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 java.lang.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:
API specification

  • Field Details

  • Method Details

    • of

      public static IndicesOptions of​(java.util.function.Function<IndicesOptions.Builder,​ObjectBuilder<IndicesOptions>> fn)

    • allowNoIndices

      @Nullable public final java.lang.Boolean allowNoIndices()
      If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.

      API name: allow_no_indices

    • expandWildcards

      public final java.util.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 java.lang.Boolean ignoreUnavailable()
      If true, missing or closed indices are not included in the response.

      API name: ignore_unavailable

    • ignoreThrottled

      @Nullable public final java.lang.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)

    • setupIndicesOptionsDeserializer

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