com.amazonaws.services.costexplorer.model

Class GetSavingsPlansCoverageRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.costexplorer.model.GetSavingsPlansCoverageRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
GetSavingsPlansCoverageRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Expression	getFilter() Filters Savings Plans coverage data by dimensions.
String	getGranularity() The granularity of the Amazon Web Services cost data for your Savings Plans.
List<GroupDefinition>	getGroupBy() You can group the data using the attributes INSTANCE_FAMILY, REGION, or SERVICE.
Integer	getMaxResults() The number of items to be returned in a response.
List<String>	getMetrics() The measurement that you want your Savings Plans coverage reported in.
String	getNextToken() The token to retrieve the next set of results.
SortDefinition	getSortBy() The value that you want to sort the data by.
DateInterval	getTimePeriod() The time period that you want the usage and costs for.
int	hashCode()
void	setFilter(Expression filter) Filters Savings Plans coverage data by dimensions.
void	setGranularity(String granularity) The granularity of the Amazon Web Services cost data for your Savings Plans.
void	setGroupBy(Collection<GroupDefinition> groupBy) You can group the data using the attributes INSTANCE_FAMILY, REGION, or SERVICE.
void	setMaxResults(Integer maxResults) The number of items to be returned in a response.
void	setMetrics(Collection<String> metrics) The measurement that you want your Savings Plans coverage reported in.
void	setNextToken(String nextToken) The token to retrieve the next set of results.
void	setSortBy(SortDefinition sortBy) The value that you want to sort the data by.
void	setTimePeriod(DateInterval timePeriod) The time period that you want the usage and costs for.
String	toString() Returns a string representation of this object.
GetSavingsPlansCoverageRequest	withFilter(Expression filter) Filters Savings Plans coverage data by dimensions.
GetSavingsPlansCoverageRequest	withGranularity(Granularity granularity) The granularity of the Amazon Web Services cost data for your Savings Plans.
GetSavingsPlansCoverageRequest	withGranularity(String granularity) The granularity of the Amazon Web Services cost data for your Savings Plans.
GetSavingsPlansCoverageRequest	withGroupBy(Collection<GroupDefinition> groupBy) You can group the data using the attributes INSTANCE_FAMILY, REGION, or SERVICE.
GetSavingsPlansCoverageRequest	withGroupBy(GroupDefinition... groupBy) You can group the data using the attributes INSTANCE_FAMILY, REGION, or SERVICE.
GetSavingsPlansCoverageRequest	withMaxResults(Integer maxResults) The number of items to be returned in a response.
GetSavingsPlansCoverageRequest	withMetrics(Collection<String> metrics) The measurement that you want your Savings Plans coverage reported in.
GetSavingsPlansCoverageRequest	withMetrics(String... metrics) The measurement that you want your Savings Plans coverage reported in.
GetSavingsPlansCoverageRequest	withNextToken(String nextToken) The token to retrieve the next set of results.
GetSavingsPlansCoverageRequest	withSortBy(SortDefinition sortBy) The value that you want to sort the data by.
GetSavingsPlansCoverageRequest	withTimePeriod(DateInterval timePeriod) The time period that you want the usage and costs 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

GetSavingsPlansCoverageRequest

public GetSavingsPlansCoverageRequest()

Method Detail

setTimePeriod

public void setTimePeriod(DateInterval timePeriod)

The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can't be used as an End date.

Parameters:

timePeriod - The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can't be used as an End date.

getTimePeriod

public DateInterval getTimePeriod()

The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can't be used as an End date.

Returns:

The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can't be used as an End date.

withTimePeriod

public GetSavingsPlansCoverageRequest withTimePeriod(DateInterval timePeriod)

The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can't be used as an End date.

Parameters:

timePeriod - The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can't be used as an End date.

Returns:

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

getGroupBy

public List<GroupDefinition> getGroupBy()

You can group the data using the attributes INSTANCE_FAMILY, REGION, or SERVICE.

Returns:

You can group the data using the attributes INSTANCE_FAMILY, REGION, or SERVICE.

setGroupBy

public void setGroupBy(Collection<GroupDefinition> groupBy)

You can group the data using the attributes INSTANCE_FAMILY, REGION, or SERVICE.

Parameters:

groupBy - You can group the data using the attributes INSTANCE_FAMILY, REGION, or SERVICE.

withGroupBy

public GetSavingsPlansCoverageRequest withGroupBy(GroupDefinition... groupBy)

You can group the data using the attributes INSTANCE_FAMILY, REGION, or SERVICE.

NOTE: This method appends the values to the existing list (if any). Use setGroupBy(java.util.Collection) or withGroupBy(java.util.Collection) if you want to override the existing values.

Parameters:

groupBy - You can group the data using the attributes INSTANCE_FAMILY, REGION, or SERVICE.

Returns:

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

withGroupBy

public GetSavingsPlansCoverageRequest withGroupBy(Collection<GroupDefinition> groupBy)

You can group the data using the attributes INSTANCE_FAMILY, REGION, or SERVICE.

Parameters:

groupBy - You can group the data using the attributes INSTANCE_FAMILY, REGION, or SERVICE.

Returns:

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

setGranularity

public void setGranularity(String granularity)

The granularity of the Amazon Web Services cost data for your Savings Plans. Granularity can't be set if GroupBy is set.

The GetSavingsPlansCoverage operation supports only DAILY and MONTHLY granularities.

Parameters:

granularity - The granularity of the Amazon Web Services cost data for your Savings Plans. Granularity can't be set if GroupBy is set.

The GetSavingsPlansCoverage operation supports only DAILY and MONTHLY granularities.

See Also:

Granularity

getGranularity

public String getGranularity()

The granularity of the Amazon Web Services cost data for your Savings Plans. Granularity can't be set if GroupBy is set.

The GetSavingsPlansCoverage operation supports only DAILY and MONTHLY granularities.

Returns:

The granularity of the Amazon Web Services cost data for your Savings Plans. Granularity can't be set if GroupBy is set.

The GetSavingsPlansCoverage operation supports only DAILY and MONTHLY granularities.

See Also:

Granularity

withGranularity

public GetSavingsPlansCoverageRequest withGranularity(String granularity)

The granularity of the Amazon Web Services cost data for your Savings Plans. Granularity can't be set if GroupBy is set.

The GetSavingsPlansCoverage operation supports only DAILY and MONTHLY granularities.

Parameters:

granularity - The granularity of the Amazon Web Services cost data for your Savings Plans. Granularity can't be set if GroupBy is set.

The GetSavingsPlansCoverage 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 GetSavingsPlansCoverageRequest withGranularity(Granularity granularity)

The granularity of the Amazon Web Services cost data for your Savings Plans. Granularity can't be set if GroupBy is set.

The GetSavingsPlansCoverage operation supports only DAILY and MONTHLY granularities.

Parameters:

granularity - The granularity of the Amazon Web Services cost data for your Savings Plans. Granularity can't be set if GroupBy is set.

The GetSavingsPlansCoverage 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)

Filters Savings Plans coverage data by dimensions. You can filter data for Savings Plans usage with the following dimensions:

• LINKED_ACCOUNT

• REGION

• SERVICE

• INSTANCE_FAMILY

GetSavingsPlansCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. If there are multiple values for a dimension, they are OR'd together.

Cost category is also supported.

Parameters:

filter - Filters Savings Plans coverage data by dimensions. You can filter data for Savings Plans usage with the following dimensions:

• LINKED_ACCOUNT

• REGION

• SERVICE

• INSTANCE_FAMILY

GetSavingsPlansCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. If there are multiple values for a dimension, they are OR'd together.

Cost category is also supported.

getFilter

public Expression getFilter()

Filters Savings Plans coverage data by dimensions. You can filter data for Savings Plans usage with the following dimensions:

• LINKED_ACCOUNT

• REGION

• SERVICE

• INSTANCE_FAMILY

GetSavingsPlansCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. If there are multiple values for a dimension, they are OR'd together.

Cost category is also supported.

Returns:

Filters Savings Plans coverage data by dimensions. You can filter data for Savings Plans usage with the following dimensions:

• LINKED_ACCOUNT

• REGION

• SERVICE

• INSTANCE_FAMILY

GetSavingsPlansCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. If there are multiple values for a dimension, they are OR'd together.

Cost category is also supported.

withFilter

public GetSavingsPlansCoverageRequest withFilter(Expression filter)

Filters Savings Plans coverage data by dimensions. You can filter data for Savings Plans usage with the following dimensions:

• LINKED_ACCOUNT

• REGION

• SERVICE

• INSTANCE_FAMILY

GetSavingsPlansCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. If there are multiple values for a dimension, they are OR'd together.

Cost category is also supported.

Parameters:

filter - Filters Savings Plans coverage data by dimensions. You can filter data for Savings Plans usage with the following dimensions:

• LINKED_ACCOUNT

• REGION

• SERVICE

• INSTANCE_FAMILY

GetSavingsPlansCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. If there are multiple values for a dimension, they are OR'd together.

Cost category is also supported.

Returns:

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

getMetrics

public List<String> getMetrics()

The measurement that you want your Savings Plans coverage reported in. The only valid value is SpendCoveredBySavingsPlans.

Returns:

The measurement that you want your Savings Plans coverage reported in. The only valid value is SpendCoveredBySavingsPlans.

setMetrics

public void setMetrics(Collection<String> metrics)

The measurement that you want your Savings Plans coverage reported in. The only valid value is SpendCoveredBySavingsPlans.

Parameters:

metrics - The measurement that you want your Savings Plans coverage reported in. The only valid value is SpendCoveredBySavingsPlans.

withMetrics

public GetSavingsPlansCoverageRequest withMetrics(String... metrics)

The measurement that you want your Savings Plans coverage reported in. The only valid value is SpendCoveredBySavingsPlans.

NOTE: This method appends the values to the existing list (if any). Use setMetrics(java.util.Collection) or withMetrics(java.util.Collection) if you want to override the existing values.

Parameters:

metrics - The measurement that you want your Savings Plans coverage reported in. The only valid value is SpendCoveredBySavingsPlans.

Returns:

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

withMetrics

public GetSavingsPlansCoverageRequest withMetrics(Collection<String> metrics)

The measurement that you want your Savings Plans coverage reported in. The only valid value is SpendCoveredBySavingsPlans.

Parameters:

metrics - The measurement that you want your Savings Plans coverage reported in. The only valid value is SpendCoveredBySavingsPlans.

Returns:

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

setNextToken

public void setNextToken(String nextToken)

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

Parameters:

nextToken - The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

getNextToken

public String getNextToken()

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

Returns:

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

withNextToken

public GetSavingsPlansCoverageRequest withNextToken(String nextToken)

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

Parameters:

nextToken - The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

Returns:

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

setMaxResults

public void setMaxResults(Integer maxResults)

The number of items to be returned in a response. The default is 20, with a minimum value of 1.

Parameters:

maxResults - The number of items to be returned in a response. The default is 20, with a minimum value of 1.

getMaxResults

public Integer getMaxResults()

The number of items to be returned in a response. The default is 20, with a minimum value of 1.

Returns:

The number of items to be returned in a response. The default is 20, with a minimum value of 1.

withMaxResults

public GetSavingsPlansCoverageRequest withMaxResults(Integer maxResults)

The number of items to be returned in a response. The default is 20, with a minimum value of 1.

Parameters:

maxResults - The number of items to be returned in a response. The default is 20, with a minimum value of 1.

Returns:

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

setSortBy

public void setSortBy(SortDefinition sortBy)

The value that you want to sort the data by.

The following values are supported for Key:

• SpendCoveredBySavingsPlan

• OnDemandCost

• CoveragePercentage

• TotalCost

• InstanceFamily

• Region

• Service

The supported values for SortOrder are ASCENDING and DESCENDING.

Parameters:

sortBy - The value that you want to sort the data by.

The following values are supported for Key:

• SpendCoveredBySavingsPlan

• OnDemandCost

• CoveragePercentage

• TotalCost

• InstanceFamily

• Region

• Service

The supported values for SortOrder are ASCENDING and DESCENDING.

getSortBy

public SortDefinition getSortBy()

The value that you want to sort the data by.

The following values are supported for Key:

• SpendCoveredBySavingsPlan

• OnDemandCost

• CoveragePercentage

• TotalCost

• InstanceFamily

• Region

• Service

The supported values for SortOrder are ASCENDING and DESCENDING.

Returns:

The value that you want to sort the data by.

The following values are supported for Key:

• SpendCoveredBySavingsPlan

• OnDemandCost

• CoveragePercentage

• TotalCost

• InstanceFamily

• Region

• Service

The supported values for SortOrder are ASCENDING and DESCENDING.

withSortBy

public GetSavingsPlansCoverageRequest withSortBy(SortDefinition sortBy)

The value that you want to sort the data by.

The following values are supported for Key:

• SpendCoveredBySavingsPlan

• OnDemandCost

• CoveragePercentage

• TotalCost

• InstanceFamily

• Region

• Service

The supported values for SortOrder are ASCENDING and DESCENDING.

Parameters:

sortBy - The value that you want to sort the data by.

The following values are supported for Key:

• SpendCoveredBySavingsPlan

• OnDemandCost

• CoveragePercentage

• TotalCost

• InstanceFamily

• Region

• Service

The supported values for SortOrder are ASCENDING and DESCENDING.

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