software.amazon.awssdk.services.rds.model

Class GlobalClusterMember

java.lang.Object

software.amazon.awssdk.services.rds.model.GlobalClusterMember

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<GlobalClusterMember.Builder,GlobalClusterMember>

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

A data structure with information about any primary and secondary clusters associated with a global cluster (Aurora global database).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GlobalClusterMember.Builder

Method Summary

Modifier and Type	Method and Description
static GlobalClusterMember.Builder	builder()
String	dbClusterArn() The Amazon Resource Name (ARN) for each Aurora DB cluster in the global cluster.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
WriteForwardingStatus	globalWriteForwardingStatus() The status of write forwarding for a secondary cluster in the global cluster.
String	globalWriteForwardingStatusAsString() The status of write forwarding for a secondary cluster in the global cluster.
int	hashCode()
boolean	hasReaders() For responses, this returns true if the service returned a value for the Readers property.
Boolean	isWriter() Indicates whether the Aurora DB cluster is the primary cluster (that is, has read-write capability) for the global cluster with which it is associated.
List<String>	readers() The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the global cluster.
List<SdkField<?>>	sdkFields()
static Class<? extends GlobalClusterMember.Builder>	serializableBuilderClass()
GlobalClusterMemberSynchronizationStatus	synchronizationStatus() The status of synchronization of each Aurora DB cluster in the global cluster.
String	synchronizationStatusAsString() The status of synchronization of each Aurora DB cluster in the global cluster.
GlobalClusterMember.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

dbClusterArn

public final String dbClusterArn()

The Amazon Resource Name (ARN) for each Aurora DB cluster in the global cluster.

Returns:

The Amazon Resource Name (ARN) for each Aurora DB cluster in the global cluster.

hasReaders

public final boolean hasReaders()

For responses, this returns true if the service returned a value for the Readers 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.

readers

public final List<String> readers()

The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the global cluster.

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 hasReaders() method.

Returns:

The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the global cluster.

isWriter

public final Boolean isWriter()

Indicates whether the Aurora DB cluster is the primary cluster (that is, has read-write capability) for the global cluster with which it is associated.

Returns:

Indicates whether the Aurora DB cluster is the primary cluster (that is, has read-write capability) for the global cluster with which it is associated.

globalWriteForwardingStatus

public final WriteForwardingStatus globalWriteForwardingStatus()

The status of write forwarding for a secondary cluster in the global cluster.

If the service returns an enum value that is not available in the current SDK version, globalWriteForwardingStatus will return WriteForwardingStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from globalWriteForwardingStatusAsString().

Returns:

The status of write forwarding for a secondary cluster in the global cluster.

See Also:

WriteForwardingStatus

globalWriteForwardingStatusAsString

public final String globalWriteForwardingStatusAsString()

The status of write forwarding for a secondary cluster in the global cluster.

If the service returns an enum value that is not available in the current SDK version, globalWriteForwardingStatus will return WriteForwardingStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from globalWriteForwardingStatusAsString().

Returns:

The status of write forwarding for a secondary cluster in the global cluster.

See Also:

WriteForwardingStatus

synchronizationStatus

public final GlobalClusterMemberSynchronizationStatus synchronizationStatus()

The status of synchronization of each Aurora DB cluster in the global cluster.

If the service returns an enum value that is not available in the current SDK version, synchronizationStatus will return GlobalClusterMemberSynchronizationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from synchronizationStatusAsString().

Returns:

The status of synchronization of each Aurora DB cluster in the global cluster.

See Also:

GlobalClusterMemberSynchronizationStatus

synchronizationStatusAsString

public final String synchronizationStatusAsString()

The status of synchronization of each Aurora DB cluster in the global cluster.

If the service returns an enum value that is not available in the current SDK version, synchronizationStatus will return GlobalClusterMemberSynchronizationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from synchronizationStatusAsString().

Returns:

The status of synchronization of each Aurora DB cluster in the global cluster.

See Also:

GlobalClusterMemberSynchronizationStatus

toBuilder

public GlobalClusterMember.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GlobalClusterMember.Builder,GlobalClusterMember>

builder

public static GlobalClusterMember.Builder builder()

serializableBuilderClass

public static Class<? extends GlobalClusterMember.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