software.amazon.awssdk.services.dynamodb.model

Class ReplicaSettingsDescription

java.lang.Object

software.amazon.awssdk.services.dynamodb.model.ReplicaSettingsDescription

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<ReplicaSettingsDescription.Builder,ReplicaSettingsDescription>

@Generated(value="software.amazon.awssdk:codegen")
public final class ReplicaSettingsDescription
extends Object
implements StructuredPojo, ToCopyableBuilder<ReplicaSettingsDescription.Builder,ReplicaSettingsDescription>

Represents the properties of a replica.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ReplicaSettingsDescription.Builder

Method Summary

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()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
String	regionName() The region name of the replica.
List<ReplicaGlobalSecondaryIndexSettingsDescription>	replicaGlobalSecondaryIndexSettings() Replica global secondary index settings for the global table.
Long	replicaProvisionedReadCapacityUnits() The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.
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:
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

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.

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.

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)

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.