com.amazonaws.services.costexplorer.model

Class GetSavingsPlansUtilizationDetailsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.costexplorer.model.GetSavingsPlansUtilizationDetailsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
GetSavingsPlansUtilizationDetailsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<String>	getDataType() The data type.
Expression	getFilter() Filters Savings Plans utilization coverage data for active Savings Plans dimensions.
Integer	getMaxResults() The number of items to be returned in a response.
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	setDataType(Collection<String> dataType) The data type.
void	setFilter(Expression filter) Filters Savings Plans utilization coverage data for active Savings Plans dimensions.
void	setMaxResults(Integer maxResults) The number of items to be returned in a response.
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.
GetSavingsPlansUtilizationDetailsRequest	withDataType(Collection<String> dataType) The data type.
GetSavingsPlansUtilizationDetailsRequest	withDataType(SavingsPlansDataType... dataType) The data type.
GetSavingsPlansUtilizationDetailsRequest	withDataType(String... dataType) The data type.
GetSavingsPlansUtilizationDetailsRequest	withFilter(Expression filter) Filters Savings Plans utilization coverage data for active Savings Plans dimensions.
GetSavingsPlansUtilizationDetailsRequest	withMaxResults(Integer maxResults) The number of items to be returned in a response.
GetSavingsPlansUtilizationDetailsRequest	withNextToken(String nextToken) The token to retrieve the next set of results.
GetSavingsPlansUtilizationDetailsRequest	withSortBy(SortDefinition sortBy) The value that you want to sort the data by.
GetSavingsPlansUtilizationDetailsRequest	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

GetSavingsPlansUtilizationDetailsRequest

public GetSavingsPlansUtilizationDetailsRequest()

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 GetSavingsPlansUtilizationDetailsRequest 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.

setFilter

public void setFilter(Expression filter)

Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:

• LINKED_ACCOUNT

• SAVINGS_PLAN_ARN

• REGION

• PAYMENT_OPTION

• INSTANCE_TYPE_FAMILY

GetSavingsPlansUtilizationDetails uses the same Expression object as the other operations, but only AND is supported among each dimension.

Parameters:

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

• LINKED_ACCOUNT

• SAVINGS_PLAN_ARN

• REGION

• PAYMENT_OPTION

• INSTANCE_TYPE_FAMILY

GetSavingsPlansUtilizationDetails uses the same Expression object as the other operations, but only AND is supported among each dimension.

getFilter

public Expression getFilter()

Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:

• LINKED_ACCOUNT

• SAVINGS_PLAN_ARN

• REGION

• PAYMENT_OPTION

• INSTANCE_TYPE_FAMILY

GetSavingsPlansUtilizationDetails uses the same Expression object as the other operations, but only AND is supported among each dimension.

Returns:

Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:

• LINKED_ACCOUNT

• SAVINGS_PLAN_ARN

• REGION

• PAYMENT_OPTION

• INSTANCE_TYPE_FAMILY

GetSavingsPlansUtilizationDetails uses the same Expression object as the other operations, but only AND is supported among each dimension.

withFilter

public GetSavingsPlansUtilizationDetailsRequest withFilter(Expression filter)

Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:

• LINKED_ACCOUNT

• SAVINGS_PLAN_ARN

• REGION

• PAYMENT_OPTION

• INSTANCE_TYPE_FAMILY

GetSavingsPlansUtilizationDetails uses the same Expression object as the other operations, but only AND is supported among each dimension.

Parameters:

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

• LINKED_ACCOUNT

• SAVINGS_PLAN_ARN

• REGION

• PAYMENT_OPTION

• INSTANCE_TYPE_FAMILY

GetSavingsPlansUtilizationDetails uses the same Expression object as the other operations, but only AND is supported among each dimension.

Returns:

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

getDataType

public List<String> getDataType()

The data type.

Returns:

The data type.

See Also:

SavingsPlansDataType

setDataType

public void setDataType(Collection<String> dataType)

The data type.

Parameters:

dataType - The data type.

See Also:

SavingsPlansDataType

withDataType

public GetSavingsPlansUtilizationDetailsRequest withDataType(String... dataType)

The data type.

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

Parameters:

dataType - The data type.

Returns:

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

See Also:

SavingsPlansDataType

withDataType

public GetSavingsPlansUtilizationDetailsRequest withDataType(Collection<String> dataType)

The data type.

Parameters:

dataType - The data type.

Returns:

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

See Also:

SavingsPlansDataType

withDataType

public GetSavingsPlansUtilizationDetailsRequest withDataType(SavingsPlansDataType... dataType)

The data type.

Parameters:

dataType - The data type.

Returns:

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

See Also:

SavingsPlansDataType

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

• UtilizationPercentage

• TotalCommitment

• UsedCommitment

• UnusedCommitment

• NetSavings

• AmortizedRecurringCommitment

• AmortizedUpfrontCommitment

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:

• UtilizationPercentage

• TotalCommitment

• UsedCommitment

• UnusedCommitment

• NetSavings

• AmortizedRecurringCommitment

• AmortizedUpfrontCommitment

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:

• UtilizationPercentage

• TotalCommitment

• UsedCommitment

• UnusedCommitment

• NetSavings

• AmortizedRecurringCommitment

• AmortizedUpfrontCommitment

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:

• UtilizationPercentage

• TotalCommitment

• UsedCommitment

• UnusedCommitment

• NetSavings

• AmortizedRecurringCommitment

• AmortizedUpfrontCommitment

The supported values for SortOrder are ASCENDING and DESCENDING.

withSortBy

public GetSavingsPlansUtilizationDetailsRequest withSortBy(SortDefinition sortBy)

The value that you want to sort the data by.

The following values are supported for Key:

• UtilizationPercentage

• TotalCommitment

• UsedCommitment

• UnusedCommitment

• NetSavings

• AmortizedRecurringCommitment

• AmortizedUpfrontCommitment

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:

• UtilizationPercentage

• TotalCommitment

• UsedCommitment

• UnusedCommitment

• NetSavings

• AmortizedRecurringCommitment

• AmortizedUpfrontCommitment

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