diff --git a/api/OpenSearchApi.d.ts b/api/OpenSearchApi.d.ts index 1cb275cc6..c0cc99e90 100644 --- a/api/OpenSearchApi.d.ts +++ b/api/OpenSearchApi.d.ts @@ -693,6 +693,18 @@ export default class OpenSearchAPI { }; ml: { + predict (params: API.Ml_Predict_Request, options?: TransportRequestOptions): TransportRequestPromise; + predict (params: API.Ml_Predict_Request, callback: callbackFn): TransportRequestCallback; + predict (params: API.Ml_Predict_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + trainPredict (params: API.Ml_TrainPredict_Request, options?: TransportRequestOptions): TransportRequestPromise; + trainPredict (params: API.Ml_TrainPredict_Request, callback: callbackFn): TransportRequestCallback; + trainPredict (params: API.Ml_TrainPredict_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + train (params: API.Ml_Train_Request, options?: TransportRequestOptions): TransportRequestPromise; + train (params: API.Ml_Train_Request, callback: callbackFn): TransportRequestCallback; + train (params: API.Ml_Train_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + registerAgents (params?: API.Ml_RegisterAgents_Request, options?: TransportRequestOptions): TransportRequestPromise; registerAgents (callback: callbackFn): TransportRequestCallback; registerAgents (params: API.Ml_RegisterAgents_Request, callback: callbackFn): TransportRequestCallback; @@ -707,15 +719,33 @@ export default class OpenSearchAPI { createConnector (params: API.Ml_CreateConnector_Request, callback: callbackFn): TransportRequestCallback; createConnector (params: API.Ml_CreateConnector_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + searchConnectors (params?: API.Ml_SearchConnectors_Request, options?: TransportRequestOptions): TransportRequestPromise; + searchConnectors (callback: callbackFn): TransportRequestCallback; + searchConnectors (params: API.Ml_SearchConnectors_Request, callback: callbackFn): TransportRequestCallback; + searchConnectors (params: API.Ml_SearchConnectors_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + deleteConnector (params: API.Ml_DeleteConnector_Request, options?: TransportRequestOptions): TransportRequestPromise; deleteConnector (params: API.Ml_DeleteConnector_Request, callback: callbackFn): TransportRequestCallback; deleteConnector (params: API.Ml_DeleteConnector_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + getConnector (params: API.Ml_GetConnector_Request, options?: TransportRequestOptions): TransportRequestPromise; + getConnector (params: API.Ml_GetConnector_Request, callback: callbackFn): TransportRequestCallback; + getConnector (params: API.Ml_GetConnector_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + updateConnector (params: API.Ml_UpdateConnector_Request, options?: TransportRequestOptions): TransportRequestPromise; + updateConnector (params: API.Ml_UpdateConnector_Request, callback: callbackFn): TransportRequestCallback; + updateConnector (params: API.Ml_UpdateConnector_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + registerModelGroup (params?: API.Ml_RegisterModelGroup_Request, options?: TransportRequestOptions): TransportRequestPromise; registerModelGroup (callback: callbackFn): TransportRequestCallback; registerModelGroup (params: API.Ml_RegisterModelGroup_Request, callback: callbackFn): TransportRequestCallback; registerModelGroup (params: API.Ml_RegisterModelGroup_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + searchModelGroup (params?: API.Ml_SearchModelGroup_Request, options?: TransportRequestOptions): TransportRequestPromise; + searchModelGroup (callback: callbackFn): TransportRequestCallback; + searchModelGroup (params: API.Ml_SearchModelGroup_Request, callback: callbackFn): TransportRequestCallback; + searchModelGroup (params: API.Ml_SearchModelGroup_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + deleteModelGroup (params: API.Ml_DeleteModelGroup_Request, options?: TransportRequestOptions): TransportRequestPromise; deleteModelGroup (params: API.Ml_DeleteModelGroup_Request, callback: callbackFn): TransportRequestCallback; deleteModelGroup (params: API.Ml_DeleteModelGroup_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; @@ -724,6 +754,10 @@ export default class OpenSearchAPI { getModelGroup (params: API.Ml_GetModelGroup_Request, callback: callbackFn): TransportRequestCallback; getModelGroup (params: API.Ml_GetModelGroup_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + updateModelGroup (params: API.Ml_UpdateModelGroup_Request, options?: TransportRequestOptions): TransportRequestPromise; + updateModelGroup (params: API.Ml_UpdateModelGroup_Request, callback: callbackFn): TransportRequestCallback; + updateModelGroup (params: API.Ml_UpdateModelGroup_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + registerModel (params?: API.Ml_RegisterModel_Request, options?: TransportRequestOptions): TransportRequestPromise; registerModel (callback: callbackFn): TransportRequestCallback; registerModel (params: API.Ml_RegisterModel_Request, callback: callbackFn): TransportRequestCallback; diff --git a/api/_core/search.d.ts b/api/_core/search.d.ts index eaabc1150..a34a8b9e5 100644 --- a/api/_core/search.d.ts +++ b/api/_core/search.d.ts @@ -57,7 +57,7 @@ export interface Search_Request extends Global.Params { search_type?: Common.SearchType; seq_no_primary_term?: boolean; size?: number; - sort?: string | string[]; + sort?: Common.StringOrStringArray; stats?: string[]; stored_fields?: Common.Fields; suggest_field?: Common.Field; diff --git a/api/_types/_common.analysis.d.ts b/api/_types/_common.analysis.d.ts index de89a8bf0..72a9d1567 100644 --- a/api/_types/_common.analysis.d.ts +++ b/api/_types/_common.analysis.d.ts @@ -556,7 +556,7 @@ export type StopTokenFilter = TokenFilterBase & { type: 'stop'; } -export type StopWords = string | string[] +export type StopWords = Common.StringOrStringArray export type SynonymFormat = 'solr' | 'wordnet' diff --git a/api/_types/_common.d.ts b/api/_types/_common.d.ts index a6f9356e9..e235b9d24 100644 --- a/api/_types/_common.d.ts +++ b/api/_types/_common.d.ts @@ -153,6 +153,8 @@ export type Duration = string export type DurationLarge = string +export type DurationValueUnitMicros = UnitMicros + export type DurationValueUnitMillis = UnitMillis export type DurationValueUnitNanos = UnitNanos @@ -283,7 +285,7 @@ export type HourAndMinute = { minute: number[]; } -export type HttpHeaders = Record +export type HttpHeaders = Record export type HumanReadableByteCount = string @@ -624,7 +626,7 @@ export type Retries = { export type Routing = string -export type RoutingInQueryString = string | string[] +export type RoutingInQueryString = StringOrStringArray export type RrfRank = RankBase & { rank_constant?: number; @@ -825,6 +827,8 @@ export type StringifiedLong = number | string export type StringifiedVersionNumber = VersionNumber | string +export type StringOrStringArray = string | string[] + export type SuggestMode = 'always' | 'missing' | 'popular' export type TaskFailure = { @@ -878,6 +882,8 @@ export type uint = number export type ulong = number +export type UnitMicros = number + export type UnitMillis = number export type UnitNanos = number diff --git a/api/_types/_global.d.ts b/api/_types/_global.d.ts index c6f9ca867..fe15884ed 100644 --- a/api/_types/_global.d.ts +++ b/api/_types/_global.d.ts @@ -14,10 +14,11 @@ * modify the API generator. */ +import * as Common from './_common' export type Params = { error_trace?: boolean; - filter_path?: string | string[]; + filter_path?: Common.StringOrStringArray; human?: boolean; pretty?: boolean; source?: string; diff --git a/api/_types/indices._common.d.ts b/api/_types/indices._common.d.ts index 740814d3f..a9ca70506 100644 --- a/api/_types/indices._common.d.ts +++ b/api/_types/indices._common.d.ts @@ -230,7 +230,7 @@ export type IndexSettings = { refresh_interval?: Common.Duration; routing?: IndexRouting; routing_partition_size?: Common.StringifiedInteger; - routing_path?: string | string[]; + routing_path?: Common.StringOrStringArray; search?: IndexSettingsSearch; 'search.idle.after'?: Common.Duration; settings?: IndexSettings; diff --git a/api/_types/indices.analyze.d.ts b/api/_types/indices.analyze.d.ts index 962b6a998..2ca3e0080 100644 --- a/api/_types/indices.analyze.d.ts +++ b/api/_types/indices.analyze.d.ts @@ -14,6 +14,7 @@ * modify the API generator. */ +import * as Common from './_common' export type AnalyzeDetail = { analyzer?: AnalyzerDetail; @@ -54,7 +55,7 @@ export type ExplainAnalyzeToken = { type: string; } -export type TextToAnalyze = string | string[] +export type TextToAnalyze = Common.StringOrStringArray export type TokenDetail = { name: string; diff --git a/api/_types/indices.stats.d.ts b/api/_types/indices.stats.d.ts index 4e0dabe49..f13adbe51 100644 --- a/api/_types/indices.stats.d.ts +++ b/api/_types/indices.stats.d.ts @@ -21,7 +21,9 @@ export type AllIndicesStats = { total: IndexStats; } -export type IndexShardStats = IndexStatsBase & { +export type IndexShardStats = IndexShardStatsBase & Record + +export type IndexShardStatsBase = IndexStatsBase & { commit?: ShardCommit; retention_leases?: ShardRetentionLeases; routing?: ShardRouting; diff --git a/api/_types/ml._common.d.ts b/api/_types/ml._common.d.ts index f6d3eb46a..57dfb9f8a 100644 --- a/api/_types/ml._common.d.ts +++ b/api/_types/ml._common.d.ts @@ -26,6 +26,22 @@ export type Action = { url?: string; } +export type Algorithm = { + value?: 'AD_LIBSVM' | 'AGENT' | 'ANOMALY_LOCALIZATION' | 'BATCH_RCF' | 'CONNECTOR' | 'FIT_RCF' | 'KMEANS' | 'LINEAR_REGRESSION' | 'LOCAL_SAMPLE_CALCULATOR' | 'LOGISTIC_REGRESSION' | 'METRICS_CORRELATION' | 'QUESTION_ANSWERING' | 'RCF_SUMMARIZE' | 'REMOTE' | 'SAMPLE_ALGO' | 'SPARSE_ENCODING' | 'SPARSE_TOKENIZE' | 'TEXT_EMBEDDING' | 'TEXT_SIMILARITY'; +} + +export type BoolQuery = { + filter?: Filter[]; + must?: Filter[]; + must_not?: Filter; + should?: Filter[]; +} + +export type ByteBuffer = { + array?: string; + order?: 'BIG_ENDIAN' | 'LITTLE_ENDIAN'; +} + export type ClientConfig = { connection_timeout?: number; max_connection?: number; @@ -36,6 +52,11 @@ export type ClientConfig = { retry_timeout_seconds?: number; } +export type ColumnMeta = { + column_type?: 'BOOLEAN' | 'DOUBLE' | 'INTEGER' | 'STRING'; + name?: Common.Name; +} + export type Credential = { access_key?: string; secret_key?: string; @@ -43,6 +64,30 @@ export type Credential = { [key: string]: any; } +export type Exists = { + field?: Common.Field; +} + +export type Filter = { + exists?: Exists; + match?: Match; + nested?: Nested; + range?: Range; + term?: Term; + terms?: Term; +} + +export type GetConnectorResponse = { + actions?: Action[]; + created_time?: number; + description?: string; + last_updated_time?: number; + name?: Common.Name; + parameters?: Parameters; + protocol?: 'aws_sigv4' | 'http'; + version?: Common.VersionString; +} + export type Headers = { content_type?: string; [key: string]: any; @@ -53,11 +98,34 @@ export type HitsTotal = { value: number; } +export type InferenceResults = { + output?: Output[]; +} + +export type InputQuery = { + _source?: string[]; + query?: Query; + size?: number; +} + +export type Key = { + gt?: number; + gte?: number; + lt?: number; + lte?: number; +} + export type LLM = { model_id?: string; parameters?: Parameters; } +export type Match = { + description?: string; +} + +export type MatchAllQuery = Record + export type Memory = { type?: string; } @@ -70,12 +138,13 @@ export type ModelConfig = { } export type ModelGroup = { - access: string; + access: 'private' | 'public' | 'restricted'; created_time?: number; description: string; last_updated_time?: number; latest_version: number; name: string; + owner?: Owner; } export type ModelGroupRegistration = { @@ -83,15 +152,73 @@ export type ModelGroupRegistration = { status: string; } +export type Nested = { + boost?: number; + ignore_unmapped?: boolean; + path?: Common.Field; + query?: Query; + score_mode?: 'avg' | 'max' | 'min' | 'none' | 'sum'; +} + +export type Output = { + byte_buffer?: ByteBuffer; + data: number[]; + data_type?: 'BOOLEAN' | 'FLOAT16' | 'FLOAT32' | 'FLOAT64' | 'INT32' | 'INT64' | 'INT8' | 'STRING' | 'UINT8' | 'UNKNOWN'; + name?: string; + shape?: number[]; +} + +export type Owner = { + backend_roles?: string[]; + custom_attribute_names?: string[]; + name: Common.Name; + roles?: string[]; + user_requested_tenant?: undefined | string; +} + +export type OwnerNameKeyword = { + boost?: number; + value?: Common.FieldValue; +} + export type Parameters = Record -export type SearchModelsHits = { - hits: SearchModelsHitsHit[]; +export type PredictionResult = { + column_metas?: ColumnMeta[]; + rows?: Rows[]; +} + +export type PredictResponse = { + inference_results?: InferenceResults[]; + prediction_result?: PredictionResult; + status?: Status; +} + +export type Query = { + bool?: BoolQuery; + match_all?: MatchAllQuery; + term?: Term; +} + +export type Range = { + k1?: Key; + k2?: Key; + k3?: Key; +} + +export type Rows = { + values?: Values[]; +} + +export type SearchConnectorsResponse = SearchResponse + +export type SearchHits = { + hits: SearchHitsHit[]; max_score?: number; total: HitsTotal; } -export type SearchModelsHitsHit = { +export type SearchHitsHit = { _id?: Common.Id; _index?: Common.IndexName; _primary_term?: number; @@ -102,16 +229,52 @@ export type SearchModelsHitsHit = { model_id?: Common.Name; } -export type SearchModelsResponse = { +export type SearchModelGroupsResponse = SearchResponse + +export type SearchModelsResponse = SearchResponse + +export type SearchResponse = { _shards?: Common.ShardStatistics; - hits: SearchModelsHits; + hits: SearchHits; timed_out?: boolean; took?: number; } +export type Sort = { + _id?: SortOrder; + _index?: SortOrder; + _score?: SortOrder; + _seq_no?: SortOrder; + algorithm?: SortOrder; + auto_redeploy_retry_times?: SortOrder; + chunk_number?: SortOrder; + created_time?: SortOrder; + current_worker_node_count?: SortOrder; + deploy_to_all_nodes?: SortOrder; + is_hidden?: SortOrder; + last_registered_time?: SortOrder; + last_updated_time?: SortOrder; + model_content_hash_value?: SortOrder; + model_content_size_in_bytes?: SortOrder; + model_format?: SortOrder; + model_group_id?: SortOrder; + model_state?: SortOrder; + model_version?: SortOrder; + planning_worker_node_count?: SortOrder; + planning_worker_nodes?: SortOrder; + total_chunks?: SortOrder; +} + +export type SortOrder = { + order?: 'asc' | 'desc'; +} + export type Source = { + access?: 'private' | 'public' | 'restricted'; + actions?: Action[]; algorithm?: string; auto_redeploy_retry_times?: number; + backend_roles?: string[]; chunk_number?: number; connector_id?: string; created_time?: number; @@ -122,23 +285,29 @@ export type Source = { last_deployed_time?: number; last_registered_time?: number; last_updated_time?: number; + latest_version?: number; model_config?: ModelConfig; model_content_hash_value?: string; model_content_size_in_bytes?: number; model_format?: string; model_group_id?: string; model_id?: Common.Name; - model_state?: 'DEPLOYED' | 'DEPLOYING' | 'DEPLOY_FAILED' | 'PARTIALLY_DEPLOYED' | 'REGISTERED' | 'REGISTERING'; + model_state?: 'DEPLOYED' | 'DEPLOYING' | 'DEPLOY_FAILED' | 'PARTIALLY_DEPLOYED' | 'REGISTERED' | 'REGISTERING' | 'UNDEPLOYED'; model_task_type?: string; model_version?: string; name?: string; + owner?: Owner; + parameters?: Parameters; planning_worker_node_count?: number; planning_worker_nodes?: Common.NodeIds[]; + protocol?: 'aws_sigv4' | 'http'; total_chunks?: number; url?: string; version?: Common.VersionString; } +export type Status = 'CANCELLED' | 'COMPLETED' | 'COMPLETED_WITH_ERROR' | 'CREATED' | 'FAILED' | 'RUNNING' + export type Task = { create_time?: number; error?: string; @@ -146,12 +315,19 @@ export type Task = { is_async?: boolean; last_update_time?: number; model_id?: string; - state: 'CANCELLED' | 'COMPLETED' | 'COMPLETED_WITH_ERROR' | 'CREATED' | 'FAILED' | 'RUNNING'; + state: 'CANCELLED' | 'CANCELLING' | 'COMPLETED' | 'COMPLETED_WITH_ERROR' | 'CREATED' | 'EXPIRED' | 'FAILED' | 'RUNNING'; task_id?: string; task_type?: 'DEPLOY_MODEL' | 'REGISTER_MODEL'; worker_node?: Common.NodeIds[]; } +export type Term = { + _id?: Common.Id[]; + algorithm?: Algorithm; + model_id?: Common.Name; + 'owner.name.keyword'?: OwnerNameKeyword; +} + export type ToolItems = { name?: string; parameters?: Parameters; @@ -159,6 +335,22 @@ export type ToolItems = { [key: string]: any; } +export type TrainParameters = { + centroids?: number; + distance_type?: 'COSINE' | 'EUCLIDEAN' | 'L1'; + iterations?: number; +} + +export type TrainPredictResponse = { + prediction_result?: PredictionResult; + status: Status; +} + +export type TrainResponse = { + model_id?: Common.Name; + status: Status; +} + export type UndeployModelNode = { stats?: UndeployModelNodeStats; } @@ -167,3 +359,12 @@ export type UndeployModelNodeStats = Record export type UndeployModelResponse = Record +export type UpdateModelGroupResponse = { + status?: string; +} + +export type Values = { + column_type?: 'BOOLEAN' | 'DOUBLE' | 'INTEGER' | 'STRING'; + value?: number; +} + diff --git a/api/_types/nodes._common.d.ts b/api/_types/nodes._common.d.ts index dcd195724..8d7a894c9 100644 --- a/api/_types/nodes._common.d.ts +++ b/api/_types/nodes._common.d.ts @@ -15,641 +15,10 @@ */ import * as Common from './_common' -import * as Indices_Stats from './indices.stats' - -export type AdaptiveSelection = { - avg_queue_size?: number; - avg_response_time?: Common.Duration; - avg_response_time_ns?: number; - avg_service_time?: Common.Duration; - avg_service_time_ns?: number; - outgoing_searches?: number; - rank?: string; -} - -export type Breaker = { - estimated_size?: Common.HumanReadableByteCount; - estimated_size_in_bytes?: Common.ByteCount; - limit_size?: Common.HumanReadableByteCount; - limit_size_in_bytes?: Common.ByteCount; - overhead?: number; - tripped?: number; -} - -export type Cgroup = { - cpu?: CgroupCpu; - cpuacct?: CpuAcct; - memory?: CgroupMemory; -} - -export type CgroupCpu = { - cfs_period_micros?: number; - cfs_quota_micros?: number; - control_group?: string; - stat?: CgroupCpuStat; -} - -export type CgroupCpuStat = { - number_of_elapsed_periods?: number; - number_of_times_throttled?: number; - time_throttled_nanos?: Common.DurationValueUnitNanos; -} - -export type CgroupMemory = { - control_group?: string; - limit_in_bytes?: string; - usage_in_bytes?: string; -} - -export type Client = { - agent?: string; - closed_time_millis?: number; - id?: number; - last_request_time_millis?: number; - last_uri?: string; - local_address?: string; - opened_time_millis?: number; - remote_address?: string; - request_count?: number; - request_size_bytes?: Common.ByteCount; - x_opaque_id?: string; -} - -export type ClusterAppliedStats = { - recordings?: Recording[]; -} - -export type ClusterStateOverallStats = { - failed_count?: number; - total_time_in_millis?: Common.DurationValueUnitMillis; - update_count?: number; -} - -export type ClusterStateQueue = { - committed?: number; - pending?: number; - total?: number; -} - -export type ClusterStateStats = { - overall?: ClusterStateOverallStats; -} - -export type ClusterStateUpdate = { - commit_time?: Common.Duration; - commit_time_millis?: Common.DurationValueUnitMillis; - completion_time?: Common.Duration; - completion_time_millis?: Common.DurationValueUnitMillis; - computation_time?: Common.Duration; - computation_time_millis?: Common.DurationValueUnitMillis; - context_construction_time?: Common.Duration; - context_construction_time_millis?: Common.DurationValueUnitMillis; - count: number; - master_apply_time?: Common.Duration; - master_apply_time_millis?: Common.DurationValueUnitMillis; - notification_time?: Common.Duration; - notification_time_millis?: Common.DurationValueUnitMillis; - publication_time?: Common.Duration; - publication_time_millis?: Common.DurationValueUnitMillis; -} - -export type Context = { - cache_evictions?: number; - compilation_limit_triggered?: number; - compilations?: number; - context?: string; -} - -export type Cpu = { - load_average?: Record; - percent?: Common.PercentageNumber; - sys?: Common.Duration; - sys_in_millis?: Common.DurationValueUnitMillis; - total?: Common.Duration; - total_in_millis?: Common.DurationValueUnitMillis; - user?: Common.Duration; - user_in_millis?: Common.DurationValueUnitMillis; -} - -export type CpuAcct = { - control_group?: string; - usage_nanos?: Common.DurationValueUnitNanos; -} - -export type DataPathStats = { - available?: Common.HumanReadableByteCount; - available_in_bytes?: Common.ByteCount; - cache_reserved?: Common.HumanReadableByteCount; - cache_reserved_in_bytes?: Common.ByteCount; - disk_queue?: string; - disk_read_size?: Common.HumanReadableByteCount; - disk_read_size_in_bytes?: Common.ByteCount; - disk_reads?: number; - disk_write_size?: Common.HumanReadableByteCount; - disk_write_size_in_bytes?: Common.ByteCount; - disk_writes?: number; - free?: Common.HumanReadableByteCount; - free_in_bytes?: Common.ByteCount; - mount?: string; - path?: string; - total?: Common.HumanReadableByteCount; - total_in_bytes?: Common.ByteCount; - type?: string; -} - -export type Discovery = { - cluster_applier_stats?: ClusterAppliedStats; - cluster_state_queue?: ClusterStateQueue; - cluster_state_stats?: ClusterStateStats; - cluster_state_update?: Record; - published_cluster_states?: PublishedClusterStates; - serialized_cluster_states?: SerializedClusterState; -} - -export type ExtendedMemoryStats = MemoryStats & { - free_percent?: Common.PercentageNumber; - used_percent?: Common.PercentageNumber; -} - -export type FileSystem = { - data?: DataPathStats[]; - io_stats?: IoStats; - timestamp?: number; - total?: FileSystemTotal; -} - -export type FileSystemTotal = { - available?: Common.HumanReadableByteCount; - available_in_bytes?: Common.ByteCount; - cache_reserved?: Common.HumanReadableByteCount; - cache_reserved_in_bytes?: Common.ByteCount; - free?: Common.HumanReadableByteCount; - free_in_bytes?: Common.ByteCount; - total?: Common.HumanReadableByteCount; - total_in_bytes?: Common.ByteCount; -} - -export type GarbageCollector = { - collectors?: Record; -} - -export type GarbageCollectorTotal = { - collection_count?: number; - collection_time?: string; - collection_time_in_millis?: number; -} - -export type Http = { - clients?: Client[]; - current_open?: number; - total_opened?: number; -} - -export type IndexingPressure = { - memory?: IndexingPressureMemory; -} - -export type IndexingPressureMemory = { - current?: PressureMemory; - limit?: Common.HumanReadableByteCount; - limit_in_bytes?: Common.ByteCount; - total?: PressureMemory; -} - -export type Ingest = { - pipelines?: Record; - total?: IngestTotal; -} - -export type IngestTotal = { - count?: number; - current?: number; - failed?: number; - processors?: Record[]; - time?: Common.Duration; - time_in_millis?: Common.DurationValueUnitMillis; -} - -export type IoStatDevice = { - device_name?: string; - io_time_in_millis?: Common.DurationValueUnitMillis; - operations?: number; - queue_size?: number; - read_kilobytes?: number; - read_operations?: number; - read_time?: number; - write_kilobytes?: number; - write_operations?: number; - write_time?: number; -} - -export type IoStats = { - devices?: IoStatDevice[]; - total?: IoStatDevice; -} - -export type Jvm = { - buffer_pools?: Record; - classes?: JvmClasses; - gc?: GarbageCollector; - mem?: JvmMemoryStats; - threads?: JvmThreads; - timestamp?: number; - uptime?: string; - uptime_in_millis?: number; -} - -export type JvmClasses = { - current_loaded_count?: number; - total_loaded_count?: number; - total_unloaded_count?: number; -} - -export type JvmMemoryStats = { - heap_committed?: Common.HumanReadableByteCount; - heap_committed_in_bytes?: Common.ByteCount; - heap_max?: Common.HumanReadableByteCount; - heap_max_in_bytes?: Common.ByteCount; - heap_used?: Common.HumanReadableByteCount; - heap_used_in_bytes?: Common.ByteCount; - heap_used_percent?: Common.PercentageNumber; - non_heap_committed?: Common.HumanReadableByteCount; - non_heap_committed_in_bytes?: Common.ByteCount; - non_heap_used?: Common.HumanReadableByteCount; - non_heap_used_in_bytes?: Common.ByteCount; - pools?: Record; -} - -export type JvmThreads = { - count?: number; - peak_count?: number; -} - -export type KeyedProcessor = { - stats?: Processor; - type?: string; -} - -export type LastGcStats = { - max?: Common.HumanReadableByteCount; - max_in_bytes?: Common.ByteCount; - usage_percent?: Common.PercentageNumber; - used?: Common.HumanReadableByteCount; - used_in_bytes?: Common.ByteCount; -} - -export type MemoryStats = { - adjusted_total_in_bytes?: Common.ByteCount; - free?: Common.HumanReadableByteCount; - free_in_bytes?: Common.ByteCount; - resident?: Common.HumanReadableByteCount; - resident_in_bytes?: Common.ByteCount; - share?: Common.HumanReadableByteCount; - share_in_bytes?: Common.ByteCount; - total?: Common.HumanReadableByteCount; - total_in_bytes?: Common.ByteCount; - total_virtual?: Common.HumanReadableByteCount; - total_virtual_in_bytes?: Common.ByteCount; - used?: Common.HumanReadableByteCount; - used_in_bytes?: Common.ByteCount; -} - -export type NodeBufferPool = { - count?: number; - total_capacity?: Common.HumanReadableByteCount; - total_capacity_in_bytes?: Common.ByteCount; - used?: Common.HumanReadableByteCount; - used_in_bytes?: Common.ByteCount; -} - -export type NodeReloadError = NodeReloadResponse & { - reload_exception?: Common.ErrorCause; -} - -export type NodeReloadResponse = { - name: Common.Name; -} - -export type NodeReloadResult = NodeReloadResponse | NodeReloadError export type NodesResponseBase = { _nodes?: Common.NodeStatistics; } -export type OperatingSystem = { - cgroup?: Cgroup; - cpu?: Cpu; - mem?: ExtendedMemoryStats; - swap?: MemoryStats; - timestamp?: number; -} - -export type Pool = { - last_gc_stats?: LastGcStats; - max?: Common.HumanReadableByteCount; - max_in_bytes?: Common.ByteCount; - peak_max?: Common.HumanReadableByteCount; - peak_max_in_bytes?: Common.ByteCount; - peak_used?: Common.HumanReadableByteCount; - peak_used_in_bytes?: Common.ByteCount; - used?: Common.HumanReadableByteCount; - used_in_bytes?: Common.ByteCount; -} - -export type PressureMemory = { - all?: Common.HumanReadableByteCount; - all_in_bytes?: Common.ByteCount; - combined_coordinating_and_primary?: Common.HumanReadableByteCount; - combined_coordinating_and_primary_in_bytes?: Common.ByteCount; - coordinating?: Common.HumanReadableByteCount; - coordinating_in_bytes?: Common.ByteCount; - coordinating_rejections?: number; - primary?: Common.HumanReadableByteCount; - primary_in_bytes?: Common.ByteCount; - primary_rejections?: number; - replica?: Common.HumanReadableByteCount; - replica_in_bytes?: Common.ByteCount; - replica_rejections?: number; -} - -export type Process = { - cpu?: Cpu; - max_file_descriptors?: number; - mem?: MemoryStats; - open_file_descriptors?: number; - timestamp?: number; -} - -export type Processor = { - count?: number; - current?: number; - failed?: number; - time?: Common.Duration; - time_in_millis?: Common.DurationValueUnitMillis; -} - -export type PublishedClusterStates = { - compatible_diffs?: number; - full_states?: number; - incompatible_diffs?: number; -} - -export type Recording = { - cumulative_execution_count?: number; - cumulative_execution_time?: Common.Duration; - cumulative_execution_time_millis?: Common.DurationValueUnitMillis; - name?: string; -} - -export type RemoteStoreStats = { - last_successful_fetch_of_pinned_timestamps?: Common.StringifiedEpochTimeUnitSeconds; -} - export type SampleType = 'block' | 'cpu' | 'wait' -export type ScriptCache = { - cache_evictions?: number; - compilation_limit_triggered?: number; - compilations?: number; - context?: string; -} - -export type Scripting = { - cache_evictions?: number; - compilation_limit_triggered?: number; - compilations?: number; - compilations_history?: Record; - contexts?: Context[]; -} - -export type SerializedClusterState = { - diffs?: SerializedClusterStateDetail; - full_states?: SerializedClusterStateDetail; -} - -export type SerializedClusterStateDetail = { - compressed_size?: Common.HumanReadableByteCount; - compressed_size_in_bytes?: Common.ByteCount; - count?: number; - uncompressed_size?: Common.HumanReadableByteCount; - uncompressed_size_in_bytes?: Common.ByteCount; -} - -export type ShardAdmissionControlStats = { - global_cpu_usage?: UsageStats; - global_io_usage?: UsageStats; -} - -export type ShardCachesStats = Record - -export type ShardCacheStats = { - evictions?: number; - hit_count?: number; - item_count?: number; - miss_count?: number; - size?: Common.HumanReadableByteCount; - size_in_bytes?: Common.ByteCount; - store_name?: string; -} - -export type ShardClusterManagerThrottlingStats = { - stats?: ShardClusterManagerThrottlingStatsDetail; -} - -export type ShardClusterManagerThrottlingStatsDetail = { - throttled_tasks_per_task_type?: Record; - total_throttled_tasks?: number; -} - -export type ShardIndexingPressureStats = { - enabled?: boolean; - enforced?: boolean; - stats?: Record; - total_rejections_breakup?: TotalRejectionsBreakup; - total_rejections_breakup_shadow_mode?: TotalRejectionsBreakup; -} - -export type ShardRepositoriesStats = any[] - -export type ShardResourceUsageStats = Record - -export type ShardResourceUsageStatsDetail = { - cpu_utilization_percent?: Common.PercentageString; - io_usage_stats?: ShardResourceUsageStatsIoUsageStats; - memory_utilization_percent?: Common.PercentageString; - timestamp?: number; -} - -export type ShardResourceUsageStatsIoUsageStats = { - max_io_utilization_percent?: Common.PercentageString; -} - -export type ShardSearchBackpressureMode = 'disabled' | 'enforced' | 'monitor_only' - -export type ShardSearchBackpressureStats = { - mode?: ShardSearchBackpressureMode; - search_shard_task?: ShardSearchBackpressureTaskStats; - search_task?: ShardSearchBackpressureTaskStats; -} - -export type ShardSearchBackpressureTaskCancellationStats = { - cancellation_count?: number; - cancellation_limit_reached_count?: number; - cancelled_task_percentage?: Common.PercentageNumber; - current_cancellation_eligible_tasks_count?: number; -} - -export type ShardSearchBackpressureTaskResourceTrackerCpuUsageTrackerStats = { - cancellation_count?: number; - current_avg?: Common.Duration; - current_avg_millis?: Common.DurationValueUnitMillis; - current_max?: Common.Duration; - current_max_millis?: Common.DurationValueUnitMillis; -} - -export type ShardSearchBackpressureTaskResourceTrackerElapsedTimeTrackerStats = { - cancellation_count?: number; - current_avg?: Common.Duration; - current_avg_millis?: Common.DurationValueUnitMillis; - current_max?: Common.Duration; - current_max_millis?: Common.DurationValueUnitMillis; -} - -export type ShardSearchBackpressureTaskResourceTrackerHeapUsageTrackerStats = { - cancellation_count?: number; - current_avg?: Common.HumanReadableByteCount; - current_avg_bytes?: Common.ByteCount; - current_max?: Common.HumanReadableByteCount; - current_max_bytes?: Common.ByteCount; - rolling_avg?: Common.HumanReadableByteCount; - rolling_avg_bytes?: Common.ByteCount; -} - -export type ShardSearchBackpressureTaskResourceTrackerStats = { - cpu_usage_tracker?: ShardSearchBackpressureTaskResourceTrackerCpuUsageTrackerStats; - elapsed_time_tracker?: ShardSearchBackpressureTaskResourceTrackerElapsedTimeTrackerStats; - heap_usage_tracker?: ShardSearchBackpressureTaskResourceTrackerHeapUsageTrackerStats; -} - -export type ShardSearchBackpressureTaskStats = { - cancellation_stats?: ShardSearchBackpressureTaskCancellationStats; - completion_count?: number; - resource_tracker_stats?: ShardSearchBackpressureTaskResourceTrackerStats; -} - -export type ShardSearchPipelineStats = { - pipelines?: Record; - total_request?: ShardSearchPipelineTotalStats; - total_response?: ShardSearchPipelineTotalStats; -} - -export type ShardSearchPipelineTotalStats = { - count?: number; - current?: number; - failed?: number; - time?: Common.Duration; - time_in_millis?: Common.DurationValueUnitMillis; -} - -export type ShardSegmentReplicationBackpressureStats = { - total_rejected_requests?: number; -} - -export type ShardTaskCancellationStats = { - search_shard_task?: ShardTaskCancellationStatsDetail; -} - -export type ShardTaskCancellationStatsDetail = { - current_count_post_cancel?: number; - total_count_post_cancel?: number; -} - -export type ShardWeightedRoutingStats = { - stats?: ShardWeightedRoutingStatsDetail; -} - -export type ShardWeightedRoutingStatsDetail = { - fail_open_count?: number; -} - -export type Stats = { - adaptive_selection?: Record; - admission_control?: ShardAdmissionControlStats; - attributes?: Record; - breakers?: Record; - caches?: ShardCachesStats; - cluster_manager_throttling?: ShardClusterManagerThrottlingStats; - discovery?: Discovery; - fs?: FileSystem; - host?: Common.Host; - http?: Http; - indexing_pressure?: IndexingPressure; - indices?: Indices_Stats.IndexShardStats; - ingest?: Ingest; - ip?: Common.Ip | Common.Ip[]; - jvm?: Jvm; - name?: Common.Name; - os?: OperatingSystem; - process?: Process; - remote_store?: RemoteStoreStats; - repositories?: ShardRepositoriesStats; - resource_usage_stats?: ShardResourceUsageStats; - roles?: Common.NodeRoles; - script?: Scripting; - script_cache?: Record; - search_backpressure?: ShardSearchBackpressureStats; - search_pipeline?: ShardSearchPipelineStats; - segment_replication_backpressure?: ShardSegmentReplicationBackpressureStats; - shard_indexing_pressure?: ShardIndexingPressureStats; - task_cancellation?: ShardTaskCancellationStats; - thread_pool?: Record; - timestamp?: number; - transport?: Transport; - transport_address?: Common.TransportAddress; - weighted_routing?: ShardWeightedRoutingStats; -} - -export type ThreadCount = { - active?: number; - completed?: number; - largest?: number; - queue?: number; - rejected?: number; - threads?: number; - total_wait_time?: Common.Duration; - total_wait_time_in_nanos?: number; -} - -export type TotalRejectionsBreakup = { - no_successful_request_limits?: number; - node_limits?: number; - throughput_degradation_limits?: number; -} - -export type Transport = { - inbound_handling_time_histogram?: TransportHistogram[]; - outbound_handling_time_histogram?: TransportHistogram[]; - rx_count?: number; - rx_size?: Common.HumanReadableByteCount; - rx_size_in_bytes?: Common.ByteCount; - server_open?: number; - total_outbound_connections?: number; - tx_count?: number; - tx_size?: Common.HumanReadableByteCount; - tx_size_in_bytes?: Common.ByteCount; -} - -export type TransportHistogram = { - count?: number; - ge_millis?: number; - lt_millis?: number; -} - -export type TransportUsageStats = { - rejection_count?: Record; -} - -export type UsageStats = { - transport?: TransportUsageStats; -} - diff --git a/api/_types/nodes.info.d.ts b/api/_types/nodes.info.d.ts index b939f1815..d8d637c7d 100644 --- a/api/_types/nodes.info.d.ts +++ b/api/_types/nodes.info.d.ts @@ -16,11 +16,6 @@ import * as Common from './_common' import * as Indices_Common from './indices._common' -import * as Nodes_Common from './nodes._common' - -export type DeprecationIndexing = { - enabled: boolean | string; -} export type Metric = '_all' | 'aggregations' | 'http' | 'indices' | 'ingest' | 'jvm' | 'os' | 'plugins' | 'process' | 'search_pipelines' | 'settings' | 'thread_pool' | 'transport' @@ -45,8 +40,8 @@ export type NodeInfo = { search_pipelines?: NodeInfoSearchPipelines; settings?: NodeInfoSettings; thread_pool?: Record; - total_indexing_buffer?: number; - total_indexing_buffer_in_bytes?: Common.ByteCount; + total_indexing_buffer?: Common.ByteCount; + total_indexing_buffer_in_bytes?: Common.HumanReadableByteCount; transport?: NodeInfoTransport; transport_address?: Common.TransportAddress; version: Common.VersionString; @@ -189,10 +184,10 @@ export type NodeInfoSettings = { } export type NodeInfoSettingsCluster = { - deprecation_indexing?: DeprecationIndexing; + deprecation_indexing?: NodeInfoSettingsDeprecationIndexing; election?: NodeInfoSettingsClusterElection; - initial_cluster_manager_nodes?: string; - initial_master_nodes?: string; + initial_cluster_manager_nodes?: Common.StringOrStringArray; + initial_master_nodes?: Common.StringOrStringArray; name: Common.Name; routing?: Indices_Common.IndexRouting; } @@ -201,9 +196,13 @@ export type NodeInfoSettingsClusterElection = { strategy: Common.Name; } +export type NodeInfoSettingsDeprecationIndexing = { + enabled: Common.StringifiedBoolean; +} + export type NodeInfoSettingsHttp = { - compression?: boolean | string; - port?: number | string; + compression?: Common.StringifiedBoolean; + port?: Common.StringifiedInteger; type: string; 'type.default'?: string; } @@ -266,7 +265,7 @@ export type NodeInfoSettingsNetwork = { } export type NodeInfoSettingsNode = { - attr: NodeInfoShardIndexingPressureEnabled; + attr: Record; max_local_storage_nodes?: string; name: Common.Name; } @@ -278,10 +277,6 @@ export type NodeInfoSettingsTransport = { 'type.default'?: string; } -export type NodeInfoShardIndexingPressureEnabled = { - shard_indexing_pressure_enabled: string; -} - export type NodeInfoTransport = { bound_address: string[]; profiles: Record; @@ -295,9 +290,10 @@ export type NodeJvmInfo = { mem: NodeInfoJvmMemory; memory_pools?: string[]; pid: number; + start_time?: Common.DateTime; start_time_in_millis: Common.EpochTimeUnitMillis; using_bundled_jdk?: boolean | undefined; - using_compressed_ordinary_object_pointers?: boolean | string; + using_compressed_ordinary_object_pointers?: Common.StringifiedBoolean; version?: Common.VersionString; vm_name?: Common.Name; vm_vendor?: string; @@ -312,6 +308,7 @@ export type NodeOperatingSystemInfo = { mem?: NodeInfoMemory; name?: Common.Name; pretty_name?: Common.Name; + refresh_interval?: Common.Duration; refresh_interval_in_millis: Common.DurationValueUnitMillis; swap?: NodeInfoMemory; version?: Common.VersionString; @@ -320,6 +317,7 @@ export type NodeOperatingSystemInfo = { export type NodeProcessInfo = { id: number; mlockall: boolean; + refresh_interval?: Common.Duration; refresh_interval_in_millis: Common.DurationValueUnitMillis; } @@ -332,8 +330,3 @@ export type NodeThreadPoolInfo = { type: string; } -export type ResponseBase = Nodes_Common.NodesResponseBase & { - cluster_name: Common.Name; - nodes: Record; -} - diff --git a/api/_types/nodes.reload_secure_settings.d.ts b/api/_types/nodes.reload_secure_settings.d.ts index d132fb154..6b4b9e61c 100644 --- a/api/_types/nodes.reload_secure_settings.d.ts +++ b/api/_types/nodes.reload_secure_settings.d.ts @@ -15,10 +15,14 @@ */ import * as Common from './_common' -import * as Nodes_Common from './nodes._common' -export type ResponseBase = Nodes_Common.NodesResponseBase & { - cluster_name: Common.Name; - nodes: Record; +export type NodeReloadError = NodeReloadResponse & { + reload_exception?: Common.ErrorCause; } +export type NodeReloadResponse = { + name: Common.Name; +} + +export type NodeReloadResult = NodeReloadResponse | NodeReloadError + diff --git a/api/_types/nodes.stats.d.ts b/api/_types/nodes.stats.d.ts index 49efb08f2..70b4cfe6c 100644 --- a/api/_types/nodes.stats.d.ts +++ b/api/_types/nodes.stats.d.ts @@ -15,14 +15,644 @@ */ import * as Common from './_common' -import * as Nodes_Common from './nodes._common' +import * as Indices_Stats from './indices.stats' + +export type AdaptiveSelection = { + avg_queue_size?: number; + avg_response_time?: Common.Duration; + avg_response_time_ns?: Common.DurationValueUnitNanos; + avg_service_time?: Common.Duration; + avg_service_time_ns?: Common.DurationValueUnitNanos; + outgoing_searches?: number; + rank?: string; +} + +export type Breaker = { + estimated_size?: Common.HumanReadableByteCount; + estimated_size_in_bytes?: Common.ByteCount; + limit_size?: Common.HumanReadableByteCount; + limit_size_in_bytes?: Common.ByteCount; + overhead?: number; + tripped?: number; +} + +export type CgroupCpuAcctStats = { + control_group?: string; + usage_nanos?: Common.DurationValueUnitNanos; +} + +export type CgroupCpuStat = { + number_of_elapsed_periods?: number; + number_of_times_throttled?: number; + time_throttled_nanos?: Common.DurationValueUnitNanos; +} + +export type CgroupCpuStats = { + cfs_period_micros?: Common.DurationValueUnitMicros; + cfs_quota_micros?: Common.DurationValueUnitMicros; + control_group?: string; + stat?: CgroupCpuStat; +} + +export type CgroupMemoryStats = { + control_group?: string; + limit_in_bytes?: string; + usage_in_bytes?: string; +} + +export type CgroupStats = { + cpu?: CgroupCpuStats; + cpuacct?: CgroupCpuAcctStats; + memory?: CgroupMemoryStats; +} + +export type ClusterStateOverallStats = { + failed_count?: number; + total_time_in_millis?: Common.DurationValueUnitMillis; + update_count?: number; +} + +export type ClusterStateQueue = { + committed?: number; + pending?: number; + total?: number; +} + +export type ClusterStateStats = { + overall?: ClusterStateOverallStats; +} + +export type DataPathStats = { + available?: Common.HumanReadableByteCount; + available_in_bytes?: Common.ByteCount; + cache_reserved?: Common.HumanReadableByteCount; + cache_reserved_in_bytes?: Common.ByteCount; + free?: Common.HumanReadableByteCount; + free_in_bytes?: Common.ByteCount; + mount?: string; + path?: string; + total?: Common.HumanReadableByteCount; + total_in_bytes?: Common.ByteCount; + type?: string; +} + +export type Discovery = { + cluster_state_queue?: ClusterStateQueue; + cluster_state_stats?: ClusterStateStats; + published_cluster_states?: PublishedClusterStates; +} + +export type ExtendedMemoryStats = MemoryStatsBase & { + free_percent?: Common.PercentageNumber; + used_percent?: Common.PercentageNumber; +} + +export type FileSystem = { + data?: DataPathStats[]; + io_stats?: IoStats; + timestamp?: Common.EpochTimeUnitMillis; + total?: FileSystemTotal; +} + +export type FileSystemTotal = { + available?: Common.HumanReadableByteCount; + available_in_bytes?: Common.ByteCount; + cache_reserved?: Common.HumanReadableByteCount; + cache_reserved_in_bytes?: Common.ByteCount; + free?: Common.HumanReadableByteCount; + free_in_bytes?: Common.ByteCount; + total?: Common.HumanReadableByteCount; + total_in_bytes?: Common.ByteCount; +} + +export type GarbageCollector = { + collectors?: Record; +} + +export type GarbageCollectorTotal = { + collection_count?: number; + collection_time?: Common.Duration; + collection_time_in_millis?: Common.DurationValueUnitMillis; +} + +export type Http = { + current_open?: number; + total_opened?: number; +} + +export type IndexingPressure = { + memory?: IndexingPressureMemory; +} + +export type IndexingPressureMemory = { + current?: PressureMemory; + limit?: Common.HumanReadableByteCount; + limit_in_bytes?: Common.ByteCount; + total?: PressureMemory; +} export type IndexMetric = '_all' | 'completion' | 'docs' | 'fielddata' | 'flush' | 'get' | 'indexing' | 'merge' | 'query_cache' | 'recovery' | 'refresh' | 'request_cache' | 'search' | 'segments' | 'store' | 'suggest' | 'translog' | 'warmer' +export type Ingest = { + pipelines?: Record; + total?: IngestTotal; +} + +export type IngestTotal = { + count?: number; + current?: number; + failed?: number; + processors?: Record[]; + time?: Common.Duration; + time_in_millis?: Common.DurationValueUnitMillis; +} + +export type IoStatDevice = { + device_name?: string; + io_time_in_millis?: Common.DurationValueUnitMillis; + operations?: number; + queue_size?: number; + read_kilobytes?: number; + read_operations?: number; + read_time?: number; + write_kilobytes?: number; + write_operations?: number; + write_time?: number; +} + +export type IoStats = { + devices?: IoStatDevice[]; + total?: IoStatDevice; +} + +export type Jvm = { + buffer_pools?: Record; + classes?: JvmClasses; + gc?: GarbageCollector; + mem?: JvmMemoryStats; + threads?: JvmThreads; + timestamp?: Common.EpochTimeUnitMillis; + uptime?: Common.Duration; + uptime_in_millis?: Common.DurationValueUnitMillis; +} + +export type JvmClasses = { + current_loaded_count?: number; + total_loaded_count?: number; + total_unloaded_count?: number; +} + +export type JvmMemoryStats = { + heap_committed?: Common.HumanReadableByteCount; + heap_committed_in_bytes?: Common.ByteCount; + heap_max?: Common.HumanReadableByteCount; + heap_max_in_bytes?: Common.ByteCount; + heap_used?: Common.HumanReadableByteCount; + heap_used_in_bytes?: Common.ByteCount; + heap_used_percent?: Common.PercentageNumber; + non_heap_committed?: Common.HumanReadableByteCount; + non_heap_committed_in_bytes?: Common.ByteCount; + non_heap_used?: Common.HumanReadableByteCount; + non_heap_used_in_bytes?: Common.ByteCount; + pools?: Record; +} + +export type JvmThreads = { + count?: number; + peak_count?: number; +} + +export type KeyedProcessor = { + stats?: Processor; + type?: string; +} + +export type LastGcStats = { + max?: Common.HumanReadableByteCount; + max_in_bytes?: Common.ByteCount; + usage_percent?: Common.PercentageNumber; + used?: Common.HumanReadableByteCount; + used_in_bytes?: Common.ByteCount; +} + +export type MemoryStats = MemoryStatsBase & Record + +export type MemoryStatsBase = { + free?: Common.HumanReadableByteCount; + free_in_bytes?: Common.ByteCount; + total?: Common.HumanReadableByteCount; + total_in_bytes?: Common.ByteCount; + used?: Common.HumanReadableByteCount; + used_in_bytes?: Common.ByteCount; +} + export type Metric = '_all' | 'adaptive_selection' | 'admission_control' | 'breaker' | 'caches' | 'cluster_manager_throttling' | 'discovery' | 'file_cache' | 'fs' | 'http' | 'indexing_pressure' | 'indices' | 'ingest' | 'jvm' | 'os' | 'process' | 'repositories' | 'resource_usage_stats' | 'script' | 'script_cache' | 'search_backpressure' | 'search_pipeline' | 'segment_replication_backpressure' | 'shard_indexing_pressure' | 'task_cancellation' | 'thread_pool' | 'transport' | 'weighted_routing' -export type ResponseBase = Nodes_Common.NodesResponseBase & { - cluster_name?: Common.Name; - nodes: Record; +export type NodeBufferPool = { + count?: number; + total_capacity?: Common.HumanReadableByteCount; + total_capacity_in_bytes?: Common.ByteCount; + used?: Common.HumanReadableByteCount; + used_in_bytes?: Common.ByteCount; +} + +export type NodeIndexShardStats = Indices_Stats.IndexShardStatsBase & Record + +export type NodeIndicesStats = Indices_Stats.IndexStatsBase & { + indices?: Record; + shards?: Record[]>; +} + +export type OperatingSystem = { + cgroup?: CgroupStats; + cpu?: OperatingSystemCpuStats; + mem?: ExtendedMemoryStats; + swap?: MemoryStats; + timestamp?: Common.EpochTimeUnitMillis; +} + +export type OperatingSystemCpuStats = { + load_average?: Record; + percent?: Common.PercentageNumber; +} + +export type Pool = { + last_gc_stats?: LastGcStats; + max?: Common.HumanReadableByteCount; + max_in_bytes?: Common.ByteCount; + peak_max?: Common.HumanReadableByteCount; + peak_max_in_bytes?: Common.ByteCount; + peak_used?: Common.HumanReadableByteCount; + peak_used_in_bytes?: Common.ByteCount; + used?: Common.HumanReadableByteCount; + used_in_bytes?: Common.ByteCount; +} + +export type PressureMemory = { + all?: Common.HumanReadableByteCount; + all_in_bytes?: Common.ByteCount; + combined_coordinating_and_primary?: Common.HumanReadableByteCount; + combined_coordinating_and_primary_in_bytes?: Common.ByteCount; + coordinating?: Common.HumanReadableByteCount; + coordinating_in_bytes?: Common.ByteCount; + coordinating_rejections?: number; + primary?: Common.HumanReadableByteCount; + primary_in_bytes?: Common.ByteCount; + primary_rejections?: number; + replica?: Common.HumanReadableByteCount; + replica_in_bytes?: Common.ByteCount; + replica_rejections?: number; +} + +export type Process = { + cpu?: ProcessCpuStats; + max_file_descriptors?: number; + mem?: ProcessMemoryStats; + open_file_descriptors?: number; + timestamp?: Common.EpochTimeUnitMillis; +} + +export type ProcessCpuStats = { + percent: Common.PercentageNumber; + total?: Common.Duration; + total_in_millis: Common.DurationValueUnitMillis; +} + +export type ProcessMemoryStats = { + total_virtual?: Common.HumanReadableByteCount; + total_virtual_in_bytes?: Common.ByteCount; +} + +export type Processor = { + count?: number; + current?: number; + failed?: number; + time?: Common.Duration; + time_in_millis?: Common.DurationValueUnitMillis; +} + +export type PublishedClusterStates = { + compatible_diffs?: number; + full_states?: number; + incompatible_diffs?: number; +} + +export type RemoteStoreStats = { + last_successful_fetch_of_pinned_timestamps?: Common.EpochTimeUnitSeconds; +} + +export type ScriptCacheStats = { + contexts?: ScriptContextStats[]; + sum: ScriptStats; +} + +export type ScriptContextStats = ScriptStatsBase & { + context: string; +} + +export type ScriptStats = ScriptStatsBase & Record + +export type ScriptStatsBase = { + cache_evictions: number; + compilation_limit_triggered: number; + compilations: number; +} + +export type ShardAdmissionControlStats = { + global_cpu_usage?: UsageStats; + global_io_usage?: UsageStats; +} + +export type ShardCachesStats = Record + +export type ShardCacheStats = { + evictions?: number; + hit_count?: number; + item_count?: number; + miss_count?: number; + size?: Common.HumanReadableByteCount; + size_in_bytes?: Common.ByteCount; + store_name?: string; +} + +export type ShardClusterManagerThrottlingStats = { + stats?: ShardClusterManagerThrottlingStatsDetail; +} + +export type ShardClusterManagerThrottlingStatsDetail = { + throttled_tasks_per_task_type: Record; + total_throttled_tasks: number; +} + +export type ShardIndexingPressurePerShardIndexingStats = { + coordinating_count: number; + coordinating_time_in_millis: Common.DurationValueUnitMillis; + primary_count: number; + primary_time_in_millis: Common.DurationValueUnitMillis; + replica_count: number; + replica_time_in_millis: Common.DurationValueUnitMillis; +} + +export type ShardIndexingPressurePerShardLastSuccessfulTimestamp = { + coordinating_last_successful_request_timestamp_in_millis: Common.EpochTimeUnitMillis; + primary_last_successful_request_timestamp_in_millis: Common.EpochTimeUnitMillis; + replica_last_successful_request_timestamp_in_millis: Common.EpochTimeUnitMillis; +} + +export type ShardIndexingPressurePerShardMemoryAllocationCurrentStats = { + current_coordinating_and_primary_bytes: Common.ByteCount; + current_replica_bytes: Common.ByteCount; +} + +export type ShardIndexingPressurePerShardMemoryAllocationLimitStats = { + current_coordinating_and_primary_limits_in_bytes: Common.ByteCount; + current_replica_limits_in_bytes: Common.ByteCount; +} + +export type ShardIndexingPressurePerShardMemoryAllocationStats = { + current: ShardIndexingPressurePerShardMemoryAllocationCurrentStats; + limit: ShardIndexingPressurePerShardMemoryAllocationLimitStats; +} + +export type ShardIndexingPressurePerShardMemoryStats = { + current: ShardIndexingPressurePerShardMemoryStatsDetails; + total: ShardIndexingPressurePerShardMemoryStatsDetails; +} + +export type ShardIndexingPressurePerShardMemoryStatsDetails = { + coordinating?: Common.HumanReadableByteCount; + coordinating_in_bytes: Common.ByteCount; + primary?: Common.HumanReadableByteCount; + primary_in_bytes: Common.ByteCount; + replica?: Common.HumanReadableByteCount; + replica_in_bytes: Common.ByteCount; +} + +export type ShardIndexingPressurePerShardRejectionCoordinatingStats = { + breakup?: ShardIndexingPressureRejectionsBreakupStats; + breakup_shadow_mode?: ShardIndexingPressureRejectionsBreakupStats; + coordinating_rejections: number; +} + +export type ShardIndexingPressurePerShardRejectionPrimaryStats = { + breakup?: ShardIndexingPressureRejectionsBreakupStats; + breakup_shadow_mode?: ShardIndexingPressureRejectionsBreakupStats; + primary_rejections: number; +} + +export type ShardIndexingPressurePerShardRejectionReplicaStats = { + breakup?: ShardIndexingPressureRejectionsBreakupStats; + breakup_shadow_mode?: ShardIndexingPressureRejectionsBreakupStats; + replica_rejections: number; +} + +export type ShardIndexingPressurePerShardRejectionStats = { + coordinating: ShardIndexingPressurePerShardRejectionCoordinatingStats; + primary: ShardIndexingPressurePerShardRejectionPrimaryStats; + replica: ShardIndexingPressurePerShardRejectionReplicaStats; +} + +export type ShardIndexingPressurePerShardStats = { + indexing: ShardIndexingPressurePerShardIndexingStats; + last_successful_timestamp: ShardIndexingPressurePerShardLastSuccessfulTimestamp; + memory: ShardIndexingPressurePerShardMemoryStats; + memory_allocation: ShardIndexingPressurePerShardMemoryAllocationStats; + rejection: ShardIndexingPressurePerShardRejectionStats; +} + +export type ShardIndexingPressureRejectionsBreakupStats = { + no_successful_request_limits?: number; + node_limits?: number; + throughput_degradation_limits?: number; +} + +export type ShardIndexingPressureStats = { + enabled?: boolean; + enforced?: boolean; + stats?: Record; + total_rejections_breakup?: ShardIndexingPressureRejectionsBreakupStats; + total_rejections_breakup_shadow_mode?: ShardIndexingPressureRejectionsBreakupStats; +} + +export type ShardRepositoriesStats = any[] + +export type ShardResourceUsageStats = Record + +export type ShardResourceUsageStatsDetail = { + cpu_utilization_percent?: Common.PercentageString; + io_usage_stats?: ShardResourceUsageStatsIoUsageStats; + memory_utilization_percent?: Common.PercentageString; + timestamp?: Common.EpochTimeUnitMillis; +} + +export type ShardResourceUsageStatsIoUsageStats = { + max_io_utilization_percent?: Common.PercentageString; +} + +export type ShardSearchBackpressureMode = 'disabled' | 'enforced' | 'monitor_only' + +export type ShardSearchBackpressureStats = { + mode?: ShardSearchBackpressureMode; + search_shard_task?: ShardSearchBackpressureTaskStats; + search_task?: ShardSearchBackpressureTaskStats; +} + +export type ShardSearchBackpressureTaskCancellationStats = { + cancellation_count?: number; + cancellation_limit_reached_count?: number; + cancelled_task_percentage?: Common.PercentageNumber; + current_cancellation_eligible_tasks_count?: number; +} + +export type ShardSearchBackpressureTaskResourceTrackerCpuUsageTrackerStats = { + cancellation_count?: number; + current_avg?: Common.Duration; + current_avg_millis?: Common.DurationValueUnitMillis; + current_max?: Common.Duration; + current_max_millis?: Common.DurationValueUnitMillis; +} + +export type ShardSearchBackpressureTaskResourceTrackerElapsedTimeTrackerStats = { + cancellation_count?: number; + current_avg?: Common.Duration; + current_avg_millis?: Common.DurationValueUnitMillis; + current_max?: Common.Duration; + current_max_millis?: Common.DurationValueUnitMillis; +} + +export type ShardSearchBackpressureTaskResourceTrackerHeapUsageTrackerStats = { + cancellation_count?: number; + current_avg?: Common.HumanReadableByteCount; + current_avg_bytes?: Common.ByteCount; + current_max?: Common.HumanReadableByteCount; + current_max_bytes?: Common.ByteCount; + rolling_avg?: Common.HumanReadableByteCount; + rolling_avg_bytes?: Common.ByteCount; +} + +export type ShardSearchBackpressureTaskResourceTrackerStats = { + cpu_usage_tracker?: ShardSearchBackpressureTaskResourceTrackerCpuUsageTrackerStats; + elapsed_time_tracker?: ShardSearchBackpressureTaskResourceTrackerElapsedTimeTrackerStats; + heap_usage_tracker?: ShardSearchBackpressureTaskResourceTrackerHeapUsageTrackerStats; +} + +export type ShardSearchBackpressureTaskStats = { + cancellation_stats?: ShardSearchBackpressureTaskCancellationStats; + completion_count?: number; + resource_tracker_stats?: ShardSearchBackpressureTaskResourceTrackerStats; +} + +export type ShardSearchPipelineOperationStats = { + count?: number; + current?: number; + failed?: number; + time?: Common.Duration; + time_in_millis?: Common.DurationValueUnitMillis; +} + +export type ShardSearchPipelinePerPipelineProcessorStats = { + stats?: ShardSearchPipelineOperationStats; + type?: string; +} + +export type ShardSearchPipelinePerPipelineStats = { + request?: ShardSearchPipelineOperationStats; + request_processors?: ShardSearchPipelinePerPipelineProcessorStats[]; + response?: ShardSearchPipelineOperationStats; + response_processors?: Record[]; +} + +export type ShardSearchPipelineStats = { + pipelines?: Record; + total_request?: ShardSearchPipelineOperationStats; + total_response?: ShardSearchPipelineOperationStats; +} + +export type ShardSegmentReplicationBackpressureStats = { + total_rejected_requests?: number; +} + +export type ShardTaskCancellationStats = { + search_shard_task?: ShardTaskCancellationStatsDetail; +} + +export type ShardTaskCancellationStatsDetail = { + current_count_post_cancel?: number; + total_count_post_cancel?: number; +} + +export type ShardWeightedRoutingStats = { + stats?: ShardWeightedRoutingStatsDetail; +} + +export type ShardWeightedRoutingStatsDetail = { + fail_open_count?: number; +} + +export type Stats = { + adaptive_selection?: Record; + admission_control?: ShardAdmissionControlStats; + attributes?: Record; + breakers?: Record; + caches?: ShardCachesStats; + cluster_manager_throttling?: ShardClusterManagerThrottlingStats; + discovery?: Discovery; + fs?: FileSystem; + host?: Common.Host; + http?: Http; + indexing_pressure?: IndexingPressure; + indices?: NodeIndicesStats; + ingest?: Ingest; + ip?: Common.Ip | Common.Ip[]; + jvm?: Jvm; + name?: Common.Name; + os?: OperatingSystem; + process?: Process; + remote_store?: RemoteStoreStats; + repositories?: ShardRepositoriesStats; + resource_usage_stats?: ShardResourceUsageStats; + roles?: Common.NodeRoles; + script?: ScriptStats; + script_cache?: ScriptCacheStats; + search_backpressure?: ShardSearchBackpressureStats; + search_pipeline?: ShardSearchPipelineStats; + segment_replication_backpressure?: ShardSegmentReplicationBackpressureStats; + shard_indexing_pressure?: ShardIndexingPressureStats; + task_cancellation?: ShardTaskCancellationStats; + thread_pool?: Record; + timestamp?: Common.EpochTimeUnitMillis; + transport?: Transport; + transport_address?: Common.TransportAddress; + weighted_routing?: ShardWeightedRoutingStats; +} + +export type ThreadCount = { + active?: number; + completed?: number; + largest?: number; + queue?: number; + rejected?: number; + threads?: number; + total_wait_time?: Common.Duration; + total_wait_time_in_nanos?: Common.DurationValueUnitNanos; +} + +export type Transport = { + rx_count?: number; + rx_size?: Common.HumanReadableByteCount; + rx_size_in_bytes?: Common.ByteCount; + server_open?: number; + total_outbound_connections?: number; + tx_count?: number; + tx_size?: Common.HumanReadableByteCount; + tx_size_in_bytes?: Common.ByteCount; +} + +export type TransportUsageStats = { + rejection_count?: Record; +} + +export type UsageStats = { + transport?: TransportUsageStats; } diff --git a/api/_types/nodes.usage.d.ts b/api/_types/nodes.usage.d.ts index 214d08e03..c335c8c13 100644 --- a/api/_types/nodes.usage.d.ts +++ b/api/_types/nodes.usage.d.ts @@ -15,19 +15,13 @@ */ import * as Common from './_common' -import * as Nodes_Common from './nodes._common' export type Metric = '_all' | 'aggregations' | 'rest_actions' export type NodeUsage = { - aggregations?: Record>; + aggregations?: Record; rest_actions?: Record; since: Common.EpochTimeUnitMillis; timestamp: Common.EpochTimeUnitMillis; } -export type ResponseBase = Nodes_Common.NodesResponseBase & { - cluster_name: Common.Name; - nodes: Record; -} - diff --git a/api/cat/aliases.js b/api/cat/aliases.js index 1b3bdef26..bc97b7452 100644 --- a/api/cat/aliases.js +++ b/api/cat/aliases.js @@ -19,7 +19,7 @@ const { normalizeArguments, parsePathParam } = require('../utils'); /** - * Shows information about currently configured aliases to indexes including filter and routing info. + * Shows information about aliases currently configured to indexes, including filter and routing information. *
See Also: {@link https://opensearch.org/docs/latest/api-reference/cat/cat-aliases/ - cat.aliases} * * @memberOf API-Cat diff --git a/api/cat/allPitSegments.js b/api/cat/allPitSegments.js index 8c4ef2e38..fb383d07b 100644 --- a/api/cat/allPitSegments.js +++ b/api/cat/allPitSegments.js @@ -19,18 +19,18 @@ const { normalizeArguments } = require('../utils'); /** - * Lists all active point-in-time segments. + * Lists all active CAT point-in-time segments. *
See Also: {@link https://opensearch.org/docs/latest/search-plugins/point-in-time-api/ - cat.all_pit_segments} * * @memberOf API-Cat * * @param {object} [params] - * @param {string} [params.bytes] - The unit in which to display byte values. - * @param {string} [params.format] - A short version of the Accept header (for example, `json`, `yaml`). - * @param {array} [params.h] - Comma-separated list of column names to display. + * @param {string} [params.bytes] - The units used to display byte values. + * @param {string} [params.format] - A short version of the `Accept` header, such as `json` or `yaml`. + * @param {array} [params.h] - A comma-separated list of column names to display. * @param {boolean} [params.help=false] - Return help information. - * @param {array} [params.s] - Comma-separated list of column names or column aliases to sort by. - * @param {boolean} [params.v=false] - Verbose mode. Display column headers. + * @param {array} [params.s] - A comma-separated list of column names or column aliases to sort by. + * @param {boolean} [params.v=false] - Enables verbose mode, which displays column headers. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/cat/clusterManager.js b/api/cat/clusterManager.js index e82c62ed5..12e350f5a 100644 --- a/api/cat/clusterManager.js +++ b/api/cat/clusterManager.js @@ -29,7 +29,7 @@ const { normalizeArguments } = require('../utils'); * @param {string} [params.format] - A short version of the HTTP `Accept` header, such as `json` or `yaml`. * @param {array} [params.h] - A comma-separated list of column names to display. * @param {boolean} [params.help=false] - Return help information. - * @param {boolean} [params.local=false] - Return local information, do not retrieve the state from cluster-manager node. + * @param {boolean} [params.local=false] - Returns local information but does not retrieve the state from the cluster manager node. * @param {string} [params.master_timeout] DEPRECATED - A timeout for connection to the cluster manager node. * @param {array} [params.s] - A comma-separated list of column names or column aliases to sort by. * @param {boolean} [params.v=false] - Enables verbose mode, which displays column headers. diff --git a/api/cat/count.js b/api/cat/count.js index c4b875919..9862740d5 100644 --- a/api/cat/count.js +++ b/api/cat/count.js @@ -19,17 +19,17 @@ const { normalizeArguments, parsePathParam } = require('../utils'); /** - * Provides quick access to the document count of the entire cluster, or individual indexes. + * Provides quick access to the document count of the entire cluster or of an individual index. *
See Also: {@link https://opensearch.org/docs/latest/api-reference/cat/cat-count/ - cat.count} * * @memberOf API-Cat * * @param {object} [params] - * @param {string} [params.format] - A short version of the Accept header (for example, `json`, `yaml`). - * @param {array} [params.h] - Comma-separated list of column names to display. + * @param {string} [params.format] - A short version of the `Accept` header, such as `json` or `yaml`. + * @param {array} [params.h] - A comma-separated list of column names to display. * @param {boolean} [params.help=false] - Return help information. - * @param {array} [params.s] - Comma-separated list of column names or column aliases to sort by. - * @param {boolean} [params.v=false] - Verbose mode. Display column headers. + * @param {array} [params.s] - A comma-separated list of column names or column aliases to sort by. + * @param {boolean} [params.v=false] - Enables verbose mode, which displays column headers. * @param {string} [params.index] - Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} diff --git a/api/cat/fielddata.js b/api/cat/fielddata.js index bc00d45ac..bb9417b24 100644 --- a/api/cat/fielddata.js +++ b/api/cat/fielddata.js @@ -25,13 +25,13 @@ const { normalizeArguments, parsePathParam } = require('../utils'); * @memberOf API-Cat * * @param {object} [params] - * @param {string} [params.bytes] - The unit used to display byte values. - * @param {string} [params.fields] - Comma-separated list of fields used to limit returned information. To retrieve all fields, omit this parameter. - * @param {string} [params.format] - A short version of the Accept header (for example, `json`, `yaml`). - * @param {array} [params.h] - Comma-separated list of column names to display. + * @param {string} [params.bytes] - The units used to display byte values. + * @param {string} [params.fields] - A comma-separated list of fields used to limit the amount of returned information. To retrieve all fields, omit this parameter. + * @param {string} [params.format] - A short version of the `Accept` header, such as `json` or `yaml`. + * @param {array} [params.h] - A comma-separated list of column names to display. * @param {boolean} [params.help=false] - Return help information. - * @param {array} [params.s] - Comma-separated list of column names or column aliases to sort by. - * @param {boolean} [params.v=false] - Verbose mode. Display column headers. + * @param {array} [params.s] - A comma-separated list of column names or column aliases to sort by. + * @param {boolean} [params.v=false] - Enables verbose mode, which displays column headers. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/cat/health.js b/api/cat/health.js index 90cd42e6e..33ec3cca9 100644 --- a/api/cat/health.js +++ b/api/cat/health.js @@ -25,13 +25,13 @@ const { normalizeArguments } = require('../utils'); * @memberOf API-Cat * * @param {object} [params] - * @param {string} [params.format] - A short version of the Accept header (for example, `json`, `yaml`). - * @param {array} [params.h] - Comma-separated list of column names to display. + * @param {string} [params.format] - A short version of the `Accept` header, such as `json` or `yaml`. + * @param {array} [params.h] - A comma-separated list of column names to display. * @param {boolean} [params.help=false] - Return help information. - * @param {array} [params.s] - Comma-separated list of column names or column aliases to sort by. + * @param {array} [params.s] - A comma-separated list of column names or column aliases to sort by. * @param {string} [params.time] - The unit used to display time values. - * @param {boolean} [params.ts=true] - If `true`, returns `HH:MM:SS` and Unix epoch timestamps. - * @param {boolean} [params.v=false] - Verbose mode. Display column headers. + * @param {boolean} [params.ts=true] - When `true`, returns `HH:MM:SS` and Unix epoch timestamps. + * @param {boolean} [params.v=false] - Enables verbose mode, which displays column headers. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/cat/indices.js b/api/cat/indices.js index 6da93dde8..28c9cdfb9 100644 --- a/api/cat/indices.js +++ b/api/cat/indices.js @@ -19,27 +19,27 @@ const { normalizeArguments, parsePathParam } = require('../utils'); /** - * Returns information about indexes: number of primaries and replicas, document counts, disk size, ... + * Lists information related to indexes, that is, how much disk space they are using, how many shards they have, their health status, and so on. *
See Also: {@link https://opensearch.org/docs/latest/api-reference/cat/cat-indices/ - cat.indices} * * @memberOf API-Cat * * @param {object} [params] - * @param {string} [params.bytes] - The unit used to display byte values. - * @param {string} [params.cluster_manager_timeout] - Operation timeout for connection to cluster-manager node. + * @param {string} [params.bytes] - The units used to display byte values. + * @param {string} [params.cluster_manager_timeout] - The amount of time allowed to establish a connection to the cluster manager node. * @param {string} [params.expand_wildcards] - The type of index that wildcard patterns can match. - * @param {string} [params.format] - A short version of the Accept header (for example, `json`, `yaml`). - * @param {array} [params.h] - Comma-separated list of column names to display. - * @param {string} [params.health] - The health status used to limit returned indexes. By default, the response includes indexes of any health status. + * @param {string} [params.format] - A short version of the `Accept` header, such as `json` or `yaml`. + * @param {array} [params.h] - A comma-separated list of column names to display. + * @param {string} [params.health] - Limits indexes based on their health status. Supported values are `green`, `yellow`, and `red`. * @param {boolean} [params.help=false] - Return help information. - * @param {boolean} [params.include_unloaded_segments=false] - If `true`, the response includes information from segments that are not loaded into memory. - * @param {boolean} [params.local=false] - Return local information, do not retrieve the state from cluster-manager node. - * @param {string} [params.master_timeout] DEPRECATED - Operation timeout for connection to cluster-manager node. - * @param {boolean} [params.pri=false] - If `true`, the response only includes information from primary shards. - * @param {array} [params.s] - Comma-separated list of column names or column aliases to sort by. - * @param {string} [params.time] - The unit used to display time values. - * @param {boolean} [params.v=false] - Verbose mode. Display column headers. - * @param {string} [params.index] - Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. + * @param {boolean} [params.include_unloaded_segments=false] - Whether to include information from segments not loaded into memory. + * @param {boolean} [params.local=false] - Returns local information but does not retrieve the state from the cluster manager node. + * @param {string} [params.master_timeout] DEPRECATED - The amount of time allowed to establish a connection to the cluster manager node. + * @param {boolean} [params.pri=false] - When `true`, returns information only from the primary shards. + * @param {array} [params.s] - A comma-separated list of column names or column aliases to sort by. + * @param {string} [params.time] - Specifies the time units. + * @param {boolean} [params.v=false] - Enables verbose mode, which displays column headers. + * @param {string} [params.index] - A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/cat/master.js b/api/cat/master.js index b595a5f8b..24ce0e671 100644 --- a/api/cat/master.js +++ b/api/cat/master.js @@ -25,14 +25,14 @@ const { normalizeArguments } = require('../utils'); * @memberOf API-Cat * * @param {object} [params] - * @param {string} [params.cluster_manager_timeout] - Operation timeout for connection to cluster-manager node. - * @param {string} [params.format] - A short version of the Accept header (for example, `json`, `yaml`). - * @param {array} [params.h] - Comma-separated list of column names to display. + * @param {string} [params.cluster_manager_timeout] - The amount of time allowed to establish a connection to the cluster manager node. + * @param {string} [params.format] - A short version of the `Accept` header, such as `json` or `yaml`. + * @param {array} [params.h] - A comma-separated list of column names to display. * @param {boolean} [params.help=false] - Return help information. - * @param {boolean} [params.local=false] - Return local information, do not retrieve the state from cluster-manager node. - * @param {string} [params.master_timeout] DEPRECATED - Operation timeout for connection to cluster-manager node. - * @param {array} [params.s] - Comma-separated list of column names or column aliases to sort by. - * @param {boolean} [params.v=false] - Verbose mode. Display column headers. + * @param {boolean} [params.local=false] - Returns local information but does not retrieve the state from the cluster manager node. + * @param {string} [params.master_timeout] DEPRECATED - The amount of time allowed to establish a connection to the cluster manager node. + * @param {array} [params.s] - A comma-separated list of column names or column aliases to sort by. + * @param {boolean} [params.v=false] - Enables verbose mode, which displays column headers. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/cat/nodeattrs.js b/api/cat/nodeattrs.js index 1b736abe8..4e8fdcce2 100644 --- a/api/cat/nodeattrs.js +++ b/api/cat/nodeattrs.js @@ -25,14 +25,14 @@ const { normalizeArguments } = require('../utils'); * @memberOf API-Cat * * @param {object} [params] - * @param {string} [params.cluster_manager_timeout] - Operation timeout for connection to cluster-manager node. - * @param {string} [params.format] - A short version of the Accept header (for example, `json`, `yaml`). - * @param {array} [params.h] - Comma-separated list of column names to display. + * @param {string} [params.cluster_manager_timeout] - The amount of time allowed to establish a connection to the cluster manager node. + * @param {string} [params.format] - A short version of the `Accept` header, such as `json` or `yaml`. + * @param {array} [params.h] - A comma-separated list of column names to display. * @param {boolean} [params.help=false] - Return help information. - * @param {boolean} [params.local=false] - Return local information, do not retrieve the state from cluster-manager node. - * @param {string} [params.master_timeout] DEPRECATED - Operation timeout for connection to cluster-manager node. - * @param {array} [params.s] - Comma-separated list of column names or column aliases to sort by. - * @param {boolean} [params.v=false] - Verbose mode. Display column headers. + * @param {boolean} [params.local=false] - Returns local information but does not retrieve the state from the cluster manager node. + * @param {string} [params.master_timeout] DEPRECATED - The amount of time allowed to establish a connection to the cluster manager node. + * @param {array} [params.s] - A comma-separated list of column names or column aliases to sort by. + * @param {boolean} [params.v=false] - Enables verbose mode, which displays column headers. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/cat/nodes.js b/api/cat/nodes.js index d0ecd8cd0..2c49ea699 100644 --- a/api/cat/nodes.js +++ b/api/cat/nodes.js @@ -19,23 +19,23 @@ const { normalizeArguments } = require('../utils'); /** - * Returns basic statistics about performance of cluster nodes. + * Returns basic statistics about the performance of cluster nodes. *
See Also: {@link https://opensearch.org/docs/latest/api-reference/cat/cat-nodes/ - cat.nodes} * * @memberOf API-Cat * * @param {object} [params] - * @param {string} [params.bytes] - The unit used to display byte values. - * @param {string} [params.cluster_manager_timeout] - Operation timeout for connection to cluster-manager node. - * @param {string} [params.format] - A short version of the Accept header (for example, `json`, `yaml`). - * @param {string} [params.full_id=false] - If `true`, return the full node ID. If `false`, return the shortened node ID. - * @param {array} [params.h] - Comma-separated list of column names to display. + * @param {string} [params.bytes] - The units used to display byte values. + * @param {string} [params.cluster_manager_timeout] - The amount of time allowed to establish a connection to the cluster manager node. + * @param {string} [params.format] - A short version of the `Accept` header, such as `json` or `yaml`. + * @param {string} [params.full_id=false] - When `true`, returns the full node ID. When `false`, returns the shortened node ID. + * @param {array} [params.h] - A comma-separated list of column names to display. * @param {boolean} [params.help=false] - Return help information. - * @param {boolean} [params.local=false] DEPRECATED - Return local information, do not retrieve the state from cluster-manager node. - * @param {string} [params.master_timeout] DEPRECATED - Operation timeout for connection to cluster-manager node. - * @param {array} [params.s] - Comma-separated list of column names or column aliases to sort by. - * @param {string} [params.time] - The unit in which to display time values. - * @param {boolean} [params.v=false] - Verbose mode. Display column headers. + * @param {boolean} [params.local=false] DEPRECATED - Returns local information but does not retrieve the state from the cluster manager node. + * @param {string} [params.master_timeout] DEPRECATED - The amount of time allowed to establish a connection to the cluster manager node. + * @param {array} [params.s] - A comma-separated list of column names or column aliases to sort by. + * @param {string} [params.time] - Specifies the time units, for example, `5d` or `7h`. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/). + * @param {boolean} [params.v=false] - Enables verbose mode, which displays column headers. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/cat/pendingTasks.js b/api/cat/pendingTasks.js index 9f8e23a01..b8447523c 100644 --- a/api/cat/pendingTasks.js +++ b/api/cat/pendingTasks.js @@ -19,21 +19,21 @@ const { normalizeArguments } = require('../utils'); /** - * Returns a concise representation of the cluster pending tasks. + * Returns a concise representation of the cluster's pending tasks. *
See Also: {@link https://opensearch.org/docs/latest/api-reference/cat/cat-pending-tasks/ - cat.pending_tasks} * * @memberOf API-Cat * * @param {object} [params] - * @param {string} [params.cluster_manager_timeout] - Operation timeout for connection to cluster-manager node. - * @param {string} [params.format] - A short version of the Accept header (for example, `json`, `yaml`). - * @param {array} [params.h] - Comma-separated list of column names to display. + * @param {string} [params.cluster_manager_timeout] - The amount of time allowed to establish a connection to the cluster manager node. + * @param {string} [params.format] - A short version of the `Accept` header, such as `json` or `yaml`. + * @param {array} [params.h] - A comma-separated list of column names to display. * @param {boolean} [params.help=false] - Return help information. - * @param {boolean} [params.local=false] - Return local information, do not retrieve the state from cluster-manager node. - * @param {string} [params.master_timeout] DEPRECATED - Operation timeout for connection to cluster-manager node. - * @param {array} [params.s] - Comma-separated list of column names or column aliases to sort by. - * @param {string} [params.time] - The unit in which to display time values. - * @param {boolean} [params.v=false] - Verbose mode. Display column headers. + * @param {boolean} [params.local=false] - Returns local information but does not retrieve the state from the cluster manager node. + * @param {string} [params.master_timeout] DEPRECATED - The amount of time allowed to establish a connection to the cluster manager node. + * @param {array} [params.s] - A comma-separated list of column names or column aliases to sort by. + * @param {string} [params.time] - Specifies the time units, for example, `5d` or `7h`. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/). + * @param {boolean} [params.v=false] - Enables verbose mode, which displays column headers. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/cat/pitSegments.js b/api/cat/pitSegments.js index 480821dda..9ceafdf23 100644 --- a/api/cat/pitSegments.js +++ b/api/cat/pitSegments.js @@ -19,18 +19,18 @@ const { normalizeArguments } = require('../utils'); /** - * List segments for one or several PITs. + * Lists one or several CAT point-in-time segments. *
See Also: {@link https://opensearch.org/docs/latest/search-plugins/point-in-time-api/ - cat.pit_segments} * * @memberOf API-Cat * * @param {object} [params] - * @param {string} [params.bytes] - The unit in which to display byte values. - * @param {string} [params.format] - A short version of the Accept header (for example, `json`, `yaml`). - * @param {array} [params.h] - Comma-separated list of column names to display. + * @param {string} [params.bytes] - The units used to display byte values. + * @param {string} [params.format] - A short version of the `Accept` header, such as `json` or `yaml`. + * @param {array} [params.h] - A comma-separated list of column names to display. * @param {boolean} [params.help=false] - Return help information. - * @param {array} [params.s] - Comma-separated list of column names or column aliases to sort by. - * @param {boolean} [params.v=false] - Verbose mode. Display column headers. + * @param {array} [params.s] - A comma-separated list of column names or column aliases to sort by. + * @param {boolean} [params.v=false] - Enables verbose mode, which displays column headers. * @param {object} [params.body] * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} diff --git a/api/cat/plugins.js b/api/cat/plugins.js index 9711d4043..d5b8c2656 100644 --- a/api/cat/plugins.js +++ b/api/cat/plugins.js @@ -19,20 +19,20 @@ const { normalizeArguments } = require('../utils'); /** - * Returns information about installed plugins across nodes node. + * Returns information about the names, components, and versions of the installed plugins. *
See Also: {@link https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/ - cat.plugins} * * @memberOf API-Cat * * @param {object} [params] - * @param {string} [params.cluster_manager_timeout] - Operation timeout for connection to cluster-manager node. - * @param {string} [params.format] - A short version of the Accept header (for example, `json`, `yaml`). - * @param {array} [params.h] - Comma-separated list of column names to display. + * @param {string} [params.cluster_manager_timeout] - The amount of time allowed to establish a connection to the cluster manager node. + * @param {string} [params.format] - A short version of the `Accept` header, such as `json` or `yaml`. + * @param {array} [params.h] - A comma-separated list of column names to display. * @param {boolean} [params.help=false] - Return help information. - * @param {boolean} [params.local=false] - Return local information, do not retrieve the state from cluster-manager node. - * @param {string} [params.master_timeout] DEPRECATED - Operation timeout for connection to cluster-manager node. - * @param {array} [params.s] - Comma-separated list of column names or column aliases to sort by. - * @param {boolean} [params.v=false] - Verbose mode. Display column headers. + * @param {boolean} [params.local=false] - Returns local information but does not retrieve the state from the cluster manager node. + * @param {string} [params.master_timeout] DEPRECATED - The amount of time allowed to establish a connection to the cluster manager node. + * @param {array} [params.s] - A comma-separated list of column names or column aliases to sort by. + * @param {boolean} [params.v=false] - Enables verbose mode, which displays column headers. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/cat/recovery.js b/api/cat/recovery.js index 79eb2b76e..871e4af72 100644 --- a/api/cat/recovery.js +++ b/api/cat/recovery.js @@ -19,22 +19,22 @@ const { normalizeArguments, parsePathParam } = require('../utils'); /** - * Returns information about index shard recoveries, both on-going completed. + * Returns all completed and ongoing index and shard recoveries. *
See Also: {@link https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/ - cat.recovery} * * @memberOf API-Cat * * @param {object} [params] * @param {boolean} [params.active_only=false] - If `true`, the response only includes ongoing shard recoveries. - * @param {string} [params.bytes] - The unit used to display byte values. - * @param {boolean} [params.detailed=false] - If `true`, the response includes detailed information about shard recoveries. - * @param {string} [params.format] - A short version of the Accept header (for example, `json`, `yaml`). - * @param {array} [params.h] - Comma-separated list of column names to display. + * @param {string} [params.bytes] - The units used to display byte values. + * @param {boolean} [params.detailed=false] - When `true`, includes detailed information about shard recoveries. + * @param {string} [params.format] - A short version of the `Accept` header, such as `json` or `yaml`. + * @param {array} [params.h] - A comma-separated list of column names to display. * @param {boolean} [params.help=false] - Return help information. * @param {string} [params.index] - A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. - * @param {array} [params.s] - Comma-separated list of column names or column aliases to sort by. - * @param {string} [params.time] - The unit in which to display time values. - * @param {boolean} [params.v=false] - Verbose mode. Display column headers. + * @param {array} [params.s] - A comma-separated list of column names or column aliases to sort by. + * @param {string} [params.time] - Specifies the time units, for example, `5d` or `7h`. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/). + * @param {boolean} [params.v=false] - Enables verbose mode, which displays column headers. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/cat/repositories.js b/api/cat/repositories.js index 6089d18fe..106da75b0 100644 --- a/api/cat/repositories.js +++ b/api/cat/repositories.js @@ -19,20 +19,20 @@ const { normalizeArguments } = require('../utils'); /** - * Returns information about snapshot repositories registered in the cluster. + * Returns information about all snapshot repositories for a cluster. *
See Also: {@link https://opensearch.org/docs/latest/api-reference/cat/cat-repositories/ - cat.repositories} * * @memberOf API-Cat * * @param {object} [params] - * @param {string} [params.cluster_manager_timeout] - Operation timeout for connection to cluster-manager node. - * @param {string} [params.format] - A short version of the Accept header (for example, `json`, `yaml`). - * @param {array} [params.h] - Comma-separated list of column names to display. + * @param {string} [params.cluster_manager_timeout] - The amount of time allowed to establish a connection to the cluster manager node. + * @param {string} [params.format] - A short version of the `Accept` header, such as `json` or `yaml`. + * @param {array} [params.h] - A comma-separated list of column names to display. * @param {boolean} [params.help=false] - Return help information. - * @param {boolean} [params.local=false] - Return local information, do not retrieve the state from cluster-manager node. - * @param {string} [params.master_timeout] DEPRECATED - Operation timeout for connection to cluster-manager node. - * @param {array} [params.s] - Comma-separated list of column names or column aliases to sort by. - * @param {boolean} [params.v=false] - Verbose mode. Display column headers. + * @param {boolean} [params.local=false] - Returns local information but does not retrieve the state from the cluster manager node. + * @param {string} [params.master_timeout] DEPRECATED - The amount of time allowed to establish a connection to the cluster manager node. + * @param {array} [params.s] - A comma-separated list of column names or column aliases to sort by. + * @param {boolean} [params.v=false] - Enables verbose mode, which displays column headers. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/cat/segmentReplication.js b/api/cat/segmentReplication.js index c535f2d62..e9a1d6fba 100644 --- a/api/cat/segmentReplication.js +++ b/api/cat/segmentReplication.js @@ -19,29 +19,30 @@ const { normalizeArguments, parsePathParam } = require('../utils'); /** - * Returns information about both on-going and latest completed Segment Replication events. + * Returns information about active and last-completed segment replication events on each replica shard, including related shard-level metrics. +These metrics provide information about how far behind the primary shard the replicas are lagging. *
See Also: {@link https://opensearch.org/docs/latest/api-reference/cat/cat-segment-replication/ - cat.segment_replication} * * @memberOf API-Cat * * @param {object} [params] - * @param {boolean} [params.active_only=false] - If `true`, the response only includes ongoing segment replication events. - * @param {boolean} [params.allow_no_indices] - Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified). - * @param {string} [params.bytes] - The unit in which to display byte values. - * @param {boolean} [params.completed_only=false] - If `true`, the response only includes latest completed segment replication events. - * @param {boolean} [params.detailed=false] - If `true`, the response includes detailed information about segment replications. - * @param {string} [params.expand_wildcards] - Whether to expand wildcard expression to concrete indexes that are open, closed or both. - * @param {string} [params.format] - A short version of the Accept header (for example, `json`, `yaml`). - * @param {array} [params.h] - Comma-separated list of column names to display. + * @param {boolean} [params.active_only=false] - When `true`, the response only includes ongoing segment replication events. + * @param {boolean} [params.allow_no_indices] - Whether to ignore the index if a wildcard index expression resolves to no concrete indexes. This includes the `_all` string or when no indexes have been specified. + * @param {string} [params.bytes] - The units used to display byte values. + * @param {boolean} [params.completed_only=false] - When `true`, the response only includes the last-completed segment replication events. + * @param {boolean} [params.detailed=false] - When `true`, the response includes additional metrics for each stage of a segment replication event. + * @param {string} [params.expand_wildcards] - Whether to expand the wildcard expression to include concrete indexes that are open, closed, or both. + * @param {string} [params.format] - A short version of the `Accept` header, such as `json` or `yaml`. + * @param {array} [params.h] - A comma-separated list of column names to display. * @param {boolean} [params.help=false] - Return help information. - * @param {boolean} [params.ignore_throttled] - Whether specified concrete, expanded or aliased indexes should be ignored when throttled. - * @param {boolean} [params.ignore_unavailable] - Whether specified concrete indexes should be ignored when unavailable (missing or closed). - * @param {array} [params.index] - Comma-separated list or wildcard expression of index names to limit the returned information. - * @param {array} [params.s] - Comma-separated list of column names or column aliases to sort by. - * @param {array} [params.shards] - Comma-separated list of shards to display. - * @param {string} [params.time] - The unit in which to display time values. - * @param {string} [params.timeout] - Operation timeout. - * @param {boolean} [params.v=false] - Verbose mode. Display column headers. + * @param {boolean} [params.ignore_throttled] - Whether specified concrete, expanded, or aliased indexes should be ignored when throttled. + * @param {boolean} [params.ignore_unavailable] - Whether the specified concrete indexes should be ignored when missing or closed. + * @param {array} [params.index] - A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. + * @param {array} [params.s] - A comma-separated list of column names or column aliases to sort by. + * @param {array} [params.shards] - A comma-separated list of shards to display. + * @param {string} [params.time] - Specifies the time units, for example, `5d` or `7h`. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/). + * @param {string} [params.timeout] - The operation timeout. + * @param {boolean} [params.v=false] - Enables verbose mode, which displays column headers. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/cat/segments.js b/api/cat/segments.js index 8bab19c43..e3a7b951d 100644 --- a/api/cat/segments.js +++ b/api/cat/segments.js @@ -25,14 +25,14 @@ const { normalizeArguments, parsePathParam } = require('../utils'); * @memberOf API-Cat * * @param {object} [params] - * @param {string} [params.bytes] - The unit used to display byte values. - * @param {string} [params.cluster_manager_timeout] - Operation timeout for connection to cluster-manager node. - * @param {string} [params.format] - A short version of the Accept header (for example, `json`, `yaml`). - * @param {array} [params.h] - Comma-separated list of column names to display. - * @param {boolean} [params.help=false] - Return help information. - * @param {string} [params.master_timeout] DEPRECATED - Operation timeout for connection to cluster-manager node. - * @param {array} [params.s] - Comma-separated list of column names or column aliases to sort by. - * @param {boolean} [params.v=false] - Verbose mode. Display column headers. + * @param {string} [params.bytes] - The units used to display byte values. + * @param {string} [params.cluster_manager_timeout] - The amount of time allowed to establish a connection to the cluster manager node. + * @param {string} [params.format] - A short version of the `Accept` header, such as `json` or `yaml`. + * @param {array} [params.h] - A comma-separated list of column names to display. + * @param {boolean} [params.help=false] - Returns help information. + * @param {string} [params.master_timeout] DEPRECATED - The amount of time allowed to establish a connection to the cluster manager node. + * @param {array} [params.s] - A comma-separated list of column names or column aliases to sort by. + * @param {boolean} [params.v=false] - Enables verbose mode, which displays column headers. * @param {string} [params.index] - A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} diff --git a/api/cat/shards.js b/api/cat/shards.js index 5744ad411..dd7ea32a9 100644 --- a/api/cat/shards.js +++ b/api/cat/shards.js @@ -19,22 +19,22 @@ const { normalizeArguments, parsePathParam } = require('../utils'); /** - * Provides a detailed view of shard allocation on nodes. + * Lists the states of all primary and replica shards and how they are distributed. *
See Also: {@link https://opensearch.org/docs/latest/api-reference/cat/cat-shards/ - cat.shards} * * @memberOf API-Cat * * @param {object} [params] - * @param {string} [params.bytes] - The unit used to display byte values. - * @param {string} [params.cluster_manager_timeout] - Operation timeout for connection to cluster-manager node. - * @param {string} [params.format] - A short version of the Accept header (for example, `json`, `yaml`). - * @param {array} [params.h] - Comma-separated list of column names to display. + * @param {string} [params.bytes] - The units used to display byte values. + * @param {string} [params.cluster_manager_timeout] - The amount of time allowed to establish a connection to the cluster manager node. + * @param {string} [params.format] - A short version of the `Accept` header, such as `json` or `yaml`. + * @param {array} [params.h] - A comma-separated list of column names to display. * @param {boolean} [params.help=false] - Return help information. - * @param {boolean} [params.local=false] - Return local information, do not retrieve the state from cluster-manager node. - * @param {string} [params.master_timeout] DEPRECATED - Operation timeout for connection to cluster-manager node. - * @param {array} [params.s] - Comma-separated list of column names or column aliases to sort by. - * @param {string} [params.time] - The unit in which to display time values. - * @param {boolean} [params.v=false] - Verbose mode. Display column headers. + * @param {boolean} [params.local=false] - Returns local information but does not retrieve the state from the cluster manager node. + * @param {string} [params.master_timeout] DEPRECATED - The amount of time allowed to establish a connection to the cluster manager node. + * @param {array} [params.s] - A comma-separated list of column names or column aliases to sort by. + * @param {string} [params.time] - Specifies the time units, for example, `5d` or `7h`. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/). + * @param {boolean} [params.v=false] - Enables verbose mode, which displays column headers. * @param {string} [params.index] - A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} diff --git a/api/cat/snapshots.js b/api/cat/snapshots.js index e7b2b068f..93d80c414 100644 --- a/api/cat/snapshots.js +++ b/api/cat/snapshots.js @@ -19,22 +19,22 @@ const { normalizeArguments, parsePathParam } = require('../utils'); /** - * Returns all snapshots in a specific repository. + * Lists all of the snapshots stored in a specific repository. *
See Also: {@link https://opensearch.org/docs/latest/api-reference/cat/cat-snapshots/ - cat.snapshots} * * @memberOf API-Cat * * @param {object} [params] - * @param {string} [params.cluster_manager_timeout] - Operation timeout for connection to cluster-manager node. - * @param {string} [params.format] - A short version of the Accept header (for example, `json`, `yaml`). - * @param {array} [params.h] - Comma-separated list of column names to display. + * @param {string} [params.cluster_manager_timeout] - The amount of time allowed to establish a connection to the cluster manager node. + * @param {string} [params.format] - A short version of the `Accept` header, such as `json` or `yaml`. + * @param {array} [params.h] - A comma-separated list of column names to display. * @param {boolean} [params.help=false] - Return help information. - * @param {boolean} [params.ignore_unavailable=false] - If `true`, the response does not include information from unavailable snapshots. - * @param {string} [params.master_timeout] DEPRECATED - Operation timeout for connection to cluster-manager node. + * @param {boolean} [params.ignore_unavailable=false] - When `true`, the response does not include information from unavailable snapshots. + * @param {string} [params.master_timeout] DEPRECATED - The amount of time allowed to establish a connection to the cluster manager node. * @param {string} [params.repository] - A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. `_all` returns all repositories. If any repository fails during the request, OpenSearch returns an error. - * @param {array} [params.s] - Comma-separated list of column names or column aliases to sort by. - * @param {string} [params.time] - The unit in which to display time values. - * @param {boolean} [params.v=false] - Verbose mode. Display column headers. + * @param {array} [params.s] - A comma-separated list of column names or column aliases to sort by. + * @param {string} [params.time] - Specifies the time units, for example, `5d` or `7h`. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/). + * @param {boolean} [params.v=false] - Enables verbose mode, which displays column headers. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/cat/tasks.js b/api/cat/tasks.js index 9de431421..1e699f6ea 100644 --- a/api/cat/tasks.js +++ b/api/cat/tasks.js @@ -19,22 +19,22 @@ const { normalizeArguments } = require('../utils'); /** - * Returns information about the tasks currently executing on one or more nodes in the cluster. + * Lists the progress of all tasks currently running on the cluster. *
See Also: {@link https://opensearch.org/docs/latest/api-reference/cat/cat-tasks/ - cat.tasks} * * @memberOf API-Cat * * @param {object} [params] - * @param {array} [params.actions] - The task action names, which are used to limit the response. + * @param {array} [params.actions] - The task action names used to limit the response. * @param {boolean} [params.detailed=false] - If `true`, the response includes detailed information about shard recoveries. - * @param {string} [params.format] - A short version of the Accept header (for example, `json`, `yaml`). - * @param {array} [params.h] - Comma-separated list of column names to display. + * @param {string} [params.format] - A short version of the `Accept` header, such as `json` or `yaml`. + * @param {array} [params.h] - A comma-separated list of column names to display. * @param {boolean} [params.help=false] - Return help information. - * @param {array} [params.nodes] - Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes. + * @param {array} [params.nodes] - A comma-separated list of node IDs or names used to limit the returned information. Use `_local` to return information from the node to which you're connecting, specify a specific node from which to get information, or keep the parameter empty to get information from all nodes. * @param {string} [params.parent_task_id] - The parent task identifier, which is used to limit the response. - * @param {array} [params.s] - Comma-separated list of column names or column aliases to sort by. - * @param {string} [params.time] - The unit in which to display time values. - * @param {boolean} [params.v=false] - Verbose mode. Display column headers. + * @param {array} [params.s] - A comma-separated list of column names or column aliases to sort by. + * @param {string} [params.time] - Specifies the time units, for example, `5d` or `7h`. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/). + * @param {boolean} [params.v=false] - Enables verbose mode, which displays column headers. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/cat/templates.js b/api/cat/templates.js index b215a9d19..d3a7f69ce 100644 --- a/api/cat/templates.js +++ b/api/cat/templates.js @@ -19,20 +19,20 @@ const { normalizeArguments, parsePathParam } = require('../utils'); /** - * Returns information about existing templates. + * Lists the names, patterns, order numbers, and version numbers of index templates. *
See Also: {@link https://opensearch.org/docs/latest/api-reference/cat/cat-templates/ - cat.templates} * * @memberOf API-Cat * * @param {object} [params] - * @param {string} [params.cluster_manager_timeout] - Operation timeout for connection to cluster-manager node. - * @param {string} [params.format] - A short version of the Accept header (for example, `json`, `yaml`). - * @param {array} [params.h] - Comma-separated list of column names to display. + * @param {string} [params.cluster_manager_timeout] - The amount of time allowed to establish a connection to the cluster manager node. + * @param {string} [params.format] - A short version of the `Accept` header, such as `json` or `yaml`. + * @param {array} [params.h] - A comma-separated list of column names to display. * @param {boolean} [params.help=false] - Return help information. - * @param {boolean} [params.local=false] - Return local information, do not retrieve the state from cluster-manager node. - * @param {string} [params.master_timeout] DEPRECATED - Operation timeout for connection to cluster-manager node. - * @param {array} [params.s] - Comma-separated list of column names or column aliases to sort by. - * @param {boolean} [params.v=false] - Verbose mode. Display column headers. + * @param {boolean} [params.local=false] - Returns local information but does not retrieve the state from the cluster manager node. + * @param {string} [params.master_timeout] DEPRECATED - The amount of time allowed to establish a connection to the cluster manager node. + * @param {array} [params.s] - A comma-separated list of column names or column aliases to sort by. + * @param {boolean} [params.v=false] - Enables verbose mode, which displays column headers. * @param {string} [params.name] - The name of the template to return. Accepts wildcard expressions. If omitted, all templates are returned. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} diff --git a/api/cat/threadPool.js b/api/cat/threadPool.js index 8ba6f1ddd..3a02dd195 100644 --- a/api/cat/threadPool.js +++ b/api/cat/threadPool.js @@ -20,21 +20,21 @@ const { normalizeArguments, parsePathParam } = require('../utils'); /** * Returns cluster-wide thread pool statistics per node. -By default the active, queue and rejected statistics are returned for all thread pools. +By default the active, queued, and rejected statistics are returned for all thread pools. *
See Also: {@link https://opensearch.org/docs/latest/api-reference/cat/cat-thread-pool/ - cat.thread_pool} * * @memberOf API-Cat * * @param {object} [params] - * @param {string} [params.cluster_manager_timeout] - Operation timeout for connection to cluster-manager node. - * @param {string} [params.format] - A short version of the Accept header (for example, `json`, `yaml`). - * @param {array} [params.h] - Comma-separated list of column names to display. + * @param {string} [params.cluster_manager_timeout] - A timeout for connection to the cluster manager node. + * @param {string} [params.format] - A short version of the `Accept` header, such as `json` or `yaml`. + * @param {array} [params.h] - A comma-separated list of column names to display. * @param {boolean} [params.help=false] - Return help information. - * @param {boolean} [params.local=false] - Return local information, do not retrieve the state from cluster-manager node. - * @param {string} [params.master_timeout] DEPRECATED - Operation timeout for connection to cluster-manager node. - * @param {array} [params.s] - Comma-separated list of column names or column aliases to sort by. + * @param {boolean} [params.local=false] - Returns local information but does not retrieve the state from the cluster manager node. + * @param {string} [params.master_timeout] DEPRECATED - The amount of time allowed to establish a connection to the cluster manager node. + * @param {array} [params.s] - A comma-separated list of column names or column aliases to sort by. * @param {number} [params.size] - The multiplier in which to display values. - * @param {boolean} [params.v=false] - Verbose mode. Display column headers. + * @param {boolean} [params.v=false] - Enables verbose mode, which displays column headers. * @param {string} [params.thread_pool_patterns] - A comma-separated list of thread pool names used to limit the request. Accepts wildcard expressions. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} diff --git a/api/index.d.ts b/api/index.d.ts index a06fd28a6..7d1553e6e 100644 --- a/api/index.d.ts +++ b/api/index.d.ts @@ -275,13 +275,21 @@ import { Knn_TrainModel_Request, Knn_TrainModel_Response, Knn_TrainModel_Respons import { Knn_DeleteModel_Request, Knn_DeleteModel_Response, Knn_DeleteModel_ResponseBody } from './knn/deleteModel'; import { Knn_GetModel_Request, Knn_GetModel_Response, Knn_GetModel_ResponseBody } from './knn/getModel'; import { Knn_Warmup_Request, Knn_Warmup_Response, Knn_Warmup_ResponseBody } from './knn/warmup'; +import { Ml_Predict_Request, Ml_Predict_RequestBody, Ml_Predict_Response, Ml_Predict_ResponseBody } from './ml/predict'; +import { Ml_TrainPredict_Request, Ml_TrainPredict_RequestBody, Ml_TrainPredict_Response, Ml_TrainPredict_ResponseBody } from './ml/trainPredict'; +import { Ml_Train_Request, Ml_Train_RequestBody, Ml_Train_Response, Ml_Train_ResponseBody } from './ml/train'; import { Ml_RegisterAgents_Request, Ml_RegisterAgents_RequestBody, Ml_RegisterAgents_Response, Ml_RegisterAgents_ResponseBody } from './ml/registerAgents'; import { Ml_DeleteAgent_Request, Ml_DeleteAgent_Response, Ml_DeleteAgent_ResponseBody } from './ml/deleteAgent'; import { Ml_CreateConnector_Request, Ml_CreateConnector_RequestBody, Ml_CreateConnector_Response, Ml_CreateConnector_ResponseBody } from './ml/createConnector'; +import { Ml_SearchConnectors_Request, Ml_SearchConnectors_RequestBody, Ml_SearchConnectors_Response, Ml_SearchConnectors_ResponseBody } from './ml/searchConnectors'; import { Ml_DeleteConnector_Request, Ml_DeleteConnector_Response, Ml_DeleteConnector_ResponseBody } from './ml/deleteConnector'; +import { Ml_GetConnector_Request, Ml_GetConnector_Response, Ml_GetConnector_ResponseBody } from './ml/getConnector'; +import { Ml_UpdateConnector_Request, Ml_UpdateConnector_RequestBody, Ml_UpdateConnector_Response, Ml_UpdateConnector_ResponseBody } from './ml/updateConnector'; import { Ml_RegisterModelGroup_Request, Ml_RegisterModelGroup_RequestBody, Ml_RegisterModelGroup_Response, Ml_RegisterModelGroup_ResponseBody } from './ml/registerModelGroup'; +import { Ml_SearchModelGroup_Request, Ml_SearchModelGroup_RequestBody, Ml_SearchModelGroup_Response, Ml_SearchModelGroup_ResponseBody } from './ml/searchModelGroup'; import { Ml_DeleteModelGroup_Request, Ml_DeleteModelGroup_Response, Ml_DeleteModelGroup_ResponseBody } from './ml/deleteModelGroup'; import { Ml_GetModelGroup_Request, Ml_GetModelGroup_Response, Ml_GetModelGroup_ResponseBody } from './ml/getModelGroup'; +import { Ml_UpdateModelGroup_Request, Ml_UpdateModelGroup_RequestBody, Ml_UpdateModelGroup_Response, Ml_UpdateModelGroup_ResponseBody } from './ml/updateModelGroup'; import { Ml_RegisterModel_Request, Ml_RegisterModel_RequestBody, Ml_RegisterModel_Response, Ml_RegisterModel_ResponseBody } from './ml/registerModel'; import { Ml_SearchModels_Request, Ml_SearchModels_RequestBody, Ml_SearchModels_Response, Ml_SearchModels_ResponseBody } from './ml/searchModels'; import { Ml_DeleteModel_Request, Ml_DeleteModel_Response, Ml_DeleteModel_ResponseBody } from './ml/deleteModel'; @@ -638,13 +646,21 @@ export { Knn_DeleteModel_Request, Knn_DeleteModel_Response, Knn_DeleteModel_ResponseBody, Knn_GetModel_Request, Knn_GetModel_Response, Knn_GetModel_ResponseBody, Knn_Warmup_Request, Knn_Warmup_Response, Knn_Warmup_ResponseBody, + Ml_Predict_Request, Ml_Predict_RequestBody, Ml_Predict_Response, Ml_Predict_ResponseBody, + Ml_TrainPredict_Request, Ml_TrainPredict_RequestBody, Ml_TrainPredict_Response, Ml_TrainPredict_ResponseBody, + Ml_Train_Request, Ml_Train_RequestBody, Ml_Train_Response, Ml_Train_ResponseBody, Ml_RegisterAgents_Request, Ml_RegisterAgents_RequestBody, Ml_RegisterAgents_Response, Ml_RegisterAgents_ResponseBody, Ml_DeleteAgent_Request, Ml_DeleteAgent_Response, Ml_DeleteAgent_ResponseBody, Ml_CreateConnector_Request, Ml_CreateConnector_RequestBody, Ml_CreateConnector_Response, Ml_CreateConnector_ResponseBody, + Ml_SearchConnectors_Request, Ml_SearchConnectors_RequestBody, Ml_SearchConnectors_Response, Ml_SearchConnectors_ResponseBody, Ml_DeleteConnector_Request, Ml_DeleteConnector_Response, Ml_DeleteConnector_ResponseBody, + Ml_GetConnector_Request, Ml_GetConnector_Response, Ml_GetConnector_ResponseBody, + Ml_UpdateConnector_Request, Ml_UpdateConnector_RequestBody, Ml_UpdateConnector_Response, Ml_UpdateConnector_ResponseBody, Ml_RegisterModelGroup_Request, Ml_RegisterModelGroup_RequestBody, Ml_RegisterModelGroup_Response, Ml_RegisterModelGroup_ResponseBody, + Ml_SearchModelGroup_Request, Ml_SearchModelGroup_RequestBody, Ml_SearchModelGroup_Response, Ml_SearchModelGroup_ResponseBody, Ml_DeleteModelGroup_Request, Ml_DeleteModelGroup_Response, Ml_DeleteModelGroup_ResponseBody, Ml_GetModelGroup_Request, Ml_GetModelGroup_Response, Ml_GetModelGroup_ResponseBody, + Ml_UpdateModelGroup_Request, Ml_UpdateModelGroup_RequestBody, Ml_UpdateModelGroup_Response, Ml_UpdateModelGroup_ResponseBody, Ml_RegisterModel_Request, Ml_RegisterModel_RequestBody, Ml_RegisterModel_Response, Ml_RegisterModel_ResponseBody, Ml_SearchModels_Request, Ml_SearchModels_RequestBody, Ml_SearchModels_Response, Ml_SearchModels_ResponseBody, Ml_DeleteModel_Request, Ml_DeleteModel_Response, Ml_DeleteModel_ResponseBody, diff --git a/api/indices/putTemplate.d.ts b/api/indices/putTemplate.d.ts index 2cf740b79..abe62fa0e 100644 --- a/api/indices/putTemplate.d.ts +++ b/api/indices/putTemplate.d.ts @@ -31,7 +31,7 @@ export interface Indices_PutTemplate_Request extends Global.Params { export type Indices_PutTemplate_RequestBody = { aliases?: Record; - index_patterns?: string | string[]; + index_patterns?: Common.StringOrStringArray; mappings?: Common_Mapping.TypeMapping; order?: number; settings?: Record; diff --git a/api/indices/stats.d.ts b/api/indices/stats.d.ts index 0810b77e2..b2717fe69 100644 --- a/api/indices/stats.d.ts +++ b/api/indices/stats.d.ts @@ -25,7 +25,7 @@ export interface Indices_Stats_Request extends Global.Params { fielddata_fields?: Common.Fields; fields?: Common.Fields; forbid_closed_indices?: boolean; - groups?: string | string[]; + groups?: Common.StringOrStringArray; include_segment_file_sizes?: boolean; include_unloaded_segments?: boolean; index?: Common.Indices; diff --git a/api/ml/_api.js b/api/ml/_api.js index 8b705a4f6..f798bef39 100644 --- a/api/ml/_api.js +++ b/api/ml/_api.js @@ -26,13 +26,21 @@ function MlApi(bindObj) { this.deleteModelGroup = require('./deleteModelGroup').bind(bindObj); this.deleteTask = require('./deleteTask').bind(bindObj); this.deployModel = require('./deployModel').bind(bindObj); + this.getConnector = require('./getConnector').bind(bindObj); this.getModelGroup = require('./getModelGroup').bind(bindObj); this.getTask = require('./getTask').bind(bindObj); + this.predict = require('./predict').bind(bindObj); this.registerAgents = require('./registerAgents').bind(bindObj); this.registerModel = require('./registerModel').bind(bindObj); this.registerModelGroup = require('./registerModelGroup').bind(bindObj); + this.searchConnectors = require('./searchConnectors').bind(bindObj); + this.searchModelGroup = require('./searchModelGroup').bind(bindObj); this.searchModels = require('./searchModels').bind(bindObj); + this.train = require('./train').bind(bindObj); + this.trainPredict = require('./trainPredict').bind(bindObj); this.undeployModel = require('./undeployModel').bind(bindObj); + this.updateConnector = require('./updateConnector').bind(bindObj); + this.updateModelGroup = require('./updateModelGroup').bind(bindObj); // Deprecated: Use createConnector instead. this.create_connector = require('./createConnector').bind(bindObj); @@ -48,6 +56,8 @@ function MlApi(bindObj) { this.delete_task = require('./deleteTask').bind(bindObj); // Deprecated: Use deployModel instead. this.deploy_model = require('./deployModel').bind(bindObj); + // Deprecated: Use getConnector instead. + this.get_connector = require('./getConnector').bind(bindObj); // Deprecated: Use getModelGroup instead. this.get_model_group = require('./getModelGroup').bind(bindObj); // Deprecated: Use getTask instead. @@ -58,10 +68,20 @@ function MlApi(bindObj) { this.register_model = require('./registerModel').bind(bindObj); // Deprecated: Use registerModelGroup instead. this.register_model_group = require('./registerModelGroup').bind(bindObj); + // Deprecated: Use searchConnectors instead. + this.search_connectors = require('./searchConnectors').bind(bindObj); + // Deprecated: Use searchModelGroup instead. + this.search_model_group = require('./searchModelGroup').bind(bindObj); // Deprecated: Use searchModels instead. this.search_models = require('./searchModels').bind(bindObj); + // Deprecated: Use trainPredict instead. + this.train_predict = require('./trainPredict').bind(bindObj); // Deprecated: Use undeployModel instead. this.undeploy_model = require('./undeployModel').bind(bindObj); + // Deprecated: Use updateConnector instead. + this.update_connector = require('./updateConnector').bind(bindObj); + // Deprecated: Use updateModelGroup instead. + this.update_model_group = require('./updateModelGroup').bind(bindObj); } module.exports = MlApi; diff --git a/api/ml/createConnector.d.ts b/api/ml/createConnector.d.ts index ae113eb21..166890f24 100644 --- a/api/ml/createConnector.d.ts +++ b/api/ml/createConnector.d.ts @@ -29,7 +29,7 @@ export type Ml_CreateConnector_RequestBody = { description: string; name: string; parameters: Ml_Common.Parameters; - protocol: string; + protocol: 'aws_sigv4' | 'http'; version: number; } diff --git a/api/ml/getConnector.d.ts b/api/ml/getConnector.d.ts new file mode 100644 index 000000000..611c041e4 --- /dev/null +++ b/api/ml/getConnector.d.ts @@ -0,0 +1,30 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +import { ApiResponse } from '../../lib/Transport' +import * as Global from '../_types/_global' +import * as Ml_Common from '../_types/ml._common' + +export interface Ml_GetConnector_Request extends Global.Params { + connector_id: string; +} + +export interface Ml_GetConnector_Response extends ApiResponse { + body: Ml_GetConnector_ResponseBody; +} + +export type Ml_GetConnector_ResponseBody = Ml_Common.GetConnectorResponse + diff --git a/api/ml/getConnector.js b/api/ml/getConnector.js new file mode 100644 index 000000000..27c704522 --- /dev/null +++ b/api/ml/getConnector.js @@ -0,0 +1,49 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +'use strict'; + +const { normalizeArguments, parsePathParam, handleMissingParam } = require('../utils'); + +/** + * Retrieves a standalone connector. + *
See Also: {@link undefined - ml.get_connector} + * + * @memberOf API-Ml + * + * @param {object} params + * @param {string} params.connector_id + * + * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} + * @param {function} [callback] - Callback that handles errors and response + * + * @returns {{abort: function(), then: function(), catch: function()}|Promise|*} + */ +function getConnectorFunc(params, options, callback) { + [params, options, callback] = normalizeArguments(params, options, callback); + if (params.connector_id == null) return handleMissingParam('connector_id', this, callback); + + let { body, connector_id, ...querystring } = params; + connector_id = parsePathParam(connector_id); + + const path = '/_plugins/_ml/connectors/' + connector_id; + const method = 'GET'; + body = body || ''; + + return this.transport.request({ method, path, querystring, body }, options, callback); +} + +module.exports = getConnectorFunc; diff --git a/api/ml/predict.d.ts b/api/ml/predict.d.ts new file mode 100644 index 000000000..966e1f41c --- /dev/null +++ b/api/ml/predict.d.ts @@ -0,0 +1,40 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +import { ApiResponse } from '../../lib/Transport' +import * as Global from '../_types/_global' +import * as Ml_Common from '../_types/ml._common' + +export interface Ml_Predict_Request extends Global.Params { + algorithm_name: string; + body?: Ml_Predict_RequestBody; + model_id: string; +} + +export type Ml_Predict_RequestBody = { + input_index?: string[]; + input_query?: Ml_Common.InputQuery; + return_number?: boolean; + target_response?: string[]; + text_docs?: string[]; +} + +export interface Ml_Predict_Response extends ApiResponse { + body: Ml_Predict_ResponseBody; +} + +export type Ml_Predict_ResponseBody = Ml_Common.PredictResponse + diff --git a/api/ml/predict.js b/api/ml/predict.js new file mode 100644 index 000000000..3a7401fa7 --- /dev/null +++ b/api/ml/predict.js @@ -0,0 +1,53 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +'use strict'; + +const { normalizeArguments, parsePathParam, handleMissingParam } = require('../utils'); + +/** + * Predicts new data with trained model. + *
See Also: {@link undefined - ml.predict} + * + * @memberOf API-Ml + * + * @param {object} params + * @param {string} params.algorithm_name + * @param {string} params.model_id + * @param {object} [params.body] + * + * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} + * @param {function} [callback] - Callback that handles errors and response + * + * @returns {{abort: function(), then: function(), catch: function()}|Promise|*} + */ +function predictFunc(params, options, callback) { + [params, options, callback] = normalizeArguments(params, options, callback); + if (params.algorithm_name == null) return handleMissingParam('algorithm_name', this, callback); + if (params.model_id == null) return handleMissingParam('model_id', this, callback); + + let { body, algorithm_name, model_id, ...querystring } = params; + algorithm_name = parsePathParam(algorithm_name); + model_id = parsePathParam(model_id); + + const path = '/_plugins/_ml/_predict/' + algorithm_name + '/' + model_id; + const method = 'POST'; + body = body || ''; + + return this.transport.request({ method, path, querystring, body }, options, callback); +} + +module.exports = predictFunc; diff --git a/api/ml/searchConnectors.d.ts b/api/ml/searchConnectors.d.ts new file mode 100644 index 000000000..4c1f2ad1d --- /dev/null +++ b/api/ml/searchConnectors.d.ts @@ -0,0 +1,36 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +import { ApiResponse } from '../../lib/Transport' +import * as Global from '../_types/_global' +import * as Ml_Common from '../_types/ml._common' + +export interface Ml_SearchConnectors_Request extends Global.Params { + body?: Ml_SearchConnectors_RequestBody; +} + +export type Ml_SearchConnectors_RequestBody = { + query?: Ml_Common.Query; + size?: number; + sort?: string[]; +} + +export interface Ml_SearchConnectors_Response extends ApiResponse { + body: Ml_SearchConnectors_ResponseBody; +} + +export type Ml_SearchConnectors_ResponseBody = Ml_Common.SearchConnectorsResponse + diff --git a/api/ml/searchConnectors.js b/api/ml/searchConnectors.js new file mode 100644 index 000000000..40c180e11 --- /dev/null +++ b/api/ml/searchConnectors.js @@ -0,0 +1,47 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +'use strict'; + +const { normalizeArguments } = require('../utils'); + +/** + * Searches for standalone connectors. + *
See Also: {@link undefined - ml.search_connectors} + * + * @memberOf API-Ml + * + * @param {object} [params] + * @param {object} [params.body] + * + * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} + * @param {function} [callback] - Callback that handles errors and response + * + * @returns {{abort: function(), then: function(), catch: function()}|Promise|*} + */ +function searchConnectorsFunc(params, options, callback) { + [params, options, callback] = normalizeArguments(params, options, callback); + + let { body, ...querystring } = params; + + const path = '/_plugins/_ml/connectors/_search'; + const method = body ? 'POST' : 'GET'; + body = body || ''; + + return this.transport.request({ method, path, querystring, body }, options, callback); +} + +module.exports = searchConnectorsFunc; diff --git a/api/ml/searchModelGroup.d.ts b/api/ml/searchModelGroup.d.ts new file mode 100644 index 000000000..82cea2cee --- /dev/null +++ b/api/ml/searchModelGroup.d.ts @@ -0,0 +1,36 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +import { ApiResponse } from '../../lib/Transport' +import * as Global from '../_types/_global' +import * as Ml_Common from '../_types/ml._common' + +export interface Ml_SearchModelGroup_Request extends Global.Params { + body?: Ml_SearchModelGroup_RequestBody; +} + +export type Ml_SearchModelGroup_RequestBody = { + query?: Ml_Common.Query; + size?: number; + sort?: Ml_Common.Sort[]; +} + +export interface Ml_SearchModelGroup_Response extends ApiResponse { + body: Ml_SearchModelGroup_ResponseBody; +} + +export type Ml_SearchModelGroup_ResponseBody = Ml_Common.SearchModelGroupsResponse + diff --git a/api/ml/searchModelGroup.js b/api/ml/searchModelGroup.js new file mode 100644 index 000000000..64e09d105 --- /dev/null +++ b/api/ml/searchModelGroup.js @@ -0,0 +1,47 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +'use strict'; + +const { normalizeArguments } = require('../utils'); + +/** + * Searches for model groups. + *
See Also: {@link undefined - ml.search_model_group} + * + * @memberOf API-Ml + * + * @param {object} [params] + * @param {object} [params.body] + * + * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} + * @param {function} [callback] - Callback that handles errors and response + * + * @returns {{abort: function(), then: function(), catch: function()}|Promise|*} + */ +function searchModelGroupFunc(params, options, callback) { + [params, options, callback] = normalizeArguments(params, options, callback); + + let { body, ...querystring } = params; + + const path = '/_plugins/_ml/model_groups/_search'; + const method = body ? 'POST' : 'GET'; + body = body || ''; + + return this.transport.request({ method, path, querystring, body }, options, callback); +} + +module.exports = searchModelGroupFunc; diff --git a/api/ml/searchModels.d.ts b/api/ml/searchModels.d.ts index 16c2ce5aa..20428e651 100644 --- a/api/ml/searchModels.d.ts +++ b/api/ml/searchModels.d.ts @@ -23,8 +23,9 @@ export interface Ml_SearchModels_Request extends Global.Params { } export type Ml_SearchModels_RequestBody = { - query: Record; - size: number; + query?: Ml_Common.Query; + size?: number; + sort?: Ml_Common.Sort[]; } export interface Ml_SearchModels_Response extends ApiResponse { diff --git a/api/ml/train.d.ts b/api/ml/train.d.ts new file mode 100644 index 000000000..cfd9c3005 --- /dev/null +++ b/api/ml/train.d.ts @@ -0,0 +1,37 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +import { ApiResponse } from '../../lib/Transport' +import * as Global from '../_types/_global' +import * as Ml_Common from '../_types/ml._common' + +export interface Ml_Train_Request extends Global.Params { + algorithm_name: string; + body?: Ml_Train_RequestBody; +} + +export type Ml_Train_RequestBody = { + input_index?: string[]; + input_query?: Ml_Common.InputQuery; + parameters?: Ml_Common.TrainParameters; +} + +export interface Ml_Train_Response extends ApiResponse { + body: Ml_Train_ResponseBody; +} + +export type Ml_Train_ResponseBody = Ml_Common.TrainResponse + diff --git a/api/ml/train.js b/api/ml/train.js new file mode 100644 index 000000000..ce84e167f --- /dev/null +++ b/api/ml/train.js @@ -0,0 +1,50 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +'use strict'; + +const { normalizeArguments, parsePathParam, handleMissingParam } = require('../utils'); + +/** + * Trains a model synchronously. + *
See Also: {@link undefined - ml.train} + * + * @memberOf API-Ml + * + * @param {object} params + * @param {string} params.algorithm_name + * @param {object} [params.body] + * + * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} + * @param {function} [callback] - Callback that handles errors and response + * + * @returns {{abort: function(), then: function(), catch: function()}|Promise|*} + */ +function trainFunc(params, options, callback) { + [params, options, callback] = normalizeArguments(params, options, callback); + if (params.algorithm_name == null) return handleMissingParam('algorithm_name', this, callback); + + let { body, algorithm_name, ...querystring } = params; + algorithm_name = parsePathParam(algorithm_name); + + const path = '/_plugins/_ml/_train/' + algorithm_name; + const method = 'POST'; + body = body || ''; + + return this.transport.request({ method, path, querystring, body }, options, callback); +} + +module.exports = trainFunc; diff --git a/api/ml/trainPredict.d.ts b/api/ml/trainPredict.d.ts new file mode 100644 index 000000000..54ce47b27 --- /dev/null +++ b/api/ml/trainPredict.d.ts @@ -0,0 +1,38 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +import { ApiResponse } from '../../lib/Transport' +import * as Global from '../_types/_global' +import * as Ml_Common from '../_types/ml._common' + +export interface Ml_TrainPredict_Request extends Global.Params { + algorithm_name: string; + body?: Ml_TrainPredict_RequestBody; +} + +export type Ml_TrainPredict_RequestBody = { + input_data?: Ml_Common.PredictionResult; + input_index?: string[]; + input_query?: Ml_Common.InputQuery; + parameters?: Ml_Common.TrainParameters; +} + +export interface Ml_TrainPredict_Response extends ApiResponse { + body: Ml_TrainPredict_ResponseBody; +} + +export type Ml_TrainPredict_ResponseBody = Ml_Common.TrainPredictResponse + diff --git a/api/ml/trainPredict.js b/api/ml/trainPredict.js new file mode 100644 index 000000000..cc5a2ff83 --- /dev/null +++ b/api/ml/trainPredict.js @@ -0,0 +1,50 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +'use strict'; + +const { normalizeArguments, parsePathParam, handleMissingParam } = require('../utils'); + +/** + * Trains a model and predicts against the same training dataset. + *
See Also: {@link undefined - ml.train_predict} + * + * @memberOf API-Ml + * + * @param {object} params + * @param {string} params.algorithm_name + * @param {object} [params.body] + * + * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} + * @param {function} [callback] - Callback that handles errors and response + * + * @returns {{abort: function(), then: function(), catch: function()}|Promise|*} + */ +function trainPredictFunc(params, options, callback) { + [params, options, callback] = normalizeArguments(params, options, callback); + if (params.algorithm_name == null) return handleMissingParam('algorithm_name', this, callback); + + let { body, algorithm_name, ...querystring } = params; + algorithm_name = parsePathParam(algorithm_name); + + const path = '/_plugins/_ml/_train_predict/' + algorithm_name; + const method = 'POST'; + body = body || ''; + + return this.transport.request({ method, path, querystring, body }, options, callback); +} + +module.exports = trainPredictFunc; diff --git a/api/ml/updateConnector.d.ts b/api/ml/updateConnector.d.ts new file mode 100644 index 000000000..9a7ef8323 --- /dev/null +++ b/api/ml/updateConnector.d.ts @@ -0,0 +1,45 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +import { ApiResponse } from '../../lib/Transport' +import * as Common from '../_types/_common' +import * as Global from '../_types/_global' +import * as Ml_Common from '../_types/ml._common' + +export interface Ml_UpdateConnector_Request extends Global.Params { + body?: Ml_UpdateConnector_RequestBody; + connector_id: string; +} + +export type Ml_UpdateConnector_RequestBody = { + access_mode?: 'private' | 'public' | 'restricted'; + actions?: Ml_Common.Action[]; + backend_roles?: string[]; + credential?: Ml_Common.Credential; + description?: string; + name?: Common.Name; + parameters?: Ml_Common.Parameters; + 'parameters.skip_validating_missing_parameters'?: boolean; + protocol?: 'aws_sigv4' | 'http'; + version?: Common.VersionNumber; +} + +export interface Ml_UpdateConnector_Response extends ApiResponse { + body: Ml_UpdateConnector_ResponseBody; +} + +export type Ml_UpdateConnector_ResponseBody = Common.WriteResponseBase + diff --git a/api/ml/updateConnector.js b/api/ml/updateConnector.js new file mode 100644 index 000000000..50ccb9ef5 --- /dev/null +++ b/api/ml/updateConnector.js @@ -0,0 +1,50 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +'use strict'; + +const { normalizeArguments, parsePathParam, handleMissingParam } = require('../utils'); + +/** + * Updates a standalone connector. + *
See Also: {@link undefined - ml.update_connector} + * + * @memberOf API-Ml + * + * @param {object} params + * @param {string} params.connector_id + * @param {object} [params.body] + * + * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} + * @param {function} [callback] - Callback that handles errors and response + * + * @returns {{abort: function(), then: function(), catch: function()}|Promise|*} + */ +function updateConnectorFunc(params, options, callback) { + [params, options, callback] = normalizeArguments(params, options, callback); + if (params.connector_id == null) return handleMissingParam('connector_id', this, callback); + + let { body, connector_id, ...querystring } = params; + connector_id = parsePathParam(connector_id); + + const path = '/_plugins/_ml/connectors/' + connector_id; + const method = 'PUT'; + body = body || ''; + + return this.transport.request({ method, path, querystring, body }, options, callback); +} + +module.exports = updateConnectorFunc; diff --git a/api/ml/updateModelGroup.d.ts b/api/ml/updateModelGroup.d.ts new file mode 100644 index 000000000..71b99bd44 --- /dev/null +++ b/api/ml/updateModelGroup.d.ts @@ -0,0 +1,40 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +import { ApiResponse } from '../../lib/Transport' +import * as Global from '../_types/_global' +import * as Ml_Common from '../_types/ml._common' + +export interface Ml_UpdateModelGroup_Request extends Global.Params { + body?: Ml_UpdateModelGroup_RequestBody; + model_group_id: string; +} + +export type Ml_UpdateModelGroup_RequestBody = { + add_all_backend_roles?: boolean; + add_backend_roles?: string[]; + backend_roles?: string[]; + description?: string; + model_access_name?: string; + name?: string; +} + +export interface Ml_UpdateModelGroup_Response extends ApiResponse { + body: Ml_UpdateModelGroup_ResponseBody; +} + +export type Ml_UpdateModelGroup_ResponseBody = Ml_Common.UpdateModelGroupResponse + diff --git a/api/ml/updateModelGroup.js b/api/ml/updateModelGroup.js new file mode 100644 index 000000000..c53235e9c --- /dev/null +++ b/api/ml/updateModelGroup.js @@ -0,0 +1,50 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +'use strict'; + +const { normalizeArguments, parsePathParam, handleMissingParam } = require('../utils'); + +/** + * Updates a model group. + *
See Also: {@link undefined - ml.update_model_group} + * + * @memberOf API-Ml + * + * @param {object} params + * @param {string} params.model_group_id + * @param {object} [params.body] + * + * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} + * @param {function} [callback] - Callback that handles errors and response + * + * @returns {{abort: function(), then: function(), catch: function()}|Promise|*} + */ +function updateModelGroupFunc(params, options, callback) { + [params, options, callback] = normalizeArguments(params, options, callback); + if (params.model_group_id == null) return handleMissingParam('model_group_id', this, callback); + + let { body, model_group_id, ...querystring } = params; + model_group_id = parsePathParam(model_group_id); + + const path = '/_plugins/_ml/model_groups/' + model_group_id; + const method = 'PUT'; + body = body || ''; + + return this.transport.request({ method, path, querystring, body }, options, callback); +} + +module.exports = updateModelGroupFunc; diff --git a/api/nodes/info.d.ts b/api/nodes/info.d.ts index f867956ee..dccfb72da 100644 --- a/api/nodes/info.d.ts +++ b/api/nodes/info.d.ts @@ -17,6 +17,7 @@ import { ApiResponse } from '../../lib/Transport' import * as Common from '../_types/_common' import * as Global from '../_types/_global' +import * as Nodes_Common from '../_types/nodes._common' import * as Nodes_Info from '../_types/nodes.info' export interface Nodes_Info_Request extends Global.Params { @@ -30,5 +31,8 @@ export interface Nodes_Info_Response extends ApiResponse { body: Nodes_Info_ResponseBody; } -export type Nodes_Info_ResponseBody = Nodes_Info.ResponseBase +export interface Nodes_Info_ResponseBody extends Nodes_Common.NodesResponseBase { + cluster_name: Common.Name; + nodes: Record; +} diff --git a/api/nodes/reloadSecureSettings.d.ts b/api/nodes/reloadSecureSettings.d.ts index d8d00c223..b5164fce5 100644 --- a/api/nodes/reloadSecureSettings.d.ts +++ b/api/nodes/reloadSecureSettings.d.ts @@ -17,6 +17,7 @@ import { ApiResponse } from '../../lib/Transport' import * as Common from '../_types/_common' import * as Global from '../_types/_global' +import * as Nodes_Common from '../_types/nodes._common' import * as Nodes_ReloadSecureSettings from '../_types/nodes.reload_secure_settings' export interface Nodes_ReloadSecureSettings_Request extends Global.Params { @@ -33,5 +34,8 @@ export interface Nodes_ReloadSecureSettings_Response extends ApiResponse { body: Nodes_ReloadSecureSettings_ResponseBody; } -export type Nodes_ReloadSecureSettings_ResponseBody = Nodes_ReloadSecureSettings.ResponseBase +export interface Nodes_ReloadSecureSettings_ResponseBody extends Nodes_Common.NodesResponseBase { + cluster_name: Common.Name; + nodes: Record; +} diff --git a/api/nodes/stats.d.ts b/api/nodes/stats.d.ts index c650a6db8..57a1aa093 100644 --- a/api/nodes/stats.d.ts +++ b/api/nodes/stats.d.ts @@ -17,6 +17,7 @@ import { ApiResponse } from '../../lib/Transport' import * as Common from '../_types/_common' import * as Global from '../_types/_global' +import * as Nodes_Common from '../_types/nodes._common' import * as Nodes_Stats from '../_types/nodes.stats' export interface Nodes_Stats_Request extends Global.Params { @@ -37,5 +38,8 @@ export interface Nodes_Stats_Response extends ApiResponse { body: Nodes_Stats_ResponseBody; } -export type Nodes_Stats_ResponseBody = Nodes_Stats.ResponseBase +export interface Nodes_Stats_ResponseBody extends Nodes_Common.NodesResponseBase { + cluster_name?: Common.Name; + nodes: Record; +} diff --git a/api/nodes/usage.d.ts b/api/nodes/usage.d.ts index 1f27ab6da..bcda68240 100644 --- a/api/nodes/usage.d.ts +++ b/api/nodes/usage.d.ts @@ -17,6 +17,7 @@ import { ApiResponse } from '../../lib/Transport' import * as Common from '../_types/_common' import * as Global from '../_types/_global' +import * as Nodes_Common from '../_types/nodes._common' import * as Nodes_Usage from '../_types/nodes.usage' export interface Nodes_Usage_Request extends Global.Params { @@ -29,5 +30,8 @@ export interface Nodes_Usage_Response extends ApiResponse { body: Nodes_Usage_ResponseBody; } -export type Nodes_Usage_ResponseBody = Nodes_Usage.ResponseBase +export interface Nodes_Usage_ResponseBody extends Nodes_Common.NodesResponseBase { + cluster_name: Common.Name; + nodes: Record; +} diff --git a/api/tasks/cancel.d.ts b/api/tasks/cancel.d.ts index 147a2140b..816f3f988 100644 --- a/api/tasks/cancel.d.ts +++ b/api/tasks/cancel.d.ts @@ -20,7 +20,7 @@ import * as Global from '../_types/_global' import * as Tasks_Common from '../_types/tasks._common' export interface Tasks_Cancel_Request extends Global.Params { - actions?: string | string[]; + actions?: Common.StringOrStringArray; nodes?: string[]; parent_task_id?: string; task_id?: Common.TaskId; diff --git a/api/tasks/list.d.ts b/api/tasks/list.d.ts index f9728c177..8ac725b55 100644 --- a/api/tasks/list.d.ts +++ b/api/tasks/list.d.ts @@ -20,7 +20,7 @@ import * as Global from '../_types/_global' import * as Tasks_Common from '../_types/tasks._common' export interface Tasks_List_Request extends Global.Params { - actions?: string | string[]; + actions?: Common.StringOrStringArray; detailed?: boolean; group_by?: Tasks_Common.GroupBy; nodes?: string[];