ReplicaDescription (AWS Java SDK :: Services :: Amazon DynamoDB 2.17.195 API)

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

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

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

Contains the details of the replica.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ReplicaDescription.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ReplicaDescription.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`List<ReplicaGlobalSecondaryIndexDescription>`	`globalSecondaryIndexes()` Replica-specific global secondary index settings.
`boolean`	`hasGlobalSecondaryIndexes()` For responses, this returns true if the service returned a value for the GlobalSecondaryIndexes property.
`int`	`hashCode()`
`String`	`kmsMasterKeyId()` The KMS key of the replica that will be used for KMS encryption.
`ProvisionedThroughputOverride`	`provisionedThroughputOverride()` Replica-specific provisioned throughput.
`String`	`regionName()` The name of the Region.
`Instant`	`replicaInaccessibleDateTime()` The time at which the replica was first detected as inaccessible.
`ReplicaStatus`	`replicaStatus()` The current state of the replica:
`String`	`replicaStatusAsString()` The current state of the replica:
`String`	`replicaStatusDescription()` Detailed information about the replica status.
`String`	`replicaStatusPercentProgress()` Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.
`TableClassSummary`	`replicaTableClassSummary()` Returns the value of the ReplicaTableClassSummary property for this object.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ReplicaDescription.Builder>`	`serializableBuilderClass()`
`ReplicaDescription.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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

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

- Method Detail
  - regionName
```
public final String regionName()
```
    The name of the Region.
    
    Returns:
    
    The name of the Region.
  - replicaStatus
```
public final ReplicaStatus replicaStatus()
```
    The current state of the replica:
    - CREATING - The replica is being created.
    - UPDATING - The replica is being updated.
    - DELETING - The replica is being deleted.
    - ACTIVE - The replica is ready for use.
    - REGION_DISABLED - The replica is inaccessible because the Amazon Web Services Region has been disabled.
      
      If the Amazon Web Services Region remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.
    - INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the table is inaccessible.
      
      If the KMS key remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.
    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 replica:
    
    CREATING - The replica is being created.
    
    UPDATING - The replica is being updated.
    
    DELETING - The replica is being deleted.
    
    ACTIVE - The replica is ready for use.
    
    REGION_DISABLED - The replica is inaccessible because the Amazon Web Services Region has been disabled.
    
    If the Amazon Web Services Region remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.
    
    INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the table is inaccessible.
    
    If the KMS key remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.
    See Also:
    
    ReplicaStatus
  - replicaStatusAsString
```
public final String replicaStatusAsString()
```
    The current state of the replica:
    - CREATING - The replica is being created.
    - UPDATING - The replica is being updated.
    - DELETING - The replica is being deleted.
    - ACTIVE - The replica is ready for use.
    - REGION_DISABLED - The replica is inaccessible because the Amazon Web Services Region has been disabled.
      
      If the Amazon Web Services Region remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.
    - INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the table is inaccessible.
      
      If the KMS key remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.
    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 replica:
    
    CREATING - The replica is being created.
    
    UPDATING - The replica is being updated.
    
    DELETING - The replica is being deleted.
    
    ACTIVE - The replica is ready for use.
    
    REGION_DISABLED - The replica is inaccessible because the Amazon Web Services Region has been disabled.
    
    If the Amazon Web Services Region remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.
    
    INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the table is inaccessible.
    
    If the KMS key remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.
    See Also:
    
    ReplicaStatus
  - replicaStatusDescription
```
public final String replicaStatusDescription()
```
    Detailed information about the replica status.
    
    Returns:
    
    Detailed information about the replica status.
  - replicaStatusPercentProgress
```
public final String replicaStatusPercentProgress()
```
    Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.
    
    Returns:
    
    Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.
  - kmsMasterKeyId
```
public final String kmsMasterKeyId()
```
    The KMS key of the replica that will be used for KMS encryption.
    
    Returns:
    
    The KMS key of the replica that will be used for KMS encryption.
  - provisionedThroughputOverride
```
public final ProvisionedThroughputOverride provisionedThroughputOverride()
```
    Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput settings.
    
    Returns:
    
    Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput settings.
  - hasGlobalSecondaryIndexes
```
public final boolean hasGlobalSecondaryIndexes()
```
    For responses, this returns true if the service returned a value for the GlobalSecondaryIndexes 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.
  - globalSecondaryIndexes
```
public final List<ReplicaGlobalSecondaryIndexDescription> globalSecondaryIndexes()
```
    Replica-specific global secondary index settings.
    
    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 hasGlobalSecondaryIndexes() method.
    
    Returns:
    
    Replica-specific global secondary index settings.
  - replicaInaccessibleDateTime
```
public final Instant replicaInaccessibleDateTime()
```
    The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility check the ReplicaStatus property.
    
    Returns:
    
    The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility check the ReplicaStatus property.
  - 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 ReplicaDescription.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ReplicaDescription.Builder,ReplicaDescription>
  - builder
```
public static ReplicaDescription.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ReplicaDescription.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class ReplicaDescription

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

replicaStatusDescription

replicaStatusPercentProgress

kmsMasterKeyId

provisionedThroughputOverride

hasGlobalSecondaryIndexes

globalSecondaryIndexes

replicaInaccessibleDateTime

replicaTableClassSummary

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields