Package co.elastic.clients.elasticsearch.cat

Class AliasesRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • expandWildcards

      public final AliasesRequest.Builder expandWildcards(List<ExpandWildcard> list)
      The 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. It supports comma-separated values, such as open,hidden.

      API name: expand_wildcards

      Adds all elements of list to expandWildcards.

    • expandWildcards

      public final AliasesRequest.Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values)
      The 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. It supports comma-separated values, such as open,hidden.

      API name: expand_wildcards

      Adds one or more values to expandWildcards.

    • local

      public final AliasesRequest.Builder local(@Nullable Boolean value)
      If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

      API name: local

    • masterTimeout

      public final AliasesRequest.Builder masterTimeout(@Nullable Time value)
      The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicated that the request should never timeout, you can set it to -1.

      API name: master_timeout

    • masterTimeout

      public final AliasesRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)
      The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicated that the request should never timeout, you can set it to -1.

      API name: master_timeout

    • name

      public final AliasesRequest.Builder name(List<String> list)
      A 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 AliasesRequest.Builder name(String value, String... values)
      A 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 AliasesRequest.Builder self()
      Specified by:
      self in class CatRequestBase.AbstractBuilder<AliasesRequest.Builder>

    • build

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