Class ReplicationPeer

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

A domain that another domain replicates with, and the state of that relationship.

See Also:

  • Method Details

    • peerDomainArn

      public final String peerDomainArn()

      The Amazon Resource Name (ARN) of the peer domain.

      Returns:
      The Amazon Resource Name (ARN) of the peer domain.

    • peerRole

      public final ReplicationRole peerRole()

      The peer's role in the relationship, either PRIMARY or SECONDARY.

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

      Returns:
      The peer's role in the relationship, either PRIMARY or SECONDARY.
      See Also:

    • peerRoleAsString

      public final String peerRoleAsString()

      The peer's role in the relationship, either PRIMARY or SECONDARY.

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

      Returns:
      The peer's role in the relationship, either PRIMARY or SECONDARY.
      See Also:

    • status

      public final ReplicationStatus status()

      The state of the relationship:

      • PENDING_SETUP - replication is being established.

      • ACTIVE - replication is running.

      • SWITCHING_OVER - a planned promotion is in progress.

      • FAILING_OVER - an unplanned promotion is in progress.

      • PENDING_REMOVAL - replication is being stopped.

      • DETACHED - the relationship has ended.

      • EJECTED - a failover promoted the other domain. The former primary keeps the data it had when it was ejected and stays read-only until you remove the peer, or discard that data and pair again.

      • FAILED - setup or teardown could not complete. You can still remove the relationship.

      A relationship that is removed successfully no longer appears in Peers.

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

      Returns:
      The state of the relationship:

      • PENDING_SETUP - replication is being established.

      • ACTIVE - replication is running.

      • SWITCHING_OVER - a planned promotion is in progress.

      • FAILING_OVER - an unplanned promotion is in progress.

      • PENDING_REMOVAL - replication is being stopped.

      • DETACHED - the relationship has ended.

      • EJECTED - a failover promoted the other domain. The former primary keeps the data it had when it was ejected and stays read-only until you remove the peer, or discard that data and pair again.

      • FAILED - setup or teardown could not complete. You can still remove the relationship.

      A relationship that is removed successfully no longer appears in Peers.

      See Also:

    • statusAsString

      public final String statusAsString()

      The state of the relationship:

      • PENDING_SETUP - replication is being established.

      • ACTIVE - replication is running.

      • SWITCHING_OVER - a planned promotion is in progress.

      • FAILING_OVER - an unplanned promotion is in progress.

      • PENDING_REMOVAL - replication is being stopped.

      • DETACHED - the relationship has ended.

      • EJECTED - a failover promoted the other domain. The former primary keeps the data it had when it was ejected and stays read-only until you remove the peer, or discard that data and pair again.

      • FAILED - setup or teardown could not complete. You can still remove the relationship.

      A relationship that is removed successfully no longer appears in Peers.

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

      Returns:
      The state of the relationship:

      • PENDING_SETUP - replication is being established.

      • ACTIVE - replication is running.

      • SWITCHING_OVER - a planned promotion is in progress.

      • FAILING_OVER - an unplanned promotion is in progress.

      • PENDING_REMOVAL - replication is being stopped.

      • DETACHED - the relationship has ended.

      • EJECTED - a failover promoted the other domain. The former primary keeps the data it had when it was ejected and stays read-only until you remove the peer, or discard that data and pair again.

      • FAILED - setup or teardown could not complete. You can still remove the relationship.

      A relationship that is removed successfully no longer appears in Peers.

      See Also:

    • statusMessage

      public final String statusMessage()

      An explanation of why the relationship is in its current state, when more detail is available.

      Returns:
      An explanation of why the relationship is in its current state, when more detail is available.

    • toBuilder

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

    • builder

      public static ReplicationPeer.Builder builder()

    • serializableBuilderClass

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