@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DescribeDimensionKeysRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
DescribeDimensionKeysRequest() |
Modifier and Type | Method and Description |
---|---|
DescribeDimensionKeysRequest |
addFilterEntry(String key,
String value)
Add a single Filter entry
|
DescribeDimensionKeysRequest |
clearFilterEntries()
Removes all the entries added into Filter.
|
DescribeDimensionKeysRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
Date |
getEndTime()
The date and time specifying the end of the requested time series data.
|
Map<String,String> |
getFilter()
One or more filters to apply in the request.
|
DimensionGroup |
getGroupBy()
A specification for how to aggregate the data points from a query result.
|
String |
getIdentifier()
An immutable, AWS Region-unique identifier for a data source.
|
Integer |
getMaxResults()
The maximum number of items to return in the response.
|
String |
getMetric()
The name of a Performance Insights metric to be measured.
|
String |
getNextToken()
An optional pagination token provided by a previous request.
|
DimensionGroup |
getPartitionBy()
For each dimension specified in
GroupBy , specify a secondary dimension to further subdivide the
partition keys in the response. |
Integer |
getPeriodInSeconds()
The granularity, in seconds, of the data points returned from Performance Insights.
|
String |
getServiceType()
The AWS service for which Performance Insights will return metrics.
|
Date |
getStartTime()
The date and time specifying the beginning of the requested time series data.
|
int |
hashCode() |
void |
setEndTime(Date endTime)
The date and time specifying the end of the requested time series data.
|
void |
setFilter(Map<String,String> filter)
One or more filters to apply in the request.
|
void |
setGroupBy(DimensionGroup groupBy)
A specification for how to aggregate the data points from a query result.
|
void |
setIdentifier(String identifier)
An immutable, AWS Region-unique identifier for a data source.
|
void |
setMaxResults(Integer maxResults)
The maximum number of items to return in the response.
|
void |
setMetric(String metric)
The name of a Performance Insights metric to be measured.
|
void |
setNextToken(String nextToken)
An optional pagination token provided by a previous request.
|
void |
setPartitionBy(DimensionGroup partitionBy)
For each dimension specified in
GroupBy , specify a secondary dimension to further subdivide the
partition keys in the response. |
void |
setPeriodInSeconds(Integer periodInSeconds)
The granularity, in seconds, of the data points returned from Performance Insights.
|
void |
setServiceType(String serviceType)
The AWS service for which Performance Insights will return metrics.
|
void |
setStartTime(Date startTime)
The date and time specifying the beginning of the requested time series data.
|
String |
toString()
Returns a string representation of this object.
|
DescribeDimensionKeysRequest |
withEndTime(Date endTime)
The date and time specifying the end of the requested time series data.
|
DescribeDimensionKeysRequest |
withFilter(Map<String,String> filter)
One or more filters to apply in the request.
|
DescribeDimensionKeysRequest |
withGroupBy(DimensionGroup groupBy)
A specification for how to aggregate the data points from a query result.
|
DescribeDimensionKeysRequest |
withIdentifier(String identifier)
An immutable, AWS Region-unique identifier for a data source.
|
DescribeDimensionKeysRequest |
withMaxResults(Integer maxResults)
The maximum number of items to return in the response.
|
DescribeDimensionKeysRequest |
withMetric(String metric)
The name of a Performance Insights metric to be measured.
|
DescribeDimensionKeysRequest |
withNextToken(String nextToken)
An optional pagination token provided by a previous request.
|
DescribeDimensionKeysRequest |
withPartitionBy(DimensionGroup partitionBy)
For each dimension specified in
GroupBy , specify a secondary dimension to further subdivide the
partition keys in the response. |
DescribeDimensionKeysRequest |
withPeriodInSeconds(Integer periodInSeconds)
The granularity, in seconds, of the data points returned from Performance Insights.
|
DescribeDimensionKeysRequest |
withServiceType(ServiceType serviceType)
The AWS service for which Performance Insights will return metrics.
|
DescribeDimensionKeysRequest |
withServiceType(String serviceType)
The AWS service for which Performance Insights will return metrics.
|
DescribeDimensionKeysRequest |
withStartTime(Date startTime)
The date and time specifying the beginning of the requested time series data.
|
addHandlerContext, 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 setServiceType(String serviceType)
The AWS service for which Performance Insights will return metrics. The only valid value for ServiceType
is RDS
.
serviceType
- The AWS service for which Performance Insights will return metrics. The only valid value for
ServiceType is RDS
.ServiceType
public String getServiceType()
The AWS service for which Performance Insights will return metrics. The only valid value for ServiceType
is RDS
.
RDS
.ServiceType
public DescribeDimensionKeysRequest withServiceType(String serviceType)
The AWS service for which Performance Insights will return metrics. The only valid value for ServiceType
is RDS
.
serviceType
- The AWS service for which Performance Insights will return metrics. The only valid value for
ServiceType is RDS
.ServiceType
public DescribeDimensionKeysRequest withServiceType(ServiceType serviceType)
The AWS service for which Performance Insights will return metrics. The only valid value for ServiceType
is RDS
.
serviceType
- The AWS service for which Performance Insights will return metrics. The only valid value for
ServiceType is RDS
.ServiceType
public void setIdentifier(String identifier)
An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.
To use an Amazon RDS instance as a data source, you specify its DbiResourceId
value. For example,
specify db-FAIHNTYBKTGAUSUZQYPDS2GW4A
identifier
- An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from
this data source.
To use an Amazon RDS instance as a data source, you specify its DbiResourceId
value. For
example, specify db-FAIHNTYBKTGAUSUZQYPDS2GW4A
public String getIdentifier()
An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.
To use an Amazon RDS instance as a data source, you specify its DbiResourceId
value. For example,
specify db-FAIHNTYBKTGAUSUZQYPDS2GW4A
To use an Amazon RDS instance as a data source, you specify its DbiResourceId
value. For
example, specify db-FAIHNTYBKTGAUSUZQYPDS2GW4A
public DescribeDimensionKeysRequest withIdentifier(String identifier)
An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.
To use an Amazon RDS instance as a data source, you specify its DbiResourceId
value. For example,
specify db-FAIHNTYBKTGAUSUZQYPDS2GW4A
identifier
- An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from
this data source.
To use an Amazon RDS instance as a data source, you specify its DbiResourceId
value. For
example, specify db-FAIHNTYBKTGAUSUZQYPDS2GW4A
public void setStartTime(Date startTime)
The date and time specifying the beginning of the requested time series data. You must specify a
StartTime
within the past 7 days. The value specified is inclusive, which means that data
points equal to or greater than StartTime
are returned.
The value for StartTime
must be earlier than the value for EndTime
.
startTime
- The date and time specifying the beginning of the requested time series data. You must specify a
StartTime
within the past 7 days. The value specified is inclusive, which means that
data points equal to or greater than StartTime
are returned.
The value for StartTime
must be earlier than the value for EndTime
.
public Date getStartTime()
The date and time specifying the beginning of the requested time series data. You must specify a
StartTime
within the past 7 days. The value specified is inclusive, which means that data
points equal to or greater than StartTime
are returned.
The value for StartTime
must be earlier than the value for EndTime
.
StartTime
within the past 7 days. The value specified is inclusive, which means that
data points equal to or greater than StartTime
are returned.
The value for StartTime
must be earlier than the value for EndTime
.
public DescribeDimensionKeysRequest withStartTime(Date startTime)
The date and time specifying the beginning of the requested time series data. You must specify a
StartTime
within the past 7 days. The value specified is inclusive, which means that data
points equal to or greater than StartTime
are returned.
The value for StartTime
must be earlier than the value for EndTime
.
startTime
- The date and time specifying the beginning of the requested time series data. You must specify a
StartTime
within the past 7 days. The value specified is inclusive, which means that
data points equal to or greater than StartTime
are returned.
The value for StartTime
must be earlier than the value for EndTime
.
public void setEndTime(Date endTime)
The date and time specifying the end of the requested time series data. The value specified is exclusive,
which means that data points less than (but not equal to) EndTime
are returned.
The value for EndTime
must be later than the value for StartTime
.
endTime
- The date and time specifying the end of the requested time series data. The value specified is
exclusive, which means that data points less than (but not equal to) EndTime
are
returned.
The value for EndTime
must be later than the value for StartTime
.
public Date getEndTime()
The date and time specifying the end of the requested time series data. The value specified is exclusive,
which means that data points less than (but not equal to) EndTime
are returned.
The value for EndTime
must be later than the value for StartTime
.
EndTime
are
returned.
The value for EndTime
must be later than the value for StartTime
.
public DescribeDimensionKeysRequest withEndTime(Date endTime)
The date and time specifying the end of the requested time series data. The value specified is exclusive,
which means that data points less than (but not equal to) EndTime
are returned.
The value for EndTime
must be later than the value for StartTime
.
endTime
- The date and time specifying the end of the requested time series data. The value specified is
exclusive, which means that data points less than (but not equal to) EndTime
are
returned.
The value for EndTime
must be later than the value for StartTime
.
public void setMetric(String metric)
The name of a Performance Insights metric to be measured.
Valid values for Metric
are:
db.load.avg
- a scaled representation of the number of active sessions for the database engine.
db.sampledload.avg
- the raw number of active sessions for the database engine.
If the number of active sessions is less than an internal Performance Insights threshold,
db.load.avg
and db.sampledload.avg
are the same value. If the number of active sessions
is greater than the internal threshold, Performance Insights samples the active sessions, with
db.load.avg
showing the scaled values, db.sampledload.avg
showing the raw values, and
db.sampledload.avg
less than db.load.avg
. For most use cases, you can query
db.load.avg
only.
metric
- The name of a Performance Insights metric to be measured.
Valid values for Metric
are:
db.load.avg
- a scaled representation of the number of active sessions for the database
engine.
db.sampledload.avg
- the raw number of active sessions for the database engine.
If the number of active sessions is less than an internal Performance Insights threshold,
db.load.avg
and db.sampledload.avg
are the same value. If the number of active
sessions is greater than the internal threshold, Performance Insights samples the active sessions, with
db.load.avg
showing the scaled values, db.sampledload.avg
showing the raw
values, and db.sampledload.avg
less than db.load.avg
. For most use cases, you
can query db.load.avg
only.
public String getMetric()
The name of a Performance Insights metric to be measured.
Valid values for Metric
are:
db.load.avg
- a scaled representation of the number of active sessions for the database engine.
db.sampledload.avg
- the raw number of active sessions for the database engine.
If the number of active sessions is less than an internal Performance Insights threshold,
db.load.avg
and db.sampledload.avg
are the same value. If the number of active sessions
is greater than the internal threshold, Performance Insights samples the active sessions, with
db.load.avg
showing the scaled values, db.sampledload.avg
showing the raw values, and
db.sampledload.avg
less than db.load.avg
. For most use cases, you can query
db.load.avg
only.
Valid values for Metric
are:
db.load.avg
- a scaled representation of the number of active sessions for the database
engine.
db.sampledload.avg
- the raw number of active sessions for the database engine.
If the number of active sessions is less than an internal Performance Insights threshold,
db.load.avg
and db.sampledload.avg
are the same value. If the number of active
sessions is greater than the internal threshold, Performance Insights samples the active sessions, with
db.load.avg
showing the scaled values, db.sampledload.avg
showing the raw
values, and db.sampledload.avg
less than db.load.avg
. For most use cases, you
can query db.load.avg
only.
public DescribeDimensionKeysRequest withMetric(String metric)
The name of a Performance Insights metric to be measured.
Valid values for Metric
are:
db.load.avg
- a scaled representation of the number of active sessions for the database engine.
db.sampledload.avg
- the raw number of active sessions for the database engine.
If the number of active sessions is less than an internal Performance Insights threshold,
db.load.avg
and db.sampledload.avg
are the same value. If the number of active sessions
is greater than the internal threshold, Performance Insights samples the active sessions, with
db.load.avg
showing the scaled values, db.sampledload.avg
showing the raw values, and
db.sampledload.avg
less than db.load.avg
. For most use cases, you can query
db.load.avg
only.
metric
- The name of a Performance Insights metric to be measured.
Valid values for Metric
are:
db.load.avg
- a scaled representation of the number of active sessions for the database
engine.
db.sampledload.avg
- the raw number of active sessions for the database engine.
If the number of active sessions is less than an internal Performance Insights threshold,
db.load.avg
and db.sampledload.avg
are the same value. If the number of active
sessions is greater than the internal threshold, Performance Insights samples the active sessions, with
db.load.avg
showing the scaled values, db.sampledload.avg
showing the raw
values, and db.sampledload.avg
less than db.load.avg
. For most use cases, you
can query db.load.avg
only.
public void setPeriodInSeconds(Integer periodInSeconds)
The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are:
1
(one second)
60
(one minute)
300
(five minutes)
3600
(one hour)
86400
(twenty-four hours)
If you don't specify PeriodInSeconds
, then Performance Insights chooses a value for you, with a goal
of returning roughly 100-200 data points in the response.
periodInSeconds
- The granularity, in seconds, of the data points returned from Performance Insights. A period can be as
short as one second, or as long as one day (86400 seconds). Valid values are:
1
(one second)
60
(one minute)
300
(five minutes)
3600
(one hour)
86400
(twenty-four hours)
If you don't specify PeriodInSeconds
, then Performance Insights chooses a value for you, with
a goal of returning roughly 100-200 data points in the response.
public Integer getPeriodInSeconds()
The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are:
1
(one second)
60
(one minute)
300
(five minutes)
3600
(one hour)
86400
(twenty-four hours)
If you don't specify PeriodInSeconds
, then Performance Insights chooses a value for you, with a goal
of returning roughly 100-200 data points in the response.
1
(one second)
60
(one minute)
300
(five minutes)
3600
(one hour)
86400
(twenty-four hours)
If you don't specify PeriodInSeconds
, then Performance Insights chooses a value for you,
with a goal of returning roughly 100-200 data points in the response.
public DescribeDimensionKeysRequest withPeriodInSeconds(Integer periodInSeconds)
The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are:
1
(one second)
60
(one minute)
300
(five minutes)
3600
(one hour)
86400
(twenty-four hours)
If you don't specify PeriodInSeconds
, then Performance Insights chooses a value for you, with a goal
of returning roughly 100-200 data points in the response.
periodInSeconds
- The granularity, in seconds, of the data points returned from Performance Insights. A period can be as
short as one second, or as long as one day (86400 seconds). Valid values are:
1
(one second)
60
(one minute)
300
(five minutes)
3600
(one hour)
86400
(twenty-four hours)
If you don't specify PeriodInSeconds
, then Performance Insights chooses a value for you, with
a goal of returning roughly 100-200 data points in the response.
public void setGroupBy(DimensionGroup groupBy)
A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights returns all dimensions within this group, unless you provide the names of specific dimensions within this group. You can also request that Performance Insights return a limited number of values for a dimension.
groupBy
- A specification for how to aggregate the data points from a query result. You must specify a valid
dimension group. Performance Insights returns all dimensions within this group, unless you provide the
names of specific dimensions within this group. You can also request that Performance Insights return a
limited number of values for a dimension.public DimensionGroup getGroupBy()
A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights returns all dimensions within this group, unless you provide the names of specific dimensions within this group. You can also request that Performance Insights return a limited number of values for a dimension.
public DescribeDimensionKeysRequest withGroupBy(DimensionGroup groupBy)
A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights returns all dimensions within this group, unless you provide the names of specific dimensions within this group. You can also request that Performance Insights return a limited number of values for a dimension.
groupBy
- A specification for how to aggregate the data points from a query result. You must specify a valid
dimension group. Performance Insights returns all dimensions within this group, unless you provide the
names of specific dimensions within this group. You can also request that Performance Insights return a
limited number of values for a dimension.public void setPartitionBy(DimensionGroup partitionBy)
For each dimension specified in GroupBy
, specify a secondary dimension to further subdivide the
partition keys in the response.
partitionBy
- For each dimension specified in GroupBy
, specify a secondary dimension to further subdivide
the partition keys in the response.public DimensionGroup getPartitionBy()
For each dimension specified in GroupBy
, specify a secondary dimension to further subdivide the
partition keys in the response.
GroupBy
, specify a secondary dimension to further subdivide
the partition keys in the response.public DescribeDimensionKeysRequest withPartitionBy(DimensionGroup partitionBy)
For each dimension specified in GroupBy
, specify a secondary dimension to further subdivide the
partition keys in the response.
partitionBy
- For each dimension specified in GroupBy
, specify a secondary dimension to further subdivide
the partition keys in the response.public Map<String,String> getFilter()
One or more filters to apply in the request. Restrictions:
Any number of filters by the same dimension, as specified in the GroupBy
or Partition
parameters.
A single filter for any other dimension in this dimension group.
Any number of filters by the same dimension, as specified in the GroupBy
or
Partition
parameters.
A single filter for any other dimension in this dimension group.
public void setFilter(Map<String,String> filter)
One or more filters to apply in the request. Restrictions:
Any number of filters by the same dimension, as specified in the GroupBy
or Partition
parameters.
A single filter for any other dimension in this dimension group.
filter
- One or more filters to apply in the request. Restrictions:
Any number of filters by the same dimension, as specified in the GroupBy
or
Partition
parameters.
A single filter for any other dimension in this dimension group.
public DescribeDimensionKeysRequest withFilter(Map<String,String> filter)
One or more filters to apply in the request. Restrictions:
Any number of filters by the same dimension, as specified in the GroupBy
or Partition
parameters.
A single filter for any other dimension in this dimension group.
filter
- One or more filters to apply in the request. Restrictions:
Any number of filters by the same dimension, as specified in the GroupBy
or
Partition
parameters.
A single filter for any other dimension in this dimension group.
public DescribeDimensionKeysRequest addFilterEntry(String key, String value)
public DescribeDimensionKeysRequest clearFilterEntries()
public void setMaxResults(Integer maxResults)
The maximum number of items to return in the response. If more items exist than the specified
MaxRecords
value, a pagination token is included in the response so that the remaining results can
be retrieved.
maxResults
- The maximum number of items to return in the response. If more items exist than the specified
MaxRecords
value, a pagination token is included in the response so that the remaining
results can be retrieved.public Integer getMaxResults()
The maximum number of items to return in the response. If more items exist than the specified
MaxRecords
value, a pagination token is included in the response so that the remaining results can
be retrieved.
MaxRecords
value, a pagination token is included in the response so that the remaining
results can be retrieved.public DescribeDimensionKeysRequest withMaxResults(Integer maxResults)
The maximum number of items to return in the response. If more items exist than the specified
MaxRecords
value, a pagination token is included in the response so that the remaining results can
be retrieved.
maxResults
- The maximum number of items to return in the response. If more items exist than the specified
MaxRecords
value, a pagination token is included in the response so that the remaining
results can be retrieved.public void setNextToken(String nextToken)
An optional pagination token provided by a previous request. If this parameter is specified, the response
includes only records beyond the token, up to the value specified by MaxRecords
.
nextToken
- An optional pagination token provided by a previous request. If this parameter is specified, the response
includes only records beyond the token, up to the value specified by MaxRecords
.public String getNextToken()
An optional pagination token provided by a previous request. If this parameter is specified, the response
includes only records beyond the token, up to the value specified by MaxRecords
.
MaxRecords
.public DescribeDimensionKeysRequest withNextToken(String nextToken)
An optional pagination token provided by a previous request. If this parameter is specified, the response
includes only records beyond the token, up to the value specified by MaxRecords
.
nextToken
- An optional pagination token provided by a previous request. If this parameter is specified, the response
includes only records beyond the token, up to the value specified by MaxRecords
.public String toString()
toString
in class Object
Object.toString()
public DescribeDimensionKeysRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()