software.amazon.awssdk.services.pi.model

Class DescribeDimensionKeysRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.pi.model.PiRequest

software.amazon.awssdk.services.pi.model.DescribeDimensionKeysRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeDimensionKeysRequest.Builder,DescribeDimensionKeysRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeDimensionKeysRequest
extends PiRequest
implements ToCopyableBuilder<DescribeDimensionKeysRequest.Builder,DescribeDimensionKeysRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeDimensionKeysRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeDimensionKeysRequest.Builder	builder()
Instant	endTime() The date and time specifying the end of the requested time series data.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Map<String,String>	filter() One or more filters to apply in the request.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
DimensionGroup	groupBy() A specification for how to aggregate the data points from a query result.
boolean	hasFilter() Returns true if the Filter property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
String	identifier() An immutable, AWS Region-unique identifier for a data source.
Integer	maxResults() The maximum number of items to return in the response.
String	metric() The name of a Performance Insights metric to be measured.
String	nextToken() An optional pagination token provided by a previous request.
DimensionGroup	partitionBy() For each dimension specified in GroupBy, specify a secondary dimension to further subdivide the partition keys in the response.
Integer	periodInSeconds() The granularity, in seconds, of the data points returned from Performance Insights.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeDimensionKeysRequest.Builder>	serializableBuilderClass()
ServiceType	serviceType() The AWS service for which Performance Insights will return metrics.
String	serviceTypeAsString() The AWS service for which Performance Insights will return metrics.
Instant	startTime() The date and time specifying the beginning of the requested time series data.
DescribeDimensionKeysRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

serviceType

public final ServiceType serviceType()

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

If the service returns an enum value that is not available in the current SDK version, serviceType will return ServiceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from serviceTypeAsString().

Returns:

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

See Also:

ServiceType

serviceTypeAsString

public final String serviceTypeAsString()

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

If the service returns an enum value that is not available in the current SDK version, serviceType will return ServiceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from serviceTypeAsString().

Returns:

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

See Also:

ServiceType

identifier

public final 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

Returns:

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

startTime

public final 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.

Returns:

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.

endTime

public final 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.

Returns:

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.

metric

public final 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.

Returns:

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.

periodInSeconds

public final 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.

Returns:

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.

groupBy

public final 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.

Returns:

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.

partitionBy

public final DimensionGroup partitionBy()

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

Returns:

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

hasFilter

public final boolean hasFilter()

Returns true if the Filter property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

filter

public final 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasFilter() to see if a value was sent in this field.

Returns:

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.

maxResults

public final 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.

Returns:

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.

nextToken

public final 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.

Returns:

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.

toBuilder

public DescribeDimensionKeysRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeDimensionKeysRequest.Builder,DescribeDimensionKeysRequest>

Specified by:

toBuilder in class PiRequest

builder

public static DescribeDimensionKeysRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeDimensionKeysRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo