Source: api/api/delete_by_query_rethrottle.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. const { handleError, snakeCaseKeys, normalizeArguments, kConfigurationError } = require('../utils');
  36. const acceptedQuerystring = [
  37.   'requests_per_second',
  38.   'pretty',
  39.   'human',
  40.   'error_trace',
  41.   'source',
  42.   'filter_path',
  43. ];
  44. const snakeCase = {
  45.   requestsPerSecond: 'requests_per_second',
  46.   errorTrace: 'error_trace',
  47.   filterPath: 'filter_path',
  48. };
  50. /**
  51.  * Changes the number of requests per second for a particular Delete By Query operation.
  52.  *
  53.  * @memberOf API-Document
  54.  *
  55.  * @param {Object} params
  56.  * @param {string} params.task_id - The task id to rethrottle
  57.  * @param {number} params.requests_per_second - The throttle to set on this request in floating sub-requests per second. -1 means set no throttle.
  58.  *
  59.  * @param {Object} options - Options for {@link Transport#request}
  60.  * @param {function} callback - Callback that handles errors and response
  61.  *
  62.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*}
  63.  */
  64. function deleteByQueryRethrottleApi(params, options, callback) {
  65.   [params, options, callback] = normalizeArguments(params, options, callback);
  67.   // check required parameters
  68.   if (params.task_id == null && params.taskId == null) {
  69.     const err = new this[kConfigurationError]('Missing required parameter: task_id or taskId');
  70.     return handleError(err, callback);
  71.   }
  72.   if (params.requests_per_second == null && params.requestsPerSecond == null) {
  73.     const err = new this[kConfigurationError](
  74.       'Missing required parameter: requests_per_second or requestsPerSecond'
  75.     );
  76.     return handleError(err, callback);
  77.   }
  79.   let { method, body, taskId, task_id, ...querystring } = params;
  80.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  82.   let path = '';
  83.   if (method == null) method = 'POST';
  84.   path =
  85.     '/' + '_delete_by_query' + '/' + encodeURIComponent(task_id || taskId) + '/' + '_rethrottle';
  87.   // build request object
  88.   const request = {
  89.     method,
  90.     path,
  91.     body: body || '',
  92.     querystring,
  93.   };
  95.   return this.transport.request(request, options, callback);
  96. }
  98. module.exports = deleteByQueryRethrottleApi;