Source: api/api/dangling_indices.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-Dangling-Indices */
  37. const { handleError, snakeCaseKeys, normalizeArguments, kConfigurationError } = require('../utils');
  38. const acceptedQuerystring = [
  39.   'accept_data_loss',
  40.   'timeout',
  41.   'cluster_manager_timeout',
  42.   'master_timeout',
  43.   'pretty',
  44.   'human',
  45.   'error_trace',
  46.   'source',
  47.   'filter_path',
  48. ];
  49. const snakeCase = {
  50.   acceptDataLoss: 'accept_data_loss',
  51.   clusterManagerTimeout: 'cluster_manager_timeout',
  52.   masterTimeout: 'master_timeout',
  53.   errorTrace: 'error_trace',
  54.   filterPath: 'filter_path',
  55. };
  57. function DanglingIndicesApi(transport, ConfigurationError) {
  58.   this.transport = transport;
  59.   this[kConfigurationError] = ConfigurationError;
  60. }
  62. /**
  63.  * Deletes the specified dangling index
  64.  * <br/> See also: {@link https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/ OpenSearch - Dangling Indexes}
  65.  * @memberOf API-Dangling-Indices
  66.  *
  67.  * @param {Object} params
  68.  * @param {string} params.index_uuid - The UUID of the dangling index
  69.  * @param {boolean} [params.accept_data_loss] - Must be set to true in order to delete the dangling index
  70.  * @param {string} [params.timeout=30s] - Explicit operation timeout
  71.  * @param {string} [params.cluster_manager_timeout] - Specify timeout for connection to cluster_manager
  72.  *
  73.  * @param {Object} [options] - Options for {@link Transport#request}
  74.  * @param {function} [callback] - Callback that handles errors and response
  75.  *
  76.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*}
  77.  */
  78. DanglingIndicesApi.prototype.deleteDanglingIndex = function danglingIndicesDeleteDanglingIndexApi(
  79.   params,
  80.   options,
  81.   callback
  82. ) {
  83.   [params, options, callback] = normalizeArguments(params, options, callback);
  85.   // check required parameters
  86.   if (params.index_uuid == null && params.indexUuid == null) {
  87.     const err = new this[kConfigurationError](
  88.       'Missing required parameter: index_uuid or indexUuid'
  89.     );
  90.     return handleError(err, callback);
  91.   }
  93.   let { method, body, indexUuid, index_uuid, ...querystring } = params;
  94.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  96.   let path = '';
  97.   if (method == null) method = 'DELETE';
  98.   path = '/' + '_dangling' + '/' + encodeURIComponent(index_uuid || indexUuid);
  100.   // build request object
  101.   const request = {
  102.     method,
  103.     path,
  104.     body: body || '',
  105.     querystring,
  106.   };
  108.   return this.transport.request(request, options, callback);
  109. };
  111. /**
  112.  * Imports the specified dangling index
  113.  * <br/> See also: {@link https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/ OpenSearch - Dangling Indexes}
  114.  * @memberOf API-Dangling-Indices
  115.  *
  116.  * @param {Object} params
  117.  * @param {string} params.index_uuid - The UUID of the dangling index
  118.  * @param {boolean} [params.accept_data_loss] - Must be set to true in order to delete the dangling index
  119.  * @param {string} [params.timeout=30s] - Explicit operation timeout
  120.  * @param {string} [params.cluster_manager_timeout] - Specify timeout for connection to cluster_manager
  121.  *
  122.  * @param {Object} [options] - Options for {@link Transport#request}
  123.  * @param {function} [callback] - Callback that handles errors and response
  124.  *
  125.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*}
  126.  */
  127. DanglingIndicesApi.prototype.importDanglingIndex = function danglingIndicesImportDanglingIndexApi(
  128.   params,
  129.   options,
  130.   callback
  131. ) {
  132.   [params, options, callback] = normalizeArguments(params, options, callback);
  134.   // check required parameters
  135.   if (params.index_uuid == null && params.indexUuid == null) {
  136.     const err = new this[kConfigurationError](
  137.       'Missing required parameter: index_uuid or indexUuid'
  138.     );
  139.     return handleError(err, callback);
  140.   }
  142.   let { method, body, indexUuid, index_uuid, ...querystring } = params;
  143.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  145.   let path = '';
  146.   if (method == null) method = 'POST';
  147.   path = '/' + '_dangling' + '/' + encodeURIComponent(index_uuid || indexUuid);
  149.   // build request object
  150.   const request = {
  151.     method,
  152.     path,
  153.     body: body || '',
  154.     querystring,
  155.   };
  157.   return this.transport.request(request, options, callback);
  158. };
  160. /**
  161.  * Retrieve all dangling indices.
  162.  * <br/> See also: {@link https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/ OpenSearch - Dangling Indexes}
  163.  * @memberOf API-Dangling-Indices
  164.  *
  165.  * @param {Object} params - (Unused)
  166.  * @param {Object} [options] - Options for {@link Transport#request}
  167.  * @param {function} [callback] - Callback that handles errors and response
  168.  *
  169.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*}
  170.  */
  171. DanglingIndicesApi.prototype.listDanglingIndices = function danglingIndicesListDanglingIndicesApi(
  172.   params,
  173.   options,
  174.   callback
  175. ) {
  176.   [params, options, callback] = normalizeArguments(params, options, callback);
  178.   let { method, body, ...querystring } = params;
  179.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  181.   let path = '';
  182.   if (method == null) method = 'GET';
  183.   path = '/' + '_dangling';
  185.   // build request object
  186.   const request = {
  187.     method,
  188.     path,
  189.     body: null,
  190.     querystring,
  191.   };
  193.   return this.transport.request(request, options, callback);
  194. };
  196. Object.defineProperties(DanglingIndicesApi.prototype, {
  197.   delete_dangling_index: {
  198.     get() {
  199.       return this.deleteDanglingIndex;
  200.     },
  201.   },
  202.   import_dangling_index: {
  203.     get() {
  204.       return this.importDanglingIndex;
  205.     },
  206.   },
  207.   list_dangling_indices: {
  208.     get() {
  209.       return this.listDanglingIndices;
  210.     },
  211.   },
  212. });
  214. module.exports = DanglingIndicesApi;