Package co.elastic.clients.elasticsearch.cluster.health

Class HealthResponseBody.AbstractBuilder<BuilderT extends HealthResponseBody.AbstractBuilder<BuilderT>>

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch.cluster.health.HealthResponseBody.AbstractBuilder<BuilderT>
All Implemented Interfaces:
WithJson<BuilderT>
Direct Known Subclasses:
HealthResponse.Builder
Enclosing class:
HealthResponseBody
public abstract static class HealthResponseBody.AbstractBuilder<BuilderT extends HealthResponseBody.AbstractBuilder<BuilderT>> extends WithJsonObjectBuilderBase<BuilderT>

  • Constructor Details

    • AbstractBuilder

      public AbstractBuilder()

  • Method Details

    • activePrimaryShards

      public final BuilderT activePrimaryShards(int value)
      Required - The number of active primary shards.

      API name: active_primary_shards

    • activeShards

      public final BuilderT activeShards(int value)
      Required - The total number of active primary and replica shards.

      API name: active_shards

    • activeShardsPercent

      public final BuilderT activeShardsPercent(@Nullable String value)
      The ratio of active shards in the cluster expressed as a string formatted percentage.

      API name: active_shards_percent

    • activeShardsPercentAsNumber

      public final BuilderT activeShardsPercentAsNumber(double value)
      Required - The ratio of active shards in the cluster expressed as a percentage.

      API name: active_shards_percent_as_number

    • clusterName

      public final BuilderT clusterName(String value)
      Required - The name of the cluster.

      API name: cluster_name

    • delayedUnassignedShards

      public final BuilderT delayedUnassignedShards(int value)
      Required - The number of shards whose allocation has been delayed by the timeout settings.

      API name: delayed_unassigned_shards

    • indices

      public final BuilderT indices(Map<String,IndexHealthStats> map)
      API name: indices

      Adds all entries of map to indices.

    • indices

      public final BuilderT indices(String key, IndexHealthStats value)
      API name: indices

      Adds an entry to indices.

    • indices

      public final BuilderT indices(String key, Function<IndexHealthStats.Builder,ObjectBuilder<IndexHealthStats>> fn)
      API name: indices

      Adds an entry to indices using a builder lambda.

    • initializingShards

      public final BuilderT initializingShards(int value)
      Required - The number of shards that are under initialization.

      API name: initializing_shards

    • numberOfDataNodes

      public final BuilderT numberOfDataNodes(int value)
      Required - The number of nodes that are dedicated data nodes.

      API name: number_of_data_nodes

    • numberOfInFlightFetch

      public final BuilderT numberOfInFlightFetch(int value)
      Required - The number of unfinished fetches.

      API name: number_of_in_flight_fetch

    • numberOfNodes

      public final BuilderT numberOfNodes(int value)
      Required - The number of nodes within the cluster.

      API name: number_of_nodes

    • numberOfPendingTasks

      public final BuilderT numberOfPendingTasks(int value)
      Required - The number of cluster-level changes that have not yet been executed.

      API name: number_of_pending_tasks

    • relocatingShards

      public final BuilderT relocatingShards(int value)
      Required - The number of shards that are under relocation.

      API name: relocating_shards

    • status

      public final BuilderT status(HealthStatus value)
      Required - API name: status

    • taskMaxWaitingInQueue

      public final BuilderT taskMaxWaitingInQueue(@Nullable Time value)
      The time since the earliest initiated task is waiting for being performed.

      API name: task_max_waiting_in_queue

    • taskMaxWaitingInQueue

      public final BuilderT taskMaxWaitingInQueue(Function<Time.Builder,ObjectBuilder<Time>> fn)
      The time since the earliest initiated task is waiting for being performed.

      API name: task_max_waiting_in_queue

    • taskMaxWaitingInQueueMillis

      public final BuilderT taskMaxWaitingInQueueMillis(long value)
      Required - 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 final BuilderT timedOut(boolean value)
      Required - If false the response returned within the period of time that is specified by the timeout parameter (30s by default)

      API name: timed_out

    • unassignedPrimaryShards

      public final BuilderT unassignedPrimaryShards(int value)
      Required - The number of primary shards that are not allocated.

      API name: unassigned_primary_shards

    • unassignedShards

      public final BuilderT unassignedShards(int value)
      Required - The number of shards that are not allocated.

      API name: unassigned_shards

    • self

      protected abstract BuilderT self()
      Specified by:
      self in class WithJsonObjectBuilderBase<BuilderT extends HealthResponseBody.AbstractBuilder<BuilderT>>