@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.
Modifier and Type | Class and Description |
---|---|
static interface |
ReplicaSettingsDescription.Builder |
Modifier and Type | Method and Description |
---|---|
static ReplicaSettingsDescription.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasReplicaGlobalSecondaryIndexSettings()
For responses, this returns true if the service returned a value for the ReplicaGlobalSecondaryIndexSettings
property.
|
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()
Auto scaling 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()
Auto scaling 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:
|
TableClassSummary |
replicaTableClassSummary()
Returns the value of the ReplicaTableClassSummary property for this object.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends ReplicaSettingsDescription.Builder> |
serializableBuilderClass() |
ReplicaSettingsDescription.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final String regionName()
The Region name of the replica.
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()
.
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.
ReplicaStatus
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()
.
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.
ReplicaStatus
public final BillingModeSummary replicaBillingModeSummary()
The read/write capacity mode of the replica.
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.
ThrottlingException
. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.public final AutoScalingSettingsDescription replicaProvisionedReadCapacityAutoScalingSettings()
Auto scaling settings for a global table replica's read capacity units.
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.
ThrottlingException
. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.public final AutoScalingSettingsDescription replicaProvisionedWriteCapacityAutoScalingSettings()
Auto scaling settings for a global table replica's write capacity units.
public final boolean hasReplicaGlobalSecondaryIndexSettings()
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.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.
public final TableClassSummary replicaTableClassSummary()
public ReplicaSettingsDescription.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<ReplicaSettingsDescription.Builder,ReplicaSettingsDescription>
public static ReplicaSettingsDescription.Builder builder()
public static Class<? extends ReplicaSettingsDescription.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
Copyright © 2023. All rights reserved.