com.amazonaws.services.dynamodbv2.model

Class TableDescription

java.lang.Object

com.amazonaws.services.dynamodbv2.model.TableDescription

All Implemented Interfaces:

Serializable

public class TableDescription
extends Object
implements Serializable

Represents the properties of a table.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TableDescription() Default constructor for a new TableDescription object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<AttributeDefinition>	getAttributeDefinitions() An array of AttributeDefinition objects.
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.
Long	getItemCount() The number of items in the specified table.
List<KeySchemaElement>	getKeySchema() The primary key structure for the table.
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.
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	setAttributeDefinitions(Collection<AttributeDefinition> attributeDefinitions) An array of AttributeDefinition objects.
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	setItemCount(Long itemCount) The number of items in the specified table.
void	setKeySchema(Collection<KeySchemaElement> keySchema) The primary key structure for the table.
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	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; useful for testing and debugging.
TableDescription	withAttributeDefinitions(AttributeDefinition... attributeDefinitions) An array of AttributeDefinition objects.
TableDescription	withAttributeDefinitions(Collection<AttributeDefinition> attributeDefinitions) An array of AttributeDefinition objects.
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	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	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	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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TableDescription

public TableDescription()

Default constructor for a new TableDescription object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

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.

Returns a reference to this object so that method calls can be chained together.

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:

A reference to this updated 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.

Returns a reference to this object so that method calls can be chained together.

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:

A reference to this updated object so that method calls can be chained together.

getTableName

public String getTableName()

The name of the table.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Returns:

The name of the table.

setTableName

public void setTableName(String tableName)

The name of the table.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Parameters:

tableName - The name of the table.

withTableName

public TableDescription withTableName(String tableName)

The name of the table.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Parameters:

tableName - The name of the table.

Returns:

A reference to this updated 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 key type for the attribute. Can be either HASH or RANGE.

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

Constraints:
Length: 1 - 2

Returns:

The primary key structure for the table. Each KeySchemaElement consists of:

• AttributeName - The name of the attribute.

• KeyType - The key type for the attribute. Can be either HASH or RANGE.

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 key type for the attribute. Can be either HASH or RANGE.

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

Constraints:
Length: 1 - 2

Parameters:

keySchema - The primary key structure for the table. Each KeySchemaElement consists of:

• AttributeName - The name of the attribute.

• KeyType - The key type for the attribute. Can be either HASH or RANGE.

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 key type for the attribute. Can be either HASH or RANGE.

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 2

Parameters:

keySchema - The primary key structure for the table. Each KeySchemaElement consists of:

• AttributeName - The name of the attribute.

• KeyType - The key type for the attribute. Can be either HASH or RANGE.

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

Returns:

A reference to this updated 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 key type for the attribute. Can be either HASH or RANGE.

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 2

Parameters:

keySchema - The primary key structure for the table. Each KeySchemaElement consists of:

• AttributeName - The name of the attribute.

• KeyType - The key type for the attribute. Can be either HASH or RANGE.

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

Returns:

A reference to this updated object so that method calls can be chained together.

getTableStatus

public String getTableStatus()

The current state of the table:

• CREATING - The table is being created, as the result of a CreateTable operation.

• UPDATING - The table is being updated, as the result of an UpdateTable operation.

• DELETING - The table is being deleted, as the result of a DeleteTable operation.

• ACTIVE - The table is ready for use.

Constraints:
Allowed Values: CREATING, UPDATING, DELETING, ACTIVE

Returns:

The current state of the table:

• CREATING - The table is being created, as the result of a CreateTable operation.

• UPDATING - The table is being updated, as the result of an UpdateTable operation.

• DELETING - The table is being deleted, as the result of a DeleteTable operation.

• ACTIVE - The table is ready for use.

See Also:

TableStatus

setTableStatus

public void setTableStatus(String tableStatus)

The current state of the table:

• CREATING - The table is being created, as the result of a CreateTable operation.

• UPDATING - The table is being updated, as the result of an UpdateTable operation.

• DELETING - The table is being deleted, as the result of a DeleteTable operation.

• ACTIVE - The table is ready for use.

Constraints:
Allowed Values: CREATING, UPDATING, DELETING, ACTIVE

Parameters:

tableStatus - The current state of the table:

• CREATING - The table is being created, as the result of a CreateTable operation.

• UPDATING - The table is being updated, as the result of an UpdateTable operation.

• DELETING - The table is being deleted, as the result of a DeleteTable operation.

• ACTIVE - The table is ready for use.

See Also:

TableStatus

withTableStatus

public TableDescription withTableStatus(String tableStatus)

The current state of the table:

• CREATING - The table is being created, as the result of a CreateTable operation.

• UPDATING - The table is being updated, as the result of an UpdateTable operation.

• DELETING - The table is being deleted, as the result of a DeleteTable operation.

• ACTIVE - The table is ready for use.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: CREATING, UPDATING, DELETING, ACTIVE

Parameters:

tableStatus - The current state of the table:

• CREATING - The table is being created, as the result of a CreateTable operation.

• UPDATING - The table is being updated, as the result of an UpdateTable operation.

• DELETING - The table is being deleted, as the result of a DeleteTable operation.

• ACTIVE - The table is ready for use.

Returns:

A reference to this updated 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, as the result of a CreateTable operation.

• UPDATING - The table is being updated, as the result of an UpdateTable operation.

• DELETING - The table is being deleted, as the result of a DeleteTable operation.

• ACTIVE - The table is ready for use.

Constraints:
Allowed Values: CREATING, UPDATING, DELETING, ACTIVE

Parameters:

tableStatus - The current state of the table:

• CREATING - The table is being created, as the result of a CreateTable operation.

• UPDATING - The table is being updated, as the result of an UpdateTable operation.

• DELETING - The table is being deleted, as the result of a DeleteTable operation.

• ACTIVE - The table is ready for use.

See Also:

TableStatus

withTableStatus

public TableDescription withTableStatus(TableStatus tableStatus)

The current state of the table:

• CREATING - The table is being created, as the result of a CreateTable operation.

• UPDATING - The table is being updated, as the result of an UpdateTable operation.

• DELETING - The table is being deleted, as the result of a DeleteTable operation.

• ACTIVE - The table is ready for use.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: CREATING, UPDATING, DELETING, ACTIVE

Parameters:

tableStatus - The current state of the table:

• CREATING - The table is being created, as the result of a CreateTable operation.

• UPDATING - The table is being updated, as the result of an UpdateTable operation.

• DELETING - The table is being deleted, as the result of a DeleteTable operation.

• ACTIVE - The table is ready for use.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

TableStatus

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.

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.

withCreationDateTime

public TableDescription withCreationDateTime(Date creationDateTime)

The date and time when the table was created, in UNIX epoch time format.

Returns a reference to this object so that method calls can be chained together.

Parameters:

creationDateTime - The date and time when the table was created, in UNIX epoch time format.

Returns:

A reference to this updated object so that method calls can be chained together.

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.

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.

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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

provisionedThroughput - The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

Returns:

A reference to this updated object so that method calls can be chained together.

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.

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.

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.

Returns a reference to this object so that method calls can be chained together.

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:

A reference to this updated object so that method calls can be chained together.

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.

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.

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.

Returns a reference to this object so that method calls can be chained together.

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:

A reference to this updated 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 hash 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 hash key attribute 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 specified 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 hash 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 hash key attribute 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 specified 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 hash 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 hash key attribute 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 specified 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 hash 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 hash key attribute 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 specified 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 hash 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 hash key attribute 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 specified 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 a reference to this object so that method calls can be chained together.

Parameters:

localSecondaryIndexes - Represents one or more local secondary indexes on the table. Each index is scoped to a given hash 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 hash key attribute 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 specified 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:

A reference to this updated 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 hash 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 hash key attribute 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 specified 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 a reference to this object so that method calls can be chained together.

Parameters:

localSecondaryIndexes - Represents one or more local secondary indexes on the table. Each index is scoped to a given hash 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 hash key attribute 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 specified 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:

A reference to this updated 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 hash key value. Each element is composed of:

• 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 hash key attribute 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 specified 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 hash key value. Each element is composed of:

• 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 hash key attribute 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 specified 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 hash key value. Each element is composed of:

• 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 hash key attribute 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 specified 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 hash key value. Each element is composed of:

• 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 hash key attribute 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 specified 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 hash key value. Each element is composed of:

• 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 hash key attribute 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 specified 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 a reference to this object so that method calls can be chained together.

Parameters:

globalSecondaryIndexes - The global secondary indexes, if any, on the table. Each index is scoped to a given hash key value. Each element is composed of:

• 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 hash key attribute 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 specified 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:

A reference to this updated 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 hash key value. Each element is composed of:

• 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 hash key attribute 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 specified 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 a reference to this object so that method calls can be chained together.

Parameters:

globalSecondaryIndexes - The global secondary indexes, if any, on the table. Each index is scoped to a given hash key value. Each element is composed of:

• 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 hash key attribute 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 specified 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:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object