Package co.elastic.clients.elasticsearch.indices

Class ExistsRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<ExistsRequest.Builder>
co.elastic.clients.elasticsearch.indices.ExistsRequest.Builder
All Implemented Interfaces:
WithJson<ExistsRequest.Builder>, ObjectBuilder<ExistsRequest>
Enclosing class:
ExistsRequest
public static class ExistsRequest.Builder extends RequestBase.AbstractBuilder<ExistsRequest.Builder> implements ObjectBuilder<ExistsRequest>
Builder for ExistsRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allowNoIndices

      public final ExistsRequest.Builder allowNoIndices(@Nullable Boolean value)
      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 ExistsRequest.Builder expandWildcards(List<ExpandWildcard> list)
      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

      Adds all elements of list to expandWildcards.

    • expandWildcards

      public final ExistsRequest.Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values)
      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

      Adds one or more values to expandWildcards.

    • flatSettings

      public final ExistsRequest.Builder flatSettings(@Nullable Boolean value)
      If true, returns settings in flat format.

      API name: flat_settings

    • ignoreUnavailable

      public final ExistsRequest.Builder ignoreUnavailable(@Nullable Boolean value)
      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

    • includeDefaults

      public final ExistsRequest.Builder includeDefaults(@Nullable Boolean value)
      If true, return all default settings in the response.

      API name: include_defaults

    • index

      public final ExistsRequest.Builder index(List<String> list)
      Required - Comma-separated list of data streams, indices, and aliases. Supports wildcards (*).

      API name: index

      Adds all elements of list to index.

    • index

      public final ExistsRequest.Builder index(String value, String... values)
      Required - Comma-separated list of data streams, indices, and aliases. Supports wildcards (*).

      API name: index

      Adds one or more values to index.

    • local

      public final ExistsRequest.Builder local(@Nullable Boolean value)
      If true, the request retrieves information from the local node only.

      API name: local

    • self

      protected ExistsRequest.Builder self()
      Specified by:
      self in class RequestBase.AbstractBuilder<ExistsRequest.Builder>

    • build

      public ExistsRequest build()
      Builds a ExistsRequest.
      Specified by:
      build in interface ObjectBuilder<ExistsRequest>
      Throws:
      NullPointerException - if some of the required fields are null.