Package org.opensearch.client.opensearch.indices

Class ExistsAliasRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • copy

      @Nonnull public ExistsAliasRequest.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<ExistsAliasRequest.Builder,ExistsAliasRequest>
      Returns:
      a new builder instance.

    • self

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

    • allowNoIndices

      @Nonnull public final ExistsAliasRequest.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

    • expandWildcards

      @Nonnull public final ExistsAliasRequest.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 ExistsAliasRequest.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.

    • ignoreUnavailable

      @Nonnull public final ExistsAliasRequest.Builder ignoreUnavailable(@Nullable Boolean value)
      If false, requests that include a missing data stream or index in the target indexes or data streams return an error.

      API name: ignore_unavailable

    • index

      @Nonnull public final ExistsAliasRequest.Builder index(List<String> list)
      Comma-separated list of data streams or indexes used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.

      API name: index

      Adds all elements of list to index.

    • index

      @Nonnull public final ExistsAliasRequest.Builder index(String value, String... values)
      Comma-separated list of data streams or indexes used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.

      API name: index

      Adds one or more values to index.

    • local

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

      API name: local

    • name

      @Nonnull public final ExistsAliasRequest.Builder name(List<String> list)
      Required - Comma-separated list of aliases to check. Supports wildcards (*).

      API name: name

      Adds all elements of list to name.

    • name

      @Nonnull public final ExistsAliasRequest.Builder name(String value, String... values)
      Required - Comma-separated list of aliases to check. Supports wildcards (*).

      API name: name

      Adds one or more values to name.

    • build

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