Class FailoverState

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

Contains the state of scheduled or in-process operations on an Amazon DocumentDB global cluster. This data type is empty unless a switchover or failover operation is scheduled or is in progress on the global cluster.

See Also:

  • Method Details

    • status

      public final FailoverStatus status()

      The current status of the global cluster. Possible values are as follows:

      • pending – The service received a request to switch over or fail over the global cluster. The global cluster's primary cluster and the specified secondary cluster are being verified before the operation starts.

      • failing-over – The chosen secondary cluster is being promoted to become the new primary cluster to fail over the global cluster.

      • cancelling – The request to switch over or fail over the global cluster was cancelled and the primary cluster and the selected secondary cluster are returning to their previous states.

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

      Returns:
      The current status of the global cluster. Possible values are as follows:

      • pending – The service received a request to switch over or fail over the global cluster. The global cluster's primary cluster and the specified secondary cluster are being verified before the operation starts.

      • failing-over – The chosen secondary cluster is being promoted to become the new primary cluster to fail over the global cluster.

      • cancelling – The request to switch over or fail over the global cluster was cancelled and the primary cluster and the selected secondary cluster are returning to their previous states.

      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the global cluster. Possible values are as follows:

      • pending – The service received a request to switch over or fail over the global cluster. The global cluster's primary cluster and the specified secondary cluster are being verified before the operation starts.

      • failing-over – The chosen secondary cluster is being promoted to become the new primary cluster to fail over the global cluster.

      • cancelling – The request to switch over or fail over the global cluster was cancelled and the primary cluster and the selected secondary cluster are returning to their previous states.

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

      Returns:
      The current status of the global cluster. Possible values are as follows:

      • pending – The service received a request to switch over or fail over the global cluster. The global cluster's primary cluster and the specified secondary cluster are being verified before the operation starts.

      • failing-over – The chosen secondary cluster is being promoted to become the new primary cluster to fail over the global cluster.

      • cancelling – The request to switch over or fail over the global cluster was cancelled and the primary cluster and the selected secondary cluster are returning to their previous states.

      See Also:

    • fromDbClusterArn

      public final String fromDbClusterArn()

      The Amazon Resource Name (ARN) of the Amazon DocumentDB cluster that is currently being demoted, and which is associated with this state.

      Returns:
      The Amazon Resource Name (ARN) of the Amazon DocumentDB cluster that is currently being demoted, and which is associated with this state.

    • toDbClusterArn

      public final String toDbClusterArn()

      The Amazon Resource Name (ARN) of the Amazon DocumentDB cluster that is currently being promoted, and which is associated with this state.

      Returns:
      The Amazon Resource Name (ARN) of the Amazon DocumentDB cluster that is currently being promoted, and which is associated with this state.

    • isDataLossAllowed

      public final Boolean isDataLossAllowed()

      Indicates whether the operation is a global switchover or a global failover. If data loss is allowed, then the operation is a global failover. Otherwise, it's a switchover.

      Returns:
      Indicates whether the operation is a global switchover or a global failover. If data loss is allowed, then the operation is a global failover. Otherwise, it's a switchover.

    • toBuilder

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

    • builder

      public static FailoverState.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.