com.amazonaws.services.costexplorer.model

Class GetUsageForecastRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.costexplorer.model.GetUsageForecastRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetUsageForecastRequest
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
GetUsageForecastRequest()

Method Summary

Modifier and Type	Method and Description
GetUsageForecastRequest	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 start and end dates of the period that you want to retrieve usage forecast for.
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 start and end dates of the period that you want to retrieve usage forecast for.
String	toString() Returns a string representation of this object.
GetUsageForecastRequest	withFilter(Expression filter) The filters that you want to use to filter your forecast.
GetUsageForecastRequest	withGranularity(Granularity granularity) How granular you want the forecast to be.
GetUsageForecastRequest	withGranularity(String granularity) How granular you want the forecast to be.
GetUsageForecastRequest	withMetric(Metric metric) Which metric Cost Explorer uses to create your forecast.
GetUsageForecastRequest	withMetric(String metric) Which metric Cost Explorer uses to create your forecast.
GetUsageForecastRequest	withPredictionIntervalLevel(Integer predictionIntervalLevel) Cost Explorer always returns the mean forecast as a single point.
GetUsageForecastRequest	withTimePeriod(DateInterval timePeriod) The start and end dates of the period that you want to retrieve usage forecast for.

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

GetUsageForecastRequest

public GetUsageForecastRequest()

Method Detail

setTimePeriod

public void setTimePeriod(DateInterval timePeriod)

The start and end dates of the period that you want to retrieve usage forecast for. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01. The start date must be equal to or later than the current date to avoid a validation error.

Parameters:

timePeriod - The start and end dates of the period that you want to retrieve usage forecast for. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01. The start date must be equal to or later than the current date to avoid a validation error.

getTimePeriod

public DateInterval getTimePeriod()

The start and end dates of the period that you want to retrieve usage forecast for. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01. The start date must be equal to or later than the current date to avoid a validation error.

Returns:

The start and end dates of the period that you want to retrieve usage forecast for. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01. The start date must be equal to or later than the current date to avoid a validation error.

withTimePeriod

public GetUsageForecastRequest withTimePeriod(DateInterval timePeriod)

The start and end dates of the period that you want to retrieve usage forecast for. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01. The start date must be equal to or later than the current date to avoid a validation error.

Parameters:

timePeriod - The start and end dates of the period that you want to retrieve usage forecast for. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01. The start date must be equal to or 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.

Valid values for a GetUsageForecast call are the following:

• USAGE_QUANTITY

• NORMALIZED_USAGE_AMOUNT

Parameters:

metric - Which metric Cost Explorer uses to create your forecast.

Valid values for a GetUsageForecast call are the following:

• USAGE_QUANTITY

• NORMALIZED_USAGE_AMOUNT

See Also:

Metric

getMetric

public String getMetric()

Which metric Cost Explorer uses to create your forecast.

Valid values for a GetUsageForecast call are the following:

• USAGE_QUANTITY

• NORMALIZED_USAGE_AMOUNT

Returns:

Which metric Cost Explorer uses to create your forecast.

Valid values for a GetUsageForecast call are the following:

• USAGE_QUANTITY

• NORMALIZED_USAGE_AMOUNT

See Also:

Metric

withMetric

public GetUsageForecastRequest withMetric(String metric)

Which metric Cost Explorer uses to create your forecast.

Valid values for a GetUsageForecast call are the following:

• USAGE_QUANTITY

• NORMALIZED_USAGE_AMOUNT

Parameters:

metric - Which metric Cost Explorer uses to create your forecast.

Valid values for a GetUsageForecast call are the following:

• USAGE_QUANTITY

• NORMALIZED_USAGE_AMOUNT

Returns:

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

See Also:

Metric

withMetric

public GetUsageForecastRequest withMetric(Metric metric)

Which metric Cost Explorer uses to create your forecast.

Valid values for a GetUsageForecast call are the following:

• USAGE_QUANTITY

• NORMALIZED_USAGE_AMOUNT

Parameters:

metric - Which metric Cost Explorer uses to create your forecast.

Valid values for a GetUsageForecast call are the following:

• USAGE_QUANTITY

• NORMALIZED_USAGE_AMOUNT

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 GetUsageForecast 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 GetUsageForecast 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 GetUsageForecast 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 GetUsageForecast operation supports only DAILY and MONTHLY granularities.

See Also:

Granularity

withGranularity

public GetUsageForecastRequest 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 GetUsageForecast 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 GetUsageForecast 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 GetUsageForecastRequest 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 GetUsageForecast 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 GetUsageForecast 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 GetUsageForecast 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 GetUsageForecast 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 GetUsageForecast 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 GetUsageForecast 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 GetUsageForecastRequest withFilter(Expression filter)

The filters that you want to use to filter your forecast. The GetUsageForecast 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 GetUsageForecast 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 GetUsageForecastRequest 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 GetUsageForecastRequest 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()