Class ModifyingProperties

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

Information about the domain properties that are currently being modified.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the property that is currently being modified.

      Returns:
      The name of the property that is currently being modified.

    • activeValue

      public final String activeValue()

      The current value of the domain property that is being modified.

      Returns:
      The current value of the domain property that is being modified.

    • pendingValue

      public final String pendingValue()

      The value that the property that is currently being modified will eventually have.

      Returns:
      The value that the property that is currently being modified will eventually have.

    • valueType

      public final PropertyValueType valueType()

      The type of value that is currently being modified. Properties can have two types:

      • PLAIN_TEXT: Contain direct values such as "1", "True", or "c5.large.search".
      • STRINGIFIED_JSON: Contain content in JSON format, such as {"Enabled":"True"}".

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

      Returns:
      The type of value that is currently being modified. Properties can have two types:

      • PLAIN_TEXT: Contain direct values such as "1", "True", or "c5.large.search".
      • STRINGIFIED_JSON: Contain content in JSON format, such as {"Enabled":"True"}".
      See Also:

    • valueTypeAsString

      public final String valueTypeAsString()

      The type of value that is currently being modified. Properties can have two types:

      • PLAIN_TEXT: Contain direct values such as "1", "True", or "c5.large.search".
      • STRINGIFIED_JSON: Contain content in JSON format, such as {"Enabled":"True"}".

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

      Returns:
      The type of value that is currently being modified. Properties can have two types:

      • PLAIN_TEXT: Contain direct values such as "1", "True", or "c5.large.search".
      • STRINGIFIED_JSON: Contain content in JSON format, such as {"Enabled":"True"}".
      See Also:

    • toBuilder

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

    • builder

      public static ModifyingProperties.Builder builder()

    • serializableBuilderClass

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