Class TableDescription
- java.lang.Object
-
- com.amazonaws.services.dynamodbv2.model.TableDescription
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class TableDescription extends Object implements Serializable, Cloneable
Represents the properties of a table.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description TableDescription()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TableDescription
clone()
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.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.StreamSpecification
getStreamSpecification()
The current DynamoDB Streams configuration for the table.String
getTableArn()
The Amazon Resource Name (ARN) that uniquely identifies the table.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
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
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
setTableName(String tableName)
The name of the table.void
setTableSizeBytes(Long tableSizeBytes)
The total size of the specified table, in bytes.void
setTableStatus(TableStatus tableStatus)
The current state of the table:void
setTableStatus(String 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(GlobalSecondaryIndexDescription... globalSecondaryIndexes)
The global secondary indexes, if any, on the table.TableDescription
withGlobalSecondaryIndexes(Collection<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(KeySchemaElement... keySchema)
The primary key structure for the table.TableDescription
withKeySchema(Collection<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(LocalSecondaryIndexDescription... localSecondaryIndexes)
Represents one or more local secondary indexes on the table.TableDescription
withLocalSecondaryIndexes(Collection<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
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
withTableName(String tableName)
The name of the table.TableDescription
withTableSizeBytes(Long tableSizeBytes)
The total size of the specified table, in bytes.TableDescription
withTableStatus(TableStatus tableStatus)
The current state of the table:TableDescription
withTableStatus(String tableStatus)
The current state of the table:
-
-
-
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)
orwithAttributeDefinitions(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' 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' 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' 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' 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' 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)
orwithKeySchema(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' 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' 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' 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.
- 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.
-
- 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.
- Returns:
- The current state of the table:
-
CREATING - The table is being created.
-
UPDATING - The table is being updated.
-
DELETING - The table is being deleted.
-
ACTIVE - The table is ready for use.
-
- See Also:
TableStatus
-
-
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.
- 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.
-
- 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.
- 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.
-
- 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.
- 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.
-
- 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.
-
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 are in NonKeyAttributes. -
ALL
- All of the table attributes are projected into the index.
-
-
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
-
-
IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
-
ItemCount - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
If the table is in the
DELETING
state, no information about indexes will be returned.- Returns:
- Represents one or more local secondary indexes on the table. Each
index is scoped to a given partition key value. Tables with one
or more local secondary indexes are subject to an item collection
size limit, where the amount of data within a given item
collection cannot exceed 10 GB. Each element is composed of:
-
IndexName - The name of the local secondary index.
-
KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.
-
Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
-
ProjectionType - One of the following:
-
KEYS_ONLY
- Only the index and primary keys are projected into the index. -
INCLUDE
- Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes. -
ALL
- All of the table attributes are projected into the index.
-
-
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
-
-
IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
-
ItemCount - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
If the table is in the
DELETING
state, no information about indexes will be returned. -
-
-
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 are in NonKeyAttributes. -
ALL
- All of the table attributes are projected into the index.
-
-
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
-
-
IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
-
ItemCount - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
If the table is in the
DELETING
state, no information about indexes will be returned.- 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 are in NonKeyAttributes. -
ALL
- All of the table attributes are projected into the index.
-
-
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
-
-
IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
-
ItemCount - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
If the table is in the
DELETING
state, no information about indexes will be returned.-
-
-
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 are in NonKeyAttributes. -
ALL
- All of the table attributes are projected into the index.
-
-
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
-
-
IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
-
ItemCount - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
If the table is in the
DELETING
state, no information about indexes will be returned.NOTE: This method appends the values to the existing list (if any). Use
setLocalSecondaryIndexes(java.util.Collection)
orwithLocalSecondaryIndexes(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 are in NonKeyAttributes. -
ALL
- All of the table attributes are projected into the index.
-
-
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
-
-
IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
-
ItemCount - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
If the table is in the
DELETING
state, no information about indexes will be returned.-
- 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 are in NonKeyAttributes. -
ALL
- All of the table attributes are projected into the index.
-
-
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
-
-
IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
-
ItemCount - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
If the table is in the
DELETING
state, no information about indexes will be returned.- 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 are in NonKeyAttributes. -
ALL
- All of the table attributes are projected into the index.
-
-
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
-
-
IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
-
ItemCount - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
If the table is in the
DELETING
state, no information about indexes will be returned.-
- 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.)
-
IndexName - The name of the global secondary index.
-
IndexSizeBytes - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
-
IndexStatus - The current status of the global secondary index:
-
CREATING - The index is being created.
-
UPDATING - The index is being updated.
-
DELETING - The index is being deleted.
-
ACTIVE - The index is ready for use.
-
-
ItemCount - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
-
KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.
-
Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
-
ProjectionType - One of the following:
-
KEYS_ONLY
- Only the index and primary keys are projected into the index. -
INCLUDE
- Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes. -
ALL
- All of the table attributes are projected into the index.
-
-
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
-
-
ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases.
If the table is in the
DELETING
state, no information about indexes will be returned.- Returns:
- The global secondary indexes, if any, on the table. Each index is
scoped to a given partition key value. Each element is composed
of:
-
Backfilling - If true, then the index is currently in the backfilling phase. Backfilling occurs only when a new global secondary index is added to the table; it is the process by which DynamoDB populates the new index with data from the table. (This attribute does not appear for indexes that were created during a CreateTable operation.)
-
IndexName - The name of the global secondary index.
-
IndexSizeBytes - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
-
IndexStatus - The current status of the global secondary index:
-
CREATING - The index is being created.
-
UPDATING - The index is being updated.
-
DELETING - The index is being deleted.
-
ACTIVE - The index is ready for use.
-
-
ItemCount - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
-
KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.
-
Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
-
ProjectionType - One of the following:
-
KEYS_ONLY
- Only the index and primary keys are projected into the index. -
INCLUDE
- Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes. -
ALL
- All of the table attributes are projected into the index.
-
-
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
-
-
ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases.
If the table is in the
DELETING
state, no information about indexes will be returned. -
-
-
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.)
-
IndexName - The name of the global secondary index.
-
IndexSizeBytes - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
-
IndexStatus - The current status of the global secondary index:
-
CREATING - The index is being created.
-
UPDATING - The index is being updated.
-
DELETING - The index is being deleted.
-
ACTIVE - The index is ready for use.
-
-
ItemCount - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
-
KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.
-
Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
-
ProjectionType - One of the following:
-
KEYS_ONLY
- Only the index and primary keys are projected into the index. -
INCLUDE
- Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes. -
ALL
- All of the table attributes are projected into the index.
-
-
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
-
-
ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases.
If the table is in the
DELETING
state, no information about indexes will be returned.- 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.)
-
IndexName - The name of the global secondary index.
-
IndexSizeBytes - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
-
IndexStatus - The current status of the global secondary index:
-
CREATING - The index is being created.
-
UPDATING - The index is being updated.
-
DELETING - The index is being deleted.
-
ACTIVE - The index is ready for use.
-
-
ItemCount - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
-
KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.
-
Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
-
ProjectionType - One of the following:
-
KEYS_ONLY
- Only the index and primary keys are projected into the index. -
INCLUDE
- Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes. -
ALL
- All of the table attributes are projected into the index.
-
-
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
-
-
ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases.
If the table is in the
DELETING
state, no information about indexes will be returned.-
-
-
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.)
-
IndexName - The name of the global secondary index.
-
IndexSizeBytes - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
-
IndexStatus - The current status of the global secondary index:
-
CREATING - The index is being created.
-
UPDATING - The index is being updated.
-
DELETING - The index is being deleted.
-
ACTIVE - The index is ready for use.
-
-
ItemCount - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
-
KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.
-
Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
-
ProjectionType - One of the following:
-
KEYS_ONLY
- Only the index and primary keys are projected into the index. -
INCLUDE
- Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes. -
ALL
- All of the table attributes are projected into the index.
-
-
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
-
-
ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases.
If the table is in the
DELETING
state, no information about indexes will be returned.NOTE: This method appends the values to the existing list (if any). Use
setGlobalSecondaryIndexes(java.util.Collection)
orwithGlobalSecondaryIndexes(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.)
-
IndexName - The name of the global secondary index.
-
IndexSizeBytes - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
-
IndexStatus - The current status of the global secondary index:
-
CREATING - The index is being created.
-
UPDATING - The index is being updated.
-
DELETING - The index is being deleted.
-
ACTIVE - The index is ready for use.
-
-
ItemCount - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
-
KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.
-
Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
-
ProjectionType - One of the following:
-
KEYS_ONLY
- Only the index and primary keys are projected into the index. -
INCLUDE
- Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes. -
ALL
- All of the table attributes are projected into the index.
-
-
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
-
-
ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases.
If the table is in the
DELETING
state, no information about indexes will be returned.-
- 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.)
-
IndexName - The name of the global secondary index.
-
IndexSizeBytes - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
-
IndexStatus - The current status of the global secondary index:
-
CREATING - The index is being created.
-
UPDATING - The index is being updated.
-
DELETING - The index is being deleted.
-
ACTIVE - The index is ready for use.
-
-
ItemCount - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
-
KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.
-
Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
-
ProjectionType - One of the following:
-
KEYS_ONLY
- Only the index and primary keys are projected into the index. -
INCLUDE
- Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes. -
ALL
- All of the table attributes are projected into the index.
-
-
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
-
-
ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases.
If the table is in the
DELETING
state, no information about indexes will be returned.- 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.)
-
IndexName - The name of the global secondary index.
-
IndexSizeBytes - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
-
IndexStatus - The current status of the global secondary index:
-
CREATING - The index is being created.
-
UPDATING - The index is being updated.
-
DELETING - The index is being deleted.
-
ACTIVE - The index is ready for use.
-
-
ItemCount - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
-
KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.
-
Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
-
ProjectionType - One of the following:
-
KEYS_ONLY
- Only the index and primary keys are projected into the index. -
INCLUDE
- Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes. -
ALL
- All of the table attributes are projected into the index.
-
-
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
-
-
ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases.
If the table is in the
DELETING
state, no information about indexes will be returned.-
- 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:
-
the AWS customer ID.
-
the table name.
-
the 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:
-
the AWS customer ID.
-
the table name.
-
the 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:
-
the AWS customer ID.
-
the table name.
-
the StreamLabel.
- Returns:
- A timestamp, in ISO 8601 format, for this stream.
Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:
-
the AWS customer ID.
-
the table name.
-
the StreamLabel.
-
-
-
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:
-
the AWS customer ID.
-
the table name.
-
the 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:
-
the AWS customer ID.
-
the table name.
-
the 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.
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public TableDescription clone()
-
-