From 646a4cc94f1cbb201bd893f1923d0e8967ddd4f9 Mon Sep 17 00:00:00 2001 From: kosabogi Date: Wed, 27 Aug 2025 13:14:09 +0200 Subject: [PATCH 1/3] WIP: temporary changes for cat-h-values --- specification/cat/_types/CatBase.ts | 79 +++++++++++++++++++++++++++++ 1 file changed, 79 insertions(+) diff --git a/specification/cat/_types/CatBase.ts b/specification/cat/_types/CatBase.ts index 5a5242a6b8..4c879cb44d 100644 --- a/specification/cat/_types/CatBase.ts +++ b/specification/cat/_types/CatBase.ts @@ -1471,6 +1471,85 @@ export enum CatFieldDataColumn { size } +/** @non_exhaustive */ +export enum CatHealthColumn { + /** + * The number of seconds since 1970-01-01 00:00:00. + * @aliases t, time + */ + epoch, + /** + * The time in HH:MM:SS format. + * @aliases ts, hms, hhmmss + */ + timestamp, + /** + * The cluster name. + * @aliases cl + */ + cluster, + /** + * The health status. + * @aliases st + */ + status, + /** + * The total number of nodes. + * @aliases nt, nodeTotal + */ + 'node.total', + /** + * The number of nodes that can store data. + * @aliases nd, nodeData + */ + 'node.data', + /** + * The total number of shards. + * @aliases t, sh, shards.total, shardsTotal + */ + shards, + /** + * The number of primary shards. + * @aliases p, shards.primary, shardsPrimary + */ + pri, + /** + * The number of relocating nodes. + * @aliases r, shards.relocating, shardsRelocating + */ + relo, + /** + * The number of initializing nodes. + * @aliases i, shards.initializing, shardsInitializing + */ + init, + /** + * The number of unassigned shards. + * @aliases u, shards.unassigned, shardsUnassigned + */ + unassign, + /** + * The number of unassigned primary shards. + * @aliases up, shards.unassigned.primary, shardsUnassignedPrimary + */ + 'unassign.pri', + /** + * The number of pending tasks. + * @aliases pt, pendingTasks + */ + pending_tasks, + /** + * The wait time of the longest pending task. + * @aliases mtwt, maxTaskWaitTime + */ + max_task_wait_time, + /** + * The percentage of active shards. + * @aliases asp, activeShardsPercent + */ + active_shards_percent +} + export type CatDfaColumns = CatDfaColumn | CatDfaColumn[] export type CatDatafeedColumns = CatDatafeedColumn | CatDatafeedColumn[] export type CatNodeColumns = CatNodeColumn | CatNodeColumn[] From 8c1322acd8baf7d47dd65836e60e2162ad18c480 Mon Sep 17 00:00:00 2001 From: kosabogi Date: Wed, 27 Aug 2025 13:18:25 +0200 Subject: [PATCH 2/3] Save remaining changes to CatBase.ts --- specification/cat/_types/CatBase.ts | 698 +++++++++++++++++++++++++++- 1 file changed, 697 insertions(+), 1 deletion(-) diff --git a/specification/cat/_types/CatBase.ts b/specification/cat/_types/CatBase.ts index 4c879cb44d..e9a13a166d 100644 --- a/specification/cat/_types/CatBase.ts +++ b/specification/cat/_types/CatBase.ts @@ -1494,7 +1494,7 @@ export enum CatHealthColumn { */ status, /** - * The total number of nodes. + * The total number of nodes that can store data. * @aliases nt, nodeTotal */ 'node.total', @@ -1550,6 +1550,702 @@ export enum CatHealthColumn { active_shards_percent } +/** @non_exhaustive */ +export enum CatIndicesColumn { + /** + * The current health status. + * @aliases h + */ + health, + /** + * The open/close status. + * @aliases s + */ + status, + /** + * The index name. + * @aliases i, idx + */ + index, + /** + * The index UUID. + * @aliases id, uuid + */ + uuid, + /** + * The number of primary shards. + * @aliases p, shards.primary, shardsPrimary + */ + pri, + /** + * The number of replica shards. + * @aliases r, shards.replica, shardsReplica + */ + rep, + /** + * The number of available documents. + * @aliases dc, docsCount + */ + 'docs.count', + /** + * The number of deleted documents. + * @aliases dd, docsDeleted + */ + 'docs.deleted', + /** + * The index creation date (millisecond value). + * @aliases cd + */ + 'creation.date', + /** + * The index creation date (as string). + * @aliases cds + */ + 'creation.date.string', + /** + * The store size of primaries and replicas. + * @aliases ss, storeSize + */ + 'store.size', + /** + * The store size of primaries. + */ + 'pri.store.size', + /** + * The total size of the dataset. + */ + 'dataset.size', + /** + * The size of completion. + * @aliases cs, completionSize + */ + 'completion.size', + /** + * The size of completion. + */ + 'pri.completion.size', + /** + * The used fielddata cache. + * @aliases fm, fielddataMemory + */ + 'fielddata.memory_size', + /** + * The used fielddata cache. + */ + 'pri.fielddata.memory_size', + /** + * The number of fielddata evictions. + * @aliases fe, fielddataEvictions + */ + 'fielddata.evictions', + /** + * The number of fielddata evictions. + */ + 'pri.fielddata.evictions', + /** + * The used query cache. + * @aliases qcm, queryCacheMemory + */ + 'query_cache.memory_size', + /** + * The used query cache. + */ + 'pri.query_cache.memory_size', + /** + * The number of query cache evictions. + * @aliases qce, queryCacheEvictions + */ + 'query_cache.evictions', + /** + * The number of query cache evictions. + */ + 'pri.query_cache.evictions', + /** + * The used request cache. + * @aliases rcm, requestCacheMemory + */ + 'request_cache.memory_size', + /** + * The used request cache. + */ + 'pri.request_cache.memory_size', + /** + * The number of request cache evictions. + * @aliases rce, requestCacheEvictions + */ + 'request_cache.evictions', + /** + * The number of request cache evictions. + */ + 'pri.request_cache.evictions', + /** + * The request cache hit count. + * @aliases rchc, requestCacheHitCount + */ + 'request_cache.hit_count', + /** + * The request cache hit count. + */ + 'pri.request_cache.hit_count', + /** + * The request cache miss count. + * @aliases rcmc, requestCacheMissCount + */ + 'request_cache.miss_count', + /** + * The request cache miss count. + */ + 'pri.request_cache.miss_count', + /** + * The number of flushes. + * @aliases ft, flushTotal + */ + 'flush.total', + /** + * The number of flushes. + */ + 'pri.flush.total', + /** + * The time spent in flush. + * @aliases ftt, flushTotalTime + */ + 'flush.total_time', + /** + * The time spent in flush. + */ + 'pri.flush.total_time', + /** + * The number of current get operations. + * @aliases gc, getCurrent + */ + 'get.current', + /** + * The number of current get operations. + */ + 'pri.get.current', + /** + * The time spent in get. + * @aliases gti, getTime + */ + 'get.time', + /** + * The time spent in get. + */ + 'pri.get.time', + /** + * The number of get operations. + * @aliases gto, getTotal + */ + 'get.total', + /** + * The number of get operations. + */ + 'pri.get.total', + /** + * The time spent in successful gets. + * @aliases geti, getExistsTime + */ + 'get.exists_time', + /** + * The time spent in successful gets. + */ + 'pri.get.exists_time', + /** + * The number of successful gets. + * @aliases geto, getExistsTotal + */ + 'get.exists_total', + /** + * The number of successful gets. + */ + 'pri.get.exists_total', + /** + * The time spent in failed gets. + * @aliases gmti, getMissingTime + */ + 'get.missing_time', + /** + * The time spent in failed gets. + */ + 'pri.get.missing_time', + /** + * The number of failed gets. + * @aliases gmto, getMissingTotal + */ + 'get.missing_total', + /** + * The number of failed gets. + */ + 'pri.get.missing_total', + /** + * The number of current deletions. + * @aliases idc, indexingDeleteCurrent + */ + 'indexing.delete_current', + /** + * The number of current deletions. + */ + 'pri.indexing.delete_current', + /** + * The time spent in deletions. + * @aliases idti, indexingDeleteTime + */ + 'indexing.delete_time', + /** + * The time spent in deletions. + */ + 'pri.indexing.delete_time', + /** + * The number of delete operations. + * @aliases idto, indexingDeleteTotal + */ + 'indexing.delete_total', + /** + * The number of delete operations. + */ + 'pri.indexing.delete_total', + /** + * The number of current indexing operations. + * @aliases iic, indexingIndexCurrent + */ + 'indexing.index_current', + /** + * The number of current indexing operations. + */ + 'pri.indexing.index_current', + /** + * The time spent in indexing. + * @aliases iiti, indexingIndexTime + */ + 'indexing.index_time', + /** + * The time spent in indexing. + */ + 'pri.indexing.index_time', + /** + * The number of indexing operations. + * @aliases iito, indexingIndexTotal + */ + 'indexing.index_total', + /** + * The number of indexing operations. + */ + 'pri.indexing.index_total', + /** + * The number of failed indexing operations. + * @aliases iif, indexingIndexFailed + */ + 'indexing.index_failed', + /** + * The number of failed indexing operations. + */ + 'pri.indexing.index_failed', + /** + * The number of failed indexing operations due to version conflict. + * @aliases iifvc, indexingIndexFailedDueToVersionConflict + */ + 'indexing.index_failed_due_to_version_conflict', + /** + * The number of failed indexing operations due to version conflict. + */ + 'pri.indexing.index_failed_due_to_version_conflict', + /** + * The number of current merges. + * @aliases mc, mergesCurrent + */ + 'merges.current', + /** + * The number of current merges. + */ + 'pri.merges.current', + /** + * The number of current merging documents. + * @aliases mcd, mergesCurrentDocs + */ + 'merges.current_docs', + /** + * The number of current merging documents. + */ + 'pri.merges.current_docs', + /** + * The size of current merges. + * @aliases mcs, mergesCurrentSize + */ + 'merges.current_size', + /** + * The size of current merges. + */ + 'pri.merges.current_size', + /** + * The number of completed merge operations. + * @aliases mt, mergesTotal + */ + 'merges.total', + /** + * The number of completed merge operations. + */ + 'pri.merges.total', + /** + * The number of merged documents. + * @aliases mtd, mergesTotalDocs + */ + 'merges.total_docs', + /** + * The number of merged documents. + */ + 'pri.merges.total_docs', + /** + * The merged size. + * @aliases mts, mergesTotalSize + */ + 'merges.total_size', + /** + * The merged size. + */ + 'pri.merges.total_size', + /** + * The time spent in merges. + * @aliases mtt, mergesTotalTime + */ + 'merges.total_time', + /** + * The time spent in merges. + */ + 'pri.merges.total_time', + /** + * The total refreshes. + * @aliases rto, refreshTotal + */ + 'refresh.total', + /** + * The total refreshes. + */ + 'pri.refresh.total', + /** + * The time spent in refreshes. + * @aliases rti, refreshTime + */ + 'refresh.time', + /** + * The time spent in refreshes. + */ + 'pri.refresh.time', + /** + * The total external refreshes. + * @aliases rto, refreshTotal + */ + 'refresh.external_total', + /** + * The total external refreshes. + */ + 'pri.refresh.external_total', + /** + * The time spent in external refreshes. + * @aliases rti, refreshTime + */ + 'refresh.external_time', + /** + * The time spent in external refreshes. + */ + 'pri.refresh.external_time', + /** + * The number of pending refresh listeners. + * @aliases rli, refreshListeners + */ + 'refresh.listeners', + /** + * The number of pending refresh listeners. + */ + 'pri.refresh.listeners', + /** + * The current fetch phase operations. + * @aliases sfc, searchFetchCurrent + */ + 'search.fetch_current', + /** + * The current fetch phase operations. + */ + 'pri.search.fetch_current', + /** + * The time spent in fetch phase. + * @aliases sfti, searchFetchTime + */ + 'search.fetch_time', + /** + * The time spent in fetch phase. + */ + 'pri.search.fetch_time', + /** + * The total fetch operations. + * @aliases sfto, searchFetchTotal + */ + 'search.fetch_total', + /** + * The total fetch operations. + */ + 'pri.search.fetch_total', + /** + * The open search contexts. + * @aliases so, searchOpenContexts + */ + 'search.open_contexts', + /** + * The open search contexts. + */ + 'pri.search.open_contexts', + /** + * The current query phase operations. + * @aliases sqc, searchQueryCurrent + */ + 'search.query_current', + /** + * The current query phase operations. + */ + 'pri.search.query_current', + /** + * The time spent in query phase. + * @aliases sqti, searchQueryTime + */ + 'search.query_time', + /** + * The time spent in query phase. + */ + 'pri.search.query_time', + /** + * The total query phase operations. + * @aliases sqto, searchQueryTotal + */ + 'search.query_total', + /** + * The total query phase operations. + */ + 'pri.search.query_total', + /** + * The open scroll contexts. + * @aliases scc, searchScrollCurrent + */ + 'search.scroll_current', + /** + * The open scroll contexts. + */ + 'pri.search.scroll_current', + /** + * The time scroll contexts held open. + * @aliases scti, searchScrollTime + */ + 'search.scroll_time', + /** + * The time scroll contexts held open. + */ + 'pri.search.scroll_time', + /** + * The completed scroll contexts. + * @aliases scto, searchScrollTotal + */ + 'search.scroll_total', + /** + * The completed scroll contexts. + */ + 'pri.search.scroll_total', + /** + * The number of segments. + * @aliases sc, segmentsCount + */ + 'segments.count', + /** + * The number of segments. + */ + 'pri.segments.count', + /** + * The memory used by segments. + * @aliases sm, segmentsMemory + */ + 'segments.memory', + /** + * The memory used by segments. + */ + 'pri.segments.memory', + /** + * The memory used by index writer. + * @aliases siwm, segmentsIndexWriterMemory + */ + 'segments.index_writer_memory', + /** + * The memory used by index writer. + */ + 'pri.segments.index_writer_memory', + /** + * The memory used by version map. + * @aliases svmm, segmentsVersionMapMemory + */ + 'segments.version_map_memory', + /** + * The memory used by version map. + */ + 'pri.segments.version_map_memory', + /** + * The memory used by fixed bit sets for nested object field types and type filters for types referred in _parent fields. + * @aliases sfbm, fixedBitsetMemory + */ + 'segments.fixed_bitset_memory', + /** + * The memory used by fixed bit sets for nested object field types and type filters for types referred in _parent fields. + */ + 'pri.segments.fixed_bitset_memory', + /** + * The current warmer operations. + * @aliases wc, warmerCurrent + */ + 'warmer.current', + /** + * The current warmer operations. + */ + 'pri.warmer.current', + /** + * The total warmer operations. + * @aliases wto, warmerTotal + */ + 'warmer.total', + /** + * The total warmer operations. + */ + 'pri.warmer.total', + /** + * The time spent in warmers. + * @aliases wtt, warmerTotalTime + */ + 'warmer.total_time', + /** + * The time spent in warmers. + */ + 'pri.warmer.total_time', + /** + * The current suggest operations. + * @aliases suc, suggestCurrent + */ + 'suggest.current', + /** + * The current suggest operations. + */ + 'pri.suggest.current', + /** + * The time spent in suggest. + * @aliases suti, suggestTime + */ + 'suggest.time', + /** + * The time spent in suggest. + */ + 'pri.suggest.time', + /** + * The number of suggest operations. + * @aliases suto, suggestTotal + */ + 'suggest.total', + /** + * The number of suggest operations. + */ + 'pri.suggest.total', + /** + * The total used memory. + * @aliases tm, memoryTotal + */ + 'memory.total', + /** + * The total used memory. + */ + 'pri.memory.total', + /** + * The number of bulk shard operations. + * @aliases bto, bulkTotalOperation + */ + 'bulk.total_operations', + /** + * The number of bulk shard operations. + */ + 'pri.bulk.total_operations', + /** + * The time spent in shard bulk. + * @aliases btti, bulkTotalTime + */ + 'bulk.total_time', + /** + * The time spent in shard bulk. + */ + 'pri.bulk.total_time', + /** + * The total size in bytes of shard bulk. + * @aliases btsi, bulkTotalSizeInBytes + */ + 'bulk.total_size_in_bytes', + /** + * The total size in bytes of shard bulk. + */ + 'pri.bulk.total_size_in_bytes', + /** + * The average time spent in shard bulk. + * @aliases bati, bulkAvgTime + */ + 'bulk.avg_time', + /** + * The average time spent in shard bulk. + */ + 'pri.bulk.avg_time', + /** + * The average size in bytes of shard bulk. + * @aliases basi, bulkAvgSizeInBytes + */ + 'bulk.avg_size_in_bytes', + /** + * The average size in bytes of shard bulk. + */ + 'pri.bulk.avg_size_in_bytes', + /** + * The total count of indexed dense vectors. + * @aliases dvc, denseVectorCount + */ + 'dense_vector.value_count', + /** + * The total count of indexed dense vectors. + */ + 'pri.dense_vector.value_count', + /** + * The total count of indexed sparse vectors. + * @aliases svc, sparseVectorCount + */ + 'sparse_vector.value_count', + /** + * The total count of indexed sparse vectors. + */ + 'pri.sparse_vector.value_count' +} + +/** @non_exhaustive */ +export enum CatMasterColumn { + /** + * The node ID. + */ + id, + /** + * The host name of the node. + * @aliases h + */ + host, + /** + * The IP address of the node. + */ + ip, + /** + * The node name. + * @aliases n + */ + node, +} + + + + + export type CatDfaColumns = CatDfaColumn | CatDfaColumn[] export type CatDatafeedColumns = CatDatafeedColumn | CatDatafeedColumn[] export type CatNodeColumns = CatNodeColumn | CatNodeColumn[] From a10ed338cc6554ffee412e166cf80d115dba2963 Mon Sep 17 00:00:00 2001 From: kosabogi Date: Fri, 29 Aug 2025 11:50:19 +0200 Subject: [PATCH 3/3] Adds cat-h values --- specification/cat/_types/CatBase.ts | 348 +++++++++++------- specification/cat/health/CatHealthRequest.ts | 6 +- .../cat/indices/CatIndicesRequest.ts | 6 +- specification/cat/master/CatMasterRequest.ts | 6 +- .../cat/nodeattrs/CatNodeAttributesRequest.ts | 6 +- .../pending_tasks/CatPendingTasksRequest.ts | 6 +- 6 files changed, 224 insertions(+), 154 deletions(-) diff --git a/specification/cat/_types/CatBase.ts b/specification/cat/_types/CatBase.ts index e9a13a166d..ad23bbdf72 100644 --- a/specification/cat/_types/CatBase.ts +++ b/specification/cat/_types/CatBase.ts @@ -1503,7 +1503,7 @@ export enum CatHealthColumn { * @aliases nd, nodeData */ 'node.data', - /** + /** * The total number of shards. * @aliases t, sh, shards.total, shardsTotal */ @@ -1533,7 +1533,7 @@ export enum CatHealthColumn { * @aliases up, shards.unassigned.primary, shardsUnassignedPrimary */ 'unassign.pri', - /** + /** * The number of pending tasks. * @aliases pt, pendingTasks */ @@ -1616,606 +1616,606 @@ export enum CatIndicesColumn { */ 'dataset.size', /** - * The size of completion. + * The size of completion for primaries and replicas. * @aliases cs, completionSize */ 'completion.size', /** - * The size of completion. + * The size of completion for primaries. */ 'pri.completion.size', /** - * The used fielddata cache. + * The used fielddata cache for primaries and replicas. * @aliases fm, fielddataMemory */ 'fielddata.memory_size', /** - * The used fielddata cache. + * The used fielddata cache for primaries. */ 'pri.fielddata.memory_size', /** - * The number of fielddata evictions. + * The number of fielddata evictions for primaries and replicas. * @aliases fe, fielddataEvictions */ 'fielddata.evictions', /** - * The number of fielddata evictions. + * The number of fielddata evictions for primaries. */ 'pri.fielddata.evictions', /** - * The used query cache. + * The used query cache for primaries and replicas. * @aliases qcm, queryCacheMemory */ 'query_cache.memory_size', /** - * The used query cache. + * The used query cache for primaries. */ 'pri.query_cache.memory_size', /** - * The number of query cache evictions. + * The number of query cache evictions for primaries and replicas. * @aliases qce, queryCacheEvictions */ 'query_cache.evictions', /** - * The number of query cache evictions. + * The number of query cache evictions for primaries. */ 'pri.query_cache.evictions', /** - * The used request cache. + * The used request cache for primaries and replicas. * @aliases rcm, requestCacheMemory */ 'request_cache.memory_size', /** - * The used request cache. + * The used request cache for primaries. */ 'pri.request_cache.memory_size', /** - * The number of request cache evictions. + * The number of request cache evictions for primaries and replicas. * @aliases rce, requestCacheEvictions */ 'request_cache.evictions', /** - * The number of request cache evictions. + * The number of request cache evictions for primaries. */ 'pri.request_cache.evictions', /** - * The request cache hit count. + * The request cache hit count for primaries and replicas. * @aliases rchc, requestCacheHitCount */ 'request_cache.hit_count', /** - * The request cache hit count. + * The request cache hit count for primaries. */ 'pri.request_cache.hit_count', /** - * The request cache miss count. + * The request cache miss count for primaries and replicas. * @aliases rcmc, requestCacheMissCount */ 'request_cache.miss_count', /** - * The request cache miss count. + * The request cache miss count for primaries. */ 'pri.request_cache.miss_count', /** - * The number of flushes. + * The number of flushes for primaries and replicas. * @aliases ft, flushTotal */ 'flush.total', /** - * The number of flushes. + * The number of flushes for primaries. */ 'pri.flush.total', /** - * The time spent in flush. + * The time spent in flush for primaries and replicas. * @aliases ftt, flushTotalTime */ 'flush.total_time', /** - * The time spent in flush. + * The time spent in flush for primaries. */ 'pri.flush.total_time', /** - * The number of current get operations. + * The number of current get operations for primaries and replicas. * @aliases gc, getCurrent */ 'get.current', /** - * The number of current get operations. + * The number of current get operations for primaries. */ 'pri.get.current', /** - * The time spent in get. + * The time spent in get for primaries and replicas. * @aliases gti, getTime */ 'get.time', /** - * The time spent in get. + * The time spent in get for primaries. */ 'pri.get.time', /** - * The number of get operations. + * The number of get operations for primaries and replicas. * @aliases gto, getTotal */ 'get.total', /** - * The number of get operations. + * The number of get operations for primaries. */ 'pri.get.total', /** - * The time spent in successful gets. + * The time spent in successful gets for primaries and replicas. * @aliases geti, getExistsTime */ 'get.exists_time', /** - * The time spent in successful gets. + * The time spent in successful gets for primaries. */ 'pri.get.exists_time', /** - * The number of successful gets. + * The number of successful gets for primaries and replicas. * @aliases geto, getExistsTotal */ 'get.exists_total', /** - * The number of successful gets. + * The number of successful gets for primaries. */ 'pri.get.exists_total', /** - * The time spent in failed gets. + * The time spent in failed gets for primaries and replicas. * @aliases gmti, getMissingTime */ 'get.missing_time', /** - * The time spent in failed gets. + * The time spent in failed gets for primaries. */ 'pri.get.missing_time', /** - * The number of failed gets. + * The number of failed gets for primaries and replicas. * @aliases gmto, getMissingTotal */ 'get.missing_total', /** - * The number of failed gets. + * The number of failed gets for primaries. */ 'pri.get.missing_total', /** - * The number of current deletions. + * The number of current deletions for primaries and replicas. * @aliases idc, indexingDeleteCurrent */ 'indexing.delete_current', /** - * The number of current deletions. + * The number of current deletions for primaries. */ 'pri.indexing.delete_current', /** - * The time spent in deletions. + * The time spent in deletions for primaries and replicas. * @aliases idti, indexingDeleteTime */ 'indexing.delete_time', /** - * The time spent in deletions. + * The time spent in deletions for primaries. */ 'pri.indexing.delete_time', /** - * The number of delete operations. + * The number of delete operations for primaries and replicas. * @aliases idto, indexingDeleteTotal */ 'indexing.delete_total', /** - * The number of delete operations. + * The number of delete operations for primaries. */ 'pri.indexing.delete_total', /** - * The number of current indexing operations. + * The number of current indexing operations for primaries and replicas. * @aliases iic, indexingIndexCurrent */ 'indexing.index_current', /** - * The number of current indexing operations. + * The number of current indexing operations for primaries. */ 'pri.indexing.index_current', /** - * The time spent in indexing. + * The time spent in indexing for primaries and replicas. * @aliases iiti, indexingIndexTime */ 'indexing.index_time', /** - * The time spent in indexing. + * The time spent in indexing for primaries. */ 'pri.indexing.index_time', /** - * The number of indexing operations. + * The number of indexing operations for primaries and replicas. * @aliases iito, indexingIndexTotal */ 'indexing.index_total', /** - * The number of indexing operations. + * The number of indexing operations for primaries. */ 'pri.indexing.index_total', /** - * The number of failed indexing operations. + * The number of failed indexing operations for primaries and replicas. * @aliases iif, indexingIndexFailed */ 'indexing.index_failed', /** - * The number of failed indexing operations. + * The number of failed indexing operations for primaries. */ 'pri.indexing.index_failed', /** - * The number of failed indexing operations due to version conflict. + * The number of failed indexing operations due to version conflict for primaries and replicas. * @aliases iifvc, indexingIndexFailedDueToVersionConflict */ 'indexing.index_failed_due_to_version_conflict', /** - * The number of failed indexing operations due to version conflict. + * The number of failed indexing operations due to version conflict for primaries. */ 'pri.indexing.index_failed_due_to_version_conflict', /** - * The number of current merges. + * The number of current merges for primaries and replicas. * @aliases mc, mergesCurrent */ 'merges.current', /** - * The number of current merges. + * The number of current merges for primaries. */ 'pri.merges.current', /** - * The number of current merging documents. + * The number of current merging documents for primaries and replicas. * @aliases mcd, mergesCurrentDocs */ 'merges.current_docs', /** - * The number of current merging documents. + * The number of current merging documents for primaries. */ 'pri.merges.current_docs', /** - * The size of current merges. + * The size of current merges for primaries and replicas. * @aliases mcs, mergesCurrentSize */ 'merges.current_size', /** - * The size of current merges. + * The size of current merges for primaries. */ 'pri.merges.current_size', /** - * The number of completed merge operations. + * The number of completed merge operations for primaries and replicas. * @aliases mt, mergesTotal */ 'merges.total', /** - * The number of completed merge operations. + * The number of completed merge operations for primaries. */ 'pri.merges.total', /** - * The number of merged documents. + * The number of merged documents for primaries and replicas. * @aliases mtd, mergesTotalDocs */ 'merges.total_docs', /** - * The number of merged documents. + * The number of merged documents for primaries. */ 'pri.merges.total_docs', /** - * The merged size. + * The merged size for primaries and replicas. * @aliases mts, mergesTotalSize */ 'merges.total_size', /** - * The merged size. + * The merged size for primaries. */ 'pri.merges.total_size', /** - * The time spent in merges. + * The time spent in merges for primaries and replicas. * @aliases mtt, mergesTotalTime */ 'merges.total_time', /** - * The time spent in merges. + * The time spent in merges for primaries. */ 'pri.merges.total_time', /** - * The total refreshes. + * The total refreshes for primaries and replicas. * @aliases rto, refreshTotal */ 'refresh.total', /** - * The total refreshes. + * The total refreshes for primaries. */ 'pri.refresh.total', /** - * The time spent in refreshes. + * The time spent in refreshes for primaries and replicas. * @aliases rti, refreshTime */ 'refresh.time', /** - * The time spent in refreshes. + * The time spent in refreshes for primaries. */ 'pri.refresh.time', /** - * The total external refreshes. + * The total external refreshes for primaries and replicas. * @aliases rto, refreshTotal */ 'refresh.external_total', /** - * The total external refreshes. + * The total external refreshes for primaries. */ 'pri.refresh.external_total', /** - * The time spent in external refreshes. + * The time spent in external refreshes for primaries and replicas. * @aliases rti, refreshTime */ 'refresh.external_time', /** - * The time spent in external refreshes. + * The time spent in external refreshes for primaries. */ 'pri.refresh.external_time', /** - * The number of pending refresh listeners. + * The number of pending refresh listeners for primaries and replicas. * @aliases rli, refreshListeners */ 'refresh.listeners', /** - * The number of pending refresh listeners. + * The number of pending refresh listeners for primaries. */ 'pri.refresh.listeners', /** - * The current fetch phase operations. + * The current fetch phase operations for primaries and replicas. * @aliases sfc, searchFetchCurrent */ 'search.fetch_current', /** - * The current fetch phase operations. + * The current fetch phase operations for primaries. */ 'pri.search.fetch_current', /** - * The time spent in fetch phase. + * The time spent in fetch phase for primaries and replicas. * @aliases sfti, searchFetchTime */ 'search.fetch_time', /** - * The time spent in fetch phase. + * The time spent in fetch phase for primaries. */ 'pri.search.fetch_time', /** - * The total fetch operations. + * The total fetch operations for primaries and replicas. * @aliases sfto, searchFetchTotal */ 'search.fetch_total', /** - * The total fetch operations. + * The total fetch operations for primaries. */ 'pri.search.fetch_total', /** - * The open search contexts. + * The open search contexts for primaries and replicas. * @aliases so, searchOpenContexts */ 'search.open_contexts', /** - * The open search contexts. + * The open search contexts for primaries. */ 'pri.search.open_contexts', /** - * The current query phase operations. + * The current query phase operations for primaries and replicas. * @aliases sqc, searchQueryCurrent */ 'search.query_current', /** - * The current query phase operations. + * The current query phase operations for primaries. */ 'pri.search.query_current', /** - * The time spent in query phase. + * The time spent in query phase for primaries and replicas. * @aliases sqti, searchQueryTime */ 'search.query_time', /** - * The time spent in query phase. + * The time spent in query phase for primaries. */ 'pri.search.query_time', /** - * The total query phase operations. + * The total query phase operations for primaries and replicas. * @aliases sqto, searchQueryTotal */ 'search.query_total', /** - * The total query phase operations. + * The total query phase operations for primaries. */ 'pri.search.query_total', /** - * The open scroll contexts. + * The open scroll contexts for primaries and replicas. * @aliases scc, searchScrollCurrent */ 'search.scroll_current', /** - * The open scroll contexts. + * The open scroll contexts for primaries. */ 'pri.search.scroll_current', /** - * The time scroll contexts held open. + * The time scroll contexts held open for primaries and replicas. * @aliases scti, searchScrollTime */ 'search.scroll_time', /** - * The time scroll contexts held open. + * The time scroll contexts held open for primaries. */ 'pri.search.scroll_time', /** - * The completed scroll contexts. + * The completed scroll contexts for primaries and replicas. * @aliases scto, searchScrollTotal */ 'search.scroll_total', /** - * The completed scroll contexts. + * The completed scroll contexts for primaries. */ 'pri.search.scroll_total', /** - * The number of segments. + * The number of segments for primaries and replicas. * @aliases sc, segmentsCount */ 'segments.count', /** - * The number of segments. + * The number of segments for primaries. */ 'pri.segments.count', /** - * The memory used by segments. + * The memory used by segments for primaries and replicas. * @aliases sm, segmentsMemory */ 'segments.memory', /** - * The memory used by segments. + * The memory used by segments for primaries. */ 'pri.segments.memory', /** - * The memory used by index writer. + * The memory used by index writer for primaries and replicas. * @aliases siwm, segmentsIndexWriterMemory */ 'segments.index_writer_memory', /** - * The memory used by index writer. + * The memory used by index writer for primaries. */ 'pri.segments.index_writer_memory', /** - * The memory used by version map. + * The memory used by version map for primaries and replicas. * @aliases svmm, segmentsVersionMapMemory */ 'segments.version_map_memory', /** - * The memory used by version map. + * The memory used by version map for primaries. */ 'pri.segments.version_map_memory', /** - * The memory used by fixed bit sets for nested object field types and type filters for types referred in _parent fields. + * The memory used by fixed bit sets for nested object field types and type filters for types referred in _parent fields. Applicable for primaries and replicas. * @aliases sfbm, fixedBitsetMemory */ 'segments.fixed_bitset_memory', /** - * The memory used by fixed bit sets for nested object field types and type filters for types referred in _parent fields. + * The memory used by fixed bit sets for nested object field types and type filters for types referred in _parent fields. Applicable for primaries. */ 'pri.segments.fixed_bitset_memory', /** - * The current warmer operations. + * The current warmer operations for primaries and replicas. * @aliases wc, warmerCurrent */ 'warmer.current', /** - * The current warmer operations. + * The current warmer operations for primaries. */ 'pri.warmer.current', /** - * The total warmer operations. + * The total warmer operations for primaries and replicas. * @aliases wto, warmerTotal */ 'warmer.total', /** - * The total warmer operations. + * The total warmer operations for primaries. */ 'pri.warmer.total', /** - * The time spent in warmers. + * The time spent in warmers for primaries and replicas. * @aliases wtt, warmerTotalTime */ 'warmer.total_time', /** - * The time spent in warmers. + * The time spent in warmers for primaries. */ 'pri.warmer.total_time', /** - * The current suggest operations. + * The current suggest operations for primaries and replicas. * @aliases suc, suggestCurrent */ 'suggest.current', /** - * The current suggest operations. + * The current suggest operations for primaries. */ 'pri.suggest.current', /** - * The time spent in suggest. + * The time spent in suggest for primaries and replicas. * @aliases suti, suggestTime */ 'suggest.time', /** - * The time spent in suggest. + * The time spent in suggest for primaries. */ 'pri.suggest.time', /** - * The number of suggest operations. + * The number of suggest operations for primaries and replicas. * @aliases suto, suggestTotal */ 'suggest.total', /** - * The number of suggest operations. + * The number of suggest operations for primaries. */ 'pri.suggest.total', /** - * The total used memory. + * The total used memory for primaries and replicas. * @aliases tm, memoryTotal */ 'memory.total', /** - * The total used memory. + * The total used memory for primaries. */ 'pri.memory.total', /** - * The number of bulk shard operations. + * The number of bulk shard operations for primaries and replicas. * @aliases bto, bulkTotalOperation */ 'bulk.total_operations', /** - * The number of bulk shard operations. + * The number of bulk shard operations for primaries. */ 'pri.bulk.total_operations', /** - * The time spent in shard bulk. + * The time spent in shard bulk for primaries and replicas. * @aliases btti, bulkTotalTime */ 'bulk.total_time', /** - * The time spent in shard bulk. + * The time spent in shard bulk for primaries. */ 'pri.bulk.total_time', /** - * The total size in bytes of shard bulk. + * The total size in bytes of shard bulk for primaries and replicas. * @aliases btsi, bulkTotalSizeInBytes */ 'bulk.total_size_in_bytes', /** - * The total size in bytes of shard bulk. + * The total size in bytes of shard bulk for primaries. */ 'pri.bulk.total_size_in_bytes', /** - * The average time spent in shard bulk. + * The average time spent in shard bulk for primaries and replicas. * @aliases bati, bulkAvgTime */ 'bulk.avg_time', /** - * The average time spent in shard bulk. + * The average time spent in shard bulk for primaries. */ 'pri.bulk.avg_time', /** - * The average size in bytes of shard bulk. + * The average size in bytes of shard bulk for primaries and replicas. * @aliases basi, bulkAvgSizeInBytes */ 'bulk.avg_size_in_bytes', /** - * The average size in bytes of shard bulk. + * The average size in bytes of shard bulk for primaries. */ 'pri.bulk.avg_size_in_bytes', /** - * The total count of indexed dense vectors. + * The total count of indexed dense vectors for primaries and replicas. * @aliases dvc, denseVectorCount */ 'dense_vector.value_count', /** - * The total count of indexed dense vectors. + * The total count of indexed dense vectors for primaries. */ 'pri.dense_vector.value_count', /** - * The total count of indexed sparse vectors. + * The total count of indexed sparse vectors for primaries and replicas. * @aliases svc, sparseVectorCount */ 'sparse_vector.value_count', /** - * The total count of indexed sparse vectors. + * The total count of indexed sparse vectors for primaries. */ 'pri.sparse_vector.value_count' } @@ -2239,12 +2239,75 @@ export enum CatMasterColumn { * The node name. * @aliases n */ - node, + node } +/** @non_exhaustive */ +export enum CatNodeattrsColumn { + /** + * The node name. + */ + node, + /** + * The unique node ID. + * @aliases id, nodeId + */ + id, + /** + * The process ID. + * * @aliases p + */ + pid, + /** + * The host name. + * @aliases h + */ + host, + /** + * The IP address. + * @aliases i + */ + ip, + /** + * The bound transport port. + * @aliases po + */ + port, + /** + * The attribute description. + * @aliases attr.name + */ + attr, + /** + * The attribute value. + * @aliases attr.value + */ + value +} - - +/** @non_exhaustive */ +export enum CatPendingTasksColumn { + /** + * The task insertion order. + * @aliases o + */ + insertOrder, + /** + * How long the task has been in the queue. + * @aliases t + */ + timeInQueue, + /** + * The task priority. + * @aliases p + */ + priority, + /** + * The task source. + * @aliases s + */ + source +} export type CatDfaColumns = CatDfaColumn | CatDfaColumn[] export type CatDatafeedColumns = CatDatafeedColumn | CatDatafeedColumn[] @@ -2257,6 +2320,13 @@ export type CatAllocationColumns = CatAllocationColumn | CatAllocationColumn[] export type CatComponentColumns = CatComponentColumn | CatComponentColumn[] export type CatCountColumns = CatCountColumn | CatCountColumn[] export type CatFieldDataColumns = CatFieldDataColumn | CatFieldDataColumn[] +export type CatHealthColumns = CatHealthColumn | CatHealthColumn[] +export type CatIndicesColumns = CatIndicesColumn | CatIndicesColumn[] +export type CatMasterColumns = CatMasterColumn | CatMasterColumn[] +export type CatNodeattrsColumns = CatNodeattrsColumn | CatNodeattrsColumn[] +export type CatPendingTasksColumns = + | CatPendingTasksColumn + | CatPendingTasksColumn[] export enum CatTrainedModelsColumn { /** diff --git a/specification/cat/health/CatHealthRequest.ts b/specification/cat/health/CatHealthRequest.ts index 5182f998ac..8d5b200b90 100644 --- a/specification/cat/health/CatHealthRequest.ts +++ b/specification/cat/health/CatHealthRequest.ts @@ -19,7 +19,7 @@ import { Names } from '@_types/common' import { TimeUnit } from '@_types/Time' -import { CatRequestBase } from '@cat/_types/CatBase' +import { CatHealthColumns, CatRequestBase } from '@cat/_types/CatBase' /** * Get the cluster health status. @@ -57,9 +57,9 @@ export interface Request extends CatRequestBase { */ ts?: boolean /** - * List of columns to appear in the response. Supports simple wildcards. + * A comma-separated list of columns names to display. It supports simple wildcards. */ - h?: Names + h?: CatHealthColumns /** * List of columns that determine how the table should be sorted. * Sorting defaults to ascending and can be changed by setting `:asc` diff --git a/specification/cat/indices/CatIndicesRequest.ts b/specification/cat/indices/CatIndicesRequest.ts index 5339db929f..3604be33da 100644 --- a/specification/cat/indices/CatIndicesRequest.ts +++ b/specification/cat/indices/CatIndicesRequest.ts @@ -25,7 +25,7 @@ import { Names } from '@_types/common' import { Duration, TimeUnit } from '@_types/Time' -import { CatRequestBase } from '@cat/_types/CatBase' +import { CatIndicesColumns, CatRequestBase } from '@cat/_types/CatBase' /** * Get index information. @@ -96,9 +96,9 @@ export interface Request extends CatRequestBase { */ master_timeout?: Duration /** - * List of columns to appear in the response. Supports simple wildcards. + * A comma-separated list of columns names to display. It supports simple wildcards. */ - h?: Names + h?: CatIndicesColumns /** * List of columns that determine how the table should be sorted. * Sorting defaults to ascending and can be changed by setting `:asc` diff --git a/specification/cat/master/CatMasterRequest.ts b/specification/cat/master/CatMasterRequest.ts index f214287165..26d1c5bc39 100644 --- a/specification/cat/master/CatMasterRequest.ts +++ b/specification/cat/master/CatMasterRequest.ts @@ -19,7 +19,7 @@ import { Names } from '@_types/common' import { Duration } from '@_types/Time' -import { CatRequestBase } from '@cat/_types/CatBase' +import { CatMasterColumns, CatRequestBase } from '@cat/_types/CatBase' /** * Get master node information. @@ -42,9 +42,9 @@ export interface Request extends CatRequestBase { ] query_parameters: { /** - * List of columns to appear in the response. Supports simple wildcards. + * A comma-separated list of columns names to display. It supports simple wildcards. */ - h?: Names + h?: CatMasterColumns /** * List of columns that determine how the table should be sorted. * Sorting defaults to ascending and can be changed by setting `:asc` diff --git a/specification/cat/nodeattrs/CatNodeAttributesRequest.ts b/specification/cat/nodeattrs/CatNodeAttributesRequest.ts index 796c2f2e08..96ca2b676b 100644 --- a/specification/cat/nodeattrs/CatNodeAttributesRequest.ts +++ b/specification/cat/nodeattrs/CatNodeAttributesRequest.ts @@ -19,7 +19,7 @@ import { Names } from '@_types/common' import { Duration } from '@_types/Time' -import { CatRequestBase } from '@cat/_types/CatBase' +import { CatNodeattrsColumns, CatRequestBase } from '@cat/_types/CatBase' /** * Get node attribute information. @@ -41,9 +41,9 @@ export interface Request extends CatRequestBase { ] query_parameters: { /** - * List of columns to appear in the response. Supports simple wildcards. + * A comma-separated list of columns names to display. It supports simple wildcards. */ - h?: Names + h?: CatNodeattrsColumns /** * List of columns that determine how the table should be sorted. * Sorting defaults to ascending and can be changed by setting `:asc` diff --git a/specification/cat/pending_tasks/CatPendingTasksRequest.ts b/specification/cat/pending_tasks/CatPendingTasksRequest.ts index 0c76fdec1c..b49dd64921 100644 --- a/specification/cat/pending_tasks/CatPendingTasksRequest.ts +++ b/specification/cat/pending_tasks/CatPendingTasksRequest.ts @@ -19,7 +19,7 @@ import { Names } from '@_types/common' import { Duration, TimeUnit } from '@_types/Time' -import { CatRequestBase } from '@cat/_types/CatBase' +import { CatPendingTasksColumns, CatRequestBase } from '@cat/_types/CatBase' /** * Get pending task information. @@ -41,9 +41,9 @@ export interface Request extends CatRequestBase { ] query_parameters: { /** - * List of columns to appear in the response. Supports simple wildcards. + * A comma-separated list of columns names to display. It supports simple wildcards. */ - h?: Names + h?: CatPendingTasksColumns /** * List of columns that determine how the table should be sorted. * Sorting defaults to ascending and can be changed by setting `:asc`