/* * 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 */ function buildIndicesFreeze (opts) { // eslint-disable-next-line no-unused-vars const { makeRequest, ConfigurationError, handleError } = opts /** * Perform a [indices.freeze](https://www.elastic.co/guide/en/elasticsearch/reference/current/frozen.html) request * * @param {string} index - The name of the index to freeze * @param {time} timeout - Explicit operation timeout * @param {time} master_timeout - Specify timeout for connection to master * @param {boolean} ignore_unavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {boolean} allow_no_indices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {enum} expand_wildcards - Whether to expand wildcard expression to concrete indices that are open, closed or both. * @param {string} wait_for_active_shards - Sets the number of active shards to wait for before the operation returns. */ const acceptedQuerystring = [ 'timeout', 'master_timeout', 'ignore_unavailable', 'allow_no_indices', 'expand_wildcards', 'wait_for_active_shards' ] const snakeCase = { masterTimeout: 'master_timeout', ignoreUnavailable: 'ignore_unavailable', allowNoIndices: 'allow_no_indices', expandWildcards: 'expand_wildcards', waitForActiveShards: 'wait_for_active_shards' } return function indicesFreeze (params, options, callback) { options = options || {} if (typeof options === 'function') { callback = options options = {} } if (typeof params === 'function' || params == null) { callback = params params = {} options = {} } // check required parameters if (params['index'] == null) { const err = new ConfigurationError('Missing required parameter: index') return handleError(err, callback) } if (params.body != null) { const err = new ConfigurationError('This API does not require a body') return handleError(err, callback) } // validate headers object if (options.headers != null && typeof options.headers !== 'object') { const err = new ConfigurationError(`Headers should be an object, instead got: ${typeof options.headers}`) return handleError(err, callback) } var warnings = null var { method, body, index } = params var querystring = semicopy(params, ['method', 'body', 'index']) if (method == null) { method = 'POST' } var ignore = options.ignore || null if (typeof ignore === 'number') { ignore = [ignore] } var path = '' path = '/' + encodeURIComponent(index) + '/' + '_freeze' // build request object const request = { method, path, body: '', querystring } const requestOptions = { ignore, requestTimeout: options.requestTimeout || null, maxRetries: options.maxRetries || null, asStream: options.asStream || false, headers: options.headers || null, querystring: options.querystring || null, compression: options.compression || false, warnings } return makeRequest(request, requestOptions, callback) function semicopy (obj, exclude) { var target = {} var keys = Object.keys(obj) for (var i = 0, len = keys.length; i < len; i++) { var key = keys[i] if (exclude.indexOf(key) === -1) { target[snakeCase[key] || key] = obj[key] if (acceptedQuerystring.indexOf(snakeCase[key] || key) === -1) { warnings = warnings || [] warnings.push('Client - Unknown parameter: "' + key + '", sending it as query parameter') } } } return target } } } module.exports = buildIndicesFreeze