Class GlobalCluster

java.lang.Object
software.amazon.awssdk.services.neptune.model.GlobalCluster
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<GlobalCluster.Builder,GlobalCluster>
@Generated("software.amazon.awssdk:codegen") public final class GlobalCluster extends Object implements SdkPojo, Serializable, ToCopyableBuilder<GlobalCluster.Builder,GlobalCluster>

Contains the details of an Amazon Neptune global database.

This data type is used as a response element for the CreateGlobalCluster, DescribeGlobalClusters, ModifyGlobalCluster, DeleteGlobalCluster, FailoverGlobalCluster, and RemoveFromGlobalCluster actions.

See Also:

  • Method Details

    • globalClusterIdentifier

      public final String globalClusterIdentifier()

      Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database.

      Returns:
      Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database.

    • globalClusterResourceId

      public final String globalClusterResourceId()

      An immutable identifier for the global database that is unique within in all regions. This identifier is found in CloudTrail log entries whenever the KMS key for the DB cluster is accessed.

      Returns:
      An immutable identifier for the global database that is unique within in all regions. This identifier is found in CloudTrail log entries whenever the KMS key for the DB cluster is accessed.

    • globalClusterArn

      public final String globalClusterArn()

      The Amazon Resource Name (ARN) for the global database.

      Returns:
      The Amazon Resource Name (ARN) for the global database.

    • status

      public final String status()

      Specifies the current state of this global database.

      Returns:
      Specifies the current state of this global database.

    • engine

      public final String engine()

      The Neptune database engine used by the global database ("neptune").

      Returns:
      The Neptune database engine used by the global database ("neptune").

    • engineVersion

      public final String engineVersion()

      The Neptune engine version used by the global database.

      Returns:
      The Neptune engine version used by the global database.

    • storageEncrypted

      public final Boolean storageEncrypted()

      The storage encryption setting for the global database.

      Returns:
      The storage encryption setting for the global database.

    • deletionProtection

      public final Boolean deletionProtection()

      The deletion protection setting for the global database.

      Returns:
      The deletion protection setting for the global database.

    • hasGlobalClusterMembers

      public final boolean hasGlobalClusterMembers()
      For responses, this returns true if the service returned a value for the GlobalClusterMembers 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.

    • globalClusterMembers

      public final List<GlobalClusterMember> globalClusterMembers()

      A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.

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

      Returns:
      A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.

    • toBuilder

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

    • builder

      public static GlobalCluster.Builder builder()

    • serializableBuilderClass

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