Module org.elasticsearch.server
Package org.elasticsearch.action.support

Record Class IndicesOptions.ConcreteTargetOptions

java.lang.Object
java.lang.Record
org.elasticsearch.action.support.IndicesOptions.ConcreteTargetOptions
Record Components:
allowUnavailableTargets - , if false when any of the concrete targets requested does not exist, throw an error
All Implemented Interfaces:
ToXContent, ToXContentFragment
Enclosing class:
IndicesOptions
public static record IndicesOptions.ConcreteTargetOptions(boolean allowUnavailableTargets) extends Record implements ToXContentFragment
Controls the way the target indices will be handled.

  • Field Details

  • Constructor Details

    • ConcreteTargetOptions

      public ConcreteTargetOptions(boolean allowUnavailableTargets)
      Creates an instance of a ConcreteTargetOptions record class.
      Parameters:
      allowUnavailableTargets - the value for the allowUnavailableTargets record component

  • Method Details

    • fromParameter

      public static IndicesOptions.ConcreteTargetOptions fromParameter(Object ignoreUnavailableString, IndicesOptions.ConcreteTargetOptions defaultOption)

    • toXContent

      public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface ToXContent
      Throws:
      IOException

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • allowUnavailableTargets

      public boolean allowUnavailableTargets()
      Returns the value of the allowUnavailableTargets record component.
      Returns:
      the value of the allowUnavailableTargets record component