Class DataTableAttribute

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

Represents an attribute (column) in a data table. Attributes define the schema and validation rules for values that can be stored in the table. They specify the data type, constraints, and whether the attribute is used as a primary key for record identification.

See Also:

  • Method Details

    • attributeId

      public final String attributeId()

      The unique identifier for the attribute within the data table.

      Returns:
      The unique identifier for the attribute within the data table.

    • name

      public final String name()

      The human-readable name of the attribute. Must be unique within the data table and conform to Connect naming standards.

      Returns:
      The human-readable name of the attribute. Must be unique within the data table and conform to Connect naming standards.

    • valueType

      public final DataTableAttributeValueType valueType()

      The type of value allowed for this attribute. Must be one of TEXT, TEXT_LIST, NUMBER, NUMBER_LIST, or BOOLEAN. Determines how values are validated and processed.

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

      Returns:
      The type of value allowed for this attribute. Must be one of TEXT, TEXT_LIST, NUMBER, NUMBER_LIST, or BOOLEAN. Determines how values are validated and processed.
      See Also:

    • valueTypeAsString

      public final String valueTypeAsString()

      The type of value allowed for this attribute. Must be one of TEXT, TEXT_LIST, NUMBER, NUMBER_LIST, or BOOLEAN. Determines how values are validated and processed.

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

      Returns:
      The type of value allowed for this attribute. Must be one of TEXT, TEXT_LIST, NUMBER, NUMBER_LIST, or BOOLEAN. Determines how values are validated and processed.
      See Also:

    • description

      public final String description()

      An optional description explaining the purpose and usage of this attribute.

      Returns:
      An optional description explaining the purpose and usage of this attribute.

    • dataTableId

      public final String dataTableId()

      The unique identifier of the data table that contains this attribute.

      Returns:
      The unique identifier of the data table that contains this attribute.

    • dataTableArn

      public final String dataTableArn()

      The Amazon Resource Name (ARN) of the data table that contains this attribute.

      Returns:
      The Amazon Resource Name (ARN) of the data table that contains this attribute.

    • primary

      public final Boolean primary()

      Boolean indicating whether this attribute is used as a primary key for record identification. Primary attributes must have unique value combinations and cannot contain expressions.

      Returns:
      Boolean indicating whether this attribute is used as a primary key for record identification. Primary attributes must have unique value combinations and cannot contain expressions.

    • version

      public final String version()

      The version identifier for this attribute, used for versioning and change tracking.

      Returns:
      The version identifier for this attribute, used for versioning and change tracking.

    • lockVersion

      public final DataTableLockVersion lockVersion()

      The lock version for this attribute, used for optimistic locking to prevent concurrent modification conflicts.

      Returns:
      The lock version for this attribute, used for optimistic locking to prevent concurrent modification conflicts.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The timestamp when this attribute was last modified.

      Returns:
      The timestamp when this attribute was last modified.

    • lastModifiedRegion

      public final String lastModifiedRegion()

      The AWS region where this attribute was last modified, used for region replication.

      Returns:
      The AWS region where this attribute was last modified, used for region replication.

    • validation

      public final Validation validation()

      The validation rules applied to values of this attribute. Based on JSON Schema Draft 2020-12 with additional Connect-specific validations for data integrity.

      Returns:
      The validation rules applied to values of this attribute. Based on JSON Schema Draft 2020-12 with additional Connect-specific validations for data integrity.

    • toBuilder

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

    • builder

      public static DataTableAttribute.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.