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

Record Class IndicesOptions.IndexAbstractionOptions

java.lang.Object
java.lang.Record
org.elasticsearch.action.support.IndicesOptions.IndexAbstractionOptions
Record Components:
resolveAliases - , aliases will be included in the result, if false we treat them like they do not exist. Defaults to true.
resolveViews - , views will be included in the result, if false we treat them like they do not exist. Defaults to false.
Enclosing class:
IndicesOptions
public static record IndicesOptions.IndexAbstractionOptions(boolean resolveAliases, boolean resolveViews) extends Record
Controls which types of index abstractions participate in index resolution. These options apply uniformly to both concrete target and wildcard resolution paths.

  • Field Details

  • Constructor Details

    • IndexAbstractionOptions

      public IndexAbstractionOptions(boolean resolveAliases, boolean resolveViews)
      Creates an instance of a IndexAbstractionOptions record class.
      Parameters:
      resolveAliases - the value for the resolveAliases record component
      resolveViews - the value for the resolveViews record component

  • Method Details

    • builder

      public static IndicesOptions.IndexAbstractionOptions.Builder builder()

    • builder

      public static IndicesOptions.IndexAbstractionOptions.Builder builder(IndicesOptions.IndexAbstractionOptions indexAbstractionOptions)

    • 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.

    • resolveAliases

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

    • resolveViews

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