Class ShardsRecord.Builder
- All Implemented Interfaces:
WithJson<ShardsRecord.Builder>
,ObjectBuilder<ShardsRecord>
- Enclosing class:
- ShardsRecord
ShardsRecord
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aShardsRecord
.final ShardsRecord.Builder
bulkAvgSizeInBytes
(String value) The average size in bytes of shard bulk operations.final ShardsRecord.Builder
bulkAvgTime
(String value) The average time spent in shard bulk operations.final ShardsRecord.Builder
bulkTotalOperations
(String value) The number of bulk shard operations.final ShardsRecord.Builder
bulkTotalSizeInBytes
(String value) The total size in bytes of shard bulk operations.final ShardsRecord.Builder
bulkTotalTime
(String value) The time spent in shard bulk operations.final ShardsRecord.Builder
completionSize
(String value) The size of completion.final ShardsRecord.Builder
The number of documents in the shard.final ShardsRecord.Builder
fielddataEvictions
(String value) The fielddata cache evictions.final ShardsRecord.Builder
fielddataMemorySize
(String value) The used fielddata cache memory.final ShardsRecord.Builder
flushTotal
(String value) The number of flushes.final ShardsRecord.Builder
flushTotalTime
(String value) The time spent in flush.final ShardsRecord.Builder
getCurrent
(String value) The number of current get operations.final ShardsRecord.Builder
getExistsTime
(String value) The time spent in successful get operations.final ShardsRecord.Builder
getExistsTotal
(String value) The number of successful get operations.final ShardsRecord.Builder
getMissingTime
(String value) The time spent in failed get operations.final ShardsRecord.Builder
getMissingTotal
(String value) The number of failed get operations.final ShardsRecord.Builder
The time spent in get operations.final ShardsRecord.Builder
The number of get operations.final ShardsRecord.Builder
The unique identifier for the node.final ShardsRecord.Builder
The index name.final ShardsRecord.Builder
indexingDeleteCurrent
(String value) The number of current deletion operations.final ShardsRecord.Builder
indexingDeleteTime
(String value) The time spent in deletion operations.final ShardsRecord.Builder
indexingDeleteTotal
(String value) The number of delete operations.final ShardsRecord.Builder
indexingIndexCurrent
(String value) The number of current indexing operations.final ShardsRecord.Builder
indexingIndexFailed
(String value) The number of failed indexing operations.final ShardsRecord.Builder
indexingIndexTime
(String value) The time spent in indexing operations.final ShardsRecord.Builder
indexingIndexTotal
(String value) The number of indexing operations.final ShardsRecord.Builder
The IP address of the node.final ShardsRecord.Builder
mergesCurrent
(String value) The number of current merge operations.final ShardsRecord.Builder
mergesCurrentDocs
(String value) The number of current merging documents.final ShardsRecord.Builder
mergesCurrentSize
(String value) The size of current merge operations.final ShardsRecord.Builder
mergesTotal
(String value) The number of completed merge operations.final ShardsRecord.Builder
mergesTotalDocs
(String value) The nuber of merged documents.final ShardsRecord.Builder
mergesTotalSize
(String value) The size of current merges.final ShardsRecord.Builder
mergesTotalTime
(String value) The time spent merging documents.final ShardsRecord.Builder
The name of node.final ShardsRecord.Builder
The shard data path.final ShardsRecord.Builder
The shard state path.final ShardsRecord.Builder
The shard type:primary
orreplica
.final ShardsRecord.Builder
queryCacheEvictions
(String value) The query cache evictions.final ShardsRecord.Builder
queryCacheMemorySize
(String value) The used query cache memory.final ShardsRecord.Builder
recoverysourceType
(String value) The type of recovery source.final ShardsRecord.Builder
refreshExternalTime
(String value) The time spent in external refreshes.final ShardsRecord.Builder
refreshExternalTotal
(String value) The total nunber of external refreshes.final ShardsRecord.Builder
refreshListeners
(String value) The number of pending refresh listeners.final ShardsRecord.Builder
refreshTime
(String value) The time spent in refreshes.final ShardsRecord.Builder
refreshTotal
(String value) The total number of refreshes.final ShardsRecord.Builder
searchFetchCurrent
(String value) The current fetch phase operations.final ShardsRecord.Builder
searchFetchTime
(String value) The time spent in fetch phase.final ShardsRecord.Builder
searchFetchTotal
(String value) The total number of fetch operations.final ShardsRecord.Builder
searchOpenContexts
(String value) The number of open search contexts.final ShardsRecord.Builder
searchQueryCurrent
(String value) The current query phase operations.final ShardsRecord.Builder
searchQueryTime
(String value) The time spent in query phase.final ShardsRecord.Builder
searchQueryTotal
(String value) The total number of query phase operations.final ShardsRecord.Builder
searchScrollCurrent
(String value) The open scroll contexts.final ShardsRecord.Builder
searchScrollTime
(String value) The time scroll contexts were held open.final ShardsRecord.Builder
searchScrollTotal
(String value) The number of completed scroll contexts.final ShardsRecord.Builder
segmentsCount
(String value) The number of segments.final ShardsRecord.Builder
segmentsFixedBitsetMemory
(String value) The memory used by fixed bit sets for nested object field types and export type filters for types referred in_parent
fields.final ShardsRecord.Builder
segmentsIndexWriterMemory
(String value) The memory used by the index writer.final ShardsRecord.Builder
segmentsMemory
(String value) The memory used by segments.final ShardsRecord.Builder
segmentsVersionMapMemory
(String value) The memory used by the version map.protected ShardsRecord.Builder
self()
final ShardsRecord.Builder
seqNoGlobalCheckpoint
(String value) The global checkpoint.final ShardsRecord.Builder
seqNoLocalCheckpoint
(String value) The local checkpoint.final ShardsRecord.Builder
The maximum sequence number.final ShardsRecord.Builder
The shard name.final ShardsRecord.Builder
The shard state.final ShardsRecord.Builder
The disk space used by the shard.final ShardsRecord.Builder
The sync identifier.final ShardsRecord.Builder
unassignedAt
(String value) The time at which the shard became unassigned in Coordinated Universal Time (UTC).final ShardsRecord.Builder
unassignedDetails
(String value) Additional details as to why the shard became unassigned.final ShardsRecord.Builder
unassignedFor
(String value) The time at which the shard was requested to be unassigned in Coordinated Universal Time (UTC).final ShardsRecord.Builder
unassignedReason
(String value) The reason for the last change to the state of an unassigned shard.final ShardsRecord.Builder
warmerCurrent
(String value) The number of current warmer operations.final ShardsRecord.Builder
warmerTotal
(String value) The total number of warmer operations.final ShardsRecord.Builder
warmerTotalTime
(String value) The time spent in warmer operations.Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
index
The index name.API name:
index
-
shard
The shard name.API name:
shard
-
prirep
The shard type:primary
orreplica
.API name:
prirep
-
state
The shard state. Returned values include:INITIALIZING
: The shard is recovering from a peer shard or gateway.RELOCATING
: The shard is relocating.STARTED
: The shard has started.UNASSIGNED
: The shard is not assigned to any node.API name:
state
-
docs
The number of documents in the shard.API name:
docs
-
store
The disk space used by the shard.API name:
store
-
ip
The IP address of the node.API name:
ip
-
id
The unique identifier for the node.API name:
id
-
node
The name of node.API name:
node
-
syncId
The sync identifier.API name:
sync_id
-
unassignedReason
The reason for the last change to the state of an unassigned shard. It does not explain why the shard is currently unassigned; use the cluster allocation explain API for that information. Returned values include:ALLOCATION_FAILED
: Unassigned as a result of a failed allocation of the shard.CLUSTER_RECOVERED
: Unassigned as a result of a full cluster recovery.DANGLING_INDEX_IMPORTED
: Unassigned as a result of importing a dangling index.EXISTING_INDEX_RESTORED
: Unassigned as a result of restoring into a closed index.FORCED_EMPTY_PRIMARY
: The shard’s allocation was last modified by forcing an empty primary using the cluster reroute API.INDEX_CLOSED
: Unassigned because the index was closed.INDEX_CREATED
: Unassigned as a result of an API creation of an index.INDEX_REOPENED
: Unassigned as a result of opening a closed index.MANUAL_ALLOCATION
: The shard’s allocation was last modified by the cluster reroute API.NEW_INDEX_RESTORED
: Unassigned as a result of restoring into a new index.NODE_LEFT
: Unassigned as a result of the node hosting it leaving the cluster.NODE_RESTARTING
: Similar toNODE_LEFT
, except that the node was registered as restarting using the node shutdown API.PRIMARY_FAILED
: The shard was initializing as a replica, but the primary shard failed before the initialization completed.REALLOCATED_REPLICA
: A better replica location is identified and causes the existing replica allocation to be cancelled.REINITIALIZED
: When a shard moves from started back to initializing.REPLICA_ADDED
: Unassigned as a result of explicit addition of a replica.REROUTE_CANCELLED
: Unassigned as a result of explicit cancel reroute command.API name:
unassigned.reason
-
unassignedAt
The time at which the shard became unassigned in Coordinated Universal Time (UTC).API name:
unassigned.at
-
unassignedFor
The time at which the shard was requested to be unassigned in Coordinated Universal Time (UTC).API name:
unassigned.for
-
unassignedDetails
Additional details as to why the shard became unassigned. It does not explain why the shard is not assigned; use the cluster allocation explain API for that information.API name:
unassigned.details
-
recoverysourceType
The type of recovery source.API name:
recoverysource.type
-
completionSize
The size of completion.API name:
completion.size
-
fielddataMemorySize
The used fielddata cache memory.API name:
fielddata.memory_size
-
fielddataEvictions
The fielddata cache evictions.API name:
fielddata.evictions
-
queryCacheMemorySize
The used query cache memory.API name:
query_cache.memory_size
-
queryCacheEvictions
The query cache evictions.API name:
query_cache.evictions
-
flushTotal
The number of flushes.API name:
flush.total
-
flushTotalTime
The time spent in flush.API name:
flush.total_time
-
getCurrent
The number of current get operations.API name:
get.current
-
getTime
The time spent in get operations.API name:
get.time
-
getTotal
The number of get operations.API name:
get.total
-
getExistsTime
The time spent in successful get operations.API name:
get.exists_time
-
getExistsTotal
The number of successful get operations.API name:
get.exists_total
-
getMissingTime
The time spent in failed get operations.API name:
get.missing_time
-
getMissingTotal
The number of failed get operations.API name:
get.missing_total
-
indexingDeleteCurrent
The number of current deletion operations.API name:
indexing.delete_current
-
indexingDeleteTime
The time spent in deletion operations.API name:
indexing.delete_time
-
indexingDeleteTotal
The number of delete operations.API name:
indexing.delete_total
-
indexingIndexCurrent
The number of current indexing operations.API name:
indexing.index_current
-
indexingIndexTime
The time spent in indexing operations.API name:
indexing.index_time
-
indexingIndexTotal
The number of indexing operations.API name:
indexing.index_total
-
indexingIndexFailed
The number of failed indexing operations.API name:
indexing.index_failed
-
mergesCurrent
The number of current merge operations.API name:
merges.current
-
mergesCurrentDocs
The number of current merging documents.API name:
merges.current_docs
-
mergesCurrentSize
The size of current merge operations.API name:
merges.current_size
-
mergesTotal
The number of completed merge operations.API name:
merges.total
-
mergesTotalDocs
The nuber of merged documents.API name:
merges.total_docs
-
mergesTotalSize
The size of current merges.API name:
merges.total_size
-
mergesTotalTime
The time spent merging documents.API name:
merges.total_time
-
refreshTotal
The total number of refreshes.API name:
refresh.total
-
refreshTime
The time spent in refreshes.API name:
refresh.time
-
refreshExternalTotal
The total nunber of external refreshes.API name:
refresh.external_total
-
refreshExternalTime
The time spent in external refreshes.API name:
refresh.external_time
-
refreshListeners
The number of pending refresh listeners.API name:
refresh.listeners
-
searchFetchCurrent
The current fetch phase operations.API name:
search.fetch_current
-
searchFetchTime
The time spent in fetch phase.API name:
search.fetch_time
-
searchFetchTotal
The total number of fetch operations.API name:
search.fetch_total
-
searchOpenContexts
The number of open search contexts.API name:
search.open_contexts
-
searchQueryCurrent
The current query phase operations.API name:
search.query_current
-
searchQueryTime
The time spent in query phase.API name:
search.query_time
-
searchQueryTotal
The total number of query phase operations.API name:
search.query_total
-
searchScrollCurrent
The open scroll contexts.API name:
search.scroll_current
-
searchScrollTime
The time scroll contexts were held open.API name:
search.scroll_time
-
searchScrollTotal
The number of completed scroll contexts.API name:
search.scroll_total
-
segmentsCount
The number of segments.API name:
segments.count
-
segmentsMemory
The memory used by segments.API name:
segments.memory
-
segmentsIndexWriterMemory
The memory used by the index writer.API name:
segments.index_writer_memory
-
segmentsVersionMapMemory
The memory used by the version map.API name:
segments.version_map_memory
-
segmentsFixedBitsetMemory
The 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
The maximum sequence number.API name:
seq_no.max
-
seqNoLocalCheckpoint
The local checkpoint.API name:
seq_no.local_checkpoint
-
seqNoGlobalCheckpoint
The global checkpoint.API name:
seq_no.global_checkpoint
-
warmerCurrent
The number of current warmer operations.API name:
warmer.current
-
warmerTotal
The total number of warmer operations.API name:
warmer.total
-
warmerTotalTime
The time spent in warmer operations.API name:
warmer.total_time
-
pathData
The shard data path.API name:
path.data
-
pathState
The shard state path.API name:
path.state
-
bulkTotalOperations
The number of bulk shard operations.API name:
bulk.total_operations
-
bulkTotalTime
The time spent in shard bulk operations.API name:
bulk.total_time
-
bulkTotalSizeInBytes
The total size in bytes of shard bulk operations.API name:
bulk.total_size_in_bytes
-
bulkAvgTime
The average time spent in shard bulk operations.API name:
bulk.avg_time
-
bulkAvgSizeInBytes
The average size in bytes of shard bulk operations.API name:
bulk.avg_size_in_bytes
-
self
- Specified by:
self
in classWithJsonObjectBuilderBase<ShardsRecord.Builder>
-
build
Builds aShardsRecord
.- Specified by:
build
in interfaceObjectBuilder<ShardsRecord>
- Throws:
NullPointerException
- if some of the required fields are null.
-