Class PartitionKey

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

An attribute used in partitioning data in a table. A dimension key partitions data using the values of the dimension specified by the dimension-name as partition key, while a measure key partitions data using measure names (values of the 'measure_name' column).

See Also:

  • Method Details

    • type

      public final PartitionKeyType type()

      The type of the partition key. Options are DIMENSION (dimension key) and MEASURE (measure key).

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

      Returns:
      The type of the partition key. Options are DIMENSION (dimension key) and MEASURE (measure key).
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the partition key. Options are DIMENSION (dimension key) and MEASURE (measure key).

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

      Returns:
      The type of the partition key. Options are DIMENSION (dimension key) and MEASURE (measure key).
      See Also:

    • name

      public final String name()

      The name of the attribute used for a dimension key.

      Returns:
      The name of the attribute used for a dimension key.

    • enforcementInRecord

      public final PartitionKeyEnforcementLevel enforcementInRecord()

      The level of enforcement for the specification of a dimension key in ingested records. Options are REQUIRED (dimension key must be specified) and OPTIONAL (dimension key does not have to be specified).

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

      Returns:
      The level of enforcement for the specification of a dimension key in ingested records. Options are REQUIRED (dimension key must be specified) and OPTIONAL (dimension key does not have to be specified).
      See Also:

    • enforcementInRecordAsString

      public final String enforcementInRecordAsString()

      The level of enforcement for the specification of a dimension key in ingested records. Options are REQUIRED (dimension key must be specified) and OPTIONAL (dimension key does not have to be specified).

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

      Returns:
      The level of enforcement for the specification of a dimension key in ingested records. Options are REQUIRED (dimension key must be specified) and OPTIONAL (dimension key does not have to be specified).
      See Also:

    • toBuilder

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

    • builder

      public static PartitionKey.Builder builder()

    • serializableBuilderClass

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