Source: api/api/features.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-Features */
  37. const { handleError, snakeCaseKeys, normalizeArguments, kConfigurationError } = require('../utils');
  38. const acceptedQuerystring = [
  39.   'cluster_manager_timeout',
  40.   'master_timeout',
  41.   'pretty',
  42.   'human',
  43.   'error_trace',
  44.   'source',
  45.   'filter_path',
  46. ];
  47. const snakeCase = {
  48.   clusterManagerTimeout: 'cluster_manager_timeout',
  49.   masterTimeout: 'master_timeout',
  50.   errorTrace: 'error_trace',
  51.   filterPath: 'filter_path',
  52. };
  54. function FeaturesApi(transport, ConfigurationError) {
  55.   this.transport = transport;
  56.   this[kConfigurationError] = ConfigurationError;
  57. }
  59. /**
  60.  * Gets a list of features
  61.  * @memberOf API-Features
  62.  *
  63.  * @param {Object} params
  64.  * @param {string} [params.cluster_manager_timeout] - Explicit operation timeout for connection to cluster_manager node
  65.  *
  66.  * @param {Object} [options] - Options for {@link Transport#request}
  67.  * @param {function} [callback] - Callback that handles errors and response
  68.  *
  69.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*}
  70.  */
  71. FeaturesApi.prototype.getFeatures = function featuresGetFeaturesApi(params, options, callback) {
  72.   [params, options, callback] = normalizeArguments(params, options, callback);
  74.   let { method, body, ...querystring } = params;
  75.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  77.   let path = '';
  78.   if (method == null) method = 'GET';
  79.   path = '/' + '_features';
  81.   // build request object
  82.   const request = {
  83.     method,
  84.     path,
  85.     body: null,
  86.     querystring,
  87.   };
  89.   return this.transport.request(request, options, callback);
  90. };
  92. /**
  93.  * Resets the internal state of features, usually by deleting system indices
  94.  * @memberOf API-Features
  95.  *
  96.  * @param {Object} params - (Unused)
  97.  * @param {Object} [options] - Options for {@link Transport#request}
  98.  * @param {function} [callback] - Callback that handles errors and response
  99.  *
  100.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*}
  101.  */
  102. FeaturesApi.prototype.resetFeatures = function featuresResetFeaturesApi(params, options, callback) {
  103.   [params, options, callback] = normalizeArguments(params, options, callback);
  105.   let { method, body, ...querystring } = params;
  106.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  108.   let path = '';
  109.   if (method == null) method = 'POST';
  110.   path = '/' + '_features' + '/' + '_reset';
  112.   // build request object
  113.   const request = {
  114.     method,
  115.     path,
  116.     body: body || '',
  117.     querystring,
  118.   };
  120.   return this.transport.request(request, options, callback);
  121. };
  123. Object.defineProperties(FeaturesApi.prototype, {
  124.   get_features: {
  125.     get() {
  126.       return this.getFeatures;
  127.     },
  128.   },
  129.   reset_features: {
  130.     get() {
  131.       return this.resetFeatures;
  132.     },
  133.   },
  134. });
  136. module.exports = FeaturesApi;