Package software.amazon.awssdk.services.dynamodb.model

Class ReplicaSettingsDescription

    • Method Detail

      • regionName

        public final String regionName()

        The Region name of the replica.

        Returns:
        The Region name of the replica.

      • replicaStatus

        public final ReplicaStatus replicaStatus()

        The current state of the Region:

        • CREATING - The Region is being created.

        • UPDATING - The Region is being updated.

        • DELETING - The Region is being deleted.

        • ACTIVE - The Region is ready for use.

        If the service returns an enum value that is not available in the current SDK version, replicaStatus will return ReplicaStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from replicaStatusAsString().

        Returns:
        The current state of the Region:

        • CREATING - The Region is being created.

        • UPDATING - The Region is being updated.

        • DELETING - The Region is being deleted.

        • ACTIVE - The Region is ready for use.

        See Also:
        ReplicaStatus

      • replicaStatusAsString

        public final String replicaStatusAsString()

        The current state of the Region:

        • CREATING - The Region is being created.

        • UPDATING - The Region is being updated.

        • DELETING - The Region is being deleted.

        • ACTIVE - The Region is ready for use.

        If the service returns an enum value that is not available in the current SDK version, replicaStatus will return ReplicaStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from replicaStatusAsString().

        Returns:
        The current state of the Region:

        • CREATING - The Region is being created.

        • UPDATING - The Region is being updated.

        • DELETING - The Region is being deleted.

        • ACTIVE - The Region is ready for use.

        See Also:
        ReplicaStatus

      • replicaBillingModeSummary

        public final BillingModeSummary replicaBillingModeSummary()

        The read/write capacity mode of the replica.

        Returns:
        The read/write capacity mode of the replica.

      • replicaProvisionedReadCapacityUnits

        public final Long replicaProvisionedReadCapacityUnits()

        The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

        Returns:
        The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

      • replicaProvisionedReadCapacityAutoScalingSettings

        public final AutoScalingSettingsDescription replicaProvisionedReadCapacityAutoScalingSettings()

        Auto scaling settings for a global table replica's read capacity units.

        Returns:
        Auto scaling settings for a global table replica's read capacity units.

      • replicaProvisionedWriteCapacityUnits

        public final Long replicaProvisionedWriteCapacityUnits()

        The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

        Returns:
        The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

      • replicaProvisionedWriteCapacityAutoScalingSettings

        public final AutoScalingSettingsDescription replicaProvisionedWriteCapacityAutoScalingSettings()

        Auto scaling settings for a global table replica's write capacity units.

        Returns:
        Auto scaling settings for a global table replica's write capacity units.

      • hasReplicaGlobalSecondaryIndexSettings

        public final boolean hasReplicaGlobalSecondaryIndexSettings()
        For responses, this returns true if the service returned a value for the ReplicaGlobalSecondaryIndexSettings 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.

      • replicaGlobalSecondaryIndexSettings

        public final List<ReplicaGlobalSecondaryIndexSettingsDescription> replicaGlobalSecondaryIndexSettings()

        Replica global secondary index settings for the global 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 hasReplicaGlobalSecondaryIndexSettings() method.

        Returns:
        Replica global secondary index settings for the global table.

      • replicaTableClassSummary

        public final TableClassSummary replicaTableClassSummary()
        Returns the value of the ReplicaTableClassSummary property for this object.
        Returns:
        The value of the ReplicaTableClassSummary property for this object.

      • hashCode

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

      • equals

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

      • 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)