Class Dimension

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

Represents the metadata attributes of the time series. For example, the name and Availability Zone of an EC2 instance or the name of the manufacturer of a wind turbine are dimensions.

See Also:

  • Method Details

    • name

      public final String name()

      Dimension represents the metadata attributes of the time series. For example, the name and Availability Zone of an EC2 instance or the name of the manufacturer of a wind turbine are dimensions.

      For constraints on dimension names, see Naming Constraints.

      Returns:
      Dimension represents the metadata attributes of the time series. For example, the name and Availability Zone of an EC2 instance or the name of the manufacturer of a wind turbine are dimensions.

      For constraints on dimension names, see Naming Constraints.

    • value

      public final String value()

      The value of the dimension.

      Returns:
      The value of the dimension.

    • dimensionValueType

      public final DimensionValueType dimensionValueType()

      The data type of the dimension for the time-series data point.

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

      Returns:
      The data type of the dimension for the time-series data point.
      See Also:

    • dimensionValueTypeAsString

      public final String dimensionValueTypeAsString()

      The data type of the dimension for the time-series data point.

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

      Returns:
      The data type of the dimension for the time-series data point.
      See Also:

    • toBuilder

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

    • builder

      public static Dimension.Builder builder()

    • serializableBuilderClass

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