/* * 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. * */ /* * Licensed to Elasticsearch B.V. under one or more contributor * license agreements. See the NOTICE file distributed with * this work for additional information regarding copyright * ownership. Elasticsearch B.V. licenses this file to you under * the Apache License, Version 2.0 (the "License"); you may * not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. */ 'use strict'; /* eslint camelcase: 0 */ /* eslint no-unused-vars: 0 */ const { handleError, snakeCaseKeys, normalizeArguments, kConfigurationError } = require('../utils'); const acceptedQuerystring = [ 'requests_per_second', 'pretty', 'human', 'error_trace', 'source', 'filter_path', ]; const snakeCase = { requestsPerSecond: 'requests_per_second', errorTrace: 'error_trace', filterPath: 'filter_path', }; /** * Changes the number of requests per second for a particular Delete By Query operation. * * @memberOf API-Document * * @param {Object} params * @param {string} params.task_id - The task id to rethrottle * @param {number} params.requests_per_second - The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. * * @param {Object} options - Options for {@link Transport#request} * @param {function} callback - Callback that handles errors and response * * @returns {{abort: function(), then: function(), catch: function()}|Promise|*} */ function deleteByQueryRethrottleApi(params, options, callback) { [params, options, callback] = normalizeArguments(params, options, callback); // check required parameters if (params.task_id == null && params.taskId == null) { const err = new this[kConfigurationError]('Missing required parameter: task_id or taskId'); return handleError(err, callback); } if (params.requests_per_second == null && params.requestsPerSecond == null) { const err = new this[kConfigurationError]( 'Missing required parameter: requests_per_second or requestsPerSecond' ); return handleError(err, callback); } let { method, body, taskId, task_id, ...querystring } = params; querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring); let path = ''; if (method == null) method = 'POST'; path = '/' + '_delete_by_query' + '/' + encodeURIComponent(task_id || taskId) + '/' + '_rethrottle'; // build request object const request = { method, path, body: body || '', querystring, }; return this.transport.request(request, options, callback); } module.exports = deleteByQueryRethrottleApi;