Class GlobalTableDescription
- java.lang.Object
-
- software.amazon.awssdk.services.dynamodb.model.GlobalTableDescription
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<GlobalTableDescription.Builder,GlobalTableDescription>
@Generated("software.amazon.awssdk:codegen") public final class GlobalTableDescription extends Object implements SdkPojo, Serializable, ToCopyableBuilder<GlobalTableDescription.Builder,GlobalTableDescription>
Contains details about the global table.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
GlobalTableDescription.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static GlobalTableDescription.Builder
builder()
Instant
creationDateTime()
The creation time of the global table.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
String
globalTableArn()
The unique identifier of the global table.String
globalTableName()
The global table name.GlobalTableStatus
globalTableStatus()
The current state of the global table:String
globalTableStatusAsString()
The current state of the global table:int
hashCode()
boolean
hasReplicationGroup()
For responses, this returns true if the service returned a value for the ReplicationGroup property.List<ReplicaDescription>
replicationGroup()
The Regions where the global table has replicas.List<SdkField<?>>
sdkFields()
static Class<? extends GlobalTableDescription.Builder>
serializableBuilderClass()
GlobalTableDescription.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
-
hasReplicationGroup
public final boolean hasReplicationGroup()
For responses, this returns true if the service returned a value for the ReplicationGroup property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
replicationGroup
public final List<ReplicaDescription> replicationGroup()
The Regions where the global table has replicas.
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
hasReplicationGroup()
method.- Returns:
- The Regions where the global table has replicas.
-
globalTableArn
public final String globalTableArn()
The unique identifier of the global table.
- Returns:
- The unique identifier of the global table.
-
creationDateTime
public final Instant creationDateTime()
The creation time of the global table.
- Returns:
- The creation time of the global table.
-
globalTableStatus
public final GlobalTableStatus globalTableStatus()
The current state of the global table:
-
CREATING
- The global table is being created. -
UPDATING
- The global table is being updated. -
DELETING
- The global table is being deleted. -
ACTIVE
- The global table is ready for use.
If the service returns an enum value that is not available in the current SDK version,
globalTableStatus
will returnGlobalTableStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromglobalTableStatusAsString()
.- Returns:
- The current state of the global table:
-
CREATING
- The global table is being created. -
UPDATING
- The global table is being updated. -
DELETING
- The global table is being deleted. -
ACTIVE
- The global table is ready for use.
-
- See Also:
GlobalTableStatus
-
-
globalTableStatusAsString
public final String globalTableStatusAsString()
The current state of the global table:
-
CREATING
- The global table is being created. -
UPDATING
- The global table is being updated. -
DELETING
- The global table is being deleted. -
ACTIVE
- The global table is ready for use.
If the service returns an enum value that is not available in the current SDK version,
globalTableStatus
will returnGlobalTableStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromglobalTableStatusAsString()
.- Returns:
- The current state of the global table:
-
CREATING
- The global table is being created. -
UPDATING
- The global table is being updated. -
DELETING
- The global table is being deleted. -
ACTIVE
- The global table is ready for use.
-
- See Also:
GlobalTableStatus
-
-
globalTableName
public final String globalTableName()
The global table name.
- Returns:
- The global table name.
-
toBuilder
public GlobalTableDescription.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<GlobalTableDescription.Builder,GlobalTableDescription>
-
builder
public static GlobalTableDescription.Builder builder()
-
serializableBuilderClass
public static Class<? extends GlobalTableDescription.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-