Package org.opensearch.client.opensearch.cat.shards

Class ShardsRecord.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.cat.shards.ShardsRecord.Builder

All Implemented Interfaces:

ObjectBuilder<ShardsRecord>

Enclosing class:

ShardsRecord

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

Builder for ShardsRecord.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ShardsRecord	build()	Builds a ShardsRecord.
ShardsRecord.Builder	bulkAvgSizeInBytes(java.lang.String value)	avg size in bytes of shard bulk
ShardsRecord.Builder	bulkAvgTime(java.lang.String value)	average time spend in shard bulk
ShardsRecord.Builder	bulkTotalOperations(java.lang.String value)	number of bulk shard ops
ShardsRecord.Builder	bulkTotalSizeInBytes(java.lang.String value)	total size in bytes of shard bulk
ShardsRecord.Builder	bulkTotalTime(java.lang.String value)	time spend in shard bulk
ShardsRecord.Builder	completionSize(java.lang.String value)	size of completion
ShardsRecord.Builder	docs(java.lang.String value)	number of docs in shard
ShardsRecord.Builder	fielddataEvictions(java.lang.String value)	fielddata evictions
ShardsRecord.Builder	fielddataMemorySize(java.lang.String value)	used fielddata cache
ShardsRecord.Builder	flushTotal(java.lang.String value)	number of flushes
ShardsRecord.Builder	flushTotalTime(java.lang.String value)	time spent in flush
ShardsRecord.Builder	getCurrent(java.lang.String value)	number of current get ops
ShardsRecord.Builder	getExistsTime(java.lang.String value)	time spent in successful gets
ShardsRecord.Builder	getExistsTotal(java.lang.String value)	number of successful gets
ShardsRecord.Builder	getMissingTime(java.lang.String value)	time spent in failed gets
ShardsRecord.Builder	getMissingTotal(java.lang.String value)	number of failed gets
ShardsRecord.Builder	getTime(java.lang.String value)	time spent in get
ShardsRecord.Builder	getTotal(java.lang.String value)	number of get ops
ShardsRecord.Builder	id(java.lang.String value)	unique id of node where it lives
ShardsRecord.Builder	index(java.lang.String value)	index name
ShardsRecord.Builder	indexingDeleteCurrent(java.lang.String value)	number of current deletions
ShardsRecord.Builder	indexingDeleteTime(java.lang.String value)	time spent in deletions
ShardsRecord.Builder	indexingDeleteTotal(java.lang.String value)	number of delete ops
ShardsRecord.Builder	indexingIndexCurrent(java.lang.String value)	number of current indexing ops
ShardsRecord.Builder	indexingIndexFailed(java.lang.String value)	number of failed indexing ops
ShardsRecord.Builder	indexingIndexTime(java.lang.String value)	time spent in indexing
ShardsRecord.Builder	indexingIndexTotal(java.lang.String value)	number of indexing ops
ShardsRecord.Builder	ip(java.lang.String value)	ip of node where it lives
ShardsRecord.Builder	mergesCurrent(java.lang.String value)	number of current merges
ShardsRecord.Builder	mergesCurrentDocs(java.lang.String value)	number of current merging docs
ShardsRecord.Builder	mergesCurrentSize(java.lang.String value)	size of current merges
ShardsRecord.Builder	mergesTotal(java.lang.String value)	number of completed merge ops
ShardsRecord.Builder	mergesTotalDocs(java.lang.String value)	docs merged
ShardsRecord.Builder	mergesTotalSize(java.lang.String value)	size merged
ShardsRecord.Builder	mergesTotalTime(java.lang.String value)	time spent in merges
ShardsRecord.Builder	node(java.lang.String value)	name of node where it lives
ShardsRecord.Builder	pathData(java.lang.String value)	shard data path
ShardsRecord.Builder	pathState(java.lang.String value)	shard state path
ShardsRecord.Builder	prirep(java.lang.String value)	primary or replica
ShardsRecord.Builder	queryCacheEvictions(java.lang.String value)	query cache evictions
ShardsRecord.Builder	queryCacheMemorySize(java.lang.String value)	used query cache
ShardsRecord.Builder	recoverysourceType(java.lang.String value)	recovery source type
ShardsRecord.Builder	refreshExternalTime(java.lang.String value)	time spent in external refreshes
ShardsRecord.Builder	refreshExternalTotal(java.lang.String value)	total external refreshes
ShardsRecord.Builder	refreshListeners(java.lang.String value)	number of pending refresh listeners
ShardsRecord.Builder	refreshTime(java.lang.String value)	time spent in refreshes
ShardsRecord.Builder	refreshTotal(java.lang.String value)	total refreshes
ShardsRecord.Builder	searchFetchCurrent(java.lang.String value)	current fetch phase ops
ShardsRecord.Builder	searchFetchTime(java.lang.String value)	time spent in fetch phase
ShardsRecord.Builder	searchFetchTotal(java.lang.String value)	total fetch ops
ShardsRecord.Builder	searchOpenContexts(java.lang.String value)	open search contexts
ShardsRecord.Builder	searchQueryCurrent(java.lang.String value)	current query phase ops
ShardsRecord.Builder	searchQueryTime(java.lang.String value)	time spent in query phase
ShardsRecord.Builder	searchQueryTotal(java.lang.String value)	total query phase ops
ShardsRecord.Builder	searchScrollCurrent(java.lang.String value)	open scroll contexts
ShardsRecord.Builder	searchScrollTime(java.lang.String value)	time scroll contexts held open
ShardsRecord.Builder	searchScrollTotal(java.lang.String value)	completed scroll contexts
ShardsRecord.Builder	segmentsCount(java.lang.String value)	number of segments
ShardsRecord.Builder	segmentsFixedBitsetMemory(java.lang.String value)	memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields
ShardsRecord.Builder	segmentsIndexWriterMemory(java.lang.String value)	memory used by index writer
ShardsRecord.Builder	segmentsMemory(java.lang.String value)	memory used by segments
ShardsRecord.Builder	segmentsVersionMapMemory(java.lang.String value)	memory used by version map
ShardsRecord.Builder	seqNoGlobalCheckpoint(java.lang.String value)	global checkpoint
ShardsRecord.Builder	seqNoLocalCheckpoint(java.lang.String value)	local checkpoint
ShardsRecord.Builder	seqNoMax(java.lang.String value)	max sequence number
ShardsRecord.Builder	shard(java.lang.String value)	shard name
ShardsRecord.Builder	state(java.lang.String value)	shard state
ShardsRecord.Builder	store(java.lang.String value)	store size of shard (how much disk it uses)
ShardsRecord.Builder	syncId(java.lang.String value)	sync id
ShardsRecord.Builder	unassignedAt(java.lang.String value)	time shard became unassigned (UTC)
ShardsRecord.Builder	unassignedDetails(java.lang.String value)	additional details as to why the shard became unassigned
ShardsRecord.Builder	unassignedFor(java.lang.String value)	time has been unassigned
ShardsRecord.Builder	unassignedReason(java.lang.String value)	reason shard is unassigned
ShardsRecord.Builder	warmerCurrent(java.lang.String value)	current warmer ops
ShardsRecord.Builder	warmerTotal(java.lang.String value)	total warmer ops
ShardsRecord.Builder	warmerTotalTime(java.lang.String value)	time spent in warmers

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

index

public final ShardsRecord.Builder index(@Nullable
                                        java.lang.String value)

index name

API name: index

shard

public final ShardsRecord.Builder shard(@Nullable
                                        java.lang.String value)

shard name

API name: shard

prirep

public final ShardsRecord.Builder prirep(@Nullable
                                         java.lang.String value)

primary or replica

API name: prirep

state

public final ShardsRecord.Builder state(@Nullable
                                        java.lang.String value)

shard state

API name: state

docs

public final ShardsRecord.Builder docs(@Nullable
                                       java.lang.String value)

number of docs in shard

API name: docs

store

public final ShardsRecord.Builder store(@Nullable
                                        java.lang.String value)

store size of shard (how much disk it uses)

API name: store

ip

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

ip of node where it lives

API name: ip

id

public final ShardsRecord.Builder id(@Nullable
                                     java.lang.String value)

unique id of node where it lives

API name: id

node

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

name of node where it lives

API name: node

syncId

public final ShardsRecord.Builder syncId(@Nullable
                                         java.lang.String value)

sync id

API name: sync_id

unassignedReason

public final ShardsRecord.Builder unassignedReason(@Nullable
                                                   java.lang.String value)

reason shard is unassigned

API name: unassigned.reason

unassignedAt

public final ShardsRecord.Builder unassignedAt(@Nullable
                                               java.lang.String value)

time shard became unassigned (UTC)

API name: unassigned.at

unassignedFor

public final ShardsRecord.Builder unassignedFor(@Nullable
                                                java.lang.String value)

time has been unassigned

API name: unassigned.for

unassignedDetails

public final ShardsRecord.Builder unassignedDetails(@Nullable
                                                    java.lang.String value)

additional details as to why the shard became unassigned

API name: unassigned.details

recoverysourceType

public final ShardsRecord.Builder recoverysourceType(@Nullable
                                                     java.lang.String value)

recovery source type

API name: recoverysource.type

completionSize

public final ShardsRecord.Builder completionSize(@Nullable
                                                 java.lang.String value)

size of completion

API name: completion.size

fielddataMemorySize

public final ShardsRecord.Builder fielddataMemorySize(@Nullable
                                                      java.lang.String value)

used fielddata cache

API name: fielddata.memory_size

fielddataEvictions

public final ShardsRecord.Builder fielddataEvictions(@Nullable
                                                     java.lang.String value)

fielddata evictions

API name: fielddata.evictions

queryCacheMemorySize

public final ShardsRecord.Builder queryCacheMemorySize(@Nullable
                                                       java.lang.String value)

used query cache

API name: query_cache.memory_size

queryCacheEvictions

public final ShardsRecord.Builder queryCacheEvictions(@Nullable
                                                      java.lang.String value)

query cache evictions

API name: query_cache.evictions

flushTotal

public final ShardsRecord.Builder flushTotal(@Nullable
                                             java.lang.String value)

number of flushes

API name: flush.total

flushTotalTime

public final ShardsRecord.Builder flushTotalTime(@Nullable
                                                 java.lang.String value)

time spent in flush

API name: flush.total_time

getCurrent

public final ShardsRecord.Builder getCurrent(@Nullable
                                             java.lang.String value)

number of current get ops

API name: get.current

getTime

public final ShardsRecord.Builder getTime(@Nullable
                                          java.lang.String value)

time spent in get

API name: get.time

getTotal

public final ShardsRecord.Builder getTotal(@Nullable
                                           java.lang.String value)

number of get ops

API name: get.total

getExistsTime

public final ShardsRecord.Builder getExistsTime(@Nullable
                                                java.lang.String value)

time spent in successful gets

API name: get.exists_time

getExistsTotal

public final ShardsRecord.Builder getExistsTotal(@Nullable
                                                 java.lang.String value)

number of successful gets

API name: get.exists_total

getMissingTime

public final ShardsRecord.Builder getMissingTime(@Nullable
                                                 java.lang.String value)

time spent in failed gets

API name: get.missing_time

getMissingTotal

public final ShardsRecord.Builder getMissingTotal(@Nullable
                                                  java.lang.String value)

number of failed gets

API name: get.missing_total

indexingDeleteCurrent

public final ShardsRecord.Builder indexingDeleteCurrent(@Nullable
                                                        java.lang.String value)

number of current deletions

API name: indexing.delete_current

indexingDeleteTime

public final ShardsRecord.Builder indexingDeleteTime(@Nullable
                                                     java.lang.String value)

time spent in deletions

API name: indexing.delete_time

indexingDeleteTotal

public final ShardsRecord.Builder indexingDeleteTotal(@Nullable
                                                      java.lang.String value)

number of delete ops

API name: indexing.delete_total

indexingIndexCurrent

public final ShardsRecord.Builder indexingIndexCurrent(@Nullable
                                                       java.lang.String value)

number of current indexing ops

API name: indexing.index_current

indexingIndexTime

public final ShardsRecord.Builder indexingIndexTime(@Nullable
                                                    java.lang.String value)

time spent in indexing

API name: indexing.index_time

indexingIndexTotal

public final ShardsRecord.Builder indexingIndexTotal(@Nullable
                                                     java.lang.String value)

number of indexing ops

API name: indexing.index_total

indexingIndexFailed

public final ShardsRecord.Builder indexingIndexFailed(@Nullable
                                                      java.lang.String value)

number of failed indexing ops

API name: indexing.index_failed

mergesCurrent

public final ShardsRecord.Builder mergesCurrent(@Nullable
                                                java.lang.String value)

number of current merges

API name: merges.current

mergesCurrentDocs

public final ShardsRecord.Builder mergesCurrentDocs(@Nullable
                                                    java.lang.String value)

number of current merging docs

API name: merges.current_docs

mergesCurrentSize

public final ShardsRecord.Builder mergesCurrentSize(@Nullable
                                                    java.lang.String value)

size of current merges

API name: merges.current_size

mergesTotal

public final ShardsRecord.Builder mergesTotal(@Nullable
                                              java.lang.String value)

number of completed merge ops

API name: merges.total

mergesTotalDocs

public final ShardsRecord.Builder mergesTotalDocs(@Nullable
                                                  java.lang.String value)

docs merged

API name: merges.total_docs

mergesTotalSize

public final ShardsRecord.Builder mergesTotalSize(@Nullable
                                                  java.lang.String value)

size merged

API name: merges.total_size

mergesTotalTime

public final ShardsRecord.Builder mergesTotalTime(@Nullable
                                                  java.lang.String value)

time spent in merges

API name: merges.total_time

refreshTotal

public final ShardsRecord.Builder refreshTotal(@Nullable
                                               java.lang.String value)

total refreshes

API name: refresh.total

refreshTime

public final ShardsRecord.Builder refreshTime(@Nullable
                                              java.lang.String value)

time spent in refreshes

API name: refresh.time

refreshExternalTotal

public final ShardsRecord.Builder refreshExternalTotal(@Nullable
                                                       java.lang.String value)

total external refreshes

API name: refresh.external_total

refreshExternalTime

public final ShardsRecord.Builder refreshExternalTime(@Nullable
                                                      java.lang.String value)

time spent in external refreshes

API name: refresh.external_time

refreshListeners

public final ShardsRecord.Builder refreshListeners(@Nullable
                                                   java.lang.String value)

number of pending refresh listeners

API name: refresh.listeners

searchFetchCurrent

public final ShardsRecord.Builder searchFetchCurrent(@Nullable
                                                     java.lang.String value)

current fetch phase ops

API name: search.fetch_current

searchFetchTime

public final ShardsRecord.Builder searchFetchTime(@Nullable
                                                  java.lang.String value)

time spent in fetch phase

API name: search.fetch_time

searchFetchTotal

public final ShardsRecord.Builder searchFetchTotal(@Nullable
                                                   java.lang.String value)

total fetch ops

API name: search.fetch_total

searchOpenContexts

public final ShardsRecord.Builder searchOpenContexts(@Nullable
                                                     java.lang.String value)

open search contexts

API name: search.open_contexts

searchQueryCurrent

public final ShardsRecord.Builder searchQueryCurrent(@Nullable
                                                     java.lang.String value)

current query phase ops

API name: search.query_current

searchQueryTime

public final ShardsRecord.Builder searchQueryTime(@Nullable
                                                  java.lang.String value)

time spent in query phase

API name: search.query_time

searchQueryTotal

public final ShardsRecord.Builder searchQueryTotal(@Nullable
                                                   java.lang.String value)

total query phase ops

API name: search.query_total

searchScrollCurrent

public final ShardsRecord.Builder searchScrollCurrent(@Nullable
                                                      java.lang.String value)

open scroll contexts

API name: search.scroll_current

searchScrollTime

public final ShardsRecord.Builder searchScrollTime(@Nullable
                                                   java.lang.String value)

time scroll contexts held open

API name: search.scroll_time

searchScrollTotal

public final ShardsRecord.Builder searchScrollTotal(@Nullable
                                                    java.lang.String value)

completed scroll contexts

API name: search.scroll_total

segmentsCount

public final ShardsRecord.Builder segmentsCount(@Nullable
                                                java.lang.String value)

number of segments

API name: segments.count

segmentsMemory

public final ShardsRecord.Builder segmentsMemory(@Nullable
                                                 java.lang.String value)

memory used by segments

API name: segments.memory

segmentsIndexWriterMemory

public final ShardsRecord.Builder segmentsIndexWriterMemory(@Nullable
                                                            java.lang.String value)

memory used by index writer

API name: segments.index_writer_memory

segmentsVersionMapMemory

public final ShardsRecord.Builder segmentsVersionMapMemory(@Nullable
                                                           java.lang.String value)

memory used by version map

API name: segments.version_map_memory

segmentsFixedBitsetMemory

public final ShardsRecord.Builder segmentsFixedBitsetMemory(@Nullable
                                                            java.lang.String value)

memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields

API name: segments.fixed_bitset_memory

seqNoMax

public final ShardsRecord.Builder seqNoMax(@Nullable
                                           java.lang.String value)

max sequence number

API name: seq_no.max

seqNoLocalCheckpoint

public final ShardsRecord.Builder seqNoLocalCheckpoint(@Nullable
                                                       java.lang.String value)

local checkpoint

API name: seq_no.local_checkpoint

seqNoGlobalCheckpoint

public final ShardsRecord.Builder seqNoGlobalCheckpoint(@Nullable
                                                        java.lang.String value)

global checkpoint

API name: seq_no.global_checkpoint

warmerCurrent

public final ShardsRecord.Builder warmerCurrent(@Nullable
                                                java.lang.String value)

current warmer ops

API name: warmer.current

warmerTotal

public final ShardsRecord.Builder warmerTotal(@Nullable
                                              java.lang.String value)

total warmer ops

API name: warmer.total

warmerTotalTime

public final ShardsRecord.Builder warmerTotalTime(@Nullable
                                                  java.lang.String value)

time spent in warmers

API name: warmer.total_time

pathData

public final ShardsRecord.Builder pathData(@Nullable
                                           java.lang.String value)

shard data path

API name: path.data

pathState

public final ShardsRecord.Builder pathState(@Nullable
                                            java.lang.String value)

shard state path

API name: path.state

bulkTotalOperations

public final ShardsRecord.Builder bulkTotalOperations(@Nullable
                                                      java.lang.String value)

number of bulk shard ops

API name: bulk.total_operations

bulkTotalTime

public final ShardsRecord.Builder bulkTotalTime(@Nullable
                                                java.lang.String value)

time spend in shard bulk

API name: bulk.total_time

bulkTotalSizeInBytes

public final ShardsRecord.Builder bulkTotalSizeInBytes(@Nullable
                                                       java.lang.String value)

total size in bytes of shard bulk

API name: bulk.total_size_in_bytes

bulkAvgTime

public final ShardsRecord.Builder bulkAvgTime(@Nullable
                                              java.lang.String value)

average time spend in shard bulk

API name: bulk.avg_time

bulkAvgSizeInBytes

public final ShardsRecord.Builder bulkAvgSizeInBytes(@Nullable
                                                     java.lang.String value)

avg size in bytes of shard bulk

API name: bulk.avg_size_in_bytes

build

public ShardsRecord build()

Builds a ShardsRecord.

Specified by:

build in interface ObjectBuilder<ShardsRecord>

Throws:

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