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:

CopyableBuilder<HealthRecord.Builder,HealthRecord>, MutableBuilder<HealthRecord.Builder,HealthRecord>, ObjectBuilder<HealthRecord>

Enclosing class:

HealthRecord

public static class HealthRecord.Builder
extends ObjectBuilderBase
implements CopyableBuilder<HealthRecord.Builder,HealthRecord>

Builder for HealthRecord.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final HealthRecord.Builder	activeShardsPercent(String value)	active number of shards in percent
HealthRecord	build()	Builds a HealthRecord.
final HealthRecord.Builder	cluster(String value)	cluster name
HealthRecord.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final HealthRecord.Builder	discoveredClusterManager(String value)	cluster manager is discovered or not
final HealthRecord.Builder	epoch(Long value)	API name: epoch
final HealthRecord.Builder	init(String value)	number of initializing nodes
final HealthRecord.Builder	maxTaskWaitTime(String value)	wait time of longest task pending
final HealthRecord.Builder	nodeData(String value)	number of nodes that can store data
final HealthRecord.Builder	nodeTotal(String value)	total number of nodes
final HealthRecord.Builder	pendingTasks(String value)	number of pending tasks
final HealthRecord.Builder	pri(String value)	number of primary shards
final HealthRecord.Builder	relo(String value)	number of relocating nodes
final HealthRecord.Builder	shards(String value)	total number of shards
final HealthRecord.Builder	status(String value)	health status
final HealthRecord.Builder	timestamp(String value)	API name: timestamp
final HealthRecord.Builder	unassign(String value)	number of unassigned shards

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

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public HealthRecord.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<HealthRecord.Builder,HealthRecord>

Returns:

a new builder instance.

activeShardsPercent

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

active number of shards in percent

API name: active_shards_percent

cluster

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

cluster name

API name: cluster

discoveredClusterManager

@Nonnull
public final HealthRecord.Builder discoveredClusterManager(@Nullable
 String value)

cluster manager is discovered or not

API name: discovered_cluster_manager

epoch

@Nonnull
public final HealthRecord.Builder epoch(@Nullable
 Long value)

API name: epoch

init

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

number of initializing nodes

API name: init

maxTaskWaitTime

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

wait time of longest task pending

API name: max_task_wait_time

nodeData

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

number of nodes that can store data

API name: node.data

nodeTotal

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

total number of nodes

API name: node.total

pendingTasks

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

number of pending tasks

API name: pending_tasks

pri

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

number of primary shards

API name: pri

relo

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

number of relocating nodes

API name: relo

shards

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

total number of shards

API name: shards

status

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

health status

API name: status

timestamp

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

API name: timestamp

unassign

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

number of unassigned shards

API name: unassign

build

@Nonnull
public HealthRecord build()

Builds a HealthRecord.

Specified by:

build in interface ObjectBuilder<HealthRecord>

Throws:

NullPointerException - if some of the required fields are null.