public static interface DescribeDimensionKeysRequest.Builder extends PiRequest.Builder, SdkPojo, CopyableBuilder<DescribeDimensionKeysRequest.Builder,DescribeDimensionKeysRequest>
| Modifier and Type | Method and Description |
|---|---|
DescribeDimensionKeysRequest.Builder |
additionalMetrics(Collection<String> additionalMetrics)
Additional metrics for the top
N dimension keys. |
DescribeDimensionKeysRequest.Builder |
additionalMetrics(String... additionalMetrics)
Additional metrics for the top
N dimension keys. |
DescribeDimensionKeysRequest.Builder |
endTime(Instant endTime)
The date and time specifying the end of the requested time series data.
|
DescribeDimensionKeysRequest.Builder |
filter(Map<String,String> filter)
One or more filters to apply in the request.
|
default DescribeDimensionKeysRequest.Builder |
groupBy(Consumer<DimensionGroup.Builder> groupBy)
A specification for how to aggregate the data points from a query result.
|
DescribeDimensionKeysRequest.Builder |
groupBy(DimensionGroup groupBy)
A specification for how to aggregate the data points from a query result.
|
DescribeDimensionKeysRequest.Builder |
identifier(String identifier)
An immutable, Amazon Web Services Region-unique identifier for a data source.
|
DescribeDimensionKeysRequest.Builder |
maxResults(Integer maxResults)
The maximum number of items to return in the response.
|
DescribeDimensionKeysRequest.Builder |
metric(String metric)
The name of a Performance Insights metric to be measured.
|
DescribeDimensionKeysRequest.Builder |
nextToken(String nextToken)
An optional pagination token provided by a previous request.
|
DescribeDimensionKeysRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
DescribeDimensionKeysRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
default DescribeDimensionKeysRequest.Builder |
partitionBy(Consumer<DimensionGroup.Builder> partitionBy)
For each dimension specified in
GroupBy, specify a secondary dimension to further subdivide the
partition keys in the response. |
DescribeDimensionKeysRequest.Builder |
partitionBy(DimensionGroup partitionBy)
For each dimension specified in
GroupBy, specify a secondary dimension to further subdivide the
partition keys in the response. |
DescribeDimensionKeysRequest.Builder |
periodInSeconds(Integer periodInSeconds)
The granularity, in seconds, of the data points returned from Performance Insights.
|
DescribeDimensionKeysRequest.Builder |
serviceType(ServiceType serviceType)
The Amazon Web Services service for which Performance Insights will return metrics.
|
DescribeDimensionKeysRequest.Builder |
serviceType(String serviceType)
The Amazon Web Services service for which Performance Insights will return metrics.
|
DescribeDimensionKeysRequest.Builder |
startTime(Instant startTime)
The date and time specifying the beginning of the requested time series data.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildDescribeDimensionKeysRequest.Builder serviceType(String serviceType)
The Amazon Web Services service for which Performance Insights will return metrics. Valid values are as follows:
RDS
DOCDB
serviceType - The Amazon Web Services service for which Performance Insights will return metrics. Valid values are
as follows:
RDS
DOCDB
ServiceType,
ServiceTypeDescribeDimensionKeysRequest.Builder serviceType(ServiceType serviceType)
The Amazon Web Services service for which Performance Insights will return metrics. Valid values are as follows:
RDS
DOCDB
serviceType - The Amazon Web Services service for which Performance Insights will return metrics. Valid values are
as follows:
RDS
DOCDB
ServiceType,
ServiceTypeDescribeDimensionKeysRequest.Builder identifier(String identifier)
An immutable, Amazon Web Services 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, Amazon Web Services 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.
DescribeDimensionKeysRequest.Builder startTime(Instant 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.
DescribeDimensionKeysRequest.Builder endTime(Instant 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.
DescribeDimensionKeysRequest.Builder metric(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.
DescribeDimensionKeysRequest.Builder periodInSeconds(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.
DescribeDimensionKeysRequest.Builder groupBy(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.default DescribeDimensionKeysRequest.Builder groupBy(Consumer<DimensionGroup.Builder> 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.
This is a convenience method that creates an instance of theDimensionGroup.Builder avoiding the need
to create one manually via DimensionGroup.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to groupBy(DimensionGroup).
groupBy - a consumer that will call methods on DimensionGroup.BuildergroupBy(DimensionGroup)DescribeDimensionKeysRequest.Builder additionalMetrics(Collection<String> additionalMetrics)
Additional metrics for the top N dimension keys. If the specified dimension group in the
GroupBy parameter is db.sql_tokenized, you can specify per-SQL metrics to get the
values for the top N SQL digests. The response syntax is as follows:
"AdditionalMetrics" : { "string" : "string" }.
additionalMetrics - Additional metrics for the top N dimension keys. If the specified dimension group in the
GroupBy parameter is db.sql_tokenized, you can specify per-SQL metrics to
get the values for the top N SQL digests. The response syntax is as follows:
"AdditionalMetrics" : { "string" : "string" }.DescribeDimensionKeysRequest.Builder additionalMetrics(String... additionalMetrics)
Additional metrics for the top N dimension keys. If the specified dimension group in the
GroupBy parameter is db.sql_tokenized, you can specify per-SQL metrics to get the
values for the top N SQL digests. The response syntax is as follows:
"AdditionalMetrics" : { "string" : "string" }.
additionalMetrics - Additional metrics for the top N dimension keys. If the specified dimension group in the
GroupBy parameter is db.sql_tokenized, you can specify per-SQL metrics to
get the values for the top N SQL digests. The response syntax is as follows:
"AdditionalMetrics" : { "string" : "string" }.DescribeDimensionKeysRequest.Builder partitionBy(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.default DescribeDimensionKeysRequest.Builder partitionBy(Consumer<DimensionGroup.Builder> partitionBy)
For each dimension specified in GroupBy, specify a secondary dimension to further subdivide the
partition keys in the response.
DimensionGroup.Builder avoiding the need
to create one manually via DimensionGroup.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to partitionBy(DimensionGroup).
partitionBy - a consumer that will call methods on DimensionGroup.BuilderpartitionBy(DimensionGroup)DescribeDimensionKeysRequest.Builder filter(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.
DescribeDimensionKeysRequest.Builder maxResults(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.DescribeDimensionKeysRequest.Builder nextToken(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.DescribeDimensionKeysRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderDescribeDimensionKeysRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2023. All rights reserved.