software.amazon.awssdk.services.costexplorer.model

Class GetSavingsPlansCoverageRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetSavingsPlansCoverageRequest.Builder,GetSavingsPlansCoverageRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetSavingsPlansCoverageRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GetSavingsPlansCoverageRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Expression	filter() Filters Savings Plans coverage data by dimensions.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
Granularity	granularity() The granularity of the Amazon Web Services cost data for your Savings Plans.
String	granularityAsString() The granularity of the Amazon Web Services cost data for your Savings Plans.
List<GroupDefinition>	groupBy() You can group the data using the attributes INSTANCE_FAMILY, REGION, or SERVICE.
boolean	hasGroupBy() For responses, this returns true if the service returned a value for the GroupBy property.
int	hashCode()
boolean	hasMetrics() For responses, this returns true if the service returned a value for the Metrics property.
Integer	maxResults() The number of items to be returned in a response.
List<String>	metrics() The measurement that you want your Savings Plans coverage reported in.
String	nextToken() The token to retrieve the next set of results.
List<SdkField<?>>	sdkFields()
static Class<? extends GetSavingsPlansCoverageRequest.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.
GetSavingsPlansCoverageRequest.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.

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 using the attributes INSTANCE_FAMILY, REGION, or SERVICE.

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 using the attributes INSTANCE_FAMILY, REGION, or SERVICE.

granularity

public final Granularity granularity()

The granularity of the Amazon Web Services cost data for your Savings Plans. Granularity can't be set if GroupBy is set.

The GetSavingsPlansCoverage 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 your Savings Plans. Granularity can't be set if GroupBy is set.

The GetSavingsPlansCoverage 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 your Savings Plans. Granularity can't be set if GroupBy is set.

The GetSavingsPlansCoverage 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 your Savings Plans. Granularity can't be set if GroupBy is set.

The GetSavingsPlansCoverage operation supports only DAILY and MONTHLY granularities.

See Also:

Granularity

filter

public final Expression filter()

Filters Savings Plans coverage data by dimensions. You can filter data for Savings Plans usage with the following dimensions:

• LINKED_ACCOUNT

• REGION

• SERVICE

• INSTANCE_FAMILY

GetSavingsPlansCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. If there are multiple values for a dimension, they are OR'd together.

Cost category is also supported.

Returns:

Filters Savings Plans coverage data by dimensions. You can filter data for Savings Plans usage with the following dimensions:

• LINKED_ACCOUNT

• REGION

• SERVICE

• INSTANCE_FAMILY

GetSavingsPlansCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. If there are multiple values for a dimension, they are OR'd together.

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 Savings Plans coverage reported in. The only valid value is SpendCoveredBySavingsPlans.

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 Savings Plans coverage reported in. The only valid value is SpendCoveredBySavingsPlans.

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:

• SpendCoveredBySavingsPlan

• OnDemandCost

• CoveragePercentage

• TotalCost

• InstanceFamily

• Region

• Service

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:

• SpendCoveredBySavingsPlan

• OnDemandCost

• CoveragePercentage

• TotalCost

• InstanceFamily

• Region

• Service

The supported values for SortOrder are ASCENDING and DESCENDING.

toBuilder

public GetSavingsPlansCoverageRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetSavingsPlansCoverageRequest.Builder,GetSavingsPlansCoverageRequest>

Specified by:

toBuilder in class CostExplorerRequest

builder

public static GetSavingsPlansCoverageRequest.Builder builder()

serializableBuilderClass

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