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)
Expression	filter() Filters utilization data by dimensions.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
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.
int	hashCode()
String	nextPageToken() The token to retrieve the next set of results.
List<SdkField<?>>	sdkFields()
static Class<? extends GetReservationUtilizationRequest.Builder>	serializableBuilderClass()
DateInterval	timePeriod() Sets the start and end dates for retrieving Reserved Instance (RI) utilization.
GetReservationUtilizationRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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 Detail

timePeriod

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

groupBy

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

Returns:

Groups only by SUBSCRIPTION_ID. Metadata is included.

granularity

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

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.

See Also:

Granularity

granularityAsString

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

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.

See Also:

Granularity

filter

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

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.

nextPageToken

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

toBuilder

public GetReservationUtilizationRequest.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<GetReservationUtilizationRequest.Builder,GetReservationUtilizationRequest>

Specified by:

toBuilder in class CostExplorerRequest

Returns:

a builder for type T

builder

public static GetReservationUtilizationRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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