/* * 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 buildCatSnapshots (opts) { // eslint-disable-next-line no-unused-vars const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts /** * Perform a [cat.snapshots](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-snapshots.html) request * * @param {list} repository - Name of repository from which to fetch the snapshot information * @param {string} format - a short version of the Accept header, e.g. json, yaml * @param {boolean} ignore_unavailable - Set to true to ignore unavailable snapshots * @param {time} master_timeout - Explicit operation timeout for connection to master node * @param {list} h - Comma-separated list of column names to display * @param {boolean} help - Return help information * @param {list} s - Comma-separated list of column names or column aliases to sort by * @param {boolean} v - Verbose mode. Display column headers */ const acceptedQuerystring = [ 'format', 'ignore_unavailable', 'master_timeout', 'h', 'help', 's', 'v', 'pretty', 'human', 'error_trace', 'source', 'filter_path' ] const snakeCase = { ignoreUnavailable: 'ignore_unavailable', masterTimeout: 'master_timeout', errorTrace: 'error_trace', filterPath: 'filter_path' } return function catSnapshots (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.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 = [] var { method, body, repository, ...querystring } = params querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring, warnings) if (method == null) { method = 'GET' } var ignore = options.ignore if (typeof ignore === 'number') { options.ignore = [ignore] } var path = '' if ((repository) != null) { path = '/' + '_cat' + '/' + 'snapshots' + '/' + encodeURIComponent(repository) } else { path = '/' + '_cat' + '/' + 'snapshots' } // build request object const request = { method, path, body: null, querystring } options.warnings = warnings.length === 0 ? null : warnings return makeRequest(request, options, callback) } } module.exports = buildCatSnapshots