Class DimensionKeyDetail

java.lang.Object
software.amazon.awssdk.services.pi.model.DimensionKeyDetail
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DimensionKeyDetail.Builder,DimensionKeyDetail>
@Generated("software.amazon.awssdk:codegen") public final class DimensionKeyDetail extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DimensionKeyDetail.Builder,DimensionKeyDetail>

An object that describes the details for a specified dimension.

See Also:

  • Method Details

    • value

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

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

      public final DetailStatus 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 status PROCESSING, 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 return DetailStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      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 status PROCESSING, Performance Insights returns the truncated query.

      • UNAVAILABLE - The dimension detail data could not be collected successfully.

      See Also:

    • statusAsString

      public final String 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 status PROCESSING, 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 return DetailStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      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 status PROCESSING, Performance Insights returns the truncated query.

      • UNAVAILABLE - The dimension detail data could not be collected successfully.

      See Also:

    • toBuilder

      public DimensionKeyDetail.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<DimensionKeyDetail.Builder,DimensionKeyDetail>
      Returns:
      a builder for type T

    • builder

      public static DimensionKeyDetail.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

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

    • sdkFields

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