com.amazonaws.services.costexplorer.model

Class GetCostForecastRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.costexplorer.model.GetCostForecastRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetCostForecastRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetCostForecastRequest()

Method Summary

Modifier and Type	Method and Description
GetCostForecastRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Expression	getFilter() The filters that you want to use to filter your forecast.
String	getGranularity() How granular you want the forecast to be.
String	getMetric() Which metric Cost Explorer uses to create your forecast.
Integer	getPredictionIntervalLevel() Cost Explorer always returns the mean forecast as a single point.
DateInterval	getTimePeriod() The period of time that you want the forecast to cover.
int	hashCode()
void	setFilter(Expression filter) The filters that you want to use to filter your forecast.
void	setGranularity(String granularity) How granular you want the forecast to be.
void	setMetric(String metric) Which metric Cost Explorer uses to create your forecast.
void	setPredictionIntervalLevel(Integer predictionIntervalLevel) Cost Explorer always returns the mean forecast as a single point.
void	setTimePeriod(DateInterval timePeriod) The period of time that you want the forecast to cover.
String	toString() Returns a string representation of this object.
GetCostForecastRequest	withFilter(Expression filter) The filters that you want to use to filter your forecast.
GetCostForecastRequest	withGranularity(Granularity granularity) How granular you want the forecast to be.
GetCostForecastRequest	withGranularity(String granularity) How granular you want the forecast to be.
GetCostForecastRequest	withMetric(Metric metric) Which metric Cost Explorer uses to create your forecast.
GetCostForecastRequest	withMetric(String metric) Which metric Cost Explorer uses to create your forecast.
GetCostForecastRequest	withPredictionIntervalLevel(Integer predictionIntervalLevel) Cost Explorer always returns the mean forecast as a single point.
GetCostForecastRequest	withTimePeriod(DateInterval timePeriod) The period of time that you want the forecast to cover.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetCostForecastRequest

public GetCostForecastRequest()

Method Detail

setTimePeriod

public void setTimePeriod(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.

getTimePeriod

public DateInterval getTimePeriod()

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.

withTimePeriod

public GetCostForecastRequest withTimePeriod(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.

setMetric

public void setMetric(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

See Also:

Metric

getMetric

public String getMetric()

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:

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

withMetric

public GetCostForecastRequest withMetric(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

withMetric

public GetCostForecastRequest withMetric(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:

Metric

setGranularity

public void setGranularity(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.

See Also:

Granularity

getGranularity

public String getGranularity()

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:

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

withGranularity

public GetCostForecastRequest withGranularity(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

withGranularity

public GetCostForecastRequest withGranularity(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:

Granularity

setFilter

public void setFilter(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

getFilter

public Expression getFilter()

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

withFilter

public GetCostForecastRequest withFilter(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.

setPredictionIntervalLevel

public void setPredictionIntervalLevel(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.

getPredictionIntervalLevel

public Integer getPredictionIntervalLevel()

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.

withPredictionIntervalLevel

public GetCostForecastRequest withPredictionIntervalLevel(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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GetCostForecastRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()