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)
Map<String,String>	filter() One or more filters to apply in the request.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
DimensionGroup	groupBy() A specification for how to aggregate the data points from a query result.
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() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

serviceType

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

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

startTime

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

Returns:

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.

endTime

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

Returns:

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.

metric

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

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.

periodInSeconds

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

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

groupBy

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

Returns:

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.

partitionBy

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

filter

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

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 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 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()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeDimensionKeysRequest.Builder,DescribeDimensionKeysRequest>

Specified by:

toBuilder in class PiRequest

Returns:

a builder for type T

builder

public static DescribeDimensionKeysRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.