Package software.amazon.awssdk.services.opensearch.model

Class CrossClusterSearchConnectionProperties

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

Cross-cluster search specific connection properties.

See Also:

  • Method Details

    • skipUnavailable

      public final SkipUnavailableStatus skipUnavailable()

      The status of the SkipUnavailable setting for the outbound connection. This feature allows you to specify some clusters as optional and ensure that your cross-cluster queries return partial results despite failures on one or more remote clusters.

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

      Returns:
      The status of the SkipUnavailable setting for the outbound connection. This feature allows you to specify some clusters as optional and ensure that your cross-cluster queries return partial results despite failures on one or more remote clusters.
      See Also:

    • skipUnavailableAsString

      public final String skipUnavailableAsString()

      The status of the SkipUnavailable setting for the outbound connection. This feature allows you to specify some clusters as optional and ensure that your cross-cluster queries return partial results despite failures on one or more remote clusters.

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

      Returns:
      The status of the SkipUnavailable setting for the outbound connection. This feature allows you to specify some clusters as optional and ensure that your cross-cluster queries return partial results despite failures on one or more remote clusters.
      See Also:

    • toBuilder

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

    • builder

      public static CrossClusterSearchConnectionProperties.Builder builder()

    • serializableBuilderClass

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