software.amazon.awssdk.services.costexplorer.model

Class GetReservationUtilizationRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetReservationUtilizationRequest.Builder,GetReservationUtilizationRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetReservationUtilizationRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GetReservationUtilizationRequest.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() If GroupBy is set, Granularity can't be set.
String	granularityAsString() If GroupBy is set, Granularity can't be set.
List<GroupDefinition>	groupBy() Groups only by SUBSCRIPTION_ID.
boolean	hasGroupBy() For responses, this returns true if the service returned a value for the GroupBy property.
int	hashCode()
Integer	maxResults() The maximum number of objects that you returned for this request.
String	nextPageToken() The token to retrieve the next set of results.
List<SdkField<?>>	sdkFields()
static Class<? extends GetReservationUtilizationRequest.Builder>	serializableBuilderClass()
SortDefinition	sortBy() The value that you want to sort the data by.
DateInterval	timePeriod() Sets the start and end dates for retrieving Reserved Instance (RI) utilization.
GetReservationUtilizationRequest.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()

Sets the start and end dates for retrieving Reserved Instance (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 Reserved Instance (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.

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

Groups only by SUBSCRIPTION_ID. Metadata is included.

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:

Groups only by SUBSCRIPTION_ID. Metadata is included.

granularity

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

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:

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

granularityAsString

public final String granularityAsString()

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.

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:

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

filter

public final Expression filter()

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

• AZ

• CACHE_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

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

sortBy

public final SortDefinition sortBy()

The value that you want to sort the data by.

The following values are supported for Key:

• UtilizationPercentage

• UtilizationPercentageInUnits

• PurchasedHours

• PurchasedUnits

• TotalActualHours

• TotalActualUnits

• UnusedHours

• UnusedUnits

• OnDemandCostOfRIHoursUsed

• NetRISavings

• TotalPotentialRISavings

• AmortizedUpfrontFee

• AmortizedRecurringFee

• TotalAmortizedFee

• RICostForUnusedHours

• RealizedSavings

• UnrealizedSavings

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

• UtilizationPercentageInUnits

• PurchasedHours

• PurchasedUnits

• TotalActualHours

• TotalActualUnits

• UnusedHours

• UnusedUnits

• OnDemandCostOfRIHoursUsed

• NetRISavings

• TotalPotentialRISavings

• AmortizedUpfrontFee

• AmortizedRecurringFee

• TotalAmortizedFee

• RICostForUnusedHours

• RealizedSavings

• UnrealizedSavings

The supported values for SortOrder are ASCENDING and DESCENDING.

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.

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 GetReservationUtilizationRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetReservationUtilizationRequest.Builder,GetReservationUtilizationRequest>

Specified by:

toBuilder in class CostExplorerRequest

builder

public static GetReservationUtilizationRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetReservationUtilizationRequest.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