Class OutboundConnection

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

Specifies details about an outbound cross-cluster connection.

See Also:

  • Method Details

    • localDomainInfo

      public final DomainInformationContainer localDomainInfo()

      Information about the source (local) domain.

      Returns:
      Information about the source (local) domain.

    • remoteDomainInfo

      public final DomainInformationContainer remoteDomainInfo()

      Information about the destination (remote) domain.

      Returns:
      Information about the destination (remote) domain.

    • connectionId

      public final String connectionId()

      Unique identifier of the connection.

      Returns:
      Unique identifier of the connection.

    • connectionAlias

      public final String connectionAlias()

      Name of the connection.

      Returns:
      Name of the connection.

    • connectionStatus

      public final OutboundConnectionStatus connectionStatus()

      Status of the connection.

      Returns:
      Status of the connection.

    • connectionMode

      public final ConnectionMode connectionMode()

      The connection mode.

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

      Returns:
      The connection mode.
      See Also:

    • connectionModeAsString

      public final String connectionModeAsString()

      The connection mode.

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

      Returns:
      The connection mode.
      See Also:

    • connectionProperties

      public final ConnectionProperties connectionProperties()

      Properties for the outbound connection.

      Returns:
      Properties for the outbound connection.

    • toBuilder

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

    • builder

      public static OutboundConnection.Builder builder()

    • serializableBuilderClass

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