public class TableDescription
extends java.lang.Object
implements java.io.Serializable
Represents the properties of a table.
Constructor and Description |
---|
TableDescription() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.util.List<AttributeDefinition> |
getAttributeDefinitions()
An array of
AttributeDefinition objects. |
java.util.Date |
getCreationDateTime()
The date and time when the table was created, in UNIX epoch time format.
|
java.util.List<GlobalSecondaryIndexDescription> |
getGlobalSecondaryIndexes()
The global secondary indexes, if any, on the table.
|
java.lang.Long |
getItemCount()
The number of items in the specified table.
|
java.util.List<KeySchemaElement> |
getKeySchema()
The primary key structure for the table.
|
java.lang.String |
getLatestStreamArn()
The Amazon Resource Name (ARN) that uniquely identifies the latest stream
for this table.
|
java.lang.String |
getLatestStreamLabel()
A timestamp, in ISO 8601 format, for this stream.
|
java.util.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.
|
RestoreSummary |
getRestoreSummary()
Contains details for the restore.
|
SSEDescription |
getSSEDescription()
The description of the server-side encryption status on the specified
table.
|
StreamSpecification |
getStreamSpecification()
The current DynamoDB Streams configuration for the table.
|
java.lang.String |
getTableArn()
The Amazon Resource Name (ARN) that uniquely identifies the table.
|
java.lang.String |
getTableId()
Unique identifier for the table for which the backup was created.
|
java.lang.String |
getTableName()
The name of the table.
|
java.lang.Long |
getTableSizeBytes()
The total size of the specified table, in bytes.
|
java.lang.String |
getTableStatus()
The current state of the table:
|
int |
hashCode() |
void |
setAttributeDefinitions(java.util.Collection<AttributeDefinition> attributeDefinitions)
An array of
AttributeDefinition objects. |
void |
setCreationDateTime(java.util.Date creationDateTime)
The date and time when the table was created, in UNIX epoch time format.
|
void |
setGlobalSecondaryIndexes(java.util.Collection<GlobalSecondaryIndexDescription> globalSecondaryIndexes)
The global secondary indexes, if any, on the table.
|
void |
setItemCount(java.lang.Long itemCount)
The number of items in the specified table.
|
void |
setKeySchema(java.util.Collection<KeySchemaElement> keySchema)
The primary key structure for the table.
|
void |
setLatestStreamArn(java.lang.String latestStreamArn)
The Amazon Resource Name (ARN) that uniquely identifies the latest stream
for this table.
|
void |
setLatestStreamLabel(java.lang.String latestStreamLabel)
A timestamp, in ISO 8601 format, for this stream.
|
void |
setLocalSecondaryIndexes(java.util.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 |
setRestoreSummary(RestoreSummary restoreSummary)
Contains details for the restore.
|
void |
setSSEDescription(SSEDescription sSEDescription)
The description of the server-side encryption status on the specified
table.
|
void |
setStreamSpecification(StreamSpecification streamSpecification)
The current DynamoDB Streams configuration for the table.
|
void |
setTableArn(java.lang.String tableArn)
The Amazon Resource Name (ARN) that uniquely identifies the table.
|
void |
setTableId(java.lang.String tableId)
Unique identifier for the table for which the backup was created.
|
void |
setTableName(java.lang.String tableName)
The name of the table.
|
void |
setTableSizeBytes(java.lang.Long tableSizeBytes)
The total size of the specified table, in bytes.
|
void |
setTableStatus(java.lang.String tableStatus)
The current state of the table:
|
void |
setTableStatus(TableStatus tableStatus)
The current state of the table:
|
java.lang.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(java.util.Collection<AttributeDefinition> attributeDefinitions)
An array of
AttributeDefinition objects. |
TableDescription |
withCreationDateTime(java.util.Date creationDateTime)
The date and time when the table was created, in UNIX epoch time format.
|
TableDescription |
withGlobalSecondaryIndexes(java.util.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(java.lang.Long itemCount)
The number of items in the specified table.
|
TableDescription |
withKeySchema(java.util.Collection<KeySchemaElement> keySchema)
The primary key structure for the table.
|
TableDescription |
withKeySchema(KeySchemaElement... keySchema)
The primary key structure for the table.
|
TableDescription |
withLatestStreamArn(java.lang.String latestStreamArn)
The Amazon Resource Name (ARN) that uniquely identifies the latest stream
for this table.
|
TableDescription |
withLatestStreamLabel(java.lang.String latestStreamLabel)
A timestamp, in ISO 8601 format, for this stream.
|
TableDescription |
withLocalSecondaryIndexes(java.util.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 |
withRestoreSummary(RestoreSummary restoreSummary)
Contains details for the restore.
|
TableDescription |
withSSEDescription(SSEDescription sSEDescription)
The description of the server-side encryption status on the specified
table.
|
TableDescription |
withStreamSpecification(StreamSpecification streamSpecification)
The current DynamoDB Streams configuration for the table.
|
TableDescription |
withTableArn(java.lang.String tableArn)
The Amazon Resource Name (ARN) that uniquely identifies the table.
|
TableDescription |
withTableId(java.lang.String tableId)
Unique identifier for the table for which the backup was created.
|
TableDescription |
withTableName(java.lang.String tableName)
The name of the table.
|
TableDescription |
withTableSizeBytes(java.lang.Long tableSizeBytes)
The total size of the specified table, in bytes.
|
TableDescription |
withTableStatus(java.lang.String tableStatus)
The current state of the table:
|
TableDescription |
withTableStatus(TableStatus tableStatus)
The current state of the table:
|
public java.util.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.
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.
public void setAttributeDefinitions(java.util.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.
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.
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.
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.
public TableDescription withAttributeDefinitions(java.util.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.
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.
public java.lang.String getTableName()
The name of the table.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
The name of the table.
public void setTableName(java.lang.String tableName)
The name of the table.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
tableName
- The name of the table.
public TableDescription withTableName(java.lang.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_.-]+
tableName
- The name of the table.
public java.util.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.
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.
public void setKeySchema(java.util.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.
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.
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.
Returns a reference to this object so that method calls can be chained together.
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.
public TableDescription withKeySchema(java.util.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.
Returns a reference to this object so that method calls can be chained together.
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.
public java.lang.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.
Constraints:
Allowed Values: CREATING, UPDATING, DELETING, ACTIVE
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.
TableStatus
public void setTableStatus(java.lang.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.
Constraints:
Allowed Values: CREATING, UPDATING, DELETING, ACTIVE
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.
TableStatus
public TableDescription withTableStatus(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: CREATING, UPDATING, DELETING, ACTIVE
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.
TableStatus
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.
Constraints:
Allowed Values: CREATING, UPDATING, DELETING, ACTIVE
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.
TableStatus
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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: CREATING, UPDATING, DELETING, ACTIVE
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.
TableStatus
public java.util.Date getCreationDateTime()
The date and time when the table was created, in UNIX epoch time format.
The date and time when the table was created, in UNIX epoch time format.
public void setCreationDateTime(java.util.Date creationDateTime)
The date and time when the table was created, in UNIX epoch time format.
creationDateTime
- The date and time when the table was created, in UNIX epoch time format.
public TableDescription withCreationDateTime(java.util.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.
creationDateTime
- The date and time when the table was created, in UNIX epoch time format.
public ProvisionedThroughputDescription getProvisionedThroughput()
The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
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.
provisionedThroughput
- The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
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.
provisionedThroughput
- The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
public java.lang.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.
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.
public void setTableSizeBytes(java.lang.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.
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.
public TableDescription withTableSizeBytes(java.lang.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.
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.
public java.lang.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.
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.
public void setItemCount(java.lang.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.
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.
public TableDescription withItemCount(java.lang.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.
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.
public java.lang.String getTableArn()
The Amazon Resource Name (ARN) that uniquely identifies the table.
The Amazon Resource Name (ARN) that uniquely identifies the table.
public void setTableArn(java.lang.String tableArn)
The Amazon Resource Name (ARN) that uniquely identifies the table.
tableArn
- The Amazon Resource Name (ARN) that uniquely identifies the table.
public TableDescription withTableArn(java.lang.String tableArn)
The Amazon Resource Name (ARN) that uniquely identifies the table.
Returns a reference to this object so that method calls can be chained together.
tableArn
- The Amazon Resource Name (ARN) that uniquely identifies the table.
public java.lang.String getTableId()
Unique identifier for the table for which the backup was created.
Constraints:
Pattern:
[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
Unique identifier for the table for which the backup was created.
public void setTableId(java.lang.String tableId)
Unique identifier for the table for which the backup was created.
Constraints:
Pattern:
[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
tableId
- Unique identifier for the table for which the backup was created.
public TableDescription withTableId(java.lang.String tableId)
Unique identifier for the table for which the backup was created.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Pattern:
[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
tableId
- Unique identifier for the table for which the backup was created.
public java.util.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.
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.
public void setLocalSecondaryIndexes(java.util.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.
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.
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.
Returns a reference to this object so that method calls can be chained together.
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.
public TableDescription withLocalSecondaryIndexes(java.util.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.
Returns a reference to this object so that method calls can be chained together.
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.
public java.util.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.
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.
public void setGlobalSecondaryIndexes(java.util.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.
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.
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.
Returns a reference to this object so that method calls can be chained together.
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.
public TableDescription withGlobalSecondaryIndexes(java.util.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.
Returns a reference to this object so that method calls can be chained together.
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.
public StreamSpecification getStreamSpecification()
The current DynamoDB Streams configuration for the table.
The current DynamoDB Streams configuration for the table.
public void setStreamSpecification(StreamSpecification streamSpecification)
The current DynamoDB Streams configuration for the table.
streamSpecification
- The current DynamoDB Streams configuration for the table.
public TableDescription withStreamSpecification(StreamSpecification streamSpecification)
The current DynamoDB Streams configuration for the table.
Returns a reference to this object so that method calls can be chained together.
streamSpecification
- The current DynamoDB Streams configuration for the table.
public java.lang.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
.
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
.
public void setLatestStreamLabel(java.lang.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
.
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
.
public TableDescription withLatestStreamLabel(java.lang.String latestStreamLabel)
A timestamp, in ISO 8601 format, for this stream.
Note that LatestStreamLabel
is not a unique identifier for
the stream, because it is possible that a stream from another table might
have the same timestamp. However, the combination of the following three
elements is guaranteed to be unique:
the AWS customer ID.
the table name.
the StreamLabel
.
Returns a reference to this object so that method calls can be chained together.
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
.
public java.lang.String getLatestStreamArn()
The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
Constraints:
Length: 37 - 1024
The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
public void setLatestStreamArn(java.lang.String latestStreamArn)
The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
Constraints:
Length: 37 - 1024
latestStreamArn
- The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
public TableDescription withLatestStreamArn(java.lang.String latestStreamArn)
The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 37 - 1024
latestStreamArn
- The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
public RestoreSummary getRestoreSummary()
Contains details for the restore.
Contains details for the restore.
public void setRestoreSummary(RestoreSummary restoreSummary)
Contains details for the restore.
restoreSummary
- Contains details for the restore.
public TableDescription withRestoreSummary(RestoreSummary restoreSummary)
Contains details for the restore.
Returns a reference to this object so that method calls can be chained together.
restoreSummary
- Contains details for the restore.
public SSEDescription getSSEDescription()
The description of the server-side encryption status on the specified table.
The description of the server-side encryption status on the specified table.
public void setSSEDescription(SSEDescription sSEDescription)
The description of the server-side encryption status on the specified table.
sSEDescription
- The description of the server-side encryption status on the specified table.
public TableDescription withSSEDescription(SSEDescription sSEDescription)
The description of the server-side encryption status on the specified table.
Returns a reference to this object so that method calls can be chained together.
sSEDescription
- The description of the server-side encryption status on the specified table.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2018 Amazon Web Services, Inc. All Rights Reserved.