com.amazonaws.services.costexplorer.model

Class GetReservationUtilizationRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.costexplorer.model.GetReservationUtilizationRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
GetReservationUtilizationRequest	clone()
boolean	equals(Object obj)
Expression	getFilter() Filters utilization data by dimensions.
String	getGranularity() If GroupBy is set, Granularity can't be set.
List<GroupDefinition>	getGroupBy() Groups only by SUBSCRIPTION_ID.
String	getNextPageToken() The token to retrieve the next set of results.
DateInterval	getTimePeriod() Sets the start and end dates for retrieving RI utilization.
int	hashCode()
void	setFilter(Expression filter) Filters utilization data by dimensions.
void	setGranularity(String granularity) If GroupBy is set, Granularity can't be set.
void	setGroupBy(Collection<GroupDefinition> groupBy) Groups only by SUBSCRIPTION_ID.
void	setNextPageToken(String nextPageToken) The token to retrieve the next set of results.
void	setTimePeriod(DateInterval timePeriod) Sets the start and end dates for retrieving RI utilization.
String	toString() Returns a string representation of this object.
GetReservationUtilizationRequest	withFilter(Expression filter) Filters utilization data by dimensions.
GetReservationUtilizationRequest	withGranularity(Granularity granularity) If GroupBy is set, Granularity can't be set.
GetReservationUtilizationRequest	withGranularity(String granularity) If GroupBy is set, Granularity can't be set.
GetReservationUtilizationRequest	withGroupBy(Collection<GroupDefinition> groupBy) Groups only by SUBSCRIPTION_ID.
GetReservationUtilizationRequest	withGroupBy(GroupDefinition... groupBy) Groups only by SUBSCRIPTION_ID.
GetReservationUtilizationRequest	withNextPageToken(String nextPageToken) The token to retrieve the next set of results.
GetReservationUtilizationRequest	withTimePeriod(DateInterval timePeriod) Sets the start and end dates for retrieving RI utilization.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, 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

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetReservationUtilizationRequest

public GetReservationUtilizationRequest()

Method Detail

setTimePeriod

public void setTimePeriod(DateInterval timePeriod)

Sets the start and end dates for retrieving RI utilization. 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.

Parameters:

timePeriod - Sets the start and end dates for retrieving RI utilization. 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.

getTimePeriod

public DateInterval getTimePeriod()

Sets the start and end dates for retrieving RI utilization. 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.

Returns:

Sets the start and end dates for retrieving RI utilization. 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.

withTimePeriod

public GetReservationUtilizationRequest withTimePeriod(DateInterval timePeriod)

Sets the start and end dates for retrieving RI utilization. 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.

Parameters:

timePeriod - Sets the start and end dates for retrieving RI utilization. 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.

Returns:

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

getGroupBy

public List<GroupDefinition> getGroupBy()

Groups only by SUBSCRIPTION_ID. Metadata is included.

Returns:

Groups only by SUBSCRIPTION_ID. Metadata is included.

setGroupBy

public void setGroupBy(Collection<GroupDefinition> groupBy)

Groups only by SUBSCRIPTION_ID. Metadata is included.

Parameters:

groupBy - Groups only by SUBSCRIPTION_ID. Metadata is included.

withGroupBy

public GetReservationUtilizationRequest withGroupBy(GroupDefinition... groupBy)

Groups only by SUBSCRIPTION_ID. Metadata is included.

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 - Groups only by SUBSCRIPTION_ID. Metadata is included.

Returns:

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

withGroupBy

public GetReservationUtilizationRequest withGroupBy(Collection<GroupDefinition> groupBy)

Groups only by SUBSCRIPTION_ID. Metadata is included.

Parameters:

groupBy - Groups only by SUBSCRIPTION_ID. Metadata is included.

Returns:

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

setGranularity

public void setGranularity(String granularity)

If GroupBy is set, Granularity can't be set. If Granularity isn't set, the response object doesn't include Granularity, either MONTHLY or DAILY. If both GroupBy and Granularity aren't set, GetReservationUtilization defaults to DAILY.

The GetReservationUtilization operation supports only DAILY and MONTHLY granularities.

Parameters:

granularity - If GroupBy is set, Granularity can't be set. If Granularity isn't set, the response object doesn't include Granularity, either MONTHLY or DAILY. If both GroupBy and Granularity aren't set, GetReservationUtilization defaults to DAILY.

The GetReservationUtilization operation supports only DAILY and MONTHLY granularities.

See Also:

Granularity

getGranularity

public String getGranularity()

If GroupBy is set, Granularity can't be set. If Granularity isn't set, the response object doesn't include Granularity, either MONTHLY or DAILY. If both GroupBy and Granularity aren't set, GetReservationUtilization defaults to DAILY.

The GetReservationUtilization operation supports only DAILY and MONTHLY granularities.

Returns:

If GroupBy is set, Granularity can't be set. If Granularity isn't set, the response object doesn't include Granularity, either MONTHLY or DAILY. If both GroupBy and Granularity aren't set, GetReservationUtilization defaults to DAILY.

The GetReservationUtilization operation supports only DAILY and MONTHLY granularities.

See Also:

Granularity

withGranularity

public GetReservationUtilizationRequest withGranularity(String granularity)

If GroupBy is set, Granularity can't be set. If Granularity isn't set, the response object doesn't include Granularity, either MONTHLY or DAILY. If both GroupBy and Granularity aren't set, GetReservationUtilization defaults to DAILY.

The GetReservationUtilization operation supports only DAILY and MONTHLY granularities.

Parameters:

granularity - If GroupBy is set, Granularity can't be set. If Granularity isn't set, the response object doesn't include Granularity, either MONTHLY or DAILY. If both GroupBy and Granularity aren't set, GetReservationUtilization defaults to DAILY.

The GetReservationUtilization 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 GetReservationUtilizationRequest withGranularity(Granularity granularity)

If GroupBy is set, Granularity can't be set. If Granularity isn't set, the response object doesn't include Granularity, either MONTHLY or DAILY. If both GroupBy and Granularity aren't set, GetReservationUtilization defaults to DAILY.

The GetReservationUtilization operation supports only DAILY and MONTHLY granularities.

Parameters:

granularity - If GroupBy is set, Granularity can't be set. If Granularity isn't set, the response object doesn't include Granularity, either MONTHLY or DAILY. If both GroupBy and Granularity aren't set, GetReservationUtilization defaults to DAILY.

The GetReservationUtilization 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 utilization data by dimensions. You can filter by the following dimensions:

• AZ

• CACHE_ENGINE

• DATABASE_ENGINE

• DEPLOYMENT_OPTION

• INSTANCE_TYPE

• LINKED_ACCOUNT

• OPERATING_SYSTEM

• PLATFORM

• REGION

• SERVICE

• SCOPE

• TENANCY

GetReservationUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension, and nesting is supported up to only one level deep. If there are multiple values for a dimension, they are OR'd together.

Parameters:

filter - Filters utilization data by dimensions. You can filter by the following dimensions:

• AZ

• CACHE_ENGINE

• DATABASE_ENGINE

• DEPLOYMENT_OPTION

• INSTANCE_TYPE

• LINKED_ACCOUNT

• OPERATING_SYSTEM

• PLATFORM

• REGION

• SERVICE

• SCOPE

• TENANCY

GetReservationUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension, and nesting is supported up to only one level deep. If there are multiple values for a dimension, they are OR'd together.

getFilter

public Expression getFilter()

Filters utilization data by dimensions. You can filter by the following dimensions:

• AZ

• CACHE_ENGINE

• DATABASE_ENGINE

• DEPLOYMENT_OPTION

• INSTANCE_TYPE

• LINKED_ACCOUNT

• OPERATING_SYSTEM

• PLATFORM

• REGION

• SERVICE

• SCOPE

• TENANCY

GetReservationUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension, and nesting is supported up to only one level deep. If there are multiple values for a dimension, they are OR'd together.

Returns:

Filters utilization data by dimensions. You can filter by the following dimensions:

• AZ

• CACHE_ENGINE

• DATABASE_ENGINE

• DEPLOYMENT_OPTION

• INSTANCE_TYPE

• LINKED_ACCOUNT

• OPERATING_SYSTEM

• PLATFORM

• REGION

• SERVICE

• SCOPE

• TENANCY

GetReservationUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension, and nesting is supported up to only one level deep. If there are multiple values for a dimension, they are OR'd together.

withFilter

public GetReservationUtilizationRequest withFilter(Expression filter)

Filters utilization data by dimensions. You can filter by the following dimensions:

• AZ

• CACHE_ENGINE

• DATABASE_ENGINE

• DEPLOYMENT_OPTION

• INSTANCE_TYPE

• LINKED_ACCOUNT

• OPERATING_SYSTEM

• PLATFORM

• REGION

• SERVICE

• SCOPE

• TENANCY

GetReservationUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension, and nesting is supported up to only one level deep. If there are multiple values for a dimension, they are OR'd together.

Parameters:

filter - Filters utilization data by dimensions. You can filter by the following dimensions:

• AZ

• CACHE_ENGINE

• DATABASE_ENGINE

• DEPLOYMENT_OPTION

• INSTANCE_TYPE

• LINKED_ACCOUNT

• OPERATING_SYSTEM

• PLATFORM

• REGION

• SERVICE

• SCOPE

• TENANCY

GetReservationUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension, and nesting is supported up to only one level deep. If there are multiple values for a dimension, they are OR'd together.

Returns:

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

setNextPageToken

public void setNextPageToken(String nextPageToken)

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

Parameters:

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

getNextPageToken

public String getNextPageToken()

The token to retrieve the next set of results. AWS 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. AWS provides the token when the response from a previous call has more results than the maximum page size.

withNextPageToken

public GetReservationUtilizationRequest withNextPageToken(String nextPageToken)

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

Parameters:

nextPageToken - The token to retrieve the next set of results. AWS 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.

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 GetReservationUtilizationRequest clone()

Overrides:

clone in class AmazonWebServiceRequest