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)
Expression	filter() The filters that you want to use to filter your forecast.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
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() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

timePeriod

public DateInterval timePeriod()

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

Returns:

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

metric

public 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

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:

• AmortizedCost

• BlendedCost

• NetAmortizedCost

• NetUnblendedCost

• UnblendedCost

See Also:

Metric

metricAsString

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

• AmortizedCost

• BlendedCost

• NetAmortizedCost

• NetUnblendedCost

• UnblendedCost

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:

• AmortizedCost

• BlendedCost

• NetAmortizedCost

• NetUnblendedCost

• UnblendedCost

See Also:

Metric

granularity

public Granularity granularity()

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

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.

See Also:

Granularity

granularityAsString

public String granularityAsString()

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

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.

See Also:

Granularity

filter

public Expression filter()

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

Returns:

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

predictionIntervalLevel

public 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()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GetCostForecastRequest.Builder,GetCostForecastRequest>

Specified by:

toBuilder in class CostExplorerRequest

Returns:

a builder for type T

builder

public static GetCostForecastRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.