Package org.opensearch.client.opensearch.cat.health

Class HealthRecord.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.cat.health.HealthRecord.Builder

All Implemented Interfaces:

ObjectBuilder<HealthRecord>

Enclosing class:

HealthRecord

public static class HealthRecord.Builder
extends ObjectBuilderBase
implements ObjectBuilder<HealthRecord>

Builder for HealthRecord.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
HealthRecord.Builder	activeShardsPercent(java.lang.String value)	active number of shards in percent
HealthRecord	build()	Builds a HealthRecord.
HealthRecord.Builder	cluster(java.lang.String value)	cluster name
HealthRecord.Builder	epoch(java.lang.String value)	seconds since 1969-01-01 00:00:00
HealthRecord.Builder	init(java.lang.String value)	number of initializing nodes
HealthRecord.Builder	maxTaskWaitTime(java.lang.String value)	wait time of longest task pending
HealthRecord.Builder	nodeData(java.lang.String value)	number of nodes that can store data
HealthRecord.Builder	nodeTotal(java.lang.String value)	total number of nodes
HealthRecord.Builder	pendingTasks(java.lang.String value)	number of pending tasks
HealthRecord.Builder	pri(java.lang.String value)	number of primary shards
HealthRecord.Builder	relo(java.lang.String value)	number of relocating nodes
HealthRecord.Builder	shards(java.lang.String value)	total number of shards
HealthRecord.Builder	status(java.lang.String value)	health status
HealthRecord.Builder	timestamp(java.lang.String value)	time in HH:MM:SS
HealthRecord.Builder	unassign(java.lang.String value)	number of unassigned shards

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

epoch

public final HealthRecord.Builder epoch(@Nullable
                                        java.lang.String value)

seconds since 1969-01-01 00:00:00

API name: epoch

timestamp

public final HealthRecord.Builder timestamp(@Nullable
                                            java.lang.String value)

time in HH:MM:SS

API name: timestamp

cluster

public final HealthRecord.Builder cluster(@Nullable
                                          java.lang.String value)

cluster name

API name: cluster

status

public final HealthRecord.Builder status(@Nullable
                                         java.lang.String value)

health status

API name: status

nodeTotal

public final HealthRecord.Builder nodeTotal(@Nullable
                                            java.lang.String value)

total number of nodes

API name: node.total

nodeData

public final HealthRecord.Builder nodeData(@Nullable
                                           java.lang.String value)

number of nodes that can store data

API name: node.data

shards

public final HealthRecord.Builder shards(@Nullable
                                         java.lang.String value)

total number of shards

API name: shards

pri

public final HealthRecord.Builder pri(@Nullable
                                      java.lang.String value)

number of primary shards

API name: pri

relo

public final HealthRecord.Builder relo(@Nullable
                                       java.lang.String value)

number of relocating nodes

API name: relo

init

public final HealthRecord.Builder init(@Nullable
                                       java.lang.String value)

number of initializing nodes

API name: init

unassign

public final HealthRecord.Builder unassign(@Nullable
                                           java.lang.String value)

number of unassigned shards

API name: unassign

pendingTasks

public final HealthRecord.Builder pendingTasks(@Nullable
                                               java.lang.String value)

number of pending tasks

API name: pending_tasks

maxTaskWaitTime

public final HealthRecord.Builder maxTaskWaitTime(@Nullable
                                                  java.lang.String value)

wait time of longest task pending

API name: max_task_wait_time

activeShardsPercent

public final HealthRecord.Builder activeShardsPercent(@Nullable
                                                      java.lang.String value)

active number of shards in percent

API name: active_shards_percent

build

public HealthRecord build()

Builds a HealthRecord.

Specified by:

build in interface ObjectBuilder<HealthRecord>

Throws:

java.lang.NullPointerException - if some of the required fields are null.