Module: Antbird::RestApi::RestApiOpensearchV2_13

Defined in:
lib/antbird/rest_api/rest_api_opensearch_v2_13.rb

Instance Method Summary collapse

Instance Method Details

#bulk(params = {}) ⇒ Object

bulk href="https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html">www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html”, “description”=>“Allows to perform multiple index/update/delete operations in a single request.”



13
14
15
16
17
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 13

def bulk(params = {})
  api_name = 'bulk'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html", "description"=>"Allows to perform multiple index/update/delete operations in a single request."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_bulk", "methods"=>["POST", "PUT"]}, {"path"=>"/{index}/_bulk", "methods"=>["POST", "PUT"], "parts"=>{"index"=>{"type"=>"string", "description"=>"Default index for items which don't provide one"}}}]}, "params"=>{"wait_for_active_shards"=>{"type"=>"string", "description"=>"Sets the number of shard copies that must be active before proceeding with the bulk operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)"}, "refresh"=>{"type"=>"enum", "options"=>["true", "false", "wait_for"], "description"=>"If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes."}, "routing"=>{"type"=>"string", "description"=>"Specific routing value"}, "timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}, "type"=>{"type"=>"string", "description"=>"Default document type for items which don't provide one"}, "_source"=>{"type"=>"list", "description"=>"True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request"}, "_source_excludes"=>{"type"=>"list", "description"=>"Default list of fields to exclude from the returned _source field, can be overridden on each sub-request"}, "_source_includes"=>{"type"=>"list", "description"=>"Default list of fields to extract and return from the _source field, can be overridden on each sub-request"}, "pipeline"=>{"type"=>"string", "description"=>"The pipeline id to preprocess incoming documents with"}, "require_alias"=>{"type"=>"boolean", "description"=>"Sets require_alias for all incoming documents. Defaults to unset (false)"}}, "body"=>{"description"=>"The operation definition and data (action-data pairs), separated by newlines", "required"=>true, "serialize"=>"bulk"}}
  request(api_name, api_spec, params)
end

#cat_aliases(params = {}) ⇒ Object

cat.aliases href="https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-alias.html">www.elastic.co/guide/en/elasticsearch/reference/master/cat-alias.html”, “description”=>“Shows information about currently configured aliases to indices including filter and routing infos.”



21
22
23
24
25
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 21

def cat_aliases(params = {})
  api_name = 'cat.aliases'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-alias.html", "description"=>"Shows information about currently configured aliases to indices including filter and routing infos."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_cat/aliases", "methods"=>["GET"]}, {"path"=>"/_cat/aliases/{name}", "methods"=>["GET"], "parts"=>{"name"=>{"type"=>"list", "description"=>"A comma-separated list of alias names to return"}}}]}, "params"=>{"format"=>{"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "local"=>{"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, "h"=>{"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help"=>{"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "s"=>{"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "v"=>{"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}, "expand_wildcards"=>{"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"all", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}}}
  request(api_name, api_spec, params)
end

#cat_allocation(params = {}) ⇒ Object

cat.allocation href="https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.html">www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.html”, “description”=>“Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.”



29
30
31
32
33
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 29

def cat_allocation(params = {})
  api_name = 'cat.allocation'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.html", "description"=>"Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_cat/allocation", "methods"=>["GET"]}, {"path"=>"/_cat/allocation/{node_id}", "methods"=>["GET"], "parts"=>{"node_id"=>{"type"=>"list", "description"=>"A comma-separated list of node IDs or names to limit the returned information"}}}]}, "params"=>{"format"=>{"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "bytes"=>{"type"=>"enum", "description"=>"The unit in which to display byte values", "options"=>["b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb"]}, "local"=>{"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, "master_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to master node", "deprecated"=>{"version"=>"2.0.0", "description"=>"To promote inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to cluster-manager node"}, "h"=>{"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help"=>{"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "s"=>{"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "v"=>{"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}}}
  request(api_name, api_spec, params)
end

#cat_cluster_manager(params = {}) ⇒ Object

cat.cluster_manager href="https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-master">opensearch.org/docs/latest/opensearch/rest-api/cat/cat-master/”, “description”=>“Returns information about the cluster-manager node.”



37
38
39
40
41
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 37

def cat_cluster_manager(params = {})
  api_name = 'cat.cluster_manager'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-master/", "description"=>"Returns information about the cluster-manager node."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_cat/cluster_manager", "methods"=>["GET"]}, {"path"=>"/_cat/master", "methods"=>["GET"], "deprecated"=>{"version"=>"2.0.0", "description"=>"To promote inclusive language, please use '/_cat/cluster_manager' instead."}}]}, "params"=>{"format"=>{"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "local"=>{"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from cluster-manager node (default: false)"}, "master_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to master node", "deprecated"=>{"version"=>"2.0.0", "description"=>"To promote inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to cluster-manager node"}, "h"=>{"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help"=>{"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "s"=>{"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "v"=>{"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}}}
  request(api_name, api_spec, params)
end

#cat_count(params = {}) ⇒ Object

cat.count href="https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html">www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html”, “description”=>“Provides quick access to the document count of the entire cluster, or individual indices.”



45
46
47
48
49
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 45

def cat_count(params = {})
  api_name = 'cat.count'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html", "description"=>"Provides quick access to the document count of the entire cluster, or individual indices."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_cat/count", "methods"=>["GET"]}, {"path"=>"/_cat/count/{index}", "methods"=>["GET"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names to limit the returned information"}}}]}, "params"=>{"format"=>{"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "h"=>{"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help"=>{"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "s"=>{"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "v"=>{"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}}}
  request(api_name, api_spec, params)
end

#cat_fielddata(params = {}) ⇒ Object

cat.fielddata href="https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html">www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html”, “description”=>“Shows how much heap memory is currently being used by fielddata on every data node in the cluster.”



53
54
55
56
57
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 53

def cat_fielddata(params = {})
  api_name = 'cat.fielddata'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html", "description"=>"Shows how much heap memory is currently being used by fielddata on every data node in the cluster."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_cat/fielddata", "methods"=>["GET"]}, {"path"=>"/_cat/fielddata/{fields}", "methods"=>["GET"], "parts"=>{"fields"=>{"type"=>"list", "description"=>"A comma-separated list of fields to return the fielddata size"}}}]}, "params"=>{"format"=>{"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "bytes"=>{"type"=>"enum", "description"=>"The unit in which to display byte values", "options"=>["b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb"]}, "h"=>{"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help"=>{"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "s"=>{"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "v"=>{"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}, "fields"=>{"type"=>"list", "description"=>"A comma-separated list of fields to return in the output"}}}
  request(api_name, api_spec, params)
end

#cat_health(params = {}) ⇒ Object

cat.health href="https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-health.html">www.elastic.co/guide/en/elasticsearch/reference/master/cat-health.html”, “description”=>“Returns a concise representation of the cluster health.”



61
62
63
64
65
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 61

def cat_health(params = {})
  api_name = 'cat.health'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-health.html", "description"=>"Returns a concise representation of the cluster health."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_cat/health", "methods"=>["GET"]}]}, "params"=>{"format"=>{"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "h"=>{"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help"=>{"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "s"=>{"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "time"=>{"type"=>"enum", "description"=>"The unit in which to display time values", "options"=>["d", "h", "m", "s", "ms", "micros", "nanos"]}, "ts"=>{"type"=>"boolean", "description"=>"Set to false to disable timestamping", "default"=>true}, "v"=>{"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}}}
  request(api_name, api_spec, params)
end

#cat_help(params = {}) ⇒ Object

cat.help href="https://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html">www.elastic.co/guide/en/elasticsearch/reference/master/cat.html”, “description”=>“Returns help for the Cat APIs.”



69
70
71
72
73
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 69

def cat_help(params = {})
  api_name = 'cat.help'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html", "description"=>"Returns help for the Cat APIs."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_cat", "methods"=>["GET"]}]}, "params"=>{"help"=>{"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "s"=>{"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}}}
  request(api_name, api_spec, params)
end

#cat_indices(params = {}) ⇒ Object

cat.indices href="https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html">www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html”, “description”=>“Returns information about indices: number of primaries and replicas, document counts, disk size, …”



77
78
79
80
81
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 77

def cat_indices(params = {})
  api_name = 'cat.indices'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html", "description"=>"Returns information about indices: number of primaries and replicas, document counts, disk size, ..."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_cat/indices", "methods"=>["GET"]}, {"path"=>"/_cat/indices/{index}", "methods"=>["GET"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names to limit the returned information"}}}]}, "params"=>{"format"=>{"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "bytes"=>{"type"=>"enum", "description"=>"The unit in which to display byte values", "options"=>["b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb"]}, "local"=>{"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, "master_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to master node", "deprecated"=>{"version"=>"2.0.0", "description"=>"To promote inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to cluster-manager node"}, "h"=>{"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "health"=>{"type"=>"enum", "options"=>["green", "yellow", "red"], "description"=>"A health status (\"green\", \"yellow\", or \"red\" to filter only indices matching the specified health status"}, "help"=>{"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "pri"=>{"type"=>"boolean", "description"=>"Set to true to return stats only for primary shards", "default"=>false}, "s"=>{"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "time"=>{"type"=>"enum", "description"=>"The unit in which to display time values", "options"=>["d", "h", "m", "s", "ms", "micros", "nanos"]}, "v"=>{"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}, "include_unloaded_segments"=>{"type"=>"boolean", "description"=>"If set to true segment stats will include stats for segments that are not currently loaded into memory", "default"=>false}, "expand_wildcards"=>{"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"all", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}}}
  request(api_name, api_spec, params)
end

#cat_nodeattrs(params = {}) ⇒ Object

cat.nodeattrs href="https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodeattrs.html">www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodeattrs.html”, “description”=>“Returns information about custom node attributes.”



85
86
87
88
89
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 85

def cat_nodeattrs(params = {})
  api_name = 'cat.nodeattrs'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodeattrs.html", "description"=>"Returns information about custom node attributes."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_cat/nodeattrs", "methods"=>["GET"]}]}, "params"=>{"format"=>{"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "local"=>{"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, "master_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to master node", "deprecated"=>{"version"=>"2.0.0", "description"=>"To promote inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to cluster-manager node"}, "h"=>{"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help"=>{"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "s"=>{"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "v"=>{"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}}}
  request(api_name, api_spec, params)
end

#cat_nodes(params = {}) ⇒ Object

cat.nodes href="https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html">www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html”, “description”=>“Returns basic statistics about performance of cluster nodes.”



93
94
95
96
97
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 93

def cat_nodes(params = {})
  api_name = 'cat.nodes'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html", "description"=>"Returns basic statistics about performance of cluster nodes."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_cat/nodes", "methods"=>["GET"]}]}, "params"=>{"bytes"=>{"type"=>"enum", "description"=>"The unit in which to display byte values", "options"=>["b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb"]}, "format"=>{"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "full_id"=>{"type"=>"boolean", "description"=>"Return the full node ID instead of the shortened version (default: false)"}, "local"=>{"type"=>"boolean", "description"=>"Calculate the selected nodes using the local cluster state rather than the state from master node (default: false)", "deprecated"=>{"version"=>"7.6.0", "description"=>"This parameter does not cause this API to act locally."}}, "master_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to master node", "deprecated"=>{"version"=>"2.0.0", "description"=>"To promote inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to cluster-manager node"}, "h"=>{"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help"=>{"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "s"=>{"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "time"=>{"type"=>"enum", "description"=>"The unit in which to display time values", "options"=>["d", "h", "m", "s", "ms", "micros", "nanos"]}, "v"=>{"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}}}
  request(api_name, api_spec, params)
end

#cat_pending_tasks(params = {}) ⇒ Object

cat.pending_tasks href="https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-pending-tasks.html">www.elastic.co/guide/en/elasticsearch/reference/master/cat-pending-tasks.html”, “description”=>“Returns a concise representation of the cluster pending tasks.”



101
102
103
104
105
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 101

def cat_pending_tasks(params = {})
  api_name = 'cat.pending_tasks'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-pending-tasks.html", "description"=>"Returns a concise representation of the cluster pending tasks."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_cat/pending_tasks", "methods"=>["GET"]}]}, "params"=>{"format"=>{"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "local"=>{"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, "master_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to master node", "deprecated"=>{"version"=>"2.0.0", "description"=>"To promote inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to cluster-manager node"}, "h"=>{"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help"=>{"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "s"=>{"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "time"=>{"type"=>"enum", "description"=>"The unit in which to display time values", "options"=>["d", "h", "m", "s", "ms", "micros", "nanos"]}, "v"=>{"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}}}
  request(api_name, api_spec, params)
end

#cat_plugins(params = {}) ⇒ Object

cat.plugins href="https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html">www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html”, “description”=>“Returns information about installed plugins across nodes node.”



109
110
111
112
113
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 109

def cat_plugins(params = {})
  api_name = 'cat.plugins'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html", "description"=>"Returns information about installed plugins across nodes node."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_cat/plugins", "methods"=>["GET"]}]}, "params"=>{"format"=>{"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "local"=>{"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, "master_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to master node", "deprecated"=>{"version"=>"2.0.0", "description"=>"To promote inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to cluster-manager node"}, "h"=>{"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help"=>{"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "s"=>{"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "v"=>{"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}}}
  request(api_name, api_spec, params)
end

#cat_recovery(params = {}) ⇒ Object

cat.recovery href="https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html">www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html”, “description”=>“Returns information about index shard recoveries, both on-going completed.”



117
118
119
120
121
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 117

def cat_recovery(params = {})
  api_name = 'cat.recovery'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html", "description"=>"Returns information about index shard recoveries, both on-going completed."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_cat/recovery", "methods"=>["GET"]}, {"path"=>"/_cat/recovery/{index}", "methods"=>["GET"], "parts"=>{"index"=>{"type"=>"list", "description"=>"Comma-separated list or wildcard expression of index names to limit the returned information"}}}]}, "params"=>{"format"=>{"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "active_only"=>{"type"=>"boolean", "description"=>"If `true`, the response only includes ongoing shard recoveries", "default"=>false}, "bytes"=>{"type"=>"enum", "description"=>"The unit in which to display byte values", "options"=>["b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb"]}, "detailed"=>{"type"=>"boolean", "description"=>"If `true`, the response includes detailed information about shard recoveries", "default"=>false}, "h"=>{"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help"=>{"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "index"=>{"type"=>"list", "description"=>"Comma-separated list or wildcard expression of index names to limit the returned information"}, "s"=>{"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "time"=>{"type"=>"enum", "description"=>"The unit in which to display time values", "options"=>["d", "h", "m", "s", "ms", "micros", "nanos"]}, "v"=>{"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}}}
  request(api_name, api_spec, params)
end

#cat_repositories(params = {}) ⇒ Object

cat.repositories href="https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-repositories.html">www.elastic.co/guide/en/elasticsearch/reference/master/cat-repositories.html”, “description”=>“Returns information about snapshot repositories registered in the cluster.”



125
126
127
128
129
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 125

def cat_repositories(params = {})
  api_name = 'cat.repositories'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-repositories.html", "description"=>"Returns information about snapshot repositories registered in the cluster."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_cat/repositories", "methods"=>["GET"]}]}, "params"=>{"format"=>{"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "local"=>{"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node", "default"=>false}, "master_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to master node", "deprecated"=>{"version"=>"2.0.0", "description"=>"To promote inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to cluster-manager node"}, "h"=>{"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help"=>{"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "s"=>{"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "v"=>{"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}}}
  request(api_name, api_spec, params)
end

#cat_segment_replication(params = {}) ⇒ Object

cat.segment_replication href="https://github.com/opensearch-project/documentation-website/issues/2627">github.com/opensearch-project/documentation-website/issues/2627”, “description”=>“Returns information about both on-going and latest completed Segment Replication events”



133
134
135
136
137
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 133

def cat_segment_replication(params = {})
  api_name = 'cat.segment_replication'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://github.com/opensearch-project/documentation-website/issues/2627", "description"=>"Returns information about both on-going and latest completed Segment Replication events"}, "stability"=>"experimental", "url"=>{"paths"=>[{"path"=>"/_cat/segment_replication", "methods"=>["GET"]}, {"path"=>"/_cat/segment_replication/{index}", "methods"=>["GET"], "parts"=>{"index"=>{"type"=>"list", "description"=>"Comma-separated list or wildcard expression of index names to limit the returned information"}}}]}, "params"=>{"format"=>{"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "active_only"=>{"type"=>"boolean", "description"=>"If `true`, the response only includes ongoing segment replication events", "default"=>false}, "bytes"=>{"type"=>"enum", "description"=>"The unit in which to display byte values", "options"=>["b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb"]}, "detailed"=>{"type"=>"boolean", "description"=>"If `true`, the response includes detailed information about segment replications", "default"=>false}, "shards"=>{"type"=>"list", "description"=>"Comma-separated list of shards to display"}, "h"=>{"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help"=>{"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "index"=>{"type"=>"list", "description"=>"Comma-separated list or wildcard expression of index names to limit the returned information"}, "s"=>{"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "time"=>{"type"=>"enum", "description"=>"The unit in which to display time values", "options"=>["d", "h", "m", "s", "ms", "micros", "nanos"]}, "v"=>{"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}}}
  request(api_name, api_spec, params)
end

#cat_segments(params = {}) ⇒ Object

cat.segments href="https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html">www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html”, “description”=>“Provides low-level information about the segments in the shards of an index.”



141
142
143
144
145
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 141

def cat_segments(params = {})
  api_name = 'cat.segments'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html", "description"=>"Provides low-level information about the segments in the shards of an index."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_cat/segments", "methods"=>["GET"]}, {"path"=>"/_cat/segments/{index}", "methods"=>["GET"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names to limit the returned information"}}}]}, "params"=>{"format"=>{"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "bytes"=>{"type"=>"enum", "description"=>"The unit in which to display byte values", "options"=>["b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb"]}, "master_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to master node", "deprecated"=>{"version"=>"2.0.0", "description"=>"To promote inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to cluster-manager node"}, "h"=>{"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help"=>{"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "s"=>{"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "v"=>{"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}}}
  request(api_name, api_spec, params)
end

#cat_shards(params = {}) ⇒ Object

cat.shards href="https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html">www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html”, “description”=>“Provides a detailed view of shard allocation on nodes.”



149
150
151
152
153
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 149

def cat_shards(params = {})
  api_name = 'cat.shards'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html", "description"=>"Provides a detailed view of shard allocation on nodes."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_cat/shards", "methods"=>["GET"]}, {"path"=>"/_cat/shards/{index}", "methods"=>["GET"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names to limit the returned information"}}}]}, "params"=>{"format"=>{"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "bytes"=>{"type"=>"enum", "description"=>"The unit in which to display byte values", "options"=>["b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb"]}, "local"=>{"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, "master_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to master node", "deprecated"=>{"version"=>"2.0.0", "description"=>"To promote inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to cluster-manager node"}, "h"=>{"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help"=>{"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "s"=>{"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "time"=>{"type"=>"enum", "description"=>"The unit in which to display time values", "options"=>["d", "h", "m", "s", "ms", "micros", "nanos"]}, "v"=>{"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}}}
  request(api_name, api_spec, params)
end

#cat_snapshots(params = {}) ⇒ Object

cat.snapshots href="https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-snapshots.html">www.elastic.co/guide/en/elasticsearch/reference/master/cat-snapshots.html”, “description”=>“Returns all snapshots in a specific repository.”



157
158
159
160
161
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 157

def cat_snapshots(params = {})
  api_name = 'cat.snapshots'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-snapshots.html", "description"=>"Returns all snapshots in a specific repository."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_cat/snapshots", "methods"=>["GET"]}, {"path"=>"/_cat/snapshots/{repository}", "methods"=>["GET"], "parts"=>{"repository"=>{"type"=>"list", "description"=>"Name of repository from which to fetch the snapshot information"}}}]}, "params"=>{"format"=>{"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "ignore_unavailable"=>{"type"=>"boolean", "description"=>"Set to true to ignore unavailable snapshots", "default"=>false}, "master_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to master node", "deprecated"=>{"version"=>"2.0.0", "description"=>"To promote inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to cluster-manager node"}, "h"=>{"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help"=>{"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "s"=>{"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "time"=>{"type"=>"enum", "description"=>"The unit in which to display time values", "options"=>["d", "h", "m", "s", "ms", "micros", "nanos"]}, "v"=>{"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}}}
  request(api_name, api_spec, params)
end

#cat_tasks(params = {}) ⇒ Object

cat.tasks href="https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html">www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html”, “description”=>“Returns information about the tasks currently executing on one or more nodes in the cluster.”



165
166
167
168
169
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 165

def cat_tasks(params = {})
  api_name = 'cat.tasks'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html", "description"=>"Returns information about the tasks currently executing on one or more nodes in the cluster."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_cat/tasks", "methods"=>["GET"]}]}, "params"=>{"format"=>{"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "nodes"=>{"type"=>"list", "description"=>"A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes"}, "actions"=>{"type"=>"list", "description"=>"A comma-separated list of actions that should be returned. Leave empty to return all."}, "detailed"=>{"type"=>"boolean", "description"=>"Return detailed task information (default: false)"}, "parent_task_id"=>{"type"=>"string", "description"=>"Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all."}, "h"=>{"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help"=>{"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "s"=>{"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "time"=>{"type"=>"enum", "description"=>"The unit in which to display time values", "options"=>["d", "h", "m", "s", "ms", "micros", "nanos"]}, "v"=>{"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}}}
  request(api_name, api_spec, params)
end

#cat_templates(params = {}) ⇒ Object

cat.templates href="https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-templates.html">www.elastic.co/guide/en/elasticsearch/reference/master/cat-templates.html”, “description”=>“Returns information about existing templates.”



173
174
175
176
177
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 173

def cat_templates(params = {})
  api_name = 'cat.templates'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-templates.html", "description"=>"Returns information about existing templates."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_cat/templates", "methods"=>["GET"]}, {"path"=>"/_cat/templates/{name}", "methods"=>["GET"], "parts"=>{"name"=>{"type"=>"string", "description"=>"A pattern that returned template names must match"}}}]}, "params"=>{"format"=>{"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "local"=>{"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, "master_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to master node", "deprecated"=>{"version"=>"2.0.0", "description"=>"To promote inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to cluster-manager node"}, "h"=>{"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help"=>{"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "s"=>{"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "v"=>{"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}}}
  request(api_name, api_spec, params)
end

#cat_thread_pool(params = {}) ⇒ Object

cat.thread_pool href="https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.html">www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.html”, “description”=>“Returns cluster-wide thread pool statistics per node.nBy default the active, queue and rejected statistics are returned for all thread pools.”



181
182
183
184
185
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 181

def cat_thread_pool(params = {})
  api_name = 'cat.thread_pool'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.html", "description"=>"Returns cluster-wide thread pool statistics per node.\nBy default the active, queue and rejected statistics are returned for all thread pools."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_cat/thread_pool", "methods"=>["GET"]}, {"path"=>"/_cat/thread_pool/{thread_pool_patterns}", "methods"=>["GET"], "parts"=>{"thread_pool_patterns"=>{"type"=>"list", "description"=>"A comma-separated list of regular-expressions to filter the thread pools in the output"}}}]}, "params"=>{"format"=>{"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "size"=>{"type"=>"enum", "description"=>"The multiplier in which to display values", "options"=>["", "k", "m", "g", "t", "p"], "deprecated"=>{"version"=>"7.7.0", "description"=>"Setting this value has no effect and will be removed from the specification."}}, "local"=>{"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, "master_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to master node", "deprecated"=>{"version"=>"2.0.0", "description"=>"To promote inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to cluster-manager node"}, "h"=>{"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help"=>{"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "s"=>{"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "v"=>{"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}}}
  request(api_name, api_spec, params)
end

#clear_scroll(params = {}) ⇒ Object

clear_scroll href="https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-scroll-api.html">www.elastic.co/guide/en/elasticsearch/reference/current/clear-scroll-api.html”, “description”=>“Explicitly clears the search context for a scroll.”



189
190
191
192
193
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 189

def clear_scroll(params = {})
  api_name = 'clear_scroll'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-scroll-api.html", "description"=>"Explicitly clears the search context for a scroll."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_search/scroll", "methods"=>["DELETE"]}, {"path"=>"/_search/scroll/{scroll_id}", "methods"=>["DELETE"], "parts"=>{"scroll_id"=>{"type"=>"list", "description"=>"A comma-separated list of scroll IDs to clear", "deprecated"=>true}}, "deprecated"=>{"version"=>"7.0.0", "description"=>"A scroll id can be quite large and should be specified as part of the body"}}]}, "params"=>{}, "body"=>{"description"=>"A comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter"}}
  request(api_name, api_spec, params)
end

#cluster_allocation_explain(params = {}) ⇒ Object

cluster.allocation_explain href="https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-allocation-explain.html">www.elastic.co/guide/en/elasticsearch/reference/master/cluster-allocation-explain.html”, “description”=>“Provides explanations for shard allocations in the cluster.”



197
198
199
200
201
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 197

def cluster_allocation_explain(params = {})
  api_name = 'cluster.allocation_explain'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-allocation-explain.html", "description"=>"Provides explanations for shard allocations in the cluster."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_cluster/allocation/explain", "methods"=>["GET", "POST"]}]}, "params"=>{"include_yes_decisions"=>{"type"=>"boolean", "description"=>"Return 'YES' decisions in explanation (default: false)"}, "include_disk_info"=>{"type"=>"boolean", "description"=>"Return information about disk usage and shard sizes (default: false)"}}, "body"=>{"description"=>"The index, shard, and primary flag to explain. Empty means 'explain the first unassigned shard'"}}
  request(api_name, api_spec, params)
end

#cluster_delete_component_template(params = {}) ⇒ Object

cluster.delete_component_template href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html”, “description”=>“Deletes a component template”



205
206
207
208
209
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 205

def cluster_delete_component_template(params = {})
  api_name = 'cluster.delete_component_template'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html", "description"=>"Deletes a component template"}, "stability"=>"experimental", "url"=>{"paths"=>[{"path"=>"/_component_template/{name}", "methods"=>["DELETE"], "parts"=>{"name"=>{"type"=>"string", "description"=>"The name of the template"}}}]}, "params"=>{"timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}, "master_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to master node", "deprecated"=>{"version"=>"2.0.0", "description"=>"To support inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to cluster-manager node"}}}
  request(api_name, api_spec, params)
end

#cluster_delete_decommission_awareness(params = {}) ⇒ Object

cluster.delete_decommission_awareness href="https://opensearch.org/docs/latest/opensearch/rest-api/decommission">opensearch.org/docs/latest/opensearch/rest-api/decommission/”, “description”=>“Delete any existing decommission.”



213
214
215
216
217
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 213

def cluster_delete_decommission_awareness(params = {})
  api_name = 'cluster.delete_decommission_awareness'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://opensearch.org/docs/latest/opensearch/rest-api/decommission/", "description"=>"Delete any existing decommission."}, "stability"=>"experimental", "url"=>{"paths"=>[{"path"=>"/_cluster/decommission/awareness/", "methods"=>["DELETE"]}]}}
  request(api_name, api_spec, params)
end

#cluster_delete_voting_config_exclusions(params = {}) ⇒ Object

cluster.delete_voting_config_exclusions href="https://www.elastic.co/guide/en/elasticsearch/reference/master/voting-config-exclusions.html">www.elastic.co/guide/en/elasticsearch/reference/master/voting-config-exclusions.html”, “description”=>“Clears cluster voting config exclusions.”



221
222
223
224
225
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 221

def cluster_delete_voting_config_exclusions(params = {})
  api_name = 'cluster.delete_voting_config_exclusions'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/voting-config-exclusions.html", "description"=>"Clears cluster voting config exclusions."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_cluster/voting_config_exclusions", "methods"=>["DELETE"]}]}, "params"=>{"wait_for_removal"=>{"type"=>"boolean", "description"=>"Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting configuration exclusions list.", "default"=>true}}}
  request(api_name, api_spec, params)
end

#cluster_delete_weighted_routing(params = {}) ⇒ Object

cluster.delete_weighted_routing href="https://opensearch.org/docs/latest/opensearch/rest-api/weighted-routing/delete">opensearch.org/docs/latest/opensearch/rest-api/weighted-routing/delete”, “description”=>“Delete weighted shard routing weights”



229
230
231
232
233
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 229

def cluster_delete_weighted_routing(params = {})
  api_name = 'cluster.delete_weighted_routing'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://opensearch.org/docs/latest/opensearch/rest-api/weighted-routing/delete", "description"=>"Delete weighted shard routing weights"}, "stability"=>"experimental", "url"=>{"paths"=>[{"path"=>"/_cluster/routing/awareness/weights", "methods"=>["DELETE"]}]}}
  request(api_name, api_spec, params)
end

#cluster_exists_component_template(params = {}) ⇒ Object Also known as: cluster_exists_component_template?

cluster.exists_component_template href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html”, “description”=>“Returns information about whether a particular component template exist”



237
238
239
240
241
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 237

def cluster_exists_component_template(params = {})
  api_name = 'cluster.exists_component_template'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html", "description"=>"Returns information about whether a particular component template exist"}, "stability"=>"experimental", "url"=>{"paths"=>[{"path"=>"/_component_template/{name}", "methods"=>["HEAD"], "parts"=>{"name"=>{"type"=>"string", "description"=>"The name of the template"}}}]}, "params"=>{"master_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, "local"=>{"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}}}
  request(api_name, api_spec, params)
end

#cluster_get_component_template(params = {}) ⇒ Object

cluster.get_component_template href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html”, “description”=>“Returns one or more component templates”



246
247
248
249
250
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 246

def cluster_get_component_template(params = {})
  api_name = 'cluster.get_component_template'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html", "description"=>"Returns one or more component templates"}, "stability"=>"experimental", "url"=>{"paths"=>[{"path"=>"/_component_template", "methods"=>["GET"]}, {"path"=>"/_component_template/{name}", "methods"=>["GET"], "parts"=>{"name"=>{"type"=>"list", "description"=>"The comma separated names of the component templates"}}}]}, "params"=>{"master_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to master node", "deprecated"=>{"version"=>"2.0.0", "description"=>"To support inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to cluster-manager node"}, "local"=>{"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}}}
  request(api_name, api_spec, params)
end

#cluster_get_decommission_awareness(params = {}) ⇒ Object

cluster.get_decommission_awareness href="https://opensearch.org/docs/latest/opensearch/rest-api/decommission">opensearch.org/docs/latest/opensearch/rest-api/decommission/”, “description”=>“Get details and status of decommissioned attribute”



254
255
256
257
258
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 254

def cluster_get_decommission_awareness(params = {})
  api_name = 'cluster.get_decommission_awareness'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://opensearch.org/docs/latest/opensearch/rest-api/decommission/", "description"=>"Get details and status of decommissioned attribute"}, "stability"=>"experimental", "url"=>{"paths"=>[{"path"=>"/_cluster/decommission/awareness/{awareness_attribute_name}/_status", "methods"=>["GET"], "parts"=>{"awareness_attribute_name"=>{"type"=>"string", "description"=>"Awareness attribute name"}}}]}}
  request(api_name, api_spec, params)
end

#cluster_get_settings(params = {}) ⇒ Object

cluster.get_settings href="https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html">www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html”, “description”=>“Returns cluster settings.”



262
263
264
265
266
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 262

def cluster_get_settings(params = {})
  api_name = 'cluster.get_settings'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html", "description"=>"Returns cluster settings."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_cluster/settings", "methods"=>["GET"]}]}, "params"=>{"flat_settings"=>{"type"=>"boolean", "description"=>"Return settings in flat format (default: false)"}, "master_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to master node", "deprecated"=>{"version"=>"2.0.0", "description"=>"To promote inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to cluster-manager node"}, "timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}, "include_defaults"=>{"type"=>"boolean", "description"=>"Whether to return all default clusters setting.", "default"=>false}}}
  request(api_name, api_spec, params)
end

#cluster_get_weighted_routing(params = {}) ⇒ Object

cluster.get_weighted_routing href="https://opensearch.org/docs/latest/opensearch/rest-api/weighted-routing/get">opensearch.org/docs/latest/opensearch/rest-api/weighted-routing/get”, “description”=>“Fetches weighted shard routing weights”



270
271
272
273
274
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 270

def cluster_get_weighted_routing(params = {})
  api_name = 'cluster.get_weighted_routing'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://opensearch.org/docs/latest/opensearch/rest-api/weighted-routing/get", "description"=>"Fetches weighted shard routing weights"}, "stability"=>"experimental", "url"=>{"paths"=>[{"path"=>"/_cluster/routing/awareness/{attribute}/weights", "methods"=>["GET"], "parts"=>{"attribute"=>{"type"=>"string", "description"=>"Awareness attribute name"}}}]}}
  request(api_name, api_spec, params)
end

#cluster_health(params = {}) ⇒ Object

cluster.health href="https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-health.html">www.elastic.co/guide/en/elasticsearch/reference/master/cluster-health.html”, “description”=>“Returns basic information about the health of the cluster.”



278
279
280
281
282
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 278

def cluster_health(params = {})
  api_name = 'cluster.health'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-health.html", "description"=>"Returns basic information about the health of the cluster."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_cluster/health", "methods"=>["GET"]}, {"path"=>"/_cluster/health/{index}", "methods"=>["GET"], "parts"=>{"index"=>{"type"=>"list", "description"=>"Limit the information returned to a specific index"}}}]}, "params"=>{"expand_wildcards"=>{"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"all", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "level"=>{"type"=>"enum", "options"=>["cluster", "indices", "shards", "awareness_attributes"], "default"=>"cluster", "description"=>"Specify the level of detail for returned information"}, "local"=>{"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, "master_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to master node", "deprecated"=>{"version"=>"2.0.0", "description"=>"To promote inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to cluster-manager node"}, "timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}, "wait_for_active_shards"=>{"type"=>"string", "description"=>"Wait until the specified number of shards is active"}, "wait_for_nodes"=>{"type"=>"string", "description"=>"Wait until the specified number of nodes is available"}, "wait_for_events"=>{"type"=>"enum", "options"=>["immediate", "urgent", "high", "normal", "low", "languid"], "description"=>"Wait until all currently queued events with the given priority are processed"}, "wait_for_no_relocating_shards"=>{"type"=>"boolean", "description"=>"Whether to wait until there are no relocating shards in the cluster"}, "wait_for_no_initializing_shards"=>{"type"=>"boolean", "description"=>"Whether to wait until there are no initializing shards in the cluster"}, "wait_for_status"=>{"type"=>"enum", "options"=>["green", "yellow", "red"], "description"=>"Wait until cluster is in a specific state"}, "awareness_attribute"=>{"type"=>"string", "description"=>"The awareness attribute for which the health is required"}, "ensure_node_weighed_in"=>{"type"=>"boolean", "description"=>"Ensures whether the local node is commissioned and weighed in or not. (default: false)"}}}
  request(api_name, api_spec, params)
end

#cluster_pending_tasks(params = {}) ⇒ Object

cluster.pending_tasks href="https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-pending.html">www.elastic.co/guide/en/elasticsearch/reference/master/cluster-pending.html”, “description”=>“Returns a list of any cluster-level changes (e.g. create index, update mapping,nallocate or fail shard) which have not yet been executed.”



286
287
288
289
290
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 286

def cluster_pending_tasks(params = {})
  api_name = 'cluster.pending_tasks'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-pending.html", "description"=>"Returns a list of any cluster-level changes (e.g. create index, update mapping,\nallocate or fail shard) which have not yet been executed."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_cluster/pending_tasks", "methods"=>["GET"]}]}, "params"=>{"local"=>{"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, "master_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to master", "deprecated"=>{"version"=>"2.0.0", "description"=>"To promote inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to cluster-manager node"}}}
  request(api_name, api_spec, params)
end

#cluster_post_voting_config_exclusions(params = {}) ⇒ Object

cluster.post_voting_config_exclusions href="https://www.elastic.co/guide/en/elasticsearch/reference/master/voting-config-exclusions.html">www.elastic.co/guide/en/elasticsearch/reference/master/voting-config-exclusions.html”, “description”=>“Updates the cluster voting config exclusions by node ids or node names.”



294
295
296
297
298
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 294

def cluster_post_voting_config_exclusions(params = {})
  api_name = 'cluster.post_voting_config_exclusions'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/voting-config-exclusions.html", "description"=>"Updates the cluster voting config exclusions by node ids or node names."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_cluster/voting_config_exclusions", "methods"=>["POST"]}]}, "params"=>{"node_ids"=>{"type"=>"string", "description"=>"A comma-separated list of the persistent ids of the nodes to exclude from the voting configuration. If specified, you may not also specify ?node_names."}, "node_names"=>{"type"=>"string", "description"=>"A comma-separated list of the names of the nodes to exclude from the voting configuration. If specified, you may not also specify ?node_ids."}, "timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout", "default"=>"30s"}}}
  request(api_name, api_spec, params)
end

#cluster_put_component_template(params = {}) ⇒ Object

cluster.put_component_template href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html”, “description”=>“Creates or updates a component template”



302
303
304
305
306
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 302

def cluster_put_component_template(params = {})
  api_name = 'cluster.put_component_template'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html", "description"=>"Creates or updates a component template"}, "stability"=>"experimental", "url"=>{"paths"=>[{"path"=>"/_component_template/{name}", "methods"=>["PUT", "POST"], "parts"=>{"name"=>{"type"=>"string", "description"=>"The name of the template"}}}]}, "params"=>{"create"=>{"type"=>"boolean", "description"=>"Whether the index template should only be added if new or can also replace an existing one", "default"=>false}, "timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}, "master_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to master node", "deprecated"=>{"version"=>"2.0.0", "description"=>"To support inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to cluster-manager node"}}, "body"=>{"description"=>"The template definition", "required"=>true}}
  request(api_name, api_spec, params)
end

#cluster_put_decommission_awareness(params = {}) ⇒ Object

cluster.put_decommission_awareness href="https://opensearch.org/docs/latest/opensearch/rest-api/decommission">opensearch.org/docs/latest/opensearch/rest-api/decommission/”, “description”=>“Decommissions an awareness attribute”



310
311
312
313
314
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 310

def cluster_put_decommission_awareness(params = {})
  api_name = 'cluster.put_decommission_awareness'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://opensearch.org/docs/latest/opensearch/rest-api/decommission/", "description"=>"Decommissions an awareness attribute"}, "stability"=>"experimental", "url"=>{"paths"=>[{"path"=>"/_cluster/decommission/awareness/{awareness_attribute_name}/{awareness_attribute_value}", "methods"=>["PUT"], "parts"=>{"awareness_attribute_name"=>{"type"=>"string", "description"=>"Awareness attribute name"}, "awareness_attribute_value"=>{"type"=>"string", "description"=>"Awareness attribute value"}}}]}}
  request(api_name, api_spec, params)
end

#cluster_put_settings(params = {}) ⇒ Object

cluster.put_settings href="https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html">www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html”, “description”=>“Updates the cluster settings.”



318
319
320
321
322
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 318

def cluster_put_settings(params = {})
  api_name = 'cluster.put_settings'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html", "description"=>"Updates the cluster settings."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_cluster/settings", "methods"=>["PUT"]}]}, "params"=>{"flat_settings"=>{"type"=>"boolean", "description"=>"Return settings in flat format (default: false)"}, "master_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to master node", "deprecated"=>{"version"=>"2.0.0", "description"=>"To promote inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to cluster-manager node"}, "timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}}, "body"=>{"description"=>"The settings to be updated. Can be either `transient` or `persistent` (survives cluster restart).", "required"=>true}}
  request(api_name, api_spec, params)
end

#cluster_put_weighted_routing(params = {}) ⇒ Object

cluster.put_weighted_routing href="https://opensearch.org/docs/latest/opensearch/rest-api/weighted-routing/put">opensearch.org/docs/latest/opensearch/rest-api/weighted-routing/put”, “description”=>“Updates weighted shard routing weights”



326
327
328
329
330
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 326

def cluster_put_weighted_routing(params = {})
  api_name = 'cluster.put_weighted_routing'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://opensearch.org/docs/latest/opensearch/rest-api/weighted-routing/put", "description"=>"Updates weighted shard routing weights"}, "stability"=>"experimental", "url"=>{"paths"=>[{"path"=>"/_cluster/routing/awareness/{attribute}/weights", "methods"=>["PUT"], "parts"=>{"attribute"=>{"type"=>"string", "description"=>"Awareness attribute name"}}}]}}
  request(api_name, api_spec, params)
end

#cluster_remote_info(params = {}) ⇒ Object

cluster.remote_info href="https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-remote-info.html">www.elastic.co/guide/en/elasticsearch/reference/master/cluster-remote-info.html”, “description”=>“Returns the information about configured remote clusters.”



334
335
336
337
338
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 334

def cluster_remote_info(params = {})
  api_name = 'cluster.remote_info'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-remote-info.html", "description"=>"Returns the information about configured remote clusters."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_remote/info", "methods"=>["GET"]}]}, "params"=>{}}
  request(api_name, api_spec, params)
end

#cluster_reroute(params = {}) ⇒ Object

cluster.reroute href="https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-reroute.html">www.elastic.co/guide/en/elasticsearch/reference/master/cluster-reroute.html”, “description”=>“Allows to manually change the allocation of individual shards in the cluster.”



342
343
344
345
346
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 342

def cluster_reroute(params = {})
  api_name = 'cluster.reroute'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-reroute.html", "description"=>"Allows to manually change the allocation of individual shards in the cluster."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_cluster/reroute", "methods"=>["POST"]}]}, "params"=>{"dry_run"=>{"type"=>"boolean", "description"=>"Simulate the operation only and return the resulting state"}, "explain"=>{"type"=>"boolean", "description"=>"Return an explanation of why the commands can or cannot be executed"}, "retry_failed"=>{"type"=>"boolean", "description"=>"Retries allocation of shards that are blocked due to too many subsequent allocation failures"}, "metric"=>{"type"=>"list", "options"=>["_all", "blocks", "metadata", "nodes", "routing_table", "master_node", "cluster_manager_node", "version"], "description"=>"Limit the information returned to the specified metrics. Defaults to all but metadata"}, "master_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to master node", "deprecated"=>{"version"=>"2.0.0", "description"=>"To promote inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to cluster-manager node"}, "timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}}, "body"=>{"description"=>"The definition of `commands` to perform (`move`, `cancel`, `allocate`)"}}
  request(api_name, api_spec, params)
end

#cluster_state(params = {}) ⇒ Object

cluster.state href="https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-state.html">www.elastic.co/guide/en/elasticsearch/reference/master/cluster-state.html”, “description”=>“Returns a comprehensive information about the state of the cluster.”



350
351
352
353
354
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 350

def cluster_state(params = {})
  api_name = 'cluster.state'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-state.html", "description"=>"Returns a comprehensive information about the state of the cluster."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_cluster/state", "methods"=>["GET"]}, {"path"=>"/_cluster/state/{metric}", "methods"=>["GET"], "parts"=>{"metric"=>{"type"=>"list", "options"=>["_all", "blocks", "metadata", "nodes", "routing_table", "routing_nodes", "master_node", "version"], "description"=>"Limit the information returned to the specified metrics"}}}, {"path"=>"/_cluster/state/{metric}/{index}", "methods"=>["GET"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"}, "metric"=>{"type"=>"list", "options"=>["_all", "blocks", "metadata", "nodes", "routing_table", "routing_nodes", "master_node", "cluster_manager_node", "version"], "description"=>"Limit the information returned to the specified metrics"}}}]}, "params"=>{"local"=>{"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, "master_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to master", "deprecated"=>{"version"=>"2.0.0", "description"=>"To promote inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to cluster-manager node"}, "flat_settings"=>{"type"=>"boolean", "description"=>"Return settings in flat format (default: false)"}, "wait_for_metadata_version"=>{"type"=>"number", "description"=>"Wait for the metadata version to be equal or greater than the specified metadata version"}, "wait_for_timeout"=>{"type"=>"time", "description"=>"The maximum time to wait for wait_for_metadata_version before timing out"}, "ignore_unavailable"=>{"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices"=>{"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards"=>{"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}}}
  request(api_name, api_spec, params)
end

#cluster_stats(params = {}) ⇒ Object

cluster.stats href="https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-stats.html">www.elastic.co/guide/en/elasticsearch/reference/master/cluster-stats.html”, “description”=>“Returns high-level overview of cluster statistics.”



358
359
360
361
362
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 358

def cluster_stats(params = {})
  api_name = 'cluster.stats'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-stats.html", "description"=>"Returns high-level overview of cluster statistics."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_cluster/stats", "methods"=>["GET"]}, {"path"=>"/_cluster/stats/nodes/{node_id}", "methods"=>["GET"], "parts"=>{"node_id"=>{"type"=>"list", "description"=>"A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes"}}}]}, "params"=>{"flat_settings"=>{"type"=>"boolean", "description"=>"Return settings in flat format (default: false)"}, "timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}}}
  request(api_name, api_spec, params)
end

#common_params ⇒ Object 



7
8
9
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 7

def common_params
  @common_params ||= {"documentation"=>{"description"=>"Parameters that are accepted by all API endpoints.", "url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html"}, "params"=>{"pretty"=>{"type"=>"boolean", "description"=>"Pretty format the returned JSON response.", "default"=>false}, "human"=>{"type"=>"boolean", "description"=>"Return human readable values for statistics.", "default"=>true}, "error_trace"=>{"type"=>"boolean", "description"=>"Include the stack trace of returned errors.", "default"=>false}, "source"=>{"type"=>"string", "description"=>"The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests."}, "filter_path"=>{"type"=>"list", "description"=>"A comma-separated list of filters used to reduce the response."}}}
end

#count(params = {}) ⇒ Object

count href="https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html">www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html”, “description”=>“Returns number of documents matching a query.”



366
367
368
369
370
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 366

def count(params = {})
  api_name = 'count'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html", "description"=>"Returns number of documents matching a query."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_count", "methods"=>["POST", "GET"]}, {"path"=>"/{index}/_count", "methods"=>["POST", "GET"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of indices to restrict the results"}}}]}, "params"=>{"ignore_unavailable"=>{"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "ignore_throttled"=>{"type"=>"boolean", "description"=>"Whether specified concrete, expanded or aliased indices should be ignored when throttled"}, "allow_no_indices"=>{"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards"=>{"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "min_score"=>{"type"=>"number", "description"=>"Include only documents with a specific `_score` value in the result"}, "preference"=>{"type"=>"string", "description"=>"Specify the node or shard the operation should be performed on (default: random)"}, "routing"=>{"type"=>"list", "description"=>"A comma-separated list of specific routing values"}, "q"=>{"type"=>"string", "description"=>"Query in the Lucene query string syntax"}, "analyzer"=>{"type"=>"string", "description"=>"The analyzer to use for the query string"}, "analyze_wildcard"=>{"type"=>"boolean", "description"=>"Specify whether wildcard and prefix queries should be analyzed (default: false)"}, "default_operator"=>{"type"=>"enum", "options"=>["AND", "OR"], "default"=>"OR", "description"=>"The default operator for query string query (AND or OR)"}, "df"=>{"type"=>"string", "description"=>"The field to use as default where no field prefix is given in the query string"}, "lenient"=>{"type"=>"boolean", "description"=>"Specify whether format-based query failures (such as providing text to a numeric field) should be ignored"}, "terminate_after"=>{"type"=>"number", "description"=>"The maximum count for each shard, upon reaching which the query execution will terminate early"}}, "body"=>{"description"=>"A query to restrict the results specified with the Query DSL (optional)"}}
  request(api_name, api_spec, params)
end

#create(params = {}) ⇒ Object

create href="https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html">www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html”, “description”=>“Creates a new document in the index.nnReturns a 409 response when a document with a same ID already exists in the index.”



374
375
376
377
378
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 374

def create(params = {})
  api_name = 'create'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html", "description"=>"Creates a new document in the index.\n\nReturns a 409 response when a document with a same ID already exists in the index."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/{index}/_create/{id}", "methods"=>["PUT", "POST"], "parts"=>{"id"=>{"type"=>"string", "description"=>"Document ID"}, "index"=>{"type"=>"string", "description"=>"The name of the index"}}}]}, "params"=>{"wait_for_active_shards"=>{"type"=>"string", "description"=>"Sets the number of shard copies that must be active before proceeding with the index operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)"}, "refresh"=>{"type"=>"enum", "options"=>["true", "false", "wait_for"], "description"=>"If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes."}, "routing"=>{"type"=>"string", "description"=>"Specific routing value"}, "timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}, "version"=>{"type"=>"number", "description"=>"Explicit version number for concurrency control"}, "version_type"=>{"type"=>"enum", "options"=>["internal", "external", "external_gte"], "description"=>"Specific version type"}, "pipeline"=>{"type"=>"string", "description"=>"The pipeline id to preprocess incoming documents with"}}, "body"=>{"description"=>"The document", "required"=>true}}
  request(api_name, api_spec, params)
end

#create_pit(params = {}) ⇒ Object

create_pit href="https://opensearch.org/docs/latest/opensearch/rest-api/point_in_time">opensearch.org/docs/latest/opensearch/rest-api/point_in_time/”, “description”=>“Creates point in time context.”



382
383
384
385
386
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 382

def create_pit(params = {})
  api_name = 'create_pit'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://opensearch.org/docs/latest/opensearch/rest-api/point_in_time/", "description"=>"Creates point in time context."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/{index}/_search/point_in_time", "methods"=>["POST"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices"}}}]}, "params"=>{"allow_partial_pit_creation"=>{"type"=>"boolean", "description"=>"Allow if point in time can be created with partial failures"}, "keep_alive"=>{"type"=>"string", "description"=>"Specify the keep alive for point in time"}, "preference"=>{"type"=>"string", "description"=>"Specify the node or shard the operation should be performed on (default: random)"}, "routing"=>{"type"=>"list", "description"=>"A comma-separated list of specific routing values"}}}
  request(api_name, api_spec, params)
end

#dangling_indices_delete_dangling_index(params = {}) ⇒ Object

dangling_indices.delete_dangling_index href="https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html">www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html”, “description”=>“Deletes the specified dangling index”



390
391
392
393
394
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 390

def dangling_indices_delete_dangling_index(params = {})
  api_name = 'dangling_indices.delete_dangling_index'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html", "description"=>"Deletes the specified dangling index"}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_dangling/{index_uuid}", "methods"=>["DELETE"], "parts"=>{"index_uuid"=>{"type"=>"string", "description"=>"The UUID of the dangling index"}}}]}, "params"=>{"accept_data_loss"=>{"type"=>"boolean", "description"=>"Must be set to true in order to delete the dangling index"}, "timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}, "master_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to master", "deprecated"=>{"version"=>"2.0.0", "description"=>"To promote inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to cluster-manager node"}}}
  request(api_name, api_spec, params)
end

#dangling_indices_import_dangling_index(params = {}) ⇒ Object

dangling_indices.import_dangling_index href="https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html">www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html”, “description”=>“Imports the specified dangling index”



398
399
400
401
402
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 398

def dangling_indices_import_dangling_index(params = {})
  api_name = 'dangling_indices.import_dangling_index'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html", "description"=>"Imports the specified dangling index"}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_dangling/{index_uuid}", "methods"=>["POST"], "parts"=>{"index_uuid"=>{"type"=>"string", "description"=>"The UUID of the dangling index"}}}]}, "params"=>{"accept_data_loss"=>{"type"=>"boolean", "description"=>"Must be set to true in order to import the dangling index"}, "timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}, "master_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to master", "deprecated"=>{"version"=>"2.0.0", "description"=>"To promote inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to cluster-manager node"}}}
  request(api_name, api_spec, params)
end

#dangling_indices_list_dangling_indices(params = {}) ⇒ Object

dangling_indices.list_dangling_indices href="https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html">www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html”, “description”=>“Returns all dangling indices.”



406
407
408
409
410
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 406

def dangling_indices_list_dangling_indices(params = {})
  api_name = 'dangling_indices.list_dangling_indices'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html", "description"=>"Returns all dangling indices."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_dangling", "methods"=>["GET"]}]}, "params"=>{}}
  request(api_name, api_spec, params)
end

#delete(params = {}) ⇒ Object

delete href="https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html">www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html”, “description”=>“Removes a document from the index.”



414
415
416
417
418
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 414

def delete(params = {})
  api_name = 'delete'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html", "description"=>"Removes a document from the index."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/{index}/_doc/{id}", "methods"=>["DELETE"], "parts"=>{"id"=>{"type"=>"string", "description"=>"The document ID"}, "index"=>{"type"=>"string", "description"=>"The name of the index"}}}]}, "params"=>{"wait_for_active_shards"=>{"type"=>"string", "description"=>"Sets the number of shard copies that must be active before proceeding with the delete operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)"}, "refresh"=>{"type"=>"enum", "options"=>["true", "false", "wait_for"], "description"=>"If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes."}, "routing"=>{"type"=>"string", "description"=>"Specific routing value"}, "timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}, "if_seq_no"=>{"type"=>"number", "description"=>"only perform the delete operation if the last operation that has changed the document has the specified sequence number"}, "if_primary_term"=>{"type"=>"number", "description"=>"only perform the delete operation if the last operation that has changed the document has the specified primary term"}, "version"=>{"type"=>"number", "description"=>"Explicit version number for concurrency control"}, "version_type"=>{"type"=>"enum", "options"=>["internal", "external", "external_gte", "force"], "description"=>"Specific version type"}}}
  request(api_name, api_spec, params)
end

#delete_all_pits(params = {}) ⇒ Object

delete_all_pits href="https://opensearch.org/docs/latest/opensearch/rest-api/point_in_time">opensearch.org/docs/latest/opensearch/rest-api/point_in_time/”, “description”=>“Deletes all active point in time searches.”



422
423
424
425
426
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 422

def delete_all_pits(params = {})
  api_name = 'delete_all_pits'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://opensearch.org/docs/latest/opensearch/rest-api/point_in_time/", "description"=>"Deletes all active point in time searches."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_search/point_in_time/_all", "methods"=>["DELETE"]}]}}
  request(api_name, api_spec, params)
end

#delete_by_query(params = {}) ⇒ Object

delete_by_query href="https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html">www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html”, “description”=>“Deletes documents matching the provided query.”



430
431
432
433
434
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 430

def delete_by_query(params = {})
  api_name = 'delete_by_query'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html", "description"=>"Deletes documents matching the provided query."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/{index}/_delete_by_query", "methods"=>["POST"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices"}}}]}, "params"=>{"analyzer"=>{"type"=>"string", "description"=>"The analyzer to use for the query string"}, "analyze_wildcard"=>{"type"=>"boolean", "description"=>"Specify whether wildcard and prefix queries should be analyzed (default: false)"}, "default_operator"=>{"type"=>"enum", "options"=>["AND", "OR"], "default"=>"OR", "description"=>"The default operator for query string query (AND or OR)"}, "df"=>{"type"=>"string", "description"=>"The field to use as default where no field prefix is given in the query string"}, "from"=>{"type"=>"number", "description"=>"Starting offset (default: 0)"}, "ignore_unavailable"=>{"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices"=>{"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "conflicts"=>{"type"=>"enum", "options"=>["abort", "proceed"], "default"=>"abort", "description"=>"What to do when the delete by query hits version conflicts?"}, "expand_wildcards"=>{"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "lenient"=>{"type"=>"boolean", "description"=>"Specify whether format-based query failures (such as providing text to a numeric field) should be ignored"}, "preference"=>{"type"=>"string", "description"=>"Specify the node or shard the operation should be performed on (default: random)"}, "q"=>{"type"=>"string", "description"=>"Query in the Lucene query string syntax"}, "routing"=>{"type"=>"list", "description"=>"A comma-separated list of specific routing values"}, "scroll"=>{"type"=>"time", "description"=>"Specify how long a consistent view of the index should be maintained for scrolled search"}, "search_type"=>{"type"=>"enum", "options"=>["query_then_fetch", "dfs_query_then_fetch"], "description"=>"Search operation type"}, "search_timeout"=>{"type"=>"time", "description"=>"Explicit timeout for each search request. Defaults to no timeout."}, "size"=>{"type"=>"number", "description"=>"Deprecated, please use `max_docs` instead"}, "max_docs"=>{"type"=>"number", "description"=>"Maximum number of documents to process (default: all documents)"}, "sort"=>{"type"=>"list", "description"=>"A comma-separated list of <field>:<direction> pairs"}, "_source"=>{"type"=>"list", "description"=>"True or false to return the _source field or not, or a list of fields to return"}, "_source_excludes"=>{"type"=>"list", "description"=>"A list of fields to exclude from the returned _source field"}, "_source_includes"=>{"type"=>"list", "description"=>"A list of fields to extract and return from the _source field"}, "terminate_after"=>{"type"=>"number", "description"=>"The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early."}, "stats"=>{"type"=>"list", "description"=>"Specific 'tag' of the request for logging and statistical purposes"}, "version"=>{"type"=>"boolean", "description"=>"Specify whether to return document version as part of a hit"}, "request_cache"=>{"type"=>"boolean", "description"=>"Specify if request cache should be used for this request or not, defaults to index level setting"}, "refresh"=>{"type"=>"boolean", "description"=>"Should the effected indexes be refreshed?"}, "timeout"=>{"type"=>"time", "default"=>"1m", "description"=>"Time each individual bulk request should wait for shards that are unavailable."}, "wait_for_active_shards"=>{"type"=>"string", "description"=>"Sets the number of shard copies that must be active before proceeding with the delete by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)"}, "scroll_size"=>{"type"=>"number", "default"=>100, "description"=>"Size on the scroll request powering the delete by query"}, "wait_for_completion"=>{"type"=>"boolean", "default"=>true, "description"=>"Should the request should block until the delete by query is complete."}, "requests_per_second"=>{"type"=>"number", "default"=>0, "description"=>"The throttle for this request in sub-requests per second. -1 means no throttle."}, "slices"=>{"type"=>"number|string", "default"=>1, "description"=>"The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`."}}, "body"=>{"description"=>"The search definition using the Query DSL", "required"=>true}}
  request(api_name, api_spec, params)
end

#delete_by_query_rethrottle(params = {}) ⇒ Object

delete_by_query_rethrottle href="https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html">www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html”, “description”=>“Changes the number of requests per second for a particular Delete By Query operation.”



438
439
440
441
442
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 438

def delete_by_query_rethrottle(params = {})
  api_name = 'delete_by_query_rethrottle'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html", "description"=>"Changes the number of requests per second for a particular Delete By Query operation."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_delete_by_query/{task_id}/_rethrottle", "methods"=>["POST"], "parts"=>{"task_id"=>{"type"=>"string", "description"=>"The task id to rethrottle"}}}]}, "params"=>{"requests_per_second"=>{"type"=>"number", "required"=>true, "description"=>"The throttle to set on this request in floating sub-requests per second. -1 means set no throttle."}}}
  request(api_name, api_spec, params)
end

#delete_pit(params = {}) ⇒ Object

delete_pit href="https://opensearch.org/docs/latest/opensearch/rest-api/point_in_time">opensearch.org/docs/latest/opensearch/rest-api/point_in_time/”, “description”=>“Deletes one or more point in time searches based on the IDs passed.”



446
447
448
449
450
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 446

def delete_pit(params = {})
  api_name = 'delete_pit'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://opensearch.org/docs/latest/opensearch/rest-api/point_in_time/", "description"=>"Deletes one or more point in time searches based on the IDs passed."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_search/point_in_time", "methods"=>["DELETE"]}]}, "body"=>{"description"=>"A comma-separated list of pit IDs to clear", "required"=>true}}
  request(api_name, api_spec, params)
end

#delete_script(params = {}) ⇒ Object

delete_script href="https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html">www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html”, “description”=>“Deletes a script.”



454
455
456
457
458
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 454

def delete_script(params = {})
  api_name = 'delete_script'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", "description"=>"Deletes a script."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_scripts/{id}", "methods"=>["DELETE"], "parts"=>{"id"=>{"type"=>"string", "description"=>"Script ID"}}}]}, "params"=>{"timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}, "master_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to master", "deprecated"=>{"version"=>"2.0.0", "description"=>"To support inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to cluster-manager node"}}}
  request(api_name, api_spec, params)
end

#exists(params = {}) ⇒ Object Also known as: exists?

exists href="https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html">www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html”, “description”=>“Returns information about whether a document exists in an index.”



462
463
464
465
466
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 462

def exists(params = {})
  api_name = 'exists'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", "description"=>"Returns information about whether a document exists in an index."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/{index}/_doc/{id}", "methods"=>["HEAD"], "parts"=>{"id"=>{"type"=>"string", "description"=>"The document ID"}, "index"=>{"type"=>"string", "description"=>"The name of the index"}}}]}, "params"=>{"stored_fields"=>{"type"=>"list", "description"=>"A comma-separated list of stored fields to return in the response"}, "preference"=>{"type"=>"string", "description"=>"Specify the node or shard the operation should be performed on (default: random)"}, "realtime"=>{"type"=>"boolean", "description"=>"Specify whether to perform the operation in realtime or search mode"}, "refresh"=>{"type"=>"boolean", "description"=>"Refresh the shard containing the document before performing the operation"}, "routing"=>{"type"=>"string", "description"=>"Specific routing value"}, "_source"=>{"type"=>"list", "description"=>"True or false to return the _source field or not, or a list of fields to return"}, "_source_excludes"=>{"type"=>"list", "description"=>"A list of fields to exclude from the returned _source field"}, "_source_includes"=>{"type"=>"list", "description"=>"A list of fields to extract and return from the _source field"}, "version"=>{"type"=>"number", "description"=>"Explicit version number for concurrency control"}, "version_type"=>{"type"=>"enum", "options"=>["internal", "external", "external_gte", "force"], "description"=>"Specific version type"}}}
  request(api_name, api_spec, params)
end

#exists_source(params = {}) ⇒ Object Also known as: exists_source?

exists_source href="https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html">www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html”, “description”=>“Returns information about whether a document source exists in an index.”



471
472
473
474
475
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 471

def exists_source(params = {})
  api_name = 'exists_source'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", "description"=>"Returns information about whether a document source exists in an index."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/{index}/_source/{id}", "methods"=>["HEAD"], "parts"=>{"id"=>{"type"=>"string", "description"=>"The document ID"}, "index"=>{"type"=>"string", "description"=>"The name of the index"}}}]}, "params"=>{"preference"=>{"type"=>"string", "description"=>"Specify the node or shard the operation should be performed on (default: random)"}, "realtime"=>{"type"=>"boolean", "description"=>"Specify whether to perform the operation in realtime or search mode"}, "refresh"=>{"type"=>"boolean", "description"=>"Refresh the shard containing the document before performing the operation"}, "routing"=>{"type"=>"string", "description"=>"Specific routing value"}, "_source"=>{"type"=>"list", "description"=>"True or false to return the _source field or not, or a list of fields to return"}, "_source_excludes"=>{"type"=>"list", "description"=>"A list of fields to exclude from the returned _source field"}, "_source_includes"=>{"type"=>"list", "description"=>"A list of fields to extract and return from the _source field"}, "version"=>{"type"=>"number", "description"=>"Explicit version number for concurrency control"}, "version_type"=>{"type"=>"enum", "options"=>["internal", "external", "external_gte", "force"], "description"=>"Specific version type"}}}
  request(api_name, api_spec, params)
end

#explain(params = {}) ⇒ Object

explain href="https://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html">www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html”, “description”=>“Returns information about why a specific matches (or doesn’t match) a query.”



480
481
482
483
484
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 480

def explain(params = {})
  api_name = 'explain'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html", "description"=>"Returns information about why a specific matches (or doesn't match) a query."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/{index}/_explain/{id}", "methods"=>["GET", "POST"], "parts"=>{"id"=>{"type"=>"string", "description"=>"The document ID"}, "index"=>{"type"=>"string", "description"=>"The name of the index"}}}]}, "params"=>{"analyze_wildcard"=>{"type"=>"boolean", "description"=>"Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)"}, "analyzer"=>{"type"=>"string", "description"=>"The analyzer for the query string query"}, "default_operator"=>{"type"=>"enum", "options"=>["AND", "OR"], "default"=>"OR", "description"=>"The default operator for query string query (AND or OR)"}, "df"=>{"type"=>"string", "description"=>"The default field for query string query (default: _all)"}, "stored_fields"=>{"type"=>"list", "description"=>"A comma-separated list of stored fields to return in the response"}, "lenient"=>{"type"=>"boolean", "description"=>"Specify whether format-based query failures (such as providing text to a numeric field) should be ignored"}, "preference"=>{"type"=>"string", "description"=>"Specify the node or shard the operation should be performed on (default: random)"}, "q"=>{"type"=>"string", "description"=>"Query in the Lucene query string syntax"}, "routing"=>{"type"=>"string", "description"=>"Specific routing value"}, "_source"=>{"type"=>"list", "description"=>"True or false to return the _source field or not, or a list of fields to return"}, "_source_excludes"=>{"type"=>"list", "description"=>"A list of fields to exclude from the returned _source field"}, "_source_includes"=>{"type"=>"list", "description"=>"A list of fields to extract and return from the _source field"}}, "body"=>{"description"=>"The query definition using the Query DSL"}}
  request(api_name, api_spec, params)
end

#field_caps(params = {}) ⇒ Object

field_caps href="https://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html">www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html”, “description”=>“Returns the information about the capabilities of fields among multiple indices.”



488
489
490
491
492
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 488

def field_caps(params = {})
  api_name = 'field_caps'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html", "description"=>"Returns the information about the capabilities of fields among multiple indices."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_field_caps", "methods"=>["GET", "POST"]}, {"path"=>"/{index}/_field_caps", "methods"=>["GET", "POST"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"}}}]}, "params"=>{"fields"=>{"type"=>"list", "description"=>"A comma-separated list of field names"}, "ignore_unavailable"=>{"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices"=>{"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards"=>{"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "include_unmapped"=>{"type"=>"boolean", "default"=>false, "description"=>"Indicates whether unmapped fields should be included in the response."}}, "body"=>{"description"=>"An index filter specified with the Query DSL"}}
  request(api_name, api_spec, params)
end

#get(params = {}) ⇒ Object

get href="https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html">www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html”, “description”=>“Returns a document.”



496
497
498
499
500
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 496

def get(params = {})
  api_name = 'get'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", "description"=>"Returns a document."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/{index}/_doc/{id}", "methods"=>["GET"], "parts"=>{"id"=>{"type"=>"string", "description"=>"The document ID"}, "index"=>{"type"=>"string", "description"=>"The name of the index"}}}]}, "params"=>{"stored_fields"=>{"type"=>"list", "description"=>"A comma-separated list of stored fields to return in the response"}, "preference"=>{"type"=>"string", "description"=>"Specify the node or shard the operation should be performed on (default: random)"}, "realtime"=>{"type"=>"boolean", "description"=>"Specify whether to perform the operation in realtime or search mode"}, "refresh"=>{"type"=>"boolean", "description"=>"Refresh the shard containing the document before performing the operation"}, "routing"=>{"type"=>"string", "description"=>"Specific routing value"}, "_source"=>{"type"=>"list", "description"=>"True or false to return the _source field or not, or a list of fields to return"}, "_source_excludes"=>{"type"=>"list", "description"=>"A list of fields to exclude from the returned _source field"}, "_source_includes"=>{"type"=>"list", "description"=>"A list of fields to extract and return from the _source field"}, "version"=>{"type"=>"number", "description"=>"Explicit version number for concurrency control"}, "version_type"=>{"type"=>"enum", "options"=>["internal", "external", "external_gte", "force"], "description"=>"Specific version type"}}}
  request(api_name, api_spec, params)
end

#get_all_pits(params = {}) ⇒ Object

get_all_pits href="https://opensearch.org/docs/latest/opensearch/rest-api/point_in_time">opensearch.org/docs/latest/opensearch/rest-api/point_in_time/”, “description”=>“Lists all active point in time searches.”



504
505
506
507
508
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 504

def get_all_pits(params = {})
  api_name = 'get_all_pits'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://opensearch.org/docs/latest/opensearch/rest-api/point_in_time/", "description"=>"Lists all active point in time searches."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_search/point_in_time/_all", "methods"=>["GET"]}]}}
  request(api_name, api_spec, params)
end

#get_script(params = {}) ⇒ Object

get_script href="https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html">www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html”, “description”=>“Returns a script.”



512
513
514
515
516
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 512

def get_script(params = {})
  api_name = 'get_script'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", "description"=>"Returns a script."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_scripts/{id}", "methods"=>["GET"], "parts"=>{"id"=>{"type"=>"string", "description"=>"Script ID"}}}]}, "params"=>{"master_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to master", "deprecated"=>{"version"=>"2.0.0", "description"=>"To support inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to cluster-manager node"}}}
  request(api_name, api_spec, params)
end

#get_script_context(params = {}) ⇒ Object

get_script_context href="https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-contexts.html">www.elastic.co/guide/en/elasticsearch/painless/master/painless-contexts.html”, “description”=>“Returns all script contexts.”



520
521
522
523
524
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 520

def get_script_context(params = {})
  api_name = 'get_script_context'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-contexts.html", "description"=>"Returns all script contexts."}, "stability"=>"experimental", "url"=>{"paths"=>[{"path"=>"/_script_context", "methods"=>["GET"]}]}, "params"=>{}}
  request(api_name, api_spec, params)
end

#get_script_languages(params = {}) ⇒ Object

get_script_languages href="https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html">www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html”, “description”=>“Returns available script types, languages and contexts”



528
529
530
531
532
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 528

def get_script_languages(params = {})
  api_name = 'get_script_languages'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", "description"=>"Returns available script types, languages and contexts"}, "stability"=>"experimental", "url"=>{"paths"=>[{"path"=>"/_script_language", "methods"=>["GET"]}]}, "params"=>{}}
  request(api_name, api_spec, params)
end

#get_source(params = {}) ⇒ Object

get_source href="https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html">www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html”, “description”=>“Returns the source of a document.”



536
537
538
539
540
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 536

def get_source(params = {})
  api_name = 'get_source'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", "description"=>"Returns the source of a document."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/{index}/_source/{id}", "methods"=>["GET"], "parts"=>{"id"=>{"type"=>"string", "description"=>"The document ID"}, "index"=>{"type"=>"string", "description"=>"The name of the index"}}}]}, "params"=>{"preference"=>{"type"=>"string", "description"=>"Specify the node or shard the operation should be performed on (default: random)"}, "realtime"=>{"type"=>"boolean", "description"=>"Specify whether to perform the operation in realtime or search mode"}, "refresh"=>{"type"=>"boolean", "description"=>"Refresh the shard containing the document before performing the operation"}, "routing"=>{"type"=>"string", "description"=>"Specific routing value"}, "_source"=>{"type"=>"list", "description"=>"True or false to return the _source field or not, or a list of fields to return"}, "_source_excludes"=>{"type"=>"list", "description"=>"A list of fields to exclude from the returned _source field"}, "_source_includes"=>{"type"=>"list", "description"=>"A list of fields to extract and return from the _source field"}, "version"=>{"type"=>"number", "description"=>"Explicit version number for concurrency control"}, "version_type"=>{"type"=>"enum", "options"=>["internal", "external", "external_gte", "force"], "description"=>"Specific version type"}}}
  request(api_name, api_spec, params)
end

#index(params = {}) ⇒ Object

index href="https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html">www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html”, “description”=>“Creates or updates a document in an index.”



544
545
546
547
548
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 544

def index(params = {})
  api_name = 'index'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html", "description"=>"Creates or updates a document in an index."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/{index}/_doc/{id}", "methods"=>["PUT", "POST"], "parts"=>{"id"=>{"type"=>"string", "description"=>"Document ID"}, "index"=>{"type"=>"string", "description"=>"The name of the index"}}}, {"path"=>"/{index}/_doc", "methods"=>["POST"], "parts"=>{"index"=>{"type"=>"string", "description"=>"The name of the index"}}}]}, "params"=>{"wait_for_active_shards"=>{"type"=>"string", "description"=>"Sets the number of shard copies that must be active before proceeding with the index operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)"}, "op_type"=>{"type"=>"enum", "options"=>["index", "create"], "description"=>"Explicit operation type. Defaults to `index` for requests with an explicit document ID, and to `create`for requests without an explicit document ID"}, "refresh"=>{"type"=>"enum", "options"=>["true", "false", "wait_for"], "description"=>"If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes."}, "routing"=>{"type"=>"string", "description"=>"Specific routing value"}, "timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}, "version"=>{"type"=>"number", "description"=>"Explicit version number for concurrency control"}, "version_type"=>{"type"=>"enum", "options"=>["internal", "external", "external_gte"], "description"=>"Specific version type"}, "if_seq_no"=>{"type"=>"number", "description"=>"only perform the index operation if the last operation that has changed the document has the specified sequence number"}, "if_primary_term"=>{"type"=>"number", "description"=>"only perform the index operation if the last operation that has changed the document has the specified primary term"}, "pipeline"=>{"type"=>"string", "description"=>"The pipeline id to preprocess incoming documents with"}, "require_alias"=>{"type"=>"boolean", "description"=>"When true, requires destination to be an alias. Default is false"}}, "body"=>{"description"=>"The document", "required"=>true}}
  request(api_name, api_spec, params)
end

#indices_add_block(params = {}) ⇒ Object

indices.add_block href="https://www.elastic.co/guide/en/elasticsearch/reference/master/index-modules-blocks.html">www.elastic.co/guide/en/elasticsearch/reference/master/index-modules-blocks.html”, “description”=>“Adds a block to an index.”



552
553
554
555
556
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 552

def indices_add_block(params = {})
  api_name = 'indices.add_block'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/index-modules-blocks.html", "description"=>"Adds a block to an index."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/{index}/_block/{block}", "methods"=>["PUT"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma separated list of indices to add a block to"}, "block"=>{"type"=>"string", "description"=>"The block to add (one of read, write, read_only or metadata)"}}}]}, "params"=>{"timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}, "master_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to master", "deprecated"=>{"version"=>"2.0.0", "description"=>"To promote inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to cluster-manager node"}, "ignore_unavailable"=>{"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices"=>{"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards"=>{"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}}}
  request(api_name, api_spec, params)
end

#indices_analyze(params = {}) ⇒ Object

indices.analyze href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-analyze.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-analyze.html”, “description”=>“Performs the analysis process on a text and return the tokens breakdown of the text.”



560
561
562
563
564
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 560

def indices_analyze(params = {})
  api_name = 'indices.analyze'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-analyze.html", "description"=>"Performs the analysis process on a text and return the tokens breakdown of the text."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_analyze", "methods"=>["GET", "POST"]}, {"path"=>"/{index}/_analyze", "methods"=>["GET", "POST"], "parts"=>{"index"=>{"type"=>"string", "description"=>"The name of the index to scope the operation"}}}]}, "params"=>{"index"=>{"type"=>"string", "description"=>"The name of the index to scope the operation"}}, "body"=>{"description"=>"Define analyzer/tokenizer parameters and the text on which the analysis should be performed"}}
  request(api_name, api_spec, params)
end

#indices_clear_cache(params = {}) ⇒ Object

indices.clear_cache href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clearcache.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-clearcache.html”, “description”=>“Clears all or specific caches for one or more indices.”



568
569
570
571
572
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 568

def indices_clear_cache(params = {})
  api_name = 'indices.clear_cache'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clearcache.html", "description"=>"Clears all or specific caches for one or more indices."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_cache/clear", "methods"=>["POST"]}, {"path"=>"/{index}/_cache/clear", "methods"=>["POST"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index name to limit the operation"}}}]}, "params"=>{"fielddata"=>{"type"=>"boolean", "description"=>"Clear field data"}, "fields"=>{"type"=>"list", "description"=>"A comma-separated list of fields to clear when using the `fielddata` parameter (default: all)"}, "query"=>{"type"=>"boolean", "description"=>"Clear query caches"}, "ignore_unavailable"=>{"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices"=>{"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards"=>{"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "index"=>{"type"=>"list", "description"=>"A comma-separated list of index name to limit the operation"}, "request"=>{"type"=>"boolean", "description"=>"Clear request cache"}, "file"=>{"type"=>"boolean", "description"=>"Clear filecache"}}}
  request(api_name, api_spec, params)
end

#indices_clone(params = {}) ⇒ Object

indices.clone href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clone-index.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-clone-index.html”, “description”=>“Clones an index”



576
577
578
579
580
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 576

def indices_clone(params = {})
  api_name = 'indices.clone'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clone-index.html", "description"=>"Clones an index"}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/{index}/_clone/{target}", "methods"=>["PUT", "POST"], "parts"=>{"index"=>{"type"=>"string", "description"=>"The name of the source index to clone"}, "target"=>{"type"=>"string", "description"=>"The name of the target index to clone into"}}}]}, "params"=>{"timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}, "master_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to master", "deprecated"=>{"version"=>"2.0.0", "description"=>"To promote inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to cluster-manager node"}, "wait_for_active_shards"=>{"type"=>"string", "description"=>"Set the number of active shards to wait for on the cloned index before the operation returns."}, "wait_for_completion"=>{"type"=>"boolean", "description"=>"If false, the request will return a task immediately and the operation will run in background. Defaults to true."}, "task_execution_timeout"=>{"type"=>"time", "description"=>"Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h."}}, "body"=>{"description"=>"The configuration for the target index (`settings` and `aliases`)"}}
  request(api_name, api_spec, params)
end

#indices_close(params = {}) ⇒ Object

indices.close href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html”, “description”=>“Closes an index.”



584
585
586
587
588
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 584

def indices_close(params = {})
  api_name = 'indices.close'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html", "description"=>"Closes an index."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/{index}/_close", "methods"=>["POST"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma separated list of indices to close"}}}]}, "params"=>{"timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}, "master_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to master", "deprecated"=>{"version"=>"2.0.0", "description"=>"To promote inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to cluster-manager node"}, "ignore_unavailable"=>{"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices"=>{"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards"=>{"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "wait_for_active_shards"=>{"type"=>"string", "description"=>"Sets the number of active shards to wait for before the operation returns."}}}
  request(api_name, api_spec, params)
end

#indices_create(params = {}) ⇒ Object

indices.create href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-create-index.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-create-index.html”, “description”=>“Creates an index with optional settings and mappings.”



592
593
594
595
596
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 592

def indices_create(params = {})
  api_name = 'indices.create'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-create-index.html", "description"=>"Creates an index with optional settings and mappings."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/{index}", "methods"=>["PUT"], "parts"=>{"index"=>{"type"=>"string", "description"=>"The name of the index"}}}]}, "params"=>{"wait_for_active_shards"=>{"type"=>"string", "description"=>"Set the number of active shards to wait for before the operation returns."}, "timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}, "master_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to master", "deprecated"=>{"version"=>"2.0.0", "description"=>"To promote inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to cluster-manager node"}}, "body"=>{"description"=>"The configuration for the index (`settings` and `mappings`)"}}
  request(api_name, api_spec, params)
end

#indices_create_data_stream(params = {}) ⇒ Object

indices.create_data_stream href="https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html">www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html”, “description”=>“Creates or updates a data stream”



600
601
602
603
604
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 600

def indices_create_data_stream(params = {})
  api_name = 'indices.create_data_stream'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "description"=>"Creates or updates a data stream"}, "stability"=>"experimental", "url"=>{"paths"=>[{"path"=>"/_data_stream/{name}", "methods"=>["PUT"], "parts"=>{"name"=>{"type"=>"string", "description"=>"The name of the data stream"}}}]}, "params"=>{}, "body"=>{"description"=>"The data stream definition"}}
  request(api_name, api_spec, params)
end

#indices_data_streams_stats(params = {}) ⇒ Object

indices.data_streams_stats href="https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html">www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html”, “description”=>“Provides statistics on operations happening in a data stream.”



608
609
610
611
612
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 608

def indices_data_streams_stats(params = {})
  api_name = 'indices.data_streams_stats'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "description"=>"Provides statistics on operations happening in a data stream."}, "stability"=>"experimental", "url"=>{"paths"=>[{"path"=>"/_data_stream/_stats", "methods"=>["GET"]}, {"path"=>"/_data_stream/{name}/_stats", "methods"=>["GET"], "parts"=>{"name"=>{"type"=>"list", "description"=>"A comma-separated list of data stream names; use `_all` or empty string to perform the operation on all data streams"}}}]}}
  request(api_name, api_spec, params)
end

#indices_delete(params = {}) ⇒ Object

indices.delete href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-index.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-index.html”, “description”=>“Deletes an index.”



616
617
618
619
620
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 616

def indices_delete(params = {})
  api_name = 'indices.delete'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-index.html", "description"=>"Deletes an index."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/{index}", "methods"=>["DELETE"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices"}}}]}, "params"=>{"timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}, "master_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to master"}, "ignore_unavailable"=>{"type"=>"boolean", "description"=>"Ignore unavailable indexes (default: false)"}, "allow_no_indices"=>{"type"=>"boolean", "description"=>"Ignore if a wildcard expression resolves to no concrete indices (default: false)"}, "expand_wildcards"=>{"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether wildcard expressions should get expanded to open or closed indices (default: open)"}}}
  request(api_name, api_spec, params)
end

#indices_delete_alias(params = {}) ⇒ Object

indices.delete_alias href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html”, “description”=>“Deletes an alias.”



624
625
626
627
628
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 624

def indices_delete_alias(params = {})
  api_name = 'indices.delete_alias'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", "description"=>"Deletes an alias."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/{index}/_alias/{name}", "methods"=>["DELETE"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names (supports wildcards); use `_all` for all indices"}, "name"=>{"type"=>"list", "description"=>"A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices."}}}, {"path"=>"/{index}/_aliases/{name}", "methods"=>["DELETE"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names (supports wildcards); use `_all` for all indices"}, "name"=>{"type"=>"list", "description"=>"A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices."}}}]}, "params"=>{"timeout"=>{"type"=>"time", "description"=>"Explicit timestamp for the document"}, "master_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to master", "deprecated"=>{"version"=>"2.0.0", "description"=>"To promote inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to cluster-manager node"}}}
  request(api_name, api_spec, params)
end

#indices_delete_data_stream(params = {}) ⇒ Object

indices.delete_data_stream href="https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html">www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html”, “description”=>“Deletes a data stream.”



632
633
634
635
636
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 632

def indices_delete_data_stream(params = {})
  api_name = 'indices.delete_data_stream'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "description"=>"Deletes a data stream."}, "stability"=>"experimental", "url"=>{"paths"=>[{"path"=>"/_data_stream/{name}", "methods"=>["DELETE"], "parts"=>{"name"=>{"type"=>"list", "description"=>"A comma-separated list of data streams to delete; use `*` to delete all data streams"}}}]}, "params"=>{}}
  request(api_name, api_spec, params)
end

#indices_delete_index_template(params = {}) ⇒ Object

indices.delete_index_template href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html”, “description”=>“Deletes an index template.”



640
641
642
643
644
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 640

def indices_delete_index_template(params = {})
  api_name = 'indices.delete_index_template'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", "description"=>"Deletes an index template."}, "stability"=>"experimental", "url"=>{"paths"=>[{"path"=>"/_index_template/{name}", "methods"=>["DELETE"], "parts"=>{"name"=>{"type"=>"string", "description"=>"The name of the template"}}}]}, "params"=>{"timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}, "master_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to master node", "deprecated"=>{"version"=>"2.0.0", "description"=>"To support inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to cluster-manager node"}}}
  request(api_name, api_spec, params)
end

#indices_delete_template(params = {}) ⇒ Object

indices.delete_template href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html”, “description”=>“Deletes an index template.”



648
649
650
651
652
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 648

def indices_delete_template(params = {})
  api_name = 'indices.delete_template'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", "description"=>"Deletes an index template."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_template/{name}", "methods"=>["DELETE"], "parts"=>{"name"=>{"type"=>"string", "description"=>"The name of the template"}}}]}, "params"=>{"timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}, "master_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to master node", "deprecated"=>{"version"=>"2.0.0", "description"=>"To support inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to cluster-manager node"}}}
  request(api_name, api_spec, params)
end

#indices_exists(params = {}) ⇒ Object Also known as: indices_exists?

indices.exists href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-exists.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-exists.html”, “description”=>“Returns information about whether a particular index exists.”



656
657
658
659
660
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 656

def indices_exists(params = {})
  api_name = 'indices.exists'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-exists.html", "description"=>"Returns information about whether a particular index exists."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/{index}", "methods"=>["HEAD"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names"}}}]}, "params"=>{"local"=>{"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, "ignore_unavailable"=>{"type"=>"boolean", "description"=>"Ignore unavailable indexes (default: false)"}, "allow_no_indices"=>{"type"=>"boolean", "description"=>"Ignore if a wildcard expression resolves to no concrete indices (default: false)"}, "expand_wildcards"=>{"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether wildcard expressions should get expanded to open or closed indices (default: open)"}, "flat_settings"=>{"type"=>"boolean", "description"=>"Return settings in flat format (default: false)"}, "include_defaults"=>{"type"=>"boolean", "description"=>"Whether to return all default setting for each of the indices.", "default"=>false}}}
  request(api_name, api_spec, params)
end

#indices_exists_alias(params = {}) ⇒ Object Also known as: indices_exists_alias?

indices.exists_alias href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html”, “description”=>“Returns information about whether a particular alias exists.”



665
666
667
668
669
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 665

def indices_exists_alias(params = {})
  api_name = 'indices.exists_alias'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", "description"=>"Returns information about whether a particular alias exists."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_alias/{name}", "methods"=>["HEAD"], "parts"=>{"name"=>{"type"=>"list", "description"=>"A comma-separated list of alias names to return"}}}, {"path"=>"/{index}/_alias/{name}", "methods"=>["HEAD"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names to filter aliases"}, "name"=>{"type"=>"list", "description"=>"A comma-separated list of alias names to return"}}}]}, "params"=>{"ignore_unavailable"=>{"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices"=>{"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards"=>{"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"all", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "local"=>{"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}}}
  request(api_name, api_spec, params)
end

#indices_exists_index_template(params = {}) ⇒ Object Also known as: indices_exists_index_template?

indices.exists_index_template href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html”, “description”=>“Returns information about whether a particular index template exists.”



674
675
676
677
678
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 674

def indices_exists_index_template(params = {})
  api_name = 'indices.exists_index_template'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", "description"=>"Returns information about whether a particular index template exists."}, "stability"=>"experimental", "url"=>{"paths"=>[{"path"=>"/_index_template/{name}", "methods"=>["HEAD"], "parts"=>{"name"=>{"type"=>"string", "description"=>"The name of the template"}}}]}, "params"=>{"flat_settings"=>{"type"=>"boolean", "description"=>"Return settings in flat format (default: false)"}, "master_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, "local"=>{"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}}}
  request(api_name, api_spec, params)
end

#indices_exists_template(params = {}) ⇒ Object Also known as: indices_exists_template?

indices.exists_template href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html”, “description”=>“Returns information about whether a particular index template exists.”



683
684
685
686
687
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 683

def indices_exists_template(params = {})
  api_name = 'indices.exists_template'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", "description"=>"Returns information about whether a particular index template exists."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_template/{name}", "methods"=>["HEAD"], "parts"=>{"name"=>{"type"=>"list", "description"=>"The comma separated names of the index templates"}}}]}, "params"=>{"flat_settings"=>{"type"=>"boolean", "description"=>"Return settings in flat format (default: false)"}, "master_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, "local"=>{"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}}}
  request(api_name, api_spec, params)
end

#indices_flush(params = {}) ⇒ Object

indices.flush href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-flush.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-flush.html”, “description”=>“Performs the flush operation on one or more indices.”



692
693
694
695
696
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 692

def indices_flush(params = {})
  api_name = 'indices.flush'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-flush.html", "description"=>"Performs the flush operation on one or more indices."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_flush", "methods"=>["POST", "GET"]}, {"path"=>"/{index}/_flush", "methods"=>["POST", "GET"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names; use `_all` or empty string for all indices"}}}]}, "params"=>{"force"=>{"type"=>"boolean", "description"=>"Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal)"}, "wait_if_ongoing"=>{"type"=>"boolean", "description"=>"If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. The default is true. If set to false the flush will be skipped iff if another flush operation is already running."}, "ignore_unavailable"=>{"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices"=>{"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards"=>{"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}}}
  request(api_name, api_spec, params)
end

#indices_forcemerge(params = {}) ⇒ Object

indices.forcemerge href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-forcemerge.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-forcemerge.html”, “description”=>“Performs the force merge operation on one or more indices.”



700
701
702
703
704
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 700

def indices_forcemerge(params = {})
  api_name = 'indices.forcemerge'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-forcemerge.html", "description"=>"Performs the force merge operation on one or more indices."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_forcemerge", "methods"=>["POST"]}, {"path"=>"/{index}/_forcemerge", "methods"=>["POST"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"}}}]}, "params"=>{"flush"=>{"type"=>"boolean", "description"=>"Specify whether the index should be flushed after performing the operation (default: true)"}, "ignore_unavailable"=>{"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices"=>{"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards"=>{"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "max_num_segments"=>{"type"=>"number", "description"=>"The number of segments the index should be merged into (default: dynamic)"}, "only_expunge_deletes"=>{"type"=>"boolean", "description"=>"Specify whether the operation should only expunge deleted documents"}, "wait_for_completion"=>{"type"=>"boolean", "description"=>"If false, the request will return a task immediately and the operation will run in background. Defaults to true."}, "primary_only"=>{"type"=>"boolean", "description"=>"Specify whether the operation should only perform on primary shards. Defaults to false."}}}
  request(api_name, api_spec, params)
end

#indices_get(params = {}) ⇒ Object

indices.get href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index.html”, “description”=>“Returns information about one or more indices.”



708
709
710
711
712
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 708

def indices_get(params = {})
  api_name = 'indices.get'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index.html", "description"=>"Returns information about one or more indices."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/{index}", "methods"=>["GET"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names"}}}]}, "params"=>{"local"=>{"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, "ignore_unavailable"=>{"type"=>"boolean", "description"=>"Ignore unavailable indexes (default: false)"}, "allow_no_indices"=>{"type"=>"boolean", "description"=>"Ignore if a wildcard expression resolves to no concrete indices (default: false)"}, "expand_wildcards"=>{"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether wildcard expressions should get expanded to open or closed indices (default: open)"}, "flat_settings"=>{"type"=>"boolean", "description"=>"Return settings in flat format (default: false)"}, "include_defaults"=>{"type"=>"boolean", "description"=>"Whether to return all default setting for each of the indices.", "default"=>false}, "master_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to master", "deprecated"=>{"version"=>"2.0.0", "description"=>"To promote inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to cluster-manager node"}}}
  request(api_name, api_spec, params)
end

#indices_get_alias(params = {}) ⇒ Object

indices.get_alias href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html”, “description”=>“Returns an alias.”



716
717
718
719
720
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 716

def indices_get_alias(params = {})
  api_name = 'indices.get_alias'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", "description"=>"Returns an alias."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_alias", "methods"=>["GET"]}, {"path"=>"/_alias/{name}", "methods"=>["GET"], "parts"=>{"name"=>{"type"=>"list", "description"=>"A comma-separated list of alias names to return"}}}, {"path"=>"/{index}/_alias/{name}", "methods"=>["GET"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names to filter aliases"}, "name"=>{"type"=>"list", "description"=>"A comma-separated list of alias names to return"}}}, {"path"=>"/{index}/_alias", "methods"=>["GET"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names to filter aliases"}}}]}, "params"=>{"ignore_unavailable"=>{"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices"=>{"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards"=>{"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"all", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "local"=>{"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}}}
  request(api_name, api_spec, params)
end

#indices_get_data_stream(params = {}) ⇒ Object

indices.get_data_stream href="https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html">www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html”, “description”=>“Returns data streams.”



724
725
726
727
728
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 724

def indices_get_data_stream(params = {})
  api_name = 'indices.get_data_stream'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "description"=>"Returns data streams."}, "stability"=>"experimental", "url"=>{"paths"=>[{"path"=>"/_data_stream", "methods"=>["GET"]}, {"path"=>"/_data_stream/{name}", "methods"=>["GET"], "parts"=>{"name"=>{"type"=>"list", "description"=>"A comma-separated list of data streams to get; use `*` to get all data streams"}}}]}, "params"=>{}}
  request(api_name, api_spec, params)
end

#indices_get_field_mapping(params = {}) ⇒ Object

indices.get_field_mapping href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-field-mapping.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-field-mapping.html”, “description”=>“Returns mapping for one or more fields.”



732
733
734
735
736
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 732

def indices_get_field_mapping(params = {})
  api_name = 'indices.get_field_mapping'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-field-mapping.html", "description"=>"Returns mapping for one or more fields."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_mapping/field/{fields}", "methods"=>["GET"], "parts"=>{"fields"=>{"type"=>"list", "description"=>"A comma-separated list of fields"}}}, {"path"=>"/{index}/_mapping/field/{fields}", "methods"=>["GET"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names"}, "fields"=>{"type"=>"list", "description"=>"A comma-separated list of fields"}}}]}, "params"=>{"include_defaults"=>{"type"=>"boolean", "description"=>"Whether the default mapping values should be returned as well"}, "ignore_unavailable"=>{"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices"=>{"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards"=>{"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "local"=>{"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}}}
  request(api_name, api_spec, params)
end

#indices_get_index_template(params = {}) ⇒ Object

indices.get_index_template href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html”, “description”=>“Returns an index template.”



740
741
742
743
744
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 740

def indices_get_index_template(params = {})
  api_name = 'indices.get_index_template'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", "description"=>"Returns an index template."}, "stability"=>"experimental", "url"=>{"paths"=>[{"path"=>"/_index_template", "methods"=>["GET"]}, {"path"=>"/_index_template/{name}", "methods"=>["GET"], "parts"=>{"name"=>{"type"=>"list", "description"=>"The comma separated names of the index templates"}}}]}, "params"=>{"flat_settings"=>{"type"=>"boolean", "description"=>"Return settings in flat format (default: false)"}, "master_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to master node", "deprecated"=>{"version"=>"2.0.0", "description"=>"To support inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to cluster-manager node"}, "local"=>{"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}}}
  request(api_name, api_spec, params)
end

#indices_get_mapping(params = {}) ⇒ Object

indices.get_mapping href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-mapping.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-mapping.html”, “description”=>“Returns mappings for one or more indices.”



748
749
750
751
752
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 748

def indices_get_mapping(params = {})
  api_name = 'indices.get_mapping'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-mapping.html", "description"=>"Returns mappings for one or more indices."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_mapping", "methods"=>["GET"]}, {"path"=>"/{index}/_mapping", "methods"=>["GET"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names"}}}]}, "params"=>{"ignore_unavailable"=>{"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices"=>{"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards"=>{"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "master_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to master", "deprecated"=>{"version"=>"2.0.0", "description"=>"To promote inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to cluster-manager node"}, "local"=>{"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)", "deprecated"=>{"version"=>"7.8.0", "description"=>"This parameter is a no-op and field mappings are always retrieved locally."}}}}
  request(api_name, api_spec, params)
end

#indices_get_settings(params = {}) ⇒ Object

indices.get_settings href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html”, “description”=>“Returns settings for one or more indices.”



756
757
758
759
760
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 756

def indices_get_settings(params = {})
  api_name = 'indices.get_settings'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html", "description"=>"Returns settings for one or more indices."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_settings", "methods"=>["GET"]}, {"path"=>"/{index}/_settings", "methods"=>["GET"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"}}}, {"path"=>"/{index}/_settings/{name}", "methods"=>["GET"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"}, "name"=>{"type"=>"list", "description"=>"The name of the settings that should be included"}}}, {"path"=>"/_settings/{name}", "methods"=>["GET"], "parts"=>{"name"=>{"type"=>"list", "description"=>"The name of the settings that should be included"}}}]}, "params"=>{"master_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to master", "deprecated"=>{"version"=>"2.0.0", "description"=>"To promote inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to cluster-manager node"}, "ignore_unavailable"=>{"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices"=>{"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards"=>{"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"all", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "flat_settings"=>{"type"=>"boolean", "description"=>"Return settings in flat format (default: false)"}, "local"=>{"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, "include_defaults"=>{"type"=>"boolean", "description"=>"Whether to return all default setting for each of the indices.", "default"=>false}}}
  request(api_name, api_spec, params)
end

#indices_get_template(params = {}) ⇒ Object

indices.get_template href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html”, “description”=>“Returns an index template.”



764
765
766
767
768
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 764

def indices_get_template(params = {})
  api_name = 'indices.get_template'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", "description"=>"Returns an index template."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_template", "methods"=>["GET"]}, {"path"=>"/_template/{name}", "methods"=>["GET"], "parts"=>{"name"=>{"type"=>"list", "description"=>"The comma separated names of the index templates"}}}]}, "params"=>{"flat_settings"=>{"type"=>"boolean", "description"=>"Return settings in flat format (default: false)"}, "master_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to master node", "deprecated"=>{"version"=>"2.0.0", "description"=>"To support inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to cluster-manager node"}, "local"=>{"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}}}
  request(api_name, api_spec, params)
end

#indices_get_upgrade(params = {}) ⇒ Object

indices.get_upgrade href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html”, “description”=>“The _upgrade API is no longer useful and will be removed.”



772
773
774
775
776
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 772

def indices_get_upgrade(params = {})
  api_name = 'indices.get_upgrade'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html", "description"=>"The _upgrade API is no longer useful and will be removed."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_upgrade", "methods"=>["GET"]}, {"path"=>"/{index}/_upgrade", "methods"=>["GET"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"}}}]}, "params"=>{"ignore_unavailable"=>{"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices"=>{"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards"=>{"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}}}
  request(api_name, api_spec, params)
end

#indices_open(params = {}) ⇒ Object

indices.open href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html”, “description”=>“Opens an index.”



780
781
782
783
784
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 780

def indices_open(params = {})
  api_name = 'indices.open'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html", "description"=>"Opens an index."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/{index}/_open", "methods"=>["POST"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma separated list of indices to open"}}}]}, "params"=>{"timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}, "master_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to master", "deprecated"=>{"version"=>"2.0.0", "description"=>"To promote inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to cluster-manager node"}, "ignore_unavailable"=>{"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices"=>{"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards"=>{"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"closed", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "wait_for_active_shards"=>{"type"=>"string", "description"=>"Sets the number of active shards to wait for before the operation returns."}, "wait_for_completion"=>{"type"=>"boolean", "description"=>"If false, the request will return a task immediately and the operation will run in background. Defaults to true."}, "task_execution_timeout"=>{"type"=>"time", "description"=>"Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h."}}}
  request(api_name, api_spec, params)
end

#indices_put_alias(params = {}) ⇒ Object

indices.put_alias href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html”, “description”=>“Creates or updates an alias.”



788
789
790
791
792
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 788

def indices_put_alias(params = {})
  api_name = 'indices.put_alias'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", "description"=>"Creates or updates an alias."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/{index}/_alias/{name}", "methods"=>["PUT", "POST"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices."}, "name"=>{"type"=>"string", "description"=>"The name of the alias to be created or updated"}}}, {"path"=>"/{index}/_aliases/{name}", "methods"=>["PUT", "POST"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices."}, "name"=>{"type"=>"string", "description"=>"The name of the alias to be created or updated"}}}]}, "params"=>{"timeout"=>{"type"=>"time", "description"=>"Explicit timestamp for the document"}, "master_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to master", "deprecated"=>{"version"=>"2.0.0", "description"=>"To promote inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to cluster-manager node"}}, "body"=>{"description"=>"The settings for the alias, such as `routing` or `filter`", "required"=>false}}
  request(api_name, api_spec, params)
end

#indices_put_index_template(params = {}) ⇒ Object

indices.put_index_template href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html”, “description”=>“Creates or updates an index template.”



796
797
798
799
800
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 796

def indices_put_index_template(params = {})
  api_name = 'indices.put_index_template'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", "description"=>"Creates or updates an index template."}, "stability"=>"experimental", "url"=>{"paths"=>[{"path"=>"/_index_template/{name}", "methods"=>["PUT", "POST"], "parts"=>{"name"=>{"type"=>"string", "description"=>"The name of the template"}}}]}, "params"=>{"create"=>{"type"=>"boolean", "description"=>"Whether the index template should only be added if new or can also replace an existing one", "default"=>false}, "cause"=>{"type"=>"string", "description"=>"User defined reason for creating/updating the index template", "default"=>false}, "master_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to master node", "deprecated"=>{"version"=>"2.0.0", "description"=>"To support inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to cluster-manager node"}}, "body"=>{"description"=>"The template definition", "required"=>true}}
  request(api_name, api_spec, params)
end

#indices_put_mapping(params = {}) ⇒ Object

indices.put_mapping href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html”, “description”=>“Updates the index mappings.”



804
805
806
807
808
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 804

def indices_put_mapping(params = {})
  api_name = 'indices.put_mapping'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html", "description"=>"Updates the index mappings."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/{index}/_mapping", "methods"=>["PUT", "POST"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices."}}}]}, "params"=>{"timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}, "master_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to master", "deprecated"=>{"version"=>"2.0.0", "description"=>"To promote inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to cluster-manager node"}, "ignore_unavailable"=>{"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices"=>{"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards"=>{"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "write_index_only"=>{"type"=>"boolean", "default"=>false, "description"=>"When true, applies mappings only to the write index of an alias or data stream"}}, "body"=>{"description"=>"The mapping definition", "required"=>true}}
  request(api_name, api_spec, params)
end

#indices_put_settings(params = {}) ⇒ Object

indices.put_settings href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html”, “description”=>“Updates the index settings.”



812
813
814
815
816
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 812

def indices_put_settings(params = {})
  api_name = 'indices.put_settings'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html", "description"=>"Updates the index settings."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_settings", "methods"=>["PUT"]}, {"path"=>"/{index}/_settings", "methods"=>["PUT"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"}}}]}, "params"=>{"master_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to master", "deprecated"=>{"version"=>"2.0.0", "description"=>"To promote inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to cluster-manager node"}, "timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}, "preserve_existing"=>{"type"=>"boolean", "description"=>"Whether to update existing settings. If set to `true` existing settings on an index remain unchanged, the default is `false`"}, "ignore_unavailable"=>{"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices"=>{"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards"=>{"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "flat_settings"=>{"type"=>"boolean", "description"=>"Return settings in flat format (default: false)"}}, "body"=>{"description"=>"The index settings to be updated", "required"=>true}}
  request(api_name, api_spec, params)
end

#indices_put_template(params = {}) ⇒ Object

indices.put_template href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html”, “description”=>“Creates or updates an index template.”



820
821
822
823
824
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 820

def indices_put_template(params = {})
  api_name = 'indices.put_template'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", "description"=>"Creates or updates an index template."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_template/{name}", "methods"=>["PUT", "POST"], "parts"=>{"name"=>{"type"=>"string", "description"=>"The name of the template"}}}]}, "params"=>{"order"=>{"type"=>"number", "description"=>"The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers)"}, "create"=>{"type"=>"boolean", "description"=>"Whether the index template should only be added if new or can also replace an existing one", "default"=>false}, "master_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to master node", "deprecated"=>{"version"=>"2.0.0", "description"=>"To support inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to cluster-manager node"}}, "body"=>{"description"=>"The template definition", "required"=>true}}
  request(api_name, api_spec, params)
end

#indices_recovery(params = {}) ⇒ Object

indices.recovery href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-recovery.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-recovery.html”, “description”=>“Returns information about ongoing index shard recoveries.”



828
829
830
831
832
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 828

def indices_recovery(params = {})
  api_name = 'indices.recovery'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-recovery.html", "description"=>"Returns information about ongoing index shard recoveries."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_recovery", "methods"=>["GET"]}, {"path"=>"/{index}/_recovery", "methods"=>["GET"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"}}}]}, "params"=>{"detailed"=>{"type"=>"boolean", "description"=>"Whether to display detailed information about shard recovery", "default"=>false}, "active_only"=>{"type"=>"boolean", "description"=>"Display only those recoveries that are currently on-going", "default"=>false}}}
  request(api_name, api_spec, params)
end

#indices_refresh(params = {}) ⇒ Object

indices.refresh href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html”, “description”=>“Performs the refresh operation in one or more indices.”



836
837
838
839
840
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 836

def indices_refresh(params = {})
  api_name = 'indices.refresh'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html", "description"=>"Performs the refresh operation in one or more indices."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_refresh", "methods"=>["POST", "GET"]}, {"path"=>"/{index}/_refresh", "methods"=>["POST", "GET"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"}}}]}, "params"=>{"ignore_unavailable"=>{"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices"=>{"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards"=>{"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}}}
  request(api_name, api_spec, params)
end

#indices_resolve_index(params = {}) ⇒ Object

indices.resolve_index href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-resolve-index-api.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-resolve-index-api.html”, “description”=>“Returns information about any matching indices, aliases, and data streams”



844
845
846
847
848
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 844

def indices_resolve_index(params = {})
  api_name = 'indices.resolve_index'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-resolve-index-api.html", "description"=>"Returns information about any matching indices, aliases, and data streams"}, "stability"=>"experimental", "url"=>{"paths"=>[{"path"=>"/_resolve/index/{name}", "methods"=>["GET"], "parts"=>{"name"=>{"type"=>"list", "description"=>"A comma-separated list of names or wildcard expressions"}}}]}, "params"=>{"expand_wildcards"=>{"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether wildcard expressions should get expanded to open or closed indices (default: open)"}}}
  request(api_name, api_spec, params)
end

#indices_rollover(params = {}) ⇒ Object

indices.rollover href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-rollover-index.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-rollover-index.html”, “description”=>“Updates an alias to point to a new index when the existing indexnis considered to be too large or too old.”



852
853
854
855
856
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 852

def indices_rollover(params = {})
  api_name = 'indices.rollover'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-rollover-index.html", "description"=>"Updates an alias to point to a new index when the existing index\nis considered to be too large or too old."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/{alias}/_rollover", "methods"=>["POST"], "parts"=>{"alias"=>{"type"=>"string", "description"=>"The name of the alias to rollover"}}}, {"path"=>"/{alias}/_rollover/{new_index}", "methods"=>["POST"], "parts"=>{"alias"=>{"type"=>"string", "description"=>"The name of the alias to rollover"}, "new_index"=>{"type"=>"string", "description"=>"The name of the rollover index"}}}]}, "params"=>{"timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}, "dry_run"=>{"type"=>"boolean", "description"=>"If set to true the rollover action will only be validated but not actually performed even if a condition matches. The default is false"}, "master_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to master", "deprecated"=>{"version"=>"2.0.0", "description"=>"To promote inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to cluster-manager node"}, "wait_for_active_shards"=>{"type"=>"string", "description"=>"Set the number of active shards to wait for on the newly created rollover index before the operation returns."}}, "body"=>{"description"=>"The conditions that needs to be met for executing rollover"}}
  request(api_name, api_spec, params)
end

#indices_segments(params = {}) ⇒ Object

indices.segments href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-segments.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-segments.html”, “description”=>“Provides low-level information about segments in a Lucene index.”



860
861
862
863
864
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 860

def indices_segments(params = {})
  api_name = 'indices.segments'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-segments.html", "description"=>"Provides low-level information about segments in a Lucene index."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_segments", "methods"=>["GET"]}, {"path"=>"/{index}/_segments", "methods"=>["GET"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"}}}]}, "params"=>{"ignore_unavailable"=>{"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices"=>{"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards"=>{"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "verbose"=>{"type"=>"boolean", "description"=>"Includes detailed memory usage by Lucene.", "default"=>false}}}
  request(api_name, api_spec, params)
end

#indices_shard_stores(params = {}) ⇒ Object

indices.shard_stores href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shards-stores.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-shards-stores.html”, “description”=>“Provides store information for shard copies of indices.”



868
869
870
871
872
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 868

def indices_shard_stores(params = {})
  api_name = 'indices.shard_stores'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shards-stores.html", "description"=>"Provides store information for shard copies of indices."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_shard_stores", "methods"=>["GET"]}, {"path"=>"/{index}/_shard_stores", "methods"=>["GET"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"}}}]}, "params"=>{"status"=>{"type"=>"list", "options"=>["green", "yellow", "red", "all"], "description"=>"A comma-separated list of statuses used to filter on shards to get store information for"}, "ignore_unavailable"=>{"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices"=>{"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards"=>{"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}}}
  request(api_name, api_spec, params)
end

#indices_shrink(params = {}) ⇒ Object

indices.shrink href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shrink-index.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-shrink-index.html”, “description”=>“Allow to shrink an existing index into a new index with fewer primary shards.”



876
877
878
879
880
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 876

def indices_shrink(params = {})
  api_name = 'indices.shrink'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shrink-index.html", "description"=>"Allow to shrink an existing index into a new index with fewer primary shards."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/{index}/_shrink/{target}", "methods"=>["PUT", "POST"], "parts"=>{"index"=>{"type"=>"string", "description"=>"The name of the source index to shrink"}, "target"=>{"type"=>"string", "description"=>"The name of the target index to shrink into"}}}]}, "params"=>{"copy_settings"=>{"type"=>"boolean", "description"=>"whether or not to copy settings from the source index (defaults to false)"}, "timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}, "master_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to master", "deprecated"=>{"version"=>"2.0.0", "description"=>"To promote inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to cluster-manager node"}, "wait_for_active_shards"=>{"type"=>"string", "description"=>"Set the number of active shards to wait for on the shrunken index before the operation returns."}, "wait_for_completion"=>{"type"=>"boolean", "description"=>"If false, the request will return a task immediately and the operation will run in background. Defaults to true."}, "task_execution_timeout"=>{"type"=>"time", "description"=>"Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h."}}, "body"=>{"description"=>"The configuration for the target index (`settings` and `aliases`)"}}
  request(api_name, api_spec, params)
end

#indices_simulate_index_template(params = {}) ⇒ Object

indices.simulate_index_template href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html”, “description”=>“Simulate matching the given index name against the index templates in the system”



884
885
886
887
888
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 884

def indices_simulate_index_template(params = {})
  api_name = 'indices.simulate_index_template'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", "description"=>"Simulate matching the given index name against the index templates in the system"}, "stability"=>"experimental", "url"=>{"paths"=>[{"path"=>"/_index_template/_simulate_index/{name}", "methods"=>["POST"], "parts"=>{"name"=>{"type"=>"string", "description"=>"The name of the index (it must be a concrete index name)"}}}]}, "params"=>{"create"=>{"type"=>"boolean", "description"=>"Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one", "default"=>false}, "cause"=>{"type"=>"string", "description"=>"User defined reason for dry-run creating the new template for simulation purposes", "default"=>false}, "master_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to master node", "deprecated"=>{"version"=>"2.0.0", "description"=>"To support inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to cluster-manager node"}}, "body"=>{"description"=>"New index template definition, which will be included in the simulation, as if it already exists in the system", "required"=>false}}
  request(api_name, api_spec, params)
end

#indices_simulate_template(params = {}) ⇒ Object

indices.simulate_template href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html”, “description”=>“Simulate resolving the given template name or body”



892
893
894
895
896
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 892

def indices_simulate_template(params = {})
  api_name = 'indices.simulate_template'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", "description"=>"Simulate resolving the given template name or body"}, "stability"=>"experimental", "url"=>{"paths"=>[{"path"=>"/_index_template/_simulate", "methods"=>["POST"]}, {"path"=>"/_index_template/_simulate/{name}", "methods"=>["POST"], "parts"=>{"name"=>{"type"=>"string", "description"=>"The name of the index template"}}}]}, "params"=>{"create"=>{"type"=>"boolean", "description"=>"Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one", "default"=>false}, "cause"=>{"type"=>"string", "description"=>"User defined reason for dry-run creating the new template for simulation purposes", "default"=>false}, "master_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to master node", "deprecated"=>{"version"=>"2.0.0", "description"=>"To support inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to cluster-manager node"}}, "body"=>{"description"=>"New index template definition to be simulated, if no index template name is specified", "required"=>false}}
  request(api_name, api_spec, params)
end

#indices_split(params = {}) ⇒ Object

indices.split href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-split-index.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-split-index.html”, “description”=>“Allows you to split an existing index into a new index with more primary shards.”



900
901
902
903
904
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 900

def indices_split(params = {})
  api_name = 'indices.split'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-split-index.html", "description"=>"Allows you to split an existing index into a new index with more primary shards."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/{index}/_split/{target}", "methods"=>["PUT", "POST"], "parts"=>{"index"=>{"type"=>"string", "description"=>"The name of the source index to split"}, "target"=>{"type"=>"string", "description"=>"The name of the target index to split into"}}}]}, "params"=>{"copy_settings"=>{"type"=>"boolean", "description"=>"whether or not to copy settings from the source index (defaults to false)"}, "timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}, "master_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to master", "deprecated"=>{"version"=>"2.0.0", "description"=>"To promote inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to cluster-manager node"}, "wait_for_active_shards"=>{"type"=>"string", "description"=>"Set the number of active shards to wait for on the shrunken index before the operation returns."}, "wait_for_completion"=>{"type"=>"boolean", "description"=>"If false, the request will return a task immediately and the operation will run in background. Defaults to true."}, "task_execution_timeout"=>{"type"=>"time", "description"=>"Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h."}}, "body"=>{"description"=>"The configuration for the target index (`settings` and `aliases`)"}}
  request(api_name, api_spec, params)
end

#indices_stats(params = {}) ⇒ Object

indices.stats href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-stats.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-stats.html”, “description”=>“Provides statistics on operations happening in an index.”



908
909
910
911
912
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 908

def indices_stats(params = {})
  api_name = 'indices.stats'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-stats.html", "description"=>"Provides statistics on operations happening in an index."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_stats", "methods"=>["GET"]}, {"path"=>"/_stats/{metric}", "methods"=>["GET"], "parts"=>{"metric"=>{"type"=>"list", "options"=>["_all", "completion", "docs", "fielddata", "query_cache", "flush", "get", "indexing", "merge", "request_cache", "refresh", "search", "segments", "store", "warmer", "suggest"], "description"=>"Limit the information returned the specific metrics."}}}, {"path"=>"/{index}/_stats", "methods"=>["GET"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"}}}, {"path"=>"/{index}/_stats/{metric}", "methods"=>["GET"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"}, "metric"=>{"type"=>"list", "options"=>["_all", "completion", "docs", "fielddata", "query_cache", "flush", "get", "indexing", "merge", "request_cache", "refresh", "search", "segments", "store", "warmer", "suggest"], "description"=>"Limit the information returned the specific metrics."}}}]}, "params"=>{"completion_fields"=>{"type"=>"list", "description"=>"A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)"}, "fielddata_fields"=>{"type"=>"list", "description"=>"A comma-separated list of fields for `fielddata` index metric (supports wildcards)"}, "fields"=>{"type"=>"list", "description"=>"A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)"}, "groups"=>{"type"=>"list", "description"=>"A comma-separated list of search groups for `search` index metric"}, "level"=>{"type"=>"enum", "description"=>"Return stats aggregated at cluster, index or shard level", "options"=>["cluster", "indices", "shards"], "default"=>"indices"}, "include_segment_file_sizes"=>{"type"=>"boolean", "description"=>"Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested)", "default"=>false}, "include_unloaded_segments"=>{"type"=>"boolean", "description"=>"If set to true segment stats will include stats for segments that are not currently loaded into memory", "default"=>false}, "expand_wildcards"=>{"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "forbid_closed_indices"=>{"type"=>"boolean", "description"=>"If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices", "default"=>true}}}
  request(api_name, api_spec, params)
end

#indices_update_aliases(params = {}) ⇒ Object

indices.update_aliases href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html”, “description”=>“Updates index aliases.”



916
917
918
919
920
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 916

def indices_update_aliases(params = {})
  api_name = 'indices.update_aliases'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", "description"=>"Updates index aliases."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_aliases", "methods"=>["POST"]}]}, "params"=>{"timeout"=>{"type"=>"time", "description"=>"Request timeout"}, "master_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to master", "deprecated"=>{"version"=>"2.0.0", "description"=>"To promote inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to cluster-manager node"}}, "body"=>{"description"=>"The definition of `actions` to perform", "required"=>true}}
  request(api_name, api_spec, params)
end

#indices_upgrade(params = {}) ⇒ Object

indices.upgrade href="https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html">www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html”, “description”=>“The _upgrade API is no longer useful and will be removed.”



924
925
926
927
928
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 924

def indices_upgrade(params = {})
  api_name = 'indices.upgrade'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html", "description"=>"The _upgrade API is no longer useful and will be removed."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_upgrade", "methods"=>["POST"]}, {"path"=>"/{index}/_upgrade", "methods"=>["POST"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"}}}]}, "params"=>{"allow_no_indices"=>{"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards"=>{"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "ignore_unavailable"=>{"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "wait_for_completion"=>{"type"=>"boolean", "description"=>"Specify whether the request should block until the all segments are upgraded (default: false)"}, "only_ancient_segments"=>{"type"=>"boolean", "description"=>"If true, only ancient (an older Lucene major release) segments will be upgraded"}}}
  request(api_name, api_spec, params)
end

#indices_validate_query(params = {}) ⇒ Object

indices.validate_query href="https://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html">www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html”, “description”=>“Allows a user to validate a potentially expensive query without executing it.”



932
933
934
935
936
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 932

def indices_validate_query(params = {})
  api_name = 'indices.validate_query'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html", "description"=>"Allows a user to validate a potentially expensive query without executing it."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_validate/query", "methods"=>["GET", "POST"]}, {"path"=>"/{index}/_validate/query", "methods"=>["GET", "POST"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices"}}}]}, "params"=>{"explain"=>{"type"=>"boolean", "description"=>"Return detailed information about the error"}, "ignore_unavailable"=>{"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices"=>{"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards"=>{"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "q"=>{"type"=>"string", "description"=>"Query in the Lucene query string syntax"}, "analyzer"=>{"type"=>"string", "description"=>"The analyzer to use for the query string"}, "analyze_wildcard"=>{"type"=>"boolean", "description"=>"Specify whether wildcard and prefix queries should be analyzed (default: false)"}, "default_operator"=>{"type"=>"enum", "options"=>["AND", "OR"], "default"=>"OR", "description"=>"The default operator for query string query (AND or OR)"}, "df"=>{"type"=>"string", "description"=>"The field to use as default where no field prefix is given in the query string"}, "lenient"=>{"type"=>"boolean", "description"=>"Specify whether format-based query failures (such as providing text to a numeric field) should be ignored"}, "rewrite"=>{"type"=>"boolean", "description"=>"Provide a more detailed explanation showing the actual Lucene query that will be executed."}, "all_shards"=>{"type"=>"boolean", "description"=>"Execute validation on all shards instead of one random shard per index"}}, "body"=>{"description"=>"The query definition specified with the Query DSL"}}
  request(api_name, api_spec, params)
end

#info(params = {}) ⇒ Object

info href="https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html">www.elastic.co/guide/en/elasticsearch/reference/current/index.html”, “description”=>“Returns basic information about the cluster.”



940
941
942
943
944
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 940

def info(params = {})
  api_name = 'info'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html", "description"=>"Returns basic information about the cluster."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/", "methods"=>["GET"]}]}, "params"=>{}}
  request(api_name, api_spec, params)
end

#ingest_delete_pipeline(params = {}) ⇒ Object

ingest.delete_pipeline href="https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-pipeline-api.html">www.elastic.co/guide/en/elasticsearch/reference/master/delete-pipeline-api.html”, “description”=>“Deletes a pipeline.”



948
949
950
951
952
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 948

def ingest_delete_pipeline(params = {})
  api_name = 'ingest.delete_pipeline'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-pipeline-api.html", "description"=>"Deletes a pipeline."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_ingest/pipeline/{id}", "methods"=>["DELETE"], "parts"=>{"id"=>{"type"=>"string", "description"=>"Pipeline ID"}}}]}, "params"=>{"master_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to master node", "deprecated"=>{"version"=>"2.0.0", "description"=>"To support inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to cluster-manager node"}, "timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}}}
  request(api_name, api_spec, params)
end

#ingest_get_pipeline(params = {}) ⇒ Object

ingest.get_pipeline href="https://www.elastic.co/guide/en/elasticsearch/reference/master/get-pipeline-api.html">www.elastic.co/guide/en/elasticsearch/reference/master/get-pipeline-api.html”, “description”=>“Returns a pipeline.”



956
957
958
959
960
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 956

def ingest_get_pipeline(params = {})
  api_name = 'ingest.get_pipeline'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/get-pipeline-api.html", "description"=>"Returns a pipeline."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_ingest/pipeline", "methods"=>["GET"]}, {"path"=>"/_ingest/pipeline/{id}", "methods"=>["GET"], "parts"=>{"id"=>{"type"=>"string", "description"=>"Comma separated list of pipeline ids. Wildcards supported"}}}]}, "params"=>{"master_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to master node", "deprecated"=>{"version"=>"2.0.0", "description"=>"To support inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to cluster-manager node"}}}
  request(api_name, api_spec, params)
end

#ingest_processor_grok(params = {}) ⇒ Object

ingest.processor_grok href="https://www.elastic.co/guide/en/elasticsearch/reference/master/grok-processor.html#grok-processor-rest-get">www.elastic.co/guide/en/elasticsearch/reference/master/grok-processor.html#grok-processor-rest-get”, “description”=>“Returns a list of the built-in patterns.”



964
965
966
967
968
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 964

def ingest_processor_grok(params = {})
  api_name = 'ingest.processor_grok'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/grok-processor.html#grok-processor-rest-get", "description"=>"Returns a list of the built-in patterns."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_ingest/processor/grok", "methods"=>["GET"]}]}, "params"=>{}}
  request(api_name, api_spec, params)
end

#ingest_put_pipeline(params = {}) ⇒ Object

ingest.put_pipeline href="https://www.elastic.co/guide/en/elasticsearch/reference/master/put-pipeline-api.html">www.elastic.co/guide/en/elasticsearch/reference/master/put-pipeline-api.html”, “description”=>“Creates or updates a pipeline.”



972
973
974
975
976
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 972

def ingest_put_pipeline(params = {})
  api_name = 'ingest.put_pipeline'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/put-pipeline-api.html", "description"=>"Creates or updates a pipeline."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_ingest/pipeline/{id}", "methods"=>["PUT"], "parts"=>{"id"=>{"type"=>"string", "description"=>"Pipeline ID"}}}]}, "params"=>{"master_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to master node", "deprecated"=>{"version"=>"2.0.0", "description"=>"To support inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to cluster-manager node"}, "timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}}, "body"=>{"description"=>"The ingest definition", "required"=>true}}
  request(api_name, api_spec, params)
end

#ingest_simulate(params = {}) ⇒ Object

ingest.simulate href="https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-pipeline-api.html">www.elastic.co/guide/en/elasticsearch/reference/master/simulate-pipeline-api.html”, “description”=>“Allows to simulate a pipeline with example documents.”



980
981
982
983
984
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 980

def ingest_simulate(params = {})
  api_name = 'ingest.simulate'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-pipeline-api.html", "description"=>"Allows to simulate a pipeline with example documents."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_ingest/pipeline/_simulate", "methods"=>["GET", "POST"]}, {"path"=>"/_ingest/pipeline/{id}/_simulate", "methods"=>["GET", "POST"], "parts"=>{"id"=>{"type"=>"string", "description"=>"Pipeline ID"}}}]}, "params"=>{"verbose"=>{"type"=>"boolean", "description"=>"Verbose mode. Display data output for each processor in executed pipeline", "default"=>false}}, "body"=>{"description"=>"The simulate definition", "required"=>true}}
  request(api_name, api_spec, params)
end

#mget(params = {}) ⇒ Object

mget href="https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html">www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html”, “description”=>“Allows to get multiple documents in one request.”



988
989
990
991
992
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 988

def mget(params = {})
  api_name = 'mget'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html", "description"=>"Allows to get multiple documents in one request."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_mget", "methods"=>["GET", "POST"]}, {"path"=>"/{index}/_mget", "methods"=>["GET", "POST"], "parts"=>{"index"=>{"type"=>"string", "description"=>"The name of the index"}}}]}, "params"=>{"stored_fields"=>{"type"=>"list", "description"=>"A comma-separated list of stored fields to return in the response"}, "preference"=>{"type"=>"string", "description"=>"Specify the node or shard the operation should be performed on (default: random)"}, "realtime"=>{"type"=>"boolean", "description"=>"Specify whether to perform the operation in realtime or search mode"}, "refresh"=>{"type"=>"boolean", "description"=>"Refresh the shard containing the document before performing the operation"}, "routing"=>{"type"=>"string", "description"=>"Specific routing value"}, "_source"=>{"type"=>"list", "description"=>"True or false to return the _source field or not, or a list of fields to return"}, "_source_excludes"=>{"type"=>"list", "description"=>"A list of fields to exclude from the returned _source field"}, "_source_includes"=>{"type"=>"list", "description"=>"A list of fields to extract and return from the _source field"}}, "body"=>{"description"=>"Document identifiers; can be either `docs` (containing full document information) or `ids` (when index is provided in the URL.", "required"=>true}}
  request(api_name, api_spec, params)
end

#msearch(params = {}) ⇒ Object

msearch href="https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html">www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html”, “description”=>“Allows to execute several search operations in one request.”



996
997
998
999
1000
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 996

def msearch(params = {})
  api_name = 'msearch'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html", "description"=>"Allows to execute several search operations in one request."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_msearch", "methods"=>["GET", "POST"]}, {"path"=>"/{index}/_msearch", "methods"=>["GET", "POST"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names to use as default"}}}]}, "params"=>{"search_type"=>{"type"=>"enum", "options"=>["query_then_fetch", "query_and_fetch", "dfs_query_then_fetch", "dfs_query_and_fetch"], "description"=>"Search operation type"}, "max_concurrent_searches"=>{"type"=>"number", "description"=>"Controls the maximum number of concurrent searches the multi search api will execute"}, "typed_keys"=>{"type"=>"boolean", "description"=>"Specify whether aggregation and suggester names should be prefixed by their respective types in the response"}, "pre_filter_shard_size"=>{"type"=>"number", "description"=>"A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint."}, "max_concurrent_shard_requests"=>{"type"=>"number", "description"=>"The number of concurrent shard requests each sub search executes concurrently per node. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests", "default"=>5}, "rest_total_hits_as_int"=>{"type"=>"boolean", "description"=>"Indicates whether hits.total should be rendered as an integer or an object in the rest search response", "default"=>false}, "ccs_minimize_roundtrips"=>{"type"=>"boolean", "description"=>"Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution", "default"=>"true"}}, "body"=>{"description"=>"The request definitions (metadata-search request definition pairs), separated by newlines", "required"=>true, "serialize"=>"bulk"}}
  request(api_name, api_spec, params)
end

#msearch_template(params = {}) ⇒ Object

msearch_template href="https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html">www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html”, “description”=>“Allows to execute several search template operations in one request.”



1004
1005
1006
1007
1008
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 1004

def msearch_template(params = {})
  api_name = 'msearch_template'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html", "description"=>"Allows to execute several search template operations in one request."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_msearch/template", "methods"=>["GET", "POST"]}, {"path"=>"/{index}/_msearch/template", "methods"=>["GET", "POST"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names to use as default"}}}]}, "params"=>{"search_type"=>{"type"=>"enum", "options"=>["query_then_fetch", "query_and_fetch", "dfs_query_then_fetch", "dfs_query_and_fetch"], "description"=>"Search operation type"}, "typed_keys"=>{"type"=>"boolean", "description"=>"Specify whether aggregation and suggester names should be prefixed by their respective types in the response"}, "max_concurrent_searches"=>{"type"=>"number", "description"=>"Controls the maximum number of concurrent searches the multi search api will execute"}, "rest_total_hits_as_int"=>{"type"=>"boolean", "description"=>"Indicates whether hits.total should be rendered as an integer or an object in the rest search response", "default"=>false}, "ccs_minimize_roundtrips"=>{"type"=>"boolean", "description"=>"Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution", "default"=>"true"}}, "body"=>{"description"=>"The request definitions (metadata-search request definition pairs), separated by newlines", "required"=>true, "serialize"=>"bulk"}}
  request(api_name, api_spec, params)
end

#mtermvectors(params = {}) ⇒ Object

mtermvectors href="https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html">www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html”, “description”=>“Returns multiple termvectors in one request.”



1012
1013
1014
1015
1016
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 1012

def mtermvectors(params = {})
  api_name = 'mtermvectors'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html", "description"=>"Returns multiple termvectors in one request."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_mtermvectors", "methods"=>["GET", "POST"]}, {"path"=>"/{index}/_mtermvectors", "methods"=>["GET", "POST"], "parts"=>{"index"=>{"type"=>"string", "description"=>"The index in which the document resides."}}}]}, "params"=>{"ids"=>{"type"=>"list", "description"=>"A comma-separated list of documents ids. You must define ids as parameter or set \"ids\" or \"docs\" in the request body"}, "term_statistics"=>{"type"=>"boolean", "description"=>"Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\".", "default"=>false}, "field_statistics"=>{"type"=>"boolean", "description"=>"Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\".", "default"=>true}, "fields"=>{"type"=>"list", "description"=>"A comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\"."}, "offsets"=>{"type"=>"boolean", "description"=>"Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\".", "default"=>true}, "positions"=>{"type"=>"boolean", "description"=>"Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\".", "default"=>true}, "payloads"=>{"type"=>"boolean", "description"=>"Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\".", "default"=>true}, "preference"=>{"type"=>"string", "description"=>"Specify the node or shard the operation should be performed on (default: random) .Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\"."}, "routing"=>{"type"=>"string", "description"=>"Specific routing value. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\"."}, "realtime"=>{"type"=>"boolean", "description"=>"Specifies if requests are real-time as opposed to near-real-time (default: true)."}, "version"=>{"type"=>"number", "description"=>"Explicit version number for concurrency control"}, "version_type"=>{"type"=>"enum", "options"=>["internal", "external", "external_gte", "force"], "description"=>"Specific version type"}}, "body"=>{"description"=>"Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation.", "required"=>false}}
  request(api_name, api_spec, params)
end

#nodes_hot_threads(params = {}) ⇒ Object

nodes.hot_threads href="https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-hot-threads.html">www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-hot-threads.html”, “description”=>“Returns information about hot threads on each node in the cluster.”



1020
1021
1022
1023
1024
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 1020

def nodes_hot_threads(params = {})
  api_name = 'nodes.hot_threads'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-hot-threads.html", "description"=>"Returns information about hot threads on each node in the cluster."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_nodes/hot_threads", "methods"=>["GET"]}, {"path"=>"/_nodes/{node_id}/hot_threads", "methods"=>["GET"], "parts"=>{"node_id"=>{"type"=>"list", "description"=>"A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes"}}}, {"path"=>"/_cluster/nodes/hotthreads", "methods"=>["GET"], "parts"=>{}, "deprecated"=>{"version"=>"7.0.0", "description"=>"The hot threads API accepts `hotthreads` but only `hot_threads` is documented"}}, {"path"=>"/_cluster/nodes/{node_id}/hotthreads", "methods"=>["GET"], "parts"=>{"node_id"=>{"type"=>"list", "description"=>"A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes"}}, "deprecated"=>{"version"=>"7.0.0", "description"=>"The hot threads API accepts `hotthreads` but only `hot_threads` is documented"}}, {"path"=>"/_nodes/hotthreads", "methods"=>["GET"], "parts"=>{}, "deprecated"=>{"version"=>"7.0.0", "description"=>"The hot threads API accepts `hotthreads` but only `hot_threads` is documented"}}, {"path"=>"/_nodes/{node_id}/hotthreads", "methods"=>["GET"], "parts"=>{"node_id"=>{"type"=>"list", "description"=>"A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes"}}, "deprecated"=>{"version"=>"7.0.0", "description"=>"The hot threads API accepts `hotthreads` but only `hot_threads` is documented"}}, {"path"=>"/_cluster/nodes/hot_threads", "methods"=>["GET"], "parts"=>{}, "deprecated"=>{"version"=>"7.0.0", "description"=>"The hot accepts /_cluster/nodes as prefix for backwards compatibility reasons"}}, {"path"=>"/_cluster/nodes/{node_id}/hot_threads", "methods"=>["GET"], "parts"=>{"node_id"=>{"type"=>"list", "description"=>"A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes"}}, "deprecated"=>{"version"=>"7.0.0", "description"=>"The hot accepts /_cluster/nodes as prefix for backwards compatibility reasons"}}]}, "params"=>{"interval"=>{"type"=>"time", "description"=>"The interval for the second sampling of threads"}, "snapshots"=>{"type"=>"number", "description"=>"Number of samples of thread stacktrace (default: 10)"}, "threads"=>{"type"=>"number", "description"=>"Specify the number of threads to provide information for (default: 3)"}, "ignore_idle_threads"=>{"type"=>"boolean", "description"=>"Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue (default: true)"}, "type"=>{"type"=>"enum", "options"=>["cpu", "wait", "block"], "description"=>"The type to sample (default: cpu)"}, "timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}}}
  request(api_name, api_spec, params)
end

#nodes_info(params = {}) ⇒ Object

nodes.info href="https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-info.html">www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-info.html”, “description”=>“Returns information about nodes in the cluster.”



1028
1029
1030
1031
1032
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 1028

def nodes_info(params = {})
  api_name = 'nodes.info'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-info.html", "description"=>"Returns information about nodes in the cluster."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_nodes", "methods"=>["GET"]}, {"path"=>"/_nodes/{node_id}", "methods"=>["GET"], "parts"=>{"node_id"=>{"type"=>"list", "description"=>"A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes"}}}, {"path"=>"/_nodes/{metric}", "methods"=>["GET"], "parts"=>{"metric"=>{"type"=>"list", "options"=>["settings", "os", "process", "jvm", "thread_pool", "transport", "http", "plugins", "ingest"], "description"=>"A comma-separated list of metrics you wish returned. Leave empty to return all."}}}, {"path"=>"/_nodes/{node_id}/{metric}", "methods"=>["GET"], "parts"=>{"node_id"=>{"type"=>"list", "description"=>"A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes"}, "metric"=>{"type"=>"list", "options"=>["settings", "os", "process", "jvm", "thread_pool", "transport", "http", "plugins", "ingest"], "description"=>"A comma-separated list of metrics you wish returned. Leave empty to return all."}}}]}, "params"=>{"flat_settings"=>{"type"=>"boolean", "description"=>"Return settings in flat format (default: false)"}, "timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}}}
  request(api_name, api_spec, params)
end

#nodes_reload_secure_settings(params = {}) ⇒ Object

nodes.reload_secure_settings href="https://www.elastic.co/guide/en/elasticsearch/reference/master/secure-settings.html#reloadable-secure-settings">www.elastic.co/guide/en/elasticsearch/reference/master/secure-settings.html#reloadable-secure-settings”, “description”=>“Reloads secure settings.”



1036
1037
1038
1039
1040
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 1036

def nodes_reload_secure_settings(params = {})
  api_name = 'nodes.reload_secure_settings'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/secure-settings.html#reloadable-secure-settings", "description"=>"Reloads secure settings."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_nodes/reload_secure_settings", "methods"=>["POST"]}, {"path"=>"/_nodes/{node_id}/reload_secure_settings", "methods"=>["POST"], "parts"=>{"node_id"=>{"type"=>"list", "description"=>"A comma-separated list of node IDs to span the reload/reinit call. Should stay empty because reloading usually involves all cluster nodes."}}}]}, "params"=>{"timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}}, "body"=>{"description"=>"An object containing the password for the opensearch keystore", "required"=>false}}
  request(api_name, api_spec, params)
end

#nodes_stats(params = {}) ⇒ Object

nodes.stats href="https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-stats.html">www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-stats.html”, “description”=>“Returns statistical information about nodes in the cluster.”



1044
1045
1046
1047
1048
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 1044

def nodes_stats(params = {})
  api_name = 'nodes.stats'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-stats.html", "description"=>"Returns statistical information about nodes in the cluster."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_nodes/stats", "methods"=>["GET"]}, {"path"=>"/_nodes/{node_id}/stats", "methods"=>["GET"], "parts"=>{"node_id"=>{"type"=>"list", "description"=>"A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes"}}}, {"path"=>"/_nodes/stats/{metric}", "methods"=>["GET"], "parts"=>{"metric"=>{"type"=>"list", "options"=>["_all", "breaker", "fs", "http", "indices", "jvm", "os", "process", "thread_pool", "transport", "discovery", "indexing_pressure"], "description"=>"Limit the information returned to the specified metrics"}}}, {"path"=>"/_nodes/{node_id}/stats/{metric}", "methods"=>["GET"], "parts"=>{"metric"=>{"type"=>"list", "options"=>["_all", "breaker", "fs", "http", "indices", "jvm", "os", "process", "thread_pool", "transport", "discovery", "indexing_pressure"], "description"=>"Limit the information returned to the specified metrics"}, "node_id"=>{"type"=>"list", "description"=>"A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes"}}}, {"path"=>"/_nodes/stats/{metric}/{index_metric}", "methods"=>["GET"], "parts"=>{"metric"=>{"type"=>"list", "options"=>["_all", "breaker", "fs", "http", "indices", "jvm", "os", "process", "thread_pool", "transport", "discovery", "indexing_pressure"], "description"=>"Limit the information returned to the specified metrics"}, "index_metric"=>{"type"=>"list", "options"=>["_all", "completion", "docs", "fielddata", "query_cache", "flush", "get", "indexing", "merge", "request_cache", "refresh", "search", "segments", "store", "warmer", "suggest"], "description"=>"Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified."}}}, {"path"=>"/_nodes/{node_id}/stats/{metric}/{index_metric}", "methods"=>["GET"], "parts"=>{"metric"=>{"type"=>"list", "options"=>["_all", "breaker", "fs", "http", "indices", "jvm", "os", "process", "thread_pool", "transport", "discovery", "indexing_pressure"], "description"=>"Limit the information returned to the specified metrics"}, "index_metric"=>{"type"=>"list", "options"=>["_all", "completion", "docs", "fielddata", "query_cache", "flush", "get", "indexing", "merge", "request_cache", "refresh", "search", "segments", "store", "warmer", "suggest"], "description"=>"Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified."}, "node_id"=>{"type"=>"list", "description"=>"A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes"}}}]}, "params"=>{"completion_fields"=>{"type"=>"list", "description"=>"A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)"}, "fielddata_fields"=>{"type"=>"list", "description"=>"A comma-separated list of fields for `fielddata` index metric (supports wildcards)"}, "fields"=>{"type"=>"list", "description"=>"A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)"}, "groups"=>{"type"=>"boolean", "description"=>"A comma-separated list of search groups for `search` index metric"}, "level"=>{"type"=>"enum", "description"=>"Return indices stats aggregated at index, node or shard level", "options"=>["indices", "node", "shards"], "default"=>"node"}, "types"=>{"type"=>"list", "description"=>"A comma-separated list of document types for the `indexing` index metric"}, "timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}, "include_segment_file_sizes"=>{"type"=>"boolean", "description"=>"Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested)", "default"=>false}}}
  request(api_name, api_spec, params)
end

#nodes_usage(params = {}) ⇒ Object

nodes.usage href="https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-usage.html">www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-usage.html”, “description”=>“Returns low-level information about REST actions usage on nodes.”



1052
1053
1054
1055
1056
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 1052

def nodes_usage(params = {})
  api_name = 'nodes.usage'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-usage.html", "description"=>"Returns low-level information about REST actions usage on nodes."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_nodes/usage", "methods"=>["GET"]}, {"path"=>"/_nodes/{node_id}/usage", "methods"=>["GET"], "parts"=>{"node_id"=>{"type"=>"list", "description"=>"A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes"}}}, {"path"=>"/_nodes/usage/{metric}", "methods"=>["GET"], "parts"=>{"metric"=>{"type"=>"list", "options"=>["_all", "rest_actions"], "description"=>"Limit the information returned to the specified metrics"}}}, {"path"=>"/_nodes/{node_id}/usage/{metric}", "methods"=>["GET"], "parts"=>{"metric"=>{"type"=>"list", "options"=>["_all", "rest_actions"], "description"=>"Limit the information returned to the specified metrics"}, "node_id"=>{"type"=>"list", "description"=>"A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes"}}}]}, "params"=>{"timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}}}
  request(api_name, api_spec, params)
end

#ping(params = {}) ⇒ Object Also known as: ping?

ping href="https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html">www.elastic.co/guide/en/elasticsearch/reference/current/index.html”, “description”=>“Returns whether the cluster is running.”



1060
1061
1062
1063
1064
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 1060

def ping(params = {})
  api_name = 'ping'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html", "description"=>"Returns whether the cluster is running."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/", "methods"=>["HEAD"]}]}, "params"=>{}}
  request(api_name, api_spec, params)
end

#put_script(params = {}) ⇒ Object

put_script href="https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html">www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html”, “description”=>“Creates or updates a script.”



1069
1070
1071
1072
1073
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 1069

def put_script(params = {})
  api_name = 'put_script'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", "description"=>"Creates or updates a script."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_scripts/{id}", "methods"=>["PUT", "POST"], "parts"=>{"id"=>{"type"=>"string", "description"=>"Script ID"}}}, {"path"=>"/_scripts/{id}/{context}", "methods"=>["PUT", "POST"], "parts"=>{"id"=>{"type"=>"string", "description"=>"Script ID"}, "context"=>{"type"=>"string", "description"=>"Script context"}}}]}, "params"=>{"timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}, "master_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to master", "deprecated"=>{"version"=>"2.0.0", "description"=>"To support inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to cluster-manager node"}, "context"=>{"type"=>"string", "description"=>"Context name to compile script against"}}, "body"=>{"description"=>"The document", "required"=>true}}
  request(api_name, api_spec, params)
end

#rank_eval(params = {}) ⇒ Object

rank_eval href="https://www.elastic.co/guide/en/elasticsearch/reference/master/search-rank-eval.html">www.elastic.co/guide/en/elasticsearch/reference/master/search-rank-eval.html”, “description”=>“Allows to evaluate the quality of ranked search results over a set of typical search queries”



1077
1078
1079
1080
1081
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 1077

def rank_eval(params = {})
  api_name = 'rank_eval'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/search-rank-eval.html", "description"=>"Allows to evaluate the quality of ranked search results over a set of typical search queries"}, "stability"=>"experimental", "url"=>{"paths"=>[{"path"=>"/_rank_eval", "methods"=>["GET", "POST"]}, {"path"=>"/{index}/_rank_eval", "methods"=>["GET", "POST"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices"}}}]}, "params"=>{"ignore_unavailable"=>{"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices"=>{"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards"=>{"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "search_type"=>{"type"=>"enum", "options"=>["query_then_fetch", "dfs_query_then_fetch"], "description"=>"Search operation type"}}, "body"=>{"description"=>"The ranking evaluation search definition, including search requests, document ratings and ranking metric definition.", "required"=>true}}
  request(api_name, api_spec, params)
end

#reindex(params = {}) ⇒ Object

reindex href="https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html">www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html”, “description”=>“Allows to copy documents from one index to another, optionally filtering the sourcendocuments by a query, changing the destination index settings, or fetching thendocuments from a remote cluster.”



1085
1086
1087
1088
1089
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 1085

def reindex(params = {})
  api_name = 'reindex'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html", "description"=>"Allows to copy documents from one index to another, optionally filtering the source\ndocuments by a query, changing the destination index settings, or fetching the\ndocuments from a remote cluster."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_reindex", "methods"=>["POST"]}]}, "params"=>{"refresh"=>{"type"=>"boolean", "description"=>"Should the affected indexes be refreshed?"}, "timeout"=>{"type"=>"time", "default"=>"1m", "description"=>"Time each individual bulk request should wait for shards that are unavailable."}, "wait_for_active_shards"=>{"type"=>"string", "description"=>"Sets the number of shard copies that must be active before proceeding with the reindex operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)"}, "wait_for_completion"=>{"type"=>"boolean", "default"=>true, "description"=>"Should the request should block until the reindex is complete."}, "requests_per_second"=>{"type"=>"number", "default"=>0, "description"=>"The throttle to set on this request in sub-requests per second. -1 means no throttle."}, "scroll"=>{"type"=>"time", "description"=>"Control how long to keep the search context alive", "default"=>"5m"}, "slices"=>{"type"=>"number|string", "default"=>1, "description"=>"The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`."}, "max_docs"=>{"type"=>"number", "description"=>"Maximum number of documents to process (default: all documents)"}}, "body"=>{"description"=>"The search definition using the Query DSL and the prototype for the index request.", "required"=>true}}
  request(api_name, api_spec, params)
end

#reindex_rethrottle(params = {}) ⇒ Object

reindex_rethrottle href="https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html">www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html”, “description”=>“Changes the number of requests per second for a particular Reindex operation.”



1093
1094
1095
1096
1097
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 1093

def reindex_rethrottle(params = {})
  api_name = 'reindex_rethrottle'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html", "description"=>"Changes the number of requests per second for a particular Reindex operation."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_reindex/{task_id}/_rethrottle", "methods"=>["POST"], "parts"=>{"task_id"=>{"type"=>"string", "description"=>"The task id to rethrottle"}}}]}, "params"=>{"requests_per_second"=>{"type"=>"number", "required"=>true, "description"=>"The throttle to set on this request in floating sub-requests per second. -1 means set no throttle."}}}
  request(api_name, api_spec, params)
end

#remote_store_restore(params = {}) ⇒ Object

remote_store.restore href="https://opensearch.org/docs/latest/opensearch/rest-api/remote-store#restore">opensearch.org/docs/latest/opensearch/rest-api/remote-store#restore”, “description”=>“Restores from remote store.”



1101
1102
1103
1104
1105
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 1101

def remote_store_restore(params = {})
  api_name = 'remote_store.restore'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://opensearch.org/docs/latest/opensearch/rest-api/remote-store#restore", "description"=>"Restores from remote store."}, "stability"=>"experimental", "url"=>{"paths"=>[{"path"=>"/_remotestore/_restore", "methods"=>["POST"]}]}, "params"=>{"cluster_manager_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to cluster-manager node"}, "wait_for_completion"=>{"type"=>"boolean", "description"=>"Should this request wait until the operation has completed before returning", "default"=>false}}, "body"=>{"description"=>"A comma separated list of index IDs", "required"=>true}}
  request(api_name, api_spec, params)
end

#remote_store_stats(params = {}) ⇒ Object

remote_store.stats href="https://opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/remote">opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/remote”, “description”=>“Stats for remote store.”



1109
1110
1111
1112
1113
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 1109

def remote_store_stats(params = {})
  api_name = 'remote_store.stats'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/remote", "description"=>"Stats for remote store."}, "stability"=>"experimental", "url"=>{"paths"=>[{"path"=>"/_remotestore/stats/{index}", "methods"=>["GET"], "parts"=>{"index"=>{"type"=>"string", "description"=>"Index name to fetch stats"}}}, {"path"=>"/_remotestore/stats/{index}/{shard_id}", "methods"=>["GET"], "parts"=>{"index"=>{"type"=>"string", "description"=>"Index name to fetch stats"}, "shard_id"=>{"type"=>"string", "description"=>"Specific shard to fetch stats"}}}]}, "params"=>{"timeout"=>{"type"=>"time", "default"=>"10s", "description"=>"Max time each individual stats request should take."}}}
  request(api_name, api_spec, params)
end

#render_search_template(params = {}) ⇒ Object

render_search_template href="https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html#_validating_templates">www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html#_validating_templates”, “description”=>“Allows to use the Mustache language to pre-render a search definition.”



1117
1118
1119
1120
1121
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 1117

def render_search_template(params = {})
  api_name = 'render_search_template'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html#_validating_templates", "description"=>"Allows to use the Mustache language to pre-render a search definition."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_render/template", "methods"=>["GET", "POST"]}, {"path"=>"/_render/template/{id}", "methods"=>["GET", "POST"], "parts"=>{"id"=>{"type"=>"string", "description"=>"The id of the stored search template"}}}]}, "body"=>{"description"=>"The search definition template and its params"}}
  request(api_name, api_spec, params)
end

#scripts_painless_execute(params = {}) ⇒ Object

scripts_painless_execute href="https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-execute-api.html">www.elastic.co/guide/en/elasticsearch/painless/master/painless-execute-api.html”, “description”=>“Allows an arbitrary script to be executed and a result to be returned”



1125
1126
1127
1128
1129
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 1125

def scripts_painless_execute(params = {})
  api_name = 'scripts_painless_execute'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-execute-api.html", "description"=>"Allows an arbitrary script to be executed and a result to be returned"}, "stability"=>"experimental", "url"=>{"paths"=>[{"path"=>"/_scripts/painless/_execute", "methods"=>["GET", "POST"]}]}, "params"=>{}, "body"=>{"description"=>"The script to execute"}}
  request(api_name, api_spec, params)
end

#scroll(params = {}) ⇒ Object

scroll href="https://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-body.html#request-body-search-scroll">www.elastic.co/guide/en/elasticsearch/reference/master/search-request-body.html#request-body-search-scroll”, “description”=>“Allows to retrieve a large numbers of results from a single search request.”



1133
1134
1135
1136
1137
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 1133

def scroll(params = {})
  api_name = 'scroll'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-body.html#request-body-search-scroll", "description"=>"Allows to retrieve a large numbers of results from a single search request."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_search/scroll", "methods"=>["GET", "POST"]}, {"path"=>"/_search/scroll/{scroll_id}", "methods"=>["GET", "POST"], "parts"=>{"scroll_id"=>{"type"=>"string", "description"=>"The scroll ID", "deprecated"=>true}}, "deprecated"=>{"version"=>"7.0.0", "description"=>"A scroll id can be quite large and should be specified as part of the body"}}]}, "params"=>{"scroll"=>{"type"=>"time", "description"=>"Specify how long a consistent view of the index should be maintained for scrolled search"}, "scroll_id"=>{"type"=>"string", "description"=>"The scroll ID for scrolled search"}, "rest_total_hits_as_int"=>{"type"=>"boolean", "description"=>"Indicates whether hits.total should be rendered as an integer or an object in the rest search response", "default"=>false}}, "body"=>{"description"=>"The scroll ID if not passed by URL or query parameter."}}
  request(api_name, api_spec, params)
end

#search(params = {}) ⇒ Object

search href="https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html">www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html”, “description”=>“Returns results matching a query.”



1141
1142
1143
1144
1145
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 1141

def search(params = {})
  api_name = 'search'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html", "description"=>"Returns results matching a query."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_search", "methods"=>["GET", "POST"]}, {"path"=>"/{index}/_search", "methods"=>["GET", "POST"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices"}}}]}, "params"=>{"analyzer"=>{"type"=>"string", "description"=>"The analyzer to use for the query string"}, "analyze_wildcard"=>{"type"=>"boolean", "description"=>"Specify whether wildcard and prefix queries should be analyzed (default: false)"}, "ccs_minimize_roundtrips"=>{"type"=>"boolean", "description"=>"Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution", "default"=>"true"}, "default_operator"=>{"type"=>"enum", "options"=>["AND", "OR"], "default"=>"OR", "description"=>"The default operator for query string query (AND or OR)"}, "df"=>{"type"=>"string", "description"=>"The field to use as default where no field prefix is given in the query string"}, "explain"=>{"type"=>"boolean", "description"=>"Specify whether to return detailed information about score computation as part of a hit"}, "stored_fields"=>{"type"=>"list", "description"=>"A comma-separated list of stored fields to return as part of a hit"}, "docvalue_fields"=>{"type"=>"list", "description"=>"A comma-separated list of fields to return as the docvalue representation of a field for each hit"}, "from"=>{"type"=>"number", "description"=>"Starting offset (default: 0)"}, "ignore_unavailable"=>{"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "ignore_throttled"=>{"type"=>"boolean", "description"=>"Whether specified concrete, expanded or aliased indices should be ignored when throttled"}, "allow_no_indices"=>{"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards"=>{"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "lenient"=>{"type"=>"boolean", "description"=>"Specify whether format-based query failures (such as providing text to a numeric field) should be ignored"}, "preference"=>{"type"=>"string", "description"=>"Specify the node or shard the operation should be performed on (default: random)"}, "q"=>{"type"=>"string", "description"=>"Query in the Lucene query string syntax"}, "routing"=>{"type"=>"list", "description"=>"A comma-separated list of specific routing values"}, "scroll"=>{"type"=>"time", "description"=>"Specify how long a consistent view of the index should be maintained for scrolled search"}, "search_type"=>{"type"=>"enum", "options"=>["query_then_fetch", "dfs_query_then_fetch"], "description"=>"Search operation type"}, "size"=>{"type"=>"number", "description"=>"Number of hits to return (default: 10)"}, "sort"=>{"type"=>"list", "description"=>"A comma-separated list of <field>:<direction> pairs"}, "_source"=>{"type"=>"list", "description"=>"True or false to return the _source field or not, or a list of fields to return"}, "_source_excludes"=>{"type"=>"list", "description"=>"A list of fields to exclude from the returned _source field"}, "_source_includes"=>{"type"=>"list", "description"=>"A list of fields to extract and return from the _source field"}, "terminate_after"=>{"type"=>"number", "description"=>"The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early."}, "stats"=>{"type"=>"list", "description"=>"Specific 'tag' of the request for logging and statistical purposes"}, "suggest_field"=>{"type"=>"string", "description"=>"Specify which field to use for suggestions"}, "suggest_mode"=>{"type"=>"enum", "options"=>["missing", "popular", "always"], "default"=>"missing", "description"=>"Specify suggest mode"}, "suggest_size"=>{"type"=>"number", "description"=>"How many suggestions to return in response"}, "suggest_text"=>{"type"=>"string", "description"=>"The source text for which the suggestions should be returned"}, "timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}, "track_scores"=>{"type"=>"boolean", "description"=>"Whether to calculate and return scores even if they are not used for sorting"}, "track_total_hits"=>{"type"=>"boolean", "description"=>"Indicate if the number of documents that match the query should be tracked"}, "allow_partial_search_results"=>{"type"=>"boolean", "default"=>true, "description"=>"Indicate if an error should be returned if there is a partial search failure or timeout"}, "typed_keys"=>{"type"=>"boolean", "description"=>"Specify whether aggregation and suggester names should be prefixed by their respective types in the response"}, "version"=>{"type"=>"boolean", "description"=>"Specify whether to return document version as part of a hit"}, "seq_no_primary_term"=>{"type"=>"boolean", "description"=>"Specify whether to return sequence number and primary term of the last modification of each hit"}, "request_cache"=>{"type"=>"boolean", "description"=>"Specify if request cache should be used for this request or not, defaults to index level setting"}, "batched_reduce_size"=>{"type"=>"number", "description"=>"The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.", "default"=>512}, "max_concurrent_shard_requests"=>{"type"=>"number", "description"=>"The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests", "default"=>5}, "pre_filter_shard_size"=>{"type"=>"number", "description"=>"A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint."}, "rest_total_hits_as_int"=>{"type"=>"boolean", "description"=>"Indicates whether hits.total should be rendered as an integer or an object in the rest search response", "default"=>false}, "search_pipeline"=>{"type"=>"string", "description"=>"The search pipeline to use to execute this request"}, "include_named_queries_score"=>{"type"=>"boolean", "description"=>"Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false)", "default"=>false}}, "body"=>{"description"=>"The search definition using the Query DSL"}}
  request(api_name, api_spec, params)
end

#search_pipeline_delete(params = {}) ⇒ Object

search_pipeline.delete a search pipeline.”, “url”=>“opensearch.org/docs/latest/opensearch/rest-api/search_pipelines/”



1149
1150
1151
1152
1153
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 1149

def search_pipeline_delete(params = {})
  api_name = 'search_pipeline.delete'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"description"=>"Deletes a search pipeline.", "url"=>"https://opensearch.org/docs/latest/opensearch/rest-api/search_pipelines/"}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_search/pipeline/{id}", "methods"=>["DELETE"], "parts"=>{"id"=>{"type"=>"string", "description"=>"Pipeline ID"}}}]}, "params"=>{"cluster_manager_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to cluster-manager node"}, "timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}}}
  request(api_name, api_spec, params)
end

#search_pipeline_get(params = {}) ⇒ Object

search_pipeline.get a search pipeline”, “url”=>“opensearch.org/docs/latest/opensearch/rest-api/search_pipelines/”



1157
1158
1159
1160
1161
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 1157

def search_pipeline_get(params = {})
  api_name = 'search_pipeline.get'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"description"=>"Returns a search pipeline", "url"=>"https://opensearch.org/docs/latest/opensearch/rest-api/search_pipelines/"}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_search/pipeline", "methods"=>["GET"]}, {"path"=>"/_search/pipeline/{id}", "methods"=>["GET"], "parts"=>{"id"=>{"type"=>"string", "description"=>"Comma-separated list of search pipeline ids. Wildcards supported."}}}]}, "params"=>{"cluster_manager_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to cluster-manager node"}}}
  request(api_name, api_spec, params)
end

#search_pipeline_put(params = {}) ⇒ Object

search_pipeline.put or updates a search pipeline.”, “url”=>“opensearch.org/docs/latest/opensearch/rest-api/search_pipelines/”



1165
1166
1167
1168
1169
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 1165

def search_pipeline_put(params = {})
  api_name = 'search_pipeline.put'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"description"=>"Creates or updates a search pipeline.", "url"=>"https://opensearch.org/docs/latest/opensearch/rest-api/search_pipelines/"}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_search/pipeline/{id}", "methods"=>["PUT"], "parts"=>{"id"=>{"type"=>"string", "description"=>"Pipeline ID"}}}]}, "params"=>{"cluster_manager_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to cluster-manager node"}, "timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}}, "body"=>{"description"=>"The search pipeline definition", "required"=>true}}
  request(api_name, api_spec, params)
end

#search_shards(params = {}) ⇒ Object

search_shards href="https://www.elastic.co/guide/en/elasticsearch/reference/master/search-shards.html">www.elastic.co/guide/en/elasticsearch/reference/master/search-shards.html”, “description”=>“Returns information about the indices and shards that a search request would be executed against.”



1173
1174
1175
1176
1177
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 1173

def search_shards(params = {})
  api_name = 'search_shards'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/search-shards.html", "description"=>"Returns information about the indices and shards that a search request would be executed against."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_search_shards", "methods"=>["GET", "POST"]}, {"path"=>"/{index}/_search_shards", "methods"=>["GET", "POST"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices"}}}]}, "params"=>{"preference"=>{"type"=>"string", "description"=>"Specify the node or shard the operation should be performed on (default: random)"}, "routing"=>{"type"=>"string", "description"=>"Specific routing value"}, "local"=>{"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, "ignore_unavailable"=>{"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices"=>{"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards"=>{"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}}}
  request(api_name, api_spec, params)
end

#search_template(params = {}) ⇒ Object

search_template href="https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html">www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html”, “description”=>“Allows to use the Mustache language to pre-render a search definition.”



1181
1182
1183
1184
1185
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 1181

def search_template(params = {})
  api_name = 'search_template'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html", "description"=>"Allows to use the Mustache language to pre-render a search definition."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_search/template", "methods"=>["GET", "POST"]}, {"path"=>"/{index}/_search/template", "methods"=>["GET", "POST"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices"}}}]}, "params"=>{"ignore_unavailable"=>{"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "ignore_throttled"=>{"type"=>"boolean", "description"=>"Whether specified concrete, expanded or aliased indices should be ignored when throttled"}, "allow_no_indices"=>{"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards"=>{"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "preference"=>{"type"=>"string", "description"=>"Specify the node or shard the operation should be performed on (default: random)"}, "routing"=>{"type"=>"list", "description"=>"A comma-separated list of specific routing values"}, "scroll"=>{"type"=>"time", "description"=>"Specify how long a consistent view of the index should be maintained for scrolled search"}, "search_type"=>{"type"=>"enum", "options"=>["query_then_fetch", "query_and_fetch", "dfs_query_then_fetch", "dfs_query_and_fetch"], "description"=>"Search operation type"}, "explain"=>{"type"=>"boolean", "description"=>"Specify whether to return detailed information about score computation as part of a hit"}, "profile"=>{"type"=>"boolean", "description"=>"Specify whether to profile the query execution"}, "typed_keys"=>{"type"=>"boolean", "description"=>"Specify whether aggregation and suggester names should be prefixed by their respective types in the response"}, "rest_total_hits_as_int"=>{"type"=>"boolean", "description"=>"Indicates whether hits.total should be rendered as an integer or an object in the rest search response", "default"=>false}, "ccs_minimize_roundtrips"=>{"type"=>"boolean", "description"=>"Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution", "default"=>"true"}}, "body"=>{"description"=>"The search definition template and its params", "required"=>true}}
  request(api_name, api_spec, params)
end

#snapshot_cleanup_repository(params = {}) ⇒ Object

snapshot.cleanup_repository href="https://www.elastic.co/guide/en/elasticsearch/reference/master/clean-up-snapshot-repo-api.html">www.elastic.co/guide/en/elasticsearch/reference/master/clean-up-snapshot-repo-api.html”, “description”=>“Removes stale data from repository.”



1189
1190
1191
1192
1193
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 1189

def snapshot_cleanup_repository(params = {})
  api_name = 'snapshot.cleanup_repository'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/clean-up-snapshot-repo-api.html", "description"=>"Removes stale data from repository."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_snapshot/{repository}/_cleanup", "methods"=>["POST"], "parts"=>{"repository"=>{"type"=>"string", "description"=>"A repository name"}}}]}, "params"=>{"master_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to master node", "deprecated"=>{"version"=>"2.0.0", "description"=>"To support inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to cluster-manager node"}, "timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}}}
  request(api_name, api_spec, params)
end

#snapshot_clone(params = {}) ⇒ Object

snapshot.clone href="https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html">www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html”, “description”=>“Clones indices from one snapshot into another snapshot in the same repository.”



1197
1198
1199
1200
1201
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 1197

def snapshot_clone(params = {})
  api_name = 'snapshot.clone'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "description"=>"Clones indices from one snapshot into another snapshot in the same repository."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_snapshot/{repository}/{snapshot}/_clone/{target_snapshot}", "methods"=>["PUT"], "parts"=>{"repository"=>{"type"=>"string", "description"=>"A repository name"}, "snapshot"=>{"type"=>"string", "description"=>"The name of the snapshot to clone from"}, "target_snapshot"=>{"type"=>"string", "description"=>"The name of the cloned snapshot to create"}}}]}, "params"=>{"master_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to master node", "deprecated"=>{"version"=>"2.0.0", "description"=>"To support inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to cluster-manager node"}}, "body"=>{"description"=>"The snapshot clone definition", "required"=>true}}
  request(api_name, api_spec, params)
end

#snapshot_create(params = {}) ⇒ Object

snapshot.create href="https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html">www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html”, “description”=>“Creates a snapshot in a repository.”



1205
1206
1207
1208
1209
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 1205

def snapshot_create(params = {})
  api_name = 'snapshot.create'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "description"=>"Creates a snapshot in a repository."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_snapshot/{repository}/{snapshot}", "methods"=>["PUT", "POST"], "parts"=>{"repository"=>{"type"=>"string", "description"=>"A repository name"}, "snapshot"=>{"type"=>"string", "description"=>"A snapshot name"}}}]}, "params"=>{"master_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to master node", "deprecated"=>{"version"=>"2.0.0", "description"=>"To support inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to cluster-manager node"}, "wait_for_completion"=>{"type"=>"boolean", "description"=>"Should this request wait until the operation has completed before returning", "default"=>false}}, "body"=>{"description"=>"The snapshot definition", "required"=>false}}
  request(api_name, api_spec, params)
end

#snapshot_create_repository(params = {}) ⇒ Object

snapshot.create_repository href="https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html">www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html”, “description”=>“Creates a repository.”



1213
1214
1215
1216
1217
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 1213

def snapshot_create_repository(params = {})
  api_name = 'snapshot.create_repository'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "description"=>"Creates a repository."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_snapshot/{repository}", "methods"=>["PUT", "POST"], "parts"=>{"repository"=>{"type"=>"string", "description"=>"A repository name"}}}]}, "params"=>{"master_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to master node", "deprecated"=>{"version"=>"2.0.0", "description"=>"To support inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to cluster-manager node"}, "timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}, "verify"=>{"type"=>"boolean", "description"=>"Whether to verify the repository after creation"}}, "body"=>{"description"=>"The repository definition", "required"=>true}}
  request(api_name, api_spec, params)
end

#snapshot_delete(params = {}) ⇒ Object

snapshot.delete href="https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html">www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html”, “description”=>“Deletes a snapshot.”



1221
1222
1223
1224
1225
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 1221

def snapshot_delete(params = {})
  api_name = 'snapshot.delete'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "description"=>"Deletes a snapshot."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_snapshot/{repository}/{snapshot}", "methods"=>["DELETE"], "parts"=>{"repository"=>{"type"=>"string", "description"=>"A repository name"}, "snapshot"=>{"type"=>"string", "description"=>"A snapshot name"}}}]}, "params"=>{"master_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to master node", "deprecated"=>{"version"=>"2.0.0", "description"=>"To support inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to cluster-manager node"}}}
  request(api_name, api_spec, params)
end

#snapshot_delete_repository(params = {}) ⇒ Object

snapshot.delete_repository href="https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html">www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html”, “description”=>“Deletes a repository.”



1229
1230
1231
1232
1233
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 1229

def snapshot_delete_repository(params = {})
  api_name = 'snapshot.delete_repository'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "description"=>"Deletes a repository."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_snapshot/{repository}", "methods"=>["DELETE"], "parts"=>{"repository"=>{"type"=>"list", "description"=>"Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported."}}}]}, "params"=>{"master_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to master node", "deprecated"=>{"version"=>"2.0.0", "description"=>"To support inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to cluster-manager node"}, "timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}}}
  request(api_name, api_spec, params)
end

#snapshot_get(params = {}) ⇒ Object

snapshot.get href="https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html">www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html”, “description”=>“Returns information about a snapshot.”



1237
1238
1239
1240
1241
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 1237

def snapshot_get(params = {})
  api_name = 'snapshot.get'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "description"=>"Returns information about a snapshot."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_snapshot/{repository}/{snapshot}", "methods"=>["GET"], "parts"=>{"repository"=>{"type"=>"string", "description"=>"A repository name"}, "snapshot"=>{"type"=>"list", "description"=>"A comma-separated list of snapshot names"}}}]}, "params"=>{"master_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to master node", "deprecated"=>{"version"=>"2.0.0", "description"=>"To support inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to cluster-manager node"}, "ignore_unavailable"=>{"type"=>"boolean", "description"=>"Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown"}, "verbose"=>{"type"=>"boolean", "description"=>"Whether to show verbose snapshot info or only show the basic info found in the repository index blob"}}}
  request(api_name, api_spec, params)
end

#snapshot_get_repository(params = {}) ⇒ Object

snapshot.get_repository href="https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html">www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html”, “description”=>“Returns information about a repository.”



1245
1246
1247
1248
1249
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 1245

def snapshot_get_repository(params = {})
  api_name = 'snapshot.get_repository'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "description"=>"Returns information about a repository."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_snapshot", "methods"=>["GET"]}, {"path"=>"/_snapshot/{repository}", "methods"=>["GET"], "parts"=>{"repository"=>{"type"=>"list", "description"=>"A comma-separated list of repository names"}}}]}, "params"=>{"master_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to master node", "deprecated"=>{"version"=>"2.0.0", "description"=>"To support inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to cluster-manager node"}, "local"=>{"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}}}
  request(api_name, api_spec, params)
end

#snapshot_restore(params = {}) ⇒ Object

snapshot.restore href="https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html">www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html”, “description”=>“Restores a snapshot.”



1253
1254
1255
1256
1257
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 1253

def snapshot_restore(params = {})
  api_name = 'snapshot.restore'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "description"=>"Restores a snapshot."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_snapshot/{repository}/{snapshot}/_restore", "methods"=>["POST"], "parts"=>{"repository"=>{"type"=>"string", "description"=>"A repository name"}, "snapshot"=>{"type"=>"string", "description"=>"A snapshot name"}}}]}, "params"=>{"master_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to master node", "deprecated"=>{"version"=>"2.0.0", "description"=>"To support inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to cluster-manager node"}, "wait_for_completion"=>{"type"=>"boolean", "description"=>"Should this request wait until the operation has completed before returning", "default"=>false}, "source_remote_store_repository"=>{"type"=>"string", "description"=>"Remote Store Repository of Remote Store Indices"}}, "body"=>{"description"=>"Details of what to restore", "required"=>false}}
  request(api_name, api_spec, params)
end

#snapshot_status(params = {}) ⇒ Object

snapshot.status href="https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html">www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html”, “description”=>“Returns information about the status of a snapshot.”



1261
1262
1263
1264
1265
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 1261

def snapshot_status(params = {})
  api_name = 'snapshot.status'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "description"=>"Returns information about the status of a snapshot."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_snapshot/_status", "methods"=>["GET"]}, {"path"=>"/_snapshot/{repository}/_status", "methods"=>["GET"], "parts"=>{"repository"=>{"type"=>"string", "description"=>"A repository name"}}}, {"path"=>"/_snapshot/{repository}/{snapshot}/_status", "methods"=>["GET"], "parts"=>{"repository"=>{"type"=>"string", "description"=>"A repository name"}, "snapshot"=>{"type"=>"list", "description"=>"A comma-separated list of snapshot names"}}}]}, "params"=>{"master_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to master node", "deprecated"=>{"version"=>"2.0.0", "description"=>"To support inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to cluster-manager node"}, "ignore_unavailable"=>{"type"=>"boolean", "description"=>"Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown"}}}
  request(api_name, api_spec, params)
end

#snapshot_verify_repository(params = {}) ⇒ Object

snapshot.verify_repository href="https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html">www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html”, “description”=>“Verifies a repository.”



1269
1270
1271
1272
1273
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 1269

def snapshot_verify_repository(params = {})
  api_name = 'snapshot.verify_repository'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "description"=>"Verifies a repository."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_snapshot/{repository}/_verify", "methods"=>["POST"], "parts"=>{"repository"=>{"type"=>"string", "description"=>"A repository name"}}}]}, "params"=>{"master_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to master node", "deprecated"=>{"version"=>"2.0.0", "description"=>"To support inclusive language, use 'cluster_manager_timeout' instead."}}, "cluster_manager_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to cluster-manager node"}, "timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}}}
  request(api_name, api_spec, params)
end

#tasks_cancel(params = {}) ⇒ Object

tasks.cancel href="https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html">www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html”, “description”=>“Cancels a task, if it can be cancelled through an API.”



1277
1278
1279
1280
1281
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 1277

def tasks_cancel(params = {})
  api_name = 'tasks.cancel'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html", "description"=>"Cancels a task, if it can be cancelled through an API."}, "stability"=>"experimental", "url"=>{"paths"=>[{"path"=>"/_tasks/_cancel", "methods"=>["POST"]}, {"path"=>"/_tasks/{task_id}/_cancel", "methods"=>["POST"], "parts"=>{"task_id"=>{"type"=>"string", "description"=>"Cancel the task with specified task id (node_id:task_number)"}}}]}, "params"=>{"nodes"=>{"type"=>"list", "description"=>"A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes"}, "actions"=>{"type"=>"list", "description"=>"A comma-separated list of actions that should be cancelled. Leave empty to cancel all."}, "parent_task_id"=>{"type"=>"string", "description"=>"Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all."}, "wait_for_completion"=>{"type"=>"boolean", "description"=>"Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false"}}}
  request(api_name, api_spec, params)
end

#tasks_get(params = {}) ⇒ Object

tasks.get href="https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html">www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html”, “description”=>“Returns information about a task.”



1285
1286
1287
1288
1289
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 1285

def tasks_get(params = {})
  api_name = 'tasks.get'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html", "description"=>"Returns information about a task."}, "stability"=>"experimental", "url"=>{"paths"=>[{"path"=>"/_tasks/{task_id}", "methods"=>["GET"], "parts"=>{"task_id"=>{"type"=>"string", "description"=>"Return the task with specified id (node_id:task_number)"}}}]}, "params"=>{"wait_for_completion"=>{"type"=>"boolean", "description"=>"Wait for the matching tasks to complete (default: false)"}, "timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}}}
  request(api_name, api_spec, params)
end

#tasks_list(params = {}) ⇒ Object

tasks.list href="https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html">www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html”, “description”=>“Returns a list of tasks.”



1293
1294
1295
1296
1297
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 1293

def tasks_list(params = {})
  api_name = 'tasks.list'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html", "description"=>"Returns a list of tasks."}, "stability"=>"experimental", "url"=>{"paths"=>[{"path"=>"/_tasks", "methods"=>["GET"]}]}, "params"=>{"nodes"=>{"type"=>"list", "description"=>"A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes"}, "actions"=>{"type"=>"list", "description"=>"A comma-separated list of actions that should be returned. Leave empty to return all."}, "detailed"=>{"type"=>"boolean", "description"=>"Return detailed task information (default: false)"}, "parent_task_id"=>{"type"=>"string", "description"=>"Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all."}, "wait_for_completion"=>{"type"=>"boolean", "description"=>"Wait for the matching tasks to complete (default: false)"}, "group_by"=>{"type"=>"enum", "description"=>"Group tasks by nodes or parent/child relationships", "options"=>["nodes", "parents", "none"], "default"=>"nodes"}, "timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}}}
  request(api_name, api_spec, params)
end

#termvectors(params = {}) ⇒ Object

termvectors href="https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html">www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html”, “description”=>“Returns information and statistics about terms in the fields of a particular document.”



1301
1302
1303
1304
1305
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 1301

def termvectors(params = {})
  api_name = 'termvectors'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html", "description"=>"Returns information and statistics about terms in the fields of a particular document."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/{index}/_termvectors/{id}", "methods"=>["GET", "POST"], "parts"=>{"index"=>{"type"=>"string", "description"=>"The index in which the document resides."}, "id"=>{"type"=>"string", "description"=>"The id of the document, when not specified a doc param should be supplied."}}}, {"path"=>"/{index}/_termvectors", "methods"=>["GET", "POST"], "parts"=>{"index"=>{"type"=>"string", "description"=>"The index in which the document resides."}}}]}, "params"=>{"term_statistics"=>{"type"=>"boolean", "description"=>"Specifies if total term frequency and document frequency should be returned.", "default"=>false}, "field_statistics"=>{"type"=>"boolean", "description"=>"Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.", "default"=>true}, "fields"=>{"type"=>"list", "description"=>"A comma-separated list of fields to return."}, "offsets"=>{"type"=>"boolean", "description"=>"Specifies if term offsets should be returned.", "default"=>true}, "positions"=>{"type"=>"boolean", "description"=>"Specifies if term positions should be returned.", "default"=>true}, "payloads"=>{"type"=>"boolean", "description"=>"Specifies if term payloads should be returned.", "default"=>true}, "preference"=>{"type"=>"string", "description"=>"Specify the node or shard the operation should be performed on (default: random)."}, "routing"=>{"type"=>"string", "description"=>"Specific routing value."}, "realtime"=>{"type"=>"boolean", "description"=>"Specifies if request is real-time as opposed to near-real-time (default: true)."}, "version"=>{"type"=>"number", "description"=>"Explicit version number for concurrency control"}, "version_type"=>{"type"=>"enum", "options"=>["internal", "external", "external_gte", "force"], "description"=>"Specific version type"}}, "body"=>{"description"=>"Define parameters and or supply a document to get termvectors for. See documentation.", "required"=>false}}
  request(api_name, api_spec, params)
end

#update(params = {}) ⇒ Object

update href="https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html">www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html”, “description”=>“Updates a document with a script or partial document.”



1309
1310
1311
1312
1313
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 1309

def update(params = {})
  api_name = 'update'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html", "description"=>"Updates a document with a script or partial document."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/{index}/_update/{id}", "methods"=>["POST"], "parts"=>{"id"=>{"type"=>"string", "description"=>"Document ID"}, "index"=>{"type"=>"string", "description"=>"The name of the index"}}}]}, "params"=>{"wait_for_active_shards"=>{"type"=>"string", "description"=>"Sets the number of shard copies that must be active before proceeding with the update operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)"}, "_source"=>{"type"=>"list", "description"=>"True or false to return the _source field or not, or a list of fields to return"}, "_source_excludes"=>{"type"=>"list", "description"=>"A list of fields to exclude from the returned _source field"}, "_source_includes"=>{"type"=>"list", "description"=>"A list of fields to extract and return from the _source field"}, "lang"=>{"type"=>"string", "description"=>"The script language (default: painless)"}, "refresh"=>{"type"=>"enum", "options"=>["true", "false", "wait_for"], "description"=>"If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes."}, "retry_on_conflict"=>{"type"=>"number", "description"=>"Specify how many times should the operation be retried when a conflict occurs (default: 0)"}, "routing"=>{"type"=>"string", "description"=>"Specific routing value"}, "timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}, "if_seq_no"=>{"type"=>"number", "description"=>"only perform the update operation if the last operation that has changed the document has the specified sequence number"}, "if_primary_term"=>{"type"=>"number", "description"=>"only perform the update operation if the last operation that has changed the document has the specified primary term"}, "require_alias"=>{"type"=>"boolean", "description"=>"When true, requires destination is an alias. Default is false"}}, "body"=>{"description"=>"The request definition requires either `script` or partial `doc`", "required"=>true}}
  request(api_name, api_spec, params)
end

#update_by_query(params = {}) ⇒ Object

update_by_query href="https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-query.html">www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-query.html”, “description”=>“Performs an update on every document in the index without changing the source,nfor example to pick up a mapping change.”



1317
1318
1319
1320
1321
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 1317

def update_by_query(params = {})
  api_name = 'update_by_query'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-query.html", "description"=>"Performs an update on every document in the index without changing the source,\nfor example to pick up a mapping change."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/{index}/_update_by_query", "methods"=>["POST"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices"}}}]}, "params"=>{"analyzer"=>{"type"=>"string", "description"=>"The analyzer to use for the query string"}, "analyze_wildcard"=>{"type"=>"boolean", "description"=>"Specify whether wildcard and prefix queries should be analyzed (default: false)"}, "default_operator"=>{"type"=>"enum", "options"=>["AND", "OR"], "default"=>"OR", "description"=>"The default operator for query string query (AND or OR)"}, "df"=>{"type"=>"string", "description"=>"The field to use as default where no field prefix is given in the query string"}, "from"=>{"type"=>"number", "description"=>"Starting offset (default: 0)"}, "ignore_unavailable"=>{"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices"=>{"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "conflicts"=>{"type"=>"enum", "options"=>["abort", "proceed"], "default"=>"abort", "description"=>"What to do when the update by query hits version conflicts?"}, "expand_wildcards"=>{"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "lenient"=>{"type"=>"boolean", "description"=>"Specify whether format-based query failures (such as providing text to a numeric field) should be ignored"}, "pipeline"=>{"type"=>"string", "description"=>"Ingest pipeline to set on index requests made by this action. (default: none)"}, "preference"=>{"type"=>"string", "description"=>"Specify the node or shard the operation should be performed on (default: random)"}, "q"=>{"type"=>"string", "description"=>"Query in the Lucene query string syntax"}, "routing"=>{"type"=>"list", "description"=>"A comma-separated list of specific routing values"}, "scroll"=>{"type"=>"time", "description"=>"Specify how long a consistent view of the index should be maintained for scrolled search"}, "search_type"=>{"type"=>"enum", "options"=>["query_then_fetch", "dfs_query_then_fetch"], "description"=>"Search operation type"}, "search_timeout"=>{"type"=>"time", "description"=>"Explicit timeout for each search request. Defaults to no timeout."}, "size"=>{"type"=>"number", "description"=>"Deprecated, please use `max_docs` instead"}, "max_docs"=>{"type"=>"number", "description"=>"Maximum number of documents to process (default: all documents)"}, "sort"=>{"type"=>"list", "description"=>"A comma-separated list of <field>:<direction> pairs"}, "_source"=>{"type"=>"list", "description"=>"True or false to return the _source field or not, or a list of fields to return"}, "_source_excludes"=>{"type"=>"list", "description"=>"A list of fields to exclude from the returned _source field"}, "_source_includes"=>{"type"=>"list", "description"=>"A list of fields to extract and return from the _source field"}, "terminate_after"=>{"type"=>"number", "description"=>"The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early."}, "stats"=>{"type"=>"list", "description"=>"Specific 'tag' of the request for logging and statistical purposes"}, "version"=>{"type"=>"boolean", "description"=>"Specify whether to return document version as part of a hit"}, "version_type"=>{"type"=>"boolean", "description"=>"Should the document increment the version number (internal) on hit or not (reindex)"}, "request_cache"=>{"type"=>"boolean", "description"=>"Specify if request cache should be used for this request or not, defaults to index level setting"}, "refresh"=>{"type"=>"boolean", "description"=>"Should the affected indexes be refreshed?"}, "timeout"=>{"type"=>"time", "default"=>"1m", "description"=>"Time each individual bulk request should wait for shards that are unavailable."}, "wait_for_active_shards"=>{"type"=>"string", "description"=>"Sets the number of shard copies that must be active before proceeding with the update by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)"}, "scroll_size"=>{"type"=>"number", "default"=>100, "description"=>"Size on the scroll request powering the update by query"}, "wait_for_completion"=>{"type"=>"boolean", "default"=>true, "description"=>"Should the request should block until the update by query operation is complete."}, "requests_per_second"=>{"type"=>"number", "default"=>0, "description"=>"The throttle to set on this request in sub-requests per second. -1 means no throttle."}, "slices"=>{"type"=>"number|string", "default"=>1, "description"=>"The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`."}}, "body"=>{"description"=>"The search definition using the Query DSL"}}
  request(api_name, api_spec, params)
end

#update_by_query_rethrottle(params = {}) ⇒ Object

update_by_query_rethrottle href="https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-query.html">www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-query.html”, “description”=>“Changes the number of requests per second for a particular Update By Query operation.”



1325
1326
1327
1328
1329
 
# File 'lib/antbird/rest_api/rest_api_opensearch_v2_13.rb', line 1325

def update_by_query_rethrottle(params = {})
  api_name = 'update_by_query_rethrottle'
  api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-query.html", "description"=>"Changes the number of requests per second for a particular Update By Query operation."}, "stability"=>"stable", "url"=>{"paths"=>[{"path"=>"/_update_by_query/{task_id}/_rethrottle", "methods"=>["POST"], "parts"=>{"task_id"=>{"type"=>"string", "description"=>"The task id to rethrottle"}}}]}, "params"=>{"requests_per_second"=>{"type"=>"number", "required"=>true, "description"=>"The throttle to set on this request in floating sub-requests per second. -1 means set no throttle."}}}
  request(api_name, api_spec, params)
end