Package co.elastic.clients.elasticsearch._types

Class IndicesOptions

java.lang.Object
co.elastic.clients.elasticsearch._types.IndicesOptions
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class IndicesOptions extends Object implements JsonpSerializable
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.
See Also:

  • Field Details

  • Method Details

    • of

      public static IndicesOptions of(Function<IndicesOptions.Builder,ObjectBuilder<IndicesOptions>> fn)

    • allowNoIndices

      @Nullable public final Boolean allowNoIndices()
      A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result.

      API name: allow_no_indices

    • expandWildcards

      public final List<ExpandWildcard> expandWildcards()
      Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

      API name: expand_wildcards

    • ignoreUnavailable

      @Nullable public final Boolean ignoreUnavailable()
      If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored.

      API name: ignore_unavailable

    • ignoreThrottled

      @Nullable public final Boolean ignoreThrottled()
      If true, concrete, expanded or aliased indices are ignored when frozen.

      API name: ignore_throttled

    • serialize

      public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • rebuild

      public IndicesOptions.Builder rebuild()
      Returns:
      New IndicesOptions.Builder initialized with field values of this instance

    • setupIndicesOptionsDeserializer

      protected static void setupIndicesOptionsDeserializer(ObjectDeserializer<IndicesOptions.Builder> op)