software.amazon.awssdk.services.costexplorer.model

Class GetCostForecastRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.costexplorer.model.CostExplorerRequest

software.amazon.awssdk.services.costexplorer.model.GetCostForecastRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetCostForecastRequest.Builder,GetCostForecastRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetCostForecastRequest
extends CostExplorerRequest
implements ToCopyableBuilder<GetCostForecastRequest.Builder,GetCostForecastRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetCostForecastRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GetCostForecastRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Expression	filter() The filters that you want to use to filter your forecast.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
Granularity	granularity() How granular you want the forecast to be.
String	granularityAsString() How granular you want the forecast to be.
int	hashCode()
Metric	metric() Which metric Cost Explorer uses to create your forecast.
String	metricAsString() Which metric Cost Explorer uses to create your forecast.
Integer	predictionIntervalLevel() Cost Explorer always returns the mean forecast as a single point.
List<SdkField<?>>	sdkFields()
static Class<? extends GetCostForecastRequest.Builder>	serializableBuilderClass()
DateInterval	timePeriod() The period of time that you want the forecast to cover.
GetCostForecastRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

timePeriod

public final 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.

Returns:

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.

metric

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

If the service returns an enum value that is not available in the current SDK version, metric will return Metric.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metricAsString().

Returns:

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

See Also:

Metric

metricAsString

public final String metricAsString()

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

If the service returns an enum value that is not available in the current SDK version, metric will return Metric.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metricAsString().

Returns:

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

See Also:

Metric

granularity

public final 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.

If the service returns an enum value that is not available in the current SDK version, granularity will return Granularity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from granularityAsString().

Returns:

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.

See Also:

Granularity

granularityAsString

public final String granularityAsString()

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.

If the service returns an enum value that is not available in the current SDK version, granularity will return Granularity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from granularityAsString().

Returns:

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.

See Also:

Granularity

filter

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

Returns:

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

predictionIntervalLevel

public final 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.

Returns:

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.

toBuilder

public GetCostForecastRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetCostForecastRequest.Builder,GetCostForecastRequest>

Specified by:

toBuilder in class CostExplorerRequest

builder

public static GetCostForecastRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetCostForecastRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo