Class NodesRecord.Builder

java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch.cat.nodes.NodesRecord.Builder
All Implemented Interfaces:
CopyableBuilder<NodesRecord.Builder,NodesRecord>, MutableBuilder<NodesRecord.Builder,NodesRecord>, ObjectBuilder<NodesRecord>
Enclosing class:
NodesRecord

public static class NodesRecord.Builder extends ObjectBuilderBase implements CopyableBuilder<NodesRecord.Builder,NodesRecord>
Builder for NodesRecord.
  • Constructor Details

    • Builder

      public Builder()
  • Method Details

    • copy

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

      @Nonnull public final NodesRecord.Builder build(@Nullable String value)
      The OpenSearch build hash.

      API name: build

    • bulkAvgSizeInBytes

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

      API name: bulk.avg_size_in_bytes

    • bulkAvgTime

      @Nonnull public final NodesRecord.Builder bulkAvgTime(@Nullable String value)
      The average time spend in shard bulk.

      API name: bulk.avg_time

    • bulkTotalOperations

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

      API name: bulk.total_operations

    • bulkTotalSizeInBytes

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

      API name: bulk.total_size_in_bytes

    • bulkTotalTime

      @Nonnull public final NodesRecord.Builder bulkTotalTime(@Nullable String value)
      The time spend in shard bulk.

      API name: bulk.total_time

    • clusterManager

      @Nonnull public final NodesRecord.Builder clusterManager(@Nullable String value)
      Indicates whether the node is the elected cluster-manager node. Returned values include *(elected cluster-manager) and -(not elected cluster-manager).

      API name: cluster_manager

    • completionSize

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

      API name: completion.size

    • cpu

      @Nonnull public final NodesRecord.Builder cpu(@Nullable String value)
      The recent system CPU usage as a percentage.

      API name: cpu

    • diskAvail

      @Nonnull public final NodesRecord.Builder diskAvail(@Nullable String value)
      API name: disk.avail
    • diskTotal

      @Nonnull public final NodesRecord.Builder diskTotal(@Nullable String value)
      API name: disk.total
    • diskUsed

      @Nonnull public final NodesRecord.Builder diskUsed(@Nullable String value)
      API name: disk.used
    • diskUsedPercent

      @Nonnull public final NodesRecord.Builder diskUsedPercent(@Nullable String value)
      API name: disk.used_percent
    • fielddataEvictions

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

      API name: fielddata.evictions

    • fielddataMemorySize

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

      API name: fielddata.memory_size

    • fileDescCurrent

      @Nonnull public final NodesRecord.Builder fileDescCurrent(@Nullable String value)
      The used file descriptors.

      API name: file_desc.current

    • fileDescMax

      @Nonnull public final NodesRecord.Builder fileDescMax(@Nullable String value)
      The maximum number of file descriptors.

      API name: file_desc.max

    • fileDescPercent

      @Nonnull public final NodesRecord.Builder fileDescPercent(@Nullable String value)
      API name: file_desc.percent
    • flavor

      @Nonnull public final NodesRecord.Builder flavor(@Nullable String value)
      The OpenSearch distribution flavor.

      API name: flavor

    • flushTotal

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

      API name: flush.total

    • flushTotalTime

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

      API name: flush.total_time

    • getCurrent

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

      API name: get.current

    • getExistsTime

      @Nonnull public final NodesRecord.Builder getExistsTime(@Nullable String value)
      The time spent in successful gets.

      API name: get.exists_time

    • getExistsTotal

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

      API name: get.exists_total

    • getMissingTime

      @Nonnull public final NodesRecord.Builder getMissingTime(@Nullable String value)
      The time spent in failed gets.

      API name: get.missing_time

    • getMissingTotal

      @Nonnull public final NodesRecord.Builder getMissingTotal(@Nullable String value)
      The number of failed gets.

      API name: get.missing_total

    • getTime

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

      API name: get.time

    • getTotal

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

      API name: get.total

    • heapCurrent

      @Nonnull public final NodesRecord.Builder heapCurrent(@Nullable String value)
      The used heap.

      API name: heap.current

    • heapMax

      @Nonnull public final NodesRecord.Builder heapMax(@Nullable String value)
      The maximum configured heap.

      API name: heap.max

    • heapPercent

      @Nonnull public final NodesRecord.Builder heapPercent(@Nullable String value)
      API name: heap.percent
    • httpAddress

      @Nonnull public final NodesRecord.Builder httpAddress(@Nullable String value)
      The bound HTTP address.

      API name: http_address

    • id

      @Nonnull public final NodesRecord.Builder id(@Nullable String value)
      API name: id
    • indexingDeleteCurrent

      @Nonnull public final NodesRecord.Builder indexingDeleteCurrent(@Nullable String value)
      The number of current deletions.

      API name: indexing.delete_current

    • indexingDeleteTime

      @Nonnull public final NodesRecord.Builder indexingDeleteTime(@Nullable String value)
      The time spent in deletions.

      API name: indexing.delete_time

    • indexingDeleteTotal

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

      API name: indexing.delete_total

    • indexingIndexCurrent

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

      API name: indexing.index_current

    • indexingIndexFailed

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

      API name: indexing.index_failed

    • indexingIndexTime

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

      API name: indexing.index_time

    • indexingIndexTotal

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

      API name: indexing.index_total

    • ip

      @Nonnull public final NodesRecord.Builder ip(@Nullable String value)
      The IP address.

      API name: ip

    • jdk

      @Nonnull public final NodesRecord.Builder jdk(@Nullable String value)
      The Java version.

      API name: jdk

    • load15m

      @Nonnull public final NodesRecord.Builder load15m(@Nullable String value)
      The load average for the last fifteen minutes.

      API name: load_15m

    • load1m

      @Nonnull public final NodesRecord.Builder load1m(@Nullable String value)
      The load average for the most recent minute.

      API name: load_1m

    • load5m

      @Nonnull public final NodesRecord.Builder load5m(@Nullable String value)
      The load average for the last five minutes.

      API name: load_5m

    • master

      @Nonnull public final NodesRecord.Builder master(@Nullable String value)
      Indicates whether the node is the elected cluster-manager node. Returned values include *(elected cluster manager) and -(not elected cluster manager).

      API name: master

    • mergesCurrent

      @Nonnull public final NodesRecord.Builder mergesCurrent(@Nullable String value)
      The number of current merges.

      API name: merges.current

    • mergesCurrentDocs

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

      API name: merges.current_docs

    • mergesCurrentSize

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

      API name: merges.current_size

    • mergesTotal

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

      API name: merges.total

    • mergesTotalDocs

      @Nonnull public final NodesRecord.Builder mergesTotalDocs(@Nullable String value)
      The docs merged.

      API name: merges.total_docs

    • mergesTotalSize

      @Nonnull public final NodesRecord.Builder mergesTotalSize(@Nullable String value)
      The size merged.

      API name: merges.total_size

    • mergesTotalTime

      @Nonnull public final NodesRecord.Builder mergesTotalTime(@Nullable String value)
      The time spent in merges.

      API name: merges.total_time

    • name

      @Nonnull public final NodesRecord.Builder name(@Nullable String value)
      API name: name
    • nodeRole

      @Nonnull public final NodesRecord.Builder nodeRole(@Nullable String value)
      The roles of the node. Returned values include c(cold node), d(data node), f(frozen node), h(hot node), i(ingest node), l(machine learning node), m (cluster-manager eligible node), r(remote cluster client node), s(content node), t(transform node), v(voting-only node), w(warm node),and -(coordinating node only).

      API name: node.role

    • nodeRoles

      @Nonnull public final NodesRecord.Builder nodeRoles(@Nullable String value)
      A comma-separated list of the roles of the node. Returned values may include but are not limited to: data, ingest, master, cluster_manager, remote_cluster_client, search, and -(coordinating node only).

      API name: node.roles

    • pid

      @Nonnull public final NodesRecord.Builder pid(@Nullable String value)
      The process identifier.

      API name: pid

    • port

      @Nonnull public final NodesRecord.Builder port(@Nullable String value)
      The bound transport port.

      API name: port

    • queryCacheEvictions

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

      API name: query_cache.evictions

    • queryCacheHitCount

      @Nonnull public final NodesRecord.Builder queryCacheHitCount(@Nullable String value)
      The query cache hit counts.

      API name: query_cache.hit_count

    • queryCacheMemorySize

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

      API name: query_cache.memory_size

    • queryCacheMissCount

      @Nonnull public final NodesRecord.Builder queryCacheMissCount(@Nullable String value)
      The query cache miss counts.

      API name: query_cache.miss_count

    • ramCurrent

      @Nonnull public final NodesRecord.Builder ramCurrent(@Nullable String value)
      The used machine memory.

      API name: ram.current

    • ramMax

      @Nonnull public final NodesRecord.Builder ramMax(@Nullable String value)
      The total machine memory.

      API name: ram.max

    • ramPercent

      @Nonnull public final NodesRecord.Builder ramPercent(@Nullable String value)
      API name: ram.percent
    • refreshExternalTime

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

      API name: refresh.external_time

    • refreshExternalTotal

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

      API name: refresh.external_total

    • refreshListeners

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

      API name: refresh.listeners

    • refreshTime

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

      API name: refresh.time

    • refreshTotal

      @Nonnull public final NodesRecord.Builder refreshTotal(@Nullable String value)
      The total refreshes.

      API name: refresh.total

    • requestCacheEvictions

      @Nonnull public final NodesRecord.Builder requestCacheEvictions(@Nullable String value)
      The request cache evictions.

      API name: request_cache.evictions

    • requestCacheHitCount

      @Nonnull public final NodesRecord.Builder requestCacheHitCount(@Nullable String value)
      The request cache hit counts.

      API name: request_cache.hit_count

    • requestCacheMemorySize

      @Nonnull public final NodesRecord.Builder requestCacheMemorySize(@Nullable String value)
      The used request cache.

      API name: request_cache.memory_size

    • requestCacheMissCount

      @Nonnull public final NodesRecord.Builder requestCacheMissCount(@Nullable String value)
      The request cache miss counts.

      API name: request_cache.miss_count

    • scriptCacheEvictions

      @Nonnull public final NodesRecord.Builder scriptCacheEvictions(@Nullable String value)
      The total compiled scripts evicted from the cache.

      API name: script.cache_evictions

    • scriptCompilationLimitTriggered

      @Nonnull public final NodesRecord.Builder scriptCompilationLimitTriggered(@Nullable String value)
      The script cache compilation limit triggered.

      API name: script.compilation_limit_triggered

    • scriptCompilations

      @Nonnull public final NodesRecord.Builder scriptCompilations(@Nullable String value)
      The total script compilations.

      API name: script.compilations

    • searchConcurrentAvgSliceCount

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

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

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

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

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

      API name: search.fetch_current

    • searchFetchTime

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

      API name: search.fetch_time

    • searchFetchTotal

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

      API name: search.fetch_total

    • searchOpenContexts

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

      API name: search.open_contexts

    • searchPointInTimeCurrent

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

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

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

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

      API name: search.query_current

    • searchQueryTime

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

      API name: search.query_time

    • searchQueryTotal

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

      API name: search.query_total

    • searchScrollCurrent

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

      API name: search.scroll_current

    • searchScrollTime

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

      API name: search.scroll_time

    • searchScrollTotal

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

      API name: search.scroll_total

    • segmentsCount

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

      API name: segments.count

    • segmentsFixedBitsetMemory

      @Nonnull public final NodesRecord.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 NodesRecord.Builder segmentsIndexWriterMemory(@Nullable String value)
      The memory used by the index writer.

      API name: segments.index_writer_memory

    • segmentsMemory

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

      API name: segments.memory

    • segmentsVersionMapMemory

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

      API name: segments.version_map_memory

    • suggestCurrent

      @Nonnull public final NodesRecord.Builder suggestCurrent(@Nullable String value)
      The number of current suggest operations.

      API name: suggest.current

    • suggestTime

      @Nonnull public final NodesRecord.Builder suggestTime(@Nullable String value)
      The time spend in suggest.

      API name: suggest.time

    • suggestTotal

      @Nonnull public final NodesRecord.Builder suggestTotal(@Nullable String value)
      The number of suggest operations.

      API name: suggest.total

    • type

      @Nonnull public final NodesRecord.Builder type(@Nullable String value)
      The OpenSearch distribution type.

      API name: type

    • uptime

      @Nonnull public final NodesRecord.Builder uptime(@Nullable String value)
      The node uptime.

      API name: uptime

    • version

      @Nonnull public final NodesRecord.Builder version(@Nullable String value)
      API name: version
    • build

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