Class DataTable

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

Represents a data table in Amazon Connect. A data table is a JSON-like data structure where attributes and values are dynamically set by customers. Customers can reference table values within call flows, applications, views, and workspaces to pinpoint dynamic configuration that changes their contact center's behavior in a predetermined and safe way.

See Also:

  • Method Details

    • name

      public final String name()

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

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

    • id

      public final String id()

      The unique identifier for the data table. Does not include version aliases.

      Returns:
      The unique identifier for the data table. Does not include version aliases.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) for the data table. Does not include version aliases.

      Returns:
      The Amazon Resource Name (ARN) for the data table. Does not include version aliases.

    • timeZone

      public final String timeZone()

      The IANA timezone identifier used when resolving time based dynamic values. Required even if no time slices are specified.

      Returns:
      The IANA timezone identifier used when resolving time based dynamic values. Required even if no time slices are specified.

    • description

      public final String description()

      An optional description of the data table's purpose and contents.

      Returns:
      An optional description of the data table's purpose and contents.

    • valueLockLevel

      public final DataTableLockLevel valueLockLevel()

      The data level that concurrent value edits are locked on. One of DATA_TABLE, PRIMARY_VALUE, ATTRIBUTE, VALUE, and NONE. Determines how concurrent edits are handled when multiple users attempt to modify values simultaneously.

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

      Returns:
      The data level that concurrent value edits are locked on. One of DATA_TABLE, PRIMARY_VALUE, ATTRIBUTE, VALUE, and NONE. Determines how concurrent edits are handled when multiple users attempt to modify values simultaneously.
      See Also:

    • valueLockLevelAsString

      public final String valueLockLevelAsString()

      The data level that concurrent value edits are locked on. One of DATA_TABLE, PRIMARY_VALUE, ATTRIBUTE, VALUE, and NONE. Determines how concurrent edits are handled when multiple users attempt to modify values simultaneously.

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

      Returns:
      The data level that concurrent value edits are locked on. One of DATA_TABLE, PRIMARY_VALUE, ATTRIBUTE, VALUE, and NONE. Determines how concurrent edits are handled when multiple users attempt to modify values simultaneously.
      See Also:

    • lockVersion

      public final DataTableLockVersion lockVersion()

      The lock version information used for optimistic locking and table versioning. Changes with each update to prevent concurrent modification conflicts.

      Returns:
      The lock version information used for optimistic locking and table versioning. Changes with each update to prevent concurrent modification conflicts.

    • version

      public final String version()

      A unique identifier and alias for customer managed versions (not $LATEST or $SAVED).

      Returns:
      A unique identifier and alias for customer managed versions (not $LATEST or $SAVED).

    • versionDescription

      public final String versionDescription()

      A description of the customer managed version.

      Returns:
      A description of the customer managed version.

    • status

      public final DataTableStatus status()

      The current status of the data table. One of PUBLISHED or SAVED.

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

      Returns:
      The current status of the data table. One of PUBLISHED or SAVED.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the data table. One of PUBLISHED or SAVED.

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

      Returns:
      The current status of the data table. One of PUBLISHED or SAVED.
      See Also:

    • createdTime

      public final Instant createdTime()

      The timestamp when the data table was created.

      Returns:
      The timestamp when the data table was created.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The timestamp when the data table or any of its properties were last modified.

      Returns:
      The timestamp when the data table or any of its properties were last modified.

    • lastModifiedRegion

      public final String lastModifiedRegion()

      The AWS region where the data table was last modified, used for region replication.

      Returns:
      The AWS region where the data table was last modified, used for region replication.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final Map<String,String> tags()

      Key-value pairs for attribute based access control (TBAC or ABAC) and organization.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      Key-value pairs for attribute based access control (TBAC or ABAC) and organization.

    • toBuilder

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

    • builder

      public static DataTable.Builder builder()

    • serializableBuilderClass

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