@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class TableDescription extends Object implements Serializable, Cloneable, StructuredPojo
Represents the properties of a table.
Constructor and Description |
---|
TableDescription() |
Modifier and Type | Method and Description |
---|---|
TableDescription |
clone() |
boolean |
equals(Object obj) |
ArchivalSummary |
getArchivalSummary()
Contains information about the table archive.
|
List<AttributeDefinition> |
getAttributeDefinitions()
An array of
AttributeDefinition objects. |
BillingModeSummary |
getBillingModeSummary()
Contains the details for the read/write capacity mode.
|
Date |
getCreationDateTime()
The date and time when the table was created, in UNIX epoch time
format.
|
List<GlobalSecondaryIndexDescription> |
getGlobalSecondaryIndexes()
The global secondary indexes, if any, on the table.
|
String |
getGlobalTableVersion()
Represents the version of global tables in
use, if the table is replicated across AWS Regions.
|
Long |
getItemCount()
The number of items in the specified table.
|
List<KeySchemaElement> |
getKeySchema()
The primary key structure for the table.
|
String |
getLatestStreamArn()
The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
|
String |
getLatestStreamLabel()
A timestamp, in ISO 8601 format, for this stream.
|
List<LocalSecondaryIndexDescription> |
getLocalSecondaryIndexes()
Represents one or more local secondary indexes on the table.
|
ProvisionedThroughputDescription |
getProvisionedThroughput()
The provisioned throughput settings for the table, consisting of read and write capacity units, along with data
about increases and decreases.
|
List<ReplicaDescription> |
getReplicas()
Represents replicas of the table.
|
RestoreSummary |
getRestoreSummary()
Contains details for the restore.
|
SSEDescription |
getSSEDescription()
The description of the server-side encryption status on the specified table.
|
StreamSpecification |
getStreamSpecification()
The current DynamoDB Streams configuration for the table.
|
String |
getTableArn()
The Amazon Resource Name (ARN) that uniquely identifies the table.
|
String |
getTableId()
Unique identifier for the table for which the backup was created.
|
String |
getTableName()
The name of the table.
|
Long |
getTableSizeBytes()
The total size of the specified table, in bytes.
|
String |
getTableStatus()
The current state of the table:
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller) |
void |
setArchivalSummary(ArchivalSummary archivalSummary)
Contains information about the table archive.
|
void |
setAttributeDefinitions(Collection<AttributeDefinition> attributeDefinitions)
An array of
AttributeDefinition objects. |
void |
setBillingModeSummary(BillingModeSummary billingModeSummary)
Contains the details for the read/write capacity mode.
|
void |
setCreationDateTime(Date creationDateTime)
The date and time when the table was created, in UNIX epoch time
format.
|
void |
setGlobalSecondaryIndexes(Collection<GlobalSecondaryIndexDescription> globalSecondaryIndexes)
The global secondary indexes, if any, on the table.
|
void |
setGlobalTableVersion(String globalTableVersion)
Represents the version of global tables in
use, if the table is replicated across AWS Regions.
|
void |
setItemCount(Long itemCount)
The number of items in the specified table.
|
void |
setKeySchema(Collection<KeySchemaElement> keySchema)
The primary key structure for the table.
|
void |
setLatestStreamArn(String latestStreamArn)
The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
|
void |
setLatestStreamLabel(String latestStreamLabel)
A timestamp, in ISO 8601 format, for this stream.
|
void |
setLocalSecondaryIndexes(Collection<LocalSecondaryIndexDescription> localSecondaryIndexes)
Represents one or more local secondary indexes on the table.
|
void |
setProvisionedThroughput(ProvisionedThroughputDescription provisionedThroughput)
The provisioned throughput settings for the table, consisting of read and write capacity units, along with data
about increases and decreases.
|
void |
setReplicas(Collection<ReplicaDescription> replicas)
Represents replicas of the table.
|
void |
setRestoreSummary(RestoreSummary restoreSummary)
Contains details for the restore.
|
void |
setSSEDescription(SSEDescription sSEDescription)
The description of the server-side encryption status on the specified table.
|
void |
setStreamSpecification(StreamSpecification streamSpecification)
The current DynamoDB Streams configuration for the table.
|
void |
setTableArn(String tableArn)
The Amazon Resource Name (ARN) that uniquely identifies the table.
|
void |
setTableId(String tableId)
Unique identifier for the table for which the backup was created.
|
void |
setTableName(String tableName)
The name of the table.
|
void |
setTableSizeBytes(Long tableSizeBytes)
The total size of the specified table, in bytes.
|
void |
setTableStatus(String tableStatus)
The current state of the table:
|
void |
setTableStatus(TableStatus tableStatus)
The current state of the table:
|
String |
toString()
Returns a string representation of this object.
|
TableDescription |
withArchivalSummary(ArchivalSummary archivalSummary)
Contains information about the table archive.
|
TableDescription |
withAttributeDefinitions(AttributeDefinition... attributeDefinitions)
An array of
AttributeDefinition objects. |
TableDescription |
withAttributeDefinitions(Collection<AttributeDefinition> attributeDefinitions)
An array of
AttributeDefinition objects. |
TableDescription |
withBillingModeSummary(BillingModeSummary billingModeSummary)
Contains the details for the read/write capacity mode.
|
TableDescription |
withCreationDateTime(Date creationDateTime)
The date and time when the table was created, in UNIX epoch time
format.
|
TableDescription |
withGlobalSecondaryIndexes(Collection<GlobalSecondaryIndexDescription> globalSecondaryIndexes)
The global secondary indexes, if any, on the table.
|
TableDescription |
withGlobalSecondaryIndexes(GlobalSecondaryIndexDescription... globalSecondaryIndexes)
The global secondary indexes, if any, on the table.
|
TableDescription |
withGlobalTableVersion(String globalTableVersion)
Represents the version of global tables in
use, if the table is replicated across AWS Regions.
|
TableDescription |
withItemCount(Long itemCount)
The number of items in the specified table.
|
TableDescription |
withKeySchema(Collection<KeySchemaElement> keySchema)
The primary key structure for the table.
|
TableDescription |
withKeySchema(KeySchemaElement... keySchema)
The primary key structure for the table.
|
TableDescription |
withLatestStreamArn(String latestStreamArn)
The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
|
TableDescription |
withLatestStreamLabel(String latestStreamLabel)
A timestamp, in ISO 8601 format, for this stream.
|
TableDescription |
withLocalSecondaryIndexes(Collection<LocalSecondaryIndexDescription> localSecondaryIndexes)
Represents one or more local secondary indexes on the table.
|
TableDescription |
withLocalSecondaryIndexes(LocalSecondaryIndexDescription... localSecondaryIndexes)
Represents one or more local secondary indexes on the table.
|
TableDescription |
withProvisionedThroughput(ProvisionedThroughputDescription provisionedThroughput)
The provisioned throughput settings for the table, consisting of read and write capacity units, along with data
about increases and decreases.
|
TableDescription |
withReplicas(Collection<ReplicaDescription> replicas)
Represents replicas of the table.
|
TableDescription |
withReplicas(ReplicaDescription... replicas)
Represents replicas of the table.
|
TableDescription |
withRestoreSummary(RestoreSummary restoreSummary)
Contains details for the restore.
|
TableDescription |
withSSEDescription(SSEDescription sSEDescription)
The description of the server-side encryption status on the specified table.
|
TableDescription |
withStreamSpecification(StreamSpecification streamSpecification)
The current DynamoDB Streams configuration for the table.
|
TableDescription |
withTableArn(String tableArn)
The Amazon Resource Name (ARN) that uniquely identifies the table.
|
TableDescription |
withTableId(String tableId)
Unique identifier for the table for which the backup was created.
|
TableDescription |
withTableName(String tableName)
The name of the table.
|
TableDescription |
withTableSizeBytes(Long tableSizeBytes)
The total size of the specified table, in bytes.
|
TableDescription |
withTableStatus(String tableStatus)
The current state of the table:
|
TableDescription |
withTableStatus(TableStatus tableStatus)
The current state of the table:
|
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.
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(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.
NOTE: This method appends the values to the existing list (if any). Use
setAttributeDefinitions(java.util.Collection)
or withAttributeDefinitions(java.util.Collection)
if you want to override the existing values.
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(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 void setTableName(String tableName)
The name of the table.
tableName
- The name of the table.public String getTableName()
The name of the table.
public TableDescription withTableName(String tableName)
The name of the table.
tableName
- The name of the table.public List<KeySchemaElement> getKeySchema()
The primary key structure for the table. Each KeySchemaElement
consists of:
AttributeName
- The name of the attribute.
KeyType
- The role of the attribute:
HASH
- partition key
RANGE
- sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
KeySchemaElement
consists of:
AttributeName
- The name of the attribute.
KeyType
- The role of the attribute:
HASH
- partition key
RANGE
- sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
public void setKeySchema(Collection<KeySchemaElement> keySchema)
The primary key structure for the table. Each KeySchemaElement
consists of:
AttributeName
- The name of the attribute.
KeyType
- The role of the attribute:
HASH
- partition key
RANGE
- sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
keySchema
- The primary key structure for the table. Each KeySchemaElement
consists of:
AttributeName
- The name of the attribute.
KeyType
- The role of the attribute:
HASH
- partition key
RANGE
- sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
public TableDescription withKeySchema(KeySchemaElement... keySchema)
The primary key structure for the table. Each KeySchemaElement
consists of:
AttributeName
- The name of the attribute.
KeyType
- The role of the attribute:
HASH
- partition key
RANGE
- sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
NOTE: This method appends the values to the existing list (if any). Use
setKeySchema(java.util.Collection)
or withKeySchema(java.util.Collection)
if you want to
override the existing values.
keySchema
- The primary key structure for the table. Each KeySchemaElement
consists of:
AttributeName
- The name of the attribute.
KeyType
- The role of the attribute:
HASH
- partition key
RANGE
- sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
public TableDescription withKeySchema(Collection<KeySchemaElement> keySchema)
The primary key structure for the table. Each KeySchemaElement
consists of:
AttributeName
- The name of the attribute.
KeyType
- The role of the attribute:
HASH
- partition key
RANGE
- sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
keySchema
- The primary key structure for the table. Each KeySchemaElement
consists of:
AttributeName
- The name of the attribute.
KeyType
- The role of the attribute:
HASH
- partition key
RANGE
- sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
public void setTableStatus(String tableStatus)
The current state of the table:
CREATING
- The table is being created.
UPDATING
- The table is being updated.
DELETING
- The table is being deleted.
ACTIVE
- The table is ready for use.
INACCESSIBLE_ENCRYPTION_CREDENTIALS
- The AWS KMS key used to encrypt the table in inaccessible.
Table operations may fail due to failure to use the AWS KMS key. DynamoDB will initiate the table archival
process when a table's AWS KMS key remains inaccessible for more than seven days.
ARCHIVING
- The table is being archived. Operations are not allowed until archival is complete.
ARCHIVED
- The table has been archived. See the ArchivalReason for more information.
tableStatus
- The current state of the table:
CREATING
- The table is being created.
UPDATING
- The table is being updated.
DELETING
- The table is being deleted.
ACTIVE
- The table is ready for use.
INACCESSIBLE_ENCRYPTION_CREDENTIALS
- The AWS KMS key used to encrypt the table in
inaccessible. Table operations may fail due to failure to use the AWS KMS key. DynamoDB will initiate the
table archival process when a table's AWS KMS key remains inaccessible for more than seven days.
ARCHIVING
- The table is being archived. Operations are not allowed until archival is
complete.
ARCHIVED
- The table has been archived. See the ArchivalReason for more information.
TableStatus
public String getTableStatus()
The current state of the table:
CREATING
- The table is being created.
UPDATING
- The table is being updated.
DELETING
- The table is being deleted.
ACTIVE
- The table is ready for use.
INACCESSIBLE_ENCRYPTION_CREDENTIALS
- The AWS KMS key used to encrypt the table in inaccessible.
Table operations may fail due to failure to use the AWS KMS key. DynamoDB will initiate the table archival
process when a table's AWS KMS key remains inaccessible for more than seven days.
ARCHIVING
- The table is being archived. Operations are not allowed until archival is complete.
ARCHIVED
- The table has been archived. See the ArchivalReason for more information.
CREATING
- The table is being created.
UPDATING
- The table is being updated.
DELETING
- The table is being deleted.
ACTIVE
- The table is ready for use.
INACCESSIBLE_ENCRYPTION_CREDENTIALS
- The AWS KMS key used to encrypt the table in
inaccessible. Table operations may fail due to failure to use the AWS KMS key. DynamoDB will initiate the
table archival process when a table's AWS KMS key remains inaccessible for more than seven days.
ARCHIVING
- The table is being archived. Operations are not allowed until archival is
complete.
ARCHIVED
- The table has been archived. See the ArchivalReason for more information.
TableStatus
public TableDescription withTableStatus(String tableStatus)
The current state of the table:
CREATING
- The table is being created.
UPDATING
- The table is being updated.
DELETING
- The table is being deleted.
ACTIVE
- The table is ready for use.
INACCESSIBLE_ENCRYPTION_CREDENTIALS
- The AWS KMS key used to encrypt the table in inaccessible.
Table operations may fail due to failure to use the AWS KMS key. DynamoDB will initiate the table archival
process when a table's AWS KMS key remains inaccessible for more than seven days.
ARCHIVING
- The table is being archived. Operations are not allowed until archival is complete.
ARCHIVED
- The table has been archived. See the ArchivalReason for more information.
tableStatus
- The current state of the table:
CREATING
- The table is being created.
UPDATING
- The table is being updated.
DELETING
- The table is being deleted.
ACTIVE
- The table is ready for use.
INACCESSIBLE_ENCRYPTION_CREDENTIALS
- The AWS KMS key used to encrypt the table in
inaccessible. Table operations may fail due to failure to use the AWS KMS key. DynamoDB will initiate the
table archival process when a table's AWS KMS key remains inaccessible for more than seven days.
ARCHIVING
- The table is being archived. Operations are not allowed until archival is
complete.
ARCHIVED
- The table has been archived. See the ArchivalReason for more information.
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.
INACCESSIBLE_ENCRYPTION_CREDENTIALS
- The AWS KMS key used to encrypt the table in inaccessible.
Table operations may fail due to failure to use the AWS KMS key. DynamoDB will initiate the table archival
process when a table's AWS KMS key remains inaccessible for more than seven days.
ARCHIVING
- The table is being archived. Operations are not allowed until archival is complete.
ARCHIVED
- The table has been archived. See the ArchivalReason for more information.
tableStatus
- The current state of the table:
CREATING
- The table is being created.
UPDATING
- The table is being updated.
DELETING
- The table is being deleted.
ACTIVE
- The table is ready for use.
INACCESSIBLE_ENCRYPTION_CREDENTIALS
- The AWS KMS key used to encrypt the table in
inaccessible. Table operations may fail due to failure to use the AWS KMS key. DynamoDB will initiate the
table archival process when a table's AWS KMS key remains inaccessible for more than seven days.
ARCHIVING
- The table is being archived. Operations are not allowed until archival is
complete.
ARCHIVED
- The table has been archived. See the ArchivalReason for more information.
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.
INACCESSIBLE_ENCRYPTION_CREDENTIALS
- The AWS KMS key used to encrypt the table in inaccessible.
Table operations may fail due to failure to use the AWS KMS key. DynamoDB will initiate the table archival
process when a table's AWS KMS key remains inaccessible for more than seven days.
ARCHIVING
- The table is being archived. Operations are not allowed until archival is complete.
ARCHIVED
- The table has been archived. See the ArchivalReason for more information.
tableStatus
- The current state of the table:
CREATING
- The table is being created.
UPDATING
- The table is being updated.
DELETING
- The table is being deleted.
ACTIVE
- The table is ready for use.
INACCESSIBLE_ENCRYPTION_CREDENTIALS
- The AWS KMS key used to encrypt the table in
inaccessible. Table operations may fail due to failure to use the AWS KMS key. DynamoDB will initiate the
table archival process when a table's AWS KMS key remains inaccessible for more than seven days.
ARCHIVING
- The table is being archived. Operations are not allowed until archival is
complete.
ARCHIVED
- The table has been archived. See the ArchivalReason for more information.
TableStatus
public void setCreationDateTime(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 Date getCreationDateTime()
The date and time when the table was created, in UNIX epoch time format.
public TableDescription withCreationDateTime(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 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 ProvisionedThroughputDescription getProvisionedThroughput()
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.
provisionedThroughput
- The provisioned throughput settings for the table, consisting of read and write capacity units, along with
data about increases and decreases.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.
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 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.
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.
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 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.
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 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.
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.
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 void setTableArn(String tableArn)
The Amazon Resource Name (ARN) that uniquely identifies the table.
tableArn
- The Amazon Resource Name (ARN) that uniquely identifies the table.public String getTableArn()
The Amazon Resource Name (ARN) that uniquely identifies the table.
public TableDescription withTableArn(String tableArn)
The Amazon Resource Name (ARN) that uniquely identifies the table.
tableArn
- The Amazon Resource Name (ARN) that uniquely identifies the table.public void setTableId(String tableId)
Unique identifier for the table for which the backup was created.
tableId
- Unique identifier for the table for which the backup was created.public String getTableId()
Unique identifier for the table for which the backup was created.
public TableDescription withTableId(String tableId)
Unique identifier for the table for which the backup was created.
tableId
- Unique identifier for the table for which the backup was created.public void setBillingModeSummary(BillingModeSummary billingModeSummary)
Contains the details for the read/write capacity mode.
billingModeSummary
- Contains the details for the read/write capacity mode.public BillingModeSummary getBillingModeSummary()
Contains the details for the read/write capacity mode.
public TableDescription withBillingModeSummary(BillingModeSummary billingModeSummary)
Contains the details for the read/write capacity mode.
billingModeSummary
- Contains the details for the read/write capacity mode.public List<LocalSecondaryIndexDescription> getLocalSecondaryIndexes()
Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:
IndexName
- The name of the local secondary index.
KeySchema
- Specifies the complete index key schema. The attribute names in the key schema must be
between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.
Projection
- Specifies attributes that are copied (projected) from the table into the index. These
are in addition to the primary key attributes and index key attributes, which are automatically projected. Each
attribute specification is composed of:
ProjectionType
- One of the following:
KEYS_ONLY
- Only the index and primary keys are projected into the index.
INCLUDE
- Only the specified table attributes are projected into the index. The list of projected
attributes is in NonKeyAttributes
.
ALL
- All of the table attributes are projected into the index.
NonKeyAttributes
- A list of one or more non-key attribute names that are projected into the
secondary index. The total count of attributes provided in NonKeyAttributes
, summed across all of
the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this
counts as two distinct attributes when determining the total.
IndexSizeBytes
- Represents the total size of the index, in bytes. DynamoDB updates this value
approximately every six hours. Recent changes might not be reflected in this value.
ItemCount
- Represents the number of items in the index. DynamoDB updates this value approximately
every six hours. Recent changes might not be reflected in this value.
If the table is in the DELETING
state, no information about indexes will be returned.
IndexName
- The name of the local secondary index.
KeySchema
- Specifies the complete index key schema. The attribute names in the key schema
must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key
as the table.
Projection
- Specifies attributes that are copied (projected) from the table into the index.
These are in addition to the primary key attributes and index key attributes, which are automatically
projected. Each attribute specification is composed of:
ProjectionType
- One of the following:
KEYS_ONLY
- Only the index and primary keys are projected into the index.
INCLUDE
- Only the specified table attributes are projected into the index. The list of
projected attributes is in NonKeyAttributes
.
ALL
- All of the table attributes are projected into the index.
NonKeyAttributes
- A list of one or more non-key attribute names that are projected into the
secondary index. The total count of attributes provided in NonKeyAttributes
, summed across
all of the secondary indexes, must not exceed 20. If you project the same attribute into two different
indexes, this counts as two distinct attributes when determining the total.
IndexSizeBytes
- Represents the total size of the index, in bytes. DynamoDB updates this
value approximately every six hours. Recent changes might not be reflected in this value.
ItemCount
- Represents the number of items in the index. DynamoDB updates this value
approximately every six hours. Recent changes might not be reflected in this value.
If the table is in the DELETING
state, no information about indexes will be returned.
public void setLocalSecondaryIndexes(Collection<LocalSecondaryIndexDescription> localSecondaryIndexes)
Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:
IndexName
- The name of the local secondary index.
KeySchema
- Specifies the complete index key schema. The attribute names in the key schema must be
between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.
Projection
- Specifies attributes that are copied (projected) from the table into the index. These
are in addition to the primary key attributes and index key attributes, which are automatically projected. Each
attribute specification is composed of:
ProjectionType
- One of the following:
KEYS_ONLY
- Only the index and primary keys are projected into the index.
INCLUDE
- Only the specified table attributes are projected into the index. The list of projected
attributes is in NonKeyAttributes
.
ALL
- All of the table attributes are projected into the index.
NonKeyAttributes
- A list of one or more non-key attribute names that are projected into the
secondary index. The total count of attributes provided in NonKeyAttributes
, summed across all of
the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this
counts as two distinct attributes when determining the total.
IndexSizeBytes
- Represents the total size of the index, in bytes. DynamoDB updates this value
approximately every six hours. Recent changes might not be reflected in this value.
ItemCount
- Represents the number of items in the index. DynamoDB updates this value approximately
every six hours. Recent changes might not be reflected in this value.
If the table is in the DELETING
state, no information about indexes will be returned.
localSecondaryIndexes
- Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key
value. Tables with one or more local secondary indexes are subject to an item collection size limit, where
the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:
IndexName
- The name of the local secondary index.
KeySchema
- Specifies the complete index key schema. The attribute names in the key schema
must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as
the table.
Projection
- Specifies attributes that are copied (projected) from the table into the index.
These are in addition to the primary key attributes and index key attributes, which are automatically
projected. Each attribute specification is composed of:
ProjectionType
- One of the following:
KEYS_ONLY
- Only the index and primary keys are projected into the index.
INCLUDE
- Only the specified table attributes are projected into the index. The list of
projected attributes is in NonKeyAttributes
.
ALL
- All of the table attributes are projected into the index.
NonKeyAttributes
- A list of one or more non-key attribute names that are projected into the
secondary index. The total count of attributes provided in NonKeyAttributes
, summed across
all of the secondary indexes, must not exceed 20. If you project the same attribute into two different
indexes, this counts as two distinct attributes when determining the total.
IndexSizeBytes
- Represents the total size of the index, in bytes. DynamoDB updates this
value approximately every six hours. Recent changes might not be reflected in this value.
ItemCount
- Represents the number of items in the index. DynamoDB updates this value
approximately every six hours. Recent changes might not be reflected in this value.
If the table is in the DELETING
state, no information about indexes will be returned.
public TableDescription withLocalSecondaryIndexes(LocalSecondaryIndexDescription... localSecondaryIndexes)
Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:
IndexName
- The name of the local secondary index.
KeySchema
- Specifies the complete index key schema. The attribute names in the key schema must be
between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.
Projection
- Specifies attributes that are copied (projected) from the table into the index. These
are in addition to the primary key attributes and index key attributes, which are automatically projected. Each
attribute specification is composed of:
ProjectionType
- One of the following:
KEYS_ONLY
- Only the index and primary keys are projected into the index.
INCLUDE
- Only the specified table attributes are projected into the index. The list of projected
attributes is in NonKeyAttributes
.
ALL
- All of the table attributes are projected into the index.
NonKeyAttributes
- A list of one or more non-key attribute names that are projected into the
secondary index. The total count of attributes provided in NonKeyAttributes
, summed across all of
the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this
counts as two distinct attributes when determining the total.
IndexSizeBytes
- Represents the total size of the index, in bytes. DynamoDB updates this value
approximately every six hours. Recent changes might not be reflected in this value.
ItemCount
- Represents the number of items in the index. DynamoDB updates this value approximately
every six hours. Recent changes might not be reflected in this value.
If the table is in the DELETING
state, no information about indexes will be returned.
NOTE: This method appends the values to the existing list (if any). Use
setLocalSecondaryIndexes(java.util.Collection)
or
withLocalSecondaryIndexes(java.util.Collection)
if you want to override the existing values.
localSecondaryIndexes
- Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key
value. Tables with one or more local secondary indexes are subject to an item collection size limit, where
the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:
IndexName
- The name of the local secondary index.
KeySchema
- Specifies the complete index key schema. The attribute names in the key schema
must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as
the table.
Projection
- Specifies attributes that are copied (projected) from the table into the index.
These are in addition to the primary key attributes and index key attributes, which are automatically
projected. Each attribute specification is composed of:
ProjectionType
- One of the following:
KEYS_ONLY
- Only the index and primary keys are projected into the index.
INCLUDE
- Only the specified table attributes are projected into the index. The list of
projected attributes is in NonKeyAttributes
.
ALL
- All of the table attributes are projected into the index.
NonKeyAttributes
- A list of one or more non-key attribute names that are projected into the
secondary index. The total count of attributes provided in NonKeyAttributes
, summed across
all of the secondary indexes, must not exceed 20. If you project the same attribute into two different
indexes, this counts as two distinct attributes when determining the total.
IndexSizeBytes
- Represents the total size of the index, in bytes. DynamoDB updates this
value approximately every six hours. Recent changes might not be reflected in this value.
ItemCount
- Represents the number of items in the index. DynamoDB updates this value
approximately every six hours. Recent changes might not be reflected in this value.
If the table is in the DELETING
state, no information about indexes will be returned.
public TableDescription withLocalSecondaryIndexes(Collection<LocalSecondaryIndexDescription> localSecondaryIndexes)
Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:
IndexName
- The name of the local secondary index.
KeySchema
- Specifies the complete index key schema. The attribute names in the key schema must be
between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.
Projection
- Specifies attributes that are copied (projected) from the table into the index. These
are in addition to the primary key attributes and index key attributes, which are automatically projected. Each
attribute specification is composed of:
ProjectionType
- One of the following:
KEYS_ONLY
- Only the index and primary keys are projected into the index.
INCLUDE
- Only the specified table attributes are projected into the index. The list of projected
attributes is in NonKeyAttributes
.
ALL
- All of the table attributes are projected into the index.
NonKeyAttributes
- A list of one or more non-key attribute names that are projected into the
secondary index. The total count of attributes provided in NonKeyAttributes
, summed across all of
the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this
counts as two distinct attributes when determining the total.
IndexSizeBytes
- Represents the total size of the index, in bytes. DynamoDB updates this value
approximately every six hours. Recent changes might not be reflected in this value.
ItemCount
- Represents the number of items in the index. DynamoDB updates this value approximately
every six hours. Recent changes might not be reflected in this value.
If the table is in the DELETING
state, no information about indexes will be returned.
localSecondaryIndexes
- Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key
value. Tables with one or more local secondary indexes are subject to an item collection size limit, where
the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:
IndexName
- The name of the local secondary index.
KeySchema
- Specifies the complete index key schema. The attribute names in the key schema
must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as
the table.
Projection
- Specifies attributes that are copied (projected) from the table into the index.
These are in addition to the primary key attributes and index key attributes, which are automatically
projected. Each attribute specification is composed of:
ProjectionType
- One of the following:
KEYS_ONLY
- Only the index and primary keys are projected into the index.
INCLUDE
- Only the specified table attributes are projected into the index. The list of
projected attributes is in NonKeyAttributes
.
ALL
- All of the table attributes are projected into the index.
NonKeyAttributes
- A list of one or more non-key attribute names that are projected into the
secondary index. The total count of attributes provided in NonKeyAttributes
, summed across
all of the secondary indexes, must not exceed 20. If you project the same attribute into two different
indexes, this counts as two distinct attributes when determining the total.
IndexSizeBytes
- Represents the total size of the index, in bytes. DynamoDB updates this
value approximately every six hours. Recent changes might not be reflected in this value.
ItemCount
- Represents the number of items in the index. DynamoDB updates this value
approximately every six hours. Recent changes might not be reflected in this value.
If the table is in the DELETING
state, no information about indexes will be returned.
public List<GlobalSecondaryIndexDescription> getGlobalSecondaryIndexes()
The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of:
Backfilling
- If true, then the index is currently in the backfilling phase. Backfilling occurs only
when a new global secondary index is added to the table. It is the process by which DynamoDB populates the new
index with data from the table. (This attribute does not appear for indexes that were created during a
CreateTable
operation.)
You can delete an index that is being created during the Backfilling
phase when
IndexStatus
is set to CREATING and Backfilling
is true. You can't delete the index that
is being created when IndexStatus
is set to CREATING and Backfilling
is false. (This
attribute does not appear for indexes that were created during a CreateTable
operation.)
IndexName
- The name of the global secondary index.
IndexSizeBytes
- The total size of the global secondary index, in bytes. DynamoDB updates this value
approximately every six hours. Recent changes might not be reflected in this value.
IndexStatus
- The current status of the global secondary index:
CREATING
- The index is being created.
UPDATING
- The index is being updated.
DELETING
- The index is being deleted.
ACTIVE
- The index is ready for use.
ItemCount
- The number of items in the global secondary index. DynamoDB updates this value
approximately every six hours. Recent changes might not be reflected in this value.
KeySchema
- Specifies the complete index key schema. The attribute names in the key schema must be
between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.
Projection
- Specifies attributes that are copied (projected) from the table into the index. These
are in addition to the primary key attributes and index key attributes, which are automatically projected. Each
attribute specification is composed of:
ProjectionType
- One of the following:
KEYS_ONLY
- Only the index and primary keys are projected into the index.
INCLUDE
- In addition to the attributes described in KEYS_ONLY
, the secondary index
will include other non-key attributes that you specify.
ALL
- All of the table attributes are projected into the index.
NonKeyAttributes
- A list of one or more non-key attribute names that are projected into the
secondary index. The total count of attributes provided in NonKeyAttributes
, summed across all of
the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this
counts as two distinct attributes when determining the total.
ProvisionedThroughput
- The provisioned throughput settings for the global secondary index,
consisting of read and write capacity units, along with data about increases and decreases.
If the table is in the DELETING
state, no information about indexes will be returned.
Backfilling
- If true, then the index is currently in the backfilling phase. Backfilling
occurs only when a new global secondary index is added to the table. It is the process by which DynamoDB
populates the new index with data from the table. (This attribute does not appear for indexes that were
created during a CreateTable
operation.)
You can delete an index that is being created during the Backfilling
phase when
IndexStatus
is set to CREATING and Backfilling
is true. You can't delete the
index that is being created when IndexStatus
is set to CREATING and Backfilling
is false. (This attribute does not appear for indexes that were created during a CreateTable
operation.)
IndexName
- The name of the global secondary index.
IndexSizeBytes
- The total size of the global secondary index, in bytes. DynamoDB updates
this value approximately every six hours. Recent changes might not be reflected in this value.
IndexStatus
- The current status of the global secondary index:
CREATING
- The index is being created.
UPDATING
- The index is being updated.
DELETING
- The index is being deleted.
ACTIVE
- The index is ready for use.
ItemCount
- The number of items in the global secondary index. DynamoDB updates this value
approximately every six hours. Recent changes might not be reflected in this value.
KeySchema
- Specifies the complete index key schema. The attribute names in the key schema
must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key
as the table.
Projection
- Specifies attributes that are copied (projected) from the table into the index.
These are in addition to the primary key attributes and index key attributes, which are automatically
projected. Each attribute specification is composed of:
ProjectionType
- One of the following:
KEYS_ONLY
- Only the index and primary keys are projected into the index.
INCLUDE
- In addition to the attributes described in KEYS_ONLY
, the secondary
index will include other non-key attributes that you specify.
ALL
- All of the table attributes are projected into the index.
NonKeyAttributes
- A list of one or more non-key attribute names that are projected into the
secondary index. The total count of attributes provided in NonKeyAttributes
, summed across
all of the secondary indexes, must not exceed 20. If you project the same attribute into two different
indexes, this counts as two distinct attributes when determining the total.
ProvisionedThroughput
- The provisioned throughput settings for the global secondary index,
consisting of read and write capacity units, along with data about increases and decreases.
If the table is in the DELETING
state, no information about indexes will be returned.
public void setGlobalSecondaryIndexes(Collection<GlobalSecondaryIndexDescription> globalSecondaryIndexes)
The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of:
Backfilling
- If true, then the index is currently in the backfilling phase. Backfilling occurs only
when a new global secondary index is added to the table. It is the process by which DynamoDB populates the new
index with data from the table. (This attribute does not appear for indexes that were created during a
CreateTable
operation.)
You can delete an index that is being created during the Backfilling
phase when
IndexStatus
is set to CREATING and Backfilling
is true. You can't delete the index that
is being created when IndexStatus
is set to CREATING and Backfilling
is false. (This
attribute does not appear for indexes that were created during a CreateTable
operation.)
IndexName
- The name of the global secondary index.
IndexSizeBytes
- The total size of the global secondary index, in bytes. DynamoDB updates this value
approximately every six hours. Recent changes might not be reflected in this value.
IndexStatus
- The current status of the global secondary index:
CREATING
- The index is being created.
UPDATING
- The index is being updated.
DELETING
- The index is being deleted.
ACTIVE
- The index is ready for use.
ItemCount
- The number of items in the global secondary index. DynamoDB updates this value
approximately every six hours. Recent changes might not be reflected in this value.
KeySchema
- Specifies the complete index key schema. The attribute names in the key schema must be
between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.
Projection
- Specifies attributes that are copied (projected) from the table into the index. These
are in addition to the primary key attributes and index key attributes, which are automatically projected. Each
attribute specification is composed of:
ProjectionType
- One of the following:
KEYS_ONLY
- Only the index and primary keys are projected into the index.
INCLUDE
- In addition to the attributes described in KEYS_ONLY
, the secondary index
will include other non-key attributes that you specify.
ALL
- All of the table attributes are projected into the index.
NonKeyAttributes
- A list of one or more non-key attribute names that are projected into the
secondary index. The total count of attributes provided in NonKeyAttributes
, summed across all of
the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this
counts as two distinct attributes when determining the total.
ProvisionedThroughput
- The provisioned throughput settings for the global secondary index,
consisting of read and write capacity units, along with data about increases and decreases.
If the table is in the DELETING
state, no information about indexes will be returned.
globalSecondaryIndexes
- The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value.
Each element is composed of:
Backfilling
- If true, then the index is currently in the backfilling phase. Backfilling
occurs only when a new global secondary index is added to the table. It is the process by which DynamoDB
populates the new index with data from the table. (This attribute does not appear for indexes that were
created during a CreateTable
operation.)
You can delete an index that is being created during the Backfilling
phase when
IndexStatus
is set to CREATING and Backfilling
is true. You can't delete the
index that is being created when IndexStatus
is set to CREATING and Backfilling
is false. (This attribute does not appear for indexes that were created during a CreateTable
operation.)
IndexName
- The name of the global secondary index.
IndexSizeBytes
- The total size of the global secondary index, in bytes. DynamoDB updates
this value approximately every six hours. Recent changes might not be reflected in this value.
IndexStatus
- The current status of the global secondary index:
CREATING
- The index is being created.
UPDATING
- The index is being updated.
DELETING
- The index is being deleted.
ACTIVE
- The index is ready for use.
ItemCount
- The number of items in the global secondary index. DynamoDB updates this value
approximately every six hours. Recent changes might not be reflected in this value.
KeySchema
- Specifies the complete index key schema. The attribute names in the key schema
must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as
the table.
Projection
- Specifies attributes that are copied (projected) from the table into the index.
These are in addition to the primary key attributes and index key attributes, which are automatically
projected. Each attribute specification is composed of:
ProjectionType
- One of the following:
KEYS_ONLY
- Only the index and primary keys are projected into the index.
INCLUDE
- In addition to the attributes described in KEYS_ONLY
, the secondary
index will include other non-key attributes that you specify.
ALL
- All of the table attributes are projected into the index.
NonKeyAttributes
- A list of one or more non-key attribute names that are projected into the
secondary index. The total count of attributes provided in NonKeyAttributes
, summed across
all of the secondary indexes, must not exceed 20. If you project the same attribute into two different
indexes, this counts as two distinct attributes when determining the total.
ProvisionedThroughput
- The provisioned throughput settings for the global secondary index,
consisting of read and write capacity units, along with data about increases and decreases.
If the table is in the DELETING
state, no information about indexes will be returned.
public TableDescription withGlobalSecondaryIndexes(GlobalSecondaryIndexDescription... globalSecondaryIndexes)
The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of:
Backfilling
- If true, then the index is currently in the backfilling phase. Backfilling occurs only
when a new global secondary index is added to the table. It is the process by which DynamoDB populates the new
index with data from the table. (This attribute does not appear for indexes that were created during a
CreateTable
operation.)
You can delete an index that is being created during the Backfilling
phase when
IndexStatus
is set to CREATING and Backfilling
is true. You can't delete the index that
is being created when IndexStatus
is set to CREATING and Backfilling
is false. (This
attribute does not appear for indexes that were created during a CreateTable
operation.)
IndexName
- The name of the global secondary index.
IndexSizeBytes
- The total size of the global secondary index, in bytes. DynamoDB updates this value
approximately every six hours. Recent changes might not be reflected in this value.
IndexStatus
- The current status of the global secondary index:
CREATING
- The index is being created.
UPDATING
- The index is being updated.
DELETING
- The index is being deleted.
ACTIVE
- The index is ready for use.
ItemCount
- The number of items in the global secondary index. DynamoDB updates this value
approximately every six hours. Recent changes might not be reflected in this value.
KeySchema
- Specifies the complete index key schema. The attribute names in the key schema must be
between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.
Projection
- Specifies attributes that are copied (projected) from the table into the index. These
are in addition to the primary key attributes and index key attributes, which are automatically projected. Each
attribute specification is composed of:
ProjectionType
- One of the following:
KEYS_ONLY
- Only the index and primary keys are projected into the index.
INCLUDE
- In addition to the attributes described in KEYS_ONLY
, the secondary index
will include other non-key attributes that you specify.
ALL
- All of the table attributes are projected into the index.
NonKeyAttributes
- A list of one or more non-key attribute names that are projected into the
secondary index. The total count of attributes provided in NonKeyAttributes
, summed across all of
the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this
counts as two distinct attributes when determining the total.
ProvisionedThroughput
- The provisioned throughput settings for the global secondary index,
consisting of read and write capacity units, along with data about increases and decreases.
If the table is in the DELETING
state, no information about indexes will be returned.
NOTE: This method appends the values to the existing list (if any). Use
setGlobalSecondaryIndexes(java.util.Collection)
or
withGlobalSecondaryIndexes(java.util.Collection)
if you want to override the existing values.
globalSecondaryIndexes
- The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value.
Each element is composed of:
Backfilling
- If true, then the index is currently in the backfilling phase. Backfilling
occurs only when a new global secondary index is added to the table. It is the process by which DynamoDB
populates the new index with data from the table. (This attribute does not appear for indexes that were
created during a CreateTable
operation.)
You can delete an index that is being created during the Backfilling
phase when
IndexStatus
is set to CREATING and Backfilling
is true. You can't delete the
index that is being created when IndexStatus
is set to CREATING and Backfilling
is false. (This attribute does not appear for indexes that were created during a CreateTable
operation.)
IndexName
- The name of the global secondary index.
IndexSizeBytes
- The total size of the global secondary index, in bytes. DynamoDB updates
this value approximately every six hours. Recent changes might not be reflected in this value.
IndexStatus
- The current status of the global secondary index:
CREATING
- The index is being created.
UPDATING
- The index is being updated.
DELETING
- The index is being deleted.
ACTIVE
- The index is ready for use.
ItemCount
- The number of items in the global secondary index. DynamoDB updates this value
approximately every six hours. Recent changes might not be reflected in this value.
KeySchema
- Specifies the complete index key schema. The attribute names in the key schema
must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as
the table.
Projection
- Specifies attributes that are copied (projected) from the table into the index.
These are in addition to the primary key attributes and index key attributes, which are automatically
projected. Each attribute specification is composed of:
ProjectionType
- One of the following:
KEYS_ONLY
- Only the index and primary keys are projected into the index.
INCLUDE
- In addition to the attributes described in KEYS_ONLY
, the secondary
index will include other non-key attributes that you specify.
ALL
- All of the table attributes are projected into the index.
NonKeyAttributes
- A list of one or more non-key attribute names that are projected into the
secondary index. The total count of attributes provided in NonKeyAttributes
, summed across
all of the secondary indexes, must not exceed 20. If you project the same attribute into two different
indexes, this counts as two distinct attributes when determining the total.
ProvisionedThroughput
- The provisioned throughput settings for the global secondary index,
consisting of read and write capacity units, along with data about increases and decreases.
If the table is in the DELETING
state, no information about indexes will be returned.
public TableDescription withGlobalSecondaryIndexes(Collection<GlobalSecondaryIndexDescription> globalSecondaryIndexes)
The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of:
Backfilling
- If true, then the index is currently in the backfilling phase. Backfilling occurs only
when a new global secondary index is added to the table. It is the process by which DynamoDB populates the new
index with data from the table. (This attribute does not appear for indexes that were created during a
CreateTable
operation.)
You can delete an index that is being created during the Backfilling
phase when
IndexStatus
is set to CREATING and Backfilling
is true. You can't delete the index that
is being created when IndexStatus
is set to CREATING and Backfilling
is false. (This
attribute does not appear for indexes that were created during a CreateTable
operation.)
IndexName
- The name of the global secondary index.
IndexSizeBytes
- The total size of the global secondary index, in bytes. DynamoDB updates this value
approximately every six hours. Recent changes might not be reflected in this value.
IndexStatus
- The current status of the global secondary index:
CREATING
- The index is being created.
UPDATING
- The index is being updated.
DELETING
- The index is being deleted.
ACTIVE
- The index is ready for use.
ItemCount
- The number of items in the global secondary index. DynamoDB updates this value
approximately every six hours. Recent changes might not be reflected in this value.
KeySchema
- Specifies the complete index key schema. The attribute names in the key schema must be
between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.
Projection
- Specifies attributes that are copied (projected) from the table into the index. These
are in addition to the primary key attributes and index key attributes, which are automatically projected. Each
attribute specification is composed of:
ProjectionType
- One of the following:
KEYS_ONLY
- Only the index and primary keys are projected into the index.
INCLUDE
- In addition to the attributes described in KEYS_ONLY
, the secondary index
will include other non-key attributes that you specify.
ALL
- All of the table attributes are projected into the index.
NonKeyAttributes
- A list of one or more non-key attribute names that are projected into the
secondary index. The total count of attributes provided in NonKeyAttributes
, summed across all of
the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this
counts as two distinct attributes when determining the total.
ProvisionedThroughput
- The provisioned throughput settings for the global secondary index,
consisting of read and write capacity units, along with data about increases and decreases.
If the table is in the DELETING
state, no information about indexes will be returned.
globalSecondaryIndexes
- The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value.
Each element is composed of:
Backfilling
- If true, then the index is currently in the backfilling phase. Backfilling
occurs only when a new global secondary index is added to the table. It is the process by which DynamoDB
populates the new index with data from the table. (This attribute does not appear for indexes that were
created during a CreateTable
operation.)
You can delete an index that is being created during the Backfilling
phase when
IndexStatus
is set to CREATING and Backfilling
is true. You can't delete the
index that is being created when IndexStatus
is set to CREATING and Backfilling
is false. (This attribute does not appear for indexes that were created during a CreateTable
operation.)
IndexName
- The name of the global secondary index.
IndexSizeBytes
- The total size of the global secondary index, in bytes. DynamoDB updates
this value approximately every six hours. Recent changes might not be reflected in this value.
IndexStatus
- The current status of the global secondary index:
CREATING
- The index is being created.
UPDATING
- The index is being updated.
DELETING
- The index is being deleted.
ACTIVE
- The index is ready for use.
ItemCount
- The number of items in the global secondary index. DynamoDB updates this value
approximately every six hours. Recent changes might not be reflected in this value.
KeySchema
- Specifies the complete index key schema. The attribute names in the key schema
must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as
the table.
Projection
- Specifies attributes that are copied (projected) from the table into the index.
These are in addition to the primary key attributes and index key attributes, which are automatically
projected. Each attribute specification is composed of:
ProjectionType
- One of the following:
KEYS_ONLY
- Only the index and primary keys are projected into the index.
INCLUDE
- In addition to the attributes described in KEYS_ONLY
, the secondary
index will include other non-key attributes that you specify.
ALL
- All of the table attributes are projected into the index.
NonKeyAttributes
- A list of one or more non-key attribute names that are projected into the
secondary index. The total count of attributes provided in NonKeyAttributes
, summed across
all of the secondary indexes, must not exceed 20. If you project the same attribute into two different
indexes, this counts as two distinct attributes when determining the total.
ProvisionedThroughput
- The provisioned throughput settings for the global secondary index,
consisting of read and write capacity units, along with data about increases and decreases.
If the table is in the DELETING
state, no information about indexes will be returned.
public void setStreamSpecification(StreamSpecification streamSpecification)
The current DynamoDB Streams configuration for the table.
streamSpecification
- The current DynamoDB Streams configuration for the table.public StreamSpecification getStreamSpecification()
The current DynamoDB Streams configuration for the table.
public TableDescription withStreamSpecification(StreamSpecification streamSpecification)
The current DynamoDB Streams configuration for the table.
streamSpecification
- The current DynamoDB Streams configuration for the table.public void setLatestStreamLabel(String latestStreamLabel)
A timestamp, in ISO 8601 format, for this stream.
Note that LatestStreamLabel
is not a unique identifier for the stream, because it is possible that a
stream from another table might have the same timestamp. However, the combination of the following three elements
is guaranteed to be unique:
AWS customer ID
Table name
StreamLabel
latestStreamLabel
- A timestamp, in ISO 8601 format, for this stream.
Note that LatestStreamLabel
is not a unique identifier for the stream, because it is possible
that a stream from another table might have the same timestamp. However, the combination of the following
three elements is guaranteed to be unique:
AWS customer ID
Table name
StreamLabel
public String getLatestStreamLabel()
A timestamp, in ISO 8601 format, for this stream.
Note that LatestStreamLabel
is not a unique identifier for the stream, because it is possible that a
stream from another table might have the same timestamp. However, the combination of the following three elements
is guaranteed to be unique:
AWS customer ID
Table name
StreamLabel
Note that LatestStreamLabel
is not a unique identifier for the stream, because it is
possible that a stream from another table might have the same timestamp. However, the combination of the
following three elements is guaranteed to be unique:
AWS customer ID
Table name
StreamLabel
public TableDescription withLatestStreamLabel(String latestStreamLabel)
A timestamp, in ISO 8601 format, for this stream.
Note that LatestStreamLabel
is not a unique identifier for the stream, because it is possible that a
stream from another table might have the same timestamp. However, the combination of the following three elements
is guaranteed to be unique:
AWS customer ID
Table name
StreamLabel
latestStreamLabel
- A timestamp, in ISO 8601 format, for this stream.
Note that LatestStreamLabel
is not a unique identifier for the stream, because it is possible
that a stream from another table might have the same timestamp. However, the combination of the following
three elements is guaranteed to be unique:
AWS customer ID
Table name
StreamLabel
public void setLatestStreamArn(String latestStreamArn)
The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
latestStreamArn
- The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.public String getLatestStreamArn()
The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
public TableDescription withLatestStreamArn(String latestStreamArn)
The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
latestStreamArn
- The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.public void setGlobalTableVersion(String globalTableVersion)
Represents the version of global tables in use, if the table is replicated across AWS Regions.
globalTableVersion
- Represents the version of global
tables in use, if the table is replicated across AWS Regions.public String getGlobalTableVersion()
Represents the version of global tables in use, if the table is replicated across AWS Regions.
public TableDescription withGlobalTableVersion(String globalTableVersion)
Represents the version of global tables in use, if the table is replicated across AWS Regions.
globalTableVersion
- Represents the version of global
tables in use, if the table is replicated across AWS Regions.public List<ReplicaDescription> getReplicas()
Represents replicas of the table.
public void setReplicas(Collection<ReplicaDescription> replicas)
Represents replicas of the table.
replicas
- Represents replicas of the table.public TableDescription withReplicas(ReplicaDescription... replicas)
Represents replicas of the table.
NOTE: This method appends the values to the existing list (if any). Use
setReplicas(java.util.Collection)
or withReplicas(java.util.Collection)
if you want to override
the existing values.
replicas
- Represents replicas of the table.public TableDescription withReplicas(Collection<ReplicaDescription> replicas)
Represents replicas of the table.
replicas
- Represents replicas of the table.public void setRestoreSummary(RestoreSummary restoreSummary)
Contains details for the restore.
restoreSummary
- Contains details for the restore.public RestoreSummary getRestoreSummary()
Contains details for the restore.
public TableDescription withRestoreSummary(RestoreSummary restoreSummary)
Contains details for the restore.
restoreSummary
- Contains details for the restore.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 SSEDescription getSSEDescription()
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.
sSEDescription
- The description of the server-side encryption status on the specified table.public void setArchivalSummary(ArchivalSummary archivalSummary)
Contains information about the table archive.
archivalSummary
- Contains information about the table archive.public ArchivalSummary getArchivalSummary()
Contains information about the table archive.
public TableDescription withArchivalSummary(ArchivalSummary archivalSummary)
Contains information about the table archive.
archivalSummary
- Contains information about the table archive.public String toString()
toString
in class Object
Object.toString()
public TableDescription clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
marshall
in interface StructuredPojo
Copyright © 2020. All rights reserved.