Class DivergentField

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

A single field that differs between the source and target copies of an item.

See Also:

  • Method Details

    • path

      public final String path()

      The location of the field within the item.

      Returns:
      The location of the field within the item.

    • sourceValue

      public final String sourceValue()

      The field's value on the source domain.

      Returns:
      The field's value on the source domain.

    • targetValue

      public final String targetValue()

      The field's value on the target domain.

      Returns:
      The field's value on the target domain.

    • policy

      public final DiffFieldPolicy policy()

      How the comparison treats this field.

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

      Returns:
      How the comparison treats this field.
      See Also:

    • policyAsString

      public final String policyAsString()

      How the comparison treats this field.

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

      Returns:
      How the comparison treats this field.
      See Also:

    • toBuilder

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

    • builder

      public static DivergentField.Builder builder()

    • serializableBuilderClass

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