Source: api/api/ingest.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-Ingest */
  37. const { handleError, snakeCaseKeys, normalizeArguments, kConfigurationError } = require('../utils');
  38. const acceptedQuerystring = [
  39.   'cluster_manager_timeout',
  40.   'master_timeout',
  41.   'timeout',
  42.   'pretty',
  43.   'human',
  44.   'error_trace',
  45.   'source',
  46.   'filter_path',
  47.   'summary',
  48.   'verbose',
  49. ];
  50. const snakeCase = {
  51.   clusterManagerTimeout: 'cluster_manager_timeout',
  52.   masterTimeout: 'master_timeout',
  53.   errorTrace: 'error_trace',
  54.   filterPath: 'filter_path',
  55. };
  57. function IngestApi(transport, ConfigurationError) {
  58.   this.transport = transport;
  59.   this[kConfigurationError] = ConfigurationError;
  60. }
  62. /**
  63.  * Deletes a pipeline.
  64.  * <br/> See Also: {@link https://opensearch.org/docs/latest/api-reference/ingest-apis/delete-ingest/ OpenSearch - Delete a pipeline}
  65.  *
  66.  * @memberOf API-Ingest
  67.  *
  68.  * @param {Object} params
  69.  * @param {string} params.id - Pipeline ID
  70.  * @param {string} [params.cluster_manager_timeout] - Explicit operation timeout for connection to cluster_manager node
  71.  * @param {string} [params.timeout] - Explicit operation timeout
  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>|*} {@link https://opensearch.org/docs/latest/api-reference/ingest-apis/delete-ingest/#response Delete Pipeline Response}
  77.  */
  78. IngestApi.prototype.deletePipeline = function ingestDeletePipelineApi(params, options, callback) {
  79.   [params, options, callback] = normalizeArguments(params, options, callback);
  81.   // check required parameters
  82.   if (params.id == null) {
  83.     const err = new this[kConfigurationError]('Missing required parameter: id');
  84.     return handleError(err, callback);
  85.   }
  87.   let { method, body, id, ...querystring } = params;
  88.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  90.   let path = '';
  91.   if (method == null) method = 'DELETE';
  92.   path = '/' + '_ingest' + '/' + 'pipeline' + '/' + encodeURIComponent(id);
  94.   // build request object
  95.   const request = {
  96.     method,
  97.     path,
  98.     body: body || '',
  99.     querystring,
  100.   };
  102.   return this.transport.request(request, options, callback);
  103. };
  105. /**
  106.  * Returns statistical information about geoip databases
  107.  *
  108.  * @memberOf API-Ingest
  109.  *
  110.  * @param {Object} params - (Unused)
  111.  * @param {Object} options - Options for {@link Transport#request}
  112.  * @param {function} callback - Callback that handles errors and response
  113.  *
  114.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*}
  115.  */
  116. IngestApi.prototype.geoIpStats = function ingestGeoIpStatsApi(params, options, callback) {
  117.   [params, options, callback] = normalizeArguments(params, options, callback);
  119.   let { method, body, ...querystring } = params;
  120.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  122.   let path = '';
  123.   if (method == null) method = 'GET';
  124.   path = '/' + '_ingest' + '/' + 'geoip' + '/' + 'stats';
  126.   // build request object
  127.   const request = {
  128.     method,
  129.     path,
  130.     body: null,
  131.     querystring,
  132.   };
  134.   return this.transport.request(request, options, callback);
  135. };
  137. /**
  138.  * Returns a pipeline.
  139.  * <br/> See Also: {@link https://opensearch.org/docs/latest/api-reference/ingest-apis/get-ingest/ OpenSearch - Get pipeline}
  140.  *
  141.  * @memberOf API-Ingest
  142.  *
  143.  * @param {Object} params
  144.  * @param {string} [params.id] - Comma separated list of pipeline ids. Wildcards supported
  145.  * @param {boolean} [params.summary=false] - Return pipelines without their definitions
  146.  * @param {string} [params.cluster_manager_timeout] - Explicit operation timeout for connection to cluster_manager node
  147.  *
  148.  * @param {Object} options - Options for {@link Transport#request}
  149.  * @param {function} callback - Callback that handles errors and response
  150.  *
  151.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*} {@link https://opensearch.org/docs/latest/api-reference/ingest-apis/get-ingest/#response Get Pipeline Response}
  152.  */
  153. IngestApi.prototype.getPipeline = function ingestGetPipelineApi(params, options, callback) {
  154.   [params, options, callback] = normalizeArguments(params, options, callback);
  156.   let { method, body, id, ...querystring } = params;
  157.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  159.   let path = '';
  160.   if (id != null) {
  161.     if (method == null) method = 'GET';
  162.     path = '/' + '_ingest' + '/' + 'pipeline' + '/' + encodeURIComponent(id);
  163.   } else {
  164.     if (method == null) method = 'GET';
  165.     path = '/' + '_ingest' + '/' + 'pipeline';
  166.   }
  168.   // build request object
  169.   const request = {
  170.     method,
  171.     path,
  172.     body: null,
  173.     querystring,
  174.   };
  176.   return this.transport.request(request, options, callback);
  177. };
  179. /**
  180.  * Returns a list of the built-in patterns.
  181.  *
  182.  * @memberOf API-Ingest
  183.  *
  184.  * @param {Object} params - (Unused)
  185.  * @param {Object} options - Options for {@link Transport#request}
  186.  * @param {function} callback - Callback that handles errors and response
  187.  *
  188.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*}
  189.  */
  190. IngestApi.prototype.processorGrok = function ingestProcessorGrokApi(params, options, callback) {
  191.   [params, options, callback] = normalizeArguments(params, options, callback);
  193.   let { method, body, ...querystring } = params;
  194.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  196.   let path = '';
  197.   if (method == null) method = 'GET';
  198.   path = '/' + '_ingest' + '/' + 'processor' + '/' + 'grok';
  200.   // build request object
  201.   const request = {
  202.     method,
  203.     path,
  204.     body: null,
  205.     querystring,
  206.   };
  208.   return this.transport.request(request, options, callback);
  209. };
  211. /**
  212.  * Creates or updates a pipeline.
  213.  * <br/> See Also: {@link https://opensearch.org/docs/latest/api-reference/ingest-apis/create-update-ingest/ OpenSearch - Create/Update pipeline}
  214.  *
  215.  * @memberOf API-Ingest
  216.  *
  217.  * @param {Object} params
  218.  * @param {string} params.id - Pipeline ID
  219.  * @param {Object} params.body - Ingest definition
  220.  * @param {string} [params.cluster_manager_timeout] - Explicit operation timeout for connection to cluster_manager node
  221.  * @param {string} [params.timeout] - Explicit operation timeout
  222.  *
  223.  * @param {Object} options - Options for {@link Transport#request}
  224.  * @param {function} callback - Callback that handles errors and response
  225.  *
  226.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*} {@link https://opensearch.org/docs/latest/api-reference/ingest-apis/create-update-ingest/#response Create/Update Pipeline Response}
  227.  */
  228. IngestApi.prototype.putPipeline = function ingestPutPipelineApi(params, options, callback) {
  229.   [params, options, callback] = normalizeArguments(params, options, callback);
  231.   // check required parameters
  232.   if (params.id == null) {
  233.     const err = new this[kConfigurationError]('Missing required parameter: id');
  234.     return handleError(err, callback);
  235.   }
  236.   if (params.body == null) {
  237.     const err = new this[kConfigurationError]('Missing required parameter: body');
  238.     return handleError(err, callback);
  239.   }
  241.   let { method, body, id, ...querystring } = params;
  242.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  244.   let path = '';
  245.   if (method == null) method = 'PUT';
  246.   path = '/' + '_ingest' + '/' + 'pipeline' + '/' + encodeURIComponent(id);
  248.   // build request object
  249.   const request = {
  250.     method,
  251.     path,
  252.     body: body || '',
  253.     querystring,
  254.   };
  256.   return this.transport.request(request, options, callback);
  257. };
  259. /**
  260.  * Allows to simulate a pipeline with example documents.
  261.  * <br/> See Also: {@link https://opensearch.org/docs/latest/api-reference/ingest-apis/simulate-ingest/ OpenSearch - Simulate Pipeline}
  262.  *
  263.  * @memberOf API-Ingest
  264.  *
  265.  * @param {Object} params
  266.  * @param {string} [params.id] - Pipeline ID
  267.  * @param {boolean} [params.verbose] - Verbose mode. Display data output for each processor in executed pipeline
  268.  * @param {Object} params.body - Simulate definition
  269.  *
  270.  * @param {Object} options - Options for {@link Transport#request}
  271.  * @param {function} callback - Callback that handles errors and response
  272.  *
  273.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*}
  274.  */
  275. IngestApi.prototype.simulate = function ingestSimulateApi(params, options, callback) {
  276.   [params, options, callback] = normalizeArguments(params, options, callback);
  278.   // check required parameters
  279.   if (params.body == null) {
  280.     const err = new this[kConfigurationError]('Missing required parameter: body');
  281.     return handleError(err, callback);
  282.   }
  284.   let { method, body, id, ...querystring } = params;
  285.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  287.   let path = '';
  288.   if (id != null) {
  289.     if (method == null) method = body == null ? 'GET' : 'POST';
  290.     path = '/' + '_ingest' + '/' + 'pipeline' + '/' + encodeURIComponent(id) + '/' + '_simulate';
  291.   } else {
  292.     if (method == null) method = body == null ? 'GET' : 'POST';
  293.     path = '/' + '_ingest' + '/' + 'pipeline' + '/' + '_simulate';
  294.   }
  296.   // build request object
  297.   const request = {
  298.     method,
  299.     path,
  300.     body: body || '',
  301.     querystring,
  302.   };
  304.   return this.transport.request(request, options, callback);
  305. };
  307. Object.defineProperties(IngestApi.prototype, {
  308.   delete_pipeline: {
  309.     get() {
  310.       return this.deletePipeline;
  311.     },
  312.   },
  313.   geo_ip_stats: {
  314.     get() {
  315.       return this.geoIpStats;
  316.     },
  317.   },
  318.   get_pipeline: {
  319.     get() {
  320.       return this.getPipeline;
  321.     },
  322.   },
  323.   processor_grok: {
  324.     get() {
  325.       return this.processorGrok;
  326.     },
  327.   },
  328.   put_pipeline: {
  329.     get() {
  330.       return this.putPipeline;
  331.     },
  332.   },
  333. });
  335. module.exports = IngestApi;