software.amazon.awssdk.services.costexplorer.model

Class GetReservationCoverageRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.costexplorer.model.CostExplorerRequest

software.amazon.awssdk.services.costexplorer.model.GetReservationCoverageRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetReservationCoverageRequest.Builder,GetReservationCoverageRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetReservationCoverageRequest
extends CostExplorerRequest
implements ToCopyableBuilder<GetReservationCoverageRequest.Builder,GetReservationCoverageRequest>

You can use the following request parameters to query for how much of your instance usage a reservation covered.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetReservationCoverageRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GetReservationCoverageRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Expression	filter() Filters utilization data by dimensions.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
Granularity	granularity() The granularity of the AWS cost data for the reservation.
String	granularityAsString() The granularity of the AWS cost data for the reservation.
List<GroupDefinition>	groupBy() You can group the data by the following attributes:
boolean	hasGroupBy() Returns true if the GroupBy property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasMetrics() Returns true if the Metrics property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
Integer	maxResults() The maximum number of objects that you returned for this request.
List<String>	metrics() The measurement that you want your reservation coverage reported in.
String	nextPageToken() The token to retrieve the next set of results.
List<SdkField<?>>	sdkFields()
static Class<? extends GetReservationCoverageRequest.Builder>	serializableBuilderClass()
SortDefinition	sortBy() The value by which you want to sort the data.
DateInterval	timePeriod() The start and end dates of the period that you want to retrieve data about reservation coverage for.
GetReservationCoverageRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

timePeriod

public final DateInterval timePeriod()

The start and end dates of the period that you want to retrieve data about reservation coverage for. You can retrieve data for a maximum of 13 months: the last 12 months and the current month. 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:

The start and end dates of the period that you want to retrieve data about reservation coverage for. You can retrieve data for a maximum of 13 months: the last 12 months and the current month. 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.

hasGroupBy

public final boolean hasGroupBy()

Returns true if the GroupBy property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

groupBy

public final List<GroupDefinition> groupBy()

You can group the data by the following attributes:

• AZ

• CACHE_ENGINE

• DATABASE_ENGINE

• DEPLOYMENT_OPTION

• INSTANCE_TYPE

• LINKED_ACCOUNT

• OPERATING_SYSTEM

• PLATFORM

• REGION

• TENANCY

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasGroupBy() to see if a value was sent in this field.

Returns:

You can group the data by the following attributes:

• AZ

• CACHE_ENGINE

• DATABASE_ENGINE

• DEPLOYMENT_OPTION

• INSTANCE_TYPE

• LINKED_ACCOUNT

• OPERATING_SYSTEM

• PLATFORM

• REGION

• TENANCY

granularity

public final Granularity granularity()

The granularity of the AWS cost data for the reservation. Valid values are MONTHLY and DAILY.

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.

The GetReservationCoverage operation supports only DAILY and MONTHLY granularities.

If the service returns an enum value that is not available in the current SDK version, granularity will return Granularity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from granularityAsString().

Returns:

The granularity of the AWS cost data for the reservation. Valid values are MONTHLY and DAILY.

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.

The GetReservationCoverage operation supports only DAILY and MONTHLY granularities.

See Also:

Granularity

granularityAsString

public final String granularityAsString()

The granularity of the AWS cost data for the reservation. Valid values are MONTHLY and DAILY.

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.

The GetReservationCoverage operation supports only DAILY and MONTHLY granularities.

If the service returns an enum value that is not available in the current SDK version, granularity will return Granularity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from granularityAsString().

Returns:

The granularity of the AWS cost data for the reservation. Valid values are MONTHLY and DAILY.

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.

The GetReservationCoverage operation supports only DAILY and MONTHLY granularities.

See Also:

Granularity

filter

public final 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

• TAG

• TENANCY

GetReservationCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR'd together.

If you don't provide a SERVICE filter, Cost Explorer defaults to EC2.

Cost category is also supported.

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

• TAG

• TENANCY

GetReservationCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR'd together.

If you don't provide a SERVICE filter, Cost Explorer defaults to EC2.

Cost category is also supported.

hasMetrics

public final boolean hasMetrics()

Returns true if the Metrics property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

metrics

public final List<String> metrics()

The measurement that you want your reservation coverage reported in.

Valid values are Hour, Unit, and Cost. You can use multiple values in a request.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasMetrics() to see if a value was sent in this field.

Returns:

The measurement that you want your reservation coverage reported in.

Valid values are Hour, Unit, and Cost. You can use multiple values in a request.

nextPageToken

public final 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.

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.

sortBy

public final SortDefinition sortBy()

The value by which you want to sort the data.

The following values are supported for Key:

• OnDemandCost

• CoverageHoursPercentage

• OnDemandHours

• ReservedHours

• TotalRunningHours

• CoverageNormalizedUnitsPercentage

• OnDemandNormalizedUnits

• ReservedNormalizedUnits

• TotalRunningNormalizedUnits

• Time

Supported values for SortOrder are ASCENDING or DESCENDING.

Returns:

The value by which you want to sort the data.

The following values are supported for Key:

• OnDemandCost

• CoverageHoursPercentage

• OnDemandHours

• ReservedHours

• TotalRunningHours

• CoverageNormalizedUnitsPercentage

• OnDemandNormalizedUnits

• ReservedNormalizedUnits

• TotalRunningNormalizedUnits

• Time

Supported values for SortOrder are ASCENDING or DESCENDING.

maxResults

public final Integer maxResults()

The maximum number of objects that you returned for this request. If more objects are available, in the response, AWS provides a NextPageToken value that you can use in a subsequent call to get the next batch of objects.

Returns:

The maximum number of objects that you returned for this request. If more objects are available, in the response, AWS provides a NextPageToken value that you can use in a subsequent call to get the next batch of objects.

toBuilder

public GetReservationCoverageRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetReservationCoverageRequest.Builder,GetReservationCoverageRequest>

Specified by:

toBuilder in class CostExplorerRequest

builder

public static GetReservationCoverageRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetReservationCoverageRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo