Package org.opensearch.client.opensearch.cat.allocation

Class AllocationRecord.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.cat.allocation.AllocationRecord.Builder

All Implemented Interfaces:

ObjectBuilder<AllocationRecord>

Enclosing class:

AllocationRecord

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

Builder for AllocationRecord.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AllocationRecord	build()	Builds a AllocationRecord.
AllocationRecord.Builder	diskAvail(java.lang.String value)	disk available
AllocationRecord.Builder	diskIndices(java.lang.String value)	disk used by ES indices
AllocationRecord.Builder	diskPercent(java.lang.String value)	percent disk used
AllocationRecord.Builder	diskTotal(java.lang.String value)	total capacity of all volumes
AllocationRecord.Builder	diskUsed(java.lang.String value)	disk used (total, not just ES)
AllocationRecord.Builder	host(java.lang.String value)	host of node
AllocationRecord.Builder	ip(java.lang.String value)	ip of node
AllocationRecord.Builder	node(java.lang.String value)	name of node
AllocationRecord.Builder	shards(java.lang.String value)	number of shards on node

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

shards

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

number of shards on node

API name: shards

diskIndices

public final AllocationRecord.Builder diskIndices(@Nullable
                                                  java.lang.String value)

disk used by ES indices

API name: disk.indices

diskUsed

public final AllocationRecord.Builder diskUsed(@Nullable
                                               java.lang.String value)

disk used (total, not just ES)

API name: disk.used

diskAvail

public final AllocationRecord.Builder diskAvail(@Nullable
                                                java.lang.String value)

disk available

API name: disk.avail

diskTotal

public final AllocationRecord.Builder diskTotal(@Nullable
                                                java.lang.String value)

total capacity of all volumes

API name: disk.total

diskPercent

public final AllocationRecord.Builder diskPercent(@Nullable
                                                  java.lang.String value)

percent disk used

API name: disk.percent

host

public final AllocationRecord.Builder host(@Nullable
                                           java.lang.String value)

host of node

API name: host

ip

public final AllocationRecord.Builder ip(@Nullable
                                         java.lang.String value)

ip of node

API name: ip

node

public final AllocationRecord.Builder node(@Nullable
                                           java.lang.String value)

name of node

API name: node

build

public AllocationRecord build()

Builds a AllocationRecord.

Specified by:

build in interface ObjectBuilder<AllocationRecord>

Throws:

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