Source: api/api/cat.js

  1. /*
  2.  * Copyright OpenSearch Contributors
  3.  * SPDX-License-Identifier: Apache-2.0
  4.  *
  5.  * The OpenSearch Contributors require contributions made to
  6.  * this file be licensed under the Apache-2.0 license or a
  7.  * compatible open source license.
  8.  *
  9.  */
  11. /*
  12.  * Licensed to Elasticsearch B.V. under one or more contributor
  13.  * license agreements. See the NOTICE file distributed with
  14.  * this work for additional information regarding copyright
  15.  * ownership. Elasticsearch B.V. licenses this file to you under
  16.  * the Apache License, Version 2.0 (the "License"); you may
  17.  * not use this file except in compliance with the License.
  18.  * You may obtain a copy of the License at
  19.  *
  20.  *    http://www.apache.org/licenses/LICENSE-2.0
  21.  *
  22.  * Unless required by applicable law or agreed to in writing,
  23.  * software distributed under the License is distributed on an
  24.  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  25.  * KIND, either express or implied.  See the License for the
  26.  * specific language governing permissions and limitations
  27.  * under the License.
  28.  */
  30. 'use strict';
  32. /* eslint camelcase: 0 */
  33. /* eslint no-unused-vars: 0 */
  35. /** @namespace API-CAT */
  37. const { handleError, snakeCaseKeys, normalizeArguments, kConfigurationError } = require('../utils');
  38. const acceptedQuerystring = [
  39.   'format',
  40.   'local',
  41.   'h',
  42.   'help',
  43.   's',
  44.   'v',
  45.   'expand_wildcards',
  46.   'pretty',
  47.   'human',
  48.   'error_trace',
  49.   'source',
  50.   'filter_path',
  51.   'bytes',
  52.   'cluster_manager_timeout',
  53.   'master_timeout',
  54.   'fields',
  55.   'time',
  56.   'ts',
  57.   'health',
  58.   'pri',
  59.   'include_unloaded_segments',
  60.   'allow_no_match',
  61.   'allow_no_datafeeds',
  62.   'allow_no_jobs',
  63.   'from',
  64.   'size',
  65.   'full_id',
  66.   'include_bootstrap',
  67.   'active_only',
  68.   'detailed',
  69.   'index',
  70.   'ignore_unavailable',
  71.   'nodes',
  72.   'actions',
  73.   'parent_task_id',
  74.   'pri',
  75. ];
  76. const snakeCase = {
  77.   expandWildcards: 'expand_wildcards',
  78.   errorTrace: 'error_trace',
  79.   filterPath: 'filter_path',
  80.   clusterManagerTimeout: 'cluster_manager_timeout',
  81.   masterTimeout: 'master_timeout',
  82.   includeUnloadedSegments: 'include_unloaded_segments',
  83.   allowNoMatch: 'allow_no_match',
  84.   allowNoDatafeeds: 'allow_no_datafeeds',
  85.   allowNoJobs: 'allow_no_jobs',
  86.   fullId: 'full_id',
  87.   includeBootstrap: 'include_bootstrap',
  88.   activeOnly: 'active_only',
  89.   ignoreUnavailable: 'ignore_unavailable',
  90.   parentTaskId: 'parent_task_id',
  91. };
  93. function CatApi(transport, ConfigurationError) {
  94.   this.transport = transport;
  95.   this[kConfigurationError] = ConfigurationError;
  96. }
  98. /**
  99.  * The CAT aliases operation lists the mapping of aliases to indices, plus routing and filtering information.
  100.  * <br/> See Also: {@link https://opensearch.org/docs/latest/api-reference/cat/cat-aliases/ OpenSearch - CAT aliases}
  101.  *
  102.  * @memberOf API-CAT
  103.  *
  104.  * @param {Object} params - Accepts {@link https://opensearch.org/docs/latest/api-reference/cat/index#optional-query-parameters - common CAT parameters} along with the following unique parameters:
  105.  * @param {string} [params.name] - To limit the information to specific aliases, provide the alias names seperated by commas.
  106.  * @param {boolean} [params.local=false] - Whether to return information from the local node only instead of from the cluster manager node.
  107.  * @param {string} [params.expand_wildcards=open] - Expands wildcard expressions to concrete indices. Combine multiple values with commas. Supported values are 'all', 'open', 'closed', 'hidden', and 'none'. Default is 'open'.
  108.  *
  109.  * @param {Object} [options] - Options for {@link Transport#request}
  110.  * @param {function} [callback] - Callback that handles errors and response
  111.  *
  112.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*} {@link https://opensearch.org/docs/latest/api-reference/cat/cat-aliases/#response CAT aliases Response}
  113.  */
  114. CatApi.prototype.aliases = function catAliasesApi(params, options, callback) {
  115.   [params, options, callback] = normalizeArguments(params, options, callback);
  117.   let { method, body, name, ...querystring } = params;
  118.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  120.   let path = '';
  121.   if (name != null) {
  122.     if (method == null) method = 'GET';
  123.     path = '/' + '_cat' + '/' + 'aliases' + '/' + encodeURIComponent(name);
  124.   } else {
  125.     if (method == null) method = 'GET';
  126.     path = '/' + '_cat' + '/' + 'aliases';
  127.   }
  129.   // build request object
  130.   const request = {
  131.     method,
  132.     path,
  133.     body: null,
  134.     querystring,
  135.   };
  137.   return this.transport.request(request, options, callback);
  138. };
  140. /**
  141.  * The CAT allocation operation lists the allocation of disk space for indices and the number of shards on each node.
  142.  * <br/> See Also: {@link https://opensearch.org/docs/latest/api-reference/cat/cat-allocation/ OpenSearch - CAT allocation}
  143.  *
  144.  * @memberOf API-CAT
  145.  *
  146.  * @param {Object} params - Accepts {@link https://opensearch.org/docs/latest/api-reference/cat/index#optional-query-parameters - common CAT parameters} along with the following unique parameters:
  147.  * @param {string} [params.node_id] - To limit the information to specific nodes, provide the node names seperated by commas.
  148.  * @param {boolean} [params.local=false] - Whether to return information from the local node only instead of from the cluster manager node.
  149.  * @param {string} [params.cluster_manager_timeout=30s] - The amount of time to wait for a connection to the cluster manager node.
  150.  * @param {string} [params.bytes] - Specify the units for byte size. For example, '7kb' or '6gb'.
  151.  *
  152.  * @param {Object} [options] - Options for {@link Transport#request}
  153.  * @param {function} [callback] - Callback that handles errors and response
  154.  *
  155.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*} {@link https://opensearch.org/docs/latest/api-reference/cat/cat-allocation/#response CAT allocation Response}
  156.  */
  157. CatApi.prototype.allocation = function catAllocationApi(params, options, callback) {
  158.   [params, options, callback] = normalizeArguments(params, options, callback);
  160.   let { method, body, nodeId, node_id, ...querystring } = params;
  161.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  163.   let path = '';
  164.   if ((node_id || nodeId) != null) {
  165.     if (method == null) method = 'GET';
  166.     path = '/' + '_cat' + '/' + 'allocation' + '/' + encodeURIComponent(node_id || nodeId);
  167.   } else {
  168.     if (method == null) method = 'GET';
  169.     path = '/' + '_cat' + '/' + 'allocation';
  170.   }
  172.   // build request object
  173.   const request = {
  174.     method,
  175.     path,
  176.     body: null,
  177.     querystring,
  178.   };
  180.   return this.transport.request(request, options, callback);
  181. };
  183. /**
  184.  * The CAT count operation lists the number of documents in your cluster.
  185.  * <br/> See Also: {@link https://opensearch.org/docs/latest/api-reference/cat/cat-count/ OpenSearch - CAT count}
  186.  *
  187.  * @memberOf API-CAT
  188.  *
  189.  * @param {Object} params - Accepts {@link https://opensearch.org/docs/latest/api-reference/cat/index#optional-query-parameters - common CAT parameters} along with the following unique parameters:
  190.  * @param {string} [params.index] - To see the number of documents in specific indices or aliases, provide the index/alias names seperated by commas.
  191.  *
  192.  * @param {Object} [options] - Options for {@link Transport#request}
  193.  * @param {function} [callback] - Callback that handles errors and response
  194.  *
  195.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*} {@link https://opensearch.org/docs/latest/api-reference/cat/cat-count/#response CAT count Response}
  196.  */
  197. CatApi.prototype.count = function catCountApi(params, options, callback) {
  198.   [params, options, callback] = normalizeArguments(params, options, callback);
  200.   let { method, body, index, ...querystring } = params;
  201.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  203.   let path = '';
  204.   if (index != null) {
  205.     if (method == null) method = 'GET';
  206.     path = '/' + '_cat' + '/' + 'count' + '/' + encodeURIComponent(index);
  207.   } else {
  208.     if (method == null) method = 'GET';
  209.     path = '/' + '_cat' + '/' + 'count';
  210.   }
  212.   // build request object
  213.   const request = {
  214.     method,
  215.     path,
  216.     body: null,
  217.     querystring,
  218.   };
  220.   return this.transport.request(request, options, callback);
  221. };
  223. /**
  224.  * The CAT fielddata operation lists the memory size used by each field per node.
  225.  * <br/> See Also: {@link https://opensearch.org/docs/latest/api-reference/cat/cat-field-data/ OpenSearch - CAT fielddata}
  226.  *
  227.  * @memberOf API-CAT
  228.  *
  229.  * @param {Object} params - Accepts {@link https://opensearch.org/docs/latest/api-reference/cat/index#optional-query-parameters - common CAT parameters} along with the following unique parameters:
  230.  * @param {string} [params.fields] - To limit the information to specific fields, provide the field names seperated by commas.
  231.  *
  232.  * @param {Object} [options] - Options for {@link Transport#request}
  233.  * @param {function} [callback] - Callback that handles errors and response
  234.  *
  235.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*} {@link https://opensearch.org/docs/latest/api-reference/cat/cat-field-data/#response CAT fielddata Response}
  236.  */
  237. CatApi.prototype.fielddata = function catFielddataApi(params, options, callback) {
  238.   [params, options, callback] = normalizeArguments(params, options, callback);
  240.   let { method, body, fields, ...querystring } = params;
  241.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  243.   let path = '';
  244.   if (fields != null) {
  245.     if (method == null) method = 'GET';
  246.     path = '/' + '_cat' + '/' + 'fielddata' + '/' + encodeURIComponent(fields);
  247.   } else {
  248.     if (method == null) method = 'GET';
  249.     path = '/' + '_cat' + '/' + 'fielddata';
  250.   }
  252.   // build request object
  253.   const request = {
  254.     method,
  255.     path,
  256.     body: null,
  257.     querystring,
  258.   };
  260.   return this.transport.request(request, options, callback);
  261. };
  263. /**
  264.  * The CAT health operation lists the status of the cluster, how long the cluster has been up, the number of nodes,
  265.  * and other useful information that helps you analyze the health of your cluster.
  266.  * <br/> See Also: {@link https://opensearch.org/docs/latest/api-reference/cat/cat-health/ OpenSearch - CAT health}
  267.  *
  268.  * @memberOf API-CAT
  269.  *
  270.  * @param {Object} params - Accepts {@link https://opensearch.org/docs/latest/api-reference/cat/index#optional-query-parameters - common CAT parameters} along with the following unique parameters:
  271.  * @param {string} [params.time] - Specify the units for time. For example, '5d' or '7h'.
  272.  * @param {boolean} [params.ts=true] - If true, returns HH:MM:SS and Unix epoch timestamps.
  273.  *
  274.  * @param {Object} [options] - Options for {@link Transport#request}
  275.  * @param {function} [callback] - Callback that handles errors and response
  276.  *
  277.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*} {@link https://opensearch.org/docs/latest/api-reference/cat/cat-health/#response CAT health Response}
  278.  */
  279. CatApi.prototype.health = function catHealthApi(params, options, callback) {
  280.   [params, options, callback] = normalizeArguments(params, options, callback);
  282.   let { method, body, ...querystring } = params;
  283.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  285.   let path = '';
  286.   if (method == null) method = 'GET';
  287.   path = '/' + '_cat' + '/' + 'health';
  289.   // build request object
  290.   const request = {
  291.     method,
  292.     path,
  293.     body: null,
  294.     querystring,
  295.   };
  297.   return this.transport.request(request, options, callback);
  298. };
  300. /**
  301.  * See the available operations in the CAT API
  302.  * <br/> See Also: {@link https://opensearch.org/docs/latest/api-reference/cat/index OpenSearch - CAT}
  303.  *
  304.  * @memberOf API-CAT
  305.  *
  306.  * @param {Object} params - (ignored)
  307.  * @param {Object} [options] - Options for {@link Transport#request}
  308.  * @param {function} [callback] - Callback that handles errors and response
  309.  *
  310.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*}
  311.  */
  312. CatApi.prototype.help = function catHelpApi(params, options, callback) {
  313.   [params, options, callback] = normalizeArguments(params, options, callback);
  315.   let { method, body, ...querystring } = params;
  316.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  318.   let path = '';
  319.   if (method == null) method = 'GET';
  320.   path = '/' + '_cat';
  322.   // build request object
  323.   const request = {
  324.     method,
  325.     path,
  326.     body: null,
  327.     querystring,
  328.   };
  330.   return this.transport.request(request, options, callback);
  331. };
  333. /**
  334.  * The CAT indices operation lists information related to indices—how much disk space they are using, how many shards they have, their health status, and so on.
  335.  * <br/> See Also: {@link https://opensearch.org/docs/latest/api-reference/cat/cat-indices/ OpenSearch - CAT indices}
  336.  *
  337.  * @memberOf API-CAT
  338.  *
  339.  * @param {Object} params - Accepts {@link https://opensearch.org/docs/latest/api-reference/cat/index#optional-query-parameters - common CAT parameters} along with the following unique parameters:
  340.  * @param {string} [params.index] - To limit the information to specific indices, provide the index names seperated by commas.
  341.  * @param {string} [params.bytes] - Specify the units for byte size. For example, '7kb' or '6gb'.
  342.  * @param {string} [params.health] - Limit indices based on their health status. Supported values are 'green', 'yellow', and 'red'.
  343.  * @param {boolean} [params.include_unloaded_segments=false] - Whether to include information from segments not loaded into memory.
  344.  * @param {string} [params.cluster_manager_timeout=30s] - The amount of time to wait for a connection to the cluster manager node.
  345.  * @param {boolean} [params.pri=false] - Whether to return information only from the primary shards.
  346.  * @param {string} [params.time] - Specify the units for time. For example, '5d' or '7h'.
  347.  * @param {string} [params.expand_wildcards=open] - Expands wildcard expressions to concrete indices. Combine multiple values with commas. Supported values are 'all', 'open', 'closed', 'hidden', and 'none'.
  348.  *
  349.  * @param {Object} [options] - Options for {@link Transport#request}
  350.  * @param {function} [callback] - Callback that handles errors and response
  351.  *
  352.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*} {@link https://opensearch.org/docs/latest/api-reference/cat/cat-indices/#response CAT indices Response}
  353.  */
  354. CatApi.prototype.indices = function catIndicesApi(params, options, callback) {
  355.   [params, options, callback] = normalizeArguments(params, options, callback);
  357.   let { method, body, index, ...querystring } = params;
  358.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  360.   let path = '';
  361.   if (index != null) {
  362.     if (method == null) method = 'GET';
  363.     path = '/' + '_cat' + '/' + 'indices' + '/' + encodeURIComponent(index);
  364.   } else {
  365.     if (method == null) method = 'GET';
  366.     path = '/' + '_cat' + '/' + 'indices';
  367.   }
  369.   // build request object
  370.   const request = {
  371.     method,
  372.     path,
  373.     body: null,
  374.     querystring,
  375.   };
  377.   return this.transport.request(request, options, callback);
  378. };
  380. /**
  381.  * The CAT cluster manager operation lists information that helps identify the elected cluster manager node.
  382.  * <br/> See Also: {@link https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/ OpenSearch - CAT cluster manager}
  383.  *
  384.  * @memberOf API-CAT
  385.  *
  386.  * @param {Object} params - Accepts {@link https://opensearch.org/docs/latest/api-reference/cat/index#optional-query-parameters - common CAT parameters}
  387.  * @param {Object} [options] - Options for {@link Transport#request}
  388.  * @param {function} [callback] - Callback that handles errors and response
  389.  *
  390.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*} {@link https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/#response CAT cluster manager Response}
  391.  */
  392. CatApi.prototype.cluster_manager = function catClusterManagerApi(params, options, callback) {
  393.   [params, options, callback] = normalizeArguments(params, options, callback);
  395.   let { method, body, ...querystring } = params;
  396.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  398.   let path = '';
  399.   if (method == null) method = 'GET';
  400.   path = '/' + '_cat' + '/' + 'cluster_manager';
  402.   // build request object
  403.   const request = {
  404.     method,
  405.     path,
  406.     body: null,
  407.     querystring,
  408.   };
  410.   return this.transport.request(request, options, callback);
  411. };
  413. /**
  414.  * // TODO: delete CatApi.prototype.master when it is removed from OpenSearch
  415.  * @deprecated use CatApi.prototype.cluster_manager instead
  416.  */
  417. CatApi.prototype.master = function catMasterApi(params, options, callback) {
  418.   [params, options, callback] = normalizeArguments(params, options, callback);
  420.   let { method, body, ...querystring } = params;
  421.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  423.   let path = '';
  424.   if (method == null) method = 'GET';
  425.   path = '/' + '_cat' + '/' + 'master';
  427.   // build request object
  428.   const request = {
  429.     method,
  430.     path,
  431.     body: null,
  432.     querystring,
  433.   };
  435.   return this.transport.request(request, options, callback);
  436. };
  438. /**
  439.  * The CAT nodeattrs operation lists the attributes of custom nodes.
  440.  * <br/> See Also: {@link https://opensearch.org/docs/latest/api-reference/cat/cat-nodeattrs/ OpenSearch - CAT aliases}
  441.  *
  442.  * @memberOf API-CAT
  443.  *
  444.  * @param {Object} params - Accepts {@link https://opensearch.org/docs/latest/api-reference/cat/index#optional-query-parameters - common CAT parameters} along with the following unique parameters:
  445.  * @param {boolean} [params.local=false] - Whether to return information from the local node only instead of from the cluster manager node.
  446.  * @param {string} [params.cluster_manager_timeout=30s] - The amount of time to wait for a connection to the cluster manager node.
  447.  *
  448.  * @param {Object} [options] - Options for {@link Transport#request}
  449.  * @param {function} [callback] - Callback that handles errors and response
  450.  *
  451.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*} {@link https://opensearch.org/docs/latest/api-reference/cat/cat-nodeattrs/#response CAT nodeattrs Response}
  452.  */
  453. CatApi.prototype.nodeattrs = function catNodeattrsApi(params, options, callback) {
  454.   [params, options, callback] = normalizeArguments(params, options, callback);
  456.   let { method, body, ...querystring } = params;
  457.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  459.   let path = '';
  460.   if (method == null) method = 'GET';
  461.   path = '/' + '_cat' + '/' + 'nodeattrs';
  463.   // build request object
  464.   const request = {
  465.     method,
  466.     path,
  467.     body: null,
  468.     querystring,
  469.   };
  471.   return this.transport.request(request, options, callback);
  472. };
  474. /**
  475.  * The CAT nodes operation lists node-level information, including node roles and load metrics.
  476.  * <br/> See Also: {@link https://opensearch.org/docs/latest/api-reference/cat/cat-nodes/ OpenSearch - CAT nodes}
  477.  *
  478.  * @memberOf API-CAT
  479.  *
  480.  * @param {Object} params - Accepts {@link https://opensearch.org/docs/latest/api-reference/cat/index#optional-query-parameters - common CAT parameters} along with the following unique parameters:
  481.  * @param {string} [params.bytes] - Specify the units for byte size. For example, '7kb' or '6gb'.
  482.  * @param {boolean} [params.full_id=false] - If true, return the full node ID. If false, return the shortened node ID.
  483.  * @param {boolean} [params.local=false] - Whether to return information from the local node only instead of from the cluster_manager node.
  484.  * @param {string} [params.cluster_manager_timeout=30s] - The amount of time to wait for a connection to the cluster manager node.
  485.  * @param {string} [params.time] - Specify the units for time. For example, '5d' or '7h'.
  486.  * @param {boolean} [params.include_unloaded_segments=false] - Whether to include information from segments not loaded into memory.
  487.  *
  488.  * @param {Object} [options] - Options for {@link Transport#request}
  489.  * @param {function} [callback] - Callback that handles errors and response
  490.  *
  491.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*} {@link https://opensearch.org/docs/latest/api-reference/cat/cat-nodes/#response CAT nodes Response}
  492.  */
  493. CatApi.prototype.nodes = function catNodesApi(params, options, callback) {
  494.   [params, options, callback] = normalizeArguments(params, options, callback);
  496.   let { method, body, ...querystring } = params;
  497.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  499.   let path = '';
  500.   if (method == null) method = 'GET';
  501.   path = '/' + '_cat' + '/' + 'nodes';
  503.   // build request object
  504.   const request = {
  505.     method,
  506.     path,
  507.     body: null,
  508.     querystring,
  509.   };
  511.   return this.transport.request(request, options, callback);
  512. };
  514. /**
  515.  * The CAT pending tasks operation lists the progress of all pending tasks, including task priority and time in queue.
  516.  * <br/> See Also: {@link https://opensearch.org/docs/latest/api-reference/cat/cat-pending-tasks/ OpenSearch - CAT pending tasks}
  517.  *
  518.  * @memberOf API-CAT
  519.  *
  520.  * @param {Object} params - Accepts {@link https://opensearch.org/docs/latest/api-reference/cat/index#optional-query-parameters - common CAT parameters} along with the following unique parameters:
  521.  * @param {boolean} [params.local=false] - Whether to return information from the local node only instead of from the cluster_manager node.
  522.  * @param {string} [params.cluster_manager_timeout=30s] - The amount of time to wait for a connection to the cluster manager node.
  523.  * @param {string} [params.time] - Specify the units for time. For example, '5d' or '7h'.
  524.  *
  525.  * @param {Object} [options] - Options for {@link Transport#request}
  526.  * @param {function} [callback] - Callback that handles errors and response
  527.  *
  528.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*} {@link https://opensearch.org/docs/latest/api-reference/cat/cat-pending-tasks/#response CAT pending tasks Response}
  529.  */
  530. CatApi.prototype.pendingTasks = function catPendingTasksApi(params, options, callback) {
  531.   [params, options, callback] = normalizeArguments(params, options, callback);
  533.   let { method, body, ...querystring } = params;
  534.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  536.   let path = '';
  537.   if (method == null) method = 'GET';
  538.   path = '/' + '_cat' + '/' + 'pending_tasks';
  540.   // build request object
  541.   const request = {
  542.     method,
  543.     path,
  544.     body: null,
  545.     querystring,
  546.   };
  548.   return this.transport.request(request, options, callback);
  549. };
  551. /**
  552.  * The CAT plugins operation lists the names, components, and versions of the installed plugins.
  553.  * <br/> See Also: {@link https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/ OpenSearch - CAT plugins}
  554.  *
  555.  * @memberOf API-CAT
  556.  *
  557.  * @param {Object} params - Accepts {@link https://opensearch.org/docs/latest/api-reference/cat/index#optional-query-parameters - common CAT parameters} along with the following unique parameters:
  558.  * @param {boolean} [params.local=false] - Whether to return information from the local node only instead of from the cluster_manager node.
  559.  * @param {string} [params.cluster_manager_timeout=30s] - The amount of time to wait for a connection to the cluster manager node.
  560.  *
  561.  * @param {Object} [options] - Options for {@link Transport#request}
  562.  * @param {function} [callback] - Callback that handles errors and response
  563.  *
  564.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*} {@link https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/#response CAT plugins Response}
  565.  */
  566. CatApi.prototype.plugins = function catPluginsApi(params, options, callback) {
  567.   [params, options, callback] = normalizeArguments(params, options, callback);
  569.   let { method, body, ...querystring } = params;
  570.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  572.   let path = '';
  573.   if (method == null) method = 'GET';
  574.   path = '/' + '_cat' + '/' + 'plugins';
  576.   // build request object
  577.   const request = {
  578.     method,
  579.     path,
  580.     body: null,
  581.     querystring,
  582.   };
  584.   return this.transport.request(request, options, callback);
  585. };
  587. /**
  588.  * The CAT recovery operation lists all completed and ongoing index and shard recoveries.
  589.  * <br/> See Also: {@link https://opensearch.org/docs/latest/api-reference/cat/cat-recovery/ OpenSearch - CAT recovery}
  590.  *
  591.  * @memberOf API-CAT
  592.  *
  593.  * @param {Object} params - Accepts {@link https://opensearch.org/docs/latest/api-reference/cat/index#optional-query-parameters - common CAT parameters} along with the following unique parameters:
  594.  * @param {string} [params.bytes] - Specify the units for byte size. For example, '7kb' or '6gb'.
  595.  * @param {string} [params.time] - Specify the units for time. For example, '5d' or '7h'.
  596.  * @param {boolean} [params.active_only=false] - Whether to only include ongoing shard recoveries.
  597.  * @param {boolean} [params.detailed=false] - Whether to only include ongoing shard recoveries.
  598.  *
  599.  * @param {Object} [options] - Options for {@link Transport#request}
  600.  * @param {function} [callback] - Callback that handles errors and response
  601.  *
  602.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*} {@link https://opensearch.org/docs/latest/api-reference/cat/cat-recovery/#response CAT recovery Response}
  603.  */
  604. CatApi.prototype.recovery = function catRecoveryApi(params, options, callback) {
  605.   [params, options, callback] = normalizeArguments(params, options, callback);
  607.   let { method, body, index, ...querystring } = params;
  608.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  610.   let path = '';
  611.   if (index != null) {
  612.     if (method == null) method = 'GET';
  613.     path = '/' + '_cat' + '/' + 'recovery' + '/' + encodeURIComponent(index);
  614.   } else {
  615.     if (method == null) method = 'GET';
  616.     path = '/' + '_cat' + '/' + 'recovery';
  617.   }
  619.   // build request object
  620.   const request = {
  621.     method,
  622.     path,
  623.     body: null,
  624.     querystring,
  625.   };
  627.   return this.transport.request(request, options, callback);
  628. };
  630. /**
  631.  * The CAT repositories operation lists all completed and ongoing index and shard recoveries.
  632.  * <br/> See Also: {@link https://opensearch.org/docs/latest/api-reference/cat/cat-repositories/ OpenSearch - CAT repositories}
  633.  *
  634.  * @memberOf API-CAT
  635.  *
  636.  * @param {Object} params - Accepts {@link https://opensearch.org/docs/latest/api-reference/cat/index#optional-query-parameters - common CAT parameters} along with the following unique parameters:
  637.  * @param {boolean} [params.local=false] - Whether to return information from the local node only instead of from the cluster_manager node.
  638.  * @param {string} [params.cluster_manager_timeout=30s] - The amount of time to wait for a connection to the cluster manager node.
  639.  *
  640.  * @param {Object} [options] - Options for {@link Transport#request}
  641.  * @param {function} [callback] - Callback that handles errors and response
  642.  *
  643.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*} {@link https://opensearch.org/docs/latest/api-reference/cat/cat-repositories/#response CAT repositories Response}
  644.  */
  645. CatApi.prototype.repositories = function catRepositoriesApi(params, options, callback) {
  646.   [params, options, callback] = normalizeArguments(params, options, callback);
  648.   let { method, body, ...querystring } = params;
  649.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  651.   let path = '';
  652.   if (method == null) method = 'GET';
  653.   path = '/' + '_cat' + '/' + 'repositories';
  655.   // build request object
  656.   const request = {
  657.     method,
  658.     path,
  659.     body: null,
  660.     querystring,
  661.   };
  663.   return this.transport.request(request, options, callback);
  664. };
  666. /**
  667.  * The cat segments operation lists Lucene segment-level information for each index.
  668.  * <br/> See Also: {@link https://opensearch.org/docs/latest/api-reference/cat/cat-segments/ OpenSearch - CAT segments}
  669.  *
  670.  * @memberOf API-CAT
  671.  *
  672.  * @param {Object} params - Accepts {@link https://opensearch.org/docs/latest/api-reference/cat/index#optional-query-parameters - common CAT parameters} along with the following unique parameters:
  673.  * @param {string} [params.index] - To see only the information about segments of specific indices, provide the index names seperated by commas.
  674.  * @param {string} [params.bytes] - Specify the units for byte size. For example, '7kb' or '6gb'.
  675.  * @param {string} [params.cluster_manager_timeout=30s] - The amount of time to wait for a connection to the cluster manager node.
  676.  *
  677.  * @param {Object} [options] - Options for {@link Transport#request}
  678.  * @param {function} [callback] - Callback that handles errors and response
  679.  *
  680.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*} {@link https://opensearch.org/docs/latest/api-reference/cat/cat-segments/#response CAT segments Response}
  681.  */
  682. CatApi.prototype.segments = function catSegmentsApi(params, options, callback) {
  683.   [params, options, callback] = normalizeArguments(params, options, callback);
  685.   let { method, body, index, ...querystring } = params;
  686.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  688.   let path = '';
  689.   if (index != null) {
  690.     if (method == null) method = 'GET';
  691.     path = '/' + '_cat' + '/' + 'segments' + '/' + encodeURIComponent(index);
  692.   } else {
  693.     if (method == null) method = 'GET';
  694.     path = '/' + '_cat' + '/' + 'segments';
  695.   }
  697.   // build request object
  698.   const request = {
  699.     method,
  700.     path,
  701.     body: null,
  702.     querystring,
  703.   };
  705.   return this.transport.request(request, options, callback);
  706. };
  708. /**
  709.  * The CAT shards operation lists the state of all primary and replica shards and how they are distributed.
  710.  * <br/> See Also: {@link https://opensearch.org/docs/latest/api-reference/cat/cat-shards/ OpenSearch - CAT shards}
  711.  *
  712.  * @memberOf API-CAT
  713.  *
  714.  * @param {Object} params - Accepts {@link https://opensearch.org/docs/latest/api-reference/cat/index#optional-query-parameters - common CAT parameters} along with the following unique parameters:
  715.  * @param {string} [params.index] - To see only the information about shards of specific indices, provide the index names seperated by commas.
  716.  * @param {string} [params.bytes] - Specify the units for byte size. For example, '7kb' or '6gb'.
  717.  * @param {boolean} [params.local=false] - Whether to return information from the local node only instead of from the cluster_manager node.
  718.  * @param {string} [params.cluster_manager_timeout=30s] - The amount of time to wait for a connection to the cluster manager node.
  719.  * @param {string} [params.time] - Specify the units for time. For example, '5d' or '7h'.
  720.  *
  721.  * @param {Object} [options] - Options for {@link Transport#request}
  722.  * @param {function} [callback] - Callback that handles errors and response
  723.  *
  724.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*} {@link https://opensearch.org/docs/latest/api-reference/cat/cat-shards/#response CAT shards Response}
  725.  */
  726. CatApi.prototype.shards = function catShardsApi(params, options, callback) {
  727.   [params, options, callback] = normalizeArguments(params, options, callback);
  729.   let { method, body, index, ...querystring } = params;
  730.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  732.   let path = '';
  733.   if (index != null) {
  734.     if (method == null) method = 'GET';
  735.     path = '/' + '_cat' + '/' + 'shards' + '/' + encodeURIComponent(index);
  736.   } else {
  737.     if (method == null) method = 'GET';
  738.     path = '/' + '_cat' + '/' + 'shards';
  739.   }
  741.   // build request object
  742.   const request = {
  743.     method,
  744.     path,
  745.     body: null,
  746.     querystring,
  747.   };
  749.   return this.transport.request(request, options, callback);
  750. };
  752. /**
  753.  * The CAT snapshots operation lists all snapshots for a repository.
  754.  * <br/> See Also: {@link https://opensearch.org/docs/latest/api-reference/cat/cat-snapshots/ OpenSearch - CAT snapshots}
  755.  *
  756.  * @memberOf API-CAT
  757.  *
  758.  * @param {Object} params - Accepts {@link https://opensearch.org/docs/latest/api-reference/cat/index#optional-query-parameters - common CAT parameters} along with the following unique parameters:
  759.  * @param {string} [params.cluster_manager_timeout=30s] - The amount of time to wait for a connection to the cluster manager node.
  760.  * @param {string} [params.time] - Specify the units for time. For example, '5d' or '7h'.
  761.  *
  762.  * @param {Object} [options] - Options for {@link Transport#request}
  763.  * @param {function} [callback] - Callback that handles errors and response
  764.  *
  765.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*} {@link https://opensearch.org/docs/latest/api-reference/cat/cat-snapshots/#response CAT snapshots Response}
  766.  */
  767. CatApi.prototype.snapshots = function catSnapshotsApi(params, options, callback) {
  768.   [params, options, callback] = normalizeArguments(params, options, callback);
  770.   let { method, body, repository, ...querystring } = params;
  771.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  773.   let path = '';
  774.   if (repository != null) {
  775.     if (method == null) method = 'GET';
  776.     path = '/' + '_cat' + '/' + 'snapshots' + '/' + encodeURIComponent(repository);
  777.   } else {
  778.     if (method == null) method = 'GET';
  779.     path = '/' + '_cat' + '/' + 'snapshots';
  780.   }
  782.   // build request object
  783.   const request = {
  784.     method,
  785.     path,
  786.     body: null,
  787.     querystring,
  788.   };
  790.   return this.transport.request(request, options, callback);
  791. };
  793. /**
  794.  * The CAT tasks operation lists the progress of all tasks currently running on your cluster.
  795.  * <br/> See Also: {@link https://opensearch.org/docs/latest/api-reference/cat/cat-tasks/ OpenSearch - CAT tasks}
  796.  *
  797.  * @memberOf API-CAT
  798.  *
  799.  * @param {Object} params - Accepts {@link https://opensearch.org/docs/latest/api-reference/cat/index#optional-query-parameters - common CAT parameters} along with the following unique parameters:
  800.  * @param {string} [params.nodes] - A 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, specify the node name to get information from specific nodes, or keep the parameter empty to get information from all nodes.
  801.  * @param {string} [params.time] - Specify the units for time. For example, '5d' or '7h'.
  802.  * @param {boolean} [params.detailed=false] - Returns detailed task information.
  803.  * @param {string} [params.parent_task_id] - Returns tasks with a specified parent task ID (node_id:task_number). Keep empty or set to -1 to return all.
  804.  *
  805.  * @param {Object} [options] - Options for {@link Transport#request}
  806.  * @param {function} [callback] - Callback that handles errors and response
  807.  *
  808.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*} {@link https://opensearch.org/docs/latest/api-reference/cat/cat-tasks/#response CAT tasks Response}
  809.  */
  810. CatApi.prototype.tasks = function catTasksApi(params, options, callback) {
  811.   [params, options, callback] = normalizeArguments(params, options, callback);
  813.   let { method, body, ...querystring } = params;
  814.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  816.   let path = '';
  817.   if (method == null) method = 'GET';
  818.   path = '/' + '_cat' + '/' + 'tasks';
  820.   // build request object
  821.   const request = {
  822.     method,
  823.     path,
  824.     body: null,
  825.     querystring,
  826.   };
  828.   return this.transport.request(request, options, callback);
  829. };
  831. /**
  832.  * The CAT templates operation lists the names, patterns, order numbers, and version numbers of index templates.
  833.  * <br/> See Also: {@link https://opensearch.org/docs/latest/api-reference/cat/cat-templates/ OpenSearch - CAT templates}
  834.  *
  835.  * @memberOf API-CAT
  836.  *
  837.  * @param {Object} params - Accepts {@link https://opensearch.org/docs/latest/api-reference/cat/index#optional-query-parameters - common CAT parameters} along with the following unique parameters:
  838.  * @param {boolean} [params.name] - If you want to limit it to a specific template or pattern, provide the template name or pattern.
  839.  * @param {boolean} [params.local=false] - Whether to return information from the local node only instead of from the cluster manager node.
  840.  * @param {string} [params.cluster_manager_timeout=30s] - The amount of time to wait for a connection to the cluster manager node.
  841.  *
  842.  * @param {Object} [options] - Options for {@link Transport#request}
  843.  * @param {function} [callback] - Callback that handles errors and response
  844.  *
  845.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*} {@link https://opensearch.org/docs/latest/api-reference/cat/cat-templates/#response CAT templates Response}
  846.  */
  847. CatApi.prototype.templates = function catTemplatesApi(params, options, callback) {
  848.   [params, options, callback] = normalizeArguments(params, options, callback);
  850.   let { method, body, name, ...querystring } = params;
  851.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  853.   let path = '';
  854.   if (name != null) {
  855.     if (method == null) method = 'GET';
  856.     path = '/' + '_cat' + '/' + 'templates' + '/' + encodeURIComponent(name);
  857.   } else {
  858.     if (method == null) method = 'GET';
  859.     path = '/' + '_cat' + '/' + 'templates';
  860.   }
  862.   // build request object
  863.   const request = {
  864.     method,
  865.     path,
  866.     body: null,
  867.     querystring,
  868.   };
  870.   return this.transport.request(request, options, callback);
  871. };
  873. /**
  874.  * The CAT thread pool operation lists the active, queued, and rejected threads of different thread pools on each node.
  875.  * <br/> See Also: {@link https://opensearch.org/docs/latest/api-reference/cat/cat-thread-pool/ OpenSearch - CAT thread pool}
  876.  *
  877.  * @memberOf API-CAT
  878.  *
  879.  * @param {Object} params - Accepts {@link https://opensearch.org/docs/latest/api-reference/cat/index#optional-query-parameters - common CAT parameters} along with the following unique parameters:
  880.  * @param {boolean} [params.local=false] - Whether to return information from the local node only instead of from the cluster manager node.
  881.  * @param {string} [params.cluster_manager_timeout=30s] - The amount of time to wait for a connection to the cluster manager node.
  882.  *
  883.  * @param {Object} [options] - Options for {@link Transport#request}
  884.  * @param {function} [callback] - Callback that handles errors and response
  885.  *
  886.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*} {@link https://opensearch.org/docs/latest/api-reference/cat/cat-thread-pool/#response CAT thread pool Response}
  887.  */
  888. CatApi.prototype.threadPool = function catThreadPoolApi(params, options, callback) {
  889.   [params, options, callback] = normalizeArguments(params, options, callback);
  891.   let { method, body, threadPoolPatterns, thread_pool_patterns, ...querystring } = params;
  892.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  894.   let path = '';
  895.   if ((thread_pool_patterns || threadPoolPatterns) != null) {
  896.     if (method == null) method = 'GET';
  897.     path =
  898.       '/' +
  899.       '_cat' +
  900.       '/' +
  901.       'thread_pool' +
  902.       '/' +
  903.       encodeURIComponent(thread_pool_patterns || threadPoolPatterns);
  904.   } else {
  905.     if (method == null) method = 'GET';
  906.     path = '/' + '_cat' + '/' + 'thread_pool';
  907.   }
  909.   // build request object
  910.   const request = {
  911.     method,
  912.     path,
  913.     body: null,
  914.     querystring,
  915.   };
  917.   return this.transport.request(request, options, callback);
  918. };
  920. Object.defineProperties(CatApi.prototype, {
  921.   pending_tasks: {
  922.     get() {
  923.       return this.pendingTasks;
  924.     },
  925.   },
  926.   thread_pool: {
  927.     get() {
  928.       return this.threadPool;
  929.     },
  930.   },
  931. });
  933. module.exports = CatApi;