Package co.elastic.clients.elasticsearch.cat.shards

Class ShardsRecord

java.lang.Object
co.elastic.clients.elasticsearch.cat.shards.ShardsRecord
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class ShardsRecord extends Object implements JsonpSerializable
See Also:

  • Field Details

  • Method Details

    • of

      public static ShardsRecord of(Function<ShardsRecord.Builder,ObjectBuilder<ShardsRecord>> fn)

    • index

      @Nullable public final String index()
      The index name.

      API name: index

    • shard

      @Nullable public final String shard()
      The shard name.

      API name: shard

    • prirep

      @Nullable public final String prirep()
      The shard type: primary or replica.

      API name: prirep

    • state

      @Nullable public final String 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

      @Nullable public final String docs()
      The number of documents in the shard.

      API name: docs

    • store

      @Nullable public final String store()
      The disk space used by the shard.

      API name: store

    • dataset

      @Nullable public final String dataset()
      total size of dataset (including the cache for partially mounted indices)

      API name: dataset

    • ip

      @Nullable public final String ip()
      The IP address of the node.

      API name: ip

    • id

      @Nullable public final String id()
      The unique identifier for the node.

      API name: id

    • node

      @Nullable public final String node()
      The name of node.

      API name: node

    • syncId

      @Nullable public final String syncId()
      The sync identifier.

      API name: sync_id

    • unassignedReason

      @Nullable public final String 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 to NODE_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

      @Nullable public final String unassignedAt()
      The time at which the shard became unassigned in Coordinated Universal Time (UTC).

      API name: unassigned.at

    • unassignedFor

      @Nullable public final String unassignedFor()
      The time at which the shard was requested to be unassigned in Coordinated Universal Time (UTC).

      API name: unassigned.for

    • unassignedDetails

      @Nullable public final String 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

      @Nullable public final String recoverysourceType()
      The type of recovery source.

      API name: recoverysource.type

    • completionSize

      @Nullable public final String completionSize()
      The size of completion.

      API name: completion.size

    • fielddataMemorySize

      @Nullable public final String fielddataMemorySize()
      The used fielddata cache memory.

      API name: fielddata.memory_size

    • fielddataEvictions

      @Nullable public final String fielddataEvictions()
      The fielddata cache evictions.

      API name: fielddata.evictions

    • queryCacheMemorySize

      @Nullable public final String queryCacheMemorySize()
      The used query cache memory.

      API name: query_cache.memory_size

    • queryCacheEvictions

      @Nullable public final String queryCacheEvictions()
      The query cache evictions.

      API name: query_cache.evictions

    • flushTotal

      @Nullable public final String flushTotal()
      The number of flushes.

      API name: flush.total

    • flushTotalTime

      @Nullable public final String flushTotalTime()
      The time spent in flush.

      API name: flush.total_time

    • getCurrent

      @Nullable public final String getCurrent()
      The number of current get operations.

      API name: get.current

    • getTime

      @Nullable public final String getTime()
      The time spent in get operations.

      API name: get.time

    • getTotal

      @Nullable public final String getTotal()
      The number of get operations.

      API name: get.total

    • getExistsTime

      @Nullable public final String getExistsTime()
      The time spent in successful get operations.

      API name: get.exists_time

    • getExistsTotal

      @Nullable public final String getExistsTotal()
      The number of successful get operations.

      API name: get.exists_total

    • getMissingTime

      @Nullable public final String getMissingTime()
      The time spent in failed get operations.

      API name: get.missing_time

    • getMissingTotal

      @Nullable public final String getMissingTotal()
      The number of failed get operations.

      API name: get.missing_total

    • indexingDeleteCurrent

      @Nullable public final String indexingDeleteCurrent()
      The number of current deletion operations.

      API name: indexing.delete_current

    • indexingDeleteTime

      @Nullable public final String indexingDeleteTime()
      The time spent in deletion operations.

      API name: indexing.delete_time

    • indexingDeleteTotal

      @Nullable public final String indexingDeleteTotal()
      The number of delete operations.

      API name: indexing.delete_total

    • indexingIndexCurrent

      @Nullable public final String indexingIndexCurrent()
      The number of current indexing operations.

      API name: indexing.index_current

    • indexingIndexTime

      @Nullable public final String indexingIndexTime()
      The time spent in indexing operations.

      API name: indexing.index_time

    • indexingIndexTotal

      @Nullable public final String indexingIndexTotal()
      The number of indexing operations.

      API name: indexing.index_total

    • indexingIndexFailed

      @Nullable public final String indexingIndexFailed()
      The number of failed indexing operations.

      API name: indexing.index_failed

    • mergesCurrent

      @Nullable public final String mergesCurrent()
      The number of current merge operations.

      API name: merges.current

    • mergesCurrentDocs

      @Nullable public final String mergesCurrentDocs()
      The number of current merging documents.

      API name: merges.current_docs

    • mergesCurrentSize

      @Nullable public final String mergesCurrentSize()
      The size of current merge operations.

      API name: merges.current_size

    • mergesTotal

      @Nullable public final String mergesTotal()
      The number of completed merge operations.

      API name: merges.total

    • mergesTotalDocs

      @Nullable public final String mergesTotalDocs()
      The nuber of merged documents.

      API name: merges.total_docs

    • mergesTotalSize

      @Nullable public final String mergesTotalSize()
      The size of current merges.

      API name: merges.total_size

    • mergesTotalTime

      @Nullable public final String mergesTotalTime()
      The time spent merging documents.

      API name: merges.total_time

    • refreshTotal

      @Nullable public final String refreshTotal()
      The total number of refreshes.

      API name: refresh.total

    • refreshTime

      @Nullable public final String refreshTime()
      The time spent in refreshes.

      API name: refresh.time

    • refreshExternalTotal

      @Nullable public final String refreshExternalTotal()
      The total nunber of external refreshes.

      API name: refresh.external_total

    • refreshExternalTime

      @Nullable public final String refreshExternalTime()
      The time spent in external refreshes.

      API name: refresh.external_time

    • refreshListeners

      @Nullable public final String refreshListeners()
      The number of pending refresh listeners.

      API name: refresh.listeners

    • searchFetchCurrent

      @Nullable public final String searchFetchCurrent()
      The current fetch phase operations.

      API name: search.fetch_current

    • searchFetchTime

      @Nullable public final String searchFetchTime()
      The time spent in fetch phase.

      API name: search.fetch_time

    • searchFetchTotal

      @Nullable public final String searchFetchTotal()
      The total number of fetch operations.

      API name: search.fetch_total

    • searchOpenContexts

      @Nullable public final String searchOpenContexts()
      The number of open search contexts.

      API name: search.open_contexts

    • searchQueryCurrent

      @Nullable public final String searchQueryCurrent()
      The current query phase operations.

      API name: search.query_current

    • searchQueryTime

      @Nullable public final String searchQueryTime()
      The time spent in query phase.

      API name: search.query_time

    • searchQueryTotal

      @Nullable public final String searchQueryTotal()
      The total number of query phase operations.

      API name: search.query_total

    • searchScrollCurrent

      @Nullable public final String searchScrollCurrent()
      The open scroll contexts.

      API name: search.scroll_current

    • searchScrollTime

      @Nullable public final String searchScrollTime()
      The time scroll contexts were held open.

      API name: search.scroll_time

    • searchScrollTotal

      @Nullable public final String searchScrollTotal()
      The number of completed scroll contexts.

      API name: search.scroll_total

    • segmentsCount

      @Nullable public final String segmentsCount()
      The number of segments.

      API name: segments.count

    • segmentsMemory

      @Nullable public final String segmentsMemory()
      The memory used by segments.

      API name: segments.memory

    • segmentsIndexWriterMemory

      @Nullable public final String segmentsIndexWriterMemory()
      The memory used by the index writer.

      API name: segments.index_writer_memory

    • segmentsVersionMapMemory

      @Nullable public final String segmentsVersionMapMemory()
      The memory used by the version map.

      API name: segments.version_map_memory

    • segmentsFixedBitsetMemory

      @Nullable public final String 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

      @Nullable public final String seqNoMax()
      The maximum sequence number.

      API name: seq_no.max

    • seqNoLocalCheckpoint

      @Nullable public final String seqNoLocalCheckpoint()
      The local checkpoint.

      API name: seq_no.local_checkpoint

    • seqNoGlobalCheckpoint

      @Nullable public final String seqNoGlobalCheckpoint()
      The global checkpoint.

      API name: seq_no.global_checkpoint

    • warmerCurrent

      @Nullable public final String warmerCurrent()
      The number of current warmer operations.

      API name: warmer.current

    • warmerTotal

      @Nullable public final String warmerTotal()
      The total number of warmer operations.

      API name: warmer.total

    • warmerTotalTime

      @Nullable public final String warmerTotalTime()
      The time spent in warmer operations.

      API name: warmer.total_time

    • pathData

      @Nullable public final String pathData()
      The shard data path.

      API name: path.data

    • pathState

      @Nullable public final String pathState()
      The shard state path.

      API name: path.state

    • bulkTotalOperations

      @Nullable public final String bulkTotalOperations()
      The number of bulk shard operations.

      API name: bulk.total_operations

    • bulkTotalTime

      @Nullable public final String bulkTotalTime()
      The time spent in shard bulk operations.

      API name: bulk.total_time

    • bulkTotalSizeInBytes

      @Nullable public final String bulkTotalSizeInBytes()
      The total size in bytes of shard bulk operations.

      API name: bulk.total_size_in_bytes

    • bulkAvgTime

      @Nullable public final String bulkAvgTime()
      The average time spent in shard bulk operations.

      API name: bulk.avg_time

    • bulkAvgSizeInBytes

      @Nullable public final String bulkAvgSizeInBytes()
      The average size in bytes of shard bulk operations.

      API name: bulk.avg_size_in_bytes

    • serialize

      public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • setupShardsRecordDeserializer

      protected static void setupShardsRecordDeserializer(ObjectDeserializer<ShardsRecord.Builder> op)