Class Table

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

Represents a database table in Timestream. Tables contain one or more related time series. You can modify the retention duration of the memory store and the magnetic store for a table.

See Also:

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name that uniquely identifies this table.

      Returns:
      The Amazon Resource Name that uniquely identifies this table.

    • tableName

      public final String tableName()

      The name of the Timestream table.

      Returns:
      The name of the Timestream table.

    • databaseName

      public final String databaseName()

      The name of the Timestream database that contains this table.

      Returns:
      The name of the Timestream database that contains this table.

    • tableStatus

      public final TableStatus tableStatus()

      The current state of the table:

      • DELETING - The table is being deleted.

      • ACTIVE - The table is ready for use.

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

      Returns:
      The current state of the table:

      • DELETING - The table is being deleted.

      • ACTIVE - The table is ready for use.

      See Also:

    • tableStatusAsString

      public final String tableStatusAsString()

      The current state of the table:

      • DELETING - The table is being deleted.

      • ACTIVE - The table is ready for use.

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

      Returns:
      The current state of the table:

      • DELETING - The table is being deleted.

      • ACTIVE - The table is ready for use.

      See Also:

    • retentionProperties

      public final RetentionProperties retentionProperties()

      The retention duration for the memory store and magnetic store.

      Returns:
      The retention duration for the memory store and magnetic store.

    • creationTime

      public final Instant creationTime()

      The time when the Timestream table was created.

      Returns:
      The time when the Timestream table was created.

    • lastUpdatedTime

      public final Instant lastUpdatedTime()

      The time when the Timestream table was last updated.

      Returns:
      The time when the Timestream table was last updated.

    • magneticStoreWriteProperties

      public final MagneticStoreWriteProperties magneticStoreWriteProperties()

      Contains properties to set on the table when enabling magnetic store writes.

      Returns:
      Contains properties to set on the table when enabling magnetic store writes.

    • schema

      public final Schema schema()

      The schema of the table.

      Returns:
      The schema of the table.

    • toBuilder

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

    • builder

      public static Table.Builder builder()

    • serializableBuilderClass

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