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

Record Class IndicesOptions.CrossProjectModeOptions

java.lang.Object
java.lang.Record
org.elasticsearch.action.support.IndicesOptions.CrossProjectModeOptions
Record Components:
resolveIndexExpression - determines that the index expression must be resolved for cross-project requests, defaults to false.
All Implemented Interfaces:
Writeable
Enclosing class:
IndicesOptions
public static record IndicesOptions.CrossProjectModeOptions(boolean resolveIndexExpression) extends Record implements Writeable
The cross-project mode options are internal-only options that apply on all indices that have been selected by the other Options. These options may contextually change over the lifetime of the request.

  • Field Details

  • Constructor Details

    • CrossProjectModeOptions

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

  • Method Details

    • writeTo

      public void writeTo(StreamOutput out) throws IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      IOException

    • readFrom

      public static IndicesOptions.CrossProjectModeOptions readFrom(StreamInput in) throws IOException
      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.

    • resolveIndexExpression

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