Package 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("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:

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • toBuilder

      public GlobalClusterMember.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<GlobalClusterMember.Builder,GlobalClusterMember>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.