Interface GetUsageForecastRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<GetUsageForecastRequest.Builder,
,GetUsageForecastRequest> CostExplorerRequest.Builder
,SdkBuilder<GetUsageForecastRequest.Builder,
,GetUsageForecastRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
GetUsageForecastRequest
-
Method Summary
Modifier and TypeMethodDescriptiondefault GetUsageForecastRequest.Builder
filter
(Consumer<Expression.Builder> filter) The filters that you want to use to filter your forecast.filter
(Expression filter) The filters that you want to use to filter your forecast.granularity
(String granularity) How granular you want the forecast to be.granularity
(Granularity granularity) How granular you want the forecast to be.Which metric Cost Explorer uses to create your forecast.Which metric Cost Explorer uses to create your forecast.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.predictionIntervalLevel
(Integer predictionIntervalLevel) Amazon Web Services Cost Explorer always returns the mean forecast as a single point.default GetUsageForecastRequest.Builder
timePeriod
(Consumer<DateInterval.Builder> timePeriod) The start and end dates of the period that you want to retrieve usage forecast for.timePeriod
(DateInterval timePeriod) The start and end dates of the period that you want to retrieve usage forecast for.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.costexplorer.model.CostExplorerRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
timePeriod
The start and end dates of the period that you want to retrieve usage forecast for. The start date is included in the period, but the end date isn't included in the period. For example, if
start
is2017-01-01
andend
is2017-05-01
, then the cost and usage data is retrieved from2017-01-01
up to and including2017-04-30
but not including2017-05-01
. The start date must be equal to or later than the current date to avoid a validation error.- Parameters:
timePeriod
- The start and end dates of the period that you want to retrieve usage forecast for. The start date is included in the period, but the end date isn't included in the period. For example, ifstart
is2017-01-01
andend
is2017-05-01
, then the cost and usage data is retrieved from2017-01-01
up to and including2017-04-30
but not including2017-05-01
. The start date must be equal to or later than the current date to avoid a validation error.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
timePeriod
The start and end dates of the period that you want to retrieve usage forecast for. The start date is included in the period, but the end date isn't included in the period. For example, if
This is a convenience method that creates an instance of thestart
is2017-01-01
andend
is2017-05-01
, then the cost and usage data is retrieved from2017-01-01
up to and including2017-04-30
but not including2017-05-01
. The start date must be equal to or later than the current date to avoid a validation error.DateInterval.Builder
avoiding the need to create one manually viaDateInterval.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totimePeriod(DateInterval)
.- Parameters:
timePeriod
- a consumer that will call methods onDateInterval.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
metric
Which metric Cost Explorer uses to create your forecast.
Valid values for a
GetUsageForecast
call are the following:-
USAGE_QUANTITY
-
NORMALIZED_USAGE_AMOUNT
- Parameters:
metric
- Which metric Cost Explorer uses to create your forecast.Valid values for a
GetUsageForecast
call are the following:-
USAGE_QUANTITY
-
NORMALIZED_USAGE_AMOUNT
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
metric
Which metric Cost Explorer uses to create your forecast.
Valid values for a
GetUsageForecast
call are the following:-
USAGE_QUANTITY
-
NORMALIZED_USAGE_AMOUNT
- Parameters:
metric
- Which metric Cost Explorer uses to create your forecast.Valid values for a
GetUsageForecast
call are the following:-
USAGE_QUANTITY
-
NORMALIZED_USAGE_AMOUNT
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
granularity
How granular you want the forecast to be. You can get 3 months of
DAILY
forecasts or 12 months ofMONTHLY
forecasts.The
GetUsageForecast
operation supports onlyDAILY
andMONTHLY
granularities.- Parameters:
granularity
- How granular you want the forecast to be. You can get 3 months ofDAILY
forecasts or 12 months ofMONTHLY
forecasts.The
GetUsageForecast
operation supports onlyDAILY
andMONTHLY
granularities.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
granularity
How granular you want the forecast to be. You can get 3 months of
DAILY
forecasts or 12 months ofMONTHLY
forecasts.The
GetUsageForecast
operation supports onlyDAILY
andMONTHLY
granularities.- Parameters:
granularity
- How granular you want the forecast to be. You can get 3 months ofDAILY
forecasts or 12 months ofMONTHLY
forecasts.The
GetUsageForecast
operation supports onlyDAILY
andMONTHLY
granularities.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
filter
The filters that you want to use to filter your forecast. The
GetUsageForecast
API supports filtering by the following dimensions:-
AZ
-
INSTANCE_TYPE
-
LINKED_ACCOUNT
-
LINKED_ACCOUNT_NAME
-
OPERATION
-
PURCHASE_TYPE
-
REGION
-
SERVICE
-
USAGE_TYPE
-
USAGE_TYPE_GROUP
-
RECORD_TYPE
-
OPERATING_SYSTEM
-
TENANCY
-
SCOPE
-
PLATFORM
-
SUBSCRIPTION_ID
-
LEGAL_ENTITY_NAME
-
DEPLOYMENT_OPTION
-
DATABASE_ENGINE
-
INSTANCE_TYPE_FAMILY
-
BILLING_ENTITY
-
RESERVATION_ID
-
SAVINGS_PLAN_ARN
- Parameters:
filter
- The filters that you want to use to filter your forecast. TheGetUsageForecast
API supports filtering by the following dimensions:-
AZ
-
INSTANCE_TYPE
-
LINKED_ACCOUNT
-
LINKED_ACCOUNT_NAME
-
OPERATION
-
PURCHASE_TYPE
-
REGION
-
SERVICE
-
USAGE_TYPE
-
USAGE_TYPE_GROUP
-
RECORD_TYPE
-
OPERATING_SYSTEM
-
TENANCY
-
SCOPE
-
PLATFORM
-
SUBSCRIPTION_ID
-
LEGAL_ENTITY_NAME
-
DEPLOYMENT_OPTION
-
DATABASE_ENGINE
-
INSTANCE_TYPE_FAMILY
-
BILLING_ENTITY
-
RESERVATION_ID
-
SAVINGS_PLAN_ARN
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
filter
The filters that you want to use to filter your forecast. The
GetUsageForecast
API supports filtering by the following dimensions:-
AZ
-
INSTANCE_TYPE
-
LINKED_ACCOUNT
-
LINKED_ACCOUNT_NAME
-
OPERATION
-
PURCHASE_TYPE
-
REGION
-
SERVICE
-
USAGE_TYPE
-
USAGE_TYPE_GROUP
-
RECORD_TYPE
-
OPERATING_SYSTEM
-
TENANCY
-
SCOPE
-
PLATFORM
-
SUBSCRIPTION_ID
-
LEGAL_ENTITY_NAME
-
DEPLOYMENT_OPTION
-
DATABASE_ENGINE
-
INSTANCE_TYPE_FAMILY
-
BILLING_ENTITY
-
RESERVATION_ID
-
SAVINGS_PLAN_ARN
Expression.Builder
avoiding the need to create one manually viaExpression.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofilter(Expression)
.- Parameters:
filter
- a consumer that will call methods onExpression.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
predictionIntervalLevel
Amazon Web Services Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around the mean by specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is about the actual value falling in the prediction interval. Higher confidence levels result in wider prediction intervals.
- Parameters:
predictionIntervalLevel
- Amazon Web Services Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around the mean by specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is about the actual value falling in the prediction interval. Higher confidence levels result in wider prediction intervals.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
GetUsageForecastRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
GetUsageForecastRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-