com.azure.resourcemanager.costmanagement.fluent.models.ReportConfigDefinition Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-resourcemanager-costmanagement Show documentation
Show all versions of azure-resourcemanager-costmanagement Show documentation
This package contains Microsoft Azure SDK for CostManagement Management SDK. For documentation on how to use this package, please see https://aka.ms/azsdk/java/mgmt. CostManagement management client provides access to CostManagement resources for Azure Enterprise Subscriptions. Package tag package-2022-10.
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.
package com.azure.resourcemanager.costmanagement.fluent.models;
import com.azure.core.annotation.Fluent;
import com.azure.core.util.logging.ClientLogger;
import com.azure.resourcemanager.costmanagement.models.ReportConfigDataset;
import com.azure.resourcemanager.costmanagement.models.ReportConfigTimePeriod;
import com.azure.resourcemanager.costmanagement.models.ReportTimeframeType;
import com.azure.resourcemanager.costmanagement.models.ReportType;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonProperty;
/** The definition of a report config. */
@Fluent
public final class ReportConfigDefinition {
@JsonIgnore private final ClientLogger logger = new ClientLogger(ReportConfigDefinition.class);
/*
* 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.
*/
@JsonProperty(value = "type", required = true)
private ReportType type;
/*
* The time frame for pulling data for the report. If custom, then a
* specific time period must be provided.
*/
@JsonProperty(value = "timeframe", required = true)
private ReportTimeframeType timeframe;
/*
* Has time period for pulling data for the report.
*/
@JsonProperty(value = "timePeriod")
private ReportConfigTimePeriod timePeriod;
/*
* Has definition for data in this report config.
*/
@JsonProperty(value = "dataSet")
private ReportConfigDataset dataSet;
/*
* Include monetary commitment
*/
@JsonProperty(value = "includeMonetaryCommitment", access = JsonProperty.Access.WRITE_ONLY)
private Boolean includeMonetaryCommitment;
/**
* 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.
*
* @return the type value.
*/
public ReportType type() {
return this.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.
*
* @param type the type value to set.
* @return the ReportConfigDefinition object itself.
*/
public ReportConfigDefinition withType(ReportType type) {
this.type = type;
return this;
}
/**
* Get the timeframe property: The time frame for pulling data for the report. If custom, then a specific time
* period must be provided.
*
* @return the timeframe value.
*/
public ReportTimeframeType timeframe() {
return this.timeframe;
}
/**
* Set the timeframe property: The time frame for pulling data for the report. If custom, then a specific time
* period must be provided.
*
* @param timeframe the timeframe value to set.
* @return the ReportConfigDefinition object itself.
*/
public ReportConfigDefinition withTimeframe(ReportTimeframeType timeframe) {
this.timeframe = timeframe;
return this;
}
/**
* Get the timePeriod property: Has time period for pulling data for the report.
*
* @return the timePeriod value.
*/
public ReportConfigTimePeriod timePeriod() {
return this.timePeriod;
}
/**
* Set the timePeriod property: Has time period for pulling data for the report.
*
* @param timePeriod the timePeriod value to set.
* @return the ReportConfigDefinition object itself.
*/
public ReportConfigDefinition withTimePeriod(ReportConfigTimePeriod timePeriod) {
this.timePeriod = timePeriod;
return this;
}
/**
* Get the dataSet property: Has definition for data in this report config.
*
* @return the dataSet value.
*/
public ReportConfigDataset dataSet() {
return this.dataSet;
}
/**
* Set the dataSet property: Has definition for data in this report config.
*
* @param dataSet the dataSet value to set.
* @return the ReportConfigDefinition object itself.
*/
public ReportConfigDefinition withDataSet(ReportConfigDataset dataSet) {
this.dataSet = dataSet;
return this;
}
/**
* Get the includeMonetaryCommitment property: Include monetary commitment.
*
* @return the includeMonetaryCommitment value.
*/
public Boolean includeMonetaryCommitment() {
return this.includeMonetaryCommitment;
}
/**
* Validates the instance.
*
* @throws IllegalArgumentException thrown if the instance is not valid.
*/
public void validate() {
if (type() == null) {
throw logger
.logExceptionAsError(
new IllegalArgumentException("Missing required property type in model ReportConfigDefinition"));
}
if (timeframe() == null) {
throw logger
.logExceptionAsError(
new IllegalArgumentException(
"Missing required property timeframe in model ReportConfigDefinition"));
}
if (timePeriod() != null) {
timePeriod().validate();
}
if (dataSet() != null) {
dataSet().validate();
}
}
}