Package software.amazon.awssdk.services.costexplorer.model

Class GetSavingsPlansUtilizationDetailsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetSavingsPlansUtilizationDetailsRequest.Builder,GetSavingsPlansUtilizationDetailsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetSavingsPlansUtilizationDetailsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static GetSavingsPlansUtilizationDetailsRequest.Builder	builder()
List<SavingsPlansDataType>	dataType()	The data type.
List<String>	dataTypeAsStrings()	The data type.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Expression	filter()	Filters Savings Plans utilization coverage data for active Savings Plans dimensions.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDataType()	For responses, this returns true if the service returned a value for the DataType property.
int	hashCode()
Integer	maxResults()	The number of items to be returned in a response.
String	nextToken()	The token to retrieve the next set of results.
List<SdkField<?>>	sdkFields()
static Class<? extends GetSavingsPlansUtilizationDetailsRequest.Builder>	serializableBuilderClass()
SortDefinition	sortBy()	The value that you want to sort the data by.
DateInterval	timePeriod()	The time period that you want the usage and costs for.
GetSavingsPlansUtilizationDetailsRequest.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 time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can't be used as an End date.

Returns:

The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can't be used as an End date.

filter

public final Expression filter()

Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:

• LINKED_ACCOUNT

• SAVINGS_PLAN_ARN

• REGION

• PAYMENT_OPTION

• INSTANCE_TYPE_FAMILY

GetSavingsPlansUtilizationDetails uses the same Expression object as the other operations, but only AND is supported among each dimension.

Returns:

Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:

• LINKED_ACCOUNT

• SAVINGS_PLAN_ARN

• REGION

• PAYMENT_OPTION

• INSTANCE_TYPE_FAMILY

GetSavingsPlansUtilizationDetails uses the same Expression object as the other operations, but only AND is supported among each dimension.

dataType

public final List<SavingsPlansDataType> dataType()

The data type.

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 hasDataType() method.

Returns:

The data type.

hasDataType

public final boolean hasDataType()

For responses, this returns true if the service returned a value for the DataType 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.

dataTypeAsStrings

public final List<String> dataTypeAsStrings()

The data type.

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 hasDataType() method.

Returns:

The data type.

nextToken

public final String nextToken()

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 number of items to be returned in a response. The default is 20, with a minimum value of 1.

Returns:

The number of items to be returned in a response. The default is 20, with a minimum value of 1.

sortBy

public final SortDefinition sortBy()

The value that you want to sort the data by.

The following values are supported for Key:

• UtilizationPercentage

• TotalCommitment

• UsedCommitment

• UnusedCommitment

• NetSavings

• AmortizedRecurringCommitment

• AmortizedUpfrontCommitment

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

• TotalCommitment

• UsedCommitment

• UnusedCommitment

• NetSavings

• AmortizedRecurringCommitment

• AmortizedUpfrontCommitment

The supported values for SortOrder are ASCENDING and DESCENDING.

toBuilder

public GetSavingsPlansUtilizationDetailsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetSavingsPlansUtilizationDetailsRequest.Builder,GetSavingsPlansUtilizationDetailsRequest>

Specified by:

toBuilder in class CostExplorerRequest

builder

public static GetSavingsPlansUtilizationDetailsRequest.Builder builder()

serializableBuilderClass

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