@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class GetReservationCoverageRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
You can use the following request parameters to query for how much of your instance usage is covered by a reservation.
NOOP
Constructor and Description |
---|
GetReservationCoverageRequest() |
Modifier and Type | Method and Description |
---|---|
GetReservationCoverageRequest |
clone() |
boolean |
equals(Object obj) |
Expression |
getFilter()
Filters utilization data by dimensions.
|
String |
getGranularity()
The granularity of the AWS cost data for the reservation.
|
List<GroupDefinition> |
getGroupBy()
You can group the data by the following attributes:
|
String |
getNextPageToken()
The token to retrieve the next set of results.
|
DateInterval |
getTimePeriod()
The start and end dates of the period for which you want to retrieve data about reservation coverage.
|
int |
hashCode() |
void |
setFilter(Expression filter)
Filters utilization data by dimensions.
|
void |
setGranularity(String granularity)
The granularity of the AWS cost data for the reservation.
|
void |
setGroupBy(Collection<GroupDefinition> groupBy)
You can group the data by the following attributes:
|
void |
setNextPageToken(String nextPageToken)
The token to retrieve the next set of results.
|
void |
setTimePeriod(DateInterval timePeriod)
The start and end dates of the period for which you want to retrieve data about reservation coverage.
|
String |
toString()
Returns a string representation of this object; useful for testing and debugging.
|
GetReservationCoverageRequest |
withFilter(Expression filter)
Filters utilization data by dimensions.
|
GetReservationCoverageRequest |
withGranularity(Granularity granularity)
The granularity of the AWS cost data for the reservation.
|
GetReservationCoverageRequest |
withGranularity(String granularity)
The granularity of the AWS cost data for the reservation.
|
GetReservationCoverageRequest |
withGroupBy(Collection<GroupDefinition> groupBy)
You can group the data by the following attributes:
|
GetReservationCoverageRequest |
withGroupBy(GroupDefinition... groupBy)
You can group the data by the following attributes:
|
GetReservationCoverageRequest |
withNextPageToken(String nextPageToken)
The token to retrieve the next set of results.
|
GetReservationCoverageRequest |
withTimePeriod(DateInterval timePeriod)
The start and end dates of the period for which you want to retrieve data about reservation coverage.
|
addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setTimePeriod(DateInterval timePeriod)
The start and end dates of the period for which you want to retrieve data about reservation coverage. 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
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
.
timePeriod
- The start and end dates of the period for which you want to retrieve data about reservation coverage. 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
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
.public DateInterval getTimePeriod()
The start and end dates of the period for which you want to retrieve data about reservation coverage. 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
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
.
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
.public GetReservationCoverageRequest withTimePeriod(DateInterval timePeriod)
The start and end dates of the period for which you want to retrieve data about reservation coverage. 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
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
.
timePeriod
- The start and end dates of the period for which you want to retrieve data about reservation coverage. 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
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
.public List<GroupDefinition> getGroupBy()
You can group the data by the following attributes:
AZ
CACHE_ENGINE
DATABASE_ENGINE
DEPLOYMENT_OPTION
INSTANCE_TYPE
LINKED_ACCOUNT
OPERATING_SYSTEM
PLATFORM
REGION
TAG
TENANCY
AZ
CACHE_ENGINE
DATABASE_ENGINE
DEPLOYMENT_OPTION
INSTANCE_TYPE
LINKED_ACCOUNT
OPERATING_SYSTEM
PLATFORM
REGION
TAG
TENANCY
public void setGroupBy(Collection<GroupDefinition> groupBy)
You can group the data by the following attributes:
AZ
CACHE_ENGINE
DATABASE_ENGINE
DEPLOYMENT_OPTION
INSTANCE_TYPE
LINKED_ACCOUNT
OPERATING_SYSTEM
PLATFORM
REGION
TAG
TENANCY
groupBy
- You can group the data by the following attributes:
AZ
CACHE_ENGINE
DATABASE_ENGINE
DEPLOYMENT_OPTION
INSTANCE_TYPE
LINKED_ACCOUNT
OPERATING_SYSTEM
PLATFORM
REGION
TAG
TENANCY
public GetReservationCoverageRequest withGroupBy(GroupDefinition... groupBy)
You can group the data by the following attributes:
AZ
CACHE_ENGINE
DATABASE_ENGINE
DEPLOYMENT_OPTION
INSTANCE_TYPE
LINKED_ACCOUNT
OPERATING_SYSTEM
PLATFORM
REGION
TAG
TENANCY
NOTE: This method appends the values to the existing list (if any). Use
setGroupBy(java.util.Collection)
or withGroupBy(java.util.Collection)
if you want to override
the existing values.
groupBy
- You can group the data by the following attributes:
AZ
CACHE_ENGINE
DATABASE_ENGINE
DEPLOYMENT_OPTION
INSTANCE_TYPE
LINKED_ACCOUNT
OPERATING_SYSTEM
PLATFORM
REGION
TAG
TENANCY
public GetReservationCoverageRequest withGroupBy(Collection<GroupDefinition> groupBy)
You can group the data by the following attributes:
AZ
CACHE_ENGINE
DATABASE_ENGINE
DEPLOYMENT_OPTION
INSTANCE_TYPE
LINKED_ACCOUNT
OPERATING_SYSTEM
PLATFORM
REGION
TAG
TENANCY
groupBy
- You can group the data by the following attributes:
AZ
CACHE_ENGINE
DATABASE_ENGINE
DEPLOYMENT_OPTION
INSTANCE_TYPE
LINKED_ACCOUNT
OPERATING_SYSTEM
PLATFORM
REGION
TAG
TENANCY
public void setGranularity(String granularity)
The granularity of the AWS cost data for the reservation. Valid values are MONTHLY
and
DAILY
.
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
.
granularity
- The granularity of the AWS cost data for the reservation. Valid values are MONTHLY
and
DAILY
.
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
.
Granularity
public String getGranularity()
The granularity of the AWS cost data for the reservation. Valid values are MONTHLY
and
DAILY
.
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
.
MONTHLY
and
DAILY
.
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
.
Granularity
public GetReservationCoverageRequest withGranularity(String granularity)
The granularity of the AWS cost data for the reservation. Valid values are MONTHLY
and
DAILY
.
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
.
granularity
- The granularity of the AWS cost data for the reservation. Valid values are MONTHLY
and
DAILY
.
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
.
Granularity
public GetReservationCoverageRequest withGranularity(Granularity granularity)
The granularity of the AWS cost data for the reservation. Valid values are MONTHLY
and
DAILY
.
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
.
granularity
- The granularity of the AWS cost data for the reservation. Valid values are MONTHLY
and
DAILY
.
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
.
Granularity
public void setFilter(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
TAG
TENANCY
GetReservationCoverage
uses the same
Expression
object as the other operations, but only AND
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.
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 only AND
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.
public Expression getFilter()
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 only AND
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.
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 only AND
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.
public GetReservationCoverageRequest withFilter(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
TAG
TENANCY
GetReservationCoverage
uses the same
Expression
object as the other operations, but only AND
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.
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 only AND
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.
public void setNextPageToken(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.
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.public String getNextPageToken()
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.
public GetReservationCoverageRequest withNextPageToken(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.
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.public String toString()
toString
in class Object
Object.toString()
public GetReservationCoverageRequest clone()
clone
in class AmazonWebServiceRequest
Copyright © 2018. All rights reserved.