Package co.elastic.clients.elasticsearch.cluster

Class HealthResponse.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • activePrimaryShards

      public HealthResponse.Builder activePrimaryShards​(int value)
      The number of active primary shards.

      API name: active_primary_shards

    • activeShards

      public HealthResponse.Builder activeShards​(int value)
      The total number of active primary and replica shards.

      API name: active_shards

    • activeShardsPercentAsNumber

      public HealthResponse.Builder activeShardsPercentAsNumber​(java.lang.String value)
      The ratio of active shards in the cluster expressed as a percentage.

      API name: active_shards_percent_as_number

    • clusterName

      public HealthResponse.Builder clusterName​(java.lang.String value)
      The name of the cluster.

      API name: cluster_name

    • delayedUnassignedShards

      public HealthResponse.Builder delayedUnassignedShards​(int value)
      The number of shards whose allocation has been delayed by the timeout settings.

      API name: delayed_unassigned_shards

    • indices

      public HealthResponse.Builder indices​(@Nullable java.util.Map<java.lang.String,​IndexHealthStats> value)
      API name: indices

    • putIndices

      public HealthResponse.Builder putIndices​(java.lang.String key, IndexHealthStats value)
      Add a key/value to indices(Map), creating the map if needed.

    • indices

      public HealthResponse.Builder indices​(java.lang.String key, java.util.function.Function<IndexHealthStats.Builder,​ObjectBuilder<IndexHealthStats>> fn)
      Set indices(Map) to a singleton map.

    • putIndices

      public HealthResponse.Builder putIndices​(java.lang.String key, java.util.function.Function<IndexHealthStats.Builder,​ObjectBuilder<IndexHealthStats>> fn)
      Add a key/value to indices(Map), creating the map if needed.

    • initializingShards

      public HealthResponse.Builder initializingShards​(int value)
      The number of shards that are under initialization.

      API name: initializing_shards

    • numberOfDataNodes

      public HealthResponse.Builder numberOfDataNodes​(int value)
      The number of nodes that are dedicated data nodes.

      API name: number_of_data_nodes

    • numberOfInFlightFetch

      public HealthResponse.Builder numberOfInFlightFetch​(int value)
      API name: number_of_in_flight_fetch

    • numberOfNodes

      public HealthResponse.Builder numberOfNodes​(int value)
      The number of nodes within the cluster.

      API name: number_of_nodes

    • numberOfPendingTasks

      public HealthResponse.Builder numberOfPendingTasks​(int value)
      The number of cluster-level changes that have not yet been executed.

      API name: number_of_pending_tasks

    • relocatingShards

      public HealthResponse.Builder relocatingShards​(int value)
      The number of shards that are under relocation.

      API name: relocating_shards

    • status

      public HealthResponse.Builder status​(Health value)
      API name: status

    • taskMaxWaitingInQueueMillis

      public HealthResponse.Builder taskMaxWaitingInQueueMillis​(java.lang.String value)
      The time expressed in milliseconds since the earliest initiated task is waiting for being performed.

      API name: task_max_waiting_in_queue_millis

    • timedOut

      public HealthResponse.Builder timedOut​(boolean value)
      If false the response returned within the period of time that is specified by the timeout parameter (30s by default)

      API name: timed_out

    • unassignedShards

      public HealthResponse.Builder unassignedShards​(int value)
      The number of shards that are not allocated.

      API name: unassigned_shards

    • build

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