Package org.elasticsearch.action.support

Record Class IndicesOptions

java.lang.Object
java.lang.Record
org.elasticsearch.action.support.IndicesOptions
All Implemented Interfaces:
org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentFragment
public record IndicesOptions(EnumSet<IndicesOptions.Option> options, EnumSet<IndicesOptions.WildcardStates> expandWildcards) extends Record implements org.elasticsearch.xcontent.ToXContentFragment
Controls how to deal with unavailable concrete indices (closed or missing), how wildcard expressions are expanded to actual indices (all, closed or open indices) and how to deal with wildcard expressions that resolve to no indices.

  • Field Details

    • STRICT_EXPAND_OPEN

      public static final IndicesOptions STRICT_EXPAND_OPEN

    • LENIENT_EXPAND_OPEN

      public static final IndicesOptions LENIENT_EXPAND_OPEN

    • LENIENT_EXPAND_OPEN_HIDDEN

      public static final IndicesOptions LENIENT_EXPAND_OPEN_HIDDEN

    • LENIENT_EXPAND_OPEN_CLOSED

      public static final IndicesOptions LENIENT_EXPAND_OPEN_CLOSED

    • LENIENT_EXPAND_OPEN_CLOSED_HIDDEN

      public static final IndicesOptions LENIENT_EXPAND_OPEN_CLOSED_HIDDEN

    • STRICT_EXPAND_OPEN_CLOSED

      public static final IndicesOptions STRICT_EXPAND_OPEN_CLOSED

    • STRICT_EXPAND_OPEN_CLOSED_HIDDEN

      public static final IndicesOptions STRICT_EXPAND_OPEN_CLOSED_HIDDEN

    • STRICT_EXPAND_OPEN_FORBID_CLOSED

      public static final IndicesOptions STRICT_EXPAND_OPEN_FORBID_CLOSED

    • STRICT_EXPAND_OPEN_HIDDEN_FORBID_CLOSED

      public static final IndicesOptions STRICT_EXPAND_OPEN_HIDDEN_FORBID_CLOSED

    • STRICT_EXPAND_OPEN_FORBID_CLOSED_IGNORE_THROTTLED

      public static final IndicesOptions STRICT_EXPAND_OPEN_FORBID_CLOSED_IGNORE_THROTTLED

    • STRICT_SINGLE_INDEX_NO_EXPAND_FORBID_CLOSED

      public static final IndicesOptions STRICT_SINGLE_INDEX_NO_EXPAND_FORBID_CLOSED

  • Constructor Details

    • IndicesOptions

      public IndicesOptions(EnumSet<IndicesOptions.Option> options, EnumSet<IndicesOptions.WildcardStates> expandWildcards)
      Creates an instance of a IndicesOptions record class.
      Parameters:
      options - the value for the options record component
      expandWildcards - the value for the expandWildcards record component

  • Method Details

    • ignoreUnavailable

      public boolean ignoreUnavailable()
      Returns:
      Whether specified concrete indices should be ignored when unavailable (missing or closed)

    • allowNoIndices

      public boolean allowNoIndices()
      Returns:
      Whether to ignore if a wildcard expression resolves to no concrete indices. The `_all` string or empty list of indices count as wildcard expressions too. Also when an alias points to a closed index this option decides if no concrete indices are allowed.

    • expandWildcardsOpen

      public boolean expandWildcardsOpen()
      Returns:
      Whether wildcard expressions should get expanded to open indices

    • expandWildcardsClosed

      public boolean expandWildcardsClosed()
      Returns:
      Whether wildcard expressions should get expanded to closed indices

    • expandWildcardsHidden

      public boolean expandWildcardsHidden()
      Returns:
      Whether wildcard expressions should get expanded to hidden indices

    • forbidClosedIndices

      public boolean forbidClosedIndices()
      Returns:
      Whether execution on closed indices is allowed.

    • allowAliasesToMultipleIndices

      public boolean allowAliasesToMultipleIndices()
      Returns:
      whether aliases pointing to multiple indices are allowed

    • ignoreAliases

      public boolean ignoreAliases()
      Returns:
      whether aliases should be ignored (when resolving a wildcard)

    • ignoreThrottled

      public boolean ignoreThrottled()
      Returns:
      whether indices that are marked as throttled should be ignored

    • expandWildcards

      public EnumSet<IndicesOptions.WildcardStates> expandWildcards()
      Returns the value of the expandWildcards record component.
      Returns:
      the value of the expandWildcards record component

    • options

      public EnumSet<IndicesOptions.Option> options()
      Returns the value of the options record component.
      Returns:
      the value of the options record component

    • writeIndicesOptions

      public void writeIndicesOptions(StreamOutput out) throws IOException
      Throws:
      IOException

    • readIndicesOptions

      public static IndicesOptions readIndicesOptions(StreamInput in) throws IOException
      Throws:
      IOException

    • fromOptions

      public static IndicesOptions fromOptions(boolean ignoreUnavailable, boolean allowNoIndices, boolean expandToOpenIndices, boolean expandToClosedIndices)

    • fromOptions

      public static IndicesOptions fromOptions(boolean ignoreUnavailable, boolean allowNoIndices, boolean expandToOpenIndices, boolean expandToClosedIndices, boolean expandToHiddenIndices)

    • fromOptions

      public static IndicesOptions fromOptions(boolean ignoreUnavailable, boolean allowNoIndices, boolean expandToOpenIndices, boolean expandToClosedIndices, IndicesOptions defaultOptions)

    • fromOptions

      public static IndicesOptions fromOptions(boolean ignoreUnavailable, boolean allowNoIndices, boolean expandToOpenIndices, boolean expandToClosedIndices, boolean allowAliasesToMultipleIndices, boolean forbidClosedIndices, boolean ignoreAliases, boolean ignoreThrottled)

    • fromOptions

      public static IndicesOptions fromOptions(boolean ignoreUnavailable, boolean allowNoIndices, boolean expandToOpenIndices, boolean expandToClosedIndices, boolean expandToHiddenIndices, boolean allowAliasesToMultipleIndices, boolean forbidClosedIndices, boolean ignoreAliases, boolean ignoreThrottled)

    • fromRequest

      public static IndicesOptions fromRequest(RestRequest request, IndicesOptions defaultSettings)

    • fromMap

      public static IndicesOptions fromMap(Map<String,Object> map, IndicesOptions defaultSettings)

    • isIndicesOptions

      public static boolean isIndicesOptions(String name)
      Returns true if the name represents a valid name for one of the indices option false otherwise

    • fromParameters

      public static IndicesOptions fromParameters(Object wildcardsString, Object ignoreUnavailableString, Object allowNoIndicesString, Object ignoreThrottled, IndicesOptions defaultSettings)

    • toXContent

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

    • fromXContent

      public static IndicesOptions fromXContent(org.elasticsearch.xcontent.XContentParser parser) throws IOException
      Throws:
      IOException

    • fromXContent

      public static IndicesOptions fromXContent(org.elasticsearch.xcontent.XContentParser parser, @Nullable IndicesOptions defaults) throws IOException
      Throws:
      IOException

    • strictExpandOpen

      public static IndicesOptions strictExpandOpen()
      Returns:
      indices options that requires every specified index to exist, expands wildcards only to open indices and allows that no indices are resolved from wildcard expressions (not returning an error).

    • strictExpandOpenAndForbidClosed

      public static IndicesOptions strictExpandOpenAndForbidClosed()
      Returns:
      indices options that requires every specified index to exist, expands wildcards only to open indices, allows that no indices are resolved from wildcard expressions (not returning an error) and forbids the use of closed indices by throwing an error.

    • strictExpandOpenAndForbidClosedIgnoreThrottled

      public static IndicesOptions strictExpandOpenAndForbidClosedIgnoreThrottled()
      Returns:
      indices options that requires every specified index to exist, expands wildcards only to open indices, allows that no indices are resolved from wildcard expressions (not returning an error), forbids the use of closed indices by throwing an error and ignores indices that are throttled.

    • strictExpand

      public static IndicesOptions strictExpand()
      Returns:
      indices option that requires every specified index to exist, expands wildcards to both open and closed indices and allows that no indices are resolved from wildcard expressions (not returning an error).

    • strictExpandHidden

      public static IndicesOptions strictExpandHidden()
      Returns:
      indices option that requires every specified index to exist, expands wildcards to both open and closed indices, includes hidden indices, and allows that no indices are resolved from wildcard expressions (not returning an error).

    • strictSingleIndexNoExpandForbidClosed

      public static IndicesOptions strictSingleIndexNoExpandForbidClosed()
      Returns:
      indices option that requires each specified index or alias to exist, doesn't expand wildcards and throws error if any of the aliases resolves to multiple indices

    • lenientExpandOpen

      public static IndicesOptions lenientExpandOpen()
      Returns:
      indices options that ignores unavailable indices, expands wildcards only to open indices and allows that no indices are resolved from wildcard expressions (not returning an error).

    • lenientExpandOpenHidden

      public static IndicesOptions lenientExpandOpenHidden()
      Returns:
      indices options that ignores unavailable indices, expands wildcards to open and hidden indices, and allows that no indices are resolved from wildcard expressions (not returning an error).

    • lenientExpand

      public static IndicesOptions lenientExpand()
      Returns:
      indices options that ignores unavailable indices, expands wildcards to both open and closed indices and allows that no indices are resolved from wildcard expressions (not returning an error).

    • lenientExpandHidden

      public static IndicesOptions lenientExpandHidden()
      Returns:
      indices options that ignores unavailable indices, expands wildcards to all open and closed indices and allows that no indices are resolved from wildcard expressions (not returning an error).

    • toString

      public 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 Objects::equals(Object,Object).
      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.