Skip to content

Commit 607c283

Browse files
committed
[API] Adds indices.resolve_cluster endpoint
1 parent c70c02d commit 607c283

File tree

2 files changed

+115
-0
lines changed

2 files changed

+115
-0
lines changed
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Licensed to Elasticsearch B.V. under one or more contributor
2+
# license agreements. See the NOTICE file distributed with
3+
# this work for additional information regarding copyright
4+
# ownership. Elasticsearch B.V. licenses this file to you under
5+
# the Apache License, Version 2.0 (the "License"); you may
6+
# not use this file except in compliance with the License.
7+
# You may obtain a copy of the License at
8+
#
9+
# http://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing,
12+
# software distributed under the License is distributed on an
13+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
# KIND, either express or implied. See the License for the
15+
# specific language governing permissions and limitations
16+
# under the License.
17+
#
18+
# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
19+
# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
20+
#
21+
module Elasticsearch
22+
module API
23+
module Indices
24+
module Actions
25+
# Resolves the specified index expressions to return information about each cluster, including the local cluster, if included.
26+
#
27+
# @option arguments [List] :name A comma-separated list of cluster:index names or wildcard expressions
28+
# @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
29+
# @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled
30+
# @option arguments [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)
31+
# @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all)
32+
# @option arguments [Hash] :headers Custom HTTP headers
33+
#
34+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-resolve-cluster-api.html
35+
#
36+
def resolve_cluster(arguments = {})
37+
request_opts = { endpoint: arguments[:endpoint] || 'indices.resolve_cluster' }
38+
39+
defined_params = [:name].each_with_object({}) do |variable, set_variables|
40+
set_variables[variable] = arguments[variable] if arguments.key?(variable)
41+
end
42+
request_opts[:defined_params] = defined_params unless defined_params.empty?
43+
44+
raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
45+
46+
arguments = arguments.clone
47+
headers = arguments.delete(:headers) || {}
48+
49+
body = nil
50+
51+
_name = arguments.delete(:name)
52+
53+
method = Elasticsearch::API::HTTP_GET
54+
path = "_resolve/cluster/#{Utils.__listify(_name)}"
55+
params = Utils.process_params(arguments)
56+
57+
Elasticsearch::API::Response.new(
58+
perform_request(method, path, params, body, headers, request_opts)
59+
)
60+
end
61+
end
62+
end
63+
end
64+
end
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Licensed to Elasticsearch B.V. under one or more contributor
2+
# license agreements. See the NOTICE file distributed with
3+
# this work for additional information regarding copyright
4+
# ownership. Elasticsearch B.V. licenses this file to you under
5+
# the Apache License, Version 2.0 (the "License"); you may
6+
# not use this file except in compliance with the License.
7+
# You may obtain a copy of the License at
8+
#
9+
# http://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing,
12+
# software distributed under the License is distributed on an
13+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
# KIND, either express or implied. See the License for the
15+
# specific language governing permissions and limitations
16+
# under the License.
17+
18+
require 'spec_helper'
19+
20+
describe 'client.indices#delete_alias' do
21+
22+
let(:expected_args) do
23+
[
24+
'GET',
25+
'_resolve/cluster/foo',
26+
{},
27+
nil,
28+
{},
29+
{ defined_params: { name: 'foo'}, endpoint: 'indices.resolve_cluster' }
30+
]
31+
end
32+
33+
context 'when there is no name specified' do
34+
let(:client) do
35+
Class.new { include Elasticsearch::API }.new
36+
end
37+
38+
it 'raises an exception' do
39+
expect {
40+
client.indices.resolve_cluster
41+
}.to raise_exception(ArgumentError)
42+
end
43+
end
44+
45+
46+
context 'when name is specified' do
47+
it 'performs the request' do
48+
expect(client_double.indices.resolve_cluster(name: 'foo')).to be_a Elasticsearch::API::Response
49+
end
50+
end
51+
end

0 commit comments

Comments
 (0)