@Generated(value="software.amazon.awssdk:codegen") public final class TableDescription extends Object implements SdkPojo, Serializable, ToCopyableBuilder<TableDescription.Builder,TableDescription>
Represents the properties of a table.
Modifier and Type | Class and Description |
---|---|
static interface |
TableDescription.Builder |
Modifier and Type | Method and Description |
---|---|
ArchivalSummary |
archivalSummary()
Contains information about the table archive.
|
List<AttributeDefinition> |
attributeDefinitions()
An array of
AttributeDefinition objects. |
BillingModeSummary |
billingModeSummary()
Contains the details for the read/write capacity mode.
|
static TableDescription.Builder |
builder() |
Instant |
creationDateTime()
The date and time when the table was created, in UNIX epoch time
format.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
List<GlobalSecondaryIndexDescription> |
globalSecondaryIndexes()
The global secondary indexes, if any, on the table.
|
String |
globalTableVersion()
Represents the version of global tables in
use, if the table is replicated across Amazon Web Services Regions.
|
boolean |
hasAttributeDefinitions()
For responses, this returns true if the service returned a value for the AttributeDefinitions property.
|
boolean |
hasGlobalSecondaryIndexes()
For responses, this returns true if the service returned a value for the GlobalSecondaryIndexes property.
|
int |
hashCode() |
boolean |
hasKeySchema()
For responses, this returns true if the service returned a value for the KeySchema property.
|
boolean |
hasLocalSecondaryIndexes()
For responses, this returns true if the service returned a value for the LocalSecondaryIndexes property.
|
boolean |
hasReplicas()
For responses, this returns true if the service returned a value for the Replicas property.
|
Long |
itemCount()
The number of items in the specified table.
|
List<KeySchemaElement> |
keySchema()
The primary key structure for the table.
|
String |
latestStreamArn()
The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
|
String |
latestStreamLabel()
A timestamp, in ISO 8601 format, for this stream.
|
List<LocalSecondaryIndexDescription> |
localSecondaryIndexes()
Represents one or more local secondary indexes on the table.
|
ProvisionedThroughputDescription |
provisionedThroughput()
The provisioned throughput settings for the table, consisting of read and write capacity units, along with data
about increases and decreases.
|
List<ReplicaDescription> |
replicas()
Represents replicas of the table.
|
RestoreSummary |
restoreSummary()
Contains details for the restore.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends TableDescription.Builder> |
serializableBuilderClass() |
SSEDescription |
sseDescription()
The description of the server-side encryption status on the specified table.
|
StreamSpecification |
streamSpecification()
The current DynamoDB Streams configuration for the table.
|
String |
tableArn()
The Amazon Resource Name (ARN) that uniquely identifies the table.
|
TableClassSummary |
tableClassSummary()
Contains details of the table class.
|
String |
tableId()
Unique identifier for the table for which the backup was created.
|
String |
tableName()
The name of the table.
|
Long |
tableSizeBytes()
The total size of the specified table, in bytes.
|
TableStatus |
tableStatus()
The current state of the table:
|
String |
tableStatusAsString()
The current state of the table:
|
TableDescription.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final boolean hasAttributeDefinitions()
isEmpty()
method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasAttributeDefinitions()
method.
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 final String tableName()
The name of the table.
public final boolean hasKeySchema()
isEmpty()
method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasKeySchema()
method.
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 final 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 KMS key used to encrypt the table in inaccessible. Table
operations may fail due to failure to use the KMS key. DynamoDB will initiate the table archival process when a
table's 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.
If the service returns an enum value that is not available in the current SDK version, tableStatus
will
return TableStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
tableStatusAsString()
.
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 KMS key used to encrypt the table in inaccessible.
Table operations may fail due to failure to use the KMS key. DynamoDB will initiate the table archival
process when a table's 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 final String tableStatusAsString()
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 KMS key used to encrypt the table in inaccessible. Table
operations may fail due to failure to use the KMS key. DynamoDB will initiate the table archival process when a
table's 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.
If the service returns an enum value that is not available in the current SDK version, tableStatus
will
return TableStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
tableStatusAsString()
.
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 KMS key used to encrypt the table in inaccessible.
Table operations may fail due to failure to use the KMS key. DynamoDB will initiate the table archival
process when a table's 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 final Instant creationDateTime()
The date and time when the table was created, in UNIX epoch time format.
public final ProvisionedThroughputDescription provisionedThroughput()
The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
public final 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.
public final 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.
public final String tableArn()
The Amazon Resource Name (ARN) that uniquely identifies the table.
public final String tableId()
Unique identifier for the table for which the backup was created.
public final BillingModeSummary billingModeSummary()
Contains the details for the read/write capacity mode.
public final boolean hasLocalSecondaryIndexes()
isEmpty()
method on the
property). This is useful because the SDK will never return a null collection or map, but you may need to
differentiate between the service returning nothing (or null) and the service returning an empty collection or
map. For requests, this returns true if a value for the property was specified in the request builder, and false
if a value was not specified.public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasLocalSecondaryIndexes()
method.
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 final boolean hasGlobalSecondaryIndexes()
isEmpty()
method on the
property). This is useful because the SDK will never return a null collection or map, but you may need to
differentiate between the service returning nothing (or null) and the service returning an empty collection or
map. For requests, this returns true if a value for the property was specified in the request builder, and false
if a value was not specified.public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasGlobalSecondaryIndexes()
method.
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 final StreamSpecification streamSpecification()
The current DynamoDB Streams configuration for the table.
public final 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:
Amazon Web Services 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:
Amazon Web Services customer ID
Table name
StreamLabel
public final String latestStreamArn()
The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
public final String globalTableVersion()
Represents the version of global tables in use, if the table is replicated across Amazon Web Services Regions.
public final boolean hasReplicas()
isEmpty()
method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final List<ReplicaDescription> replicas()
Represents replicas of the table.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasReplicas()
method.
public final RestoreSummary restoreSummary()
Contains details for the restore.
public final SSEDescription sseDescription()
The description of the server-side encryption status on the specified table.
public final ArchivalSummary archivalSummary()
Contains information about the table archive.
public final TableClassSummary tableClassSummary()
Contains details of the table class.
public TableDescription.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<TableDescription.Builder,TableDescription>
public static TableDescription.Builder builder()
public static Class<? extends TableDescription.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
Copyright © 2022. All rights reserved.