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

    • timePeriod

      GetCostForecastRequest.Builder timePeriod(DateInterval timePeriod)

      The period of time that you want the forecast to cover. The start date must be equal to or no later than the current date to avoid a validation error.

      Parameters:
      timePeriod - The period of time that you want the forecast to cover. The start date must be equal to or no 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

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

      The period of time that you want the forecast to cover. The start date must be equal to or no later than the current date to avoid a validation error.

      This is a convenience method 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:

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

      • AMORTIZED_COST

      • BLENDED_COST

      • NET_AMORTIZED_COST

      • NET_UNBLENDED_COST

      • UNBLENDED_COST

      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:

      • AMORTIZED_COST

      • BLENDED_COST

      • NET_AMORTIZED_COST

      • NET_UNBLENDED_COST

      • UNBLENDED_COST

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

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

      • AMORTIZED_COST

      • BLENDED_COST

      • NET_AMORTIZED_COST

      • NET_UNBLENDED_COST

      • UNBLENDED_COST

      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:

      • AMORTIZED_COST

      • BLENDED_COST

      • NET_AMORTIZED_COST

      • NET_UNBLENDED_COST

      • UNBLENDED_COST

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

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

      The GetCostForecast operation supports only DAILY and MONTHLY granularities.

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

      The GetCostForecast operation supports only DAILY and MONTHLY granularities.

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

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

      The GetCostForecast operation supports only DAILY and MONTHLY granularities.

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

      The GetCostForecast operation supports only DAILY and MONTHLY granularities.

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

    • filter

      GetCostForecastRequest.Builder filter(Expression filter)

      The filters that you want to use to filter your forecast. The GetCostForecast 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. The GetCostForecast 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

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

      The filters that you want to use to filter your forecast. The GetCostForecast 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

      This is a convenience method 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:

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