Package 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("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	Description
static interface	GetReservationCoverageRequest.Builder

Method Summary

Modifier and Type	Method	Description
static GetReservationCoverageRequest.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final Expression	filter()	Filters utilization data by dimensions.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)	Used to retrieve the value of a field from any class that extends SdkRequest.
final Granularity	granularity()	The granularity of the Amazon Web Services cost data for the reservation.
final String	granularityAsString()	The granularity of the Amazon Web Services cost data for the reservation.
final List<GroupDefinition>	groupBy()	You can group the data by the following attributes:
final boolean	hasGroupBy()	For responses, this returns true if the service returned a value for the GroupBy property.
final int	hashCode()
final boolean	hasMetrics()	For responses, this returns true if the service returned a value for the Metrics property.
final Integer	maxResults()	The maximum number of objects that you returned for this request.
final List<String>	metrics()	The measurement that you want your reservation coverage reported in.
final String	nextPageToken()	The token to retrieve the next set of results.
final List<SdkField<?>>	sdkFields()
static Class<? extends GetReservationCoverageRequest.Builder>	serializableBuilderClass()
final SortDefinition	sortBy()	The value by which you want to sort the data.
final DateInterval	timePeriod()	The start and end dates of the period that you want to retrieve data about reservation coverage for.
GetReservationCoverageRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final 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

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Details

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

For responses, this returns true if the service returned a value for the GroupBy property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

groupBy

public final List<GroupDefinition> groupBy()

You can group the data by the following attributes:

• AZ

• CACHE_ENGINE

• DATABASE_ENGINE

• DEPLOYMENT_OPTION

• INSTANCE_TYPE

• INVOICING_ENTITY

• LINKED_ACCOUNT

• OPERATING_SYSTEM

• PLATFORM

• REGION

• TENANCY

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasGroupBy() method.

Returns:

You can group the data by the following attributes:

• AZ

• CACHE_ENGINE

• DATABASE_ENGINE

• DEPLOYMENT_OPTION

• INSTANCE_TYPE

• INVOICING_ENTITY

• LINKED_ACCOUNT

• OPERATING_SYSTEM

• PLATFORM

• REGION

• TENANCY

granularity

public final Granularity granularity()

The granularity of the Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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()

For responses, this returns true if the service returned a value for the Metrics property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMetrics() method.

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

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, Amazon Web Services 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, Amazon Web Services provides a NextPageToken value that you can use in a subsequent call to get the next batch of objects.

toBuilder

public GetReservationCoverageRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GetReservationCoverageRequest.Builder,GetReservationCoverageRequest>

Specified by:

toBuilder in class CostExplorerRequest

Returns:

a builder for type T

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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.