Class AwsDynamoDbTableDetails

java.lang.Object
software.amazon.awssdk.services.securityhub.model.AwsDynamoDbTableDetails
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AwsDynamoDbTableDetails.Builder,AwsDynamoDbTableDetails>
@Generated("software.amazon.awssdk:codegen") public final class AwsDynamoDbTableDetails extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AwsDynamoDbTableDetails.Builder,AwsDynamoDbTableDetails>

Provides details about a DynamoDB table.

See Also:

  • 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 the 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.

    • attributeDefinitions

      public final List<AwsDynamoDbTableAttributeDefinition> 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

      public final AwsDynamoDbTableBillingModeSummary 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

      public final String 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 the 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.

    • globalSecondaryIndexes

      public final List<AwsDynamoDbTableGlobalSecondaryIndex> 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

      public final String globalTableVersion()

      The version of global tables being used.

      Returns:
      The version of global tables being used.

    • itemCount

      public final Integer 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 the 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.

    • keySchema

      public final List<AwsDynamoDbTableKeySchema> 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

      public final String latestStreamArn()

      The ARN of the latest stream for the table.

      Returns:
      The ARN of the latest stream for the table.

    • latestStreamLabel

      public final String 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 the 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.

    • localSecondaryIndexes

      public final List<AwsDynamoDbTableLocalSecondaryIndex> 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

      public final AwsDynamoDbTableProvisionedThroughput 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 the 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.

    • replicas

      public final List<AwsDynamoDbTableReplica> 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

      public final AwsDynamoDbTableRestoreSummary restoreSummary()

      Information about the restore for the table.

      Returns:
      Information about the restore for the table.

    • sseDescription

      public final AwsDynamoDbTableSseDescription sseDescription()

      Information about the server-side encryption for the table.

      Returns:
      Information about the server-side encryption for the table.

    • streamSpecification

      public final AwsDynamoDbTableStreamSpecification streamSpecification()

      The current DynamoDB Streams configuration for the table.

      Returns:
      The current DynamoDB Streams configuration for the table.

    • tableId

      public final String tableId()

      The identifier of the table.

      Returns:
      The identifier of the table.

    • tableName

      public final String tableName()

      The name of the table.

      Returns:
      The name of the table.

    • tableSizeBytes

      public final Long tableSizeBytes()

      The total size of the table in bytes.

      Returns:
      The total size of the table in bytes.

    • tableStatus

      public final String 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

      public final Boolean 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

      public AwsDynamoDbTableDetails.Builder 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 interface ToCopyableBuilder<AwsDynamoDbTableDetails.Builder,AwsDynamoDbTableDetails>
      Returns:
      a builder for type T

    • builder

      public static AwsDynamoDbTableDetails.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AwsDynamoDbTableDetails.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.