Package co.elastic.clients.elasticsearch.cluster

Class HealthRequest.Builder

java.lang.Object
co.elastic.clients.elasticsearch.cluster.HealthRequest.Builder
All Implemented Interfaces:
ObjectBuilder<HealthRequest>
Enclosing class:
HealthRequest
public static class HealthRequest.Builder
extends java.lang.Object
implements ObjectBuilder<HealthRequest>
Builder for HealthRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • index

      public HealthRequest.Builder index​(@Nullable java.util.List<java.lang.String> value)
      Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. To target all data streams and indices in a cluster, omit this parameter or use _all or *.

      API name: index

    • index

      public HealthRequest.Builder index​(java.lang.String... value)
      Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. To target all data streams and indices in a cluster, omit this parameter or use _all or *.

      API name: index

    • addIndex

      public HealthRequest.Builder addIndex​(java.lang.String value)
      Add a value to index(List), creating the list if needed.

    • expandWildcards

      public HealthRequest.Builder expandWildcards​(@Nullable java.util.List<ExpandWildcardOptions> value)
      Whether to expand wildcard expression to concrete indices that are open, closed or both.

      API name: expand_wildcards

    • expandWildcards

      public HealthRequest.Builder expandWildcards​(ExpandWildcardOptions... value)
      Whether to expand wildcard expression to concrete indices that are open, closed or both.

      API name: expand_wildcards

    • addExpandWildcards

      public HealthRequest.Builder addExpandWildcards​(ExpandWildcardOptions value)
      Add a value to expandWildcards(List), creating the list if needed.

    • level

      public HealthRequest.Builder level​(@Nullable Level value)
      Can be one of cluster, indices or shards. Controls the details level of the health information returned.

      API name: level

    • local

      public HealthRequest.Builder local​(@Nullable java.lang.Boolean value)
      If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.

      API name: local

    • masterTimeout

      public HealthRequest.Builder masterTimeout​(@Nullable java.lang.String 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

    • timeout

      public HealthRequest.Builder timeout​(@Nullable java.lang.String value)
      Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      API name: timeout

    • waitForActiveShards

      public HealthRequest.Builder waitForActiveShards​(@Nullable jakarta.json.JsonValue value)
      A number controlling to how many active shards to wait for, all to wait for all shards in the cluster to be active, or 0 to not wait.

      API name: wait_for_active_shards

    • waitForEvents

      public HealthRequest.Builder waitForEvents​(@Nullable WaitForEvents value)
      Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with the given priority are processed.

      API name: wait_for_events

    • waitForNodes

      public HealthRequest.Builder waitForNodes​(@Nullable java.lang.String value)
      The request waits until the specified number N of nodes is available. It also accepts >=N, <=N, >N and <N. Alternatively, it is possible to use ge(N), le(N), gt(N) and lt(N) notation.

      API name: wait_for_nodes

    • waitForNoInitializingShards

      public HealthRequest.Builder waitForNoInitializingShards​(@Nullable java.lang.Boolean value)
      A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard initializations. Defaults to false, which means it will not wait for initializing shards.

      API name: wait_for_no_initializing_shards

    • waitForNoRelocatingShards

      public HealthRequest.Builder waitForNoRelocatingShards​(@Nullable java.lang.Boolean value)
      A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard relocations. Defaults to false, which means it will not wait for relocating shards.

      API name: wait_for_no_relocating_shards

    • waitForStatus

      public HealthRequest.Builder waitForStatus​(@Nullable WaitForStatus value)
      One of green, yellow or red. Will wait (until the timeout provided) until the status of the cluster changes to the one provided or better, i.e. green > yellow > red. By default, will not wait for any status.

      API name: wait_for_status

    • build

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