Class GetSavingsPlansCoverageRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetSavingsPlansCoverageRequest.Builder,
GetSavingsPlansCoverageRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Expression
filter()
Filters Savings Plans coverage 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 extendsSdkRequest
.final Granularity
The granularity of the Amazon Web Services cost data for your Savings Plans.final String
The granularity of the Amazon Web Services cost data for your Savings Plans.final List
<GroupDefinition> groupBy()
You can group the data using the attributesINSTANCE_FAMILY
,REGION
, orSERVICE
.final boolean
For responses, this returns true if the service returned a value for the GroupBy property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Metrics property.final Integer
The number of items to be returned in a response.metrics()
The measurement that you want your Savings Plans coverage reported in.final String
The token to retrieve the next set of results.static Class
<? extends GetSavingsPlansCoverageRequest.Builder> final SortDefinition
sortBy()
The value that you want to sort the data by.final DateInterval
The time period that you want the usage and costs for.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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
timePeriod
The time period that you want the usage and costs for. The
Start
date must be within 13 months. TheEnd
date must be after theStart
date, and before the current date. Future dates can't be used as anEnd
date.- Returns:
- The time period that you want the usage and costs for. The
Start
date must be within 13 months. TheEnd
date must be after theStart
date, and before the current date. Future dates can't be used as anEnd
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 theisEmpty()
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
You can group the data using the attributes
INSTANCE_FAMILY
,REGION
, orSERVICE
.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
, orSERVICE
.
-
granularity
The granularity of the Amazon Web Services cost data for your Savings Plans.
Granularity
can't be set ifGroupBy
is set.The
GetSavingsPlansCoverage
operation supports onlyDAILY
andMONTHLY
granularities.If the service returns an enum value that is not available in the current SDK version,
granularity
will returnGranularity.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromgranularityAsString()
.- Returns:
- The granularity of the Amazon Web Services cost data for your Savings Plans.
Granularity
can't be set ifGroupBy
is set.The
GetSavingsPlansCoverage
operation supports onlyDAILY
andMONTHLY
granularities. - See Also:
-
granularityAsString
The granularity of the Amazon Web Services cost data for your Savings Plans.
Granularity
can't be set ifGroupBy
is set.The
GetSavingsPlansCoverage
operation supports onlyDAILY
andMONTHLY
granularities.If the service returns an enum value that is not available in the current SDK version,
granularity
will returnGranularity.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromgranularityAsString()
.- Returns:
- The granularity of the Amazon Web Services cost data for your Savings Plans.
Granularity
can't be set ifGroupBy
is set.The
GetSavingsPlansCoverage
operation supports onlyDAILY
andMONTHLY
granularities. - See Also:
-
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 onlyAND
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 onlyAND
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 theisEmpty()
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
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
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
The number of items to be returned in a response. The default is
20
, with a minimum value of1
.- Returns:
- The number of items to be returned in a response. The default is
20
, with a minimum value of1
.
-
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
areASCENDING
andDESCENDING
.- 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
areASCENDING
andDESCENDING
. -
-
-
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 interfaceToCopyableBuilder<GetSavingsPlansCoverageRequest.Builder,
GetSavingsPlansCoverageRequest> - Specified by:
toBuilder
in classCostExplorerRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-