Interface GetReservationCoverageRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<GetReservationCoverageRequest.Builder,
,GetReservationCoverageRequest> CostExplorerRequest.Builder
,SdkBuilder<GetReservationCoverageRequest.Builder,
,GetReservationCoverageRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
GetReservationCoverageRequest
-
Method Summary
Modifier and TypeMethodDescriptionfilter
(Consumer<Expression.Builder> filter) Filters utilization data by dimensions.filter
(Expression filter) Filters utilization data by dimensions.granularity
(String granularity) The granularity of the Amazon Web Services cost data for the reservation.granularity
(Granularity granularity) The granularity of the Amazon Web Services cost data for the reservation.groupBy
(Collection<GroupDefinition> groupBy) You can group the data by the following attributes:groupBy
(Consumer<GroupDefinition.Builder>... groupBy) You can group the data by the following attributes:groupBy
(GroupDefinition... groupBy) You can group the data by the following attributes:maxResults
(Integer maxResults) The maximum number of objects that you returned for this request.The measurement that you want your reservation coverage reported in.metrics
(Collection<String> metrics) The measurement that you want your reservation coverage reported in.nextPageToken
(String nextPageToken) The token to retrieve the next set of results.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.sortBy
(Consumer<SortDefinition.Builder> sortBy) The value by which you want to sort the data.sortBy
(SortDefinition sortBy) The value by which you want to sort the data.timePeriod
(Consumer<DateInterval.Builder> timePeriod) The start and end dates of the period that you want to retrieve data about reservation coverage for.timePeriod
(DateInterval timePeriod) The start and end dates of the period that you want to retrieve data about reservation coverage for.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.costexplorer.model.CostExplorerRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
timePeriod
The start and end dates of the period that you want to retrieve data about reservation coverage for. You can retrieve data for a maximum of 13 months: the last 12 months and the current month. The start date is inclusive, but the end date is exclusive. For example, if
start
is2017-01-01
andend
is2017-05-01
, then the cost and usage data is retrieved from2017-01-01
up to and including2017-04-30
but not including2017-05-01
.- Parameters:
timePeriod
- The start and end dates of the period that you want to retrieve data about reservation coverage for. You can retrieve data for a maximum of 13 months: the last 12 months and the current month. The start date is inclusive, but the end date is exclusive. For example, ifstart
is2017-01-01
andend
is2017-05-01
, then the cost and usage data is retrieved from2017-01-01
up to and including2017-04-30
but not including2017-05-01
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
timePeriod
The start and end dates of the period that you want to retrieve data about reservation coverage for. You can retrieve data for a maximum of 13 months: the last 12 months and the current month. The start date is inclusive, but the end date is exclusive. For example, if
This is a convenience method that creates an instance of thestart
is2017-01-01
andend
is2017-05-01
, then the cost and usage data is retrieved from2017-01-01
up to and including2017-04-30
but not including2017-05-01
.DateInterval.Builder
avoiding the need to create one manually viaDateInterval.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totimePeriod(DateInterval)
.- Parameters:
timePeriod
- a consumer that will call methods onDateInterval.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
groupBy
You can group the data by the following attributes:
-
AZ
-
CACHE_ENGINE
-
DATABASE_ENGINE
-
DEPLOYMENT_OPTION
-
INSTANCE_TYPE
-
INVOICING_ENTITY
-
LINKED_ACCOUNT
-
OPERATING_SYSTEM
-
PLATFORM
-
REGION
-
TENANCY
- Parameters:
groupBy
- You can group the data by the following attributes:-
AZ
-
CACHE_ENGINE
-
DATABASE_ENGINE
-
DEPLOYMENT_OPTION
-
INSTANCE_TYPE
-
INVOICING_ENTITY
-
LINKED_ACCOUNT
-
OPERATING_SYSTEM
-
PLATFORM
-
REGION
-
TENANCY
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
groupBy
You can group the data by the following attributes:
-
AZ
-
CACHE_ENGINE
-
DATABASE_ENGINE
-
DEPLOYMENT_OPTION
-
INSTANCE_TYPE
-
INVOICING_ENTITY
-
LINKED_ACCOUNT
-
OPERATING_SYSTEM
-
PLATFORM
-
REGION
-
TENANCY
- Parameters:
groupBy
- You can group the data by the following attributes:-
AZ
-
CACHE_ENGINE
-
DATABASE_ENGINE
-
DEPLOYMENT_OPTION
-
INSTANCE_TYPE
-
INVOICING_ENTITY
-
LINKED_ACCOUNT
-
OPERATING_SYSTEM
-
PLATFORM
-
REGION
-
TENANCY
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
groupBy
You can group the data by the following attributes:
-
AZ
-
CACHE_ENGINE
-
DATABASE_ENGINE
-
DEPLOYMENT_OPTION
-
INSTANCE_TYPE
-
INVOICING_ENTITY
-
LINKED_ACCOUNT
-
OPERATING_SYSTEM
-
PLATFORM
-
REGION
-
TENANCY
GroupDefinition.Builder
avoiding the need to create one manually viaGroupDefinition.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed togroupBy(List<GroupDefinition>)
.- Parameters:
groupBy
- a consumer that will call methods onGroupDefinition.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
granularity
The granularity of the Amazon Web Services cost data for the reservation. Valid values are
MONTHLY
andDAILY
.If
GroupBy
is set,Granularity
can't be set. IfGranularity
isn't set, the response object doesn't includeGranularity
, eitherMONTHLY
orDAILY
.The
GetReservationCoverage
operation supports onlyDAILY
andMONTHLY
granularities.- Parameters:
granularity
- The granularity of the Amazon Web Services cost data for the reservation. Valid values areMONTHLY
andDAILY
.If
GroupBy
is set,Granularity
can't be set. IfGranularity
isn't set, the response object doesn't includeGranularity
, eitherMONTHLY
orDAILY
.The
GetReservationCoverage
operation supports onlyDAILY
andMONTHLY
granularities.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
granularity
The granularity of the Amazon Web Services cost data for the reservation. Valid values are
MONTHLY
andDAILY
.If
GroupBy
is set,Granularity
can't be set. IfGranularity
isn't set, the response object doesn't includeGranularity
, eitherMONTHLY
orDAILY
.The
GetReservationCoverage
operation supports onlyDAILY
andMONTHLY
granularities.- Parameters:
granularity
- The granularity of the Amazon Web Services cost data for the reservation. Valid values areMONTHLY
andDAILY
.If
GroupBy
is set,Granularity
can't be set. IfGranularity
isn't set, the response object doesn't includeGranularity
, eitherMONTHLY
orDAILY
.The
GetReservationCoverage
operation supports onlyDAILY
andMONTHLY
granularities.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
-
TAG
-
TENANCY
GetReservationCoverage
uses the same Expression object as the other operations, but onlyAND
is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR'd together.If you don't provide a
SERVICE
filter, Cost Explorer defaults to EC2.Cost category is also supported.
- Parameters:
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
-
TAG
-
TENANCY
GetReservationCoverage
uses the same Expression object as the other operations, but onlyAND
is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR'd together.If you don't provide a
SERVICE
filter, Cost Explorer defaults to EC2.Cost category is also supported.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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
-
TAG
-
TENANCY
GetReservationCoverage
uses the same Expression object as the other operations, but onlyAND
is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR'd together.If you don't provide a
SERVICE
filter, Cost Explorer defaults to EC2.Cost category is also supported.
This is a convenience method that creates an instance of theExpression.Builder
avoiding the need to create one manually viaExpression.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofilter(Expression)
.- Parameters:
filter
- a consumer that will call methods onExpression.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
metrics
The measurement that you want your reservation coverage reported in.
Valid values are
Hour
,Unit
, andCost
. You can use multiple values in a request.- Parameters:
metrics
- The measurement that you want your reservation coverage reported in.Valid values are
Hour
,Unit
, andCost
. You can use multiple values in a request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
metrics
The measurement that you want your reservation coverage reported in.
Valid values are
Hour
,Unit
, andCost
. You can use multiple values in a request.- Parameters:
metrics
- The measurement that you want your reservation coverage reported in.Valid values are
Hour
,Unit
, andCost
. You can use multiple values in a request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
sortBy
The value by which you want to sort the data.
The following values are supported for
Key
:-
OnDemandCost
-
CoverageHoursPercentage
-
OnDemandHours
-
ReservedHours
-
TotalRunningHours
-
CoverageNormalizedUnitsPercentage
-
OnDemandNormalizedUnits
-
ReservedNormalizedUnits
-
TotalRunningNormalizedUnits
-
Time
Supported values for
SortOrder
areASCENDING
orDESCENDING
.- Parameters:
sortBy
- The value by which you want to sort the data.The following values are supported for
Key
:-
OnDemandCost
-
CoverageHoursPercentage
-
OnDemandHours
-
ReservedHours
-
TotalRunningHours
-
CoverageNormalizedUnitsPercentage
-
OnDemandNormalizedUnits
-
ReservedNormalizedUnits
-
TotalRunningNormalizedUnits
-
Time
Supported values for
SortOrder
areASCENDING
orDESCENDING
.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
sortBy
The value by which you want to sort the data.
The following values are supported for
Key
:-
OnDemandCost
-
CoverageHoursPercentage
-
OnDemandHours
-
ReservedHours
-
TotalRunningHours
-
CoverageNormalizedUnitsPercentage
-
OnDemandNormalizedUnits
-
ReservedNormalizedUnits
-
TotalRunningNormalizedUnits
-
Time
Supported values for
This is a convenience method that creates an instance of theSortOrder
areASCENDING
orDESCENDING
.SortDefinition.Builder
avoiding the need to create one manually viaSortDefinition.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosortBy(SortDefinition)
.- Parameters:
sortBy
- a consumer that will call methods onSortDefinition.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
GetReservationCoverageRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
GetReservationCoverageRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-