TableDescription (AWS Java SDK :: Services :: Amazon DynamoDB 2.5.23 API)

java.lang.Object
- software.amazon.awssdk.services.dynamodb.model.TableDescription

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<TableDescription.Builder,TableDescription>

@Generated(value="software.amazon.awssdk:codegen")
public final class TableDescription
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<TableDescription.Builder,TableDescription>

Represents the properties of a table.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface TableDescription.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`TableDescription.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<AttributeDefinition>`	`attributeDefinitions()` An array of `AttributeDefinition` objects.
`BillingModeSummary`	`billingModeSummary()` Contains the details for the read/write capacity mode.
`static TableDescription.Builder`	`builder()`
`Instant`	`creationDateTime()` The date and time when the table was created, in UNIX epoch time format.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`List<GlobalSecondaryIndexDescription>`	`globalSecondaryIndexes()` The global secondary indexes, if any, on the table.
`int`	`hashCode()`
`Long`	`itemCount()` The number of items in the specified table.
`List<KeySchemaElement>`	`keySchema()` The primary key structure for the table.
`String`	`latestStreamArn()` The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
`String`	`latestStreamLabel()` A timestamp, in ISO 8601 format, for this stream.
`List<LocalSecondaryIndexDescription>`	`localSecondaryIndexes()` Represents one or more local secondary indexes on the table.
`ProvisionedThroughputDescription`	`provisionedThroughput()` The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
`RestoreSummary`	`restoreSummary()` Contains details for the restore.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends TableDescription.Builder>`	`serializableBuilderClass()`
`SSEDescription`	`sseDescription()` The description of the server-side encryption status on the specified table.
`StreamSpecification`	`streamSpecification()` The current DynamoDB Streams configuration for the table.
`String`	`tableArn()` The Amazon Resource Name (ARN) that uniquely identifies the table.
`String`	`tableId()` Unique identifier for the table for which the backup was created.
`String`	`tableName()` The name of the table.
`Long`	`tableSizeBytes()` The total size of the specified table, in bytes.
`TableStatus`	`tableStatus()` The current state of the table:
`String`	`tableStatusAsString()` The current state of the table:
`TableDescription.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - attributeDefinitions
```
public List<AttributeDefinition> attributeDefinitions()
```
    An array of AttributeDefinition objects. Each of these objects describes one attribute in the table and index key schema.
    
    Each AttributeDefinition object in this array is composed of:
    - AttributeName - The name of the attribute.
    - AttributeType - The data type for the attribute.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    Returns:
    An array of AttributeDefinition objects. Each of these objects describes one attribute in the table and index key schema.
    
    Each AttributeDefinition object in this array is composed of:
    
    AttributeName - The name of the attribute.
    
    AttributeType - The data type for the attribute.
  - tableName
```
public String tableName()
```
    The name of the table.
    
    Returns:
    
    The name of the table.
  - keySchema
```
public List<KeySchemaElement> keySchema()
```
    The primary key structure for the table. Each KeySchemaElement consists of:
    - AttributeName - The name of the attribute.
    - KeyType - The role of the attribute:
      
      HASH - partition key
      
      RANGE - sort key
      
      The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
      
      The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
    For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    Returns:
    The primary key structure for the table. Each KeySchemaElement consists of:
    
    AttributeName - The name of the attribute.
    
    KeyType - The role of the attribute:
    
    HASH - partition key
    
    RANGE - sort key
    
    The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
    
    The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
    
    For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
  - tableStatus
```
public TableStatus tableStatus()
```
    The current state of the table:
    - CREATING - The table is being created.
    - UPDATING - The table is being updated.
    - 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:
    
    CREATING - The table is being created.
    
    UPDATING - The table is being updated.
    
    DELETING - The table is being deleted.
    
    ACTIVE - The table is ready for use.
    See Also:
    
    TableStatus
  - tableStatusAsString
```
public String tableStatusAsString()
```
    The current state of the table:
    - CREATING - The table is being created.
    - UPDATING - The table is being updated.
    - 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:
    
    CREATING - The table is being created.
    
    UPDATING - The table is being updated.
    
    DELETING - The table is being deleted.
    
    ACTIVE - The table is ready for use.
    See Also:
    
    TableStatus
  - creationDateTime
```
public Instant creationDateTime()
```
    The date and time when the table was created, in UNIX epoch time format.
    
    Returns:
    
    The date and time when the table was created, in UNIX epoch time format.
  - provisionedThroughput
```
public ProvisionedThroughputDescription provisionedThroughput()
```
    The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
    
    Returns:
    
    The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
  - tableSizeBytes
```
public Long tableSizeBytes()
```
    The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
    
    Returns:
    
    The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
  - itemCount
```
public Long itemCount()
```
    The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
    
    Returns:
    
    The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
  - tableArn
```
public String tableArn()
```
    The Amazon Resource Name (ARN) that uniquely identifies the table.
    
    Returns:
    
    The Amazon Resource Name (ARN) that uniquely identifies the table.
  - tableId
```
public String tableId()
```
    Unique identifier for the table for which the backup was created.
    
    Returns:
    
    Unique identifier for the table for which the backup was created.
  - billingModeSummary
```
public BillingModeSummary billingModeSummary()
```
    Contains the details for the read/write capacity mode.
    
    Returns:
    
    Contains the details for the read/write capacity mode.
  - localSecondaryIndexes
```
public List<LocalSecondaryIndexDescription> localSecondaryIndexes()
```
    Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:
    - IndexName - The name of the local secondary index.
    - KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.
    - Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
      
      ProjectionType - One of the following:
      
      KEYS_ONLY - Only the index and primary keys are projected into the index.
      
      INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.
      
      ALL - All of the table attributes are projected into the index.
      
      NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
    - IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
    - ItemCount - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
    If the table is in the DELETING state, no information about indexes will be returned.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    Returns:
    Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:
    
    IndexName - The name of the local secondary index.
    
    KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.
    
    Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
    
    ProjectionType - One of the following:
    
    KEYS_ONLY - Only the index and primary keys are projected into the index.
    
    INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.
    
    ALL - All of the table attributes are projected into the index.
    
    NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
    
    IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
    
    ItemCount - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
    
    If the table is in the DELETING state, no information about indexes will be returned.
  - globalSecondaryIndexes
```
public List<GlobalSecondaryIndexDescription> globalSecondaryIndexes()
```
    The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of:
    - Backfilling - If true, then the index is currently in the backfilling phase. Backfilling occurs only when a new global secondary index is added to the table; it is the process by which DynamoDB populates the new index with data from the table. (This attribute does not appear for indexes that were created during a CreateTable operation.)
    - IndexName - The name of the global secondary index.
    - IndexSizeBytes - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
    - IndexStatus - The current status of the global secondary index:
      
      CREATING - The index is being created.
      
      UPDATING - The index is being updated.
      
      DELETING - The index is being deleted.
      
      ACTIVE - The index is ready for use.
    - ItemCount - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
    - KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.
    - Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
      
      ProjectionType - One of the following:
      
      KEYS_ONLY - Only the index and primary keys are projected into the index.
      
      INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.
      
      ALL - All of the table attributes are projected into the index.
      
      NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
    - ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases.
    If the table is in the DELETING state, no information about indexes will be returned.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    Returns:
    The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of:
    
    Backfilling - If true, then the index is currently in the backfilling phase. Backfilling occurs only when a new global secondary index is added to the table; it is the process by which DynamoDB populates the new index with data from the table. (This attribute does not appear for indexes that were created during a CreateTable operation.)
    
    IndexName - The name of the global secondary index.
    
    IndexSizeBytes - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
    
    IndexStatus - The current status of the global secondary index:
    
    CREATING - The index is being created.
    
    UPDATING - The index is being updated.
    
    DELETING - The index is being deleted.
    
    ACTIVE - The index is ready for use.
    
    ItemCount - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
    
    KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.
    
    Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
    
    ProjectionType - One of the following:
    
    KEYS_ONLY - Only the index and primary keys are projected into the index.
    
    INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.
    
    ALL - All of the table attributes are projected into the index.
    
    NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
    
    ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases.
    
    If the table is in the DELETING state, no information about indexes will be returned.
  - streamSpecification
```
public StreamSpecification streamSpecification()
```
    The current DynamoDB Streams configuration for the table.
    
    Returns:
    
    The current DynamoDB Streams configuration for the table.
  - latestStreamLabel
```
public String latestStreamLabel()
```
    A timestamp, in ISO 8601 format, for this stream.
    
    Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:
    - the AWS customer ID.
    - the table name.
    - the StreamLabel.
    Returns:
    A timestamp, in ISO 8601 format, for this stream.
    
    Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:
    
    the AWS customer ID.
    
    the table name.
    
    the StreamLabel.
  - latestStreamArn
```
public String latestStreamArn()
```
    The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
    
    Returns:
    
    The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
  - restoreSummary
```
public RestoreSummary restoreSummary()
```
    Contains details for the restore.
    
    Returns:
    
    Contains details for the restore.
  - sseDescription
```
public SSEDescription sseDescription()
```
    The description of the server-side encryption status on the specified table.
    
    Returns:
    
    The description of the server-side encryption status on the specified table.
  - toBuilder
```
public TableDescription.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<TableDescription.Builder,TableDescription>
  - builder
```
public static TableDescription.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends TableDescription.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class TableDescription

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

attributeDefinitions

tableName

keySchema

tableStatus

tableStatusAsString

creationDateTime

provisionedThroughput

tableSizeBytes

itemCount

tableArn

tableId

billingModeSummary

localSecondaryIndexes

globalSecondaryIndexes

streamSpecification

latestStreamLabel

latestStreamArn

restoreSummary

sseDescription

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields