Class AwsDynamoDbTableDetails
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AwsDynamoDbTableDetails.Builder,
AwsDynamoDbTableDetails>
Provides details about a DynamoDB table.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionA list of attribute definitions for the table.Information about the billing for read/write capacity on the table.builder()
final String
Indicates when the table was created.final Boolean
Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) List of global secondary indexes for the table.final String
The version of global tables being used.final boolean
For responses, this returns true if the service returned a value for the AttributeDefinitions property.final boolean
For responses, this returns true if the service returned a value for the GlobalSecondaryIndexes property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the KeySchema property.final boolean
For responses, this returns true if the service returned a value for the LocalSecondaryIndexes property.final boolean
For responses, this returns true if the service returned a value for the Replicas property.final Integer
The number of items in the table.final List
<AwsDynamoDbTableKeySchema> The primary key structure for the table.final String
The ARN of the latest stream for the table.final String
The label of the latest stream.The list of local secondary indexes for the table.Information about the provisioned throughput for the table.final List
<AwsDynamoDbTableReplica> replicas()
The list of replicas of this table.Information about the restore for the table.static Class
<? extends AwsDynamoDbTableDetails.Builder> Information about the server-side encryption for the table.The current DynamoDB Streams configuration for the table.final String
tableId()
The identifier of the table.final String
The name of the table.final Long
The total size of the table in bytes.final String
The current status of the table.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hasAttributeDefinitions
public final boolean hasAttributeDefinitions()For responses, this returns true if the service returned a value for the AttributeDefinitions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
attributeDefinitions
A list of attribute definitions for 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
hasAttributeDefinitions()
method.- Returns:
- A list of attribute definitions for the table.
-
billingModeSummary
Information about the billing for read/write capacity on the table.
- Returns:
- Information about the billing for read/write capacity on the table.
-
creationDateTime
Indicates when the table was created.
This field accepts only the specified formats. Timestamps can end with
Z
or("+" / "-") time-hour [":" time-minute]
. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:-
YYYY-MM-DDTHH:MM:SSZ
(for example,2019-01-31T23:00:00Z
) -
YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ
(for example,2019-01-31T23:00:00.123456789Z
) -
YYYY-MM-DDTHH:MM:SS+HH:MM
(for example,2024-01-04T15:25:10+17:59
) -
YYYY-MM-DDTHH:MM:SS-HHMM
(for example,2024-01-04T15:25:10-1759
) -
YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM
(for example,2024-01-04T15:25:10.123456789+17:59
)
- Returns:
- Indicates when the table was created.
This field accepts only the specified formats. Timestamps can end with
Z
or("+" / "-") time-hour [":" time-minute]
. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:-
YYYY-MM-DDTHH:MM:SSZ
(for example,2019-01-31T23:00:00Z
) -
YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ
(for example,2019-01-31T23:00:00.123456789Z
) -
YYYY-MM-DDTHH:MM:SS+HH:MM
(for example,2024-01-04T15:25:10+17:59
) -
YYYY-MM-DDTHH:MM:SS-HHMM
(for example,2024-01-04T15:25:10-1759
) -
YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM
(for example,2024-01-04T15:25:10.123456789+17:59
)
-
-
-
hasGlobalSecondaryIndexes
public final boolean hasGlobalSecondaryIndexes()For responses, this returns true if the service returned a value for the GlobalSecondaryIndexes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
globalSecondaryIndexes
List of global secondary indexes for 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
hasGlobalSecondaryIndexes()
method.- Returns:
- List of global secondary indexes for the table.
-
globalTableVersion
The version of global tables being used.
- Returns:
- The version of global tables being used.
-
itemCount
The number of items in the table.
- Returns:
- The number of items in the table.
-
hasKeySchema
public final boolean hasKeySchema()For responses, this returns true if the service returned a value for the KeySchema property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
keySchema
The primary key structure for 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
hasKeySchema()
method.- Returns:
- The primary key structure for the table.
-
latestStreamArn
The ARN of the latest stream for the table.
- Returns:
- The ARN of the latest stream for the table.
-
latestStreamLabel
The label of the latest stream. The label is not a unique identifier.
- Returns:
- The label of the latest stream. The label is not a unique identifier.
-
hasLocalSecondaryIndexes
public final boolean hasLocalSecondaryIndexes()For responses, this returns true if the service returned a value for the LocalSecondaryIndexes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
localSecondaryIndexes
The list of local secondary indexes for 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
hasLocalSecondaryIndexes()
method.- Returns:
- The list of local secondary indexes for the table.
-
provisionedThroughput
Information about the provisioned throughput for the table.
- Returns:
- Information about the provisioned throughput for the table.
-
hasReplicas
public final boolean hasReplicas()For responses, this returns true if the service returned a value for the Replicas property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
replicas
The list of replicas of this 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.- Returns:
- The list of replicas of this table.
-
restoreSummary
Information about the restore for the table.
- Returns:
- Information about the restore for the table.
-
sseDescription
Information about the server-side encryption for the table.
- Returns:
- Information about the server-side encryption for the table.
-
streamSpecification
The current DynamoDB Streams configuration for the table.
- Returns:
- The current DynamoDB Streams configuration for the table.
-
tableId
The identifier of the table.
- Returns:
- The identifier of the table.
-
tableName
The name of the table.
- Returns:
- The name of the table.
-
tableSizeBytes
The total size of the table in bytes.
- Returns:
- The total size of the table in bytes.
-
tableStatus
The current status of the table. Valid values are as follows:
-
ACTIVE
-
ARCHIVED
-
ARCHIVING
-
CREATING
-
DELETING
-
INACCESSIBLE_ENCRYPTION_CREDENTIALS
-
UPDATING
- Returns:
- The current status of the table. Valid values are as follows:
-
ACTIVE
-
ARCHIVED
-
ARCHIVING
-
CREATING
-
DELETING
-
INACCESSIBLE_ENCRYPTION_CREDENTIALS
-
UPDATING
-
-
-
deletionProtectionEnabled
Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.
- Returns:
- Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<AwsDynamoDbTableDetails.Builder,
AwsDynamoDbTableDetails> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-