Source: api/api/get_all_pits.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. 'use strict';
  13. /* eslint camelcase: 0 */
  14. /* eslint no-unused-vars: 0 */
  16. const { handleError, snakeCaseKeys, normalizeArguments, kConfigurationError } = require('../utils');
  17. const acceptedQuerystring = ['pretty', 'human', 'error_trace', 'source', 'filter_path'];
  18. const snakeCase = { errorTrace: 'error_trace', filterPath: 'filter_path' };
  20. /**
  21.  * Returns all PITs in the OpenSearch cluster.
  22.  * <br/> See Also: {@link https://opensearch.org/docs/latest/opensearch/point-in-time-api#list-all-pits|Opensearch - List all PITs}
  23.  * @memberOf API-PIT
  24.  *
  25.  * @param {Object} params
  26.  *
  27.  * @param {Object} [options] - Options for {@link Transport#request}
  28.  * @param {function} [callback] - Callback that handles errors and response
  29.  *
  30.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*} {@link https://opensearch.org/docs/latest/opensearch/point-in-time-api#sample-response-1|List all PITs Response}
  31.  */
  32. function getAllPitsApi(params, options, callback) {
  33.   [params, options, callback] = normalizeArguments(params, options, callback);
  35.   let { method, body, ...querystring } = params;
  36.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  38.   let path = '';
  39.   if (method == null) method = 'GET';
  40.   path = '/' + '_search' + '/' + 'point_in_time' + '/' + '_all';
  42.   // build request object
  43.   const request = {
  44.     method,
  45.     path,
  46.     body: null,
  47.     querystring,
  48.   };
  50.   return this.transport.request(request, options, callback);
  51. }
  53. module.exports = getAllPitsApi;