Class ForecastDefinition
java.lang.Object
com.azure.resourcemanager.costmanagement.models.ForecastDefinition
The definition of a forecast.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptiondataset()
Get the dataset property: Has definition for data in this forecast.Get the includeActualCost property: a boolean determining if actualCost will be included.Get the includeFreshPartialCost property: a boolean determining if FreshPartialCost will be included.Get the timeframe property: The time frame for pulling data for the forecast.Get the timePeriod property: Has time period for pulling data for the forecast.type()
Get the type property: The type of the forecast.void
validate()
Validates the instance.withDataset
(ForecastDataset dataset) Set the dataset property: Has definition for data in this forecast.withIncludeActualCost
(Boolean includeActualCost) Set the includeActualCost property: a boolean determining if actualCost will be included.withIncludeFreshPartialCost
(Boolean includeFreshPartialCost) Set the includeFreshPartialCost property: a boolean determining if FreshPartialCost will be included.withTimeframe
(ForecastTimeframeType timeframe) Set the timeframe property: The time frame for pulling data for the forecast.withTimePeriod
(QueryTimePeriod timePeriod) Set the timePeriod property: Has time period for pulling data for the forecast.withType
(ForecastType type) Set the type property: The type of the forecast.
-
Constructor Details
-
ForecastDefinition
public ForecastDefinition()Creates an instance of ForecastDefinition class.
-
-
Method Details
-
type
Get the type property: The type of the forecast.- Returns:
- the type value.
-
withType
Set the type property: The type of the forecast.- Parameters:
type
- the type value to set.- Returns:
- the ForecastDefinition object itself.
-
timeframe
Get the timeframe property: The time frame for pulling data for the forecast. If custom, then a specific time period must be provided.- Returns:
- the timeframe value.
-
withTimeframe
Set the timeframe property: The time frame for pulling data for the forecast. If custom, then a specific time period must be provided.- Parameters:
timeframe
- the timeframe value to set.- Returns:
- the ForecastDefinition object itself.
-
timePeriod
Get the timePeriod property: Has time period for pulling data for the forecast.- Returns:
- the timePeriod value.
-
withTimePeriod
Set the timePeriod property: Has time period for pulling data for the forecast.- Parameters:
timePeriod
- the timePeriod value to set.- Returns:
- the ForecastDefinition object itself.
-
dataset
Get the dataset property: Has definition for data in this forecast.- Returns:
- the dataset value.
-
withDataset
Set the dataset property: Has definition for data in this forecast.- Parameters:
dataset
- the dataset value to set.- Returns:
- the ForecastDefinition object itself.
-
includeActualCost
Get the includeActualCost property: a boolean determining if actualCost will be included.- Returns:
- the includeActualCost value.
-
withIncludeActualCost
Set the includeActualCost property: a boolean determining if actualCost will be included.- Parameters:
includeActualCost
- the includeActualCost value to set.- Returns:
- the ForecastDefinition object itself.
-
includeFreshPartialCost
Get the includeFreshPartialCost property: a boolean determining if FreshPartialCost will be included.- Returns:
- the includeFreshPartialCost value.
-
withIncludeFreshPartialCost
Set the includeFreshPartialCost property: a boolean determining if FreshPartialCost will be included.- Parameters:
includeFreshPartialCost
- the includeFreshPartialCost value to set.- Returns:
- the ForecastDefinition object itself.
-
validate
public void validate()Validates the instance.- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-