Class DimensionKeyDetail
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DimensionKeyDetail.Builder,
DimensionKeyDetail>
An object that describes the details for a specified dimension.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic DimensionKeyDetail.Builder
builder()
final String
The full name of the dimension.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
static Class
<? extends DimensionKeyDetail.Builder> final DetailStatus
status()
The status of the dimension detail data.final String
The status of the dimension detail data.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
value()
The value of the dimension detail data.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
value
The value of the dimension detail data. Depending on the return status, this value is either the full or truncated SQL query for the following dimensions:
-
db.query.statement
(Amazon DocumentDB) -
db.sql.statement
(Amazon RDS and Aurora)
- Returns:
- The value of the dimension detail data. Depending on the return status, this value is either the full or
truncated SQL query for the following dimensions:
-
db.query.statement
(Amazon DocumentDB) -
db.sql.statement
(Amazon RDS and Aurora)
-
-
-
dimension
The full name of the dimension. The full name includes the group name and key name. The following values are valid:
-
db.query.statement
(Amazon DocumentDB) -
db.sql.statement
(Amazon RDS and Aurora)
- Returns:
- The full name of the dimension. The full name includes the group name and key name. The following values
are valid:
-
db.query.statement
(Amazon DocumentDB) -
db.sql.statement
(Amazon RDS and Aurora)
-
-
-
status
The status of the dimension detail data. Possible values include the following:
-
AVAILABLE
- The dimension detail data is ready to be retrieved. -
PROCESSING
- The dimension detail data isn't ready to be retrieved because more processing time is required. If the requested detail data has the statusPROCESSING
, Performance Insights returns the truncated query. -
UNAVAILABLE
- The dimension detail data could not be collected successfully.
If the service returns an enum value that is not available in the current SDK version,
status
will returnDetailStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the dimension detail data. Possible values include the following:
-
AVAILABLE
- The dimension detail data is ready to be retrieved. -
PROCESSING
- The dimension detail data isn't ready to be retrieved because more processing time is required. If the requested detail data has the statusPROCESSING
, Performance Insights returns the truncated query. -
UNAVAILABLE
- The dimension detail data could not be collected successfully.
-
- See Also:
-
-
statusAsString
The status of the dimension detail data. Possible values include the following:
-
AVAILABLE
- The dimension detail data is ready to be retrieved. -
PROCESSING
- The dimension detail data isn't ready to be retrieved because more processing time is required. If the requested detail data has the statusPROCESSING
, Performance Insights returns the truncated query. -
UNAVAILABLE
- The dimension detail data could not be collected successfully.
If the service returns an enum value that is not available in the current SDK version,
status
will returnDetailStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the dimension detail data. Possible values include the following:
-
AVAILABLE
- The dimension detail data is ready to be retrieved. -
PROCESSING
- The dimension detail data isn't ready to be retrieved because more processing time is required. If the requested detail data has the statusPROCESSING
, Performance Insights returns the truncated query. -
UNAVAILABLE
- The dimension detail data could not be collected successfully.
-
- See Also:
-
-
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 interfaceToCopyableBuilder<DimensionKeyDetail.Builder,
DimensionKeyDetail> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-