TableDescription (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.dynamodbv2.model.TableDescription

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class TableDescription
extends Object
implements Serializable, Cloneable, StructuredPojo

Represents the properties of a table.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

TableDescription()

Constructors
Constructor and Description
`TableDescription()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TableDescription`	`clone()`
`boolean`	`equals(Object obj)`
`ArchivalSummary`	`getArchivalSummary()` Contains information about the table archive.
`List<AttributeDefinition>`	`getAttributeDefinitions()` An array of `AttributeDefinition` objects.
`BillingModeSummary`	`getBillingModeSummary()` Contains the details for the read/write capacity mode.
`Date`	`getCreationDateTime()` The date and time when the table was created, in UNIX epoch time format.
`List<GlobalSecondaryIndexDescription>`	`getGlobalSecondaryIndexes()` The global secondary indexes, if any, on the table.
`String`	`getGlobalTableVersion()` Represents the version of global tables in use, if the table is replicated across AWS Regions.
`Long`	`getItemCount()` The number of items in the specified table.
`List<KeySchemaElement>`	`getKeySchema()` The primary key structure for the table.
`String`	`getLatestStreamArn()` The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
`String`	`getLatestStreamLabel()` A timestamp, in ISO 8601 format, for this stream.
`List<LocalSecondaryIndexDescription>`	`getLocalSecondaryIndexes()` Represents one or more local secondary indexes on the table.
`ProvisionedThroughputDescription`	`getProvisionedThroughput()` The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
`List<ReplicaDescription>`	`getReplicas()` Represents replicas of the table.
`RestoreSummary`	`getRestoreSummary()` Contains details for the restore.
`SSEDescription`	`getSSEDescription()` The description of the server-side encryption status on the specified table.
`StreamSpecification`	`getStreamSpecification()` The current DynamoDB Streams configuration for the table.
`String`	`getTableArn()` The Amazon Resource Name (ARN) that uniquely identifies the table.
`String`	`getTableId()` Unique identifier for the table for which the backup was created.
`String`	`getTableName()` The name of the table.
`Long`	`getTableSizeBytes()` The total size of the specified table, in bytes.
`String`	`getTableStatus()` The current state of the table:
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArchivalSummary(ArchivalSummary archivalSummary)` Contains information about the table archive.
`void`	`setAttributeDefinitions(Collection<AttributeDefinition> attributeDefinitions)` An array of `AttributeDefinition` objects.
`void`	`setBillingModeSummary(BillingModeSummary billingModeSummary)` Contains the details for the read/write capacity mode.
`void`	`setCreationDateTime(Date creationDateTime)` The date and time when the table was created, in UNIX epoch time format.
`void`	`setGlobalSecondaryIndexes(Collection<GlobalSecondaryIndexDescription> globalSecondaryIndexes)` The global secondary indexes, if any, on the table.
`void`	`setGlobalTableVersion(String globalTableVersion)` Represents the version of global tables in use, if the table is replicated across AWS Regions.
`void`	`setItemCount(Long itemCount)` The number of items in the specified table.
`void`	`setKeySchema(Collection<KeySchemaElement> keySchema)` The primary key structure for the table.
`void`	`setLatestStreamArn(String latestStreamArn)` The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
`void`	`setLatestStreamLabel(String latestStreamLabel)` A timestamp, in ISO 8601 format, for this stream.
`void`	`setLocalSecondaryIndexes(Collection<LocalSecondaryIndexDescription> localSecondaryIndexes)` Represents one or more local secondary indexes on the table.
`void`	`setProvisionedThroughput(ProvisionedThroughputDescription provisionedThroughput)` The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
`void`	`setReplicas(Collection<ReplicaDescription> replicas)` Represents replicas of the table.
`void`	`setRestoreSummary(RestoreSummary restoreSummary)` Contains details for the restore.
`void`	`setSSEDescription(SSEDescription sSEDescription)` The description of the server-side encryption status on the specified table.
`void`	`setStreamSpecification(StreamSpecification streamSpecification)` The current DynamoDB Streams configuration for the table.
`void`	`setTableArn(String tableArn)` The Amazon Resource Name (ARN) that uniquely identifies the table.
`void`	`setTableId(String tableId)` Unique identifier for the table for which the backup was created.
`void`	`setTableName(String tableName)` The name of the table.
`void`	`setTableSizeBytes(Long tableSizeBytes)` The total size of the specified table, in bytes.
`void`	`setTableStatus(String tableStatus)` The current state of the table:
`void`	`setTableStatus(TableStatus tableStatus)` The current state of the table:
`String`	`toString()` Returns a string representation of this object.
`TableDescription`	`withArchivalSummary(ArchivalSummary archivalSummary)` Contains information about the table archive.
`TableDescription`	`withAttributeDefinitions(AttributeDefinition... attributeDefinitions)` An array of `AttributeDefinition` objects.
`TableDescription`	`withAttributeDefinitions(Collection<AttributeDefinition> attributeDefinitions)` An array of `AttributeDefinition` objects.
`TableDescription`	`withBillingModeSummary(BillingModeSummary billingModeSummary)` Contains the details for the read/write capacity mode.
`TableDescription`	`withCreationDateTime(Date creationDateTime)` The date and time when the table was created, in UNIX epoch time format.
`TableDescription`	`withGlobalSecondaryIndexes(Collection<GlobalSecondaryIndexDescription> globalSecondaryIndexes)` The global secondary indexes, if any, on the table.
`TableDescription`	`withGlobalSecondaryIndexes(GlobalSecondaryIndexDescription... globalSecondaryIndexes)` The global secondary indexes, if any, on the table.
`TableDescription`	`withGlobalTableVersion(String globalTableVersion)` Represents the version of global tables in use, if the table is replicated across AWS Regions.
`TableDescription`	`withItemCount(Long itemCount)` The number of items in the specified table.
`TableDescription`	`withKeySchema(Collection<KeySchemaElement> keySchema)` The primary key structure for the table.
`TableDescription`	`withKeySchema(KeySchemaElement... keySchema)` The primary key structure for the table.
`TableDescription`	`withLatestStreamArn(String latestStreamArn)` The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
`TableDescription`	`withLatestStreamLabel(String latestStreamLabel)` A timestamp, in ISO 8601 format, for this stream.
`TableDescription`	`withLocalSecondaryIndexes(Collection<LocalSecondaryIndexDescription> localSecondaryIndexes)` Represents one or more local secondary indexes on the table.
`TableDescription`	`withLocalSecondaryIndexes(LocalSecondaryIndexDescription... localSecondaryIndexes)` Represents one or more local secondary indexes on the table.
`TableDescription`	`withProvisionedThroughput(ProvisionedThroughputDescription provisionedThroughput)` The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
`TableDescription`	`withReplicas(Collection<ReplicaDescription> replicas)` Represents replicas of the table.
`TableDescription`	`withReplicas(ReplicaDescription... replicas)` Represents replicas of the table.
`TableDescription`	`withRestoreSummary(RestoreSummary restoreSummary)` Contains details for the restore.
`TableDescription`	`withSSEDescription(SSEDescription sSEDescription)` The description of the server-side encryption status on the specified table.
`TableDescription`	`withStreamSpecification(StreamSpecification streamSpecification)` The current DynamoDB Streams configuration for the table.
`TableDescription`	`withTableArn(String tableArn)` The Amazon Resource Name (ARN) that uniquely identifies the table.
`TableDescription`	`withTableId(String tableId)` Unique identifier for the table for which the backup was created.
`TableDescription`	`withTableName(String tableName)` The name of the table.
`TableDescription`	`withTableSizeBytes(Long tableSizeBytes)` The total size of the specified table, in bytes.
`TableDescription`	`withTableStatus(String tableStatus)` The current state of the table:
`TableDescription`	`withTableStatus(TableStatus tableStatus)` The current state of the table:

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

- Constructor Detail
  - TableDescription
```
public TableDescription()
```
- Method Detail
  - getAttributeDefinitions
```
public List<AttributeDefinition> getAttributeDefinitions()
```
    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.
    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.
  - setAttributeDefinitions
```
public void setAttributeDefinitions(Collection<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.
    Parameters:
    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.
  - withAttributeDefinitions
```
public TableDescription withAttributeDefinitions(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.
    NOTE: This method appends the values to the existing list (if any). Use setAttributeDefinitions(java.util.Collection) or withAttributeDefinitions(java.util.Collection) if you want to override the existing values.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAttributeDefinitions
```
public TableDescription withAttributeDefinitions(Collection<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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTableName
```
public void setTableName(String tableName)
```
    The name of the table.
    
    Parameters:
    
    tableName - The name of the table.
  - getTableName
```
public String getTableName()
```
    The name of the table.
    
    Returns:
    
    The name of the table.
  - withTableName
```
public TableDescription withTableName(String tableName)
```
    The name of the table.
    
    Parameters:
    
    tableName - The name of the table.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getKeySchema
```
public List<KeySchemaElement> getKeySchema()
```
    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's 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.
    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's 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.
  - setKeySchema
```
public void setKeySchema(Collection<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's 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.
    Parameters:
    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's 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.
  - withKeySchema
```
public TableDescription withKeySchema(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's 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.
    
    NOTE: This method appends the values to the existing list (if any). Use setKeySchema(java.util.Collection) or withKeySchema(java.util.Collection) if you want to override the existing values.
    Parameters:
    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's 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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withKeySchema
```
public TableDescription withKeySchema(Collection<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's 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.
    Parameters:
    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's 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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTableStatus
```
public void setTableStatus(String 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.
    - INACCESSIBLE_ENCRYPTION_CREDENTIALS - The AWS KMS key used to encrypt the table in inaccessible. Table operations may fail due to failure to use the AWS KMS key. DynamoDB will initiate the table archival process when a table's AWS KMS key remains inaccessible for more than seven days.
    - ARCHIVING - The table is being archived. Operations are not allowed until archival is complete.
    - ARCHIVED - The table has been archived. See the ArchivalReason for more information.
    Parameters:
    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.
    
    INACCESSIBLE_ENCRYPTION_CREDENTIALS - The AWS KMS key used to encrypt the table in inaccessible. Table operations may fail due to failure to use the AWS KMS key. DynamoDB will initiate the table archival process when a table's AWS KMS key remains inaccessible for more than seven days.
    
    ARCHIVING - The table is being archived. Operations are not allowed until archival is complete.
    
    ARCHIVED - The table has been archived. See the ArchivalReason for more information.
    See Also:
    
    TableStatus
  - getTableStatus
```
public String getTableStatus()
```
    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.
    - INACCESSIBLE_ENCRYPTION_CREDENTIALS - The AWS KMS key used to encrypt the table in inaccessible. Table operations may fail due to failure to use the AWS KMS key. DynamoDB will initiate the table archival process when a table's AWS KMS key remains inaccessible for more than seven days.
    - ARCHIVING - The table is being archived. Operations are not allowed until archival is complete.
    - ARCHIVED - The table has been archived. See the ArchivalReason for more information.
    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.
    
    INACCESSIBLE_ENCRYPTION_CREDENTIALS - The AWS KMS key used to encrypt the table in inaccessible. Table operations may fail due to failure to use the AWS KMS key. DynamoDB will initiate the table archival process when a table's AWS KMS key remains inaccessible for more than seven days.
    
    ARCHIVING - The table is being archived. Operations are not allowed until archival is complete.
    
    ARCHIVED - The table has been archived. See the ArchivalReason for more information.
    See Also:
    
    TableStatus
  - withTableStatus
```
public TableDescription withTableStatus(String 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.
    - INACCESSIBLE_ENCRYPTION_CREDENTIALS - The AWS KMS key used to encrypt the table in inaccessible. Table operations may fail due to failure to use the AWS KMS key. DynamoDB will initiate the table archival process when a table's AWS KMS key remains inaccessible for more than seven days.
    - ARCHIVING - The table is being archived. Operations are not allowed until archival is complete.
    - ARCHIVED - The table has been archived. See the ArchivalReason for more information.
    Parameters:
    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.
    
    INACCESSIBLE_ENCRYPTION_CREDENTIALS - The AWS KMS key used to encrypt the table in inaccessible. Table operations may fail due to failure to use the AWS KMS key. DynamoDB will initiate the table archival process when a table's AWS KMS key remains inaccessible for more than seven days.
    
    ARCHIVING - The table is being archived. Operations are not allowed until archival is complete.
    
    ARCHIVED - The table has been archived. See the ArchivalReason for more information.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TableStatus
  - setTableStatus
```
public void setTableStatus(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.
    - INACCESSIBLE_ENCRYPTION_CREDENTIALS - The AWS KMS key used to encrypt the table in inaccessible. Table operations may fail due to failure to use the AWS KMS key. DynamoDB will initiate the table archival process when a table's AWS KMS key remains inaccessible for more than seven days.
    - ARCHIVING - The table is being archived. Operations are not allowed until archival is complete.
    - ARCHIVED - The table has been archived. See the ArchivalReason for more information.
    Parameters:
    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.
    
    INACCESSIBLE_ENCRYPTION_CREDENTIALS - The AWS KMS key used to encrypt the table in inaccessible. Table operations may fail due to failure to use the AWS KMS key. DynamoDB will initiate the table archival process when a table's AWS KMS key remains inaccessible for more than seven days.
    
    ARCHIVING - The table is being archived. Operations are not allowed until archival is complete.
    
    ARCHIVED - The table has been archived. See the ArchivalReason for more information.
    See Also:
    
    TableStatus
  - withTableStatus
```
public TableDescription withTableStatus(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.
    - INACCESSIBLE_ENCRYPTION_CREDENTIALS - The AWS KMS key used to encrypt the table in inaccessible. Table operations may fail due to failure to use the AWS KMS key. DynamoDB will initiate the table archival process when a table's AWS KMS key remains inaccessible for more than seven days.
    - ARCHIVING - The table is being archived. Operations are not allowed until archival is complete.
    - ARCHIVED - The table has been archived. See the ArchivalReason for more information.
    Parameters:
    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.
    
    INACCESSIBLE_ENCRYPTION_CREDENTIALS - The AWS KMS key used to encrypt the table in inaccessible. Table operations may fail due to failure to use the AWS KMS key. DynamoDB will initiate the table archival process when a table's AWS KMS key remains inaccessible for more than seven days.
    
    ARCHIVING - The table is being archived. Operations are not allowed until archival is complete.
    
    ARCHIVED - The table has been archived. See the ArchivalReason for more information.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TableStatus
  - setCreationDateTime
```
public void setCreationDateTime(Date creationDateTime)
```
    The date and time when the table was created, in UNIX epoch time format.
    
    Parameters:
    
    creationDateTime - The date and time when the table was created, in UNIX epoch time format.
  - getCreationDateTime
```
public Date getCreationDateTime()
```
    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.
  - withCreationDateTime
```
public TableDescription withCreationDateTime(Date creationDateTime)
```
    The date and time when the table was created, in UNIX epoch time format.
    
    Parameters:
    
    creationDateTime - The date and time when the table was created, in UNIX epoch time format.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProvisionedThroughput
```
public void setProvisionedThroughput(ProvisionedThroughputDescription provisionedThroughput)
```
    The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
    
    Parameters:
    
    provisionedThroughput - The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
  - getProvisionedThroughput
```
public ProvisionedThroughputDescription getProvisionedThroughput()
```
    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.
  - withProvisionedThroughput
```
public TableDescription withProvisionedThroughput(ProvisionedThroughputDescription provisionedThroughput)
```
    The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
    
    Parameters:
    
    provisionedThroughput - The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTableSizeBytes
```
public void setTableSizeBytes(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.
    
    Parameters:
    
    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.
  - getTableSizeBytes
```
public Long getTableSizeBytes()
```
    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.
  - withTableSizeBytes
```
public TableDescription withTableSizeBytes(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setItemCount
```
public void setItemCount(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.
    
    Parameters:
    
    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.
  - getItemCount
```
public Long getItemCount()
```
    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.
  - withItemCount
```
public TableDescription withItemCount(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTableArn
```
public void setTableArn(String tableArn)
```
    The Amazon Resource Name (ARN) that uniquely identifies the table.
    
    Parameters:
    
    tableArn - The Amazon Resource Name (ARN) that uniquely identifies the table.
  - getTableArn
```
public String getTableArn()
```
    The Amazon Resource Name (ARN) that uniquely identifies the table.
    
    Returns:
    
    The Amazon Resource Name (ARN) that uniquely identifies the table.
  - withTableArn
```
public TableDescription withTableArn(String tableArn)
```
    The Amazon Resource Name (ARN) that uniquely identifies the table.
    
    Parameters:
    
    tableArn - The Amazon Resource Name (ARN) that uniquely identifies the table.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTableId
```
public void setTableId(String tableId)
```
    Unique identifier for the table for which the backup was created.
    
    Parameters:
    
    tableId - Unique identifier for the table for which the backup was created.
  - getTableId
```
public String getTableId()
```
    Unique identifier for the table for which the backup was created.
    
    Returns:
    
    Unique identifier for the table for which the backup was created.
  - withTableId
```
public TableDescription withTableId(String tableId)
```
    Unique identifier for the table for which the backup was created.
    
    Parameters:
    
    tableId - Unique identifier for the table for which the backup was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBillingModeSummary
```
public void setBillingModeSummary(BillingModeSummary billingModeSummary)
```
    Contains the details for the read/write capacity mode.
    
    Parameters:
    
    billingModeSummary - Contains the details for the read/write capacity mode.
  - getBillingModeSummary
```
public BillingModeSummary getBillingModeSummary()
```
    Contains the details for the read/write capacity mode.
    
    Returns:
    
    Contains the details for the read/write capacity mode.
  - withBillingModeSummary
```
public TableDescription withBillingModeSummary(BillingModeSummary billingModeSummary)
```
    Contains the details for the read/write capacity mode.
    
    Parameters:
    
    billingModeSummary - Contains the details for the read/write capacity mode.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getLocalSecondaryIndexes
```
public List<LocalSecondaryIndexDescription> getLocalSecondaryIndexes()
```
    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 is 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.
    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 is 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.
  - setLocalSecondaryIndexes
```
public void setLocalSecondaryIndexes(Collection<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 is 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.
    Parameters:
    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 is 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.
  - withLocalSecondaryIndexes
```
public TableDescription withLocalSecondaryIndexes(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 is 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.
    
    NOTE: This method appends the values to the existing list (if any). Use setLocalSecondaryIndexes(java.util.Collection) or withLocalSecondaryIndexes(java.util.Collection) if you want to override the existing values.
    Parameters:
    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 is 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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withLocalSecondaryIndexes
```
public TableDescription withLocalSecondaryIndexes(Collection<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 is 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.
    Parameters:
    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 is 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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getGlobalSecondaryIndexes
```
public List<GlobalSecondaryIndexDescription> getGlobalSecondaryIndexes()
```
    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.)
      
      You can delete an index that is being created during the Backfilling phase when IndexStatus is set to CREATING and Backfilling is true. You can't delete the index that is being created when IndexStatus is set to CREATING and Backfilling is false. (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 - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.
      
      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.
    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.)
    
    You can delete an index that is being created during the Backfilling phase when IndexStatus is set to CREATING and Backfilling is true. You can't delete the index that is being created when IndexStatus is set to CREATING and Backfilling is false. (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 - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.
    
    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.
  - setGlobalSecondaryIndexes
```
public void setGlobalSecondaryIndexes(Collection<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.)
      
      You can delete an index that is being created during the Backfilling phase when IndexStatus is set to CREATING and Backfilling is true. You can't delete the index that is being created when IndexStatus is set to CREATING and Backfilling is false. (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 - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.
      
      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.
    Parameters:
    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.)
    
    You can delete an index that is being created during the Backfilling phase when IndexStatus is set to CREATING and Backfilling is true. You can't delete the index that is being created when IndexStatus is set to CREATING and Backfilling is false. (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 - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.
    
    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.
  - withGlobalSecondaryIndexes
```
public TableDescription withGlobalSecondaryIndexes(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.)
      
      You can delete an index that is being created during the Backfilling phase when IndexStatus is set to CREATING and Backfilling is true. You can't delete the index that is being created when IndexStatus is set to CREATING and Backfilling is false. (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 - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.
      
      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.
    
    NOTE: This method appends the values to the existing list (if any). Use setGlobalSecondaryIndexes(java.util.Collection) or withGlobalSecondaryIndexes(java.util.Collection) if you want to override the existing values.
    Parameters:
    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.)
    
    You can delete an index that is being created during the Backfilling phase when IndexStatus is set to CREATING and Backfilling is true. You can't delete the index that is being created when IndexStatus is set to CREATING and Backfilling is false. (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 - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.
    
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withGlobalSecondaryIndexes
```
public TableDescription withGlobalSecondaryIndexes(Collection<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.)
      
      You can delete an index that is being created during the Backfilling phase when IndexStatus is set to CREATING and Backfilling is true. You can't delete the index that is being created when IndexStatus is set to CREATING and Backfilling is false. (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 - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.
      
      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.
    Parameters:
    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.)
    
    You can delete an index that is being created during the Backfilling phase when IndexStatus is set to CREATING and Backfilling is true. You can't delete the index that is being created when IndexStatus is set to CREATING and Backfilling is false. (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 - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.
    
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStreamSpecification
```
public void setStreamSpecification(StreamSpecification streamSpecification)
```
    The current DynamoDB Streams configuration for the table.
    
    Parameters:
    
    streamSpecification - The current DynamoDB Streams configuration for the table.
  - getStreamSpecification
```
public StreamSpecification getStreamSpecification()
```
    The current DynamoDB Streams configuration for the table.
    
    Returns:
    
    The current DynamoDB Streams configuration for the table.
  - withStreamSpecification
```
public TableDescription withStreamSpecification(StreamSpecification streamSpecification)
```
    The current DynamoDB Streams configuration for the table.
    
    Parameters:
    
    streamSpecification - The current DynamoDB Streams configuration for the table.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLatestStreamLabel
```
public void setLatestStreamLabel(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:
    - AWS customer ID
    - Table name
    - StreamLabel
    Parameters:
    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:
    
    AWS customer ID
    
    Table name
    
    StreamLabel
  - getLatestStreamLabel
```
public String getLatestStreamLabel()
```
    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:
    - AWS customer ID
    - Table name
    - 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:
    
    AWS customer ID
    
    Table name
    
    StreamLabel
  - withLatestStreamLabel
```
public TableDescription withLatestStreamLabel(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:
    - AWS customer ID
    - Table name
    - StreamLabel
    Parameters:
    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:
    
    AWS customer ID
    
    Table name
    
    StreamLabel
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLatestStreamArn
```
public void setLatestStreamArn(String latestStreamArn)
```
    The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
    
    Parameters:
    
    latestStreamArn - The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
  - getLatestStreamArn
```
public String getLatestStreamArn()
```
    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.
  - withLatestStreamArn
```
public TableDescription withLatestStreamArn(String latestStreamArn)
```
    The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
    
    Parameters:
    
    latestStreamArn - The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGlobalTableVersion
```
public void setGlobalTableVersion(String globalTableVersion)
```
    Represents the version of global tables in use, if the table is replicated across AWS Regions.
    
    Parameters:
    
    globalTableVersion - Represents the version of global tables in use, if the table is replicated across AWS Regions.
  - getGlobalTableVersion
```
public String getGlobalTableVersion()
```
    Represents the version of global tables in use, if the table is replicated across AWS Regions.
    
    Returns:
    
    Represents the version of global tables in use, if the table is replicated across AWS Regions.
  - withGlobalTableVersion
```
public TableDescription withGlobalTableVersion(String globalTableVersion)
```
    Represents the version of global tables in use, if the table is replicated across AWS Regions.
    
    Parameters:
    
    globalTableVersion - Represents the version of global tables in use, if the table is replicated across AWS Regions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getReplicas
```
public List<ReplicaDescription> getReplicas()
```
    Represents replicas of the table.
    
    Returns:
    
    Represents replicas of the table.
  - setReplicas
```
public void setReplicas(Collection<ReplicaDescription> replicas)
```
    Represents replicas of the table.
    
    Parameters:
    
    replicas - Represents replicas of the table.
  - withReplicas
```
public TableDescription withReplicas(ReplicaDescription... replicas)
```
    Represents replicas of the table.
    
    NOTE: This method appends the values to the existing list (if any). Use setReplicas(java.util.Collection) or withReplicas(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    replicas - Represents replicas of the table.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withReplicas
```
public TableDescription withReplicas(Collection<ReplicaDescription> replicas)
```
    Represents replicas of the table.
    
    Parameters:
    
    replicas - Represents replicas of the table.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRestoreSummary
```
public void setRestoreSummary(RestoreSummary restoreSummary)
```
    Contains details for the restore.
    
    Parameters:
    
    restoreSummary - Contains details for the restore.
  - getRestoreSummary
```
public RestoreSummary getRestoreSummary()
```
    Contains details for the restore.
    
    Returns:
    
    Contains details for the restore.
  - withRestoreSummary
```
public TableDescription withRestoreSummary(RestoreSummary restoreSummary)
```
    Contains details for the restore.
    
    Parameters:
    
    restoreSummary - Contains details for the restore.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSSEDescription
```
public void setSSEDescription(SSEDescription sSEDescription)
```
    The description of the server-side encryption status on the specified table.
    
    Parameters:
    
    sSEDescription - The description of the server-side encryption status on the specified table.
  - getSSEDescription
```
public SSEDescription getSSEDescription()
```
    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.
  - withSSEDescription
```
public TableDescription withSSEDescription(SSEDescription sSEDescription)
```
    The description of the server-side encryption status on the specified table.
    
    Parameters:
    
    sSEDescription - The description of the server-side encryption status on the specified table.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setArchivalSummary
```
public void setArchivalSummary(ArchivalSummary archivalSummary)
```
    Contains information about the table archive.
    
    Parameters:
    
    archivalSummary - Contains information about the table archive.
  - getArchivalSummary
```
public ArchivalSummary getArchivalSummary()
```
    Contains information about the table archive.
    
    Returns:
    
    Contains information about the table archive.
  - withArchivalSummary
```
public TableDescription withArchivalSummary(ArchivalSummary archivalSummary)
```
    Contains information about the table archive.
    
    Parameters:
    
    archivalSummary - Contains information about the table archive.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public TableDescription clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class TableDescription

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TableDescription

Method Detail

getAttributeDefinitions

setAttributeDefinitions

withAttributeDefinitions

withAttributeDefinitions

setTableName

getTableName

withTableName

getKeySchema

setKeySchema

withKeySchema

withKeySchema

setTableStatus

getTableStatus

withTableStatus

setTableStatus

withTableStatus

setCreationDateTime

getCreationDateTime

withCreationDateTime

setProvisionedThroughput

getProvisionedThroughput

withProvisionedThroughput

setTableSizeBytes

getTableSizeBytes

withTableSizeBytes

setItemCount

getItemCount

withItemCount

setTableArn

getTableArn

withTableArn

setTableId

getTableId

withTableId

setBillingModeSummary

getBillingModeSummary

withBillingModeSummary

getLocalSecondaryIndexes

setLocalSecondaryIndexes

withLocalSecondaryIndexes

withLocalSecondaryIndexes

getGlobalSecondaryIndexes

setGlobalSecondaryIndexes

withGlobalSecondaryIndexes

withGlobalSecondaryIndexes

setStreamSpecification

getStreamSpecification

withStreamSpecification

setLatestStreamLabel

getLatestStreamLabel

withLatestStreamLabel

setLatestStreamArn

getLatestStreamArn

withLatestStreamArn

setGlobalTableVersion

getGlobalTableVersion

withGlobalTableVersion

getReplicas

setReplicas

withReplicas

withReplicas

setRestoreSummary

getRestoreSummary

withRestoreSummary

setSSEDescription

getSSEDescription

withSSEDescription

setArchivalSummary

getArchivalSummary

withArchivalSummary

toString

equals