antbird 0.3.0 → 0.4.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,3142 @@
1
+ # Generated REST API methods file - DO NOT EDIT!
2
+ # Date: 2021-08-12
3
+ # ES version: 7.14.0
4
+
5
+ module Antbird
6
+ module RestApi
7
+ module RestApiV7_14
8
+ def common_params
9
+ @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."}}}
10
+ end
11
+
12
+ # async_search.delete
13
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html", "description"=>"Deletes an async search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted."}
14
+ def async_search_delete(params = {})
15
+ api_name = 'async_search.delete'
16
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html", "description"=>"Deletes an async search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_async_search/{id}", "methods"=>["DELETE"], "parts"=>{"id"=>{"type"=>"string", "description"=>"The async search ID"}}}]}}
17
+ request(api_name, api_spec, params)
18
+ end
19
+
20
+ # async_search.get
21
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html", "description"=>"Retrieves the results of a previously submitted async search request given its ID."}
22
+ def async_search_get(params = {})
23
+ api_name = 'async_search.get'
24
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html", "description"=>"Retrieves the results of a previously submitted async search request given its ID."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_async_search/{id}", "methods"=>["GET"], "parts"=>{"id"=>{"type"=>"string", "description"=>"The async search ID"}}}]}, "params"=>{"wait_for_completion_timeout"=>{"type"=>"time", "description"=>"Specify the time that the request should block waiting for the final response"}, "keep_alive"=>{"type"=>"time", "description"=>"Specify the time interval in which the results (partial or final) for this search will be available"}, "typed_keys"=>{"type"=>"boolean", "description"=>"Specify whether aggregation and suggester names should be prefixed by their respective types in the response"}}}
25
+ request(api_name, api_spec, params)
26
+ end
27
+
28
+ # async_search.status
29
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html", "description"=>"Retrieves the status of a previously submitted async search request given its ID."}
30
+ def async_search_status(params = {})
31
+ api_name = 'async_search.status'
32
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html", "description"=>"Retrieves the status of a previously submitted async search request given its ID."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_async_search/status/{id}", "methods"=>["GET"], "parts"=>{"id"=>{"type"=>"string", "description"=>"The async search ID"}}}]}}
33
+ request(api_name, api_spec, params)
34
+ end
35
+
36
+ # async_search.submit
37
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html", "description"=>"Executes a search request asynchronously."}
38
+ def async_search_submit(params = {})
39
+ api_name = 'async_search.submit'
40
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html", "description"=>"Executes a search request asynchronously."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_async_search", "methods"=>["POST"]}, {"path"=>"/{index}/_async_search", "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"=>{"wait_for_completion_timeout"=>{"type"=>"time", "description"=>"Specify the time that the request should block waiting for the final response", "default"=>"1s"}, "keep_on_completion"=>{"type"=>"boolean", "description"=>"Control whether the response should be stored in the cluster if it completed within the provided [wait_for_completion] time (default: false)", "default"=>false}, "keep_alive"=>{"type"=>"time", "description"=>"Update the time interval in which the results (partial or final) for this search will be available", "default"=>"5d"}, "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 the granularity at which progress results will be made available.", "default"=>5}, "request_cache"=>{"type"=>"boolean", "description"=>"Specify if request cache should be used for this request or not, defaults to true"}, "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"}, "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"}, "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"}, "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}}, "body"=>{"description"=>"The search definition using the Query DSL"}}
41
+ request(api_name, api_spec, params)
42
+ end
43
+
44
+ # autoscaling.delete_autoscaling_policy
45
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-delete-autoscaling-policy.html", "description"=>"Deletes an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported."}
46
+ def autoscaling_delete_autoscaling_policy(params = {})
47
+ api_name = 'autoscaling.delete_autoscaling_policy'
48
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-delete-autoscaling-policy.html", "description"=>"Deletes an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_autoscaling/policy/{name}", "methods"=>["DELETE"], "parts"=>{"name"=>{"type"=>"string", "description"=>"the name of the autoscaling policy"}}}]}}
49
+ request(api_name, api_spec, params)
50
+ end
51
+
52
+ # autoscaling.get_autoscaling_capacity
53
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-capacity.html", "description"=>"Gets the current autoscaling capacity based on the configured autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported."}
54
+ def autoscaling_get_autoscaling_capacity(params = {})
55
+ api_name = 'autoscaling.get_autoscaling_capacity'
56
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-capacity.html", "description"=>"Gets the current autoscaling capacity based on the configured autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_autoscaling/capacity", "methods"=>["GET"]}]}}
57
+ request(api_name, api_spec, params)
58
+ end
59
+
60
+ # autoscaling.get_autoscaling_policy
61
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-policy.html", "description"=>"Retrieves an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported."}
62
+ def autoscaling_get_autoscaling_policy(params = {})
63
+ api_name = 'autoscaling.get_autoscaling_policy'
64
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-policy.html", "description"=>"Retrieves an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_autoscaling/policy/{name}", "methods"=>["GET"], "parts"=>{"name"=>{"type"=>"string", "description"=>"the name of the autoscaling policy"}}}]}}
65
+ request(api_name, api_spec, params)
66
+ end
67
+
68
+ # autoscaling.put_autoscaling_policy
69
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-put-autoscaling-policy.html", "description"=>"Creates a new autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported."}
70
+ def autoscaling_put_autoscaling_policy(params = {})
71
+ api_name = 'autoscaling.put_autoscaling_policy'
72
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-put-autoscaling-policy.html", "description"=>"Creates a new autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_autoscaling/policy/{name}", "methods"=>["PUT"], "parts"=>{"name"=>{"type"=>"string", "description"=>"the name of the autoscaling policy"}}}]}, "body"=>{"description"=>"the specification of the autoscaling policy", "required"=>true}}
73
+ request(api_name, api_spec, params)
74
+ end
75
+
76
+ # bulk
77
+ # {"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."}
78
+ def bulk(params = {})
79
+ api_name = 'bulk'
80
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/x-ndjson"]}, "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"}}}, {"path"=>"/{index}/{type}/_bulk", "methods"=>["POST", "PUT"], "parts"=>{"index"=>{"type"=>"string", "description"=>"Default index for items which don't provide one"}, "type"=>{"type"=>"string", "description"=>"Default document type 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"}}
81
+ request(api_name, api_spec, params)
82
+ end
83
+
84
+ # cat.aliases
85
+ # {"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."}
86
+ def cat_aliases(params = {})
87
+ api_name = 'cat.aliases'
88
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["text/plain", "application/json"]}, "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."}}}
89
+ request(api_name, api_spec, params)
90
+ end
91
+
92
+ # cat.allocation
93
+ # {"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."}
94
+ def cat_allocation(params = {})
95
+ api_name = 'cat.allocation'
96
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["text/plain", "application/json"]}, "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"}, "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}}}
97
+ request(api_name, api_spec, params)
98
+ end
99
+
100
+ # cat.count
101
+ # {"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."}
102
+ def cat_count(params = {})
103
+ api_name = 'cat.count'
104
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["text/plain", "application/json"]}, "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}}}
105
+ request(api_name, api_spec, params)
106
+ end
107
+
108
+ # cat.fielddata
109
+ # {"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."}
110
+ def cat_fielddata(params = {})
111
+ api_name = 'cat.fielddata'
112
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["text/plain", "application/json"]}, "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"}}}
113
+ request(api_name, api_spec, params)
114
+ end
115
+
116
+ # cat.health
117
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-health.html", "description"=>"Returns a concise representation of the cluster health."}
118
+ def cat_health(params = {})
119
+ api_name = 'cat.health'
120
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["text/plain", "application/json"]}, "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}}}
121
+ request(api_name, api_spec, params)
122
+ end
123
+
124
+ # cat.help
125
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html", "description"=>"Returns help for the Cat APIs."}
126
+ def cat_help(params = {})
127
+ api_name = 'cat.help'
128
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["text/plain"]}, "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"}}}
129
+ request(api_name, api_spec, params)
130
+ end
131
+
132
+ # cat.indices
133
+ # {"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, ..."}
134
+ def cat_indices(params = {})
135
+ api_name = 'cat.indices'
136
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["text/plain", "application/json"]}, "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)", "deprecated"=>{"version"=>"7.11.0", "description"=>"This parameter does not affect the request. It will be removed in a future release."}}, "master_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to master 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."}}}
137
+ request(api_name, api_spec, params)
138
+ end
139
+
140
+ # cat.master
141
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-master.html", "description"=>"Returns information about the master node."}
142
+ def cat_master(params = {})
143
+ api_name = 'cat.master'
144
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-master.html", "description"=>"Returns information about the master node."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["text/plain", "application/json"]}, "url"=>{"paths"=>[{"path"=>"/_cat/master", "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"}, "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}}}
145
+ request(api_name, api_spec, params)
146
+ end
147
+
148
+ # cat.ml_data_frame_analytics
149
+ # {"url"=>"http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-dfanalytics.html", "description"=>"Gets configuration and usage information about data frame analytics jobs."}
150
+ def cat_ml_data_frame_analytics(params = {})
151
+ api_name = 'cat.ml_data_frame_analytics'
152
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-dfanalytics.html", "description"=>"Gets configuration and usage information about data frame analytics jobs."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["text/plain", "application/json"]}, "url"=>{"paths"=>[{"path"=>"/_cat/ml/data_frame/analytics", "methods"=>["GET"]}, {"path"=>"/_cat/ml/data_frame/analytics/{id}", "methods"=>["GET"], "parts"=>{"id"=>{"type"=>"string", "description"=>"The ID of the data frame analytics to fetch"}}}]}, "params"=>{"allow_no_match"=>{"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no configs. (This includes `_all` string or when no configs have been specified)"}, "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"}, "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}}}
153
+ request(api_name, api_spec, params)
154
+ end
155
+
156
+ # cat.ml_datafeeds
157
+ # {"url"=>"http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html", "description"=>"Gets configuration and usage information about datafeeds."}
158
+ def cat_ml_datafeeds(params = {})
159
+ api_name = 'cat.ml_datafeeds'
160
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html", "description"=>"Gets configuration and usage information about datafeeds."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["text/plain", "application/json"]}, "url"=>{"paths"=>[{"path"=>"/_cat/ml/datafeeds", "methods"=>["GET"]}, {"path"=>"/_cat/ml/datafeeds/{datafeed_id}", "methods"=>["GET"], "parts"=>{"datafeed_id"=>{"type"=>"string", "description"=>"The ID of the datafeeds stats to fetch"}}}]}, "params"=>{"allow_no_match"=>{"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)"}, "allow_no_datafeeds"=>{"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)", "deprecated"=>true}, "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"]}, "v"=>{"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}}}
161
+ request(api_name, api_spec, params)
162
+ end
163
+
164
+ # cat.ml_jobs
165
+ # {"url"=>"http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-anomaly-detectors.html", "description"=>"Gets configuration and usage information about anomaly detection jobs."}
166
+ def cat_ml_jobs(params = {})
167
+ api_name = 'cat.ml_jobs'
168
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-anomaly-detectors.html", "description"=>"Gets configuration and usage information about anomaly detection jobs."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["text/plain", "application/json"]}, "url"=>{"paths"=>[{"path"=>"/_cat/ml/anomaly_detectors", "methods"=>["GET"]}, {"path"=>"/_cat/ml/anomaly_detectors/{job_id}", "methods"=>["GET"], "parts"=>{"job_id"=>{"type"=>"string", "description"=>"The ID of the jobs stats to fetch"}}}]}, "params"=>{"allow_no_match"=>{"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)"}, "allow_no_jobs"=>{"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)", "deprecated"=>true}, "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"}, "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}}}
169
+ request(api_name, api_spec, params)
170
+ end
171
+
172
+ # cat.ml_trained_models
173
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-trained-model.html", "description"=>"Gets configuration and usage information about inference trained models."}
174
+ def cat_ml_trained_models(params = {})
175
+ api_name = 'cat.ml_trained_models'
176
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-trained-model.html", "description"=>"Gets configuration and usage information about inference trained models."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["text/plain", "application/json"]}, "url"=>{"paths"=>[{"path"=>"/_cat/ml/trained_models", "methods"=>["GET"]}, {"path"=>"/_cat/ml/trained_models/{model_id}", "methods"=>["GET"], "parts"=>{"model_id"=>{"type"=>"string", "description"=>"The ID of the trained models stats to fetch"}}}]}, "params"=>{"allow_no_match"=>{"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified)", "default"=>true}, "from"=>{"type"=>"int", "description"=>"skips a number of trained models", "default"=>0}, "size"=>{"type"=>"int", "description"=>"specifies a max number of trained models to get", "default"=>100}, "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"}, "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}}}
177
+ request(api_name, api_spec, params)
178
+ end
179
+
180
+ # cat.nodeattrs
181
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodeattrs.html", "description"=>"Returns information about custom node attributes."}
182
+ def cat_nodeattrs(params = {})
183
+ api_name = 'cat.nodeattrs'
184
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["text/plain", "application/json"]}, "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"}, "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}}}
185
+ request(api_name, api_spec, params)
186
+ end
187
+
188
+ # cat.nodes
189
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html", "description"=>"Returns basic statistics about performance of cluster nodes."}
190
+ def cat_nodes(params = {})
191
+ api_name = 'cat.nodes'
192
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["text/plain", "application/json"]}, "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"}, "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}, "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}}}
193
+ request(api_name, api_spec, params)
194
+ end
195
+
196
+ # cat.pending_tasks
197
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-pending-tasks.html", "description"=>"Returns a concise representation of the cluster pending tasks."}
198
+ def cat_pending_tasks(params = {})
199
+ api_name = 'cat.pending_tasks'
200
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["text/plain", "application/json"]}, "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"}, "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}}}
201
+ request(api_name, api_spec, params)
202
+ end
203
+
204
+ # cat.plugins
205
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html", "description"=>"Returns information about installed plugins across nodes node."}
206
+ def cat_plugins(params = {})
207
+ api_name = 'cat.plugins'
208
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["text/plain", "application/json"]}, "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"}, "h"=>{"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help"=>{"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "include_bootstrap"=>{"type"=>"boolean", "description"=>"Include bootstrap plugins in the response", "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}}}
209
+ request(api_name, api_spec, params)
210
+ end
211
+
212
+ # cat.recovery
213
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html", "description"=>"Returns information about index shard recoveries, both on-going completed."}
214
+ def cat_recovery(params = {})
215
+ api_name = 'cat.recovery'
216
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["text/plain", "application/json"]}, "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}}}
217
+ request(api_name, api_spec, params)
218
+ end
219
+
220
+ # cat.repositories
221
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-repositories.html", "description"=>"Returns information about snapshot repositories registered in the cluster."}
222
+ def cat_repositories(params = {})
223
+ api_name = 'cat.repositories'
224
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["text/plain", "application/json"]}, "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"}, "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}}}
225
+ request(api_name, api_spec, params)
226
+ end
227
+
228
+ # cat.segments
229
+ # {"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."}
230
+ def cat_segments(params = {})
231
+ api_name = 'cat.segments'
232
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["text/plain", "application/json"]}, "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"]}, "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}}}
233
+ request(api_name, api_spec, params)
234
+ end
235
+
236
+ # cat.shards
237
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html", "description"=>"Provides a detailed view of shard allocation on nodes."}
238
+ def cat_shards(params = {})
239
+ api_name = 'cat.shards'
240
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["text/plain", "application/json"]}, "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)", "deprecated"=>{"version"=>"7.11.0", "description"=>"This parameter does not affect the request. It will be removed in a future release."}}, "master_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to master 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}}}
241
+ request(api_name, api_spec, params)
242
+ end
243
+
244
+ # cat.snapshots
245
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-snapshots.html", "description"=>"Returns all snapshots in a specific repository."}
246
+ def cat_snapshots(params = {})
247
+ api_name = 'cat.snapshots'
248
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["text/plain", "application/json"]}, "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"}, "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}}}
249
+ request(api_name, api_spec, params)
250
+ end
251
+
252
+ # cat.tasks
253
+ # {"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."}
254
+ def cat_tasks(params = {})
255
+ api_name = 'cat.tasks'
256
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["text/plain", "application/json"]}, "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}}}
257
+ request(api_name, api_spec, params)
258
+ end
259
+
260
+ # cat.templates
261
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-templates.html", "description"=>"Returns information about existing templates."}
262
+ def cat_templates(params = {})
263
+ api_name = 'cat.templates'
264
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["text/plain", "application/json"]}, "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"}, "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}}}
265
+ request(api_name, api_spec, params)
266
+ end
267
+
268
+ # cat.thread_pool
269
+ # {"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."}
270
+ def cat_thread_pool(params = {})
271
+ api_name = 'cat.thread_pool'
272
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["text/plain", "application/json"]}, "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"}, "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}}}
273
+ request(api_name, api_spec, params)
274
+ end
275
+
276
+ # cat.transforms
277
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-transforms.html", "description"=>"Gets configuration and usage information about transforms."}
278
+ def cat_transforms(params = {})
279
+ api_name = 'cat.transforms'
280
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-transforms.html", "description"=>"Gets configuration and usage information about transforms."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["text/plain", "application/json"]}, "url"=>{"paths"=>[{"path"=>"/_cat/transforms", "methods"=>["GET"]}, {"path"=>"/_cat/transforms/{transform_id}", "methods"=>["GET"], "parts"=>{"transform_id"=>{"type"=>"string", "description"=>"The id of the transform for which to get stats. '_all' or '*' implies all transforms"}}}]}, "params"=>{"from"=>{"type"=>"int", "required"=>false, "description"=>"skips a number of transform configs, defaults to 0"}, "size"=>{"type"=>"int", "required"=>false, "description"=>"specifies a max number of transforms to get, defaults to 100"}, "allow_no_match"=>{"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)"}, "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"]}, "v"=>{"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}}}
281
+ request(api_name, api_spec, params)
282
+ end
283
+
284
+ # ccr.delete_auto_follow_pattern
285
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-delete-auto-follow-pattern.html", "description"=>"Deletes auto-follow patterns."}
286
+ def ccr_delete_auto_follow_pattern(params = {})
287
+ api_name = 'ccr.delete_auto_follow_pattern'
288
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-delete-auto-follow-pattern.html", "description"=>"Deletes auto-follow patterns."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ccr/auto_follow/{name}", "methods"=>["DELETE"], "parts"=>{"name"=>{"type"=>"string", "description"=>"The name of the auto follow pattern."}}}]}}
289
+ request(api_name, api_spec, params)
290
+ end
291
+
292
+ # ccr.follow
293
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-follow.html", "description"=>"Creates a new follower index configured to follow the referenced leader index."}
294
+ def ccr_follow(params = {})
295
+ api_name = 'ccr.follow'
296
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-follow.html", "description"=>"Creates a new follower index configured to follow the referenced leader index."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/{index}/_ccr/follow", "methods"=>["PUT"], "parts"=>{"index"=>{"type"=>"string", "description"=>"The name of the follower index"}}}]}, "params"=>{"wait_for_active_shards"=>{"type"=>"string", "description"=>"Sets the number of shard copies that must be active before returning. Defaults to 0. 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)", "default"=>"0"}}, "body"=>{"description"=>"The name of the leader index and other optional ccr related parameters", "required"=>true}}
297
+ request(api_name, api_spec, params)
298
+ end
299
+
300
+ # ccr.follow_info
301
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-info.html", "description"=>"Retrieves information about all follower indices, including parameters and status for each follower index"}
302
+ def ccr_follow_info(params = {})
303
+ api_name = 'ccr.follow_info'
304
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-info.html", "description"=>"Retrieves information about all follower indices, including parameters and status for each follower index"}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/{index}/_ccr/info", "methods"=>["GET"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index patterns; use `_all` to perform the operation on all indices"}}}]}}
305
+ request(api_name, api_spec, params)
306
+ end
307
+
308
+ # ccr.follow_stats
309
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-stats.html", "description"=>"Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices."}
310
+ def ccr_follow_stats(params = {})
311
+ api_name = 'ccr.follow_stats'
312
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-stats.html", "description"=>"Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/{index}/_ccr/stats", "methods"=>["GET"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index patterns; use `_all` to perform the operation on all indices"}}}]}}
313
+ request(api_name, api_spec, params)
314
+ end
315
+
316
+ # ccr.forget_follower
317
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-forget-follower.html", "description"=>"Removes the follower retention leases from the leader."}
318
+ def ccr_forget_follower(params = {})
319
+ api_name = 'ccr.forget_follower'
320
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-forget-follower.html", "description"=>"Removes the follower retention leases from the leader."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/{index}/_ccr/forget_follower", "methods"=>["POST"], "parts"=>{"index"=>{"type"=>"string", "description"=>"the name of the leader index for which specified follower retention leases should be removed"}}}]}, "body"=>{"description"=>"the name and UUID of the follower index, the name of the cluster containing the follower index, and the alias from the perspective of that cluster for the remote cluster containing the leader index", "required"=>true}}
321
+ request(api_name, api_spec, params)
322
+ end
323
+
324
+ # ccr.get_auto_follow_pattern
325
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-auto-follow-pattern.html", "description"=>"Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection."}
326
+ def ccr_get_auto_follow_pattern(params = {})
327
+ api_name = 'ccr.get_auto_follow_pattern'
328
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-auto-follow-pattern.html", "description"=>"Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ccr/auto_follow", "methods"=>["GET"]}, {"path"=>"/_ccr/auto_follow/{name}", "methods"=>["GET"], "parts"=>{"name"=>{"type"=>"string", "description"=>"The name of the auto follow pattern."}}}]}}
329
+ request(api_name, api_spec, params)
330
+ end
331
+
332
+ # ccr.pause_auto_follow_pattern
333
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-pause-auto-follow-pattern.html", "description"=>"Pauses an auto-follow pattern"}
334
+ def ccr_pause_auto_follow_pattern(params = {})
335
+ api_name = 'ccr.pause_auto_follow_pattern'
336
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-pause-auto-follow-pattern.html", "description"=>"Pauses an auto-follow pattern"}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ccr/auto_follow/{name}/pause", "methods"=>["POST"], "parts"=>{"name"=>{"type"=>"string", "description"=>"The name of the auto follow pattern that should pause discovering new indices to follow."}}}]}}
337
+ request(api_name, api_spec, params)
338
+ end
339
+
340
+ # ccr.pause_follow
341
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-pause-follow.html", "description"=>"Pauses a follower index. The follower index will not fetch any additional operations from the leader index."}
342
+ def ccr_pause_follow(params = {})
343
+ api_name = 'ccr.pause_follow'
344
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-pause-follow.html", "description"=>"Pauses a follower index. The follower index will not fetch any additional operations from the leader index."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/{index}/_ccr/pause_follow", "methods"=>["POST"], "parts"=>{"index"=>{"type"=>"string", "description"=>"The name of the follower index that should pause following its leader index."}}}]}}
345
+ request(api_name, api_spec, params)
346
+ end
347
+
348
+ # ccr.put_auto_follow_pattern
349
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-auto-follow-pattern.html", "description"=>"Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices."}
350
+ def ccr_put_auto_follow_pattern(params = {})
351
+ api_name = 'ccr.put_auto_follow_pattern'
352
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-auto-follow-pattern.html", "description"=>"Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ccr/auto_follow/{name}", "methods"=>["PUT"], "parts"=>{"name"=>{"type"=>"string", "description"=>"The name of the auto follow pattern."}}}]}, "body"=>{"description"=>"The specification of the auto follow pattern", "required"=>true}}
353
+ request(api_name, api_spec, params)
354
+ end
355
+
356
+ # ccr.resume_auto_follow_pattern
357
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-resume-auto-follow-pattern.html", "description"=>"Resumes an auto-follow pattern that has been paused"}
358
+ def ccr_resume_auto_follow_pattern(params = {})
359
+ api_name = 'ccr.resume_auto_follow_pattern'
360
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-resume-auto-follow-pattern.html", "description"=>"Resumes an auto-follow pattern that has been paused"}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ccr/auto_follow/{name}/resume", "methods"=>["POST"], "parts"=>{"name"=>{"type"=>"string", "description"=>"The name of the auto follow pattern to resume discovering new indices to follow."}}}]}}
361
+ request(api_name, api_spec, params)
362
+ end
363
+
364
+ # ccr.resume_follow
365
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-resume-follow.html", "description"=>"Resumes a follower index that has been paused"}
366
+ def ccr_resume_follow(params = {})
367
+ api_name = 'ccr.resume_follow'
368
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-resume-follow.html", "description"=>"Resumes a follower index that has been paused"}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/{index}/_ccr/resume_follow", "methods"=>["POST"], "parts"=>{"index"=>{"type"=>"string", "description"=>"The name of the follow index to resume following."}}}]}, "body"=>{"description"=>"The name of the leader index and other optional ccr related parameters", "required"=>false}}
369
+ request(api_name, api_spec, params)
370
+ end
371
+
372
+ # ccr.stats
373
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-stats.html", "description"=>"Gets all stats related to cross-cluster replication."}
374
+ def ccr_stats(params = {})
375
+ api_name = 'ccr.stats'
376
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-stats.html", "description"=>"Gets all stats related to cross-cluster replication."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ccr/stats", "methods"=>["GET"]}]}}
377
+ request(api_name, api_spec, params)
378
+ end
379
+
380
+ # ccr.unfollow
381
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-unfollow.html", "description"=>"Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication."}
382
+ def ccr_unfollow(params = {})
383
+ api_name = 'ccr.unfollow'
384
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-unfollow.html", "description"=>"Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/{index}/_ccr/unfollow", "methods"=>["POST"], "parts"=>{"index"=>{"type"=>"string", "description"=>"The name of the follower index that should be turned into a regular index."}}}]}}
385
+ request(api_name, api_spec, params)
386
+ end
387
+
388
+ # clear_scroll
389
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-scroll-api.html", "description"=>"Explicitly clears the search context for a scroll."}
390
+ def clear_scroll(params = {})
391
+ api_name = 'clear_scroll'
392
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json", "text/plain"]}, "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"}}
393
+ request(api_name, api_spec, params)
394
+ end
395
+
396
+ # close_point_in_time
397
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/point-in-time-api.html", "description"=>"Close a point in time"}
398
+ def close_point_in_time(params = {})
399
+ api_name = 'close_point_in_time'
400
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/point-in-time-api.html", "description"=>"Close a point in time"}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_pit", "methods"=>["DELETE"]}]}, "params"=>{}, "body"=>{"description"=>"a point-in-time id to close"}}
401
+ request(api_name, api_spec, params)
402
+ end
403
+
404
+ # cluster.allocation_explain
405
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-allocation-explain.html", "description"=>"Provides explanations for shard allocations in the cluster."}
406
+ def cluster_allocation_explain(params = {})
407
+ api_name = 'cluster.allocation_explain'
408
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "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'"}}
409
+ request(api_name, api_spec, params)
410
+ end
411
+
412
+ # cluster.delete_component_template
413
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html", "description"=>"Deletes a component template"}
414
+ def cluster_delete_component_template(params = {})
415
+ api_name = 'cluster.delete_component_template'
416
+ 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"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"}}}
417
+ request(api_name, api_spec, params)
418
+ end
419
+
420
+ # cluster.delete_voting_config_exclusions
421
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/voting-config-exclusions.html", "description"=>"Clears cluster voting config exclusions."}
422
+ def cluster_delete_voting_config_exclusions(params = {})
423
+ api_name = 'cluster.delete_voting_config_exclusions'
424
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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}}}
425
+ request(api_name, api_spec, params)
426
+ end
427
+
428
+ # cluster.exists_component_template
429
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html", "description"=>"Returns information about whether a particular component template exist"}
430
+ def cluster_exists_component_template(params = {})
431
+ api_name = 'cluster.exists_component_template'
432
+ 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"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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)"}}}
433
+ request(api_name, api_spec, params)
434
+ end
435
+ alias :cluster_exists_component_template? :cluster_exists_component_template
436
+
437
+ # cluster.get_component_template
438
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html", "description"=>"Returns one or more component templates"}
439
+ def cluster_get_component_template(params = {})
440
+ api_name = 'cluster.get_component_template'
441
+ 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"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"}, "local"=>{"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}}}
442
+ request(api_name, api_spec, params)
443
+ end
444
+
445
+ # cluster.get_settings
446
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-get-settings.html", "description"=>"Returns cluster settings."}
447
+ def cluster_get_settings(params = {})
448
+ api_name = 'cluster.get_settings'
449
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-get-settings.html", "description"=>"Returns cluster settings."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"}, "timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}, "include_defaults"=>{"type"=>"boolean", "description"=>"Whether to return all default clusters setting.", "default"=>false}}}
450
+ request(api_name, api_spec, params)
451
+ end
452
+
453
+ # cluster.health
454
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-health.html", "description"=>"Returns basic information about the health of the cluster."}
455
+ def cluster_health(params = {})
456
+ api_name = 'cluster.health'
457
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"], "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"}, "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"}}}
458
+ request(api_name, api_spec, params)
459
+ end
460
+
461
+ # cluster.pending_tasks
462
+ # {"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."}
463
+ def cluster_pending_tasks(params = {})
464
+ api_name = 'cluster.pending_tasks'
465
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"}}}
466
+ request(api_name, api_spec, params)
467
+ end
468
+
469
+ # cluster.post_voting_config_exclusions
470
+ # {"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."}
471
+ def cluster_post_voting_config_exclusions(params = {})
472
+ api_name = 'cluster.post_voting_config_exclusions'
473
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"}}}
474
+ request(api_name, api_spec, params)
475
+ end
476
+
477
+ # cluster.put_component_template
478
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html", "description"=>"Creates or updates a component template"}
479
+ def cluster_put_component_template(params = {})
480
+ api_name = 'cluster.put_component_template'
481
+ 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"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "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"}}, "body"=>{"description"=>"The template definition", "required"=>true}}
482
+ request(api_name, api_spec, params)
483
+ end
484
+
485
+ # cluster.put_settings
486
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html", "description"=>"Updates the cluster settings."}
487
+ def cluster_put_settings(params = {})
488
+ api_name = 'cluster.put_settings'
489
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "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"}, "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}}
490
+ request(api_name, api_spec, params)
491
+ end
492
+
493
+ # cluster.remote_info
494
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-remote-info.html", "description"=>"Returns the information about configured remote clusters."}
495
+ def cluster_remote_info(params = {})
496
+ api_name = 'cluster.remote_info'
497
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_remote/info", "methods"=>["GET"]}]}, "params"=>{}}
498
+ request(api_name, api_spec, params)
499
+ end
500
+
501
+ # cluster.reroute
502
+ # {"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."}
503
+ def cluster_reroute(params = {})
504
+ api_name = 'cluster.reroute'
505
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "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", "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"}, "timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}}, "body"=>{"description"=>"The definition of `commands` to perform (`move`, `cancel`, `allocate`)"}}
506
+ request(api_name, api_spec, params)
507
+ end
508
+
509
+ # cluster.state
510
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-state.html", "description"=>"Returns a comprehensive information about the state of the cluster."}
511
+ def cluster_state(params = {})
512
+ api_name = 'cluster.state'
513
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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", "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"}, "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."}}}
514
+ request(api_name, api_spec, params)
515
+ end
516
+
517
+ # cluster.stats
518
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-stats.html", "description"=>"Returns high-level overview of cluster statistics."}
519
+ def cluster_stats(params = {})
520
+ api_name = 'cluster.stats'
521
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"}}}
522
+ request(api_name, api_spec, params)
523
+ end
524
+
525
+ # count
526
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html", "description"=>"Returns number of documents matching a query."}
527
+ def count(params = {})
528
+ api_name = 'count'
529
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "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"}}}, {"path"=>"/{index}/{type}/_count", "methods"=>["POST", "GET"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of indices to restrict the results"}, "type"=>{"type"=>"list", "description"=>"A comma-separated list of types to restrict the results"}}, "deprecated"=>{"version"=>"7.0.0", "description"=>"Specifying types in urls has been deprecated"}}]}, "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)"}}
530
+ request(api_name, api_spec, params)
531
+ end
532
+
533
+ # create
534
+ # {"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."}
535
+ def create(params = {})
536
+ api_name = 'create'
537
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "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"}}}, {"path"=>"/{index}/{type}/{id}/_create", "methods"=>["PUT", "POST"], "parts"=>{"id"=>{"type"=>"string", "description"=>"Document ID"}, "index"=>{"type"=>"string", "description"=>"The name of the index"}, "type"=>{"type"=>"string", "description"=>"The type of the document", "deprecated"=>true}}, "deprecated"=>{"version"=>"7.0.0", "description"=>"Specifying types in urls has been deprecated"}}]}, "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}}
538
+ request(api_name, api_spec, params)
539
+ end
540
+
541
+ # dangling_indices.delete_dangling_index
542
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html", "description"=>"Deletes the specified dangling index"}
543
+ def dangling_indices_delete_dangling_index(params = {})
544
+ api_name = 'dangling_indices.delete_dangling_index'
545
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"}}}
546
+ request(api_name, api_spec, params)
547
+ end
548
+
549
+ # dangling_indices.import_dangling_index
550
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html", "description"=>"Imports the specified dangling index"}
551
+ def dangling_indices_import_dangling_index(params = {})
552
+ api_name = 'dangling_indices.import_dangling_index'
553
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"}}}
554
+ request(api_name, api_spec, params)
555
+ end
556
+
557
+ # dangling_indices.list_dangling_indices
558
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html", "description"=>"Returns all dangling indices."}
559
+ def dangling_indices_list_dangling_indices(params = {})
560
+ api_name = 'dangling_indices.list_dangling_indices'
561
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_dangling", "methods"=>["GET"]}]}, "params"=>{}}
562
+ request(api_name, api_spec, params)
563
+ end
564
+
565
+ # data_frame_transform_deprecated.delete_transform
566
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html", "description"=>"Deletes an existing transform."}
567
+ def data_frame_transform_deprecated_delete_transform(params = {})
568
+ api_name = 'data_frame_transform_deprecated.delete_transform'
569
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html", "description"=>"Deletes an existing transform."}, "stability"=>"beta", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_data_frame/transforms/{transform_id}", "methods"=>["DELETE"], "parts"=>{"transform_id"=>{"type"=>"string", "description"=>"The id of the transform to delete"}}, "deprecated"=>{"version"=>"7.5.0", "description"=>"[_data_frame/transforms/] is deprecated, use [_transform/] in the future."}}]}, "params"=>{"force"=>{"type"=>"boolean", "required"=>false, "description"=>"When `true`, the transform is deleted regardless of its current state. The default value is `false`, meaning that the transform must be `stopped` before it can be deleted."}}}
570
+ request(api_name, api_spec, params)
571
+ end
572
+
573
+ # data_frame_transform_deprecated.get_transform
574
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html", "description"=>"Retrieves configuration information for transforms."}
575
+ def data_frame_transform_deprecated_get_transform(params = {})
576
+ api_name = 'data_frame_transform_deprecated.get_transform'
577
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html", "description"=>"Retrieves configuration information for transforms."}, "stability"=>"beta", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_data_frame/transforms/{transform_id}", "methods"=>["GET"], "parts"=>{"transform_id"=>{"type"=>"string", "description"=>"The id or comma delimited list of id expressions of the transforms to get, '_all' or '*' implies get all transforms"}}, "deprecated"=>{"version"=>"7.5.0", "description"=>"[_data_frame/transforms/] is deprecated, use [_transform/] in the future."}}, {"path"=>"/_data_frame/transforms", "methods"=>["GET"], "deprecated"=>{"version"=>"7.5.0", "description"=>"[_data_frame/transforms/] is deprecated, use [_transform/] in the future."}}]}, "params"=>{"from"=>{"type"=>"int", "required"=>false, "description"=>"skips a number of transform configs, defaults to 0"}, "size"=>{"type"=>"int", "required"=>false, "description"=>"specifies a max number of transforms to get, defaults to 100"}, "allow_no_match"=>{"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)"}, "exclude_generated"=>{"required"=>false, "type"=>"boolean", "default"=>false, "description"=>"Omits generated fields. Allows transform configurations to be easily copied between clusters and within the same cluster"}}}
578
+ request(api_name, api_spec, params)
579
+ end
580
+
581
+ # data_frame_transform_deprecated.get_transform_stats
582
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-stats.html", "description"=>"Retrieves usage information for transforms."}
583
+ def data_frame_transform_deprecated_get_transform_stats(params = {})
584
+ api_name = 'data_frame_transform_deprecated.get_transform_stats'
585
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-stats.html", "description"=>"Retrieves usage information for transforms."}, "stability"=>"beta", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_data_frame/transforms/{transform_id}/_stats", "methods"=>["GET"], "parts"=>{"transform_id"=>{"type"=>"string", "description"=>"The id of the transform for which to get stats. '_all' or '*' implies all transforms"}}, "deprecated"=>{"version"=>"7.5.0", "description"=>"[_data_frame/transforms/] is deprecated, use [_transform/] in the future."}}]}, "params"=>{"from"=>{"type"=>"number", "required"=>false, "description"=>"skips a number of transform stats, defaults to 0"}, "size"=>{"type"=>"number", "required"=>false, "description"=>"specifies a max number of transform stats to get, defaults to 100"}, "allow_no_match"=>{"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)"}}}
586
+ request(api_name, api_spec, params)
587
+ end
588
+
589
+ # data_frame_transform_deprecated.preview_transform
590
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html", "description"=>"Previews a transform."}
591
+ def data_frame_transform_deprecated_preview_transform(params = {})
592
+ api_name = 'data_frame_transform_deprecated.preview_transform'
593
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html", "description"=>"Previews a transform."}, "stability"=>"beta", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_data_frame/transforms/_preview", "methods"=>["POST"], "deprecated"=>{"version"=>"7.5.0", "description"=>"[_data_frame/transforms/] is deprecated, use [_transform/] in the future."}}]}, "body"=>{"description"=>"The definition for the transform to preview", "required"=>true}}
594
+ request(api_name, api_spec, params)
595
+ end
596
+
597
+ # data_frame_transform_deprecated.put_transform
598
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html", "description"=>"Instantiates a transform."}
599
+ def data_frame_transform_deprecated_put_transform(params = {})
600
+ api_name = 'data_frame_transform_deprecated.put_transform'
601
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html", "description"=>"Instantiates a transform."}, "stability"=>"beta", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_data_frame/transforms/{transform_id}", "methods"=>["PUT"], "parts"=>{"transform_id"=>{"type"=>"string", "description"=>"The id of the new transform."}}, "deprecated"=>{"version"=>"7.5.0", "description"=>"[_data_frame/transforms/] is deprecated, use [_transform/] in the future."}}]}, "params"=>{"defer_validation"=>{"type"=>"boolean", "required"=>false, "description"=>"If validations should be deferred until transform starts, defaults to false."}}, "body"=>{"description"=>"The transform definition", "required"=>true}}
602
+ request(api_name, api_spec, params)
603
+ end
604
+
605
+ # data_frame_transform_deprecated.start_transform
606
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html", "description"=>"Starts one or more transforms."}
607
+ def data_frame_transform_deprecated_start_transform(params = {})
608
+ api_name = 'data_frame_transform_deprecated.start_transform'
609
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html", "description"=>"Starts one or more transforms."}, "stability"=>"beta", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_data_frame/transforms/{transform_id}/_start", "methods"=>["POST"], "parts"=>{"transform_id"=>{"type"=>"string", "description"=>"The id of the transform to start"}}, "deprecated"=>{"version"=>"7.5.0", "description"=>"[_data_frame/transforms/] is deprecated, use [_transform/] in the future."}}]}, "params"=>{"timeout"=>{"type"=>"time", "required"=>false, "description"=>"Controls the time to wait for the transform to start"}}}
610
+ request(api_name, api_spec, params)
611
+ end
612
+
613
+ # data_frame_transform_deprecated.stop_transform
614
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html", "description"=>"Stops one or more transforms."}
615
+ def data_frame_transform_deprecated_stop_transform(params = {})
616
+ api_name = 'data_frame_transform_deprecated.stop_transform'
617
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html", "description"=>"Stops one or more transforms."}, "stability"=>"beta", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_data_frame/transforms/{transform_id}/_stop", "methods"=>["POST"], "parts"=>{"transform_id"=>{"type"=>"string", "description"=>"The id of the transform to stop"}}, "deprecated"=>{"version"=>"7.5.0", "description"=>"[_data_frame/transforms/] is deprecated, use [_transform/] in the future."}}]}, "params"=>{"wait_for_completion"=>{"type"=>"boolean", "required"=>false, "description"=>"Whether to wait for the transform to fully stop before returning or not. Default to false"}, "timeout"=>{"type"=>"time", "required"=>false, "description"=>"Controls the time to wait until the transform has stopped. Default to 30 seconds"}, "allow_no_match"=>{"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)"}}}
618
+ request(api_name, api_spec, params)
619
+ end
620
+
621
+ # data_frame_transform_deprecated.update_transform
622
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html", "description"=>"Updates certain properties of a transform."}
623
+ def data_frame_transform_deprecated_update_transform(params = {})
624
+ api_name = 'data_frame_transform_deprecated.update_transform'
625
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html", "description"=>"Updates certain properties of a transform."}, "stability"=>"beta", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_data_frame/transforms/{transform_id}/_update", "methods"=>["POST"], "parts"=>{"transform_id"=>{"type"=>"string", "required"=>true, "description"=>"The id of the transform."}}, "deprecated"=>{"version"=>"7.5.0", "description"=>"[_data_frame/transforms/] is deprecated, use [_transform/] in the future."}}]}, "params"=>{"defer_validation"=>{"type"=>"boolean", "required"=>false, "description"=>"If validations should be deferred until transform starts, defaults to false."}}, "body"=>{"description"=>"The update transform definition", "required"=>true}}
626
+ request(api_name, api_spec, params)
627
+ end
628
+
629
+ # delete
630
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html", "description"=>"Removes a document from the index."}
631
+ def delete(params = {})
632
+ api_name = 'delete'
633
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"}}}, {"path"=>"/{index}/{type}/{id}", "methods"=>["DELETE"], "parts"=>{"id"=>{"type"=>"string", "description"=>"The document ID"}, "index"=>{"type"=>"string", "description"=>"The name of the index"}, "type"=>{"type"=>"string", "description"=>"The type of the document", "deprecated"=>true}}, "deprecated"=>{"version"=>"7.0.0", "description"=>"Specifying types in urls has been deprecated"}}]}, "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"}}}
634
+ request(api_name, api_spec, params)
635
+ end
636
+
637
+ # delete_by_query
638
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html", "description"=>"Deletes documents matching the provided query."}
639
+ def delete_by_query(params = {})
640
+ api_name = 'delete_by_query'
641
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "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"}}}, {"path"=>"/{index}/{type}/_delete_by_query", "methods"=>["POST"], "parts"=>{"index"=>{"required"=>true, "type"=>"list", "description"=>"A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices"}, "type"=>{"type"=>"list", "description"=>"A comma-separated list of document types to search; leave empty to perform the operation on all types"}}, "deprecated"=>{"version"=>"7.0.0", "description"=>"Specifying types in urls has been deprecated"}}]}, "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}}
642
+ request(api_name, api_spec, params)
643
+ end
644
+
645
+ # delete_by_query_rethrottle
646
+ # {"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."}
647
+ def delete_by_query_rethrottle(params = {})
648
+ api_name = 'delete_by_query_rethrottle'
649
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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."}}}
650
+ request(api_name, api_spec, params)
651
+ end
652
+
653
+ # delete_script
654
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", "description"=>"Deletes a script."}
655
+ def delete_script(params = {})
656
+ api_name = 'delete_script'
657
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"}}}
658
+ request(api_name, api_spec, params)
659
+ end
660
+
661
+ # enrich.delete_policy
662
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-enrich-policy-api.html", "description"=>"Deletes an existing enrich policy and its enrich index."}
663
+ def enrich_delete_policy(params = {})
664
+ api_name = 'enrich.delete_policy'
665
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-enrich-policy-api.html", "description"=>"Deletes an existing enrich policy and its enrich index."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_enrich/policy/{name}", "methods"=>["DELETE"], "parts"=>{"name"=>{"type"=>"string", "description"=>"The name of the enrich policy"}}}]}}
666
+ request(api_name, api_spec, params)
667
+ end
668
+
669
+ # enrich.execute_policy
670
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/execute-enrich-policy-api.html", "description"=>"Creates the enrich index for an existing enrich policy."}
671
+ def enrich_execute_policy(params = {})
672
+ api_name = 'enrich.execute_policy'
673
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/execute-enrich-policy-api.html", "description"=>"Creates the enrich index for an existing enrich policy."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_enrich/policy/{name}/_execute", "methods"=>["PUT"], "parts"=>{"name"=>{"type"=>"string", "description"=>"The name of the enrich policy"}}}]}, "params"=>{"wait_for_completion"=>{"type"=>"boolean", "default"=>true, "description"=>"Should the request should block until the execution is complete."}}}
674
+ request(api_name, api_spec, params)
675
+ end
676
+
677
+ # enrich.get_policy
678
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html", "description"=>"Gets information about an enrich policy."}
679
+ def enrich_get_policy(params = {})
680
+ api_name = 'enrich.get_policy'
681
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html", "description"=>"Gets information about an enrich policy."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_enrich/policy/{name}", "methods"=>["GET"], "parts"=>{"name"=>{"type"=>"list", "description"=>"A comma-separated list of enrich policy names"}}}, {"path"=>"/_enrich/policy/", "methods"=>["GET"]}]}}
682
+ request(api_name, api_spec, params)
683
+ end
684
+
685
+ # enrich.put_policy
686
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/put-enrich-policy-api.html", "description"=>"Creates a new enrich policy."}
687
+ def enrich_put_policy(params = {})
688
+ api_name = 'enrich.put_policy'
689
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/put-enrich-policy-api.html", "description"=>"Creates a new enrich policy."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_enrich/policy/{name}", "methods"=>["PUT"], "parts"=>{"name"=>{"type"=>"string", "description"=>"The name of the enrich policy"}}}]}, "body"=>{"description"=>"The enrich policy to register", "required"=>true}}
690
+ request(api_name, api_spec, params)
691
+ end
692
+
693
+ # enrich.stats
694
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-stats-api.html", "description"=>"Gets enrich coordinator statistics and information about enrich policies that are currently executing."}
695
+ def enrich_stats(params = {})
696
+ api_name = 'enrich.stats'
697
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-stats-api.html", "description"=>"Gets enrich coordinator statistics and information about enrich policies that are currently executing."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_enrich/_stats", "methods"=>["GET"]}]}}
698
+ request(api_name, api_spec, params)
699
+ end
700
+
701
+ # eql.delete
702
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html", "description"=>"Deletes an async EQL search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted."}
703
+ def eql_delete(params = {})
704
+ api_name = 'eql.delete'
705
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html", "description"=>"Deletes an async EQL search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_eql/search/{id}", "methods"=>["DELETE"], "parts"=>{"id"=>{"type"=>"string", "description"=>"The async search ID"}}}]}}
706
+ request(api_name, api_spec, params)
707
+ end
708
+
709
+ # eql.get
710
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html", "description"=>"Returns async results from previously executed Event Query Language (EQL) search"}
711
+ def eql_get(params = {})
712
+ api_name = 'eql.get'
713
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html", "description"=>"Returns async results from previously executed Event Query Language (EQL) search"}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_eql/search/{id}", "methods"=>["GET"], "parts"=>{"id"=>{"type"=>"string", "description"=>"The async search ID"}}}]}, "params"=>{"wait_for_completion_timeout"=>{"type"=>"time", "description"=>"Specify the time that the request should block waiting for the final response"}, "keep_alive"=>{"type"=>"time", "description"=>"Update the time interval in which the results (partial or final) for this search will be available", "default"=>"5d"}}}
714
+ request(api_name, api_spec, params)
715
+ end
716
+
717
+ # eql.get_status
718
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html", "description"=>"Returns the status of a previously submitted async or stored Event Query Language (EQL) search"}
719
+ def eql_get_status(params = {})
720
+ api_name = 'eql.get_status'
721
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html", "description"=>"Returns the status of a previously submitted async or stored Event Query Language (EQL) search"}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_eql/search/status/{id}", "methods"=>["GET"], "parts"=>{"id"=>{"type"=>"string", "description"=>"The async search ID"}}}]}}
722
+ request(api_name, api_spec, params)
723
+ end
724
+
725
+ # eql.search
726
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html", "description"=>"Returns results matching a query expressed in Event Query Language (EQL)"}
727
+ def eql_search(params = {})
728
+ api_name = 'eql.search'
729
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html", "description"=>"Returns results matching a query expressed in Event Query Language (EQL)"}, "stability"=>"stable", "visibility"=>"feature_flag", "feature_flag"=>"es.eql_feature_flag_registered", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/{index}/_eql/search", "methods"=>["GET", "POST"], "parts"=>{"index"=>{"type"=>"string", "description"=>"The name of the index to scope the operation"}}}]}, "params"=>{"wait_for_completion_timeout"=>{"type"=>"time", "description"=>"Specify the time that the request should block waiting for the final response"}, "keep_on_completion"=>{"type"=>"boolean", "description"=>"Control whether the response should be stored in the cluster if it completed within the provided [wait_for_completion] time (default: false)", "default"=>false}, "keep_alive"=>{"type"=>"time", "description"=>"Update the time interval in which the results (partial or final) for this search will be available", "default"=>"5d"}}, "body"=>{"description"=>"Eql request body. Use the `query` to limit the query scope.", "required"=>true}}
730
+ request(api_name, api_spec, params)
731
+ end
732
+
733
+ # exists
734
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", "description"=>"Returns information about whether a document exists in an index."}
735
+ def exists(params = {})
736
+ api_name = 'exists'
737
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"}}}, {"path"=>"/{index}/{type}/{id}", "methods"=>["HEAD"], "parts"=>{"id"=>{"type"=>"string", "description"=>"The document ID"}, "index"=>{"type"=>"string", "description"=>"The name of the index"}, "type"=>{"type"=>"string", "description"=>"The type of the document (use `_all` to fetch the first document matching the ID across all types)", "deprecated"=>true}}, "deprecated"=>{"version"=>"7.0.0", "description"=>"Specifying types in urls has been deprecated"}}]}, "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"}}}
738
+ request(api_name, api_spec, params)
739
+ end
740
+ alias :exists? :exists
741
+
742
+ # exists_source
743
+ # {"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."}
744
+ def exists_source(params = {})
745
+ api_name = 'exists_source'
746
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"}}}, {"path"=>"/{index}/{type}/{id}/_source", "methods"=>["HEAD"], "parts"=>{"id"=>{"type"=>"string", "description"=>"The document ID"}, "index"=>{"type"=>"string", "description"=>"The name of the index"}, "type"=>{"type"=>"string", "description"=>"The type of the document; deprecated and optional starting with 7.0", "deprecated"=>true}}, "deprecated"=>{"version"=>"7.0.0", "description"=>"Specifying types in urls has been deprecated"}}]}, "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"}}}
747
+ request(api_name, api_spec, params)
748
+ end
749
+ alias :exists_source? :exists_source
750
+
751
+ # explain
752
+ # {"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."}
753
+ def explain(params = {})
754
+ api_name = 'explain'
755
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "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"}}}, {"path"=>"/{index}/{type}/{id}/_explain", "methods"=>["GET", "POST"], "parts"=>{"id"=>{"type"=>"string", "description"=>"The document ID"}, "index"=>{"type"=>"string", "description"=>"The name of the index"}, "type"=>{"type"=>"string", "description"=>"The type of the document", "deprecated"=>true}}, "deprecated"=>{"version"=>"7.0.0", "description"=>"Specifying types in urls has been deprecated"}}]}, "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"}}
756
+ request(api_name, api_spec, params)
757
+ end
758
+
759
+ # features.get_features
760
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/get-features-api.html", "description"=>"Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot"}
761
+ def features_get_features(params = {})
762
+ api_name = 'features.get_features'
763
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/get-features-api.html", "description"=>"Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot"}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_features", "methods"=>["GET"]}]}, "params"=>{"master_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}}}
764
+ request(api_name, api_spec, params)
765
+ end
766
+
767
+ # features.reset_features
768
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "description"=>"Resets the internal state of features, usually by deleting system indices"}
769
+ def features_reset_features(params = {})
770
+ api_name = 'features.reset_features'
771
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "description"=>"Resets the internal state of features, usually by deleting system indices"}, "stability"=>"experimental", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_features/_reset", "methods"=>["POST"]}]}}
772
+ request(api_name, api_spec, params)
773
+ end
774
+
775
+ # field_caps
776
+ # {"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."}
777
+ def field_caps(params = {})
778
+ api_name = 'field_caps'
779
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"}}
780
+ request(api_name, api_spec, params)
781
+ end
782
+
783
+ # fleet.global_checkpoints
784
+ # {"url"=>nil, "description"=>"Returns the current global checkpoints for an index. This API is design for internal use by the fleet server project."}
785
+ def fleet_global_checkpoints(params = {})
786
+ api_name = 'fleet.global_checkpoints'
787
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>nil, "description"=>"Returns the current global checkpoints for an index. This API is design for internal use by the fleet server project."}, "stability"=>"experimental", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/{index}/_fleet/global_checkpoints", "methods"=>["GET"], "parts"=>{"index"=>{"type"=>"string", "description"=>"The name of the index."}}}]}, "params"=>{"wait_for_advance"=>{"type"=>"boolean", "description"=>"Whether to wait for the global checkpoint to advance past the specified current checkpoints", "default"=>"false"}, "wait_for_index"=>{"type"=>"boolean", "description"=>"Whether to wait for the target index to exist and all primary shards be active", "default"=>"false"}, "checkpoints"=>{"type"=>"list", "description"=>"Comma separated list of checkpoints", "default"=>""}, "timeout"=>{"type"=>"time", "description"=>"Timeout to wait for global checkpoint to advance", "default"=>"30s"}}}
788
+ request(api_name, api_spec, params)
789
+ end
790
+
791
+ # get
792
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", "description"=>"Returns a document."}
793
+ def get(params = {})
794
+ api_name = 'get'
795
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"}}}, {"path"=>"/{index}/{type}/{id}", "methods"=>["GET"], "parts"=>{"id"=>{"type"=>"string", "description"=>"The document ID"}, "index"=>{"type"=>"string", "description"=>"The name of the index"}, "type"=>{"type"=>"string", "description"=>"The type of the document (use `_all` to fetch the first document matching the ID across all types)", "deprecated"=>true}}, "deprecated"=>{"version"=>"7.0.0", "description"=>"Specifying types in urls has been deprecated"}}]}, "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"}}}
796
+ request(api_name, api_spec, params)
797
+ end
798
+
799
+ # get_script
800
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", "description"=>"Returns a script."}
801
+ def get_script(params = {})
802
+ api_name = 'get_script'
803
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"}}}
804
+ request(api_name, api_spec, params)
805
+ end
806
+
807
+ # get_script_context
808
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-contexts.html", "description"=>"Returns all script contexts."}
809
+ def get_script_context(params = {})
810
+ api_name = 'get_script_context'
811
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_script_context", "methods"=>["GET"]}]}, "params"=>{}}
812
+ request(api_name, api_spec, params)
813
+ end
814
+
815
+ # get_script_languages
816
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", "description"=>"Returns available script types, languages and contexts"}
817
+ def get_script_languages(params = {})
818
+ api_name = 'get_script_languages'
819
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_script_language", "methods"=>["GET"]}]}, "params"=>{}}
820
+ request(api_name, api_spec, params)
821
+ end
822
+
823
+ # get_source
824
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", "description"=>"Returns the source of a document."}
825
+ def get_source(params = {})
826
+ api_name = 'get_source'
827
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"}}}, {"path"=>"/{index}/{type}/{id}/_source", "methods"=>["GET"], "parts"=>{"id"=>{"type"=>"string", "description"=>"The document ID"}, "index"=>{"type"=>"string", "description"=>"The name of the index"}, "type"=>{"type"=>"string", "description"=>"The type of the document; deprecated and optional starting with 7.0", "deprecated"=>true}}, "deprecated"=>{"version"=>"7.0.0", "description"=>"Specifying types in urls has been deprecated"}}]}, "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"}}}
828
+ request(api_name, api_spec, params)
829
+ end
830
+
831
+ # graph.explore
832
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/graph-explore-api.html", "description"=>"Explore extracted and summarized information about the documents and terms in an index."}
833
+ def graph_explore(params = {})
834
+ api_name = 'graph.explore'
835
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/graph-explore-api.html", "description"=>"Explore extracted and summarized information about the documents and terms in an index."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/{index}/_graph/explore", "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"}}}, {"path"=>"/{index}/{type}/_graph/explore", "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"}, "type"=>{"type"=>"list", "description"=>"A comma-separated list of document types to search; leave empty to perform the operation on all types", "deprecated"=>true}}, "deprecated"=>{"version"=>"7.0.0", "description"=>"Specifying types in urls has been deprecated"}}]}, "params"=>{"routing"=>{"type"=>"string", "description"=>"Specific routing value"}, "timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}}, "body"=>{"description"=>"Graph Query DSL"}}
836
+ request(api_name, api_spec, params)
837
+ end
838
+
839
+ # ilm.delete_lifecycle
840
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-delete-lifecycle.html", "description"=>"Deletes the specified lifecycle policy definition. A currently used policy cannot be deleted."}
841
+ def ilm_delete_lifecycle(params = {})
842
+ api_name = 'ilm.delete_lifecycle'
843
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-delete-lifecycle.html", "description"=>"Deletes the specified lifecycle policy definition. A currently used policy cannot be deleted."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ilm/policy/{policy}", "methods"=>["DELETE"], "parts"=>{"policy"=>{"type"=>"string", "description"=>"The name of the index lifecycle policy"}}}]}, "params"=>{}}
844
+ request(api_name, api_spec, params)
845
+ end
846
+
847
+ # ilm.explain_lifecycle
848
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-explain-lifecycle.html", "description"=>"Retrieves information about the index's current lifecycle state, such as the currently executing phase, action, and step."}
849
+ def ilm_explain_lifecycle(params = {})
850
+ api_name = 'ilm.explain_lifecycle'
851
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-explain-lifecycle.html", "description"=>"Retrieves information about the index's current lifecycle state, such as the currently executing phase, action, and step."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/{index}/_ilm/explain", "methods"=>["GET"], "parts"=>{"index"=>{"type"=>"string", "description"=>"The name of the index to explain"}}}]}, "params"=>{"only_managed"=>{"type"=>"boolean", "description"=>"filters the indices included in the response to ones managed by ILM"}, "only_errors"=>{"type"=>"boolean", "description"=>"filters the indices included in the response to ones in an ILM error state, implies only_managed"}}}
852
+ request(api_name, api_spec, params)
853
+ end
854
+
855
+ # ilm.get_lifecycle
856
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-lifecycle.html", "description"=>"Returns the specified policy definition. Includes the policy version and last modified date."}
857
+ def ilm_get_lifecycle(params = {})
858
+ api_name = 'ilm.get_lifecycle'
859
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-lifecycle.html", "description"=>"Returns the specified policy definition. Includes the policy version and last modified date."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ilm/policy/{policy}", "methods"=>["GET"], "parts"=>{"policy"=>{"type"=>"string", "description"=>"The name of the index lifecycle policy"}}}, {"path"=>"/_ilm/policy", "methods"=>["GET"]}]}, "params"=>{}}
860
+ request(api_name, api_spec, params)
861
+ end
862
+
863
+ # ilm.get_status
864
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-status.html", "description"=>"Retrieves the current index lifecycle management (ILM) status."}
865
+ def ilm_get_status(params = {})
866
+ api_name = 'ilm.get_status'
867
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-status.html", "description"=>"Retrieves the current index lifecycle management (ILM) status."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ilm/status", "methods"=>["GET"]}]}, "params"=>{}}
868
+ request(api_name, api_spec, params)
869
+ end
870
+
871
+ # ilm.migrate_to_data_tiers
872
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-migrate-to-data-tiers.html", "description"=>"Migrates the indices and ILM policies away from custom node attribute allocation routing to data tiers routing"}
873
+ def ilm_migrate_to_data_tiers(params = {})
874
+ api_name = 'ilm.migrate_to_data_tiers'
875
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-migrate-to-data-tiers.html", "description"=>"Migrates the indices and ILM policies away from custom node attribute allocation routing to data tiers routing"}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ilm/migrate_to_data_tiers", "methods"=>["POST"]}]}, "params"=>{"dry_run"=>{"type"=>"boolean", "description"=>"If set to true it will simulate the migration, providing a way to retrieve the ILM policies and indices that need to be migrated. The default is false"}}, "body"=>{"description"=>"Optionally specify a legacy index template name to delete and optionally specify a node attribute name used for index shard routing (defaults to \"data\")", "required"=>false}}
876
+ request(api_name, api_spec, params)
877
+ end
878
+
879
+ # ilm.move_to_step
880
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-move-to-step.html", "description"=>"Manually moves an index into the specified step and executes that step."}
881
+ def ilm_move_to_step(params = {})
882
+ api_name = 'ilm.move_to_step'
883
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-move-to-step.html", "description"=>"Manually moves an index into the specified step and executes that step."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ilm/move/{index}", "methods"=>["POST"], "parts"=>{"index"=>{"type"=>"string", "description"=>"The name of the index whose lifecycle step is to change"}}}]}, "params"=>{}, "body"=>{"description"=>"The new lifecycle step to move to"}}
884
+ request(api_name, api_spec, params)
885
+ end
886
+
887
+ # ilm.put_lifecycle
888
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-put-lifecycle.html", "description"=>"Creates a lifecycle policy"}
889
+ def ilm_put_lifecycle(params = {})
890
+ api_name = 'ilm.put_lifecycle'
891
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-put-lifecycle.html", "description"=>"Creates a lifecycle policy"}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ilm/policy/{policy}", "methods"=>["PUT"], "parts"=>{"policy"=>{"type"=>"string", "description"=>"The name of the index lifecycle policy"}}}]}, "params"=>{}, "body"=>{"description"=>"The lifecycle policy definition to register"}}
892
+ request(api_name, api_spec, params)
893
+ end
894
+
895
+ # ilm.remove_policy
896
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-remove-policy.html", "description"=>"Removes the assigned lifecycle policy and stops managing the specified index"}
897
+ def ilm_remove_policy(params = {})
898
+ api_name = 'ilm.remove_policy'
899
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-remove-policy.html", "description"=>"Removes the assigned lifecycle policy and stops managing the specified index"}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/{index}/_ilm/remove", "methods"=>["POST"], "parts"=>{"index"=>{"type"=>"string", "description"=>"The name of the index to remove policy on"}}}]}, "params"=>{}}
900
+ request(api_name, api_spec, params)
901
+ end
902
+
903
+ # ilm.retry
904
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-retry-policy.html", "description"=>"Retries executing the policy for an index that is in the ERROR step."}
905
+ def ilm_retry(params = {})
906
+ api_name = 'ilm.retry'
907
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-retry-policy.html", "description"=>"Retries executing the policy for an index that is in the ERROR step."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/{index}/_ilm/retry", "methods"=>["POST"], "parts"=>{"index"=>{"type"=>"string", "description"=>"The name of the indices (comma-separated) whose failed lifecycle step is to be retry"}}}]}, "params"=>{}}
908
+ request(api_name, api_spec, params)
909
+ end
910
+
911
+ # ilm.start
912
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-start.html", "description"=>"Start the index lifecycle management (ILM) plugin."}
913
+ def ilm_start(params = {})
914
+ api_name = 'ilm.start'
915
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-start.html", "description"=>"Start the index lifecycle management (ILM) plugin."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ilm/start", "methods"=>["POST"]}]}, "params"=>{}}
916
+ request(api_name, api_spec, params)
917
+ end
918
+
919
+ # ilm.stop
920
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-stop.html", "description"=>"Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin"}
921
+ def ilm_stop(params = {})
922
+ api_name = 'ilm.stop'
923
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-stop.html", "description"=>"Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin"}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ilm/stop", "methods"=>["POST"]}]}, "params"=>{}}
924
+ request(api_name, api_spec, params)
925
+ end
926
+
927
+ # index
928
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html", "description"=>"Creates or updates a document in an index."}
929
+ def index(params = {})
930
+ api_name = 'index'
931
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "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"}}}, {"path"=>"/{index}/{type}", "methods"=>["POST"], "parts"=>{"index"=>{"type"=>"string", "description"=>"The name of the index"}, "type"=>{"type"=>"string", "description"=>"The type of the document", "deprecated"=>true}}, "deprecated"=>{"version"=>"7.0.0", "description"=>"Specifying types in urls has been deprecated"}}, {"path"=>"/{index}/{type}/{id}", "methods"=>["PUT", "POST"], "parts"=>{"id"=>{"type"=>"string", "description"=>"Document ID"}, "index"=>{"type"=>"string", "description"=>"The name of the index"}, "type"=>{"type"=>"string", "description"=>"The type of the document", "deprecated"=>true}}, "deprecated"=>{"version"=>"7.0.0", "description"=>"Specifying types in urls has been deprecated"}}]}, "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}}
932
+ request(api_name, api_spec, params)
933
+ end
934
+
935
+ # indices.add_block
936
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/index-modules-blocks.html", "description"=>"Adds a block to an index."}
937
+ def indices_add_block(params = {})
938
+ api_name = 'indices.add_block'
939
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"}, "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."}}}
940
+ request(api_name, api_spec, params)
941
+ end
942
+
943
+ # indices.analyze
944
+ # {"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."}
945
+ def indices_analyze(params = {})
946
+ api_name = 'indices.analyze'
947
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "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"}}
948
+ request(api_name, api_spec, params)
949
+ end
950
+
951
+ # indices.clear_cache
952
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clearcache.html", "description"=>"Clears all or specific caches for one or more indices."}
953
+ def indices_clear_cache(params = {})
954
+ api_name = 'indices.clear_cache'
955
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"}}}
956
+ request(api_name, api_spec, params)
957
+ end
958
+
959
+ # indices.clone
960
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clone-index.html", "description"=>"Clones an index"}
961
+ def indices_clone(params = {})
962
+ api_name = 'indices.clone'
963
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "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"}, "wait_for_active_shards"=>{"type"=>"string", "description"=>"Set the number of active shards to wait for on the cloned index before the operation returns."}}, "body"=>{"description"=>"The configuration for the target index (`settings` and `aliases`)"}}
964
+ request(api_name, api_spec, params)
965
+ end
966
+
967
+ # indices.close
968
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html", "description"=>"Closes an index."}
969
+ def indices_close(params = {})
970
+ api_name = 'indices.close'
971
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"}, "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. Set to `index-setting` to wait according to the index setting `index.write.wait_for_active_shards`, or `all` to wait for all shards, or an integer. Defaults to `0`."}}}
972
+ request(api_name, api_spec, params)
973
+ end
974
+
975
+ # indices.create
976
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-create-index.html", "description"=>"Creates an index with optional settings and mappings."}
977
+ def indices_create(params = {})
978
+ api_name = 'indices.create'
979
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/{index}", "methods"=>["PUT"], "parts"=>{"index"=>{"type"=>"string", "description"=>"The name of the index"}}}]}, "params"=>{"include_type_name"=>{"type"=>"boolean", "description"=>"Whether a type should be expected in the body of the mappings."}, "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"}}, "body"=>{"description"=>"The configuration for the index (`settings` and `mappings`)"}}
980
+ request(api_name, api_spec, params)
981
+ end
982
+
983
+ # indices.create_data_stream
984
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "description"=>"Creates a data stream"}
985
+ def indices_create_data_stream(params = {})
986
+ api_name = 'indices.create_data_stream'
987
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "description"=>"Creates a data stream"}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_data_stream/{name}", "methods"=>["PUT"], "parts"=>{"name"=>{"type"=>"string", "description"=>"The name of the data stream"}}}]}, "params"=>{}}
988
+ request(api_name, api_spec, params)
989
+ end
990
+
991
+ # indices.data_streams_stats
992
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "description"=>"Provides statistics on operations happening in a data stream."}
993
+ def indices_data_streams_stats(params = {})
994
+ api_name = 'indices.data_streams_stats'
995
+ 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"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"}}}]}}
996
+ request(api_name, api_spec, params)
997
+ end
998
+
999
+ # indices.delete
1000
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-index.html", "description"=>"Deletes an index."}
1001
+ def indices_delete(params = {})
1002
+ api_name = 'indices.delete'
1003
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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)"}}}
1004
+ request(api_name, api_spec, params)
1005
+ end
1006
+
1007
+ # indices.delete_alias
1008
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", "description"=>"Deletes an alias."}
1009
+ def indices_delete_alias(params = {})
1010
+ api_name = 'indices.delete_alias'
1011
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"}}}
1012
+ request(api_name, api_spec, params)
1013
+ end
1014
+
1015
+ # indices.delete_data_stream
1016
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "description"=>"Deletes a data stream."}
1017
+ def indices_delete_data_stream(params = {})
1018
+ api_name = 'indices.delete_data_stream'
1019
+ 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"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"=>{"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)"}}}
1020
+ request(api_name, api_spec, params)
1021
+ end
1022
+
1023
+ # indices.delete_index_template
1024
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", "description"=>"Deletes an index template."}
1025
+ def indices_delete_index_template(params = {})
1026
+ api_name = 'indices.delete_index_template'
1027
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"}}}
1028
+ request(api_name, api_spec, params)
1029
+ end
1030
+
1031
+ # indices.delete_template
1032
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", "description"=>"Deletes an index template."}
1033
+ def indices_delete_template(params = {})
1034
+ api_name = 'indices.delete_template'
1035
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"}}}
1036
+ request(api_name, api_spec, params)
1037
+ end
1038
+
1039
+ # indices.exists
1040
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-exists.html", "description"=>"Returns information about whether a particular index exists."}
1041
+ def indices_exists(params = {})
1042
+ api_name = 'indices.exists'
1043
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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}}}
1044
+ request(api_name, api_spec, params)
1045
+ end
1046
+ alias :indices_exists? :indices_exists
1047
+
1048
+ # indices.exists_alias
1049
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", "description"=>"Returns information about whether a particular alias exists."}
1050
+ def indices_exists_alias(params = {})
1051
+ api_name = 'indices.exists_alias'
1052
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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)"}}}
1053
+ request(api_name, api_spec, params)
1054
+ end
1055
+ alias :indices_exists_alias? :indices_exists_alias
1056
+
1057
+ # indices.exists_index_template
1058
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", "description"=>"Returns information about whether a particular index template exists."}
1059
+ def indices_exists_index_template(params = {})
1060
+ api_name = 'indices.exists_index_template'
1061
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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)"}}}
1062
+ request(api_name, api_spec, params)
1063
+ end
1064
+ alias :indices_exists_index_template? :indices_exists_index_template
1065
+
1066
+ # indices.exists_template
1067
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", "description"=>"Returns information about whether a particular index template exists."}
1068
+ def indices_exists_template(params = {})
1069
+ api_name = 'indices.exists_template'
1070
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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)"}}}
1071
+ request(api_name, api_spec, params)
1072
+ end
1073
+ alias :indices_exists_template? :indices_exists_template
1074
+
1075
+ # indices.exists_type
1076
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-types-exists.html", "description"=>"Returns information about whether a particular document type exists. (DEPRECATED)"}
1077
+ def indices_exists_type(params = {})
1078
+ api_name = 'indices.exists_type'
1079
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-types-exists.html", "description"=>"Returns information about whether a particular document type exists. (DEPRECATED)"}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/{index}/_mapping/{type}", "methods"=>["HEAD"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names; use `_all` to check the types across all indices"}, "type"=>{"type"=>"list", "description"=>"A comma-separated list of document types to check"}}}]}, "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."}, "local"=>{"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}}}
1080
+ request(api_name, api_spec, params)
1081
+ end
1082
+ alias :indices_exists_type? :indices_exists_type
1083
+
1084
+ # indices.flush
1085
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-flush.html", "description"=>"Performs the flush operation on one or more indices."}
1086
+ def indices_flush(params = {})
1087
+ api_name = 'indices.flush'
1088
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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."}}}
1089
+ request(api_name, api_spec, params)
1090
+ end
1091
+
1092
+ # indices.flush_synced
1093
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-synced-flush-api.html", "description"=>"Performs a synced flush operation on one or more indices. Synced flush is deprecated and will be removed in 8.0. Use flush instead"}
1094
+ def indices_flush_synced(params = {})
1095
+ api_name = 'indices.flush_synced'
1096
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-synced-flush-api.html", "description"=>"Performs a synced flush operation on one or more indices. Synced flush is deprecated and will be removed in 8.0. Use flush instead"}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_flush/synced", "methods"=>["POST", "GET"], "deprecated"=>{"version"=>"7.6.0", "description"=>"Synced flush is deprecated and will be removed in 8.0. Use flush instead."}}, {"path"=>"/{index}/_flush/synced", "methods"=>["POST", "GET"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names; use `_all` or empty string for all indices"}}, "deprecated"=>{"version"=>"7.6.0", "description"=>"Synced flush is deprecated and will be removed in 8.0. Use flush instead."}}]}, "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", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}}}
1097
+ request(api_name, api_spec, params)
1098
+ end
1099
+
1100
+ # indices.forcemerge
1101
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-forcemerge.html", "description"=>"Performs the force merge operation on one or more indices."}
1102
+ def indices_forcemerge(params = {})
1103
+ api_name = 'indices.forcemerge'
1104
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"}}}
1105
+ request(api_name, api_spec, params)
1106
+ end
1107
+
1108
+ # indices.freeze
1109
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/freeze-index-api.html", "description"=>"Freezes an index. A frozen index has almost no overhead on the cluster (except for maintaining its metadata in memory) and is read-only."}
1110
+ def indices_freeze(params = {})
1111
+ api_name = 'indices.freeze'
1112
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/freeze-index-api.html", "description"=>"Freezes an index. A frozen index has almost no overhead on the cluster (except for maintaining its metadata in memory) and is read-only."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/{index}/_freeze", "methods"=>["POST"], "parts"=>{"index"=>{"type"=>"string", "description"=>"The name of the index to freeze"}}, "deprecated"=>{"version"=>"7.14.0", "description"=>"Frozen indices are deprecated because they provide no benefit given improvements in heap memory utilization. They will be removed in a future release."}}]}, "params"=>{"timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}, "master_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to master"}, "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."}}}
1113
+ request(api_name, api_spec, params)
1114
+ end
1115
+
1116
+ # indices.get
1117
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index.html", "description"=>"Returns information about one or more indices."}
1118
+ def indices_get(params = {})
1119
+ api_name = 'indices.get'
1120
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/{index}", "methods"=>["GET"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names"}}}]}, "params"=>{"include_type_name"=>{"type"=>"boolean", "description"=>"Whether to add the type name to the response (default: false)"}, "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"}}}
1121
+ request(api_name, api_spec, params)
1122
+ end
1123
+
1124
+ # indices.get_alias
1125
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", "description"=>"Returns an alias."}
1126
+ def indices_get_alias(params = {})
1127
+ api_name = 'indices.get_alias'
1128
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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)"}}}
1129
+ request(api_name, api_spec, params)
1130
+ end
1131
+
1132
+ # indices.get_data_stream
1133
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "description"=>"Returns data streams."}
1134
+ def indices_get_data_stream(params = {})
1135
+ api_name = 'indices.get_data_stream'
1136
+ 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"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"=>{"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)"}}}
1137
+ request(api_name, api_spec, params)
1138
+ end
1139
+
1140
+ # indices.get_field_mapping
1141
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-field-mapping.html", "description"=>"Returns mapping for one or more fields."}
1142
+ def indices_get_field_mapping(params = {})
1143
+ api_name = 'indices.get_field_mapping'
1144
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"}}}, {"path"=>"/_mapping/{type}/field/{fields}", "methods"=>["GET"], "parts"=>{"type"=>{"type"=>"list", "description"=>"A comma-separated list of document types", "deprecated"=>true}, "fields"=>{"type"=>"list", "description"=>"A comma-separated list of fields"}}, "deprecated"=>{"version"=>"7.0.0", "description"=>"Specifying types in urls has been deprecated"}}, {"path"=>"/{index}/_mapping/{type}/field/{fields}", "methods"=>["GET"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names"}, "type"=>{"type"=>"list", "description"=>"A comma-separated list of document types", "deprecated"=>true}, "fields"=>{"type"=>"list", "description"=>"A comma-separated list of fields"}}, "deprecated"=>{"version"=>"7.0.0", "description"=>"Specifying types in urls has been deprecated"}}]}, "params"=>{"include_type_name"=>{"type"=>"boolean", "description"=>"Whether a type should be returned in the body of the mappings."}, "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)"}}}
1145
+ request(api_name, api_spec, params)
1146
+ end
1147
+
1148
+ # indices.get_index_template
1149
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", "description"=>"Returns an index template."}
1150
+ def indices_get_index_template(params = {})
1151
+ api_name = 'indices.get_index_template'
1152
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"}, "local"=>{"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}}}
1153
+ request(api_name, api_spec, params)
1154
+ end
1155
+
1156
+ # indices.get_mapping
1157
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-mapping.html", "description"=>"Returns mappings for one or more indices."}
1158
+ def indices_get_mapping(params = {})
1159
+ api_name = 'indices.get_mapping'
1160
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_mapping", "methods"=>["GET"]}, {"path"=>"/{index}/_mapping", "methods"=>["GET"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names"}}}, {"path"=>"/_mapping/{type}", "methods"=>["GET"], "parts"=>{"type"=>{"type"=>"list", "description"=>"A comma-separated list of document types", "deprecated"=>true}}, "deprecated"=>{"version"=>"7.0.0", "description"=>"Specifying types in urls has been deprecated"}}, {"path"=>"/{index}/_mapping/{type}", "methods"=>["GET"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names"}, "type"=>{"type"=>"list", "description"=>"A comma-separated list of document types", "deprecated"=>true}}, "deprecated"=>{"version"=>"7.0.0", "description"=>"Specifying types in urls has been deprecated"}}]}, "params"=>{"include_type_name"=>{"type"=>"boolean", "description"=>"Whether to add the type name to the response (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."}, "master_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to master"}, "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."}}}}
1161
+ request(api_name, api_spec, params)
1162
+ end
1163
+
1164
+ # indices.get_settings
1165
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html", "description"=>"Returns settings for one or more indices."}
1166
+ def indices_get_settings(params = {})
1167
+ api_name = 'indices.get_settings'
1168
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"}, "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}}}
1169
+ request(api_name, api_spec, params)
1170
+ end
1171
+
1172
+ # indices.get_template
1173
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", "description"=>"Returns an index template."}
1174
+ def indices_get_template(params = {})
1175
+ api_name = 'indices.get_template'
1176
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"=>{"include_type_name"=>{"type"=>"boolean", "description"=>"Whether a type should be returned in the body of the mappings."}, "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)"}}}
1177
+ request(api_name, api_spec, params)
1178
+ end
1179
+
1180
+ # indices.get_upgrade
1181
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html", "description"=>"DEPRECATED Returns a progress status of current upgrade."}
1182
+ def indices_get_upgrade(params = {})
1183
+ api_name = 'indices.get_upgrade'
1184
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html", "description"=>"DEPRECATED Returns a progress status of current upgrade."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_upgrade", "methods"=>["GET"], "deprecated"=>{"version"=>"8.0.0", "description"=>"The _upgrade API is no longer useful and will be removed. Instead, see _reindex API."}}, {"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"}}, "deprecated"=>{"version"=>"8.0.0", "description"=>"The _upgrade API is no longer useful and will be removed. Instead, see _reindex API."}}]}, "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."}}}
1185
+ request(api_name, api_spec, params)
1186
+ end
1187
+
1188
+ # indices.migrate_to_data_stream
1189
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "description"=>"Migrates an alias to a data stream"}
1190
+ def indices_migrate_to_data_stream(params = {})
1191
+ api_name = 'indices.migrate_to_data_stream'
1192
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "description"=>"Migrates an alias to a data stream"}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_data_stream/_migrate/{name}", "methods"=>["POST"], "parts"=>{"name"=>{"type"=>"string", "description"=>"The name of the alias to migrate"}}}]}, "params"=>{}}
1193
+ request(api_name, api_spec, params)
1194
+ end
1195
+
1196
+ # indices.open
1197
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html", "description"=>"Opens an index."}
1198
+ def indices_open(params = {})
1199
+ api_name = 'indices.open'
1200
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"}, "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."}}}
1201
+ request(api_name, api_spec, params)
1202
+ end
1203
+
1204
+ # indices.promote_data_stream
1205
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "description"=>"Promotes a data stream from a replicated data stream managed by CCR to a regular data stream"}
1206
+ def indices_promote_data_stream(params = {})
1207
+ api_name = 'indices.promote_data_stream'
1208
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "description"=>"Promotes a data stream from a replicated data stream managed by CCR to a regular data stream"}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_data_stream/_promote/{name}", "methods"=>["POST"], "parts"=>{"name"=>{"type"=>"string", "description"=>"The name of the data stream"}}}]}, "params"=>{}}
1209
+ request(api_name, api_spec, params)
1210
+ end
1211
+
1212
+ # indices.put_alias
1213
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", "description"=>"Creates or updates an alias."}
1214
+ def indices_put_alias(params = {})
1215
+ api_name = 'indices.put_alias'
1216
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "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"}}, "body"=>{"description"=>"The settings for the alias, such as `routing` or `filter`", "required"=>false}}
1217
+ request(api_name, api_spec, params)
1218
+ end
1219
+
1220
+ # indices.put_index_template
1221
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", "description"=>"Creates or updates an index template."}
1222
+ def indices_put_index_template(params = {})
1223
+ api_name = 'indices.put_index_template'
1224
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "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"}}, "body"=>{"description"=>"The template definition", "required"=>true}}
1225
+ request(api_name, api_spec, params)
1226
+ end
1227
+
1228
+ # indices.put_mapping
1229
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html", "description"=>"Updates the index mappings."}
1230
+ def indices_put_mapping(params = {})
1231
+ api_name = 'indices.put_mapping'
1232
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "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."}}}, {"path"=>"/{index}/{type}/_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."}, "type"=>{"type"=>"string", "description"=>"The name of the document type", "deprecated"=>true}}, "deprecated"=>{"version"=>"7.0.0", "description"=>"Specifying types in urls has been deprecated"}}, {"path"=>"/{index}/_mapping/{type}", "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."}, "type"=>{"type"=>"string", "description"=>"The name of the document type", "deprecated"=>true}}, "deprecated"=>{"version"=>"7.0.0", "description"=>"Specifying types in urls has been deprecated"}}, {"path"=>"/{index}/{type}/_mappings", "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."}, "type"=>{"type"=>"string", "description"=>"The name of the document type", "deprecated"=>true}}, "deprecated"=>{"version"=>"7.0.0", "description"=>"Specifying types in urls has been deprecated"}}, {"path"=>"/{index}/_mappings/{type}", "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."}, "type"=>{"type"=>"string", "description"=>"The name of the document type", "deprecated"=>true}}, "deprecated"=>{"version"=>"7.0.0", "description"=>"Specifying types in urls has been deprecated"}}, {"path"=>"/_mappings/{type}", "methods"=>["PUT", "POST"], "parts"=>{"type"=>{"type"=>"string", "description"=>"The name of the document type", "deprecated"=>true}}, "deprecated"=>{"version"=>"7.0.0", "description"=>"Specifying types in urls has been deprecated"}}, {"path"=>"/{index}/_mappings", "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."}}, "deprecated"=>{"version"=>"7.0.0", "description"=>"The plural mappings is accepted but only /_mapping is documented"}}, {"path"=>"/_mapping/{type}", "methods"=>["PUT", "POST"], "parts"=>{"type"=>{"type"=>"string", "description"=>"The name of the document type", "deprecated"=>true}}, "deprecated"=>{"version"=>"7.0.0", "description"=>"Specifying types in urls has been deprecated"}}]}, "params"=>{"include_type_name"=>{"type"=>"boolean", "description"=>"Whether a type should be expected in the body of the mappings."}, "timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}, "master_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to master"}, "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}}
1233
+ request(api_name, api_spec, params)
1234
+ end
1235
+
1236
+ # indices.put_settings
1237
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html", "description"=>"Updates the index settings."}
1238
+ def indices_put_settings(params = {})
1239
+ api_name = 'indices.put_settings'
1240
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "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"}, "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}}
1241
+ request(api_name, api_spec, params)
1242
+ end
1243
+
1244
+ # indices.put_template
1245
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", "description"=>"Creates or updates an index template."}
1246
+ def indices_put_template(params = {})
1247
+ api_name = 'indices.put_template'
1248
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_template/{name}", "methods"=>["PUT", "POST"], "parts"=>{"name"=>{"type"=>"string", "description"=>"The name of the template"}}}]}, "params"=>{"include_type_name"=>{"type"=>"boolean", "description"=>"Whether a type should be returned in the body of the mappings."}, "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"}}, "body"=>{"description"=>"The template definition", "required"=>true}}
1249
+ request(api_name, api_spec, params)
1250
+ end
1251
+
1252
+ # indices.recovery
1253
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-recovery.html", "description"=>"Returns information about ongoing index shard recoveries."}
1254
+ def indices_recovery(params = {})
1255
+ api_name = 'indices.recovery'
1256
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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}}}
1257
+ request(api_name, api_spec, params)
1258
+ end
1259
+
1260
+ # indices.refresh
1261
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html", "description"=>"Performs the refresh operation in one or more indices."}
1262
+ def indices_refresh(params = {})
1263
+ api_name = 'indices.refresh'
1264
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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."}}}
1265
+ request(api_name, api_spec, params)
1266
+ end
1267
+
1268
+ # indices.reload_search_analyzers
1269
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-reload-analyzers.html", "description"=>"Reloads an index's search analyzers and their resources."}
1270
+ def indices_reload_search_analyzers(params = {})
1271
+ api_name = 'indices.reload_search_analyzers'
1272
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-reload-analyzers.html", "description"=>"Reloads an index's search analyzers and their resources."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/{index}/_reload_search_analyzers", "methods"=>["GET", "POST"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names to reload analyzers for"}}}]}, "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."}}}
1273
+ request(api_name, api_spec, params)
1274
+ end
1275
+
1276
+ # indices.resolve_index
1277
+ # {"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"}
1278
+ def indices_resolve_index(params = {})
1279
+ api_name = 'indices.resolve_index'
1280
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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)"}}}
1281
+ request(api_name, api_spec, params)
1282
+ end
1283
+
1284
+ # indices.rollover
1285
+ # {"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."}
1286
+ def indices_rollover(params = {})
1287
+ api_name = 'indices.rollover'
1288
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "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"=>{"include_type_name"=>{"type"=>"boolean", "description"=>"Whether a type should be included in the body of the mappings."}, "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"}, "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"}}
1289
+ request(api_name, api_spec, params)
1290
+ end
1291
+
1292
+ # indices.segments
1293
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-segments.html", "description"=>"Provides low-level information about segments in a Lucene index."}
1294
+ def indices_segments(params = {})
1295
+ api_name = 'indices.segments'
1296
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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}}}
1297
+ request(api_name, api_spec, params)
1298
+ end
1299
+
1300
+ # indices.shard_stores
1301
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shards-stores.html", "description"=>"Provides store information for shard copies of indices."}
1302
+ def indices_shard_stores(params = {})
1303
+ api_name = 'indices.shard_stores'
1304
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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."}}}
1305
+ request(api_name, api_spec, params)
1306
+ end
1307
+
1308
+ # indices.shrink
1309
+ # {"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."}
1310
+ def indices_shrink(params = {})
1311
+ api_name = 'indices.shrink'
1312
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "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"}, "wait_for_active_shards"=>{"type"=>"string", "description"=>"Set the number of active shards to wait for on the shrunken index before the operation returns."}}, "body"=>{"description"=>"The configuration for the target index (`settings` and `aliases`)"}}
1313
+ request(api_name, api_spec, params)
1314
+ end
1315
+
1316
+ # indices.simulate_index_template
1317
+ # {"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"}
1318
+ def indices_simulate_index_template(params = {})
1319
+ api_name = 'indices.simulate_index_template'
1320
+ 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"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "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"}}, "body"=>{"description"=>"New index template definition, which will be included in the simulation, as if it already exists in the system", "required"=>false}}
1321
+ request(api_name, api_spec, params)
1322
+ end
1323
+
1324
+ # indices.simulate_template
1325
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", "description"=>"Simulate resolving the given template name or body"}
1326
+ def indices_simulate_template(params = {})
1327
+ api_name = 'indices.simulate_template'
1328
+ 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"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "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"}}, "body"=>{"description"=>"New index template definition to be simulated, if no index template name is specified", "required"=>false}}
1329
+ request(api_name, api_spec, params)
1330
+ end
1331
+
1332
+ # indices.split
1333
+ # {"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."}
1334
+ def indices_split(params = {})
1335
+ api_name = 'indices.split'
1336
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "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"}, "wait_for_active_shards"=>{"type"=>"string", "description"=>"Set the number of active shards to wait for on the shrunken index before the operation returns."}}, "body"=>{"description"=>"The configuration for the target index (`settings` and `aliases`)"}}
1337
+ request(api_name, api_spec, params)
1338
+ end
1339
+
1340
+ # indices.stats
1341
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-stats.html", "description"=>"Provides statistics on operations happening in an index."}
1342
+ def indices_stats(params = {})
1343
+ api_name = 'indices.stats'
1344
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"}, "types"=>{"type"=>"list", "description"=>"A comma-separated list of document types for the `indexing` index metric"}, "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}}}
1345
+ request(api_name, api_spec, params)
1346
+ end
1347
+
1348
+ # indices.unfreeze
1349
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/unfreeze-index-api.html", "description"=>"Unfreezes an index. When a frozen index is unfrozen, the index goes through the normal recovery process and becomes writeable again."}
1350
+ def indices_unfreeze(params = {})
1351
+ api_name = 'indices.unfreeze'
1352
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/unfreeze-index-api.html", "description"=>"Unfreezes an index. When a frozen index is unfrozen, the index goes through the normal recovery process and becomes writeable again."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/{index}/_unfreeze", "methods"=>["POST"], "parts"=>{"index"=>{"type"=>"string", "description"=>"The name of the index to unfreeze"}}, "deprecated"=>{"version"=>"7.14.0", "description"=>"Frozen indices are deprecated because they provide no benefit given improvements in heap memory utilization. They will be removed in a future release."}}]}, "params"=>{"timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}, "master_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to master"}, "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."}}}
1353
+ request(api_name, api_spec, params)
1354
+ end
1355
+
1356
+ # indices.update_aliases
1357
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", "description"=>"Updates index aliases."}
1358
+ def indices_update_aliases(params = {})
1359
+ api_name = 'indices.update_aliases'
1360
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_aliases", "methods"=>["POST"]}]}, "params"=>{"timeout"=>{"type"=>"time", "description"=>"Request timeout"}, "master_timeout"=>{"type"=>"time", "description"=>"Specify timeout for connection to master"}}, "body"=>{"description"=>"The definition of `actions` to perform", "required"=>true}}
1361
+ request(api_name, api_spec, params)
1362
+ end
1363
+
1364
+ # indices.upgrade
1365
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html", "description"=>"DEPRECATED Upgrades to the current version of Lucene."}
1366
+ def indices_upgrade(params = {})
1367
+ api_name = 'indices.upgrade'
1368
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html", "description"=>"DEPRECATED Upgrades to the current version of Lucene."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_upgrade", "methods"=>["POST"], "deprecated"=>{"version"=>"8.0.0", "description"=>"The _upgrade API is no longer useful and will be removed. Instead, see _reindex API."}}, {"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"}}, "deprecated"=>{"version"=>"8.0.0", "description"=>"The _upgrade API is no longer useful and will be removed. Instead, see _reindex API."}}]}, "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"}}}
1369
+ request(api_name, api_spec, params)
1370
+ end
1371
+
1372
+ # indices.validate_query
1373
+ # {"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."}
1374
+ def indices_validate_query(params = {})
1375
+ api_name = 'indices.validate_query'
1376
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "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"}}}, {"path"=>"/{index}/{type}/_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"}, "type"=>{"type"=>"list", "description"=>"A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types", "deprecated"=>true}}, "deprecated"=>{"version"=>"7.0.0", "description"=>"Specifying types in urls has been deprecated"}}]}, "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"}}
1377
+ request(api_name, api_spec, params)
1378
+ end
1379
+
1380
+ # info
1381
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html", "description"=>"Returns basic information about the cluster."}
1382
+ def info(params = {})
1383
+ api_name = 'info'
1384
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/", "methods"=>["GET"]}]}, "params"=>{}}
1385
+ request(api_name, api_spec, params)
1386
+ end
1387
+
1388
+ # ingest.delete_pipeline
1389
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-pipeline-api.html", "description"=>"Deletes a pipeline."}
1390
+ def ingest_delete_pipeline(params = {})
1391
+ api_name = 'ingest.delete_pipeline'
1392
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"}, "timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}}}
1393
+ request(api_name, api_spec, params)
1394
+ end
1395
+
1396
+ # ingest.geo_ip_stats
1397
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/geoip-stats-api.html", "description"=>"Returns statistical information about geoip databases"}
1398
+ def ingest_geo_ip_stats(params = {})
1399
+ api_name = 'ingest.geo_ip_stats'
1400
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/geoip-stats-api.html", "description"=>"Returns statistical information about geoip databases"}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ingest/geoip/stats", "methods"=>["GET"]}]}}
1401
+ request(api_name, api_spec, params)
1402
+ end
1403
+
1404
+ # ingest.get_pipeline
1405
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/get-pipeline-api.html", "description"=>"Returns a pipeline."}
1406
+ def ingest_get_pipeline(params = {})
1407
+ api_name = 'ingest.get_pipeline'
1408
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"=>{"summary"=>{"type"=>"boolean", "description"=>"Return pipelines without their definitions (default: false)"}, "master_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}}}
1409
+ request(api_name, api_spec, params)
1410
+ end
1411
+
1412
+ # ingest.processor_grok
1413
+ # {"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."}
1414
+ def ingest_processor_grok(params = {})
1415
+ api_name = 'ingest.processor_grok'
1416
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ingest/processor/grok", "methods"=>["GET"]}]}, "params"=>{}}
1417
+ request(api_name, api_spec, params)
1418
+ end
1419
+
1420
+ # ingest.put_pipeline
1421
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/put-pipeline-api.html", "description"=>"Creates or updates a pipeline."}
1422
+ def ingest_put_pipeline(params = {})
1423
+ api_name = 'ingest.put_pipeline'
1424
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "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"}, "timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}}, "body"=>{"description"=>"The ingest definition", "required"=>true}}
1425
+ request(api_name, api_spec, params)
1426
+ end
1427
+
1428
+ # ingest.simulate
1429
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-pipeline-api.html", "description"=>"Allows to simulate a pipeline with example documents."}
1430
+ def ingest_simulate(params = {})
1431
+ api_name = 'ingest.simulate'
1432
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "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}}
1433
+ request(api_name, api_spec, params)
1434
+ end
1435
+
1436
+ # license.delete
1437
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-license.html", "description"=>"Deletes licensing information for the cluster"}
1438
+ def license_delete(params = {})
1439
+ api_name = 'license.delete'
1440
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-license.html", "description"=>"Deletes licensing information for the cluster"}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_license", "methods"=>["DELETE"]}]}}
1441
+ request(api_name, api_spec, params)
1442
+ end
1443
+
1444
+ # license.get
1445
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/get-license.html", "description"=>"Retrieves licensing information for the cluster"}
1446
+ def license_get(params = {})
1447
+ api_name = 'license.get'
1448
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/get-license.html", "description"=>"Retrieves licensing information for the cluster"}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_license", "methods"=>["GET"]}]}, "params"=>{"local"=>{"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, "accept_enterprise"=>{"type"=>"boolean", "description"=>"If the active license is an enterprise license, return type as 'enterprise' (default: false)"}}}
1449
+ request(api_name, api_spec, params)
1450
+ end
1451
+
1452
+ # license.get_basic_status
1453
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/get-basic-status.html", "description"=>"Retrieves information about the status of the basic license."}
1454
+ def license_get_basic_status(params = {})
1455
+ api_name = 'license.get_basic_status'
1456
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/get-basic-status.html", "description"=>"Retrieves information about the status of the basic license."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_license/basic_status", "methods"=>["GET"]}]}, "params"=>{}}
1457
+ request(api_name, api_spec, params)
1458
+ end
1459
+
1460
+ # license.get_trial_status
1461
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/get-trial-status.html", "description"=>"Retrieves information about the status of the trial license."}
1462
+ def license_get_trial_status(params = {})
1463
+ api_name = 'license.get_trial_status'
1464
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/get-trial-status.html", "description"=>"Retrieves information about the status of the trial license."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_license/trial_status", "methods"=>["GET"]}]}, "params"=>{}}
1465
+ request(api_name, api_spec, params)
1466
+ end
1467
+
1468
+ # license.post
1469
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/update-license.html", "description"=>"Updates the license for the cluster."}
1470
+ def license_post(params = {})
1471
+ api_name = 'license.post'
1472
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/update-license.html", "description"=>"Updates the license for the cluster."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_license", "methods"=>["PUT", "POST"]}]}, "params"=>{"acknowledge"=>{"type"=>"boolean", "description"=>"whether the user has acknowledged acknowledge messages (default: false)"}}, "body"=>{"description"=>"licenses to be installed"}}
1473
+ request(api_name, api_spec, params)
1474
+ end
1475
+
1476
+ # license.post_start_basic
1477
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/start-basic.html", "description"=>"Starts an indefinite basic license."}
1478
+ def license_post_start_basic(params = {})
1479
+ api_name = 'license.post_start_basic'
1480
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/start-basic.html", "description"=>"Starts an indefinite basic license."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_license/start_basic", "methods"=>["POST"]}]}, "params"=>{"acknowledge"=>{"type"=>"boolean", "description"=>"whether the user has acknowledged acknowledge messages (default: false)"}}}
1481
+ request(api_name, api_spec, params)
1482
+ end
1483
+
1484
+ # license.post_start_trial
1485
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/start-trial.html", "description"=>"starts a limited time trial license."}
1486
+ def license_post_start_trial(params = {})
1487
+ api_name = 'license.post_start_trial'
1488
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/start-trial.html", "description"=>"starts a limited time trial license."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_license/start_trial", "methods"=>["POST"]}]}, "params"=>{"type"=>{"type"=>"string", "description"=>"The type of trial license to generate (default: \"trial\")"}, "acknowledge"=>{"type"=>"boolean", "description"=>"whether the user has acknowledged acknowledge messages (default: false)"}}}
1489
+ request(api_name, api_spec, params)
1490
+ end
1491
+
1492
+ # logstash.delete_pipeline
1493
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-delete-pipeline.html", "description"=>"Deletes Logstash Pipelines used by Central Management"}
1494
+ def logstash_delete_pipeline(params = {})
1495
+ api_name = 'logstash.delete_pipeline'
1496
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-delete-pipeline.html", "description"=>"Deletes Logstash Pipelines used by Central Management"}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_logstash/pipeline/{id}", "methods"=>["DELETE"], "parts"=>{"id"=>{"type"=>"string", "description"=>"The ID of the Pipeline"}}}]}, "params"=>{}}
1497
+ request(api_name, api_spec, params)
1498
+ end
1499
+
1500
+ # logstash.get_pipeline
1501
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-get-pipeline.html", "description"=>"Retrieves Logstash Pipelines used by Central Management"}
1502
+ def logstash_get_pipeline(params = {})
1503
+ api_name = 'logstash.get_pipeline'
1504
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-get-pipeline.html", "description"=>"Retrieves Logstash Pipelines used by Central Management"}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_logstash/pipeline/{id}", "methods"=>["GET"], "parts"=>{"id"=>{"type"=>"string", "description"=>"A comma-separated list of Pipeline IDs"}}}]}, "params"=>{}}
1505
+ request(api_name, api_spec, params)
1506
+ end
1507
+
1508
+ # logstash.put_pipeline
1509
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-put-pipeline.html", "description"=>"Adds and updates Logstash Pipelines used for Central Management"}
1510
+ def logstash_put_pipeline(params = {})
1511
+ api_name = 'logstash.put_pipeline'
1512
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-put-pipeline.html", "description"=>"Adds and updates Logstash Pipelines used for Central Management"}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_logstash/pipeline/{id}", "methods"=>["PUT"], "parts"=>{"id"=>{"type"=>"string", "description"=>"The ID of the Pipeline"}}}]}, "params"=>{}, "body"=>{"description"=>"The Pipeline to add or update", "required"=>true}}
1513
+ request(api_name, api_spec, params)
1514
+ end
1515
+
1516
+ # mget
1517
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html", "description"=>"Allows to get multiple documents in one request."}
1518
+ def mget(params = {})
1519
+ api_name = 'mget'
1520
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_mget", "methods"=>["GET", "POST"]}, {"path"=>"/{index}/_mget", "methods"=>["GET", "POST"], "parts"=>{"index"=>{"type"=>"string", "description"=>"The name of the index"}}}, {"path"=>"/{index}/{type}/_mget", "methods"=>["GET", "POST"], "parts"=>{"index"=>{"type"=>"string", "description"=>"The name of the index"}, "type"=>{"type"=>"string", "description"=>"The type of the document", "deprecated"=>true}}, "deprecated"=>{"version"=>"7.0.0", "description"=>"Specifying types in urls has been deprecated"}}]}, "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 and type is provided in the URL.", "required"=>true}}
1521
+ request(api_name, api_spec, params)
1522
+ end
1523
+
1524
+ # migration.deprecations
1525
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-deprecation.html", "description"=>"Retrieves information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version."}
1526
+ def migration_deprecations(params = {})
1527
+ api_name = 'migration.deprecations'
1528
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-deprecation.html", "description"=>"Retrieves information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_migration/deprecations", "methods"=>["GET"]}, {"path"=>"/{index}/_migration/deprecations", "methods"=>["GET"], "parts"=>{"index"=>{"type"=>"string", "description"=>"Index pattern"}}}]}, "params"=>{}}
1529
+ request(api_name, api_spec, params)
1530
+ end
1531
+
1532
+ # ml.close_job
1533
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-close-job.html", "description"=>"Closes one or more anomaly detection jobs. A job can be opened and closed multiple times throughout its lifecycle."}
1534
+ def ml_close_job(params = {})
1535
+ api_name = 'ml.close_job'
1536
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-close-job.html", "description"=>"Closes one or more anomaly detection jobs. A job can be opened and closed multiple times throughout its lifecycle."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/anomaly_detectors/{job_id}/_close", "methods"=>["POST"], "parts"=>{"job_id"=>{"type"=>"string", "description"=>"The name of the job to close"}}}]}, "params"=>{"allow_no_match"=>{"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)"}, "allow_no_jobs"=>{"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)", "deprecated"=>true}, "force"=>{"type"=>"boolean", "required"=>false, "description"=>"True if the job should be forcefully closed"}, "timeout"=>{"type"=>"time", "description"=>"Controls the time to wait until a job has closed. Default to 30 minutes"}}, "body"=>{"description"=>"The URL params optionally sent in the body", "required"=>false}}
1537
+ request(api_name, api_spec, params)
1538
+ end
1539
+
1540
+ # ml.delete_calendar
1541
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar.html", "description"=>"Deletes a calendar."}
1542
+ def ml_delete_calendar(params = {})
1543
+ api_name = 'ml.delete_calendar'
1544
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar.html", "description"=>"Deletes a calendar."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/calendars/{calendar_id}", "methods"=>["DELETE"], "parts"=>{"calendar_id"=>{"type"=>"string", "description"=>"The ID of the calendar to delete"}}}]}}
1545
+ request(api_name, api_spec, params)
1546
+ end
1547
+
1548
+ # ml.delete_calendar_event
1549
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-event.html", "description"=>"Deletes scheduled events from a calendar."}
1550
+ def ml_delete_calendar_event(params = {})
1551
+ api_name = 'ml.delete_calendar_event'
1552
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-event.html", "description"=>"Deletes scheduled events from a calendar."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/calendars/{calendar_id}/events/{event_id}", "methods"=>["DELETE"], "parts"=>{"calendar_id"=>{"type"=>"string", "description"=>"The ID of the calendar to modify"}, "event_id"=>{"type"=>"string", "description"=>"The ID of the event to remove from the calendar"}}}]}}
1553
+ request(api_name, api_spec, params)
1554
+ end
1555
+
1556
+ # ml.delete_calendar_job
1557
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-job.html", "description"=>"Deletes anomaly detection jobs from a calendar."}
1558
+ def ml_delete_calendar_job(params = {})
1559
+ api_name = 'ml.delete_calendar_job'
1560
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-job.html", "description"=>"Deletes anomaly detection jobs from a calendar."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/calendars/{calendar_id}/jobs/{job_id}", "methods"=>["DELETE"], "parts"=>{"calendar_id"=>{"type"=>"string", "description"=>"The ID of the calendar to modify"}, "job_id"=>{"type"=>"string", "description"=>"The ID of the job to remove from the calendar"}}}]}}
1561
+ request(api_name, api_spec, params)
1562
+ end
1563
+
1564
+ # ml.delete_data_frame_analytics
1565
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-dfanalytics.html", "description"=>"Deletes an existing data frame analytics job."}
1566
+ def ml_delete_data_frame_analytics(params = {})
1567
+ api_name = 'ml.delete_data_frame_analytics'
1568
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-dfanalytics.html", "description"=>"Deletes an existing data frame analytics job."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/data_frame/analytics/{id}", "methods"=>["DELETE"], "parts"=>{"id"=>{"type"=>"string", "description"=>"The ID of the data frame analytics to delete"}}}]}, "params"=>{"force"=>{"type"=>"boolean", "description"=>"True if the job should be forcefully deleted", "default"=>false}, "timeout"=>{"type"=>"time", "description"=>"Controls the time to wait until a job is deleted. Defaults to 1 minute"}}}
1569
+ request(api_name, api_spec, params)
1570
+ end
1571
+
1572
+ # ml.delete_datafeed
1573
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-datafeed.html", "description"=>"Deletes an existing datafeed."}
1574
+ def ml_delete_datafeed(params = {})
1575
+ api_name = 'ml.delete_datafeed'
1576
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-datafeed.html", "description"=>"Deletes an existing datafeed."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/datafeeds/{datafeed_id}", "methods"=>["DELETE"], "parts"=>{"datafeed_id"=>{"type"=>"string", "description"=>"The ID of the datafeed to delete"}}}]}, "params"=>{"force"=>{"type"=>"boolean", "required"=>false, "description"=>"True if the datafeed should be forcefully deleted"}}}
1577
+ request(api_name, api_spec, params)
1578
+ end
1579
+
1580
+ # ml.delete_expired_data
1581
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-expired-data.html", "description"=>"Deletes expired and unused machine learning data."}
1582
+ def ml_delete_expired_data(params = {})
1583
+ api_name = 'ml.delete_expired_data'
1584
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-expired-data.html", "description"=>"Deletes expired and unused machine learning data."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/_delete_expired_data/{job_id}", "methods"=>["DELETE"], "parts"=>{"job_id"=>{"type"=>"string", "description"=>"The ID of the job(s) to perform expired data hygiene for"}}}, {"path"=>"/_ml/_delete_expired_data", "methods"=>["DELETE"]}]}, "params"=>{"requests_per_second"=>{"type"=>"number", "required"=>false, "description"=>"The desired requests per second for the deletion processes."}, "timeout"=>{"type"=>"time", "required"=>false, "description"=>"How long can the underlying delete processes run until they are canceled"}}, "body"=>{"description"=>"deleting expired data parameters"}}
1585
+ request(api_name, api_spec, params)
1586
+ end
1587
+
1588
+ # ml.delete_filter
1589
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-filter.html", "description"=>"Deletes a filter."}
1590
+ def ml_delete_filter(params = {})
1591
+ api_name = 'ml.delete_filter'
1592
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-filter.html", "description"=>"Deletes a filter."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/filters/{filter_id}", "methods"=>["DELETE"], "parts"=>{"filter_id"=>{"type"=>"string", "description"=>"The ID of the filter to delete"}}}]}}
1593
+ request(api_name, api_spec, params)
1594
+ end
1595
+
1596
+ # ml.delete_forecast
1597
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-forecast.html", "description"=>"Deletes forecasts from a machine learning job."}
1598
+ def ml_delete_forecast(params = {})
1599
+ api_name = 'ml.delete_forecast'
1600
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-forecast.html", "description"=>"Deletes forecasts from a machine learning job."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/anomaly_detectors/{job_id}/_forecast", "methods"=>["DELETE"], "parts"=>{"job_id"=>{"type"=>"string", "description"=>"The ID of the job from which to delete forecasts"}}}, {"path"=>"/_ml/anomaly_detectors/{job_id}/_forecast/{forecast_id}", "methods"=>["DELETE"], "parts"=>{"job_id"=>{"type"=>"string", "description"=>"The ID of the job from which to delete forecasts"}, "forecast_id"=>{"type"=>"string", "description"=>"The ID of the forecast to delete, can be comma delimited list. Leaving blank implies `_all`"}}}]}, "params"=>{"allow_no_forecasts"=>{"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if `_all` matches no forecasts"}, "timeout"=>{"type"=>"time", "required"=>false, "description"=>"Controls the time to wait until the forecast(s) are deleted. Default to 30 seconds"}}}
1601
+ request(api_name, api_spec, params)
1602
+ end
1603
+
1604
+ # ml.delete_job
1605
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-job.html", "description"=>"Deletes an existing anomaly detection job."}
1606
+ def ml_delete_job(params = {})
1607
+ api_name = 'ml.delete_job'
1608
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-job.html", "description"=>"Deletes an existing anomaly detection job."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/anomaly_detectors/{job_id}", "methods"=>["DELETE"], "parts"=>{"job_id"=>{"type"=>"string", "description"=>"The ID of the job to delete"}}}]}, "params"=>{"force"=>{"type"=>"boolean", "description"=>"True if the job should be forcefully deleted", "default"=>false}, "wait_for_completion"=>{"type"=>"boolean", "description"=>"Should this request wait until the operation has completed before returning", "default"=>true}}}
1609
+ request(api_name, api_spec, params)
1610
+ end
1611
+
1612
+ # ml.delete_model_snapshot
1613
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-snapshot.html", "description"=>"Deletes an existing model snapshot."}
1614
+ def ml_delete_model_snapshot(params = {})
1615
+ api_name = 'ml.delete_model_snapshot'
1616
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-snapshot.html", "description"=>"Deletes an existing model snapshot."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}", "methods"=>["DELETE"], "parts"=>{"job_id"=>{"type"=>"string", "description"=>"The ID of the job to fetch"}, "snapshot_id"=>{"type"=>"string", "description"=>"The ID of the snapshot to delete"}}}]}}
1617
+ request(api_name, api_spec, params)
1618
+ end
1619
+
1620
+ # ml.delete_trained_model
1621
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models.html", "description"=>"Deletes an existing trained inference model that is currently not referenced by an ingest pipeline."}
1622
+ def ml_delete_trained_model(params = {})
1623
+ api_name = 'ml.delete_trained_model'
1624
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models.html", "description"=>"Deletes an existing trained inference model that is currently not referenced by an ingest pipeline."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/trained_models/{model_id}", "methods"=>["DELETE"], "parts"=>{"model_id"=>{"type"=>"string", "description"=>"The ID of the trained model to delete"}}}]}}
1625
+ request(api_name, api_spec, params)
1626
+ end
1627
+
1628
+ # ml.delete_trained_model_alias
1629
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models-aliases.html", "description"=>"Deletes a model alias that refers to the trained model"}
1630
+ def ml_delete_trained_model_alias(params = {})
1631
+ api_name = 'ml.delete_trained_model_alias'
1632
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models-aliases.html", "description"=>"Deletes a model alias that refers to the trained model"}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/trained_models/{model_id}/model_aliases/{model_alias}", "methods"=>["DELETE"], "parts"=>{"model_alias"=>{"type"=>"string", "description"=>"The trained model alias to delete"}, "model_id"=>{"type"=>"string", "description"=>"The trained model where the model alias is assigned"}}}]}}
1633
+ request(api_name, api_spec, params)
1634
+ end
1635
+
1636
+ # ml.estimate_model_memory
1637
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-apis.html", "description"=>"Estimates the model memory"}
1638
+ def ml_estimate_model_memory(params = {})
1639
+ api_name = 'ml.estimate_model_memory'
1640
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-apis.html", "description"=>"Estimates the model memory"}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/anomaly_detectors/_estimate_model_memory", "methods"=>["POST"]}]}, "params"=>{}, "body"=>{"description"=>"The analysis config, plus cardinality estimates for fields it references", "required"=>true}}
1641
+ request(api_name, api_spec, params)
1642
+ end
1643
+
1644
+ # ml.evaluate_data_frame
1645
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/evaluate-dfanalytics.html", "description"=>"Evaluates the data frame analytics for an annotated index."}
1646
+ def ml_evaluate_data_frame(params = {})
1647
+ api_name = 'ml.evaluate_data_frame'
1648
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/evaluate-dfanalytics.html", "description"=>"Evaluates the data frame analytics for an annotated index."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/data_frame/_evaluate", "methods"=>["POST"]}]}, "body"=>{"description"=>"The evaluation definition", "required"=>true}}
1649
+ request(api_name, api_spec, params)
1650
+ end
1651
+
1652
+ # ml.explain_data_frame_analytics
1653
+ # {"url"=>"http://www.elastic.co/guide/en/elasticsearch/reference/current/explain-dfanalytics.html", "description"=>"Explains a data frame analytics config."}
1654
+ def ml_explain_data_frame_analytics(params = {})
1655
+ api_name = 'ml.explain_data_frame_analytics'
1656
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"http://www.elastic.co/guide/en/elasticsearch/reference/current/explain-dfanalytics.html", "description"=>"Explains a data frame analytics config."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/data_frame/analytics/_explain", "methods"=>["GET", "POST"], "parts"=>{}}, {"path"=>"/_ml/data_frame/analytics/{id}/_explain", "methods"=>["GET", "POST"], "parts"=>{"id"=>{"type"=>"string", "description"=>"The ID of the data frame analytics to explain"}}}]}, "body"=>{"description"=>"The data frame analytics config to explain", "required"=>false}}
1657
+ request(api_name, api_spec, params)
1658
+ end
1659
+
1660
+ # ml.find_file_structure
1661
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/find-structure.html", "description"=>"Finds the structure of a text file. The text file must contain data that is suitable to be ingested into Elasticsearch."}
1662
+ def ml_find_file_structure(params = {})
1663
+ api_name = 'ml.find_file_structure'
1664
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/find-structure.html", "description"=>"Finds the structure of a text file. The text file must contain data that is suitable to be ingested into Elasticsearch."}, "stability"=>"experimental", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/x-ndjson"]}, "url"=>{"paths"=>[{"path"=>"/_ml/find_file_structure", "methods"=>["POST"], "deprecated"=>{"version"=>"7.12.0", "description"=>"This endpoint has changed to _text_structure/find_structure, please use that API instead"}}]}, "params"=>{"lines_to_sample"=>{"type"=>"int", "description"=>"How many lines of the file should be included in the analysis", "default"=>1000}, "line_merge_size_limit"=>{"type"=>"int", "description"=>"Maximum number of characters permitted in a single message when lines are merged to create messages.", "default"=>10000}, "timeout"=>{"type"=>"time", "description"=>"Timeout after which the analysis will be aborted", "default"=>"25s"}, "charset"=>{"type"=>"string", "description"=>"Optional parameter to specify the character set of the file"}, "format"=>{"type"=>"enum", "options"=>["ndjson", "xml", "delimited", "semi_structured_text"], "description"=>"Optional parameter to specify the high level file format"}, "has_header_row"=>{"type"=>"boolean", "description"=>"Optional parameter to specify whether a delimited file includes the column names in its first row"}, "column_names"=>{"type"=>"list", "description"=>"Optional parameter containing a comma separated list of the column names for a delimited file"}, "delimiter"=>{"type"=>"string", "description"=>"Optional parameter to specify the delimiter character for a delimited file - must be a single character"}, "quote"=>{"type"=>"string", "description"=>"Optional parameter to specify the quote character for a delimited file - must be a single character"}, "should_trim_fields"=>{"type"=>"boolean", "description"=>"Optional parameter to specify whether the values between delimiters in a delimited file should have whitespace trimmed from them"}, "grok_pattern"=>{"type"=>"string", "description"=>"Optional parameter to specify the Grok pattern that should be used to extract fields from messages in a semi-structured text file"}, "timestamp_field"=>{"type"=>"string", "description"=>"Optional parameter to specify the timestamp field in the file"}, "timestamp_format"=>{"type"=>"string", "description"=>"Optional parameter to specify the timestamp format in the file - may be either a Joda or Java time format"}, "explain"=>{"type"=>"boolean", "description"=>"Whether to include a commentary on how the structure was derived", "default"=>false}}, "body"=>{"description"=>"The contents of the file to be analyzed", "required"=>true, "serialize"=>"bulk"}}
1665
+ request(api_name, api_spec, params)
1666
+ end
1667
+
1668
+ # ml.flush_job
1669
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-flush-job.html", "description"=>"Forces any buffered data to be processed by the job."}
1670
+ def ml_flush_job(params = {})
1671
+ api_name = 'ml.flush_job'
1672
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-flush-job.html", "description"=>"Forces any buffered data to be processed by the job."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/anomaly_detectors/{job_id}/_flush", "methods"=>["POST"], "parts"=>{"job_id"=>{"type"=>"string", "description"=>"The name of the job to flush"}}}]}, "params"=>{"calc_interim"=>{"type"=>"boolean", "description"=>"Calculates interim results for the most recent bucket or all buckets within the latency period"}, "start"=>{"type"=>"string", "description"=>"When used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results"}, "end"=>{"type"=>"string", "description"=>"When used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results"}, "advance_time"=>{"type"=>"string", "description"=>"Advances time to the given value generating results and updating the model for the advanced interval"}, "skip_time"=>{"type"=>"string", "description"=>"Skips time to the given value without generating results or updating the model for the skipped interval"}}, "body"=>{"description"=>"Flush parameters"}}
1673
+ request(api_name, api_spec, params)
1674
+ end
1675
+
1676
+ # ml.forecast
1677
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-forecast.html", "description"=>"Predicts the future behavior of a time series by using its historical behavior."}
1678
+ def ml_forecast(params = {})
1679
+ api_name = 'ml.forecast'
1680
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-forecast.html", "description"=>"Predicts the future behavior of a time series by using its historical behavior."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/anomaly_detectors/{job_id}/_forecast", "methods"=>["POST"], "parts"=>{"job_id"=>{"type"=>"string", "description"=>"The ID of the job to forecast for"}}}]}, "params"=>{"duration"=>{"type"=>"time", "required"=>false, "description"=>"The duration of the forecast"}, "expires_in"=>{"type"=>"time", "required"=>false, "description"=>"The time interval after which the forecast expires. Expired forecasts will be deleted at the first opportunity."}, "max_model_memory"=>{"type"=>"string", "required"=>false, "description"=>"The max memory able to be used by the forecast. Default is 20mb."}}}
1681
+ request(api_name, api_spec, params)
1682
+ end
1683
+
1684
+ # ml.get_buckets
1685
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-bucket.html", "description"=>"Retrieves anomaly detection job results for one or more buckets."}
1686
+ def ml_get_buckets(params = {})
1687
+ api_name = 'ml.get_buckets'
1688
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-bucket.html", "description"=>"Retrieves anomaly detection job results for one or more buckets."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/anomaly_detectors/{job_id}/results/buckets/{timestamp}", "methods"=>["GET", "POST"], "parts"=>{"job_id"=>{"type"=>"string", "description"=>"ID of the job to get bucket results from"}, "timestamp"=>{"type"=>"string", "description"=>"The timestamp of the desired single bucket result"}}}, {"path"=>"/_ml/anomaly_detectors/{job_id}/results/buckets", "methods"=>["GET", "POST"], "parts"=>{"job_id"=>{"type"=>"string", "description"=>"ID of the job to get bucket results from"}}}]}, "params"=>{"expand"=>{"type"=>"boolean", "description"=>"Include anomaly records"}, "exclude_interim"=>{"type"=>"boolean", "description"=>"Exclude interim results"}, "from"=>{"type"=>"int", "description"=>"skips a number of buckets"}, "size"=>{"type"=>"int", "description"=>"specifies a max number of buckets to get"}, "start"=>{"type"=>"string", "description"=>"Start time filter for buckets"}, "end"=>{"type"=>"string", "description"=>"End time filter for buckets"}, "anomaly_score"=>{"type"=>"double", "description"=>"Filter for the most anomalous buckets"}, "sort"=>{"type"=>"string", "description"=>"Sort buckets by a particular field"}, "desc"=>{"type"=>"boolean", "description"=>"Set the sort direction"}}, "body"=>{"description"=>"Bucket selection details if not provided in URI"}}
1689
+ request(api_name, api_spec, params)
1690
+ end
1691
+
1692
+ # ml.get_calendar_events
1693
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar-event.html", "description"=>"Retrieves information about the scheduled events in calendars."}
1694
+ def ml_get_calendar_events(params = {})
1695
+ api_name = 'ml.get_calendar_events'
1696
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar-event.html", "description"=>"Retrieves information about the scheduled events in calendars."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/calendars/{calendar_id}/events", "methods"=>["GET"], "parts"=>{"calendar_id"=>{"type"=>"string", "description"=>"The ID of the calendar containing the events"}}}]}, "params"=>{"job_id"=>{"type"=>"string", "description"=>"Get events for the job. When this option is used calendar_id must be '_all'"}, "start"=>{"type"=>"string", "description"=>"Get events after this time"}, "end"=>{"type"=>"date", "description"=>"Get events before this time"}, "from"=>{"type"=>"int", "description"=>"Skips a number of events"}, "size"=>{"type"=>"int", "description"=>"Specifies a max number of events to get"}}}
1697
+ request(api_name, api_spec, params)
1698
+ end
1699
+
1700
+ # ml.get_calendars
1701
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar.html", "description"=>"Retrieves configuration information for calendars."}
1702
+ def ml_get_calendars(params = {})
1703
+ api_name = 'ml.get_calendars'
1704
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar.html", "description"=>"Retrieves configuration information for calendars."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/calendars", "methods"=>["GET", "POST"]}, {"path"=>"/_ml/calendars/{calendar_id}", "methods"=>["GET", "POST"], "parts"=>{"calendar_id"=>{"type"=>"string", "description"=>"The ID of the calendar to fetch"}}}]}, "params"=>{"from"=>{"type"=>"int", "description"=>"skips a number of calendars"}, "size"=>{"type"=>"int", "description"=>"specifies a max number of calendars to get"}}, "body"=>{"description"=>"The from and size parameters optionally sent in the body"}}
1705
+ request(api_name, api_spec, params)
1706
+ end
1707
+
1708
+ # ml.get_categories
1709
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-category.html", "description"=>"Retrieves anomaly detection job results for one or more categories."}
1710
+ def ml_get_categories(params = {})
1711
+ api_name = 'ml.get_categories'
1712
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-category.html", "description"=>"Retrieves anomaly detection job results for one or more categories."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/anomaly_detectors/{job_id}/results/categories/{category_id}", "methods"=>["GET", "POST"], "parts"=>{"job_id"=>{"type"=>"string", "description"=>"The name of the job"}, "category_id"=>{"type"=>"long", "description"=>"The identifier of the category definition of interest"}}}, {"path"=>"/_ml/anomaly_detectors/{job_id}/results/categories/", "methods"=>["GET", "POST"], "parts"=>{"job_id"=>{"type"=>"string", "description"=>"The name of the job"}}}]}, "params"=>{"from"=>{"type"=>"int", "description"=>"skips a number of categories"}, "size"=>{"type"=>"int", "description"=>"specifies a max number of categories to get"}, "partition_field_value"=>{"type"=>"string", "description"=>"Specifies the partition to retrieve categories for. This is optional, and should never be used for jobs where per-partition categorization is disabled."}}, "body"=>{"description"=>"Category selection details if not provided in URI"}}
1713
+ request(api_name, api_spec, params)
1714
+ end
1715
+
1716
+ # ml.get_data_frame_analytics
1717
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html", "description"=>"Retrieves configuration information for data frame analytics jobs."}
1718
+ def ml_get_data_frame_analytics(params = {})
1719
+ api_name = 'ml.get_data_frame_analytics'
1720
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html", "description"=>"Retrieves configuration information for data frame analytics jobs."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/data_frame/analytics/{id}", "methods"=>["GET"], "parts"=>{"id"=>{"type"=>"string", "description"=>"The ID of the data frame analytics to fetch"}}}, {"path"=>"/_ml/data_frame/analytics", "methods"=>["GET"]}]}, "params"=>{"allow_no_match"=>{"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified)", "default"=>true}, "from"=>{"type"=>"int", "description"=>"skips a number of analytics", "default"=>0}, "size"=>{"type"=>"int", "description"=>"specifies a max number of analytics to get", "default"=>100}, "exclude_generated"=>{"required"=>false, "type"=>"boolean", "default"=>false, "description"=>"Omits fields that are illegal to set on data frame analytics PUT"}}}
1721
+ request(api_name, api_spec, params)
1722
+ end
1723
+
1724
+ # ml.get_data_frame_analytics_stats
1725
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics-stats.html", "description"=>"Retrieves usage information for data frame analytics jobs."}
1726
+ def ml_get_data_frame_analytics_stats(params = {})
1727
+ api_name = 'ml.get_data_frame_analytics_stats'
1728
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics-stats.html", "description"=>"Retrieves usage information for data frame analytics jobs."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/data_frame/analytics/_stats", "methods"=>["GET"]}, {"path"=>"/_ml/data_frame/analytics/{id}/_stats", "methods"=>["GET"], "parts"=>{"id"=>{"type"=>"string", "description"=>"The ID of the data frame analytics stats to fetch"}}}]}, "params"=>{"allow_no_match"=>{"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified)", "default"=>true}, "from"=>{"type"=>"int", "description"=>"skips a number of analytics", "default"=>0}, "size"=>{"type"=>"int", "description"=>"specifies a max number of analytics to get", "default"=>100}, "verbose"=>{"type"=>"boolean", "required"=>false, "description"=>"whether the stats response should be verbose", "default"=>false}}}
1729
+ request(api_name, api_spec, params)
1730
+ end
1731
+
1732
+ # ml.get_datafeed_stats
1733
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html", "description"=>"Retrieves usage information for datafeeds."}
1734
+ def ml_get_datafeed_stats(params = {})
1735
+ api_name = 'ml.get_datafeed_stats'
1736
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html", "description"=>"Retrieves usage information for datafeeds."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/datafeeds/{datafeed_id}/_stats", "methods"=>["GET"], "parts"=>{"datafeed_id"=>{"type"=>"string", "description"=>"The ID of the datafeeds stats to fetch"}}}, {"path"=>"/_ml/datafeeds/_stats", "methods"=>["GET"]}]}, "params"=>{"allow_no_match"=>{"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)"}, "allow_no_datafeeds"=>{"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)", "deprecated"=>true}}}
1737
+ request(api_name, api_spec, params)
1738
+ end
1739
+
1740
+ # ml.get_datafeeds
1741
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html", "description"=>"Retrieves configuration information for datafeeds."}
1742
+ def ml_get_datafeeds(params = {})
1743
+ api_name = 'ml.get_datafeeds'
1744
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html", "description"=>"Retrieves configuration information for datafeeds."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/datafeeds/{datafeed_id}", "methods"=>["GET"], "parts"=>{"datafeed_id"=>{"type"=>"string", "description"=>"The ID of the datafeeds to fetch"}}}, {"path"=>"/_ml/datafeeds", "methods"=>["GET"]}]}, "params"=>{"allow_no_match"=>{"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)"}, "allow_no_datafeeds"=>{"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)", "deprecated"=>true}, "exclude_generated"=>{"required"=>false, "type"=>"boolean", "default"=>false, "description"=>"Omits fields that are illegal to set on datafeed PUT"}}}
1745
+ request(api_name, api_spec, params)
1746
+ end
1747
+
1748
+ # ml.get_filters
1749
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-filter.html", "description"=>"Retrieves filters."}
1750
+ def ml_get_filters(params = {})
1751
+ api_name = 'ml.get_filters'
1752
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-filter.html", "description"=>"Retrieves filters."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/filters", "methods"=>["GET"]}, {"path"=>"/_ml/filters/{filter_id}", "methods"=>["GET"], "parts"=>{"filter_id"=>{"type"=>"string", "description"=>"The ID of the filter to fetch"}}}]}, "params"=>{"from"=>{"type"=>"int", "description"=>"skips a number of filters"}, "size"=>{"type"=>"int", "description"=>"specifies a max number of filters to get"}}}
1753
+ request(api_name, api_spec, params)
1754
+ end
1755
+
1756
+ # ml.get_influencers
1757
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-influencer.html", "description"=>"Retrieves anomaly detection job results for one or more influencers."}
1758
+ def ml_get_influencers(params = {})
1759
+ api_name = 'ml.get_influencers'
1760
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-influencer.html", "description"=>"Retrieves anomaly detection job results for one or more influencers."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/anomaly_detectors/{job_id}/results/influencers", "methods"=>["GET", "POST"], "parts"=>{"job_id"=>{"type"=>"string", "description"=>"Identifier for the anomaly detection job"}}}]}, "params"=>{"exclude_interim"=>{"type"=>"boolean", "description"=>"Exclude interim results"}, "from"=>{"type"=>"int", "description"=>"skips a number of influencers"}, "size"=>{"type"=>"int", "description"=>"specifies a max number of influencers to get"}, "start"=>{"type"=>"string", "description"=>"start timestamp for the requested influencers"}, "end"=>{"type"=>"string", "description"=>"end timestamp for the requested influencers"}, "influencer_score"=>{"type"=>"double", "description"=>"influencer score threshold for the requested influencers"}, "sort"=>{"type"=>"string", "description"=>"sort field for the requested influencers"}, "desc"=>{"type"=>"boolean", "description"=>"whether the results should be sorted in decending order"}}, "body"=>{"description"=>"Influencer selection criteria"}}
1761
+ request(api_name, api_spec, params)
1762
+ end
1763
+
1764
+ # ml.get_job_stats
1765
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats.html", "description"=>"Retrieves usage information for anomaly detection jobs."}
1766
+ def ml_get_job_stats(params = {})
1767
+ api_name = 'ml.get_job_stats'
1768
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats.html", "description"=>"Retrieves usage information for anomaly detection jobs."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/anomaly_detectors/_stats", "methods"=>["GET"]}, {"path"=>"/_ml/anomaly_detectors/{job_id}/_stats", "methods"=>["GET"], "parts"=>{"job_id"=>{"type"=>"string", "description"=>"The ID of the jobs stats to fetch"}}}]}, "params"=>{"allow_no_match"=>{"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)"}, "allow_no_jobs"=>{"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)", "deprecated"=>true}}}
1769
+ request(api_name, api_spec, params)
1770
+ end
1771
+
1772
+ # ml.get_jobs
1773
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html", "description"=>"Retrieves configuration information for anomaly detection jobs."}
1774
+ def ml_get_jobs(params = {})
1775
+ api_name = 'ml.get_jobs'
1776
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html", "description"=>"Retrieves configuration information for anomaly detection jobs."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/anomaly_detectors/{job_id}", "methods"=>["GET"], "parts"=>{"job_id"=>{"type"=>"string", "description"=>"The ID of the jobs to fetch"}}}, {"path"=>"/_ml/anomaly_detectors", "methods"=>["GET"]}]}, "params"=>{"allow_no_match"=>{"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)"}, "allow_no_jobs"=>{"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)", "deprecated"=>true}, "exclude_generated"=>{"required"=>false, "type"=>"boolean", "default"=>false, "description"=>"Omits fields that are illegal to set on job PUT"}}}
1777
+ request(api_name, api_spec, params)
1778
+ end
1779
+
1780
+ # ml.get_model_snapshots
1781
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-snapshot.html", "description"=>"Retrieves information about model snapshots."}
1782
+ def ml_get_model_snapshots(params = {})
1783
+ api_name = 'ml.get_model_snapshots'
1784
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-snapshot.html", "description"=>"Retrieves information about model snapshots."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}", "methods"=>["GET", "POST"], "parts"=>{"job_id"=>{"type"=>"string", "description"=>"The ID of the job to fetch"}, "snapshot_id"=>{"type"=>"string", "description"=>"The ID of the snapshot to fetch"}}}, {"path"=>"/_ml/anomaly_detectors/{job_id}/model_snapshots", "methods"=>["GET", "POST"], "parts"=>{"job_id"=>{"type"=>"string", "description"=>"The ID of the job to fetch"}}}]}, "params"=>{"from"=>{"type"=>"int", "description"=>"Skips a number of documents"}, "size"=>{"type"=>"int", "description"=>"The default number of documents returned in queries as a string."}, "start"=>{"type"=>"date", "description"=>"The filter 'start' query parameter"}, "end"=>{"type"=>"date", "description"=>"The filter 'end' query parameter"}, "sort"=>{"type"=>"string", "description"=>"Name of the field to sort on"}, "desc"=>{"type"=>"boolean", "description"=>"True if the results should be sorted in descending order"}}, "body"=>{"description"=>"Model snapshot selection criteria"}}
1785
+ request(api_name, api_spec, params)
1786
+ end
1787
+
1788
+ # ml.get_overall_buckets
1789
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html", "description"=>"Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs."}
1790
+ def ml_get_overall_buckets(params = {})
1791
+ api_name = 'ml.get_overall_buckets'
1792
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html", "description"=>"Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/anomaly_detectors/{job_id}/results/overall_buckets", "methods"=>["GET", "POST"], "parts"=>{"job_id"=>{"type"=>"string", "description"=>"The job IDs for which to calculate overall bucket results"}}}]}, "params"=>{"top_n"=>{"type"=>"int", "description"=>"The number of top job bucket scores to be used in the overall_score calculation"}, "bucket_span"=>{"type"=>"string", "description"=>"The span of the overall buckets. Defaults to the longest job bucket_span"}, "overall_score"=>{"type"=>"double", "description"=>"Returns overall buckets with overall scores higher than this value"}, "exclude_interim"=>{"type"=>"boolean", "description"=>"If true overall buckets that include interim buckets will be excluded"}, "start"=>{"type"=>"string", "description"=>"Returns overall buckets with timestamps after this time"}, "end"=>{"type"=>"string", "description"=>"Returns overall buckets with timestamps earlier than this time"}, "allow_no_match"=>{"type"=>"boolean", "description"=>"Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)"}, "allow_no_jobs"=>{"type"=>"boolean", "description"=>"Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)", "deprecated"=>true}}, "body"=>{"description"=>"Overall bucket selection details if not provided in URI"}}
1793
+ request(api_name, api_spec, params)
1794
+ end
1795
+
1796
+ # ml.get_records
1797
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-record.html", "description"=>"Retrieves anomaly records for an anomaly detection job."}
1798
+ def ml_get_records(params = {})
1799
+ api_name = 'ml.get_records'
1800
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-record.html", "description"=>"Retrieves anomaly records for an anomaly detection job."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/anomaly_detectors/{job_id}/results/records", "methods"=>["GET", "POST"], "parts"=>{"job_id"=>{"type"=>"string", "description"=>"The ID of the job"}}}]}, "params"=>{"exclude_interim"=>{"type"=>"boolean", "description"=>"Exclude interim results"}, "from"=>{"type"=>"int", "description"=>"skips a number of records"}, "size"=>{"type"=>"int", "description"=>"specifies a max number of records to get"}, "start"=>{"type"=>"string", "description"=>"Start time filter for records"}, "end"=>{"type"=>"string", "description"=>"End time filter for records"}, "record_score"=>{"type"=>"double", "description"=>"Returns records with anomaly scores greater or equal than this value"}, "sort"=>{"type"=>"string", "description"=>"Sort records by a particular field"}, "desc"=>{"type"=>"boolean", "description"=>"Set the sort direction"}}, "body"=>{"description"=>"Record selection criteria"}}
1801
+ request(api_name, api_spec, params)
1802
+ end
1803
+
1804
+ # ml.get_trained_models
1805
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models.html", "description"=>"Retrieves configuration information for a trained inference model."}
1806
+ def ml_get_trained_models(params = {})
1807
+ api_name = 'ml.get_trained_models'
1808
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models.html", "description"=>"Retrieves configuration information for a trained inference model."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/trained_models/{model_id}", "methods"=>["GET"], "parts"=>{"model_id"=>{"type"=>"string", "description"=>"The ID of the trained models to fetch"}}}, {"path"=>"/_ml/trained_models", "methods"=>["GET"]}]}, "params"=>{"allow_no_match"=>{"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified)", "default"=>true}, "include"=>{"type"=>"string", "required"=>false, "description"=>"A comma-separate list of fields to optionally include. Valid options are 'definition' and 'total_feature_importance'. Default is none."}, "include_model_definition"=>{"type"=>"boolean", "required"=>false, "description"=>"Should the full model definition be included in the results. These definitions can be large. So be cautious when including them. Defaults to false.", "default"=>false, "deprecated"=>true}, "decompress_definition"=>{"type"=>"boolean", "required"=>false, "default"=>true, "description"=>"Should the model definition be decompressed into valid JSON or returned in a custom compressed format. Defaults to true."}, "from"=>{"required"=>false, "type"=>"int", "description"=>"skips a number of trained models", "default"=>0}, "size"=>{"required"=>false, "type"=>"int", "description"=>"specifies a max number of trained models to get", "default"=>100}, "tags"=>{"required"=>false, "type"=>"list", "description"=>"A comma-separated list of tags that the model must have."}, "exclude_generated"=>{"required"=>false, "type"=>"boolean", "default"=>false, "description"=>"Omits fields that are illegal to set on model PUT"}}}
1809
+ request(api_name, api_spec, params)
1810
+ end
1811
+
1812
+ # ml.get_trained_models_stats
1813
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models-stats.html", "description"=>"Retrieves usage information for trained inference models."}
1814
+ def ml_get_trained_models_stats(params = {})
1815
+ api_name = 'ml.get_trained_models_stats'
1816
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models-stats.html", "description"=>"Retrieves usage information for trained inference models."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/trained_models/{model_id}/_stats", "methods"=>["GET"], "parts"=>{"model_id"=>{"type"=>"string", "description"=>"The ID of the trained models stats to fetch"}}}, {"path"=>"/_ml/trained_models/_stats", "methods"=>["GET"]}]}, "params"=>{"allow_no_match"=>{"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified)", "default"=>true}, "from"=>{"type"=>"int", "description"=>"skips a number of trained models", "default"=>0}, "size"=>{"type"=>"int", "description"=>"specifies a max number of trained models to get", "default"=>100}}}
1817
+ request(api_name, api_spec, params)
1818
+ end
1819
+
1820
+ # ml.info
1821
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-info.html", "description"=>"Returns defaults and limits used by machine learning."}
1822
+ def ml_info(params = {})
1823
+ api_name = 'ml.info'
1824
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-info.html", "description"=>"Returns defaults and limits used by machine learning."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/info", "methods"=>["GET"]}]}}
1825
+ request(api_name, api_spec, params)
1826
+ end
1827
+
1828
+ # ml.open_job
1829
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html", "description"=>"Opens one or more anomaly detection jobs."}
1830
+ def ml_open_job(params = {})
1831
+ api_name = 'ml.open_job'
1832
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html", "description"=>"Opens one or more anomaly detection jobs."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/anomaly_detectors/{job_id}/_open", "methods"=>["POST"], "parts"=>{"job_id"=>{"type"=>"string", "description"=>"The ID of the job to open"}}}]}}
1833
+ request(api_name, api_spec, params)
1834
+ end
1835
+
1836
+ # ml.post_calendar_events
1837
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-calendar-event.html", "description"=>"Posts scheduled events in a calendar."}
1838
+ def ml_post_calendar_events(params = {})
1839
+ api_name = 'ml.post_calendar_events'
1840
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-calendar-event.html", "description"=>"Posts scheduled events in a calendar."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/calendars/{calendar_id}/events", "methods"=>["POST"], "parts"=>{"calendar_id"=>{"type"=>"string", "description"=>"The ID of the calendar to modify"}}}]}, "body"=>{"description"=>"A list of events", "required"=>true}}
1841
+ request(api_name, api_spec, params)
1842
+ end
1843
+
1844
+ # ml.post_data
1845
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-data.html", "description"=>"Sends data to an anomaly detection job for analysis."}
1846
+ def ml_post_data(params = {})
1847
+ api_name = 'ml.post_data'
1848
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-data.html", "description"=>"Sends data to an anomaly detection job for analysis."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/x-ndjson", "application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/anomaly_detectors/{job_id}/_data", "methods"=>["POST"], "parts"=>{"job_id"=>{"type"=>"string", "description"=>"The name of the job receiving the data"}}}]}, "params"=>{"reset_start"=>{"type"=>"string", "description"=>"Optional parameter to specify the start of the bucket resetting range"}, "reset_end"=>{"type"=>"string", "description"=>"Optional parameter to specify the end of the bucket resetting range"}}, "body"=>{"description"=>"The data to process", "required"=>true, "serialize"=>"bulk"}}
1849
+ request(api_name, api_spec, params)
1850
+ end
1851
+
1852
+ # ml.preview_data_frame_analytics
1853
+ # {"url"=>"http://www.elastic.co/guide/en/elasticsearch/reference/current/preview-dfanalytics.html", "description"=>"Previews that will be analyzed given a data frame analytics config."}
1854
+ def ml_preview_data_frame_analytics(params = {})
1855
+ api_name = 'ml.preview_data_frame_analytics'
1856
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"http://www.elastic.co/guide/en/elasticsearch/reference/current/preview-dfanalytics.html", "description"=>"Previews that will be analyzed given a data frame analytics config."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/data_frame/analytics/_preview", "methods"=>["GET", "POST"], "parts"=>{}}, {"path"=>"/_ml/data_frame/analytics/{id}/_preview", "methods"=>["GET", "POST"], "parts"=>{"id"=>{"type"=>"string", "description"=>"The ID of the data frame analytics to preview"}}}]}, "body"=>{"description"=>"The data frame analytics config to preview", "required"=>false}}
1857
+ request(api_name, api_spec, params)
1858
+ end
1859
+
1860
+ # ml.preview_datafeed
1861
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html", "description"=>"Previews a datafeed."}
1862
+ def ml_preview_datafeed(params = {})
1863
+ api_name = 'ml.preview_datafeed'
1864
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html", "description"=>"Previews a datafeed."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/datafeeds/{datafeed_id}/_preview", "methods"=>["GET", "POST"], "parts"=>{"datafeed_id"=>{"type"=>"string", "description"=>"The ID of the datafeed to preview"}}}, {"path"=>"/_ml/datafeeds/_preview", "methods"=>["GET", "POST"]}]}, "body"=>{"description"=>"The datafeed config and job config with which to execute the preview", "required"=>false}}
1865
+ request(api_name, api_spec, params)
1866
+ end
1867
+
1868
+ # ml.put_calendar
1869
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar.html", "description"=>"Instantiates a calendar."}
1870
+ def ml_put_calendar(params = {})
1871
+ api_name = 'ml.put_calendar'
1872
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar.html", "description"=>"Instantiates a calendar."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/calendars/{calendar_id}", "methods"=>["PUT"], "parts"=>{"calendar_id"=>{"type"=>"string", "description"=>"The ID of the calendar to create"}}}]}, "body"=>{"description"=>"The calendar details", "required"=>false}}
1873
+ request(api_name, api_spec, params)
1874
+ end
1875
+
1876
+ # ml.put_calendar_job
1877
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar-job.html", "description"=>"Adds an anomaly detection job to a calendar."}
1878
+ def ml_put_calendar_job(params = {})
1879
+ api_name = 'ml.put_calendar_job'
1880
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar-job.html", "description"=>"Adds an anomaly detection job to a calendar."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/calendars/{calendar_id}/jobs/{job_id}", "methods"=>["PUT"], "parts"=>{"calendar_id"=>{"type"=>"string", "description"=>"The ID of the calendar to modify"}, "job_id"=>{"type"=>"string", "description"=>"The ID of the job to add to the calendar"}}}]}}
1881
+ request(api_name, api_spec, params)
1882
+ end
1883
+
1884
+ # ml.put_data_frame_analytics
1885
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/put-dfanalytics.html", "description"=>"Instantiates a data frame analytics job."}
1886
+ def ml_put_data_frame_analytics(params = {})
1887
+ api_name = 'ml.put_data_frame_analytics'
1888
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/put-dfanalytics.html", "description"=>"Instantiates a data frame analytics job."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/data_frame/analytics/{id}", "methods"=>["PUT"], "parts"=>{"id"=>{"type"=>"string", "description"=>"The ID of the data frame analytics to create"}}}]}, "body"=>{"description"=>"The data frame analytics configuration", "required"=>true}}
1889
+ request(api_name, api_spec, params)
1890
+ end
1891
+
1892
+ # ml.put_datafeed
1893
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-datafeed.html", "description"=>"Instantiates a datafeed."}
1894
+ def ml_put_datafeed(params = {})
1895
+ api_name = 'ml.put_datafeed'
1896
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-datafeed.html", "description"=>"Instantiates a datafeed."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/datafeeds/{datafeed_id}", "methods"=>["PUT"], "parts"=>{"datafeed_id"=>{"type"=>"string", "description"=>"The ID of the datafeed to create"}}}]}, "body"=>{"description"=>"The datafeed config", "required"=>true}, "params"=>{"ignore_unavailable"=>{"type"=>"boolean", "description"=>"Ignore unavailable indexes (default: false)"}, "allow_no_indices"=>{"type"=>"boolean", "description"=>"Ignore if the source indices expressions resolves to no concrete indices (default: true)"}, "ignore_throttled"=>{"type"=>"boolean", "description"=>"Ignore indices that are marked as throttled (default: true)"}, "expand_wildcards"=>{"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "description"=>"Whether source index expressions should get expanded to open or closed indices (default: open)"}}}
1897
+ request(api_name, api_spec, params)
1898
+ end
1899
+
1900
+ # ml.put_filter
1901
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-filter.html", "description"=>"Instantiates a filter."}
1902
+ def ml_put_filter(params = {})
1903
+ api_name = 'ml.put_filter'
1904
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-filter.html", "description"=>"Instantiates a filter."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/filters/{filter_id}", "methods"=>["PUT"], "parts"=>{"filter_id"=>{"type"=>"string", "description"=>"The ID of the filter to create"}}}]}, "body"=>{"description"=>"The filter details", "required"=>true}}
1905
+ request(api_name, api_spec, params)
1906
+ end
1907
+
1908
+ # ml.put_job
1909
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-job.html", "description"=>"Instantiates an anomaly detection job."}
1910
+ def ml_put_job(params = {})
1911
+ api_name = 'ml.put_job'
1912
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-job.html", "description"=>"Instantiates an anomaly detection job."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/anomaly_detectors/{job_id}", "methods"=>["PUT"], "parts"=>{"job_id"=>{"type"=>"string", "description"=>"The ID of the job to create"}}}]}, "body"=>{"description"=>"The job", "required"=>true}}
1913
+ request(api_name, api_spec, params)
1914
+ end
1915
+
1916
+ # ml.put_trained_model
1917
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models.html", "description"=>"Creates an inference trained model."}
1918
+ def ml_put_trained_model(params = {})
1919
+ api_name = 'ml.put_trained_model'
1920
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models.html", "description"=>"Creates an inference trained model."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/trained_models/{model_id}", "methods"=>["PUT"], "parts"=>{"model_id"=>{"type"=>"string", "description"=>"The ID of the trained models to store"}}}]}, "body"=>{"description"=>"The trained model configuration", "required"=>true}}
1921
+ request(api_name, api_spec, params)
1922
+ end
1923
+
1924
+ # ml.put_trained_model_alias
1925
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models-aliases.html", "description"=>"Creates a new model alias (or reassigns an existing one) to refer to the trained model"}
1926
+ def ml_put_trained_model_alias(params = {})
1927
+ api_name = 'ml.put_trained_model_alias'
1928
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models-aliases.html", "description"=>"Creates a new model alias (or reassigns an existing one) to refer to the trained model"}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/trained_models/{model_id}/model_aliases/{model_alias}", "methods"=>["PUT"], "parts"=>{"model_alias"=>{"type"=>"string", "description"=>"The trained model alias to update"}, "model_id"=>{"type"=>"string", "description"=>"The trained model where the model alias should be assigned"}}}]}, "params"=>{"reassign"=>{"type"=>"boolean", "description"=>"If the model_alias already exists and points to a separate model_id, this parameter must be true. Defaults to false."}}}
1929
+ request(api_name, api_spec, params)
1930
+ end
1931
+
1932
+ # ml.reset_job
1933
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-reset-job.html", "description"=>"Resets an existing anomaly detection job."}
1934
+ def ml_reset_job(params = {})
1935
+ api_name = 'ml.reset_job'
1936
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-reset-job.html", "description"=>"Resets an existing anomaly detection job."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/anomaly_detectors/{job_id}/_reset", "methods"=>["POST"], "parts"=>{"job_id"=>{"type"=>"string", "description"=>"The ID of the job to reset"}}}]}, "params"=>{"wait_for_completion"=>{"type"=>"boolean", "description"=>"Should this request wait until the operation has completed before returning", "default"=>true}}}
1937
+ request(api_name, api_spec, params)
1938
+ end
1939
+
1940
+ # ml.revert_model_snapshot
1941
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-revert-snapshot.html", "description"=>"Reverts to a specific snapshot."}
1942
+ def ml_revert_model_snapshot(params = {})
1943
+ api_name = 'ml.revert_model_snapshot'
1944
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-revert-snapshot.html", "description"=>"Reverts to a specific snapshot."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_revert", "methods"=>["POST"], "parts"=>{"job_id"=>{"type"=>"string", "description"=>"The ID of the job to fetch"}, "snapshot_id"=>{"type"=>"string", "description"=>"The ID of the snapshot to revert to"}}}]}, "params"=>{"delete_intervening_results"=>{"type"=>"boolean", "description"=>"Should we reset the results back to the time of the snapshot?"}}, "body"=>{"description"=>"Reversion options"}}
1945
+ request(api_name, api_spec, params)
1946
+ end
1947
+
1948
+ # ml.set_upgrade_mode
1949
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-set-upgrade-mode.html", "description"=>"Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade."}
1950
+ def ml_set_upgrade_mode(params = {})
1951
+ api_name = 'ml.set_upgrade_mode'
1952
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-set-upgrade-mode.html", "description"=>"Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/set_upgrade_mode", "methods"=>["POST"]}]}, "params"=>{"enabled"=>{"type"=>"boolean", "description"=>"Whether to enable upgrade_mode ML setting or not. Defaults to false."}, "timeout"=>{"type"=>"time", "description"=>"Controls the time to wait before action times out. Defaults to 30 seconds"}}}
1953
+ request(api_name, api_spec, params)
1954
+ end
1955
+
1956
+ # ml.start_data_frame_analytics
1957
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/start-dfanalytics.html", "description"=>"Starts a data frame analytics job."}
1958
+ def ml_start_data_frame_analytics(params = {})
1959
+ api_name = 'ml.start_data_frame_analytics'
1960
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/start-dfanalytics.html", "description"=>"Starts a data frame analytics job."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/data_frame/analytics/{id}/_start", "methods"=>["POST"], "parts"=>{"id"=>{"type"=>"string", "description"=>"The ID of the data frame analytics to start"}}}]}, "params"=>{"timeout"=>{"type"=>"time", "required"=>false, "description"=>"Controls the time to wait until the task has started. Defaults to 20 seconds"}}, "body"=>{"description"=>"The start data frame analytics parameters"}}
1961
+ request(api_name, api_spec, params)
1962
+ end
1963
+
1964
+ # ml.start_datafeed
1965
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-datafeed.html", "description"=>"Starts one or more datafeeds."}
1966
+ def ml_start_datafeed(params = {})
1967
+ api_name = 'ml.start_datafeed'
1968
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-datafeed.html", "description"=>"Starts one or more datafeeds."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/datafeeds/{datafeed_id}/_start", "methods"=>["POST"], "parts"=>{"datafeed_id"=>{"type"=>"string", "description"=>"The ID of the datafeed to start"}}}]}, "params"=>{"start"=>{"type"=>"string", "required"=>false, "description"=>"The start time from where the datafeed should begin"}, "end"=>{"type"=>"string", "required"=>false, "description"=>"The end time when the datafeed should stop. When not set, the datafeed continues in real time"}, "timeout"=>{"type"=>"time", "required"=>false, "description"=>"Controls the time to wait until a datafeed has started. Default to 20 seconds"}}, "body"=>{"description"=>"The start datafeed parameters"}}
1969
+ request(api_name, api_spec, params)
1970
+ end
1971
+
1972
+ # ml.stop_data_frame_analytics
1973
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-dfanalytics.html", "description"=>"Stops one or more data frame analytics jobs."}
1974
+ def ml_stop_data_frame_analytics(params = {})
1975
+ api_name = 'ml.stop_data_frame_analytics'
1976
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-dfanalytics.html", "description"=>"Stops one or more data frame analytics jobs."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/data_frame/analytics/{id}/_stop", "methods"=>["POST"], "parts"=>{"id"=>{"type"=>"string", "description"=>"The ID of the data frame analytics to stop"}}}]}, "params"=>{"allow_no_match"=>{"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified)"}, "force"=>{"type"=>"boolean", "required"=>false, "description"=>"True if the data frame analytics should be forcefully stopped"}, "timeout"=>{"type"=>"time", "required"=>false, "description"=>"Controls the time to wait until the task has stopped. Defaults to 20 seconds"}}, "body"=>{"description"=>"The stop data frame analytics parameters"}}
1977
+ request(api_name, api_spec, params)
1978
+ end
1979
+
1980
+ # ml.stop_datafeed
1981
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-stop-datafeed.html", "description"=>"Stops one or more datafeeds."}
1982
+ def ml_stop_datafeed(params = {})
1983
+ api_name = 'ml.stop_datafeed'
1984
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-stop-datafeed.html", "description"=>"Stops one or more datafeeds."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/datafeeds/{datafeed_id}/_stop", "methods"=>["POST"], "parts"=>{"datafeed_id"=>{"type"=>"string", "description"=>"The ID of the datafeed to stop"}}}]}, "params"=>{"allow_no_match"=>{"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)"}, "allow_no_datafeeds"=>{"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)", "deprecated"=>true}, "force"=>{"type"=>"boolean", "required"=>false, "description"=>"True if the datafeed should be forcefully stopped."}, "timeout"=>{"type"=>"time", "required"=>false, "description"=>"Controls the time to wait until a datafeed has stopped. Default to 20 seconds"}}, "body"=>{"description"=>"The URL params optionally sent in the body", "required"=>false}}
1985
+ request(api_name, api_spec, params)
1986
+ end
1987
+
1988
+ # ml.update_data_frame_analytics
1989
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/update-dfanalytics.html", "description"=>"Updates certain properties of a data frame analytics job."}
1990
+ def ml_update_data_frame_analytics(params = {})
1991
+ api_name = 'ml.update_data_frame_analytics'
1992
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/update-dfanalytics.html", "description"=>"Updates certain properties of a data frame analytics job."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/data_frame/analytics/{id}/_update", "methods"=>["POST"], "parts"=>{"id"=>{"type"=>"string", "description"=>"The ID of the data frame analytics to update"}}}]}, "body"=>{"description"=>"The data frame analytics settings to update", "required"=>true}}
1993
+ request(api_name, api_spec, params)
1994
+ end
1995
+
1996
+ # ml.update_datafeed
1997
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-datafeed.html", "description"=>"Updates certain properties of a datafeed."}
1998
+ def ml_update_datafeed(params = {})
1999
+ api_name = 'ml.update_datafeed'
2000
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-datafeed.html", "description"=>"Updates certain properties of a datafeed."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/datafeeds/{datafeed_id}/_update", "methods"=>["POST"], "parts"=>{"datafeed_id"=>{"type"=>"string", "description"=>"The ID of the datafeed to update"}}}]}, "body"=>{"description"=>"The datafeed update settings", "required"=>true}, "params"=>{"ignore_unavailable"=>{"type"=>"boolean", "description"=>"Ignore unavailable indexes (default: false)"}, "allow_no_indices"=>{"type"=>"boolean", "description"=>"Ignore if the source indices expressions resolves to no concrete indices (default: true)"}, "ignore_throttled"=>{"type"=>"boolean", "description"=>"Ignore indices that are marked as throttled (default: true)"}, "expand_wildcards"=>{"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "description"=>"Whether source index expressions should get expanded to open or closed indices (default: open)"}}}
2001
+ request(api_name, api_spec, params)
2002
+ end
2003
+
2004
+ # ml.update_filter
2005
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-filter.html", "description"=>"Updates the description of a filter, adds items, or removes items."}
2006
+ def ml_update_filter(params = {})
2007
+ api_name = 'ml.update_filter'
2008
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-filter.html", "description"=>"Updates the description of a filter, adds items, or removes items."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/filters/{filter_id}/_update", "methods"=>["POST"], "parts"=>{"filter_id"=>{"type"=>"string", "description"=>"The ID of the filter to update"}}}]}, "body"=>{"description"=>"The filter update", "required"=>true}}
2009
+ request(api_name, api_spec, params)
2010
+ end
2011
+
2012
+ # ml.update_job
2013
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-job.html", "description"=>"Updates certain properties of an anomaly detection job."}
2014
+ def ml_update_job(params = {})
2015
+ api_name = 'ml.update_job'
2016
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-job.html", "description"=>"Updates certain properties of an anomaly detection job."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/anomaly_detectors/{job_id}/_update", "methods"=>["POST"], "parts"=>{"job_id"=>{"type"=>"string", "description"=>"The ID of the job to create"}}}]}, "body"=>{"description"=>"The job update settings", "required"=>true}}
2017
+ request(api_name, api_spec, params)
2018
+ end
2019
+
2020
+ # ml.update_model_snapshot
2021
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-snapshot.html", "description"=>"Updates certain properties of a snapshot."}
2022
+ def ml_update_model_snapshot(params = {})
2023
+ api_name = 'ml.update_model_snapshot'
2024
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-snapshot.html", "description"=>"Updates certain properties of a snapshot."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_update", "methods"=>["POST"], "parts"=>{"job_id"=>{"type"=>"string", "description"=>"The ID of the job to fetch"}, "snapshot_id"=>{"type"=>"string", "description"=>"The ID of the snapshot to update"}}}]}, "params"=>{}, "body"=>{"description"=>"The model snapshot properties to update", "required"=>true}}
2025
+ request(api_name, api_spec, params)
2026
+ end
2027
+
2028
+ # ml.upgrade_job_snapshot
2029
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-upgrade-job-model-snapshot.html", "description"=>"Upgrades a given job snapshot to the current major version."}
2030
+ def ml_upgrade_job_snapshot(params = {})
2031
+ api_name = 'ml.upgrade_job_snapshot'
2032
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-upgrade-job-model-snapshot.html", "description"=>"Upgrades a given job snapshot to the current major version."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_upgrade", "methods"=>["POST"], "parts"=>{"job_id"=>{"type"=>"string", "description"=>"The ID of the job"}, "snapshot_id"=>{"type"=>"string", "description"=>"The ID of the snapshot"}}}]}, "params"=>{"timeout"=>{"type"=>"time", "required"=>false, "description"=>"How long should the API wait for the job to be opened and the old snapshot to be loaded."}, "wait_for_completion"=>{"type"=>"boolean", "required"=>false, "description"=>"Should the request wait until the task is complete before responding to the caller. Default is false."}}}
2033
+ request(api_name, api_spec, params)
2034
+ end
2035
+
2036
+ # ml.validate
2037
+ # {"url"=>"https://www.elastic.co/guide/en/machine-learning/current/ml-jobs.html", "description"=>"Validates an anomaly detection job."}
2038
+ def ml_validate(params = {})
2039
+ api_name = 'ml.validate'
2040
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/machine-learning/current/ml-jobs.html", "description"=>"Validates an anomaly detection job."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/anomaly_detectors/_validate", "methods"=>["POST"]}]}, "params"=>{}, "body"=>{"description"=>"The job config", "required"=>true}}
2041
+ request(api_name, api_spec, params)
2042
+ end
2043
+
2044
+ # ml.validate_detector
2045
+ # {"url"=>"https://www.elastic.co/guide/en/machine-learning/current/ml-jobs.html", "description"=>"Validates an anomaly detection detector."}
2046
+ def ml_validate_detector(params = {})
2047
+ api_name = 'ml.validate_detector'
2048
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/machine-learning/current/ml-jobs.html", "description"=>"Validates an anomaly detection detector."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ml/anomaly_detectors/_validate/detector", "methods"=>["POST"]}]}, "params"=>{}, "body"=>{"description"=>"The detector", "required"=>true}}
2049
+ request(api_name, api_spec, params)
2050
+ end
2051
+
2052
+ # monitoring.bulk
2053
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/monitor-elasticsearch-cluster.html", "description"=>"Used by the monitoring features to send monitoring data."}
2054
+ def monitoring_bulk(params = {})
2055
+ api_name = 'monitoring.bulk'
2056
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/monitor-elasticsearch-cluster.html", "description"=>"Used by the monitoring features to send monitoring data."}, "stability"=>"experimental", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/x-ndjson"]}, "url"=>{"paths"=>[{"path"=>"/_monitoring/bulk", "methods"=>["POST", "PUT"]}, {"path"=>"/_monitoring/{type}/bulk", "methods"=>["POST", "PUT"], "parts"=>{"type"=>{"type"=>"string", "description"=>"Default document type for items which don't provide one", "deprecated"=>true}}, "deprecated"=>{"version"=>"7.0.0", "description"=>"Specifying types in urls has been deprecated"}}]}, "params"=>{"system_id"=>{"type"=>"string", "description"=>"Identifier of the monitored system"}, "system_api_version"=>{"type"=>"string", "description"=>"API Version of the monitored system"}, "interval"=>{"type"=>"string", "description"=>"Collection interval (e.g., '10s' or '10000ms') of the payload"}}, "body"=>{"description"=>"The operation definition and data (action-data pairs), separated by newlines", "required"=>true, "serialize"=>"bulk"}}
2057
+ request(api_name, api_spec, params)
2058
+ end
2059
+
2060
+ # msearch
2061
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html", "description"=>"Allows to execute several search operations in one request."}
2062
+ def msearch(params = {})
2063
+ api_name = 'msearch'
2064
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/x-ndjson"]}, "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"}}}, {"path"=>"/{index}/{type}/_msearch", "methods"=>["GET", "POST"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names to use as default"}, "type"=>{"type"=>"list", "description"=>"A comma-separated list of document types to use as default"}}, "deprecated"=>{"version"=>"7.0.0", "description"=>"Specifying types in urls has been deprecated"}}]}, "params"=>{"search_type"=>{"type"=>"enum", "options"=>["query_then_fetch", "dfs_query_then_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"}}
2065
+ request(api_name, api_spec, params)
2066
+ end
2067
+
2068
+ # msearch_template
2069
+ # {"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."}
2070
+ def msearch_template(params = {})
2071
+ api_name = 'msearch_template'
2072
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/x-ndjson"]}, "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"}}}, {"path"=>"/{index}/{type}/_msearch/template", "methods"=>["GET", "POST"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names to use as default"}, "type"=>{"type"=>"list", "description"=>"A comma-separated list of document types to use as default"}}, "deprecated"=>{"version"=>"7.0.0", "description"=>"Specifying types in urls has been deprecated"}}]}, "params"=>{"search_type"=>{"type"=>"enum", "options"=>["query_then_fetch", "dfs_query_then_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"}}
2073
+ request(api_name, api_spec, params)
2074
+ end
2075
+
2076
+ # mtermvectors
2077
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html", "description"=>"Returns multiple termvectors in one request."}
2078
+ def mtermvectors(params = {})
2079
+ api_name = 'mtermvectors'
2080
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "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."}}}, {"path"=>"/{index}/{type}/_mtermvectors", "methods"=>["GET", "POST"], "parts"=>{"index"=>{"type"=>"string", "description"=>"The index in which the document resides."}, "type"=>{"type"=>"string", "description"=>"The type of the document."}}, "deprecated"=>{"version"=>"7.0.0", "description"=>"Specifying types in urls has been deprecated"}}]}, "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}}
2081
+ request(api_name, api_spec, params)
2082
+ end
2083
+
2084
+ # nodes.hot_threads
2085
+ # {"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."}
2086
+ def nodes_hot_threads(params = {})
2087
+ api_name = 'nodes.hot_threads'
2088
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["text/plain"]}, "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"}}}
2089
+ request(api_name, api_spec, params)
2090
+ end
2091
+
2092
+ # nodes.info
2093
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-info.html", "description"=>"Returns information about nodes in the cluster."}
2094
+ def nodes_info(params = {})
2095
+ api_name = 'nodes.info'
2096
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"}}}
2097
+ request(api_name, api_spec, params)
2098
+ end
2099
+
2100
+ # nodes.reload_secure_settings
2101
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/secure-settings.html#reloadable-secure-settings", "description"=>"Reloads secure settings."}
2102
+ def nodes_reload_secure_settings(params = {})
2103
+ api_name = 'nodes.reload_secure_settings'
2104
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "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 elasticsearch keystore", "required"=>false}}
2105
+ request(api_name, api_spec, params)
2106
+ end
2107
+
2108
+ # nodes.stats
2109
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-stats.html", "description"=>"Returns statistical information about nodes in the cluster."}
2110
+ def nodes_stats(params = {})
2111
+ api_name = 'nodes.stats'
2112
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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}, "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}}}
2113
+ request(api_name, api_spec, params)
2114
+ end
2115
+
2116
+ # nodes.usage
2117
+ # {"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."}
2118
+ def nodes_usage(params = {})
2119
+ api_name = 'nodes.usage'
2120
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"}}}
2121
+ request(api_name, api_spec, params)
2122
+ end
2123
+
2124
+ # open_point_in_time
2125
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/point-in-time-api.html", "description"=>"Open a point in time that can be used in subsequent searches"}
2126
+ def open_point_in_time(params = {})
2127
+ api_name = 'open_point_in_time'
2128
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/point-in-time-api.html", "description"=>"Open a point in time that can be used in subsequent searches"}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_pit", "methods"=>["POST"]}, {"path"=>"/{index}/_pit", "methods"=>["POST"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names to open point in time; 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"}, "ignore_unavailable"=>{"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "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."}, "keep_alive"=>{"type"=>"string", "description"=>"Specific the time to live for the point in time"}}}
2129
+ request(api_name, api_spec, params)
2130
+ end
2131
+
2132
+ # ping
2133
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html", "description"=>"Returns whether the cluster is running."}
2134
+ def ping(params = {})
2135
+ api_name = 'ping'
2136
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/", "methods"=>["HEAD"]}]}, "params"=>{}}
2137
+ request(api_name, api_spec, params)
2138
+ end
2139
+ alias :ping? :ping
2140
+
2141
+ # put_script
2142
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", "description"=>"Creates or updates a script."}
2143
+ def put_script(params = {})
2144
+ api_name = 'put_script'
2145
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "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"}, "context"=>{"type"=>"string", "description"=>"Context name to compile script against"}}, "body"=>{"description"=>"The document", "required"=>true}}
2146
+ request(api_name, api_spec, params)
2147
+ end
2148
+
2149
+ # rank_eval
2150
+ # {"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"}
2151
+ def rank_eval(params = {})
2152
+ api_name = 'rank_eval'
2153
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "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}}
2154
+ request(api_name, api_spec, params)
2155
+ end
2156
+
2157
+ # reindex
2158
+ # {"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."}
2159
+ def reindex(params = {})
2160
+ api_name = 'reindex'
2161
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "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}}
2162
+ request(api_name, api_spec, params)
2163
+ end
2164
+
2165
+ # reindex_rethrottle
2166
+ # {"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."}
2167
+ def reindex_rethrottle(params = {})
2168
+ api_name = 'reindex_rethrottle'
2169
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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."}}}
2170
+ request(api_name, api_spec, params)
2171
+ end
2172
+
2173
+ # render_search_template
2174
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/render-search-template-api.html", "description"=>"Allows to use the Mustache language to pre-render a search definition."}
2175
+ def render_search_template(params = {})
2176
+ api_name = 'render_search_template'
2177
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/render-search-template-api.html", "description"=>"Allows to use the Mustache language to pre-render a search definition."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "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"}}
2178
+ request(api_name, api_spec, params)
2179
+ end
2180
+
2181
+ # rollup.delete_job
2182
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-delete-job.html", "description"=>"Deletes an existing rollup job."}
2183
+ def rollup_delete_job(params = {})
2184
+ api_name = 'rollup.delete_job'
2185
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-delete-job.html", "description"=>"Deletes an existing rollup job."}, "stability"=>"experimental", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_rollup/job/{id}", "methods"=>["DELETE"], "parts"=>{"id"=>{"type"=>"string", "description"=>"The ID of the job to delete"}}}]}}
2186
+ request(api_name, api_spec, params)
2187
+ end
2188
+
2189
+ # rollup.get_jobs
2190
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-job.html", "description"=>"Retrieves the configuration, stats, and status of rollup jobs."}
2191
+ def rollup_get_jobs(params = {})
2192
+ api_name = 'rollup.get_jobs'
2193
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-job.html", "description"=>"Retrieves the configuration, stats, and status of rollup jobs."}, "stability"=>"experimental", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_rollup/job/{id}", "methods"=>["GET"], "parts"=>{"id"=>{"type"=>"string", "description"=>"The ID of the job(s) to fetch. Accepts glob patterns, or left blank for all jobs"}}}, {"path"=>"/_rollup/job/", "methods"=>["GET"]}]}}
2194
+ request(api_name, api_spec, params)
2195
+ end
2196
+
2197
+ # rollup.get_rollup_caps
2198
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-rollup-caps.html", "description"=>"Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern."}
2199
+ def rollup_get_rollup_caps(params = {})
2200
+ api_name = 'rollup.get_rollup_caps'
2201
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-rollup-caps.html", "description"=>"Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern."}, "stability"=>"experimental", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_rollup/data/{id}", "methods"=>["GET"], "parts"=>{"id"=>{"type"=>"string", "description"=>"The ID of the index to check rollup capabilities on, or left blank for all jobs"}}}, {"path"=>"/_rollup/data/", "methods"=>["GET"]}]}}
2202
+ request(api_name, api_spec, params)
2203
+ end
2204
+
2205
+ # rollup.get_rollup_index_caps
2206
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-rollup-index-caps.html", "description"=>"Returns the rollup capabilities of all jobs inside of a rollup index (e.g. the index where rollup data is stored)."}
2207
+ def rollup_get_rollup_index_caps(params = {})
2208
+ api_name = 'rollup.get_rollup_index_caps'
2209
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-rollup-index-caps.html", "description"=>"Returns the rollup capabilities of all jobs inside of a rollup index (e.g. the index where rollup data is stored)."}, "stability"=>"experimental", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/{index}/_rollup/data", "methods"=>["GET"], "parts"=>{"index"=>{"type"=>"string", "description"=>"The rollup index or index pattern to obtain rollup capabilities from."}}}]}}
2210
+ request(api_name, api_spec, params)
2211
+ end
2212
+
2213
+ # rollup.put_job
2214
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-put-job.html", "description"=>"Creates a rollup job."}
2215
+ def rollup_put_job(params = {})
2216
+ api_name = 'rollup.put_job'
2217
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-put-job.html", "description"=>"Creates a rollup job."}, "stability"=>"experimental", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_rollup/job/{id}", "methods"=>["PUT"], "parts"=>{"id"=>{"type"=>"string", "description"=>"The ID of the job to create"}}}]}, "body"=>{"description"=>"The job configuration", "required"=>true}}
2218
+ request(api_name, api_spec, params)
2219
+ end
2220
+
2221
+ # rollup.rollup
2222
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-rollup.html", "description"=>"Rollup an index"}
2223
+ def rollup_rollup(params = {})
2224
+ api_name = 'rollup.rollup'
2225
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-rollup.html", "description"=>"Rollup an index"}, "stability"=>"experimental", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/{index}/_rollup/{rollup_index}", "methods"=>["POST"], "parts"=>{"index"=>{"type"=>"string", "description"=>"The index to roll up", "required"=>true}, "rollup_index"=>{"type"=>"string", "description"=>"The name of the rollup index to create", "required"=>true}}}]}, "params"=>{}, "body"=>{"description"=>"The rollup configuration", "required"=>true}}
2226
+ request(api_name, api_spec, params)
2227
+ end
2228
+
2229
+ # rollup.rollup_search
2230
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-search.html", "description"=>"Enables searching rolled-up data using the standard query DSL."}
2231
+ def rollup_rollup_search(params = {})
2232
+ api_name = 'rollup.rollup_search'
2233
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-search.html", "description"=>"Enables searching rolled-up data using the standard query DSL."}, "stability"=>"experimental", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/{index}/_rollup_search", "methods"=>["GET", "POST"], "parts"=>{"index"=>{"type"=>"list", "description"=>"The indices or index-pattern(s) (containing rollup or regular data) that should be searched"}}}, {"path"=>"/{index}/{type}/_rollup_search", "methods"=>["GET", "POST"], "parts"=>{"index"=>{"type"=>"list", "description"=>"The indices or index-pattern(s) (containing rollup or regular data) that should be searched"}, "type"=>{"type"=>"string", "required"=>false, "description"=>"The doc type inside the index", "deprecated"=>true}}, "deprecated"=>{"version"=>"7.0.0", "description"=>"Specifying types in urls has been deprecated"}}]}, "params"=>{"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}}, "body"=>{"description"=>"The search request body", "required"=>true}}
2234
+ request(api_name, api_spec, params)
2235
+ end
2236
+
2237
+ # rollup.start_job
2238
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-start-job.html", "description"=>"Starts an existing, stopped rollup job."}
2239
+ def rollup_start_job(params = {})
2240
+ api_name = 'rollup.start_job'
2241
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-start-job.html", "description"=>"Starts an existing, stopped rollup job."}, "stability"=>"experimental", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_rollup/job/{id}/_start", "methods"=>["POST"], "parts"=>{"id"=>{"type"=>"string", "description"=>"The ID of the job to start"}}}]}}
2242
+ request(api_name, api_spec, params)
2243
+ end
2244
+
2245
+ # rollup.stop_job
2246
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-stop-job.html", "description"=>"Stops an existing, started rollup job."}
2247
+ def rollup_stop_job(params = {})
2248
+ api_name = 'rollup.stop_job'
2249
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-stop-job.html", "description"=>"Stops an existing, started rollup job."}, "stability"=>"experimental", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_rollup/job/{id}/_stop", "methods"=>["POST"], "parts"=>{"id"=>{"type"=>"string", "description"=>"The ID of the job to stop"}}}]}, "params"=>{"wait_for_completion"=>{"type"=>"boolean", "required"=>false, "description"=>"True if the API should block until the job has fully stopped, false if should be executed async. Defaults to false."}, "timeout"=>{"type"=>"time", "required"=>false, "description"=>"Block for (at maximum) the specified duration while waiting for the job to stop. Defaults to 30s."}}}
2250
+ request(api_name, api_spec, params)
2251
+ end
2252
+
2253
+ # scripts_painless_execute
2254
+ # {"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"}
2255
+ def scripts_painless_execute(params = {})
2256
+ api_name = 'scripts_painless_execute'
2257
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_scripts/painless/_execute", "methods"=>["GET", "POST"]}]}, "params"=>{}, "body"=>{"description"=>"The script to execute"}}
2258
+ request(api_name, api_spec, params)
2259
+ end
2260
+
2261
+ # scroll
2262
+ # {"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."}
2263
+ def scroll(params = {})
2264
+ api_name = 'scroll'
2265
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "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."}}
2266
+ request(api_name, api_spec, params)
2267
+ end
2268
+
2269
+ # search
2270
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html", "description"=>"Returns results matching a query."}
2271
+ def search(params = {})
2272
+ api_name = 'search'
2273
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "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"}}}, {"path"=>"/{index}/{type}/_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"}, "type"=>{"type"=>"list", "description"=>"A comma-separated list of document types to search; leave empty to perform the operation on all types"}}, "deprecated"=>{"version"=>"7.0.0", "description"=>"Specifying types in urls has been deprecated"}}]}, "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}, "min_compatible_shard_node"=>{"type"=>"string", "description"=>"The minimum compatible version that all shards involved in search should have for this request to be successful"}}, "body"=>{"description"=>"The search definition using the Query DSL"}}
2274
+ request(api_name, api_spec, params)
2275
+ end
2276
+
2277
+ # search_shards
2278
+ # {"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."}
2279
+ def search_shards(params = {})
2280
+ api_name = 'search_shards'
2281
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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."}}}
2282
+ request(api_name, api_spec, params)
2283
+ end
2284
+
2285
+ # search_template
2286
+ # {"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."}
2287
+ def search_template(params = {})
2288
+ api_name = 'search_template'
2289
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "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"}}}, {"path"=>"/{index}/{type}/_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"}, "type"=>{"type"=>"list", "description"=>"A comma-separated list of document types to search; leave empty to perform the operation on all types"}}, "deprecated"=>{"version"=>"7.0.0", "description"=>"Specifying types in urls has been deprecated"}}]}, "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", "dfs_query_then_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}}
2290
+ request(api_name, api_spec, params)
2291
+ end
2292
+
2293
+ # searchable_snapshots.cache_stats
2294
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-apis.html", "description"=>"Retrieve node-level cache statistics about searchable snapshots."}
2295
+ def searchable_snapshots_cache_stats(params = {})
2296
+ api_name = 'searchable_snapshots.cache_stats'
2297
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-apis.html", "description"=>"Retrieve node-level cache statistics about searchable snapshots."}, "stability"=>"experimental", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_searchable_snapshots/cache/stats", "methods"=>["GET"]}, {"path"=>"/_searchable_snapshots/{node_id}/cache/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"}}}]}}
2298
+ request(api_name, api_spec, params)
2299
+ end
2300
+
2301
+ # searchable_snapshots.clear_cache
2302
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-apis.html", "description"=>"Clear the cache of searchable snapshots."}
2303
+ def searchable_snapshots_clear_cache(params = {})
2304
+ api_name = 'searchable_snapshots.clear_cache'
2305
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-apis.html", "description"=>"Clear the cache of searchable snapshots."}, "stability"=>"experimental", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_searchable_snapshots/cache/clear", "methods"=>["POST"]}, {"path"=>"/{index}/_searchable_snapshots/cache/clear", "methods"=>["POST"], "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", "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"}}}
2306
+ request(api_name, api_spec, params)
2307
+ end
2308
+
2309
+ # searchable_snapshots.mount
2310
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-api-mount-snapshot.html", "description"=>"Mount a snapshot as a searchable index."}
2311
+ def searchable_snapshots_mount(params = {})
2312
+ api_name = 'searchable_snapshots.mount'
2313
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-api-mount-snapshot.html", "description"=>"Mount a snapshot as a searchable index."}, "stability"=>"experimental", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_snapshot/{repository}/{snapshot}/_mount", "methods"=>["POST"], "parts"=>{"repository"=>{"type"=>"string", "description"=>"The name of the repository containing the snapshot of the index to mount"}, "snapshot"=>{"type"=>"string", "description"=>"The name of the snapshot of the index to mount"}}}]}, "params"=>{"master_timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, "wait_for_completion"=>{"type"=>"boolean", "description"=>"Should this request wait until the operation has completed before returning", "default"=>false}, "storage"=>{"type"=>"string", "description"=>"Selects the kind of local storage used to accelerate searches. Experimental, and defaults to `full_copy`", "default"=>false}}, "body"=>{"description"=>"The restore configuration for mounting the snapshot as searchable", "required"=>true}}
2314
+ request(api_name, api_spec, params)
2315
+ end
2316
+
2317
+ # searchable_snapshots.repository_stats
2318
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-apis.html", "description"=>"DEPRECATED: This API is replaced by the Repositories Metering API."}
2319
+ def searchable_snapshots_repository_stats(params = {})
2320
+ api_name = 'searchable_snapshots.repository_stats'
2321
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-apis.html", "description"=>"DEPRECATED: This API is replaced by the Repositories Metering API."}, "stability"=>"experimental", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_snapshot/{repository}/_stats", "methods"=>["GET"], "parts"=>{"repository"=>{"type"=>"string", "description"=>"The repository for which to get the stats for"}}}]}}
2322
+ request(api_name, api_spec, params)
2323
+ end
2324
+
2325
+ # searchable_snapshots.stats
2326
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-apis.html", "description"=>"Retrieve shard-level statistics about searchable snapshots."}
2327
+ def searchable_snapshots_stats(params = {})
2328
+ api_name = 'searchable_snapshots.stats'
2329
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-apis.html", "description"=>"Retrieve shard-level statistics about searchable snapshots."}, "stability"=>"experimental", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_searchable_snapshots/stats", "methods"=>["GET"]}, {"path"=>"/{index}/_searchable_snapshots/stats", "methods"=>["GET"], "parts"=>{"index"=>{"type"=>"list", "description"=>"A comma-separated list of index names"}}}]}, "params"=>{"level"=>{"type"=>"enum", "description"=>"Return stats aggregated at cluster, index or shard level", "options"=>["cluster", "indices", "shards"], "default"=>"indices"}}}
2330
+ request(api_name, api_spec, params)
2331
+ end
2332
+
2333
+ # security.authenticate
2334
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-authenticate.html", "description"=>"Enables authentication as a user and retrieve information about the authenticated user."}
2335
+ def security_authenticate(params = {})
2336
+ api_name = 'security.authenticate'
2337
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-authenticate.html", "description"=>"Enables authentication as a user and retrieve information about the authenticated user."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_security/_authenticate", "methods"=>["GET"]}]}, "params"=>{}}
2338
+ request(api_name, api_spec, params)
2339
+ end
2340
+
2341
+ # security.change_password
2342
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-change-password.html", "description"=>"Changes the passwords of users in the native realm and built-in users."}
2343
+ def security_change_password(params = {})
2344
+ api_name = 'security.change_password'
2345
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-change-password.html", "description"=>"Changes the passwords of users in the native realm and built-in users."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_security/user/{username}/_password", "methods"=>["PUT", "POST"], "parts"=>{"username"=>{"type"=>"string", "description"=>"The username of the user to change the password for"}}}, {"path"=>"/_security/user/_password", "methods"=>["PUT", "POST"]}]}, "params"=>{"refresh"=>{"type"=>"enum", "options"=>["true", "false", "wait_for"], "description"=>"If `true` (the default) 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` then do nothing with refreshes."}}, "body"=>{"description"=>"the new password for the user", "required"=>true}}
2346
+ request(api_name, api_spec, params)
2347
+ end
2348
+
2349
+ # security.clear_api_key_cache
2350
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-api-key-cache.html", "description"=>"Clear a subset or all entries from the API key cache."}
2351
+ def security_clear_api_key_cache(params = {})
2352
+ api_name = 'security.clear_api_key_cache'
2353
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-api-key-cache.html", "description"=>"Clear a subset or all entries from the API key cache."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_security/api_key/{ids}/_clear_cache", "methods"=>["POST"], "parts"=>{"ids"=>{"type"=>"list", "description"=>"A comma-separated list of IDs of API keys to clear from the cache"}}}]}, "params"=>{}}
2354
+ request(api_name, api_spec, params)
2355
+ end
2356
+
2357
+ # security.clear_cached_privileges
2358
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-privilege-cache.html", "description"=>"Evicts application privileges from the native application privileges cache."}
2359
+ def security_clear_cached_privileges(params = {})
2360
+ api_name = 'security.clear_cached_privileges'
2361
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-privilege-cache.html", "description"=>"Evicts application privileges from the native application privileges cache."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_security/privilege/{application}/_clear_cache", "methods"=>["POST"], "parts"=>{"application"=>{"type"=>"list", "description"=>"A comma-separated list of application names"}}}]}, "params"=>{}}
2362
+ request(api_name, api_spec, params)
2363
+ end
2364
+
2365
+ # security.clear_cached_realms
2366
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-cache.html", "description"=>"Evicts users from the user cache. Can completely clear the cache or evict specific users."}
2367
+ def security_clear_cached_realms(params = {})
2368
+ api_name = 'security.clear_cached_realms'
2369
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-cache.html", "description"=>"Evicts users from the user cache. Can completely clear the cache or evict specific users."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_security/realm/{realms}/_clear_cache", "methods"=>["POST"], "parts"=>{"realms"=>{"type"=>"list", "description"=>"Comma-separated list of realms to clear"}}}]}, "params"=>{"usernames"=>{"type"=>"list", "description"=>"Comma-separated list of usernames to clear from the cache", "required"=>false}}}
2370
+ request(api_name, api_spec, params)
2371
+ end
2372
+
2373
+ # security.clear_cached_roles
2374
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-role-cache.html", "description"=>"Evicts roles from the native role cache."}
2375
+ def security_clear_cached_roles(params = {})
2376
+ api_name = 'security.clear_cached_roles'
2377
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-role-cache.html", "description"=>"Evicts roles from the native role cache."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_security/role/{name}/_clear_cache", "methods"=>["POST"], "parts"=>{"name"=>{"type"=>"list", "description"=>"Role name"}}}]}, "params"=>{}}
2378
+ request(api_name, api_spec, params)
2379
+ end
2380
+
2381
+ # security.clear_cached_service_tokens
2382
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-service-token-caches.html", "description"=>"Evicts tokens from the service account token caches."}
2383
+ def security_clear_cached_service_tokens(params = {})
2384
+ api_name = 'security.clear_cached_service_tokens'
2385
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-service-token-caches.html", "description"=>"Evicts tokens from the service account token caches."}, "stability"=>"beta", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_security/service/{namespace}/{service}/credential/token/{name}/_clear_cache", "methods"=>["POST"], "parts"=>{"namespace"=>{"type"=>"string", "description"=>"An identifier for the namespace"}, "service"=>{"type"=>"string", "description"=>"An identifier for the service name"}, "name"=>{"type"=>"list", "description"=>"A comma-separated list of service token names"}}}]}, "params"=>{}}
2386
+ request(api_name, api_spec, params)
2387
+ end
2388
+
2389
+ # security.create_api_key
2390
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html", "description"=>"Creates an API key for access without requiring basic authentication."}
2391
+ def security_create_api_key(params = {})
2392
+ api_name = 'security.create_api_key'
2393
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html", "description"=>"Creates an API key for access without requiring basic authentication."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_security/api_key", "methods"=>["PUT", "POST"]}]}, "params"=>{"refresh"=>{"type"=>"enum", "options"=>["true", "false", "wait_for"], "description"=>"If `true` (the default) 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` then do nothing with refreshes."}}, "body"=>{"description"=>"The api key request to create an API key", "required"=>true}}
2394
+ request(api_name, api_spec, params)
2395
+ end
2396
+
2397
+ # security.create_service_token
2398
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-service-token.html", "description"=>"Creates a service account token for access without requiring basic authentication."}
2399
+ def security_create_service_token(params = {})
2400
+ api_name = 'security.create_service_token'
2401
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-service-token.html", "description"=>"Creates a service account token for access without requiring basic authentication."}, "stability"=>"beta", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_security/service/{namespace}/{service}/credential/token/{name}", "methods"=>["PUT", "POST"], "parts"=>{"namespace"=>{"type"=>"string", "description"=>"An identifier for the namespace"}, "service"=>{"type"=>"string", "description"=>"An identifier for the service name"}, "name"=>{"type"=>"string", "description"=>"An identifier for the token name"}}}, {"path"=>"/_security/service/{namespace}/{service}/credential/token", "methods"=>["POST"], "parts"=>{"namespace"=>{"type"=>"string", "description"=>"An identifier for the namespace"}, "service"=>{"type"=>"string", "description"=>"An identifier for the service name"}}}]}, "params"=>{"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` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes."}}}
2402
+ request(api_name, api_spec, params)
2403
+ end
2404
+
2405
+ # security.delete_privileges
2406
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-privilege.html", "description"=>"Removes application privileges."}
2407
+ def security_delete_privileges(params = {})
2408
+ api_name = 'security.delete_privileges'
2409
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-privilege.html", "description"=>"Removes application privileges."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_security/privilege/{application}/{name}", "methods"=>["DELETE"], "parts"=>{"application"=>{"type"=>"string", "description"=>"Application name"}, "name"=>{"type"=>"string", "description"=>"Privilege name"}}}]}, "params"=>{"refresh"=>{"type"=>"enum", "options"=>["true", "false", "wait_for"], "description"=>"If `true` (the default) 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` then do nothing with refreshes."}}}
2410
+ request(api_name, api_spec, params)
2411
+ end
2412
+
2413
+ # security.delete_role
2414
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role.html", "description"=>"Removes roles in the native realm."}
2415
+ def security_delete_role(params = {})
2416
+ api_name = 'security.delete_role'
2417
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role.html", "description"=>"Removes roles in the native realm."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_security/role/{name}", "methods"=>["DELETE"], "parts"=>{"name"=>{"type"=>"string", "description"=>"Role name"}}}]}, "params"=>{"refresh"=>{"type"=>"enum", "options"=>["true", "false", "wait_for"], "description"=>"If `true` (the default) 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` then do nothing with refreshes."}}}
2418
+ request(api_name, api_spec, params)
2419
+ end
2420
+
2421
+ # security.delete_role_mapping
2422
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role-mapping.html", "description"=>"Removes role mappings."}
2423
+ def security_delete_role_mapping(params = {})
2424
+ api_name = 'security.delete_role_mapping'
2425
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role-mapping.html", "description"=>"Removes role mappings."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_security/role_mapping/{name}", "methods"=>["DELETE"], "parts"=>{"name"=>{"type"=>"string", "description"=>"Role-mapping name"}}}]}, "params"=>{"refresh"=>{"type"=>"enum", "options"=>["true", "false", "wait_for"], "description"=>"If `true` (the default) 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` then do nothing with refreshes."}}}
2426
+ request(api_name, api_spec, params)
2427
+ end
2428
+
2429
+ # security.delete_service_token
2430
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-service-token.html", "description"=>"Deletes a service account token."}
2431
+ def security_delete_service_token(params = {})
2432
+ api_name = 'security.delete_service_token'
2433
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-service-token.html", "description"=>"Deletes a service account token."}, "stability"=>"beta", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_security/service/{namespace}/{service}/credential/token/{name}", "methods"=>["DELETE"], "parts"=>{"namespace"=>{"type"=>"string", "description"=>"An identifier for the namespace"}, "service"=>{"type"=>"string", "description"=>"An identifier for the service name"}, "name"=>{"type"=>"string", "description"=>"An identifier for the token name"}}}]}, "params"=>{"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` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes."}}}
2434
+ request(api_name, api_spec, params)
2435
+ end
2436
+
2437
+ # security.delete_user
2438
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-user.html", "description"=>"Deletes users from the native realm."}
2439
+ def security_delete_user(params = {})
2440
+ api_name = 'security.delete_user'
2441
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-user.html", "description"=>"Deletes users from the native realm."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_security/user/{username}", "methods"=>["DELETE"], "parts"=>{"username"=>{"type"=>"string", "description"=>"username"}}}]}, "params"=>{"refresh"=>{"type"=>"enum", "options"=>["true", "false", "wait_for"], "description"=>"If `true` (the default) 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` then do nothing with refreshes."}}}
2442
+ request(api_name, api_spec, params)
2443
+ end
2444
+
2445
+ # security.disable_user
2446
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-disable-user.html", "description"=>"Disables users in the native realm."}
2447
+ def security_disable_user(params = {})
2448
+ api_name = 'security.disable_user'
2449
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-disable-user.html", "description"=>"Disables users in the native realm."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_security/user/{username}/_disable", "methods"=>["PUT", "POST"], "parts"=>{"username"=>{"type"=>"string", "description"=>"The username of the user to disable"}}}]}, "params"=>{"refresh"=>{"type"=>"enum", "options"=>["true", "false", "wait_for"], "description"=>"If `true` (the default) 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` then do nothing with refreshes."}}}
2450
+ request(api_name, api_spec, params)
2451
+ end
2452
+
2453
+ # security.enable_user
2454
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-enable-user.html", "description"=>"Enables users in the native realm."}
2455
+ def security_enable_user(params = {})
2456
+ api_name = 'security.enable_user'
2457
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-enable-user.html", "description"=>"Enables users in the native realm."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_security/user/{username}/_enable", "methods"=>["PUT", "POST"], "parts"=>{"username"=>{"type"=>"string", "description"=>"The username of the user to enable"}}}]}, "params"=>{"refresh"=>{"type"=>"enum", "options"=>["true", "false", "wait_for"], "description"=>"If `true` (the default) 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` then do nothing with refreshes."}}}
2458
+ request(api_name, api_spec, params)
2459
+ end
2460
+
2461
+ # security.get_api_key
2462
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-api-key.html", "description"=>"Retrieves information for one or more API keys."}
2463
+ def security_get_api_key(params = {})
2464
+ api_name = 'security.get_api_key'
2465
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-api-key.html", "description"=>"Retrieves information for one or more API keys."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_security/api_key", "methods"=>["GET"]}]}, "params"=>{"id"=>{"type"=>"string", "description"=>"API key id of the API key to be retrieved"}, "name"=>{"type"=>"string", "description"=>"API key name of the API key to be retrieved"}, "username"=>{"type"=>"string", "description"=>"user name of the user who created this API key to be retrieved"}, "realm_name"=>{"type"=>"string", "description"=>"realm name of the user who created this API key to be retrieved"}, "owner"=>{"type"=>"boolean", "default"=>false, "description"=>"flag to query API keys owned by the currently authenticated user"}}}
2466
+ request(api_name, api_spec, params)
2467
+ end
2468
+
2469
+ # security.get_builtin_privileges
2470
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-builtin-privileges.html", "description"=>"Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch."}
2471
+ def security_get_builtin_privileges(params = {})
2472
+ api_name = 'security.get_builtin_privileges'
2473
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-builtin-privileges.html", "description"=>"Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_security/privilege/_builtin", "methods"=>["GET"]}]}, "params"=>{}}
2474
+ request(api_name, api_spec, params)
2475
+ end
2476
+
2477
+ # security.get_privileges
2478
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-privileges.html", "description"=>"Retrieves application privileges."}
2479
+ def security_get_privileges(params = {})
2480
+ api_name = 'security.get_privileges'
2481
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-privileges.html", "description"=>"Retrieves application privileges."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_security/privilege", "methods"=>["GET"]}, {"path"=>"/_security/privilege/{application}", "methods"=>["GET"], "parts"=>{"application"=>{"type"=>"string", "description"=>"Application name"}}}, {"path"=>"/_security/privilege/{application}/{name}", "methods"=>["GET"], "parts"=>{"application"=>{"type"=>"string", "description"=>"Application name"}, "name"=>{"type"=>"string", "description"=>"Privilege name"}}}]}, "params"=>{}}
2482
+ request(api_name, api_spec, params)
2483
+ end
2484
+
2485
+ # security.get_role
2486
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html", "description"=>"Retrieves roles in the native realm."}
2487
+ def security_get_role(params = {})
2488
+ api_name = 'security.get_role'
2489
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html", "description"=>"Retrieves roles in the native realm."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_security/role/{name}", "methods"=>["GET"], "parts"=>{"name"=>{"type"=>"list", "description"=>"A comma-separated list of role names"}}}, {"path"=>"/_security/role", "methods"=>["GET"]}]}, "params"=>{}}
2490
+ request(api_name, api_spec, params)
2491
+ end
2492
+
2493
+ # security.get_role_mapping
2494
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role-mapping.html", "description"=>"Retrieves role mappings."}
2495
+ def security_get_role_mapping(params = {})
2496
+ api_name = 'security.get_role_mapping'
2497
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role-mapping.html", "description"=>"Retrieves role mappings."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_security/role_mapping/{name}", "methods"=>["GET"], "parts"=>{"name"=>{"type"=>"list", "description"=>"A comma-separated list of role-mapping names"}}}, {"path"=>"/_security/role_mapping", "methods"=>["GET"]}]}, "params"=>{}}
2498
+ request(api_name, api_spec, params)
2499
+ end
2500
+
2501
+ # security.get_service_accounts
2502
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-accounts.html", "description"=>"Retrieves information about service accounts."}
2503
+ def security_get_service_accounts(params = {})
2504
+ api_name = 'security.get_service_accounts'
2505
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-accounts.html", "description"=>"Retrieves information about service accounts."}, "stability"=>"beta", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_security/service/{namespace}/{service}", "methods"=>["GET"], "parts"=>{"namespace"=>{"type"=>"string", "description"=>"An identifier for the namespace"}, "service"=>{"type"=>"string", "description"=>"An identifier for the service name"}}}, {"path"=>"/_security/service/{namespace}", "methods"=>["GET"], "parts"=>{"namespace"=>{"type"=>"string", "description"=>"An identifier for the namespace"}}}, {"path"=>"/_security/service", "methods"=>["GET"]}]}, "params"=>{}}
2506
+ request(api_name, api_spec, params)
2507
+ end
2508
+
2509
+ # security.get_service_credentials
2510
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-credentials.html", "description"=>"Retrieves information of all service credentials for a service account."}
2511
+ def security_get_service_credentials(params = {})
2512
+ api_name = 'security.get_service_credentials'
2513
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-credentials.html", "description"=>"Retrieves information of all service credentials for a service account."}, "stability"=>"beta", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_security/service/{namespace}/{service}/credential", "methods"=>["GET"], "parts"=>{"namespace"=>{"type"=>"string", "description"=>"An identifier for the namespace"}, "service"=>{"type"=>"string", "description"=>"An identifier for the service name"}}}]}, "params"=>{}}
2514
+ request(api_name, api_spec, params)
2515
+ end
2516
+
2517
+ # security.get_token
2518
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-token.html", "description"=>"Creates a bearer token for access without requiring basic authentication."}
2519
+ def security_get_token(params = {})
2520
+ api_name = 'security.get_token'
2521
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-token.html", "description"=>"Creates a bearer token for access without requiring basic authentication."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_security/oauth2/token", "methods"=>["POST"]}]}, "params"=>{}, "body"=>{"description"=>"The token request to get", "required"=>true}}
2522
+ request(api_name, api_spec, params)
2523
+ end
2524
+
2525
+ # security.get_user
2526
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user.html", "description"=>"Retrieves information about users in the native realm and built-in users."}
2527
+ def security_get_user(params = {})
2528
+ api_name = 'security.get_user'
2529
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user.html", "description"=>"Retrieves information about users in the native realm and built-in users."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_security/user/{username}", "methods"=>["GET"], "parts"=>{"username"=>{"type"=>"list", "description"=>"A comma-separated list of usernames"}}}, {"path"=>"/_security/user", "methods"=>["GET"]}]}, "params"=>{}}
2530
+ request(api_name, api_spec, params)
2531
+ end
2532
+
2533
+ # security.get_user_privileges
2534
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user-privileges.html", "description"=>"Retrieves security privileges for the logged in user."}
2535
+ def security_get_user_privileges(params = {})
2536
+ api_name = 'security.get_user_privileges'
2537
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user-privileges.html", "description"=>"Retrieves security privileges for the logged in user."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_security/user/_privileges", "methods"=>["GET"]}]}, "params"=>{}}
2538
+ request(api_name, api_spec, params)
2539
+ end
2540
+
2541
+ # security.grant_api_key
2542
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-grant-api-key.html", "description"=>"Creates an API key on behalf of another user."}
2543
+ def security_grant_api_key(params = {})
2544
+ api_name = 'security.grant_api_key'
2545
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-grant-api-key.html", "description"=>"Creates an API key on behalf of another user."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_security/api_key/grant", "methods"=>["POST"]}]}, "params"=>{"refresh"=>{"type"=>"enum", "options"=>["true", "false", "wait_for"], "description"=>"If `true` (the default) 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` then do nothing with refreshes."}}, "body"=>{"description"=>"The api key request to create an API key", "required"=>true}}
2546
+ request(api_name, api_spec, params)
2547
+ end
2548
+
2549
+ # security.has_privileges
2550
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges.html", "description"=>"Determines whether the specified user has a specified list of privileges."}
2551
+ def security_has_privileges(params = {})
2552
+ api_name = 'security.has_privileges'
2553
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges.html", "description"=>"Determines whether the specified user has a specified list of privileges."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_security/user/_has_privileges", "methods"=>["GET", "POST"]}, {"path"=>"/_security/user/{user}/_has_privileges", "methods"=>["GET", "POST"], "parts"=>{"user"=>{"type"=>"string", "description"=>"Username"}}}]}, "params"=>{}, "body"=>{"description"=>"The privileges to test", "required"=>true}}
2554
+ request(api_name, api_spec, params)
2555
+ end
2556
+
2557
+ # security.invalidate_api_key
2558
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-api-key.html", "description"=>"Invalidates one or more API keys."}
2559
+ def security_invalidate_api_key(params = {})
2560
+ api_name = 'security.invalidate_api_key'
2561
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-api-key.html", "description"=>"Invalidates one or more API keys."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_security/api_key", "methods"=>["DELETE"]}]}, "body"=>{"description"=>"The api key request to invalidate API key(s)", "required"=>true}}
2562
+ request(api_name, api_spec, params)
2563
+ end
2564
+
2565
+ # security.invalidate_token
2566
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-token.html", "description"=>"Invalidates one or more access tokens or refresh tokens."}
2567
+ def security_invalidate_token(params = {})
2568
+ api_name = 'security.invalidate_token'
2569
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-token.html", "description"=>"Invalidates one or more access tokens or refresh tokens."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_security/oauth2/token", "methods"=>["DELETE"]}]}, "params"=>{}, "body"=>{"description"=>"The token to invalidate", "required"=>true}}
2570
+ request(api_name, api_spec, params)
2571
+ end
2572
+
2573
+ # security.put_privileges
2574
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-privileges.html", "description"=>"Adds or updates application privileges."}
2575
+ def security_put_privileges(params = {})
2576
+ api_name = 'security.put_privileges'
2577
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-privileges.html", "description"=>"Adds or updates application privileges."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_security/privilege/", "methods"=>["PUT", "POST"]}]}, "params"=>{"refresh"=>{"type"=>"enum", "options"=>["true", "false", "wait_for"], "description"=>"If `true` (the default) 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` then do nothing with refreshes."}}, "body"=>{"description"=>"The privilege(s) to add", "required"=>true}}
2578
+ request(api_name, api_spec, params)
2579
+ end
2580
+
2581
+ # security.put_role
2582
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html", "description"=>"Adds and updates roles in the native realm."}
2583
+ def security_put_role(params = {})
2584
+ api_name = 'security.put_role'
2585
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html", "description"=>"Adds and updates roles in the native realm."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_security/role/{name}", "methods"=>["PUT", "POST"], "parts"=>{"name"=>{"type"=>"string", "description"=>"Role name"}}}]}, "params"=>{"refresh"=>{"type"=>"enum", "options"=>["true", "false", "wait_for"], "description"=>"If `true` (the default) 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` then do nothing with refreshes."}}, "body"=>{"description"=>"The role to add", "required"=>true}}
2586
+ request(api_name, api_spec, params)
2587
+ end
2588
+
2589
+ # security.put_role_mapping
2590
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role-mapping.html", "description"=>"Creates and updates role mappings."}
2591
+ def security_put_role_mapping(params = {})
2592
+ api_name = 'security.put_role_mapping'
2593
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role-mapping.html", "description"=>"Creates and updates role mappings."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_security/role_mapping/{name}", "methods"=>["PUT", "POST"], "parts"=>{"name"=>{"type"=>"string", "description"=>"Role-mapping name"}}}]}, "params"=>{"refresh"=>{"type"=>"enum", "options"=>["true", "false", "wait_for"], "description"=>"If `true` (the default) 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` then do nothing with refreshes."}}, "body"=>{"description"=>"The role mapping to add", "required"=>true}}
2594
+ request(api_name, api_spec, params)
2595
+ end
2596
+
2597
+ # security.put_user
2598
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html", "description"=>"Adds and updates users in the native realm. These users are commonly referred to as native users."}
2599
+ def security_put_user(params = {})
2600
+ api_name = 'security.put_user'
2601
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html", "description"=>"Adds and updates users in the native realm. These users are commonly referred to as native users."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_security/user/{username}", "methods"=>["PUT", "POST"], "parts"=>{"username"=>{"type"=>"string", "description"=>"The username of the User"}}}]}, "params"=>{"refresh"=>{"type"=>"enum", "options"=>["true", "false", "wait_for"], "description"=>"If `true` (the default) 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` then do nothing with refreshes."}}, "body"=>{"description"=>"The user to add", "required"=>true}}
2602
+ request(api_name, api_spec, params)
2603
+ end
2604
+
2605
+ # security.saml_authenticate
2606
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-authenticate.html", "description"=>"Exchanges a SAML Response message for an Elasticsearch access token and refresh token pair"}
2607
+ def security_saml_authenticate(params = {})
2608
+ api_name = 'security.saml_authenticate'
2609
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-authenticate.html", "description"=>"Exchanges a SAML Response message for an Elasticsearch access token and refresh token pair"}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_security/saml/authenticate", "methods"=>["POST"]}]}, "body"=>{"description"=>"The SAML response to authenticate", "required"=>true}}
2610
+ request(api_name, api_spec, params)
2611
+ end
2612
+
2613
+ # security.saml_complete_logout
2614
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-complete-logout.html", "description"=>"Verifies the logout response sent from the SAML IdP"}
2615
+ def security_saml_complete_logout(params = {})
2616
+ api_name = 'security.saml_complete_logout'
2617
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-complete-logout.html", "description"=>"Verifies the logout response sent from the SAML IdP"}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_security/saml/complete_logout", "methods"=>["POST"]}]}, "body"=>{"description"=>"The logout response to verify", "required"=>true}}
2618
+ request(api_name, api_spec, params)
2619
+ end
2620
+
2621
+ # security.saml_invalidate
2622
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-invalidate.html", "description"=>"Consumes a SAML LogoutRequest"}
2623
+ def security_saml_invalidate(params = {})
2624
+ api_name = 'security.saml_invalidate'
2625
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-invalidate.html", "description"=>"Consumes a SAML LogoutRequest"}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_security/saml/invalidate", "methods"=>["POST"]}]}, "body"=>{"description"=>"The LogoutRequest message", "required"=>true}}
2626
+ request(api_name, api_spec, params)
2627
+ end
2628
+
2629
+ # security.saml_logout
2630
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-logout.html", "description"=>"Invalidates an access token and a refresh token that were generated via the SAML Authenticate API"}
2631
+ def security_saml_logout(params = {})
2632
+ api_name = 'security.saml_logout'
2633
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-logout.html", "description"=>"Invalidates an access token and a refresh token that were generated via the SAML Authenticate API"}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_security/saml/logout", "methods"=>["POST"]}]}, "body"=>{"description"=>"The tokens to invalidate", "required"=>true}}
2634
+ request(api_name, api_spec, params)
2635
+ end
2636
+
2637
+ # security.saml_prepare_authentication
2638
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-prepare-authentication.html", "description"=>"Creates a SAML authentication request"}
2639
+ def security_saml_prepare_authentication(params = {})
2640
+ api_name = 'security.saml_prepare_authentication'
2641
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-prepare-authentication.html", "description"=>"Creates a SAML authentication request"}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_security/saml/prepare", "methods"=>["POST"]}]}, "body"=>{"description"=>"The realm for which to create the authentication request, identified by either its name or the ACS URL", "required"=>true}}
2642
+ request(api_name, api_spec, params)
2643
+ end
2644
+
2645
+ # security.saml_service_provider_metadata
2646
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-sp-metadata.html", "description"=>"Generates SAML metadata for the Elastic stack SAML 2.0 Service Provider"}
2647
+ def security_saml_service_provider_metadata(params = {})
2648
+ api_name = 'security.saml_service_provider_metadata'
2649
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-sp-metadata.html", "description"=>"Generates SAML metadata for the Elastic stack SAML 2.0 Service Provider"}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_security/saml/metadata/{realm_name}", "methods"=>["GET"], "parts"=>{"realm_name"=>{"type"=>"string", "description"=>"The name of the SAML realm to get the metadata for"}}}]}}
2650
+ request(api_name, api_spec, params)
2651
+ end
2652
+
2653
+ # shutdown.delete_node
2654
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current", "description"=>"Removes a node from the shutdown list"}
2655
+ def shutdown_delete_node(params = {})
2656
+ api_name = 'shutdown.delete_node'
2657
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current", "description"=>"Removes a node from the shutdown list"}, "stability"=>"experimental", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_nodes/{node_id}/shutdown", "methods"=>["DELETE"], "parts"=>{"node_id"=>{"type"=>"string", "description"=>"The node id of node to be removed from the shutdown state"}}}]}, "params"=>{}}
2658
+ request(api_name, api_spec, params)
2659
+ end
2660
+
2661
+ # shutdown.get_node
2662
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current", "description"=>"Retrieve status of a node or nodes that are currently marked as shutting down"}
2663
+ def shutdown_get_node(params = {})
2664
+ api_name = 'shutdown.get_node'
2665
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current", "description"=>"Retrieve status of a node or nodes that are currently marked as shutting down"}, "stability"=>"experimental", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_nodes/shutdown", "methods"=>["GET"], "parts"=>{}}, {"path"=>"/_nodes/{node_id}/shutdown", "methods"=>["GET"], "parts"=>{"node_id"=>{"type"=>"string", "description"=>"Which node for which to retrieve the shutdown status"}}}]}, "params"=>{}}
2666
+ request(api_name, api_spec, params)
2667
+ end
2668
+
2669
+ # shutdown.put_node
2670
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current", "description"=>"Adds a node to be shut down"}
2671
+ def shutdown_put_node(params = {})
2672
+ api_name = 'shutdown.put_node'
2673
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current", "description"=>"Adds a node to be shut down"}, "stability"=>"experimental", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_nodes/{node_id}/shutdown", "methods"=>["PUT"], "parts"=>{"node_id"=>{"type"=>"string", "description"=>"The node id of node to be shut down"}}}]}, "params"=>{}, "body"=>{"description"=>"The shutdown type definition to register", "required"=>true}}
2674
+ request(api_name, api_spec, params)
2675
+ end
2676
+
2677
+ # slm.delete_lifecycle
2678
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-delete-policy.html", "description"=>"Deletes an existing snapshot lifecycle policy."}
2679
+ def slm_delete_lifecycle(params = {})
2680
+ api_name = 'slm.delete_lifecycle'
2681
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-delete-policy.html", "description"=>"Deletes an existing snapshot lifecycle policy."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_slm/policy/{policy_id}", "methods"=>["DELETE"], "parts"=>{"policy_id"=>{"type"=>"string", "description"=>"The id of the snapshot lifecycle policy to remove"}}}]}, "params"=>{}}
2682
+ request(api_name, api_spec, params)
2683
+ end
2684
+
2685
+ # slm.execute_lifecycle
2686
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-lifecycle.html", "description"=>"Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time."}
2687
+ def slm_execute_lifecycle(params = {})
2688
+ api_name = 'slm.execute_lifecycle'
2689
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-lifecycle.html", "description"=>"Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_slm/policy/{policy_id}/_execute", "methods"=>["PUT"], "parts"=>{"policy_id"=>{"type"=>"string", "description"=>"The id of the snapshot lifecycle policy to be executed"}}}]}, "params"=>{}}
2690
+ request(api_name, api_spec, params)
2691
+ end
2692
+
2693
+ # slm.execute_retention
2694
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-retention.html", "description"=>"Deletes any snapshots that are expired according to the policy's retention rules."}
2695
+ def slm_execute_retention(params = {})
2696
+ api_name = 'slm.execute_retention'
2697
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-retention.html", "description"=>"Deletes any snapshots that are expired according to the policy's retention rules."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_slm/_execute_retention", "methods"=>["POST"]}]}, "params"=>{}}
2698
+ request(api_name, api_spec, params)
2699
+ end
2700
+
2701
+ # slm.get_lifecycle
2702
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get-policy.html", "description"=>"Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts."}
2703
+ def slm_get_lifecycle(params = {})
2704
+ api_name = 'slm.get_lifecycle'
2705
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get-policy.html", "description"=>"Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_slm/policy/{policy_id}", "methods"=>["GET"], "parts"=>{"policy_id"=>{"type"=>"list", "description"=>"Comma-separated list of snapshot lifecycle policies to retrieve"}}}, {"path"=>"/_slm/policy", "methods"=>["GET"]}]}, "params"=>{}}
2706
+ request(api_name, api_spec, params)
2707
+ end
2708
+
2709
+ # slm.get_stats
2710
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/slm-api-get-stats.html", "description"=>"Returns global and policy-level statistics about actions taken by snapshot lifecycle management."}
2711
+ def slm_get_stats(params = {})
2712
+ api_name = 'slm.get_stats'
2713
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/slm-api-get-stats.html", "description"=>"Returns global and policy-level statistics about actions taken by snapshot lifecycle management."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_slm/stats", "methods"=>["GET"]}]}, "params"=>{}}
2714
+ request(api_name, api_spec, params)
2715
+ end
2716
+
2717
+ # slm.get_status
2718
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get-status.html", "description"=>"Retrieves the status of snapshot lifecycle management (SLM)."}
2719
+ def slm_get_status(params = {})
2720
+ api_name = 'slm.get_status'
2721
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get-status.html", "description"=>"Retrieves the status of snapshot lifecycle management (SLM)."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_slm/status", "methods"=>["GET"]}]}, "params"=>{}}
2722
+ request(api_name, api_spec, params)
2723
+ end
2724
+
2725
+ # slm.put_lifecycle
2726
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-put-policy.html", "description"=>"Creates or updates a snapshot lifecycle policy."}
2727
+ def slm_put_lifecycle(params = {})
2728
+ api_name = 'slm.put_lifecycle'
2729
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-put-policy.html", "description"=>"Creates or updates a snapshot lifecycle policy."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_slm/policy/{policy_id}", "methods"=>["PUT"], "parts"=>{"policy_id"=>{"type"=>"string", "description"=>"The id of the snapshot lifecycle policy"}}}]}, "params"=>{}, "body"=>{"description"=>"The snapshot lifecycle policy definition to register"}}
2730
+ request(api_name, api_spec, params)
2731
+ end
2732
+
2733
+ # slm.start
2734
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-start.html", "description"=>"Turns on snapshot lifecycle management (SLM)."}
2735
+ def slm_start(params = {})
2736
+ api_name = 'slm.start'
2737
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-start.html", "description"=>"Turns on snapshot lifecycle management (SLM)."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_slm/start", "methods"=>["POST"]}]}, "params"=>{}}
2738
+ request(api_name, api_spec, params)
2739
+ end
2740
+
2741
+ # slm.stop
2742
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-stop.html", "description"=>"Turns off snapshot lifecycle management (SLM)."}
2743
+ def slm_stop(params = {})
2744
+ api_name = 'slm.stop'
2745
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-stop.html", "description"=>"Turns off snapshot lifecycle management (SLM)."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_slm/stop", "methods"=>["POST"]}]}, "params"=>{}}
2746
+ request(api_name, api_spec, params)
2747
+ end
2748
+
2749
+ # snapshot.cleanup_repository
2750
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/clean-up-snapshot-repo-api.html", "description"=>"Removes stale data from repository."}
2751
+ def snapshot_cleanup_repository(params = {})
2752
+ api_name = 'snapshot.cleanup_repository'
2753
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"}, "timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}}}
2754
+ request(api_name, api_spec, params)
2755
+ end
2756
+
2757
+ # snapshot.clone
2758
+ # {"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."}
2759
+ def snapshot_clone(params = {})
2760
+ api_name = 'snapshot.clone'
2761
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "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"}}, "body"=>{"description"=>"The snapshot clone definition", "required"=>true}}
2762
+ request(api_name, api_spec, params)
2763
+ end
2764
+
2765
+ # snapshot.create
2766
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "description"=>"Creates a snapshot in a repository."}
2767
+ def snapshot_create(params = {})
2768
+ api_name = 'snapshot.create'
2769
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "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"}, "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}}
2770
+ request(api_name, api_spec, params)
2771
+ end
2772
+
2773
+ # snapshot.create_repository
2774
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "description"=>"Creates a repository."}
2775
+ def snapshot_create_repository(params = {})
2776
+ api_name = 'snapshot.create_repository'
2777
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "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"}, "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}}
2778
+ request(api_name, api_spec, params)
2779
+ end
2780
+
2781
+ # snapshot.delete
2782
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "description"=>"Deletes a snapshot."}
2783
+ def snapshot_delete(params = {})
2784
+ api_name = 'snapshot.delete'
2785
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"}}}
2786
+ request(api_name, api_spec, params)
2787
+ end
2788
+
2789
+ # snapshot.delete_repository
2790
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "description"=>"Deletes a repository."}
2791
+ def snapshot_delete_repository(params = {})
2792
+ api_name = 'snapshot.delete_repository'
2793
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"}, "timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}}}
2794
+ request(api_name, api_spec, params)
2795
+ end
2796
+
2797
+ # snapshot.get
2798
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "description"=>"Returns information about a snapshot."}
2799
+ def snapshot_get(params = {})
2800
+ api_name = 'snapshot.get'
2801
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"}, "ignore_unavailable"=>{"type"=>"boolean", "description"=>"Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown"}, "index_details"=>{"type"=>"boolean", "description"=>"Whether to include details of each index in the snapshot, if those details are available. Defaults to false."}, "include_repository"=>{"type"=>"boolean", "description"=>"Whether to include the repository name in the snapshot info. Defaults to true."}, "verbose"=>{"type"=>"boolean", "description"=>"Whether to show verbose snapshot info or only show the basic info found in the repository index blob"}}}
2802
+ request(api_name, api_spec, params)
2803
+ end
2804
+
2805
+ # snapshot.get_repository
2806
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "description"=>"Returns information about a repository."}
2807
+ def snapshot_get_repository(params = {})
2808
+ api_name = 'snapshot.get_repository'
2809
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"}, "local"=>{"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}}}
2810
+ request(api_name, api_spec, params)
2811
+ end
2812
+
2813
+ # snapshot.repository_analyze
2814
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "description"=>"Analyzes a repository for correctness and performance"}
2815
+ def snapshot_repository_analyze(params = {})
2816
+ api_name = 'snapshot.repository_analyze'
2817
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "description"=>"Analyzes a repository for correctness and performance"}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_snapshot/{repository}/_analyze", "methods"=>["POST"], "parts"=>{"repository"=>{"type"=>"string", "description"=>"A repository name"}}}]}, "params"=>{"blob_count"=>{"type"=>"number", "description"=>"Number of blobs to create during the test. Defaults to 100."}, "concurrency"=>{"type"=>"number", "description"=>"Number of operations to run concurrently during the test. Defaults to 10."}, "read_node_count"=>{"type"=>"number", "description"=>"Number of nodes on which to read a blob after writing. Defaults to 10."}, "early_read_node_count"=>{"type"=>"number", "description"=>"Number of nodes on which to perform an early read on a blob, i.e. before writing has completed. Early reads are rare actions so the 'rare_action_probability' parameter is also relevant. Defaults to 2."}, "seed"=>{"type"=>"number", "description"=>"Seed for the random number generator used to create the test workload. Defaults to a random value."}, "rare_action_probability"=>{"type"=>"number", "description"=>"Probability of taking a rare action such as an early read or an overwrite. Defaults to 0.02."}, "max_blob_size"=>{"type"=>"string", "description"=>"Maximum size of a blob to create during the test, e.g '1gb' or '100mb'. Defaults to '10mb'."}, "max_total_data_size"=>{"type"=>"string", "description"=>"Maximum total size of all blobs to create during the test, e.g '1tb' or '100gb'. Defaults to '1gb'."}, "timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout. Defaults to '30s'."}, "detailed"=>{"type"=>"boolean", "description"=>"Whether to return detailed results or a summary. Defaults to 'false' so that only the summary is returned."}, "rarely_abort_writes"=>{"type"=>"boolean", "description"=>"Whether to rarely abort writes before they complete. Defaults to 'true'."}}}
2818
+ request(api_name, api_spec, params)
2819
+ end
2820
+
2821
+ # snapshot.restore
2822
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "description"=>"Restores a snapshot."}
2823
+ def snapshot_restore(params = {})
2824
+ api_name = 'snapshot.restore'
2825
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "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"}, "wait_for_completion"=>{"type"=>"boolean", "description"=>"Should this request wait until the operation has completed before returning", "default"=>false}}, "body"=>{"description"=>"Details of what to restore", "required"=>false}}
2826
+ request(api_name, api_spec, params)
2827
+ end
2828
+
2829
+ # snapshot.status
2830
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "description"=>"Returns information about the status of a snapshot."}
2831
+ def snapshot_status(params = {})
2832
+ api_name = 'snapshot.status'
2833
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"}, "ignore_unavailable"=>{"type"=>"boolean", "description"=>"Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown"}}}
2834
+ request(api_name, api_spec, params)
2835
+ end
2836
+
2837
+ # snapshot.verify_repository
2838
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "description"=>"Verifies a repository."}
2839
+ def snapshot_verify_repository(params = {})
2840
+ api_name = 'snapshot.verify_repository'
2841
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"}, "timeout"=>{"type"=>"time", "description"=>"Explicit operation timeout"}}}
2842
+ request(api_name, api_spec, params)
2843
+ end
2844
+
2845
+ # sql.clear_cursor
2846
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-sql-cursor-api.html", "description"=>"Clears the SQL cursor"}
2847
+ def sql_clear_cursor(params = {})
2848
+ api_name = 'sql.clear_cursor'
2849
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-sql-cursor-api.html", "description"=>"Clears the SQL cursor"}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_sql/close", "methods"=>["POST"]}]}, "body"=>{"description"=>"Specify the cursor value in the `cursor` element to clean the cursor.", "required"=>true}}
2850
+ request(api_name, api_spec, params)
2851
+ end
2852
+
2853
+ # sql.delete_async
2854
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-async-sql-search-api.html", "description"=>"Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it."}
2855
+ def sql_delete_async(params = {})
2856
+ api_name = 'sql.delete_async'
2857
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-async-sql-search-api.html", "description"=>"Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_sql/async/delete/{id}", "methods"=>["DELETE"], "parts"=>{"id"=>{"type"=>"string", "description"=>"The async search ID"}}}]}}
2858
+ request(api_name, api_spec, params)
2859
+ end
2860
+
2861
+ # sql.get_async
2862
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-sql-search-api.html", "description"=>"Returns the current status and available results for an async SQL search or stored synchronous SQL search"}
2863
+ def sql_get_async(params = {})
2864
+ api_name = 'sql.get_async'
2865
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-sql-search-api.html", "description"=>"Returns the current status and available results for an async SQL search or stored synchronous SQL search"}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_sql/async/{id}", "methods"=>["GET"], "parts"=>{"id"=>{"type"=>"string", "description"=>"The async search ID"}}}]}, "params"=>{"delimiter"=>{"type"=>"string", "description"=>"Separator for CSV results", "default"=>","}, "format"=>{"type"=>"string", "description"=>"Short version of the Accept header, e.g. json, yaml"}, "keep_alive"=>{"type"=>"time", "description"=>"Retention period for the search and its results", "default"=>"5d"}, "wait_for_completion_timeout"=>{"type"=>"time", "description"=>"Duration to wait for complete results"}}}
2866
+ request(api_name, api_spec, params)
2867
+ end
2868
+
2869
+ # sql.get_async_status
2870
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-sql-search-status-api.html", "description"=>"Returns the current status of an async SQL search or a stored synchronous SQL search"}
2871
+ def sql_get_async_status(params = {})
2872
+ api_name = 'sql.get_async_status'
2873
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-sql-search-status-api.html", "description"=>"Returns the current status of an async SQL search or a stored synchronous SQL search"}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_sql/async/status/{id}", "methods"=>["GET"], "parts"=>{"id"=>{"type"=>"string", "description"=>"The async search ID"}}}]}}
2874
+ request(api_name, api_spec, params)
2875
+ end
2876
+
2877
+ # sql.query
2878
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-search-api.html", "description"=>"Executes a SQL request"}
2879
+ def sql_query(params = {})
2880
+ api_name = 'sql.query'
2881
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-search-api.html", "description"=>"Executes a SQL request"}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_sql", "methods"=>["POST", "GET"]}]}, "params"=>{"format"=>{"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}}, "body"=>{"description"=>"Use the `query` element to start a query. Use the `cursor` element to continue a query.", "required"=>true}}
2882
+ request(api_name, api_spec, params)
2883
+ end
2884
+
2885
+ # sql.translate
2886
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-translate-api.html", "description"=>"Translates SQL into Elasticsearch queries"}
2887
+ def sql_translate(params = {})
2888
+ api_name = 'sql.translate'
2889
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-translate-api.html", "description"=>"Translates SQL into Elasticsearch queries"}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_sql/translate", "methods"=>["POST", "GET"]}]}, "params"=>{}, "body"=>{"description"=>"Specify the query in the `query` element.", "required"=>true}}
2890
+ request(api_name, api_spec, params)
2891
+ end
2892
+
2893
+ # ssl.certificates
2894
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-ssl.html", "description"=>"Retrieves information about the X.509 certificates used to encrypt communications in the cluster."}
2895
+ def ssl_certificates(params = {})
2896
+ api_name = 'ssl.certificates'
2897
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-ssl.html", "description"=>"Retrieves information about the X.509 certificates used to encrypt communications in the cluster."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_ssl/certificates", "methods"=>["GET"]}]}, "params"=>{}}
2898
+ request(api_name, api_spec, params)
2899
+ end
2900
+
2901
+ # tasks.cancel
2902
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html", "description"=>"Cancels a task, if it can be cancelled through an API."}
2903
+ def tasks_cancel(params = {})
2904
+ api_name = 'tasks.cancel'
2905
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"}}}
2906
+ request(api_name, api_spec, params)
2907
+ end
2908
+
2909
+ # tasks.get
2910
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html", "description"=>"Returns information about a task."}
2911
+ def tasks_get(params = {})
2912
+ api_name = 'tasks.get'
2913
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"}}}
2914
+ request(api_name, api_spec, params)
2915
+ end
2916
+
2917
+ # tasks.list
2918
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html", "description"=>"Returns a list of tasks."}
2919
+ def tasks_list(params = {})
2920
+ api_name = 'tasks.list'
2921
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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"}}}
2922
+ request(api_name, api_spec, params)
2923
+ end
2924
+
2925
+ # terms_enum
2926
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/search-terms-enum.html", "description"=>"The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios."}
2927
+ def terms_enum(params = {})
2928
+ api_name = 'terms_enum'
2929
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/search-terms-enum.html", "description"=>"The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios."}, "stability"=>"beta", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/{index}/_terms_enum", "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"=>{}, "body"=>{"description"=>"field name, string which is the prefix expected in matching terms, timeout and size for max number of results"}}
2930
+ request(api_name, api_spec, params)
2931
+ end
2932
+
2933
+ # termvectors
2934
+ # {"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."}
2935
+ def termvectors(params = {})
2936
+ api_name = 'termvectors'
2937
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "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."}}}, {"path"=>"/{index}/{type}/{id}/_termvectors", "methods"=>["GET", "POST"], "parts"=>{"index"=>{"type"=>"string", "description"=>"The index in which the document resides.", "required"=>true}, "type"=>{"type"=>"string", "description"=>"The type of the document.", "required"=>false}, "id"=>{"type"=>"string", "description"=>"The id of the document, when not specified a doc param should be supplied."}}, "deprecated"=>{"version"=>"7.0.0", "description"=>"Specifying types in urls has been deprecated"}}, {"path"=>"/{index}/{type}/_termvectors", "methods"=>["GET", "POST"], "parts"=>{"index"=>{"type"=>"string", "description"=>"The index in which the document resides.", "required"=>true}, "type"=>{"type"=>"string", "description"=>"The type of the document.", "required"=>false}}, "deprecated"=>{"version"=>"7.0.0", "description"=>"Specifying types in urls has been deprecated"}}]}, "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}}
2938
+ request(api_name, api_spec, params)
2939
+ end
2940
+
2941
+ # text_structure.find_structure
2942
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/find-structure.html", "description"=>"Finds the structure of a text file. The text file must contain data that is suitable to be ingested into Elasticsearch."}
2943
+ def text_structure_find_structure(params = {})
2944
+ api_name = 'text_structure.find_structure'
2945
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/find-structure.html", "description"=>"Finds the structure of a text file. The text file must contain data that is suitable to be ingested into Elasticsearch."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/x-ndjson"]}, "url"=>{"paths"=>[{"path"=>"/_text_structure/find_structure", "methods"=>["POST"]}]}, "params"=>{"lines_to_sample"=>{"type"=>"int", "description"=>"How many lines of the file should be included in the analysis", "default"=>1000}, "line_merge_size_limit"=>{"type"=>"int", "description"=>"Maximum number of characters permitted in a single message when lines are merged to create messages.", "default"=>10000}, "timeout"=>{"type"=>"time", "description"=>"Timeout after which the analysis will be aborted", "default"=>"25s"}, "charset"=>{"type"=>"string", "description"=>"Optional parameter to specify the character set of the file"}, "format"=>{"type"=>"enum", "options"=>["ndjson", "xml", "delimited", "semi_structured_text"], "description"=>"Optional parameter to specify the high level file format"}, "has_header_row"=>{"type"=>"boolean", "description"=>"Optional parameter to specify whether a delimited file includes the column names in its first row"}, "column_names"=>{"type"=>"list", "description"=>"Optional parameter containing a comma separated list of the column names for a delimited file"}, "delimiter"=>{"type"=>"string", "description"=>"Optional parameter to specify the delimiter character for a delimited file - must be a single character"}, "quote"=>{"type"=>"string", "description"=>"Optional parameter to specify the quote character for a delimited file - must be a single character"}, "should_trim_fields"=>{"type"=>"boolean", "description"=>"Optional parameter to specify whether the values between delimiters in a delimited file should have whitespace trimmed from them"}, "grok_pattern"=>{"type"=>"string", "description"=>"Optional parameter to specify the Grok pattern that should be used to extract fields from messages in a semi-structured text file"}, "timestamp_field"=>{"type"=>"string", "description"=>"Optional parameter to specify the timestamp field in the file"}, "timestamp_format"=>{"type"=>"string", "description"=>"Optional parameter to specify the timestamp format in the file - may be either a Joda or Java time format"}, "explain"=>{"type"=>"boolean", "description"=>"Whether to include a commentary on how the structure was derived", "default"=>false}}, "body"=>{"description"=>"The contents of the file to be analyzed", "required"=>true, "serialize"=>"bulk"}}
2946
+ request(api_name, api_spec, params)
2947
+ end
2948
+
2949
+ # transform.delete_transform
2950
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html", "description"=>"Deletes an existing transform."}
2951
+ def transform_delete_transform(params = {})
2952
+ api_name = 'transform.delete_transform'
2953
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html", "description"=>"Deletes an existing transform."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_transform/{transform_id}", "methods"=>["DELETE"], "parts"=>{"transform_id"=>{"type"=>"string", "description"=>"The id of the transform to delete"}}}]}, "params"=>{"force"=>{"type"=>"boolean", "required"=>false, "description"=>"When `true`, the transform is deleted regardless of its current state. The default value is `false`, meaning that the transform must be `stopped` before it can be deleted."}}}
2954
+ request(api_name, api_spec, params)
2955
+ end
2956
+
2957
+ # transform.get_transform
2958
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html", "description"=>"Retrieves configuration information for transforms."}
2959
+ def transform_get_transform(params = {})
2960
+ api_name = 'transform.get_transform'
2961
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html", "description"=>"Retrieves configuration information for transforms."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_transform/{transform_id}", "methods"=>["GET"], "parts"=>{"transform_id"=>{"type"=>"string", "description"=>"The id or comma delimited list of id expressions of the transforms to get, '_all' or '*' implies get all transforms"}}}, {"path"=>"/_transform", "methods"=>["GET"]}]}, "params"=>{"from"=>{"type"=>"int", "required"=>false, "description"=>"skips a number of transform configs, defaults to 0"}, "size"=>{"type"=>"int", "required"=>false, "description"=>"specifies a max number of transforms to get, defaults to 100"}, "allow_no_match"=>{"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)"}, "exclude_generated"=>{"required"=>false, "type"=>"boolean", "default"=>false, "description"=>"Omits fields that are illegal to set on transform PUT"}}}
2962
+ request(api_name, api_spec, params)
2963
+ end
2964
+
2965
+ # transform.get_transform_stats
2966
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-stats.html", "description"=>"Retrieves usage information for transforms."}
2967
+ def transform_get_transform_stats(params = {})
2968
+ api_name = 'transform.get_transform_stats'
2969
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-stats.html", "description"=>"Retrieves usage information for transforms."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_transform/{transform_id}/_stats", "methods"=>["GET"], "parts"=>{"transform_id"=>{"type"=>"string", "description"=>"The id of the transform for which to get stats. '_all' or '*' implies all transforms"}}}]}, "params"=>{"from"=>{"type"=>"number", "required"=>false, "description"=>"skips a number of transform stats, defaults to 0"}, "size"=>{"type"=>"number", "required"=>false, "description"=>"specifies a max number of transform stats to get, defaults to 100"}, "allow_no_match"=>{"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)"}}}
2970
+ request(api_name, api_spec, params)
2971
+ end
2972
+
2973
+ # transform.preview_transform
2974
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html", "description"=>"Previews a transform."}
2975
+ def transform_preview_transform(params = {})
2976
+ api_name = 'transform.preview_transform'
2977
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html", "description"=>"Previews a transform."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_transform/_preview", "methods"=>["POST"]}]}, "body"=>{"description"=>"The definition for the transform to preview", "required"=>true}}
2978
+ request(api_name, api_spec, params)
2979
+ end
2980
+
2981
+ # transform.put_transform
2982
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html", "description"=>"Instantiates a transform."}
2983
+ def transform_put_transform(params = {})
2984
+ api_name = 'transform.put_transform'
2985
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html", "description"=>"Instantiates a transform."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_transform/{transform_id}", "methods"=>["PUT"], "parts"=>{"transform_id"=>{"type"=>"string", "description"=>"The id of the new transform."}}}]}, "params"=>{"defer_validation"=>{"type"=>"boolean", "required"=>false, "description"=>"If validations should be deferred until transform starts, defaults to false."}}, "body"=>{"description"=>"The transform definition", "required"=>true}}
2986
+ request(api_name, api_spec, params)
2987
+ end
2988
+
2989
+ # transform.start_transform
2990
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html", "description"=>"Starts one or more transforms."}
2991
+ def transform_start_transform(params = {})
2992
+ api_name = 'transform.start_transform'
2993
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html", "description"=>"Starts one or more transforms."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_transform/{transform_id}/_start", "methods"=>["POST"], "parts"=>{"transform_id"=>{"type"=>"string", "description"=>"The id of the transform to start"}}}]}, "params"=>{"timeout"=>{"type"=>"time", "required"=>false, "description"=>"Controls the time to wait for the transform to start"}}}
2994
+ request(api_name, api_spec, params)
2995
+ end
2996
+
2997
+ # transform.stop_transform
2998
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html", "description"=>"Stops one or more transforms."}
2999
+ def transform_stop_transform(params = {})
3000
+ api_name = 'transform.stop_transform'
3001
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html", "description"=>"Stops one or more transforms."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_transform/{transform_id}/_stop", "methods"=>["POST"], "parts"=>{"transform_id"=>{"type"=>"string", "description"=>"The id of the transform to stop"}}}]}, "params"=>{"force"=>{"type"=>"boolean", "required"=>false, "description"=>"Whether to force stop a failed transform or not. Default to false"}, "wait_for_completion"=>{"type"=>"boolean", "required"=>false, "description"=>"Whether to wait for the transform to fully stop before returning or not. Default to false"}, "timeout"=>{"type"=>"time", "required"=>false, "description"=>"Controls the time to wait until the transform has stopped. Default to 30 seconds"}, "allow_no_match"=>{"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)"}, "wait_for_checkpoint"=>{"type"=>"boolean", "required"=>false, "description"=>"Whether to wait for the transform to reach a checkpoint before stopping. Default to false"}}}
3002
+ request(api_name, api_spec, params)
3003
+ end
3004
+
3005
+ # transform.update_transform
3006
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html", "description"=>"Updates certain properties of a transform."}
3007
+ def transform_update_transform(params = {})
3008
+ api_name = 'transform.update_transform'
3009
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html", "description"=>"Updates certain properties of a transform."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_transform/{transform_id}/_update", "methods"=>["POST"], "parts"=>{"transform_id"=>{"type"=>"string", "required"=>true, "description"=>"The id of the transform."}}}]}, "params"=>{"defer_validation"=>{"type"=>"boolean", "required"=>false, "description"=>"If validations should be deferred until transform starts, defaults to false."}}, "body"=>{"description"=>"The update transform definition", "required"=>true}}
3010
+ request(api_name, api_spec, params)
3011
+ end
3012
+
3013
+ # update
3014
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html", "description"=>"Updates a document with a script or partial document."}
3015
+ def update(params = {})
3016
+ api_name = 'update'
3017
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/{index}/_update/{id}", "methods"=>["POST"], "parts"=>{"id"=>{"type"=>"string", "description"=>"Document ID"}, "index"=>{"type"=>"string", "description"=>"The name of the index"}}}, {"path"=>"/{index}/{type}/{id}/_update", "methods"=>["POST"], "parts"=>{"id"=>{"type"=>"string", "description"=>"Document ID"}, "index"=>{"type"=>"string", "description"=>"The name of the index"}, "type"=>{"type"=>"string", "description"=>"The type of the document", "deprecated"=>true}}, "deprecated"=>{"version"=>"7.0.0", "description"=>"Specifying types in urls has been deprecated"}}]}, "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}}
3018
+ request(api_name, api_spec, params)
3019
+ end
3020
+
3021
+ # update_by_query
3022
+ # {"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."}
3023
+ def update_by_query(params = {})
3024
+ api_name = 'update_by_query'
3025
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "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"}}}, {"path"=>"/{index}/{type}/_update_by_query", "methods"=>["POST"], "parts"=>{"index"=>{"required"=>true, "type"=>"list", "description"=>"A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices"}, "type"=>{"type"=>"list", "description"=>"A comma-separated list of document types to search; leave empty to perform the operation on all types"}}, "deprecated"=>{"version"=>"7.0.0", "description"=>"Specifying types in urls has been deprecated"}}]}, "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"}}
3026
+ request(api_name, api_spec, params)
3027
+ end
3028
+
3029
+ # update_by_query_rethrottle
3030
+ # {"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."}
3031
+ def update_by_query_rethrottle(params = {})
3032
+ api_name = 'update_by_query_rethrottle'
3033
+ 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", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "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."}}}
3034
+ request(api_name, api_spec, params)
3035
+ end
3036
+
3037
+ # watcher.ack_watch
3038
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-ack-watch.html", "description"=>"Acknowledges a watch, manually throttling the execution of the watch's actions."}
3039
+ def watcher_ack_watch(params = {})
3040
+ api_name = 'watcher.ack_watch'
3041
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-ack-watch.html", "description"=>"Acknowledges a watch, manually throttling the execution of the watch's actions."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_watcher/watch/{watch_id}/_ack", "methods"=>["PUT", "POST"], "parts"=>{"watch_id"=>{"type"=>"string", "description"=>"Watch ID"}}}, {"path"=>"/_watcher/watch/{watch_id}/_ack/{action_id}", "methods"=>["PUT", "POST"], "parts"=>{"watch_id"=>{"type"=>"string", "description"=>"Watch ID"}, "action_id"=>{"type"=>"list", "description"=>"A comma-separated list of the action ids to be acked"}}}]}}
3042
+ request(api_name, api_spec, params)
3043
+ end
3044
+
3045
+ # watcher.activate_watch
3046
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-activate-watch.html", "description"=>"Activates a currently inactive watch."}
3047
+ def watcher_activate_watch(params = {})
3048
+ api_name = 'watcher.activate_watch'
3049
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-activate-watch.html", "description"=>"Activates a currently inactive watch."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_watcher/watch/{watch_id}/_activate", "methods"=>["PUT", "POST"], "parts"=>{"watch_id"=>{"type"=>"string", "description"=>"Watch ID"}}}]}}
3050
+ request(api_name, api_spec, params)
3051
+ end
3052
+
3053
+ # watcher.deactivate_watch
3054
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-deactivate-watch.html", "description"=>"Deactivates a currently active watch."}
3055
+ def watcher_deactivate_watch(params = {})
3056
+ api_name = 'watcher.deactivate_watch'
3057
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-deactivate-watch.html", "description"=>"Deactivates a currently active watch."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_watcher/watch/{watch_id}/_deactivate", "methods"=>["PUT", "POST"], "parts"=>{"watch_id"=>{"type"=>"string", "description"=>"Watch ID"}}}]}}
3058
+ request(api_name, api_spec, params)
3059
+ end
3060
+
3061
+ # watcher.delete_watch
3062
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-delete-watch.html", "description"=>"Removes a watch from Watcher."}
3063
+ def watcher_delete_watch(params = {})
3064
+ api_name = 'watcher.delete_watch'
3065
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-delete-watch.html", "description"=>"Removes a watch from Watcher."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_watcher/watch/{id}", "methods"=>["DELETE"], "parts"=>{"id"=>{"type"=>"string", "description"=>"Watch ID"}}}]}}
3066
+ request(api_name, api_spec, params)
3067
+ end
3068
+
3069
+ # watcher.execute_watch
3070
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-execute-watch.html", "description"=>"Forces the execution of a stored watch."}
3071
+ def watcher_execute_watch(params = {})
3072
+ api_name = 'watcher.execute_watch'
3073
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-execute-watch.html", "description"=>"Forces the execution of a stored watch."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_watcher/watch/{id}/_execute", "methods"=>["PUT", "POST"], "parts"=>{"id"=>{"type"=>"string", "description"=>"Watch ID"}}}, {"path"=>"/_watcher/watch/_execute", "methods"=>["PUT", "POST"]}]}, "params"=>{"debug"=>{"type"=>"boolean", "description"=>"indicates whether the watch should execute in debug mode", "required"=>false}}, "body"=>{"description"=>"Execution control", "required"=>false}}
3074
+ request(api_name, api_spec, params)
3075
+ end
3076
+
3077
+ # watcher.get_watch
3078
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-get-watch.html", "description"=>"Retrieves a watch by its ID."}
3079
+ def watcher_get_watch(params = {})
3080
+ api_name = 'watcher.get_watch'
3081
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-get-watch.html", "description"=>"Retrieves a watch by its ID."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_watcher/watch/{id}", "methods"=>["GET"], "parts"=>{"id"=>{"type"=>"string", "description"=>"Watch ID"}}}]}, "params"=>{}}
3082
+ request(api_name, api_spec, params)
3083
+ end
3084
+
3085
+ # watcher.put_watch
3086
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-put-watch.html", "description"=>"Creates a new watch, or updates an existing one."}
3087
+ def watcher_put_watch(params = {})
3088
+ api_name = 'watcher.put_watch'
3089
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-put-watch.html", "description"=>"Creates a new watch, or updates an existing one."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_watcher/watch/{id}", "methods"=>["PUT", "POST"], "parts"=>{"id"=>{"type"=>"string", "description"=>"Watch ID"}}}]}, "params"=>{"active"=>{"type"=>"boolean", "description"=>"Specify whether the watch is in/active by default"}, "version"=>{"type"=>"number", "description"=>"Explicit version number for concurrency control"}, "if_seq_no"=>{"type"=>"number", "description"=>"only update the watch if the last operation that has changed the watch has the specified sequence number"}, "if_primary_term"=>{"type"=>"number", "description"=>"only update the watch if the last operation that has changed the watch has the specified primary term"}}, "body"=>{"description"=>"The watch", "required"=>false}}
3090
+ request(api_name, api_spec, params)
3091
+ end
3092
+
3093
+ # watcher.query_watches
3094
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-query-watches.html", "description"=>"Retrieves stored watches."}
3095
+ def watcher_query_watches(params = {})
3096
+ api_name = 'watcher.query_watches'
3097
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-query-watches.html", "description"=>"Retrieves stored watches."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"], "content_type"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_watcher/_query/watches", "methods"=>["GET", "POST"]}]}, "params"=>{}, "body"=>{"description"=>"From, size, query, sort and search_after", "required"=>false}}
3098
+ request(api_name, api_spec, params)
3099
+ end
3100
+
3101
+ # watcher.start
3102
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-start.html", "description"=>"Starts Watcher if it is not already running."}
3103
+ def watcher_start(params = {})
3104
+ api_name = 'watcher.start'
3105
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-start.html", "description"=>"Starts Watcher if it is not already running."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_watcher/_start", "methods"=>["POST"]}]}, "params"=>{}}
3106
+ request(api_name, api_spec, params)
3107
+ end
3108
+
3109
+ # watcher.stats
3110
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stats.html", "description"=>"Retrieves the current Watcher metrics."}
3111
+ def watcher_stats(params = {})
3112
+ api_name = 'watcher.stats'
3113
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stats.html", "description"=>"Retrieves the current Watcher metrics."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_watcher/stats", "methods"=>["GET"]}, {"path"=>"/_watcher/stats/{metric}", "methods"=>["GET"], "parts"=>{"metric"=>{"type"=>"list", "options"=>["_all", "queued_watches", "current_watches", "pending_watches"], "description"=>"Controls what additional stat metrics should be include in the response"}}}]}, "params"=>{"metric"=>{"type"=>"list", "options"=>["_all", "queued_watches", "current_watches", "pending_watches"], "description"=>"Controls what additional stat metrics should be include in the response"}, "emit_stacktraces"=>{"type"=>"boolean", "description"=>"Emits stack traces of currently running watches", "required"=>false}}}
3114
+ request(api_name, api_spec, params)
3115
+ end
3116
+
3117
+ # watcher.stop
3118
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stop.html", "description"=>"Stops Watcher if it is running."}
3119
+ def watcher_stop(params = {})
3120
+ api_name = 'watcher.stop'
3121
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stop.html", "description"=>"Stops Watcher if it is running."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_watcher/_stop", "methods"=>["POST"]}]}, "params"=>{}}
3122
+ request(api_name, api_spec, params)
3123
+ end
3124
+
3125
+ # xpack.info
3126
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/info-api.html", "description"=>"Retrieves information about the installed X-Pack features."}
3127
+ def xpack_info(params = {})
3128
+ api_name = 'xpack.info'
3129
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/info-api.html", "description"=>"Retrieves information about the installed X-Pack features."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_xpack", "methods"=>["GET"]}]}, "params"=>{"categories"=>{"type"=>"list", "description"=>"Comma-separated list of info categories. Can be any of: build, license, features"}, "accept_enterprise"=>{"type"=>"boolean", "description"=>"If an enterprise license is installed, return the type and mode as 'enterprise' (default: false)"}}}
3130
+ request(api_name, api_spec, params)
3131
+ end
3132
+
3133
+ # xpack.usage
3134
+ # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/usage-api.html", "description"=>"Retrieves usage information about the installed X-Pack features."}
3135
+ def xpack_usage(params = {})
3136
+ api_name = 'xpack.usage'
3137
+ api_spec = @api_specs[api_name] ||= {"documentation"=>{"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/usage-api.html", "description"=>"Retrieves usage information about the installed X-Pack features."}, "stability"=>"stable", "visibility"=>"public", "headers"=>{"accept"=>["application/json"]}, "url"=>{"paths"=>[{"path"=>"/_xpack/usage", "methods"=>["GET"]}]}, "params"=>{"master_timeout"=>{"type"=>"time", "description"=>"Specify timeout for watch write operation"}}}
3138
+ request(api_name, api_spec, params)
3139
+ end
3140
+ end
3141
+ end
3142
+ end