Package | Description |
---|---|
com.amazonaws.services.dynamodbv2.datamodeling | |
com.amazonaws.services.dynamodbv2.document | |
com.amazonaws.services.dynamodbv2.model |
Modifier and Type | Method and Description |
---|---|
TableDescription |
DynamoDBTableMapper.createTable(ProvisionedThroughput throughput)
Creates the table with the specified throughput; also populates the same
throughput for all global secondary indexes.
|
TableDescription |
DynamoDBTableMapper.deleteTable()
Deletes the table.
|
TableDescription |
DynamoDBTableMapper.describeTable()
Returns information about the table, including the current status of the
table, when it was created, the primary key schema, and any indexes on
the table.
|
Modifier and Type | Method and Description |
---|---|
TableDescription |
Index.deleteGSI()
Deletes this global secondary index (GSI) from the DynamoDB table.
|
TableDescription |
Table.describe()
Retrieves the table description from DynamoDB.
|
TableDescription |
Table.getDescription()
Returns the table description; or null if the table description has not
yet been described via
Table.describe() . |
TableDescription |
Index.updateGSI(ProvisionedThroughput provisionedThroughput)
Updates the provisioned throughput for this global secondary index (GSI).
|
TableDescription |
Table.updateTable(ProvisionedThroughput provisionedThroughput)
Updates the provisioned throughput for this table.
|
TableDescription |
Table.updateTable(UpdateTableSpec spec)
Updates the provisioned throughput for this table.
|
TableDescription |
Index.waitForActive()
A convenient blocking call that can be used, typically during index
creation, to wait for the index to become active by polling the table
every 5 seconds.
|
TableDescription |
Table.waitForActive()
A convenient blocking call that can be used, typically during table
creation, to wait for the table to become active.
|
TableDescription |
Index.waitForActiveOrDelete()
A convenient blocking call that can be used to wait on an index until it
has either become active or deleted (ie no longer exists) by polling the
table every 5 seconds.
|
TableDescription |
Table.waitForActiveOrDelete()
Deprecated.
If this method is called immediately after
AmazonDynamoDB.createTable(CreateTableRequest) or
AmazonDynamoDB.deleteTable(DeleteTableRequest) operation,
the result might be incorrect as all AmazonDynamoDB
operations are eventually consistent and might have a few seconds delay before the status is changed. |
TableDescription |
Table.waitForAllActiveOrDelete()
Deprecated.
If this method is called immediately after
AmazonDynamoDB.createTable(CreateTableRequest) or
AmazonDynamoDB.deleteTable(DeleteTableRequest) operation,
the result might be incorrect as all AmazonDynamoDB
operations are eventually consistent and might have a few seconds delay before the status is changed. |
TableDescription |
Index.waitForDelete()
A convenient blocking call that can be used, typically during index
deletion on an active table, to wait for the index to become deleted by
polling the table every 5 seconds.
|
Constructor and Description |
---|
Table(AmazonDynamoDB client,
String tableName,
TableDescription tableDescription) |
Modifier and Type | Method and Description |
---|---|
TableDescription |
TableDescription.clone() |
TableDescription |
DescribeTableResult.getTable()
The properties of the table.
|
TableDescription |
UpdateTableResult.getTableDescription()
Represents the properties of the table.
|
TableDescription |
DeleteTableResult.getTableDescription()
Represents the properties of a table.
|
TableDescription |
CreateTableResult.getTableDescription()
Represents the properties of the table.
|
TableDescription |
RestoreTableToPointInTimeResult.getTableDescription()
Represents the properties of a table.
|
TableDescription |
RestoreTableFromBackupResult.getTableDescription()
The description of the table created from an existing backup.
|
TableDescription |
TableDescription.withAttributeDefinitions(AttributeDefinition... attributeDefinitions)
An array of
AttributeDefinition objects. |
TableDescription |
TableDescription.withAttributeDefinitions(Collection<AttributeDefinition> attributeDefinitions)
An array of
AttributeDefinition objects. |
TableDescription |
TableDescription.withBillingModeSummary(BillingModeSummary billingModeSummary)
Contains the details for the read/write capacity mode.
|
TableDescription |
TableDescription.withCreationDateTime(Date creationDateTime)
The date and time when the table was created, in UNIX epoch time
format.
|
TableDescription |
TableDescription.withGlobalSecondaryIndexes(Collection<GlobalSecondaryIndexDescription> globalSecondaryIndexes)
The global secondary indexes, if any, on the table.
|
TableDescription |
TableDescription.withGlobalSecondaryIndexes(GlobalSecondaryIndexDescription... globalSecondaryIndexes)
The global secondary indexes, if any, on the table.
|
TableDescription |
TableDescription.withItemCount(Long itemCount)
The number of items in the specified table.
|
TableDescription |
TableDescription.withKeySchema(Collection<KeySchemaElement> keySchema)
The primary key structure for the table.
|
TableDescription |
TableDescription.withKeySchema(KeySchemaElement... keySchema)
The primary key structure for the table.
|
TableDescription |
TableDescription.withLatestStreamArn(String latestStreamArn)
The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
|
TableDescription |
TableDescription.withLatestStreamLabel(String latestStreamLabel)
A timestamp, in ISO 8601 format, for this stream.
|
TableDescription |
TableDescription.withLocalSecondaryIndexes(Collection<LocalSecondaryIndexDescription> localSecondaryIndexes)
Represents one or more local secondary indexes on the table.
|
TableDescription |
TableDescription.withLocalSecondaryIndexes(LocalSecondaryIndexDescription... localSecondaryIndexes)
Represents one or more local secondary indexes on the table.
|
TableDescription |
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 |
TableDescription.withRestoreSummary(RestoreSummary restoreSummary)
Contains details for the restore.
|
TableDescription |
TableDescription.withSSEDescription(SSEDescription sSEDescription)
The description of the server-side encryption status on the specified table.
|
TableDescription |
TableDescription.withStreamSpecification(StreamSpecification streamSpecification)
The current DynamoDB Streams configuration for the table.
|
TableDescription |
TableDescription.withTableArn(String tableArn)
The Amazon Resource Name (ARN) that uniquely identifies the table.
|
TableDescription |
TableDescription.withTableId(String tableId)
Unique identifier for the table for which the backup was created.
|
TableDescription |
TableDescription.withTableName(String tableName)
The name of the table.
|
TableDescription |
TableDescription.withTableSizeBytes(Long tableSizeBytes)
The total size of the specified table, in bytes.
|
TableDescription |
TableDescription.withTableStatus(String tableStatus)
The current state of the table:
|
TableDescription |
TableDescription.withTableStatus(TableStatus tableStatus)
The current state of the table:
|
Modifier and Type | Method and Description |
---|---|
void |
DescribeTableResult.setTable(TableDescription table)
The properties of the table.
|
void |
UpdateTableResult.setTableDescription(TableDescription tableDescription)
Represents the properties of the table.
|
void |
DeleteTableResult.setTableDescription(TableDescription tableDescription)
Represents the properties of a table.
|
void |
CreateTableResult.setTableDescription(TableDescription tableDescription)
Represents the properties of the table.
|
void |
RestoreTableToPointInTimeResult.setTableDescription(TableDescription tableDescription)
Represents the properties of a table.
|
void |
RestoreTableFromBackupResult.setTableDescription(TableDescription tableDescription)
The description of the table created from an existing backup.
|
DescribeTableResult |
DescribeTableResult.withTable(TableDescription table)
The properties of the table.
|
UpdateTableResult |
UpdateTableResult.withTableDescription(TableDescription tableDescription)
Represents the properties of the table.
|
DeleteTableResult |
DeleteTableResult.withTableDescription(TableDescription tableDescription)
Represents the properties of a table.
|
CreateTableResult |
CreateTableResult.withTableDescription(TableDescription tableDescription)
Represents the properties of the table.
|
RestoreTableToPointInTimeResult |
RestoreTableToPointInTimeResult.withTableDescription(TableDescription tableDescription)
Represents the properties of a table.
|
RestoreTableFromBackupResult |
RestoreTableFromBackupResult.withTableDescription(TableDescription tableDescription)
The description of the table created from an existing backup.
|
Copyright © 2019. All rights reserved.