software.amazon.awssdk.services.pi.model

Interface DescribeDimensionKeysRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<DescribeDimensionKeysRequest.Builder,DescribeDimensionKeysRequest>, PiRequest.Builder, SdkBuilder<DescribeDimensionKeysRequest.Builder,DescribeDimensionKeysRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

DescribeDimensionKeysRequest

public static interface DescribeDimensionKeysRequest.Builder
extends PiRequest.Builder, SdkPojo, CopyableBuilder<DescribeDimensionKeysRequest.Builder,DescribeDimensionKeysRequest>

Method Summary

Modifier and Type	Method and Description
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, AWS 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) Add an optional request override configuration.
DescribeDimensionKeysRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
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 AWS service for which Performance Insights will return metrics.
DescribeDimensionKeysRequest.Builder	serviceType(String serviceType) The AWS 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.

Methods inherited from interface software.amazon.awssdk.services.pi.model.PiRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

serviceType

DescribeDimensionKeysRequest.Builder serviceType(String serviceType)

The AWS service for which Performance Insights will return metrics. The only valid value for ServiceType is: RDS

Parameters:

serviceType - The AWS service for which Performance Insights will return metrics. The only valid value for ServiceType is: RDS

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ServiceType, ServiceType

serviceType

DescribeDimensionKeysRequest.Builder serviceType(ServiceType serviceType)

The AWS service for which Performance Insights will return metrics. The only valid value for ServiceType is: RDS

Parameters:

serviceType - The AWS service for which Performance Insights will return metrics. The only valid value for ServiceType is: RDS

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ServiceType, ServiceType

identifier

DescribeDimensionKeysRequest.Builder identifier(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: db-FAIHNTYBKTGAUSUZQYPDS2GW4A

Parameters:

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: db-FAIHNTYBKTGAUSUZQYPDS2GW4A

Returns:

Returns a reference to this object so that method calls can be chained together.

startTime

DescribeDimensionKeysRequest.Builder startTime(Instant startTime)

The date and time specifying the beginning of the requested time series data. You can't specify a StartTime that's earlier than 7 days ago. The value specified is inclusive - data points equal to or greater than StartTime will be returned.

The value for StartTime must be earlier than the value for EndTime.

Parameters:

startTime - The date and time specifying the beginning of the requested time series data. You can't specify a StartTime that's earlier than 7 days ago. The value specified is inclusive - data points equal to or greater than StartTime will be returned.

The value for StartTime must be earlier than the value for EndTime.

Returns:

Returns a reference to this object so that method calls can be chained together.

endTime

DescribeDimensionKeysRequest.Builder endTime(Instant endTime)

The date and time specifying the end of the requested time series data. The value specified is exclusive - data points less than (but not equal to) EndTime will be returned.

The value for EndTime must be later than the value for StartTime.

Parameters:

endTime - The date and time specifying the end of the requested time series data. The value specified is exclusive - data points less than (but not equal to) EndTime will be returned.

The value for EndTime must be later than the value for StartTime.

Returns:

Returns a reference to this object so that method calls can be chained together.

metric

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

periodInSeconds

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 will choose a value for you, with a goal of returning roughly 100-200 data points in the response.

Parameters:

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 will choose a value for you, with a goal of returning roughly 100-200 data points in the response.

Returns:

Returns a reference to this object so that method calls can be chained together.

groupBy

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 will return all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.

Parameters:

groupBy - A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights will return all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.

Returns:

Returns a reference to this object so that method calls can be chained together.

groupBy

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 will return all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.

This is a convenience that creates an instance of the 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 groupBy(DimensionGroup).

Parameters:

groupBy - a consumer that will call methods on DimensionGroup.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

groupBy(DimensionGroup)

partitionBy

DescribeDimensionKeysRequest.Builder partitionBy(DimensionGroup partitionBy)

For each dimension specified in GroupBy, specify a secondary dimension to further subdivide the partition keys in the response.

Parameters:

partitionBy - For each dimension specified in GroupBy, specify a secondary dimension to further subdivide the partition keys in the response.

Returns:

Returns a reference to this object so that method calls can be chained together.

partitionBy

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.

This is a convenience that creates an instance of the 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).

Parameters:

partitionBy - a consumer that will call methods on DimensionGroup.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

partitionBy(DimensionGroup)

filter

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

maxResults

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

nextToken

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

DescribeDimensionKeysRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

DescribeDimensionKeysRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.