ReplicaSettingsDescription (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.dynamodb.model.ReplicaSettingsDescription

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<ReplicaSettingsDescription.Builder,ReplicaSettingsDescription>

@Generated(value="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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ReplicaSettingsDescription.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ReplicaSettingsDescription.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ReplicaSettingsDescription.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`regionName()` The region name of the replica.
`BillingModeSummary`	`replicaBillingModeSummary()` The read/write capacity mode of the replica.
`List<ReplicaGlobalSecondaryIndexSettingsDescription>`	`replicaGlobalSecondaryIndexSettings()` Replica global secondary index settings for the global table.
`AutoScalingSettingsDescription`	`replicaProvisionedReadCapacityAutoScalingSettings()` Autoscaling settings for a global table replica's read capacity units.
`Long`	`replicaProvisionedReadCapacityUnits()` The maximum number of strongly consistent reads consumed per second before DynamoDB returns a `ThrottlingException`.
`AutoScalingSettingsDescription`	`replicaProvisionedWriteCapacityAutoScalingSettings()` AutoScaling settings for a global table replica's write capacity units.
`Long`	`replicaProvisionedWriteCapacityUnits()` The maximum number of writes consumed per second before DynamoDB returns a `ThrottlingException`.
`ReplicaStatus`	`replicaStatus()` The current state of the region:
`String`	`replicaStatusAsString()` The current state of the region:
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ReplicaSettingsDescription.Builder>`	`serializableBuilderClass()`
`ReplicaSettingsDescription.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - regionName
```
public String regionName()
```
    The region name of the replica.
    
    Returns:
    
    The region name of the replica.
  - replicaStatus
```
public 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 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 BillingModeSummary replicaBillingModeSummary()
```
    The read/write capacity mode of the replica.
    
    Returns:
    
    The read/write capacity mode of the replica.
  - replicaProvisionedReadCapacityUnits
```
public 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 AutoScalingSettingsDescription replicaProvisionedReadCapacityAutoScalingSettings()
```
    Autoscaling settings for a global table replica's read capacity units.
    
    Returns:
    
    Autoscaling settings for a global table replica's read capacity units.
  - replicaProvisionedWriteCapacityUnits
```
public 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 AutoScalingSettingsDescription replicaProvisionedWriteCapacityAutoScalingSettings()
```
    AutoScaling settings for a global table replica's write capacity units.
    
    Returns:
    
    AutoScaling settings for a global table replica's write capacity units.
  - replicaGlobalSecondaryIndexSettings
```
public 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.
    
    Returns:
    
    Replica global secondary index settings for the global table.
  - 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 int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public 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.

Class ReplicaSettingsDescription

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

regionName

replicaStatus

replicaStatusAsString

replicaBillingModeSummary

replicaProvisionedReadCapacityUnits

replicaProvisionedReadCapacityAutoScalingSettings

replicaProvisionedWriteCapacityUnits

replicaProvisionedWriteCapacityAutoScalingSettings

replicaGlobalSecondaryIndexSettings

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields