software.amazon.awssdk.services.pi.model

Class GetDimensionKeyDetailsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetDimensionKeyDetailsRequest.Builder,GetDimensionKeyDetailsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetDimensionKeyDetailsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GetDimensionKeyDetailsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	group() The name of the dimension group.
String	groupIdentifier() The ID of the dimension group from which to retrieve dimension details.
int	hashCode()
boolean	hasRequestedDimensions() For responses, this returns true if the service returned a value for the RequestedDimensions property.
String	identifier() The ID for a data source from which to gather dimension data.
List<String>	requestedDimensions() A list of dimensions to retrieve the detail data for within the given dimension group.
List<SdkField<?>>	sdkFields()
static Class<? extends GetDimensionKeyDetailsRequest.Builder>	serializableBuilderClass()
ServiceType	serviceType() The AWS service for which Performance Insights returns data.
String	serviceTypeAsString() The AWS service for which Performance Insights returns data.
GetDimensionKeyDetailsRequest.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 returns data. The only valid value 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 returns data. The only valid value is RDS.

See Also:

ServiceType

serviceTypeAsString

public final String serviceTypeAsString()

The AWS service for which Performance Insights returns data. The only valid value 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 returns data. The only valid value is RDS.

See Also:

ServiceType

identifier

public final String identifier()

The ID for a data source from which to gather dimension data. This ID must be immutable and unique within an AWS Region. When a DB instance is the data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.

Returns:

The ID for a data source from which to gather dimension data. This ID must be immutable and unique within an AWS Region. When a DB instance is the data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.

group

public final String group()

The name of the dimension group. The only valid value is db.sql. Performance Insights searches the specified group for the dimension group ID.

Returns:

The name of the dimension group. The only valid value is db.sql. Performance Insights searches the specified group for the dimension group ID.

groupIdentifier

public final String groupIdentifier()

The ID of the dimension group from which to retrieve dimension details. For dimension group db.sql, the group ID is db.sql.id.

Returns:

The ID of the dimension group from which to retrieve dimension details. For dimension group db.sql, the group ID is db.sql.id.

hasRequestedDimensions

public final boolean hasRequestedDimensions()

For responses, this returns true if the service returned a value for the RequestedDimensions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

requestedDimensions

public final List<String> requestedDimensions()

A list of dimensions to retrieve the detail data for within the given dimension group. For the dimension group db.sql, specify either the full dimension name db.sql.statement or the short dimension name statement. If you don't specify this parameter, Performance Insights returns all dimension data within the specified dimension group.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRequestedDimensions() method.

Returns:

A list of dimensions to retrieve the detail data for within the given dimension group. For the dimension group db.sql, specify either the full dimension name db.sql.statement or the short dimension name statement. If you don't specify this parameter, Performance Insights returns all dimension data within the specified dimension group.

toBuilder

public GetDimensionKeyDetailsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetDimensionKeyDetailsRequest.Builder,GetDimensionKeyDetailsRequest>

Specified by:

toBuilder in class PiRequest

builder

public static GetDimensionKeyDetailsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetDimensionKeyDetailsRequest.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