Package org.opensearch.client.opensearch.indices

Class ExistsRequest.Builder

java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<ExistsRequest.Builder>
org.opensearch.client.opensearch.indices.ExistsRequest.Builder
All Implemented Interfaces:
CopyableBuilder<ExistsRequest.Builder,ExistsRequest>, MutableBuilder<ExistsRequest.Builder,ExistsRequest>, ObjectBuilder<ExistsRequest>
Enclosing class:
ExistsRequest
public static class ExistsRequest.Builder extends RequestBase.AbstractBuilder<ExistsRequest.Builder> implements CopyableBuilder<ExistsRequest.Builder,ExistsRequest>
Builder for ExistsRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • copy

      @Nonnull public ExistsRequest.Builder copy()
      Description copied from interface: CopyableBuilder
      Create a new builder CopyableBuilder that is a copy of this one.
      Specified by:
      copy in interface CopyableBuilder<ExistsRequest.Builder,ExistsRequest>
      Returns:
      a new builder instance.

    • self

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

    • allowNoIndices

      @Nonnull public final ExistsRequest.Builder allowNoIndices(@Nullable Boolean value)
      If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes.

      API name: allow_no_indices

    • clusterManagerTimeout

      @Nonnull public final ExistsRequest.Builder clusterManagerTimeout(@Nullable Time value)
      Operation timeout for connection to cluster-manager node.

      API name: cluster_manager_timeout

    • clusterManagerTimeout

      @Nonnull public final ExistsRequest.Builder clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)
      Operation timeout for connection to cluster-manager node.

      API name: cluster_manager_timeout

    • expandWildcards

      @Nonnull 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. Valid values are: all, open, closed, hidden, none.

      API name: expand_wildcards

      Adds all elements of list to expandWildcards.

    • expandWildcards

      @Nonnull 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. Valid values are: all, open, closed, hidden, none.

      API name: expand_wildcards

      Adds one or more values to expandWildcards.

    • flatSettings

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

      API name: flat_settings

    • ignoreUnavailable

      @Nonnull public final ExistsRequest.Builder ignoreUnavailable(@Nullable Boolean value)
      If false, the request returns an error if it targets a missing or closed index.

      API name: ignore_unavailable

    • includeDefaults

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

      API name: include_defaults

    • index

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

      API name: index

      Adds all elements of list to index.

    • index

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

      API name: index

      Adds one or more values to index.

    • local

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

      API name: local

    • build

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