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:
CopyableBuilder<ShardsRecord.Builder,ShardsRecord>, MutableBuilder<ShardsRecord.Builder,ShardsRecord>, ObjectBuilder<ShardsRecord>
Enclosing class:
ShardsRecord
public static class ShardsRecord.Builder extends ObjectBuilderBase implements CopyableBuilder<ShardsRecord.Builder,ShardsRecord>
Builder for ShardsRecord.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • copy

      @Nonnull public ShardsRecord.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<ShardsRecord.Builder,ShardsRecord>
      Returns:
      a new builder instance.

    • bulkAvgSizeInBytes

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

      API name: bulk.avg_size_in_bytes

    • bulkAvgTime

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

      API name: bulk.avg_time

    • bulkTotalOperations

      @Nonnull public final ShardsRecord.Builder bulkTotalOperations(@Nullable String value)
      The number of bulk shard operations.

      API name: bulk.total_operations

    • bulkTotalSizeInBytes

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

      API name: bulk.total_size_in_bytes

    • bulkTotalTime

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

      API name: bulk.total_time

    • completionSize

      @Nonnull public final ShardsRecord.Builder completionSize(@Nullable String value)
      The size of completion.

      API name: completion.size

    • docs

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

      API name: docs

    • docsDeleted

      @Nonnull public final ShardsRecord.Builder docsDeleted(@Nullable String value)
      API name: docs.deleted

    • fielddataEvictions

      @Nonnull public final ShardsRecord.Builder fielddataEvictions(@Nullable String value)
      The field data cache evictions.

      API name: fielddata.evictions

    • fielddataMemorySize

      @Nonnull public final ShardsRecord.Builder fielddataMemorySize(@Nullable String value)
      The used field data cache memory.

      API name: fielddata.memory_size

    • flushTotal

      @Nonnull public final ShardsRecord.Builder flushTotal(@Nullable String value)
      The number of flushes.

      API name: flush.total

    • flushTotalTime

      @Nonnull public final ShardsRecord.Builder flushTotalTime(@Nullable String value)
      The time spent in flush.

      API name: flush.total_time

    • getCurrent

      @Nonnull public final ShardsRecord.Builder getCurrent(@Nullable String value)
      The number of current get operations.

      API name: get.current

    • getExistsTime

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

      API name: get.exists_time

    • getExistsTotal

      @Nonnull public final ShardsRecord.Builder getExistsTotal(@Nullable String value)
      The number of successful get operations.

      API name: get.exists_total

    • getMissingTime

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

      API name: get.missing_time

    • getMissingTotal

      @Nonnull public final ShardsRecord.Builder getMissingTotal(@Nullable String value)
      The number of failed get operations.

      API name: get.missing_total

    • getTime

      @Nonnull public final ShardsRecord.Builder getTime(@Nullable String value)
      The time spent in get operations.

      API name: get.time

    • getTotal

      @Nonnull public final ShardsRecord.Builder getTotal(@Nullable String value)
      The number of get operations.

      API name: get.total

    • id

      @Nonnull public final ShardsRecord.Builder id(@Nullable String value)
      The unique identifier for the node.

      API name: id

    • index

      @Nonnull public final ShardsRecord.Builder index(@Nullable String value)
      The index name.

      API name: index

    • indexingDeleteCurrent

      @Nonnull public final ShardsRecord.Builder indexingDeleteCurrent(@Nullable String value)
      The number of current deletion operations.

      API name: indexing.delete_current

    • indexingDeleteTime

      @Nonnull public final ShardsRecord.Builder indexingDeleteTime(@Nullable String value)
      The time spent in deletion operations.

      API name: indexing.delete_time

    • indexingDeleteTotal

      @Nonnull public final ShardsRecord.Builder indexingDeleteTotal(@Nullable String value)
      The number of delete operations.

      API name: indexing.delete_total

    • indexingIndexCurrent

      @Nonnull public final ShardsRecord.Builder indexingIndexCurrent(@Nullable String value)
      The number of current indexing operations.

      API name: indexing.index_current

    • indexingIndexFailed

      @Nonnull public final ShardsRecord.Builder indexingIndexFailed(@Nullable String value)
      The number of failed indexing operations.

      API name: indexing.index_failed

    • indexingIndexTime

      @Nonnull public final ShardsRecord.Builder indexingIndexTime(@Nullable String value)
      The time spent in indexing operations.

      API name: indexing.index_time

    • indexingIndexTotal

      @Nonnull public final ShardsRecord.Builder indexingIndexTotal(@Nullable String value)
      The number of indexing operations.

      API name: indexing.index_total

    • ip

      @Nonnull public final ShardsRecord.Builder ip(@Nullable String value)
      The IP address of the node.

      API name: ip

    • mergesCurrent

      @Nonnull public final ShardsRecord.Builder mergesCurrent(@Nullable String value)
      The number of current merge operations.

      API name: merges.current

    • mergesCurrentDocs

      @Nonnull public final ShardsRecord.Builder mergesCurrentDocs(@Nullable String value)
      The number of current merging documents.

      API name: merges.current_docs

    • mergesCurrentSize

      @Nonnull public final ShardsRecord.Builder mergesCurrentSize(@Nullable String value)
      The size of current merge operations.

      API name: merges.current_size

    • mergesTotal

      @Nonnull public final ShardsRecord.Builder mergesTotal(@Nullable String value)
      The number of completed merge operations.

      API name: merges.total

    • mergesTotalDocs

      @Nonnull public final ShardsRecord.Builder mergesTotalDocs(@Nullable String value)
      The number of merged documents.

      API name: merges.total_docs

    • mergesTotalSize

      @Nonnull public final ShardsRecord.Builder mergesTotalSize(@Nullable String value)
      The size of current merges.

      API name: merges.total_size

    • mergesTotalTime

      @Nonnull public final ShardsRecord.Builder mergesTotalTime(@Nullable String value)
      The time spent merging documents.

      API name: merges.total_time

    • node

      @Nonnull public final ShardsRecord.Builder node(@Nullable String value)
      The name of node.

      API name: node

    • pathData

      @Nonnull public final ShardsRecord.Builder pathData(@Nullable String value)
      The shard data path.

      API name: path.data

    • pathState

      @Nonnull public final ShardsRecord.Builder pathState(@Nullable String value)
      The shard state path.

      API name: path.state

    • prirep

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

      API name: prirep

    • queryCacheEvictions

      @Nonnull public final ShardsRecord.Builder queryCacheEvictions(@Nullable String value)
      The query cache evictions.

      API name: query_cache.evictions

    • queryCacheMemorySize

      @Nonnull public final ShardsRecord.Builder queryCacheMemorySize(@Nullable String value)
      The used query cache memory.

      API name: query_cache.memory_size

    • recoverysourceType

      @Nonnull public final ShardsRecord.Builder recoverysourceType(@Nullable String value)
      The type of recovery source.

      API name: recoverysource.type

    • refreshExternalTime

      @Nonnull public final ShardsRecord.Builder refreshExternalTime(@Nullable String value)
      The time spent in external refreshes.

      API name: refresh.external_time

    • refreshExternalTotal

      @Nonnull public final ShardsRecord.Builder refreshExternalTotal(@Nullable String value)
      The total number of external refreshes.

      API name: refresh.external_total

    • refreshListeners

      @Nonnull public final ShardsRecord.Builder refreshListeners(@Nullable String value)
      The number of pending refresh listeners.

      API name: refresh.listeners

    • refreshTime

      @Nonnull public final ShardsRecord.Builder refreshTime(@Nullable String value)
      The time spent in refreshes.

      API name: refresh.time

    • refreshTotal

      @Nonnull public final ShardsRecord.Builder refreshTotal(@Nullable String value)
      The total number of refreshes.

      API name: refresh.total

    • searchConcurrentAvgSliceCount

      @Nonnull public final ShardsRecord.Builder searchConcurrentAvgSliceCount(@Nullable String value)
      API name: search.concurrent_avg_slice_count

    • searchConcurrentQueryCurrent

      @Nonnull public final ShardsRecord.Builder searchConcurrentQueryCurrent(@Nullable String value)
      API name: search.concurrent_query_current

    • searchConcurrentQueryTime

      @Nonnull public final ShardsRecord.Builder searchConcurrentQueryTime(@Nullable String value)
      API name: search.concurrent_query_time

    • searchConcurrentQueryTotal

      @Nonnull public final ShardsRecord.Builder searchConcurrentQueryTotal(@Nullable String value)
      API name: search.concurrent_query_total

    • searchFetchCurrent

      @Nonnull public final ShardsRecord.Builder searchFetchCurrent(@Nullable String value)
      The current fetch phase operations.

      API name: search.fetch_current

    • searchFetchTime

      @Nonnull public final ShardsRecord.Builder searchFetchTime(@Nullable String value)
      The time spent in fetch phase.

      API name: search.fetch_time

    • searchFetchTotal

      @Nonnull public final ShardsRecord.Builder searchFetchTotal(@Nullable String value)
      The total number of fetch operations.

      API name: search.fetch_total

    • searchOpenContexts

      @Nonnull public final ShardsRecord.Builder searchOpenContexts(@Nullable String value)
      The number of open search contexts.

      API name: search.open_contexts

    • searchPointInTimeCurrent

      @Nonnull public final ShardsRecord.Builder searchPointInTimeCurrent(@Nullable String value)
      API name: search.point_in_time_current

    • searchPointInTimeTime

      @Nonnull public final ShardsRecord.Builder searchPointInTimeTime(@Nullable String value)
      API name: search.point_in_time_time

    • searchPointInTimeTotal

      @Nonnull public final ShardsRecord.Builder searchPointInTimeTotal(@Nullable String value)
      API name: search.point_in_time_total

    • searchQueryCurrent

      @Nonnull public final ShardsRecord.Builder searchQueryCurrent(@Nullable String value)
      The current query phase operations.

      API name: search.query_current

    • searchQueryTime

      @Nonnull public final ShardsRecord.Builder searchQueryTime(@Nullable String value)
      The time spent in query phase.

      API name: search.query_time

    • searchQueryTotal

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

      API name: search.query_total

    • searchScrollCurrent

      @Nonnull public final ShardsRecord.Builder searchScrollCurrent(@Nullable String value)
      The open scroll contexts.

      API name: search.scroll_current

    • searchScrollTime

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

      API name: search.scroll_time

    • searchScrollTotal

      @Nonnull public final ShardsRecord.Builder searchScrollTotal(@Nullable String value)
      The number of completed scroll contexts.

      API name: search.scroll_total

    • searchSearchIdleReactivateCountTotal

      @Nonnull public final ShardsRecord.Builder searchSearchIdleReactivateCountTotal(@Nullable String value)
      API name: search.search_idle_reactivate_count_total

    • segmentsCount

      @Nonnull public final ShardsRecord.Builder segmentsCount(@Nullable String value)
      The number of segments.

      API name: segments.count

    • segmentsFixedBitsetMemory

      @Nonnull public final ShardsRecord.Builder segmentsFixedBitsetMemory(@Nullable String value)
      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

    • segmentsIndexWriterMemory

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

      API name: segments.index_writer_memory

    • segmentsMemory

      @Nonnull public final ShardsRecord.Builder segmentsMemory(@Nullable String value)
      The memory used by segments.

      API name: segments.memory

    • segmentsVersionMapMemory

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

      API name: segments.version_map_memory

    • seqNoGlobalCheckpoint

      @Nonnull public final ShardsRecord.Builder seqNoGlobalCheckpoint(@Nullable String value)
      The global checkpoint.

      API name: seq_no.global_checkpoint

    • seqNoLocalCheckpoint

      @Nonnull public final ShardsRecord.Builder seqNoLocalCheckpoint(@Nullable String value)
      The local checkpoint.

      API name: seq_no.local_checkpoint

    • seqNoMax

      @Nonnull public final ShardsRecord.Builder seqNoMax(@Nullable String value)
      The maximum sequence number.

      API name: seq_no.max

    • shard

      @Nonnull public final ShardsRecord.Builder shard(@Nullable String value)
      The shard name.

      API name: shard

    • state

      @Nonnull public final ShardsRecord.Builder state(@Nullable String value)
      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

    • store

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

      API name: store

    • syncId

      @Nonnull public final ShardsRecord.Builder syncId(@Nullable String value)
      The sync identifier.

      API name: sync_id

    • unassignedAt

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

      API name: unassigned.at

    • unassignedDetails

      @Nonnull public final ShardsRecord.Builder unassignedDetails(@Nullable String value)
      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

    • unassignedFor

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

      API name: unassigned.for

    • unassignedReason

      @Nonnull public final ShardsRecord.Builder unassignedReason(@Nullable String value)
      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

    • warmerCurrent

      @Nonnull public final ShardsRecord.Builder warmerCurrent(@Nullable String value)
      The number of current warmer operations.

      API name: warmer.current

    • warmerTotal

      @Nonnull public final ShardsRecord.Builder warmerTotal(@Nullable String value)
      The total number of warmer operations.

      API name: warmer.total

    • warmerTotalTime

      @Nonnull public final ShardsRecord.Builder warmerTotalTime(@Nullable String value)
      The time spent in warmer operations.

      API name: warmer.total_time

    • build

      @Nonnull public ShardsRecord build()
      Builds a ShardsRecord.
      Specified by:
      build in interface ObjectBuilder<ShardsRecord>
      Throws:
      NullPointerException - if some of the required fields are null.