Package com.azure.resourcemanager.costmanagement.fluent.models

Class ViewProperties

java.lang.Object
com.azure.resourcemanager.costmanagement.fluent.models.ViewProperties
public final class ViewProperties extends Object
The properties of the view.

  • Constructor Details

    • ViewProperties

      public ViewProperties()
      Creates an instance of ViewProperties class.

  • Method Details

    • displayName

      public String displayName()
      Get the displayName property: User input name of the view. Required.
      Returns:
      the displayName value.

    • withDisplayName

      public ViewProperties withDisplayName(String displayName)
      Set the displayName property: User input name of the view. Required.
      Parameters:
      displayName - the displayName value to set.
      Returns:
      the ViewProperties object itself.

    • scope

      public String scope()
      Get the scope property: Cost Management scope to save the view on. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope.
      Returns:
      the scope value.

    • withScope

      public ViewProperties withScope(String scope)
      Set the scope property: Cost Management scope to save the view on. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope.
      Parameters:
      scope - the scope value to set.
      Returns:
      the ViewProperties object itself.

    • createdOn

      public OffsetDateTime createdOn()
      Get the createdOn property: Date the user created this view.
      Returns:
      the createdOn value.

    • modifiedOn

      public OffsetDateTime modifiedOn()
      Get the modifiedOn property: Date when the user last modified this view.
      Returns:
      the modifiedOn value.

    • dateRange

      public String dateRange()
      Get the dateRange property: Date range of the current view.
      Returns:
      the dateRange value.

    • currency

      public String currency()
      Get the currency property: Currency of the current view.
      Returns:
      the currency value.

    • chart

      public ChartType chart()
      Get the chart property: Chart type of the main view in Cost Analysis. Required.
      Returns:
      the chart value.

    • withChart

      public ViewProperties withChart(ChartType chart)
      Set the chart property: Chart type of the main view in Cost Analysis. Required.
      Parameters:
      chart - the chart value to set.
      Returns:
      the ViewProperties object itself.

    • accumulated

      public AccumulatedType accumulated()
      Get the accumulated property: Show costs accumulated over time.
      Returns:
      the accumulated value.

    • withAccumulated

      public ViewProperties withAccumulated(AccumulatedType accumulated)
      Set the accumulated property: Show costs accumulated over time.
      Parameters:
      accumulated - the accumulated value to set.
      Returns:
      the ViewProperties object itself.

    • metric

      public MetricType metric()
      Get the metric property: Metric to use when displaying costs.
      Returns:
      the metric value.

    • withMetric

      public ViewProperties withMetric(MetricType metric)
      Set the metric property: Metric to use when displaying costs.
      Parameters:
      metric - the metric value to set.
      Returns:
      the ViewProperties object itself.

    • kpis

      public List<KpiProperties> kpis()
      Get the kpis property: List of KPIs to show in Cost Analysis UI.
      Returns:
      the kpis value.

    • withKpis

      public ViewProperties withKpis(List<KpiProperties> kpis)
      Set the kpis property: List of KPIs to show in Cost Analysis UI.
      Parameters:
      kpis - the kpis value to set.
      Returns:
      the ViewProperties object itself.

    • pivots

      public List<PivotProperties> pivots()
      Get the pivots property: Configuration of 3 sub-views in the Cost Analysis UI.
      Returns:
      the pivots value.

    • withPivots

      public ViewProperties withPivots(List<PivotProperties> pivots)
      Set the pivots property: Configuration of 3 sub-views in the Cost Analysis UI.
      Parameters:
      pivots - the pivots value to set.
      Returns:
      the ViewProperties object itself.

    • type

      public ReportType type()
      Get the type property: The type of the report. Usage represents actual usage, forecast represents forecasted data and UsageAndForecast represents both usage and forecasted data. Actual usage and forecasted data can be differentiated based on dates.
      Returns:
      the type value.

    • withType

      public ViewProperties withType(ReportType type)
      Set the type property: The type of the report. Usage represents actual usage, forecast represents forecasted data and UsageAndForecast represents both usage and forecasted data. Actual usage and forecasted data can be differentiated based on dates.
      Parameters:
      type - the type value to set.
      Returns:
      the ViewProperties object itself.

    • timeframe

      public ReportTimeframeType timeframe()
      Get the timeframe property: The time frame for pulling data for the report. If custom, then a specific time period must be provided.
      Returns:
      the timeframe value.

    • withTimeframe

      public ViewProperties withTimeframe(ReportTimeframeType timeframe)
      Set the timeframe property: The time frame for pulling data for the report. If custom, then a specific time period must be provided.
      Parameters:
      timeframe - the timeframe value to set.
      Returns:
      the ViewProperties object itself.

    • timePeriod

      public ReportConfigTimePeriod timePeriod()
      Get the timePeriod property: Has time period for pulling data for the report.
      Returns:
      the timePeriod value.

    • withTimePeriod

      public ViewProperties withTimePeriod(ReportConfigTimePeriod timePeriod)
      Set the timePeriod property: Has time period for pulling data for the report.
      Parameters:
      timePeriod - the timePeriod value to set.
      Returns:
      the ViewProperties object itself.

    • dataSet

      public ReportConfigDataset dataSet()
      Get the dataSet property: Has definition for data in this report config.
      Returns:
      the dataSet value.

    • withDataSet

      public ViewProperties withDataSet(ReportConfigDataset dataSet)
      Set the dataSet property: Has definition for data in this report config.
      Parameters:
      dataSet - the dataSet value to set.
      Returns:
      the ViewProperties object itself.

    • includeMonetaryCommitment

      public Boolean includeMonetaryCommitment()
      Get the includeMonetaryCommitment property: If true, report includes monetary commitment.
      Returns:
      the includeMonetaryCommitment value.

    • withIncludeMonetaryCommitment

      public ViewProperties withIncludeMonetaryCommitment(Boolean includeMonetaryCommitment)
      Set the includeMonetaryCommitment property: If true, report includes monetary commitment.
      Parameters:
      includeMonetaryCommitment - the includeMonetaryCommitment value to set.
      Returns:
      the ViewProperties object itself.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.