software.amazon.awssdk.services.costexplorer.model

Interface GetCostForecastRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<GetCostForecastRequest.Builder,GetCostForecastRequest>, CostExplorerRequest.Builder, SdkBuilder<GetCostForecastRequest.Builder,GetCostForecastRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

GetCostForecastRequest

public static interface GetCostForecastRequest.Builder
extends CostExplorerRequest.Builder, SdkPojo, CopyableBuilder<GetCostForecastRequest.Builder,GetCostForecastRequest>

Method Summary

Modifier and Type	Method and Description
default GetCostForecastRequest.Builder	filter(Consumer<Expression.Builder> filter) The filters that you want to use to filter your forecast.
GetCostForecastRequest.Builder	filter(Expression filter) The filters that you want to use to filter your forecast.
GetCostForecastRequest.Builder	granularity(Granularity granularity) How granular you want the forecast to be.
GetCostForecastRequest.Builder	granularity(String granularity) How granular you want the forecast to be.
GetCostForecastRequest.Builder	metric(Metric metric) Which metric Cost Explorer uses to create your forecast.
GetCostForecastRequest.Builder	metric(String metric) Which metric Cost Explorer uses to create your forecast.
GetCostForecastRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
GetCostForecastRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
GetCostForecastRequest.Builder	predictionIntervalLevel(Integer predictionIntervalLevel) Cost Explorer always returns the mean forecast as a single point.
default GetCostForecastRequest.Builder	timePeriod(Consumer<DateInterval.Builder> timePeriod) The period of time that you want the forecast to cover.
GetCostForecastRequest.Builder	timePeriod(DateInterval timePeriod) The period of time that you want the forecast to cover.

Methods inherited from interface software.amazon.awssdk.services.costexplorer.model.CostExplorerRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

timePeriod

GetCostForecastRequest.Builder timePeriod(DateInterval timePeriod)

The period of time that you want the forecast to cover.

Parameters:

timePeriod - The period of time that you want the forecast to cover.

Returns:

Returns a reference to this object so that method calls can be chained together.

timePeriod

default GetCostForecastRequest.Builder timePeriod(Consumer<DateInterval.Builder> timePeriod)

The period of time that you want the forecast to cover.

This is a convenience that creates an instance of the DateInterval.Builder avoiding the need to create one manually via DateInterval.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to timePeriod(DateInterval).

Parameters:

timePeriod - a consumer that will call methods on DateInterval.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

timePeriod(DateInterval)

metric

GetCostForecastRequest.Builder metric(String metric)

Which metric Cost Explorer uses to create your forecast. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?.

Valid values for a GetCostForecast call are the following:

• AmortizedCost

• BlendedCost

• NetAmortizedCost

• NetUnblendedCost

• UnblendedCost

Parameters:

metric - Which metric Cost Explorer uses to create your forecast. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?.

Valid values for a GetCostForecast call are the following:

• AmortizedCost

• BlendedCost

• NetAmortizedCost

• NetUnblendedCost

• UnblendedCost

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Metric, Metric

metric

GetCostForecastRequest.Builder metric(Metric metric)

Which metric Cost Explorer uses to create your forecast. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?.

Valid values for a GetCostForecast call are the following:

• AmortizedCost

• BlendedCost

• NetAmortizedCost

• NetUnblendedCost

• UnblendedCost

Parameters:

metric - Which metric Cost Explorer uses to create your forecast. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?.

Valid values for a GetCostForecast call are the following:

• AmortizedCost

• BlendedCost

• NetAmortizedCost

• NetUnblendedCost

• UnblendedCost

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Metric, Metric

granularity

GetCostForecastRequest.Builder granularity(String granularity)

How granular you want the forecast to be. You can get 3 months of DAILY forecasts or 12 months of MONTHLY forecasts.

Parameters:

granularity - How granular you want the forecast to be. You can get 3 months of DAILY forecasts or 12 months of MONTHLY forecasts.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Granularity, Granularity

granularity

GetCostForecastRequest.Builder granularity(Granularity granularity)

How granular you want the forecast to be. You can get 3 months of DAILY forecasts or 12 months of MONTHLY forecasts.

Parameters:

granularity - How granular you want the forecast to be. You can get 3 months of DAILY forecasts or 12 months of MONTHLY forecasts.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Granularity, Granularity

filter

GetCostForecastRequest.Builder filter(Expression filter)

The filters that you want to use to filter your forecast. Cost Explorer API supports all of the Cost Explorer filters.

Parameters:

filter - The filters that you want to use to filter your forecast. Cost Explorer API supports all of the Cost Explorer filters.

Returns:

Returns a reference to this object so that method calls can be chained together.

filter

default GetCostForecastRequest.Builder filter(Consumer<Expression.Builder> filter)

The filters that you want to use to filter your forecast. Cost Explorer API supports all of the Cost Explorer filters.

This is a convenience that creates an instance of the Expression.Builder avoiding the need to create one manually via Expression.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filter(Expression).

Parameters:

filter - a consumer that will call methods on Expression.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

filter(Expression)

predictionIntervalLevel

GetCostForecastRequest.Builder predictionIntervalLevel(Integer predictionIntervalLevel)

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 - 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

GetCostForecastRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

GetCostForecastRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.