Module: OpenSearch::API::Cluster::Actions
- Included in:
- ClusterClient
- Defined in:
- lib/opensearch/api/namespace/cluster.rb,
lib/opensearch/api/actions/cluster/state.rb,
lib/opensearch/api/actions/cluster/stats.rb,
lib/opensearch/api/actions/cluster/health.rb,
lib/opensearch/api/actions/cluster/reroute.rb,
lib/opensearch/api/actions/cluster/remote_info.rb,
lib/opensearch/api/actions/cluster/get_settings.rb,
lib/opensearch/api/actions/cluster/put_settings.rb,
lib/opensearch/api/actions/cluster/pending_tasks.rb,
lib/opensearch/api/actions/cluster/params_registry.rb,
lib/opensearch/api/actions/cluster/allocation_explain.rb,
lib/opensearch/api/actions/cluster/get_component_template.rb,
lib/opensearch/api/actions/cluster/put_component_template.rb,
lib/opensearch/api/actions/cluster/delete_component_template.rb,
lib/opensearch/api/actions/cluster/exists_component_template.rb,
lib/opensearch/api/actions/cluster/post_voting_config_exclusions.rb,
lib/opensearch/api/actions/cluster/delete_voting_config_exclusions.rb
Defined Under Namespace
Modules: ParamsRegistry
Instance Method Summary collapse
-
#allocation_explain(arguments = {}) ⇒ Object
Provides explanations for shard allocations in the cluster.
-
#delete_component_template(arguments = {}) ⇒ Object
Deletes a component template.
-
#delete_voting_config_exclusions(arguments = {}) ⇒ Object
Clears cluster voting config exclusions.
-
#exists_component_template(arguments = {}) ⇒ Object
(also: #exists_component_template?)
Returns information about whether a particular component template exist.
-
#get_component_template(arguments = {}) ⇒ Object
Returns one or more component templates.
-
#get_settings(arguments = {}) ⇒ Object
Returns cluster settings.
-
#health(arguments = {}) ⇒ Object
Returns basic information about the health of the cluster.
-
#pending_tasks(arguments = {}) ⇒ Object
Returns a list of any cluster-level changes (e.g. create index, update mapping, allocate or fail shard) which have not yet been executed.
-
#post_voting_config_exclusions(arguments = {}) ⇒ Object
Updates the cluster voting config exclusions by node ids or node names.
-
#put_component_template(arguments = {}) ⇒ Object
Creates or updates a component template.
-
#put_settings(arguments = {}) ⇒ Object
Updates the cluster settings.
-
#remote_info(arguments = {}) ⇒ Object
Returns the information about configured remote clusters.
-
#reroute(arguments = {}) ⇒ Object
Allows to manually change the allocation of individual shards in the cluster.
-
#state(arguments = {}) ⇒ Object
Returns a comprehensive information about the state of the cluster.
-
#stats(arguments = {}) ⇒ Object
Returns high-level overview of cluster statistics.
Instance Method Details
#allocation_explain(arguments = {}) ⇒ Object
Provides explanations for shard allocations in the cluster.
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 |
# File 'lib/opensearch/api/actions/cluster/allocation_explain.rb', line 39 def allocation_explain(arguments = {}) headers = arguments.delete(:headers) || {} arguments = arguments.clone method = if arguments[:body] OpenSearch::API::HTTP_POST else OpenSearch::API::HTTP_GET end path = '_cluster/allocation/explain' params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__) body = arguments[:body] perform_request(method, path, params, body, headers).body end |
#delete_component_template(arguments = {}) ⇒ Object
Deletes a component template
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 |
# File 'lib/opensearch/api/actions/cluster/delete_component_template.rb', line 40 def delete_component_template(arguments = {}) raise ArgumentError, "Required argument 'name' missing" unless arguments[:name] headers = arguments.delete(:headers) || {} arguments = arguments.clone _name = arguments.delete(:name) method = OpenSearch::API::HTTP_DELETE path = "_component_template/#{Utils.__listify(_name)}" params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__) body = nil perform_request(method, path, params, body, headers).body end |
#delete_voting_config_exclusions(arguments = {}) ⇒ Object
Clears cluster voting config exclusions.
37 38 39 40 41 42 43 44 45 46 47 48 |
# File 'lib/opensearch/api/actions/cluster/delete_voting_config_exclusions.rb', line 37 def delete_voting_config_exclusions(arguments = {}) headers = arguments.delete(:headers) || {} arguments = arguments.clone method = OpenSearch::API::HTTP_DELETE path = '_cluster/voting_config_exclusions' params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__) body = nil perform_request(method, path, params, body, headers).body end |
#exists_component_template(arguments = {}) ⇒ Object Also known as: exists_component_template?
Returns information about whether a particular component template exist
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 |
# File 'lib/opensearch/api/actions/cluster/exists_component_template.rb', line 40 def exists_component_template(arguments = {}) raise ArgumentError, "Required argument 'name' missing" unless arguments[:name] headers = arguments.delete(:headers) || {} arguments = arguments.clone _name = arguments.delete(:name) method = OpenSearch::API::HTTP_HEAD path = "_component_template/#{Utils.__listify(_name)}" params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__) body = nil perform_request(method, path, params, body, headers).body end |
#get_component_template(arguments = {}) ⇒ Object
Returns one or more component templates
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 |
# File 'lib/opensearch/api/actions/cluster/get_component_template.rb', line 40 def get_component_template(arguments = {}) headers = arguments.delete(:headers) || {} arguments = arguments.clone _name = arguments.delete(:name) method = OpenSearch::API::HTTP_GET path = if _name "_component_template/#{Utils.__listify(_name)}" else '_component_template' end params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__) body = nil perform_request(method, path, params, body, headers).body end |
#get_settings(arguments = {}) ⇒ Object
Returns cluster settings.
41 42 43 44 45 46 47 48 49 50 51 52 |
# File 'lib/opensearch/api/actions/cluster/get_settings.rb', line 41 def get_settings(arguments = {}) headers = arguments.delete(:headers) || {} arguments = arguments.clone method = OpenSearch::API::HTTP_GET path = '_cluster/settings' params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__) body = nil perform_request(method, path, params, body, headers).body end |
#health(arguments = {}) ⇒ Object
Returns basic information about the health of the cluster.
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 |
# File 'lib/opensearch/api/actions/cluster/health.rb', line 49 def health(arguments = {}) headers = arguments.delete(:headers) || {} arguments = arguments.clone _index = arguments.delete(:index) method = OpenSearch::API::HTTP_GET path = if _index "_cluster/health/#{Utils.__listify(_index)}" else '_cluster/health' end params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__) body = nil perform_request(method, path, params, body, headers).body end |
#pending_tasks(arguments = {}) ⇒ Object
Returns a list of any cluster-level changes (e.g. create index, update mapping, allocate or fail shard) which have not yet been executed.
40 41 42 43 44 45 46 47 48 49 50 51 |
# File 'lib/opensearch/api/actions/cluster/pending_tasks.rb', line 40 def pending_tasks(arguments = {}) headers = arguments.delete(:headers) || {} arguments = arguments.clone method = OpenSearch::API::HTTP_GET path = '_cluster/pending_tasks' params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__) body = nil perform_request(method, path, params, body, headers).body end |
#post_voting_config_exclusions(arguments = {}) ⇒ Object
Updates the cluster voting config exclusions by node ids or node names.
39 40 41 42 43 44 45 46 47 48 49 50 |
# File 'lib/opensearch/api/actions/cluster/post_voting_config_exclusions.rb', line 39 def post_voting_config_exclusions(arguments = {}) headers = arguments.delete(:headers) || {} arguments = arguments.clone method = OpenSearch::API::HTTP_POST path = '_cluster/voting_config_exclusions' params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__) body = nil perform_request(method, path, params, body, headers).body end |
#put_component_template(arguments = {}) ⇒ Object
Creates or updates a component template
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
# File 'lib/opensearch/api/actions/cluster/put_component_template.rb', line 42 def put_component_template(arguments = {}) raise ArgumentError, "Required argument 'body' missing" unless arguments[:body] raise ArgumentError, "Required argument 'name' missing" unless arguments[:name] headers = arguments.delete(:headers) || {} arguments = arguments.clone _name = arguments.delete(:name) method = OpenSearch::API::HTTP_PUT path = "_component_template/#{Utils.__listify(_name)}" params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__) body = arguments[:body] perform_request(method, path, params, body, headers).body end |
#put_settings(arguments = {}) ⇒ Object
Updates the cluster settings.
41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
# File 'lib/opensearch/api/actions/cluster/put_settings.rb', line 41 def put_settings(arguments = {}) raise ArgumentError, "Required argument 'body' missing" unless arguments[:body] headers = arguments.delete(:headers) || {} arguments = arguments.clone method = OpenSearch::API::HTTP_PUT path = '_cluster/settings' params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__) body = arguments[:body] || {} perform_request(method, path, params, body, headers).body end |
#remote_info(arguments = {}) ⇒ Object
Returns the information about configured remote clusters.
36 37 38 39 40 41 42 43 44 45 46 47 |
# File 'lib/opensearch/api/actions/cluster/remote_info.rb', line 36 def remote_info(arguments = {}) headers = arguments.delete(:headers) || {} arguments = arguments.clone method = OpenSearch::API::HTTP_GET path = '_remote/info' params = {} body = nil perform_request(method, path, params, body, headers).body end |
#reroute(arguments = {}) ⇒ Object
Allows to manually change the allocation of individual shards in the cluster.
44 45 46 47 48 49 50 51 52 53 54 55 |
# File 'lib/opensearch/api/actions/cluster/reroute.rb', line 44 def reroute(arguments = {}) headers = arguments.delete(:headers) || {} arguments = arguments.clone method = OpenSearch::API::HTTP_POST path = '_cluster/reroute' params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__) body = arguments[:body] || {} perform_request(method, path, params, body, headers).body end |
#state(arguments = {}) ⇒ Object
Returns a comprehensive information about the state of the cluster.
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 |
# File 'lib/opensearch/api/actions/cluster/state.rb', line 47 def state(arguments = {}) headers = arguments.delete(:headers) || {} arguments = arguments.clone _metric = arguments.delete(:metric) _index = arguments.delete(:index) method = OpenSearch::API::HTTP_GET path = if _metric && _index "_cluster/state/#{Utils.__listify(_metric)}/#{Utils.__listify(_index)}" elsif _metric "_cluster/state/#{Utils.__listify(_metric)}" else '_cluster/state' end params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__) body = nil perform_request(method, path, params, body, headers).body end |
#stats(arguments = {}) ⇒ Object
Returns high-level overview of cluster statistics.
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
# File 'lib/opensearch/api/actions/cluster/stats.rb', line 39 def stats(arguments = {}) headers = arguments.delete(:headers) || {} arguments = arguments.clone _node_id = arguments.delete(:node_id) method = OpenSearch::API::HTTP_GET path = if _node_id "_cluster/stats/nodes/#{Utils.__listify(_node_id)}" else '_cluster/stats' end params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__) body = nil perform_request(method, path, params, body, headers).body end |