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

Class ReplicaSettingsDescription

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

Represents the properties of a replica.

See Also:

  • Method Details

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

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

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

    • toBuilder

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

    • builder

      public static ReplicaSettingsDescription.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ReplicaSettingsDescription.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.