From 7cbdd8b711577e48880b5ab8e66199a2e88f1b8c Mon Sep 17 00:00:00 2001 From: Fernando Briano Date: Thu, 30 Jan 2025 12:53:35 +0000 Subject: [PATCH] [API] Adds esql.async_query_stop --- .../api/actions/esql/async_query_stop.rb | 60 +++++++++++++++++++ .../api/actions/esql/async_query_stop_spec.rb | 35 +++++++++++ 2 files changed, 95 insertions(+) create mode 100644 elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_stop.rb create mode 100644 elasticsearch-api/spec/elasticsearch/api/actions/esql/async_query_stop_spec.rb diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_stop.rb b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_stop.rb new file mode 100644 index 000000000..c2d8c4b8f --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_stop.rb @@ -0,0 +1,60 @@ +# 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. +# +# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 +# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec +# +module Elasticsearch + module API + module Esql + module Actions + # Stops a previously submitted async query request given its ID and collects the results. + # + # @option arguments [String] :id The async query ID + # @option arguments [Hash] :headers Custom HTTP headers + # + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/esql-async-query-stop-api.html + # + def async_query_stop(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'esql.async_query_stop' } + + defined_params = [:id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'id' missing" unless arguments[:id] + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = nil + + _id = arguments.delete(:id) + + method = Elasticsearch::API::HTTP_POST + path = "_query/async/#{Utils.__listify(_id)}/stop" + params = {} + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/esql/async_query_stop_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/esql/async_query_stop_spec.rb new file mode 100644 index 000000000..48f61e409 --- /dev/null +++ b/elasticsearch-api/spec/elasticsearch/api/actions/esql/async_query_stop_spec.rb @@ -0,0 +1,35 @@ +# 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. + +require 'spec_helper' + +describe 'client.esql#async_query_stop' do + let(:expected_args) do + [ + 'POST', + '_query/async/foo/stop', + {}, + nil, + {}, + { endpoint: 'esql.async_query_stop', defined_params: { id: 'foo' } } + ] + end + + it 'performs the request' do + expect(client_double.esql.async_query_stop(id: 'foo')).to be_a Elasticsearch::API::Response + end +end