Package co.elastic.clients.elasticsearch.indices

Class GetAliasRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allowNoIndices

      public final GetAliasRequest.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 indices. This behavior applies even if the request targets other open indices.

      API name: allow_no_indices

    • expandWildcards

      public final GetAliasRequest.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 GetAliasRequest.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.

    • ignoreUnavailable

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

      API name: ignore_unavailable

    • index

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

      API name: index

      Adds all elements of list to index.

    • index

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

      API name: index

      Adds one or more values to index.

    • masterTimeout

      public final GetAliasRequest.Builder masterTimeout(@Nullable Time value)
      Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      API name: master_timeout

    • masterTimeout

      public final GetAliasRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)
      Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      API name: master_timeout

    • name

      public final GetAliasRequest.Builder name(List<String> list)
      Comma-separated list of aliases to retrieve. Supports wildcards (*). To retrieve all aliases, omit this parameter or use * or _all.

      API name: name

      Adds all elements of list to name.

    • name

      public final GetAliasRequest.Builder name(String value, String... values)
      Comma-separated list of aliases to retrieve. Supports wildcards (*). To retrieve all aliases, omit this parameter or use * or _all.

      API name: name

      Adds one or more values to name.

    • self

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

    • build

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