antbird 0.15.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (61) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/build-os.yml +6 -27
  3. data/.gitignore +2 -2
  4. data/Gemfile.lock +66 -0
  5. data/README.md +72 -15
  6. data/antbird.gemspec +3 -4
  7. data/lib/antbird/client.rb +113 -61
  8. data/lib/antbird/rest_api/rest_api_opensearch_v3_0.rb +492 -328
  9. data/lib/antbird/rest_api/rest_api_opensearch_v3_1.rb +495 -330
  10. data/lib/antbird/rest_api/rest_api_opensearch_v3_2.rb +495 -330
  11. data/lib/antbird/rest_api/rest_api_opensearch_v3_3.rb +495 -330
  12. data/lib/antbird/rest_api/rest_api_opensearch_v3_4.rb +1505 -0
  13. data/lib/antbird/rest_api/rest_api_opensearch_v3_5.rb +1505 -0
  14. data/lib/antbird/version.rb +1 -1
  15. metadata +8 -71
  16. data/.github/workflows/build.yml +0 -45
  17. data/lib/antbird/rest_api/rest_api_opensearch_v1_0.rb +0 -1221
  18. data/lib/antbird/rest_api/rest_api_opensearch_v1_1.rb +0 -1221
  19. data/lib/antbird/rest_api/rest_api_opensearch_v1_2.rb +0 -1221
  20. data/lib/antbird/rest_api/rest_api_opensearch_v1_3.rb +0 -1221
  21. data/lib/antbird/rest_api/rest_api_opensearch_v2_0.rb +0 -1204
  22. data/lib/antbird/rest_api/rest_api_opensearch_v2_1.rb +0 -1204
  23. data/lib/antbird/rest_api/rest_api_opensearch_v2_10.rb +0 -1332
  24. data/lib/antbird/rest_api/rest_api_opensearch_v2_11.rb +0 -1332
  25. data/lib/antbird/rest_api/rest_api_opensearch_v2_12.rb +0 -1332
  26. data/lib/antbird/rest_api/rest_api_opensearch_v2_13.rb +0 -1332
  27. data/lib/antbird/rest_api/rest_api_opensearch_v2_14.rb +0 -1332
  28. data/lib/antbird/rest_api/rest_api_opensearch_v2_15.rb +0 -1332
  29. data/lib/antbird/rest_api/rest_api_opensearch_v2_16.rb +0 -1332
  30. data/lib/antbird/rest_api/rest_api_opensearch_v2_17.rb +0 -1332
  31. data/lib/antbird/rest_api/rest_api_opensearch_v2_18.rb +0 -1332
  32. data/lib/antbird/rest_api/rest_api_opensearch_v2_19.rb +0 -1332
  33. data/lib/antbird/rest_api/rest_api_opensearch_v2_2.rb +0 -1204
  34. data/lib/antbird/rest_api/rest_api_opensearch_v2_3.rb +0 -1212
  35. data/lib/antbird/rest_api/rest_api_opensearch_v2_4.rb +0 -1292
  36. data/lib/antbird/rest_api/rest_api_opensearch_v2_5.rb +0 -1292
  37. data/lib/antbird/rest_api/rest_api_opensearch_v2_6.rb +0 -1300
  38. data/lib/antbird/rest_api/rest_api_opensearch_v2_7.rb +0 -1324
  39. data/lib/antbird/rest_api/rest_api_opensearch_v2_8.rb +0 -1332
  40. data/lib/antbird/rest_api/rest_api_opensearch_v2_9.rb +0 -1332
  41. data/lib/antbird/rest_api/rest_api_v6_4.rb +0 -996
  42. data/lib/antbird/rest_api/rest_api_v6_5.rb +0 -1012
  43. data/lib/antbird/rest_api/rest_api_v6_6.rb +0 -1012
  44. data/lib/antbird/rest_api/rest_api_v6_7.rb +0 -1012
  45. data/lib/antbird/rest_api/rest_api_v6_8.rb +0 -1011
  46. data/lib/antbird/rest_api/rest_api_v7_0.rb +0 -1012
  47. data/lib/antbird/rest_api/rest_api_v7_1.rb +0 -1012
  48. data/lib/antbird/rest_api/rest_api_v7_10.rb +0 -1189
  49. data/lib/antbird/rest_api/rest_api_v7_11.rb +0 -1189
  50. data/lib/antbird/rest_api/rest_api_v7_12.rb +0 -1197
  51. data/lib/antbird/rest_api/rest_api_v7_13.rb +0 -3045
  52. data/lib/antbird/rest_api/rest_api_v7_14.rb +0 -3141
  53. data/lib/antbird/rest_api/rest_api_v7_15.rb +0 -3189
  54. data/lib/antbird/rest_api/rest_api_v7_2.rb +0 -1020
  55. data/lib/antbird/rest_api/rest_api_v7_3.rb +0 -1012
  56. data/lib/antbird/rest_api/rest_api_v7_4.rb +0 -1028
  57. data/lib/antbird/rest_api/rest_api_v7_5.rb +0 -1028
  58. data/lib/antbird/rest_api/rest_api_v7_6.rb +0 -1044
  59. data/lib/antbird/rest_api/rest_api_v7_7.rb +0 -1092
  60. data/lib/antbird/rest_api/rest_api_v7_8.rb +0 -1157
  61. data/lib/antbird/rest_api/rest_api_v7_9.rb +0 -1181
@@ -1,3141 +0,0 @@
1
- # Generated REST API methods file - DO NOT EDIT!
2
- # elasticsearch version: 7.14.2
3
-
4
- module Antbird
5
- module RestApi
6
- module RestApiV7_14
7
- def common_params
8
- @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."}}}
9
- end
10
-
11
- # async_search.delete
12
- # {"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."}
13
- def async_search_delete(params = {})
14
- api_name = 'async_search.delete'
15
- 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"}}}]}}
16
- request(api_name, api_spec, params)
17
- end
18
-
19
- # async_search.get
20
- # {"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."}
21
- def async_search_get(params = {})
22
- api_name = 'async_search.get'
23
- 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"}}}
24
- request(api_name, api_spec, params)
25
- end
26
-
27
- # async_search.status
28
- # {"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."}
29
- def async_search_status(params = {})
30
- api_name = 'async_search.status'
31
- 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"}}}]}}
32
- request(api_name, api_spec, params)
33
- end
34
-
35
- # async_search.submit
36
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html", "description"=>"Executes a search request asynchronously."}
37
- def async_search_submit(params = {})
38
- api_name = 'async_search.submit'
39
- 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"}}
40
- request(api_name, api_spec, params)
41
- end
42
-
43
- # autoscaling.delete_autoscaling_policy
44
- # {"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."}
45
- def autoscaling_delete_autoscaling_policy(params = {})
46
- api_name = 'autoscaling.delete_autoscaling_policy'
47
- 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"}}}]}}
48
- request(api_name, api_spec, params)
49
- end
50
-
51
- # autoscaling.get_autoscaling_capacity
52
- # {"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."}
53
- def autoscaling_get_autoscaling_capacity(params = {})
54
- api_name = 'autoscaling.get_autoscaling_capacity'
55
- 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"]}]}}
56
- request(api_name, api_spec, params)
57
- end
58
-
59
- # autoscaling.get_autoscaling_policy
60
- # {"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."}
61
- def autoscaling_get_autoscaling_policy(params = {})
62
- api_name = 'autoscaling.get_autoscaling_policy'
63
- 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"}}}]}}
64
- request(api_name, api_spec, params)
65
- end
66
-
67
- # autoscaling.put_autoscaling_policy
68
- # {"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."}
69
- def autoscaling_put_autoscaling_policy(params = {})
70
- api_name = 'autoscaling.put_autoscaling_policy'
71
- 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}}
72
- request(api_name, api_spec, params)
73
- end
74
-
75
- # bulk
76
- # {"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."}
77
- def bulk(params = {})
78
- api_name = 'bulk'
79
- 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"}}
80
- request(api_name, api_spec, params)
81
- end
82
-
83
- # cat.aliases
84
- # {"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."}
85
- def cat_aliases(params = {})
86
- api_name = 'cat.aliases'
87
- 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."}}}
88
- request(api_name, api_spec, params)
89
- end
90
-
91
- # cat.allocation
92
- # {"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."}
93
- def cat_allocation(params = {})
94
- api_name = 'cat.allocation'
95
- 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}}}
96
- request(api_name, api_spec, params)
97
- end
98
-
99
- # cat.count
100
- # {"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."}
101
- def cat_count(params = {})
102
- api_name = 'cat.count'
103
- 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}}}
104
- request(api_name, api_spec, params)
105
- end
106
-
107
- # cat.fielddata
108
- # {"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."}
109
- def cat_fielddata(params = {})
110
- api_name = 'cat.fielddata'
111
- 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"}}}
112
- request(api_name, api_spec, params)
113
- end
114
-
115
- # cat.health
116
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-health.html", "description"=>"Returns a concise representation of the cluster health."}
117
- def cat_health(params = {})
118
- api_name = 'cat.health'
119
- 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}}}
120
- request(api_name, api_spec, params)
121
- end
122
-
123
- # cat.help
124
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html", "description"=>"Returns help for the Cat APIs."}
125
- def cat_help(params = {})
126
- api_name = 'cat.help'
127
- 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"}}}
128
- request(api_name, api_spec, params)
129
- end
130
-
131
- # cat.indices
132
- # {"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, ..."}
133
- def cat_indices(params = {})
134
- api_name = 'cat.indices'
135
- 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."}}}
136
- request(api_name, api_spec, params)
137
- end
138
-
139
- # cat.master
140
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-master.html", "description"=>"Returns information about the master node."}
141
- def cat_master(params = {})
142
- api_name = 'cat.master'
143
- 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}}}
144
- request(api_name, api_spec, params)
145
- end
146
-
147
- # cat.ml_data_frame_analytics
148
- # {"url"=>"http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-dfanalytics.html", "description"=>"Gets configuration and usage information about data frame analytics jobs."}
149
- def cat_ml_data_frame_analytics(params = {})
150
- api_name = 'cat.ml_data_frame_analytics'
151
- 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}}}
152
- request(api_name, api_spec, params)
153
- end
154
-
155
- # cat.ml_datafeeds
156
- # {"url"=>"http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html", "description"=>"Gets configuration and usage information about datafeeds."}
157
- def cat_ml_datafeeds(params = {})
158
- api_name = 'cat.ml_datafeeds'
159
- 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}}}
160
- request(api_name, api_spec, params)
161
- end
162
-
163
- # cat.ml_jobs
164
- # {"url"=>"http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-anomaly-detectors.html", "description"=>"Gets configuration and usage information about anomaly detection jobs."}
165
- def cat_ml_jobs(params = {})
166
- api_name = 'cat.ml_jobs'
167
- 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}}}
168
- request(api_name, api_spec, params)
169
- end
170
-
171
- # cat.ml_trained_models
172
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-trained-model.html", "description"=>"Gets configuration and usage information about inference trained models."}
173
- def cat_ml_trained_models(params = {})
174
- api_name = 'cat.ml_trained_models'
175
- 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}}}
176
- request(api_name, api_spec, params)
177
- end
178
-
179
- # cat.nodeattrs
180
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodeattrs.html", "description"=>"Returns information about custom node attributes."}
181
- def cat_nodeattrs(params = {})
182
- api_name = 'cat.nodeattrs'
183
- 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}}}
184
- request(api_name, api_spec, params)
185
- end
186
-
187
- # cat.nodes
188
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html", "description"=>"Returns basic statistics about performance of cluster nodes."}
189
- def cat_nodes(params = {})
190
- api_name = 'cat.nodes'
191
- 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}}}
192
- request(api_name, api_spec, params)
193
- end
194
-
195
- # cat.pending_tasks
196
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-pending-tasks.html", "description"=>"Returns a concise representation of the cluster pending tasks."}
197
- def cat_pending_tasks(params = {})
198
- api_name = 'cat.pending_tasks'
199
- 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}}}
200
- request(api_name, api_spec, params)
201
- end
202
-
203
- # cat.plugins
204
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html", "description"=>"Returns information about installed plugins across nodes node."}
205
- def cat_plugins(params = {})
206
- api_name = 'cat.plugins'
207
- 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}}}
208
- request(api_name, api_spec, params)
209
- end
210
-
211
- # cat.recovery
212
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html", "description"=>"Returns information about index shard recoveries, both on-going completed."}
213
- def cat_recovery(params = {})
214
- api_name = 'cat.recovery'
215
- 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}}}
216
- request(api_name, api_spec, params)
217
- end
218
-
219
- # cat.repositories
220
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-repositories.html", "description"=>"Returns information about snapshot repositories registered in the cluster."}
221
- def cat_repositories(params = {})
222
- api_name = 'cat.repositories'
223
- 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}}}
224
- request(api_name, api_spec, params)
225
- end
226
-
227
- # cat.segments
228
- # {"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."}
229
- def cat_segments(params = {})
230
- api_name = 'cat.segments'
231
- 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}}}
232
- request(api_name, api_spec, params)
233
- end
234
-
235
- # cat.shards
236
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html", "description"=>"Provides a detailed view of shard allocation on nodes."}
237
- def cat_shards(params = {})
238
- api_name = 'cat.shards'
239
- 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}}}
240
- request(api_name, api_spec, params)
241
- end
242
-
243
- # cat.snapshots
244
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-snapshots.html", "description"=>"Returns all snapshots in a specific repository."}
245
- def cat_snapshots(params = {})
246
- api_name = 'cat.snapshots'
247
- 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}}}
248
- request(api_name, api_spec, params)
249
- end
250
-
251
- # cat.tasks
252
- # {"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."}
253
- def cat_tasks(params = {})
254
- api_name = 'cat.tasks'
255
- 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}}}
256
- request(api_name, api_spec, params)
257
- end
258
-
259
- # cat.templates
260
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-templates.html", "description"=>"Returns information about existing templates."}
261
- def cat_templates(params = {})
262
- api_name = 'cat.templates'
263
- 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}}}
264
- request(api_name, api_spec, params)
265
- end
266
-
267
- # cat.thread_pool
268
- # {"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."}
269
- def cat_thread_pool(params = {})
270
- api_name = 'cat.thread_pool'
271
- 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}}}
272
- request(api_name, api_spec, params)
273
- end
274
-
275
- # cat.transforms
276
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-transforms.html", "description"=>"Gets configuration and usage information about transforms."}
277
- def cat_transforms(params = {})
278
- api_name = 'cat.transforms'
279
- 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}}}
280
- request(api_name, api_spec, params)
281
- end
282
-
283
- # ccr.delete_auto_follow_pattern
284
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-delete-auto-follow-pattern.html", "description"=>"Deletes auto-follow patterns."}
285
- def ccr_delete_auto_follow_pattern(params = {})
286
- api_name = 'ccr.delete_auto_follow_pattern'
287
- 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."}}}]}}
288
- request(api_name, api_spec, params)
289
- end
290
-
291
- # ccr.follow
292
- # {"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."}
293
- def ccr_follow(params = {})
294
- api_name = 'ccr.follow'
295
- 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}}
296
- request(api_name, api_spec, params)
297
- end
298
-
299
- # ccr.follow_info
300
- # {"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"}
301
- def ccr_follow_info(params = {})
302
- api_name = 'ccr.follow_info'
303
- 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"}}}]}}
304
- request(api_name, api_spec, params)
305
- end
306
-
307
- # ccr.follow_stats
308
- # {"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."}
309
- def ccr_follow_stats(params = {})
310
- api_name = 'ccr.follow_stats'
311
- 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"}}}]}}
312
- request(api_name, api_spec, params)
313
- end
314
-
315
- # ccr.forget_follower
316
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-forget-follower.html", "description"=>"Removes the follower retention leases from the leader."}
317
- def ccr_forget_follower(params = {})
318
- api_name = 'ccr.forget_follower'
319
- 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}}
320
- request(api_name, api_spec, params)
321
- end
322
-
323
- # ccr.get_auto_follow_pattern
324
- # {"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."}
325
- def ccr_get_auto_follow_pattern(params = {})
326
- api_name = 'ccr.get_auto_follow_pattern'
327
- 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."}}}]}}
328
- request(api_name, api_spec, params)
329
- end
330
-
331
- # ccr.pause_auto_follow_pattern
332
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-pause-auto-follow-pattern.html", "description"=>"Pauses an auto-follow pattern"}
333
- def ccr_pause_auto_follow_pattern(params = {})
334
- api_name = 'ccr.pause_auto_follow_pattern'
335
- 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."}}}]}}
336
- request(api_name, api_spec, params)
337
- end
338
-
339
- # ccr.pause_follow
340
- # {"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."}
341
- def ccr_pause_follow(params = {})
342
- api_name = 'ccr.pause_follow'
343
- 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."}}}]}}
344
- request(api_name, api_spec, params)
345
- end
346
-
347
- # ccr.put_auto_follow_pattern
348
- # {"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."}
349
- def ccr_put_auto_follow_pattern(params = {})
350
- api_name = 'ccr.put_auto_follow_pattern'
351
- 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}}
352
- request(api_name, api_spec, params)
353
- end
354
-
355
- # ccr.resume_auto_follow_pattern
356
- # {"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"}
357
- def ccr_resume_auto_follow_pattern(params = {})
358
- api_name = 'ccr.resume_auto_follow_pattern'
359
- 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."}}}]}}
360
- request(api_name, api_spec, params)
361
- end
362
-
363
- # ccr.resume_follow
364
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-resume-follow.html", "description"=>"Resumes a follower index that has been paused"}
365
- def ccr_resume_follow(params = {})
366
- api_name = 'ccr.resume_follow'
367
- 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}}
368
- request(api_name, api_spec, params)
369
- end
370
-
371
- # ccr.stats
372
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-stats.html", "description"=>"Gets all stats related to cross-cluster replication."}
373
- def ccr_stats(params = {})
374
- api_name = 'ccr.stats'
375
- 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"]}]}}
376
- request(api_name, api_spec, params)
377
- end
378
-
379
- # ccr.unfollow
380
- # {"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."}
381
- def ccr_unfollow(params = {})
382
- api_name = 'ccr.unfollow'
383
- 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."}}}]}}
384
- request(api_name, api_spec, params)
385
- end
386
-
387
- # clear_scroll
388
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-scroll-api.html", "description"=>"Explicitly clears the search context for a scroll."}
389
- def clear_scroll(params = {})
390
- api_name = 'clear_scroll'
391
- 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"}}
392
- request(api_name, api_spec, params)
393
- end
394
-
395
- # close_point_in_time
396
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/point-in-time-api.html", "description"=>"Close a point in time"}
397
- def close_point_in_time(params = {})
398
- api_name = 'close_point_in_time'
399
- 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"}}
400
- request(api_name, api_spec, params)
401
- end
402
-
403
- # cluster.allocation_explain
404
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-allocation-explain.html", "description"=>"Provides explanations for shard allocations in the cluster."}
405
- def cluster_allocation_explain(params = {})
406
- api_name = 'cluster.allocation_explain'
407
- 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'"}}
408
- request(api_name, api_spec, params)
409
- end
410
-
411
- # cluster.delete_component_template
412
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html", "description"=>"Deletes a component template"}
413
- def cluster_delete_component_template(params = {})
414
- api_name = 'cluster.delete_component_template'
415
- 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"}}}
416
- request(api_name, api_spec, params)
417
- end
418
-
419
- # cluster.delete_voting_config_exclusions
420
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/voting-config-exclusions.html", "description"=>"Clears cluster voting config exclusions."}
421
- def cluster_delete_voting_config_exclusions(params = {})
422
- api_name = 'cluster.delete_voting_config_exclusions'
423
- 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}}}
424
- request(api_name, api_spec, params)
425
- end
426
-
427
- # cluster.exists_component_template
428
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html", "description"=>"Returns information about whether a particular component template exist"}
429
- def cluster_exists_component_template(params = {})
430
- api_name = 'cluster.exists_component_template'
431
- 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)"}}}
432
- request(api_name, api_spec, params)
433
- end
434
- alias :cluster_exists_component_template? :cluster_exists_component_template
435
-
436
- # cluster.get_component_template
437
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html", "description"=>"Returns one or more component templates"}
438
- def cluster_get_component_template(params = {})
439
- api_name = 'cluster.get_component_template'
440
- 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)"}}}
441
- request(api_name, api_spec, params)
442
- end
443
-
444
- # cluster.get_settings
445
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-get-settings.html", "description"=>"Returns cluster settings."}
446
- def cluster_get_settings(params = {})
447
- api_name = 'cluster.get_settings'
448
- 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}}}
449
- request(api_name, api_spec, params)
450
- end
451
-
452
- # cluster.health
453
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-health.html", "description"=>"Returns basic information about the health of the cluster."}
454
- def cluster_health(params = {})
455
- api_name = 'cluster.health'
456
- 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"}}}
457
- request(api_name, api_spec, params)
458
- end
459
-
460
- # cluster.pending_tasks
461
- # {"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."}
462
- def cluster_pending_tasks(params = {})
463
- api_name = 'cluster.pending_tasks'
464
- 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"}}}
465
- request(api_name, api_spec, params)
466
- end
467
-
468
- # cluster.post_voting_config_exclusions
469
- # {"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."}
470
- def cluster_post_voting_config_exclusions(params = {})
471
- api_name = 'cluster.post_voting_config_exclusions'
472
- 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"}}}
473
- request(api_name, api_spec, params)
474
- end
475
-
476
- # cluster.put_component_template
477
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html", "description"=>"Creates or updates a component template"}
478
- def cluster_put_component_template(params = {})
479
- api_name = 'cluster.put_component_template'
480
- 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}}
481
- request(api_name, api_spec, params)
482
- end
483
-
484
- # cluster.put_settings
485
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html", "description"=>"Updates the cluster settings."}
486
- def cluster_put_settings(params = {})
487
- api_name = 'cluster.put_settings'
488
- 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}}
489
- request(api_name, api_spec, params)
490
- end
491
-
492
- # cluster.remote_info
493
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-remote-info.html", "description"=>"Returns the information about configured remote clusters."}
494
- def cluster_remote_info(params = {})
495
- api_name = 'cluster.remote_info'
496
- 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"=>{}}
497
- request(api_name, api_spec, params)
498
- end
499
-
500
- # cluster.reroute
501
- # {"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."}
502
- def cluster_reroute(params = {})
503
- api_name = 'cluster.reroute'
504
- 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`)"}}
505
- request(api_name, api_spec, params)
506
- end
507
-
508
- # cluster.state
509
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-state.html", "description"=>"Returns a comprehensive information about the state of the cluster."}
510
- def cluster_state(params = {})
511
- api_name = 'cluster.state'
512
- 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."}}}
513
- request(api_name, api_spec, params)
514
- end
515
-
516
- # cluster.stats
517
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-stats.html", "description"=>"Returns high-level overview of cluster statistics."}
518
- def cluster_stats(params = {})
519
- api_name = 'cluster.stats'
520
- 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"}}}
521
- request(api_name, api_spec, params)
522
- end
523
-
524
- # count
525
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html", "description"=>"Returns number of documents matching a query."}
526
- def count(params = {})
527
- api_name = 'count'
528
- 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)"}}
529
- request(api_name, api_spec, params)
530
- end
531
-
532
- # create
533
- # {"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."}
534
- def create(params = {})
535
- api_name = 'create'
536
- 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}}
537
- request(api_name, api_spec, params)
538
- end
539
-
540
- # dangling_indices.delete_dangling_index
541
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html", "description"=>"Deletes the specified dangling index"}
542
- def dangling_indices_delete_dangling_index(params = {})
543
- api_name = 'dangling_indices.delete_dangling_index'
544
- 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"}}}
545
- request(api_name, api_spec, params)
546
- end
547
-
548
- # dangling_indices.import_dangling_index
549
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html", "description"=>"Imports the specified dangling index"}
550
- def dangling_indices_import_dangling_index(params = {})
551
- api_name = 'dangling_indices.import_dangling_index'
552
- 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"}}}
553
- request(api_name, api_spec, params)
554
- end
555
-
556
- # dangling_indices.list_dangling_indices
557
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html", "description"=>"Returns all dangling indices."}
558
- def dangling_indices_list_dangling_indices(params = {})
559
- api_name = 'dangling_indices.list_dangling_indices'
560
- 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"=>{}}
561
- request(api_name, api_spec, params)
562
- end
563
-
564
- # data_frame_transform_deprecated.delete_transform
565
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html", "description"=>"Deletes an existing transform."}
566
- def data_frame_transform_deprecated_delete_transform(params = {})
567
- api_name = 'data_frame_transform_deprecated.delete_transform'
568
- 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."}}}
569
- request(api_name, api_spec, params)
570
- end
571
-
572
- # data_frame_transform_deprecated.get_transform
573
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html", "description"=>"Retrieves configuration information for transforms."}
574
- def data_frame_transform_deprecated_get_transform(params = {})
575
- api_name = 'data_frame_transform_deprecated.get_transform'
576
- 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"}}}
577
- request(api_name, api_spec, params)
578
- end
579
-
580
- # data_frame_transform_deprecated.get_transform_stats
581
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-stats.html", "description"=>"Retrieves usage information for transforms."}
582
- def data_frame_transform_deprecated_get_transform_stats(params = {})
583
- api_name = 'data_frame_transform_deprecated.get_transform_stats'
584
- 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)"}}}
585
- request(api_name, api_spec, params)
586
- end
587
-
588
- # data_frame_transform_deprecated.preview_transform
589
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html", "description"=>"Previews a transform."}
590
- def data_frame_transform_deprecated_preview_transform(params = {})
591
- api_name = 'data_frame_transform_deprecated.preview_transform'
592
- 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}}
593
- request(api_name, api_spec, params)
594
- end
595
-
596
- # data_frame_transform_deprecated.put_transform
597
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html", "description"=>"Instantiates a transform."}
598
- def data_frame_transform_deprecated_put_transform(params = {})
599
- api_name = 'data_frame_transform_deprecated.put_transform'
600
- 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}}
601
- request(api_name, api_spec, params)
602
- end
603
-
604
- # data_frame_transform_deprecated.start_transform
605
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html", "description"=>"Starts one or more transforms."}
606
- def data_frame_transform_deprecated_start_transform(params = {})
607
- api_name = 'data_frame_transform_deprecated.start_transform'
608
- 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"}}}
609
- request(api_name, api_spec, params)
610
- end
611
-
612
- # data_frame_transform_deprecated.stop_transform
613
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html", "description"=>"Stops one or more transforms."}
614
- def data_frame_transform_deprecated_stop_transform(params = {})
615
- api_name = 'data_frame_transform_deprecated.stop_transform'
616
- 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)"}}}
617
- request(api_name, api_spec, params)
618
- end
619
-
620
- # data_frame_transform_deprecated.update_transform
621
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html", "description"=>"Updates certain properties of a transform."}
622
- def data_frame_transform_deprecated_update_transform(params = {})
623
- api_name = 'data_frame_transform_deprecated.update_transform'
624
- 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}}
625
- request(api_name, api_spec, params)
626
- end
627
-
628
- # delete
629
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html", "description"=>"Removes a document from the index."}
630
- def delete(params = {})
631
- api_name = 'delete'
632
- 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"}}}
633
- request(api_name, api_spec, params)
634
- end
635
-
636
- # delete_by_query
637
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html", "description"=>"Deletes documents matching the provided query."}
638
- def delete_by_query(params = {})
639
- api_name = 'delete_by_query'
640
- 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}}
641
- request(api_name, api_spec, params)
642
- end
643
-
644
- # delete_by_query_rethrottle
645
- # {"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."}
646
- def delete_by_query_rethrottle(params = {})
647
- api_name = 'delete_by_query_rethrottle'
648
- 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."}}}
649
- request(api_name, api_spec, params)
650
- end
651
-
652
- # delete_script
653
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", "description"=>"Deletes a script."}
654
- def delete_script(params = {})
655
- api_name = 'delete_script'
656
- 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"}}}
657
- request(api_name, api_spec, params)
658
- end
659
-
660
- # enrich.delete_policy
661
- # {"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."}
662
- def enrich_delete_policy(params = {})
663
- api_name = 'enrich.delete_policy'
664
- 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"}}}]}}
665
- request(api_name, api_spec, params)
666
- end
667
-
668
- # enrich.execute_policy
669
- # {"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."}
670
- def enrich_execute_policy(params = {})
671
- api_name = 'enrich.execute_policy'
672
- 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."}}}
673
- request(api_name, api_spec, params)
674
- end
675
-
676
- # enrich.get_policy
677
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html", "description"=>"Gets information about an enrich policy."}
678
- def enrich_get_policy(params = {})
679
- api_name = 'enrich.get_policy'
680
- 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"]}]}}
681
- request(api_name, api_spec, params)
682
- end
683
-
684
- # enrich.put_policy
685
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/put-enrich-policy-api.html", "description"=>"Creates a new enrich policy."}
686
- def enrich_put_policy(params = {})
687
- api_name = 'enrich.put_policy'
688
- 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}}
689
- request(api_name, api_spec, params)
690
- end
691
-
692
- # enrich.stats
693
- # {"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."}
694
- def enrich_stats(params = {})
695
- api_name = 'enrich.stats'
696
- 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"]}]}}
697
- request(api_name, api_spec, params)
698
- end
699
-
700
- # eql.delete
701
- # {"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."}
702
- def eql_delete(params = {})
703
- api_name = 'eql.delete'
704
- 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"}}}]}}
705
- request(api_name, api_spec, params)
706
- end
707
-
708
- # eql.get
709
- # {"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"}
710
- def eql_get(params = {})
711
- api_name = 'eql.get'
712
- 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"}}}
713
- request(api_name, api_spec, params)
714
- end
715
-
716
- # eql.get_status
717
- # {"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"}
718
- def eql_get_status(params = {})
719
- api_name = 'eql.get_status'
720
- 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"}}}]}}
721
- request(api_name, api_spec, params)
722
- end
723
-
724
- # eql.search
725
- # {"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)"}
726
- def eql_search(params = {})
727
- api_name = 'eql.search'
728
- 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}}
729
- request(api_name, api_spec, params)
730
- end
731
-
732
- # exists
733
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", "description"=>"Returns information about whether a document exists in an index."}
734
- def exists(params = {})
735
- api_name = 'exists'
736
- 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"}}}
737
- request(api_name, api_spec, params)
738
- end
739
- alias :exists? :exists
740
-
741
- # exists_source
742
- # {"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."}
743
- def exists_source(params = {})
744
- api_name = 'exists_source'
745
- 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"}}}
746
- request(api_name, api_spec, params)
747
- end
748
- alias :exists_source? :exists_source
749
-
750
- # explain
751
- # {"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."}
752
- def explain(params = {})
753
- api_name = 'explain'
754
- 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"}}
755
- request(api_name, api_spec, params)
756
- end
757
-
758
- # features.get_features
759
- # {"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"}
760
- def features_get_features(params = {})
761
- api_name = 'features.get_features'
762
- 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"}}}
763
- request(api_name, api_spec, params)
764
- end
765
-
766
- # features.reset_features
767
- # {"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"}
768
- def features_reset_features(params = {})
769
- api_name = 'features.reset_features'
770
- 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"]}]}}
771
- request(api_name, api_spec, params)
772
- end
773
-
774
- # field_caps
775
- # {"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."}
776
- def field_caps(params = {})
777
- api_name = 'field_caps'
778
- 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"}}
779
- request(api_name, api_spec, params)
780
- end
781
-
782
- # fleet.global_checkpoints
783
- # {"url"=>nil, "description"=>"Returns the current global checkpoints for an index. This API is design for internal use by the fleet server project."}
784
- def fleet_global_checkpoints(params = {})
785
- api_name = 'fleet.global_checkpoints'
786
- 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"}}}
787
- request(api_name, api_spec, params)
788
- end
789
-
790
- # get
791
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", "description"=>"Returns a document."}
792
- def get(params = {})
793
- api_name = 'get'
794
- 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"}}}
795
- request(api_name, api_spec, params)
796
- end
797
-
798
- # get_script
799
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", "description"=>"Returns a script."}
800
- def get_script(params = {})
801
- api_name = 'get_script'
802
- 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"}}}
803
- request(api_name, api_spec, params)
804
- end
805
-
806
- # get_script_context
807
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-contexts.html", "description"=>"Returns all script contexts."}
808
- def get_script_context(params = {})
809
- api_name = 'get_script_context'
810
- 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"=>{}}
811
- request(api_name, api_spec, params)
812
- end
813
-
814
- # get_script_languages
815
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", "description"=>"Returns available script types, languages and contexts"}
816
- def get_script_languages(params = {})
817
- api_name = 'get_script_languages'
818
- 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"=>{}}
819
- request(api_name, api_spec, params)
820
- end
821
-
822
- # get_source
823
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", "description"=>"Returns the source of a document."}
824
- def get_source(params = {})
825
- api_name = 'get_source'
826
- 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"}}}
827
- request(api_name, api_spec, params)
828
- end
829
-
830
- # graph.explore
831
- # {"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."}
832
- def graph_explore(params = {})
833
- api_name = 'graph.explore'
834
- 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"}}
835
- request(api_name, api_spec, params)
836
- end
837
-
838
- # ilm.delete_lifecycle
839
- # {"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."}
840
- def ilm_delete_lifecycle(params = {})
841
- api_name = 'ilm.delete_lifecycle'
842
- 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"=>{}}
843
- request(api_name, api_spec, params)
844
- end
845
-
846
- # ilm.explain_lifecycle
847
- # {"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."}
848
- def ilm_explain_lifecycle(params = {})
849
- api_name = 'ilm.explain_lifecycle'
850
- 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"}}}
851
- request(api_name, api_spec, params)
852
- end
853
-
854
- # ilm.get_lifecycle
855
- # {"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."}
856
- def ilm_get_lifecycle(params = {})
857
- api_name = 'ilm.get_lifecycle'
858
- 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"=>{}}
859
- request(api_name, api_spec, params)
860
- end
861
-
862
- # ilm.get_status
863
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-status.html", "description"=>"Retrieves the current index lifecycle management (ILM) status."}
864
- def ilm_get_status(params = {})
865
- api_name = 'ilm.get_status'
866
- 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"=>{}}
867
- request(api_name, api_spec, params)
868
- end
869
-
870
- # ilm.migrate_to_data_tiers
871
- # {"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"}
872
- def ilm_migrate_to_data_tiers(params = {})
873
- api_name = 'ilm.migrate_to_data_tiers'
874
- 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}}
875
- request(api_name, api_spec, params)
876
- end
877
-
878
- # ilm.move_to_step
879
- # {"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."}
880
- def ilm_move_to_step(params = {})
881
- api_name = 'ilm.move_to_step'
882
- 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"}}
883
- request(api_name, api_spec, params)
884
- end
885
-
886
- # ilm.put_lifecycle
887
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-put-lifecycle.html", "description"=>"Creates a lifecycle policy"}
888
- def ilm_put_lifecycle(params = {})
889
- api_name = 'ilm.put_lifecycle'
890
- 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"}}
891
- request(api_name, api_spec, params)
892
- end
893
-
894
- # ilm.remove_policy
895
- # {"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"}
896
- def ilm_remove_policy(params = {})
897
- api_name = 'ilm.remove_policy'
898
- 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"=>{}}
899
- request(api_name, api_spec, params)
900
- end
901
-
902
- # ilm.retry
903
- # {"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."}
904
- def ilm_retry(params = {})
905
- api_name = 'ilm.retry'
906
- 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"=>{}}
907
- request(api_name, api_spec, params)
908
- end
909
-
910
- # ilm.start
911
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-start.html", "description"=>"Start the index lifecycle management (ILM) plugin."}
912
- def ilm_start(params = {})
913
- api_name = 'ilm.start'
914
- 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"=>{}}
915
- request(api_name, api_spec, params)
916
- end
917
-
918
- # ilm.stop
919
- # {"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"}
920
- def ilm_stop(params = {})
921
- api_name = 'ilm.stop'
922
- 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"=>{}}
923
- request(api_name, api_spec, params)
924
- end
925
-
926
- # index
927
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html", "description"=>"Creates or updates a document in an index."}
928
- def index(params = {})
929
- api_name = 'index'
930
- 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}}
931
- request(api_name, api_spec, params)
932
- end
933
-
934
- # indices.add_block
935
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/index-modules-blocks.html", "description"=>"Adds a block to an index."}
936
- def indices_add_block(params = {})
937
- api_name = 'indices.add_block'
938
- 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."}}}
939
- request(api_name, api_spec, params)
940
- end
941
-
942
- # indices.analyze
943
- # {"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."}
944
- def indices_analyze(params = {})
945
- api_name = 'indices.analyze'
946
- 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"}}
947
- request(api_name, api_spec, params)
948
- end
949
-
950
- # indices.clear_cache
951
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clearcache.html", "description"=>"Clears all or specific caches for one or more indices."}
952
- def indices_clear_cache(params = {})
953
- api_name = 'indices.clear_cache'
954
- 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"}}}
955
- request(api_name, api_spec, params)
956
- end
957
-
958
- # indices.clone
959
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clone-index.html", "description"=>"Clones an index"}
960
- def indices_clone(params = {})
961
- api_name = 'indices.clone'
962
- 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`)"}}
963
- request(api_name, api_spec, params)
964
- end
965
-
966
- # indices.close
967
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html", "description"=>"Closes an index."}
968
- def indices_close(params = {})
969
- api_name = 'indices.close'
970
- 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`."}}}
971
- request(api_name, api_spec, params)
972
- end
973
-
974
- # indices.create
975
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-create-index.html", "description"=>"Creates an index with optional settings and mappings."}
976
- def indices_create(params = {})
977
- api_name = 'indices.create'
978
- 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`)"}}
979
- request(api_name, api_spec, params)
980
- end
981
-
982
- # indices.create_data_stream
983
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "description"=>"Creates a data stream"}
984
- def indices_create_data_stream(params = {})
985
- api_name = 'indices.create_data_stream'
986
- 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"=>{}}
987
- request(api_name, api_spec, params)
988
- end
989
-
990
- # indices.data_streams_stats
991
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "description"=>"Provides statistics on operations happening in a data stream."}
992
- def indices_data_streams_stats(params = {})
993
- api_name = 'indices.data_streams_stats'
994
- 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"}}}]}}
995
- request(api_name, api_spec, params)
996
- end
997
-
998
- # indices.delete
999
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-index.html", "description"=>"Deletes an index."}
1000
- def indices_delete(params = {})
1001
- api_name = 'indices.delete'
1002
- 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,closed", "description"=>"Whether wildcard expressions should get expanded to open, closed, or hidden indices"}}}
1003
- request(api_name, api_spec, params)
1004
- end
1005
-
1006
- # indices.delete_alias
1007
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", "description"=>"Deletes an alias."}
1008
- def indices_delete_alias(params = {})
1009
- api_name = 'indices.delete_alias'
1010
- 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"}}}
1011
- request(api_name, api_spec, params)
1012
- end
1013
-
1014
- # indices.delete_data_stream
1015
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "description"=>"Deletes a data stream."}
1016
- def indices_delete_data_stream(params = {})
1017
- api_name = 'indices.delete_data_stream'
1018
- 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)"}}}
1019
- request(api_name, api_spec, params)
1020
- end
1021
-
1022
- # indices.delete_index_template
1023
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", "description"=>"Deletes an index template."}
1024
- def indices_delete_index_template(params = {})
1025
- api_name = 'indices.delete_index_template'
1026
- 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"}}}
1027
- request(api_name, api_spec, params)
1028
- end
1029
-
1030
- # indices.delete_template
1031
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", "description"=>"Deletes an index template."}
1032
- def indices_delete_template(params = {})
1033
- api_name = 'indices.delete_template'
1034
- 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"}}}
1035
- request(api_name, api_spec, params)
1036
- end
1037
-
1038
- # indices.exists
1039
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-exists.html", "description"=>"Returns information about whether a particular index exists."}
1040
- def indices_exists(params = {})
1041
- api_name = 'indices.exists'
1042
- 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}}}
1043
- request(api_name, api_spec, params)
1044
- end
1045
- alias :indices_exists? :indices_exists
1046
-
1047
- # indices.exists_alias
1048
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", "description"=>"Returns information about whether a particular alias exists."}
1049
- def indices_exists_alias(params = {})
1050
- api_name = 'indices.exists_alias'
1051
- 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)"}}}
1052
- request(api_name, api_spec, params)
1053
- end
1054
- alias :indices_exists_alias? :indices_exists_alias
1055
-
1056
- # indices.exists_index_template
1057
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", "description"=>"Returns information about whether a particular index template exists."}
1058
- def indices_exists_index_template(params = {})
1059
- api_name = 'indices.exists_index_template'
1060
- 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)"}}}
1061
- request(api_name, api_spec, params)
1062
- end
1063
- alias :indices_exists_index_template? :indices_exists_index_template
1064
-
1065
- # indices.exists_template
1066
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", "description"=>"Returns information about whether a particular index template exists."}
1067
- def indices_exists_template(params = {})
1068
- api_name = 'indices.exists_template'
1069
- 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)"}}}
1070
- request(api_name, api_spec, params)
1071
- end
1072
- alias :indices_exists_template? :indices_exists_template
1073
-
1074
- # indices.exists_type
1075
- # {"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)"}
1076
- def indices_exists_type(params = {})
1077
- api_name = 'indices.exists_type'
1078
- 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)"}}}
1079
- request(api_name, api_spec, params)
1080
- end
1081
- alias :indices_exists_type? :indices_exists_type
1082
-
1083
- # indices.flush
1084
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-flush.html", "description"=>"Performs the flush operation on one or more indices."}
1085
- def indices_flush(params = {})
1086
- api_name = 'indices.flush'
1087
- 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."}}}
1088
- request(api_name, api_spec, params)
1089
- end
1090
-
1091
- # indices.flush_synced
1092
- # {"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"}
1093
- def indices_flush_synced(params = {})
1094
- api_name = 'indices.flush_synced'
1095
- 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."}}}
1096
- request(api_name, api_spec, params)
1097
- end
1098
-
1099
- # indices.forcemerge
1100
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-forcemerge.html", "description"=>"Performs the force merge operation on one or more indices."}
1101
- def indices_forcemerge(params = {})
1102
- api_name = 'indices.forcemerge'
1103
- 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"}}}
1104
- request(api_name, api_spec, params)
1105
- end
1106
-
1107
- # indices.freeze
1108
- # {"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."}
1109
- def indices_freeze(params = {})
1110
- api_name = 'indices.freeze'
1111
- 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."}}}
1112
- request(api_name, api_spec, params)
1113
- end
1114
-
1115
- # indices.get
1116
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index.html", "description"=>"Returns information about one or more indices."}
1117
- def indices_get(params = {})
1118
- api_name = 'indices.get'
1119
- 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"}}}
1120
- request(api_name, api_spec, params)
1121
- end
1122
-
1123
- # indices.get_alias
1124
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", "description"=>"Returns an alias."}
1125
- def indices_get_alias(params = {})
1126
- api_name = 'indices.get_alias'
1127
- 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)"}}}
1128
- request(api_name, api_spec, params)
1129
- end
1130
-
1131
- # indices.get_data_stream
1132
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "description"=>"Returns data streams."}
1133
- def indices_get_data_stream(params = {})
1134
- api_name = 'indices.get_data_stream'
1135
- 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)"}}}
1136
- request(api_name, api_spec, params)
1137
- end
1138
-
1139
- # indices.get_field_mapping
1140
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-field-mapping.html", "description"=>"Returns mapping for one or more fields."}
1141
- def indices_get_field_mapping(params = {})
1142
- api_name = 'indices.get_field_mapping'
1143
- 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)"}}}
1144
- request(api_name, api_spec, params)
1145
- end
1146
-
1147
- # indices.get_index_template
1148
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", "description"=>"Returns an index template."}
1149
- def indices_get_index_template(params = {})
1150
- api_name = 'indices.get_index_template'
1151
- 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)"}}}
1152
- request(api_name, api_spec, params)
1153
- end
1154
-
1155
- # indices.get_mapping
1156
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-mapping.html", "description"=>"Returns mappings for one or more indices."}
1157
- def indices_get_mapping(params = {})
1158
- api_name = 'indices.get_mapping'
1159
- 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."}}}}
1160
- request(api_name, api_spec, params)
1161
- end
1162
-
1163
- # indices.get_settings
1164
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html", "description"=>"Returns settings for one or more indices."}
1165
- def indices_get_settings(params = {})
1166
- api_name = 'indices.get_settings'
1167
- 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}}}
1168
- request(api_name, api_spec, params)
1169
- end
1170
-
1171
- # indices.get_template
1172
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", "description"=>"Returns an index template."}
1173
- def indices_get_template(params = {})
1174
- api_name = 'indices.get_template'
1175
- 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)"}}}
1176
- request(api_name, api_spec, params)
1177
- end
1178
-
1179
- # indices.get_upgrade
1180
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html", "description"=>"DEPRECATED Returns a progress status of current upgrade."}
1181
- def indices_get_upgrade(params = {})
1182
- api_name = 'indices.get_upgrade'
1183
- 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."}}}
1184
- request(api_name, api_spec, params)
1185
- end
1186
-
1187
- # indices.migrate_to_data_stream
1188
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "description"=>"Migrates an alias to a data stream"}
1189
- def indices_migrate_to_data_stream(params = {})
1190
- api_name = 'indices.migrate_to_data_stream'
1191
- 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"=>{}}
1192
- request(api_name, api_spec, params)
1193
- end
1194
-
1195
- # indices.open
1196
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html", "description"=>"Opens an index."}
1197
- def indices_open(params = {})
1198
- api_name = 'indices.open'
1199
- 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."}}}
1200
- request(api_name, api_spec, params)
1201
- end
1202
-
1203
- # indices.promote_data_stream
1204
- # {"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"}
1205
- def indices_promote_data_stream(params = {})
1206
- api_name = 'indices.promote_data_stream'
1207
- 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"=>{}}
1208
- request(api_name, api_spec, params)
1209
- end
1210
-
1211
- # indices.put_alias
1212
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", "description"=>"Creates or updates an alias."}
1213
- def indices_put_alias(params = {})
1214
- api_name = 'indices.put_alias'
1215
- 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}}
1216
- request(api_name, api_spec, params)
1217
- end
1218
-
1219
- # indices.put_index_template
1220
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", "description"=>"Creates or updates an index template."}
1221
- def indices_put_index_template(params = {})
1222
- api_name = 'indices.put_index_template'
1223
- 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}}
1224
- request(api_name, api_spec, params)
1225
- end
1226
-
1227
- # indices.put_mapping
1228
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html", "description"=>"Updates the index mappings."}
1229
- def indices_put_mapping(params = {})
1230
- api_name = 'indices.put_mapping'
1231
- 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}}
1232
- request(api_name, api_spec, params)
1233
- end
1234
-
1235
- # indices.put_settings
1236
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html", "description"=>"Updates the index settings."}
1237
- def indices_put_settings(params = {})
1238
- api_name = 'indices.put_settings'
1239
- 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}}
1240
- request(api_name, api_spec, params)
1241
- end
1242
-
1243
- # indices.put_template
1244
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", "description"=>"Creates or updates an index template."}
1245
- def indices_put_template(params = {})
1246
- api_name = 'indices.put_template'
1247
- 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}}
1248
- request(api_name, api_spec, params)
1249
- end
1250
-
1251
- # indices.recovery
1252
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-recovery.html", "description"=>"Returns information about ongoing index shard recoveries."}
1253
- def indices_recovery(params = {})
1254
- api_name = 'indices.recovery'
1255
- 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}}}
1256
- request(api_name, api_spec, params)
1257
- end
1258
-
1259
- # indices.refresh
1260
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html", "description"=>"Performs the refresh operation in one or more indices."}
1261
- def indices_refresh(params = {})
1262
- api_name = 'indices.refresh'
1263
- 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."}}}
1264
- request(api_name, api_spec, params)
1265
- end
1266
-
1267
- # indices.reload_search_analyzers
1268
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-reload-analyzers.html", "description"=>"Reloads an index's search analyzers and their resources."}
1269
- def indices_reload_search_analyzers(params = {})
1270
- api_name = 'indices.reload_search_analyzers'
1271
- 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."}}}
1272
- request(api_name, api_spec, params)
1273
- end
1274
-
1275
- # indices.resolve_index
1276
- # {"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"}
1277
- def indices_resolve_index(params = {})
1278
- api_name = 'indices.resolve_index'
1279
- 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)"}}}
1280
- request(api_name, api_spec, params)
1281
- end
1282
-
1283
- # indices.rollover
1284
- # {"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."}
1285
- def indices_rollover(params = {})
1286
- api_name = 'indices.rollover'
1287
- 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"}}
1288
- request(api_name, api_spec, params)
1289
- end
1290
-
1291
- # indices.segments
1292
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-segments.html", "description"=>"Provides low-level information about segments in a Lucene index."}
1293
- def indices_segments(params = {})
1294
- api_name = 'indices.segments'
1295
- 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}}}
1296
- request(api_name, api_spec, params)
1297
- end
1298
-
1299
- # indices.shard_stores
1300
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shards-stores.html", "description"=>"Provides store information for shard copies of indices."}
1301
- def indices_shard_stores(params = {})
1302
- api_name = 'indices.shard_stores'
1303
- 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."}}}
1304
- request(api_name, api_spec, params)
1305
- end
1306
-
1307
- # indices.shrink
1308
- # {"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."}
1309
- def indices_shrink(params = {})
1310
- api_name = 'indices.shrink'
1311
- 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`)"}}
1312
- request(api_name, api_spec, params)
1313
- end
1314
-
1315
- # indices.simulate_index_template
1316
- # {"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"}
1317
- def indices_simulate_index_template(params = {})
1318
- api_name = 'indices.simulate_index_template'
1319
- 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}}
1320
- request(api_name, api_spec, params)
1321
- end
1322
-
1323
- # indices.simulate_template
1324
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", "description"=>"Simulate resolving the given template name or body"}
1325
- def indices_simulate_template(params = {})
1326
- api_name = 'indices.simulate_template'
1327
- 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}}
1328
- request(api_name, api_spec, params)
1329
- end
1330
-
1331
- # indices.split
1332
- # {"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."}
1333
- def indices_split(params = {})
1334
- api_name = 'indices.split'
1335
- 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`)"}}
1336
- request(api_name, api_spec, params)
1337
- end
1338
-
1339
- # indices.stats
1340
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-stats.html", "description"=>"Provides statistics on operations happening in an index."}
1341
- def indices_stats(params = {})
1342
- api_name = 'indices.stats'
1343
- 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}}}
1344
- request(api_name, api_spec, params)
1345
- end
1346
-
1347
- # indices.unfreeze
1348
- # {"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."}
1349
- def indices_unfreeze(params = {})
1350
- api_name = 'indices.unfreeze'
1351
- 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."}}}
1352
- request(api_name, api_spec, params)
1353
- end
1354
-
1355
- # indices.update_aliases
1356
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", "description"=>"Updates index aliases."}
1357
- def indices_update_aliases(params = {})
1358
- api_name = 'indices.update_aliases'
1359
- 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}}
1360
- request(api_name, api_spec, params)
1361
- end
1362
-
1363
- # indices.upgrade
1364
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html", "description"=>"DEPRECATED Upgrades to the current version of Lucene."}
1365
- def indices_upgrade(params = {})
1366
- api_name = 'indices.upgrade'
1367
- 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"}}}
1368
- request(api_name, api_spec, params)
1369
- end
1370
-
1371
- # indices.validate_query
1372
- # {"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."}
1373
- def indices_validate_query(params = {})
1374
- api_name = 'indices.validate_query'
1375
- 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"}}
1376
- request(api_name, api_spec, params)
1377
- end
1378
-
1379
- # info
1380
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html", "description"=>"Returns basic information about the cluster."}
1381
- def info(params = {})
1382
- api_name = 'info'
1383
- 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"=>{}}
1384
- request(api_name, api_spec, params)
1385
- end
1386
-
1387
- # ingest.delete_pipeline
1388
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-pipeline-api.html", "description"=>"Deletes a pipeline."}
1389
- def ingest_delete_pipeline(params = {})
1390
- api_name = 'ingest.delete_pipeline'
1391
- 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"}}}
1392
- request(api_name, api_spec, params)
1393
- end
1394
-
1395
- # ingest.geo_ip_stats
1396
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/geoip-stats-api.html", "description"=>"Returns statistical information about geoip databases"}
1397
- def ingest_geo_ip_stats(params = {})
1398
- api_name = 'ingest.geo_ip_stats'
1399
- 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"]}]}}
1400
- request(api_name, api_spec, params)
1401
- end
1402
-
1403
- # ingest.get_pipeline
1404
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/get-pipeline-api.html", "description"=>"Returns a pipeline."}
1405
- def ingest_get_pipeline(params = {})
1406
- api_name = 'ingest.get_pipeline'
1407
- 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"}}}
1408
- request(api_name, api_spec, params)
1409
- end
1410
-
1411
- # ingest.processor_grok
1412
- # {"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."}
1413
- def ingest_processor_grok(params = {})
1414
- api_name = 'ingest.processor_grok'
1415
- 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"=>{}}
1416
- request(api_name, api_spec, params)
1417
- end
1418
-
1419
- # ingest.put_pipeline
1420
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/put-pipeline-api.html", "description"=>"Creates or updates a pipeline."}
1421
- def ingest_put_pipeline(params = {})
1422
- api_name = 'ingest.put_pipeline'
1423
- 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}}
1424
- request(api_name, api_spec, params)
1425
- end
1426
-
1427
- # ingest.simulate
1428
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-pipeline-api.html", "description"=>"Allows to simulate a pipeline with example documents."}
1429
- def ingest_simulate(params = {})
1430
- api_name = 'ingest.simulate'
1431
- 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}}
1432
- request(api_name, api_spec, params)
1433
- end
1434
-
1435
- # license.delete
1436
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-license.html", "description"=>"Deletes licensing information for the cluster"}
1437
- def license_delete(params = {})
1438
- api_name = 'license.delete'
1439
- 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"]}]}}
1440
- request(api_name, api_spec, params)
1441
- end
1442
-
1443
- # license.get
1444
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/get-license.html", "description"=>"Retrieves licensing information for the cluster"}
1445
- def license_get(params = {})
1446
- api_name = 'license.get'
1447
- 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)"}}}
1448
- request(api_name, api_spec, params)
1449
- end
1450
-
1451
- # license.get_basic_status
1452
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/get-basic-status.html", "description"=>"Retrieves information about the status of the basic license."}
1453
- def license_get_basic_status(params = {})
1454
- api_name = 'license.get_basic_status'
1455
- 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"=>{}}
1456
- request(api_name, api_spec, params)
1457
- end
1458
-
1459
- # license.get_trial_status
1460
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/get-trial-status.html", "description"=>"Retrieves information about the status of the trial license."}
1461
- def license_get_trial_status(params = {})
1462
- api_name = 'license.get_trial_status'
1463
- 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"=>{}}
1464
- request(api_name, api_spec, params)
1465
- end
1466
-
1467
- # license.post
1468
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/update-license.html", "description"=>"Updates the license for the cluster."}
1469
- def license_post(params = {})
1470
- api_name = 'license.post'
1471
- 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"}}
1472
- request(api_name, api_spec, params)
1473
- end
1474
-
1475
- # license.post_start_basic
1476
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/start-basic.html", "description"=>"Starts an indefinite basic license."}
1477
- def license_post_start_basic(params = {})
1478
- api_name = 'license.post_start_basic'
1479
- 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)"}}}
1480
- request(api_name, api_spec, params)
1481
- end
1482
-
1483
- # license.post_start_trial
1484
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/start-trial.html", "description"=>"starts a limited time trial license."}
1485
- def license_post_start_trial(params = {})
1486
- api_name = 'license.post_start_trial'
1487
- 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)"}}}
1488
- request(api_name, api_spec, params)
1489
- end
1490
-
1491
- # logstash.delete_pipeline
1492
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-delete-pipeline.html", "description"=>"Deletes Logstash Pipelines used by Central Management"}
1493
- def logstash_delete_pipeline(params = {})
1494
- api_name = 'logstash.delete_pipeline'
1495
- 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"=>{}}
1496
- request(api_name, api_spec, params)
1497
- end
1498
-
1499
- # logstash.get_pipeline
1500
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-get-pipeline.html", "description"=>"Retrieves Logstash Pipelines used by Central Management"}
1501
- def logstash_get_pipeline(params = {})
1502
- api_name = 'logstash.get_pipeline'
1503
- 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"=>{}}
1504
- request(api_name, api_spec, params)
1505
- end
1506
-
1507
- # logstash.put_pipeline
1508
- # {"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"}
1509
- def logstash_put_pipeline(params = {})
1510
- api_name = 'logstash.put_pipeline'
1511
- 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}}
1512
- request(api_name, api_spec, params)
1513
- end
1514
-
1515
- # mget
1516
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html", "description"=>"Allows to get multiple documents in one request."}
1517
- def mget(params = {})
1518
- api_name = 'mget'
1519
- 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}}
1520
- request(api_name, api_spec, params)
1521
- end
1522
-
1523
- # migration.deprecations
1524
- # {"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."}
1525
- def migration_deprecations(params = {})
1526
- api_name = 'migration.deprecations'
1527
- 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"=>{}}
1528
- request(api_name, api_spec, params)
1529
- end
1530
-
1531
- # ml.close_job
1532
- # {"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."}
1533
- def ml_close_job(params = {})
1534
- api_name = 'ml.close_job'
1535
- 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}}
1536
- request(api_name, api_spec, params)
1537
- end
1538
-
1539
- # ml.delete_calendar
1540
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar.html", "description"=>"Deletes a calendar."}
1541
- def ml_delete_calendar(params = {})
1542
- api_name = 'ml.delete_calendar'
1543
- 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"}}}]}}
1544
- request(api_name, api_spec, params)
1545
- end
1546
-
1547
- # ml.delete_calendar_event
1548
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-event.html", "description"=>"Deletes scheduled events from a calendar."}
1549
- def ml_delete_calendar_event(params = {})
1550
- api_name = 'ml.delete_calendar_event'
1551
- 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"}}}]}}
1552
- request(api_name, api_spec, params)
1553
- end
1554
-
1555
- # ml.delete_calendar_job
1556
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-job.html", "description"=>"Deletes anomaly detection jobs from a calendar."}
1557
- def ml_delete_calendar_job(params = {})
1558
- api_name = 'ml.delete_calendar_job'
1559
- 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"}}}]}}
1560
- request(api_name, api_spec, params)
1561
- end
1562
-
1563
- # ml.delete_data_frame_analytics
1564
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-dfanalytics.html", "description"=>"Deletes an existing data frame analytics job."}
1565
- def ml_delete_data_frame_analytics(params = {})
1566
- api_name = 'ml.delete_data_frame_analytics'
1567
- 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"}}}
1568
- request(api_name, api_spec, params)
1569
- end
1570
-
1571
- # ml.delete_datafeed
1572
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-datafeed.html", "description"=>"Deletes an existing datafeed."}
1573
- def ml_delete_datafeed(params = {})
1574
- api_name = 'ml.delete_datafeed'
1575
- 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"}}}
1576
- request(api_name, api_spec, params)
1577
- end
1578
-
1579
- # ml.delete_expired_data
1580
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-expired-data.html", "description"=>"Deletes expired and unused machine learning data."}
1581
- def ml_delete_expired_data(params = {})
1582
- api_name = 'ml.delete_expired_data'
1583
- 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"}}
1584
- request(api_name, api_spec, params)
1585
- end
1586
-
1587
- # ml.delete_filter
1588
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-filter.html", "description"=>"Deletes a filter."}
1589
- def ml_delete_filter(params = {})
1590
- api_name = 'ml.delete_filter'
1591
- 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"}}}]}}
1592
- request(api_name, api_spec, params)
1593
- end
1594
-
1595
- # ml.delete_forecast
1596
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-forecast.html", "description"=>"Deletes forecasts from a machine learning job."}
1597
- def ml_delete_forecast(params = {})
1598
- api_name = 'ml.delete_forecast'
1599
- 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"}}}
1600
- request(api_name, api_spec, params)
1601
- end
1602
-
1603
- # ml.delete_job
1604
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-job.html", "description"=>"Deletes an existing anomaly detection job."}
1605
- def ml_delete_job(params = {})
1606
- api_name = 'ml.delete_job'
1607
- 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}}}
1608
- request(api_name, api_spec, params)
1609
- end
1610
-
1611
- # ml.delete_model_snapshot
1612
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-snapshot.html", "description"=>"Deletes an existing model snapshot."}
1613
- def ml_delete_model_snapshot(params = {})
1614
- api_name = 'ml.delete_model_snapshot'
1615
- 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"}}}]}}
1616
- request(api_name, api_spec, params)
1617
- end
1618
-
1619
- # ml.delete_trained_model
1620
- # {"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."}
1621
- def ml_delete_trained_model(params = {})
1622
- api_name = 'ml.delete_trained_model'
1623
- 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"}}}]}}
1624
- request(api_name, api_spec, params)
1625
- end
1626
-
1627
- # ml.delete_trained_model_alias
1628
- # {"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"}
1629
- def ml_delete_trained_model_alias(params = {})
1630
- api_name = 'ml.delete_trained_model_alias'
1631
- 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"}}}]}}
1632
- request(api_name, api_spec, params)
1633
- end
1634
-
1635
- # ml.estimate_model_memory
1636
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-apis.html", "description"=>"Estimates the model memory"}
1637
- def ml_estimate_model_memory(params = {})
1638
- api_name = 'ml.estimate_model_memory'
1639
- 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}}
1640
- request(api_name, api_spec, params)
1641
- end
1642
-
1643
- # ml.evaluate_data_frame
1644
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/evaluate-dfanalytics.html", "description"=>"Evaluates the data frame analytics for an annotated index."}
1645
- def ml_evaluate_data_frame(params = {})
1646
- api_name = 'ml.evaluate_data_frame'
1647
- 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}}
1648
- request(api_name, api_spec, params)
1649
- end
1650
-
1651
- # ml.explain_data_frame_analytics
1652
- # {"url"=>"http://www.elastic.co/guide/en/elasticsearch/reference/current/explain-dfanalytics.html", "description"=>"Explains a data frame analytics config."}
1653
- def ml_explain_data_frame_analytics(params = {})
1654
- api_name = 'ml.explain_data_frame_analytics'
1655
- 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}}
1656
- request(api_name, api_spec, params)
1657
- end
1658
-
1659
- # ml.find_file_structure
1660
- # {"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."}
1661
- def ml_find_file_structure(params = {})
1662
- api_name = 'ml.find_file_structure'
1663
- 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"}}
1664
- request(api_name, api_spec, params)
1665
- end
1666
-
1667
- # ml.flush_job
1668
- # {"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."}
1669
- def ml_flush_job(params = {})
1670
- api_name = 'ml.flush_job'
1671
- 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"}}
1672
- request(api_name, api_spec, params)
1673
- end
1674
-
1675
- # ml.forecast
1676
- # {"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."}
1677
- def ml_forecast(params = {})
1678
- api_name = 'ml.forecast'
1679
- 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."}}}
1680
- request(api_name, api_spec, params)
1681
- end
1682
-
1683
- # ml.get_buckets
1684
- # {"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."}
1685
- def ml_get_buckets(params = {})
1686
- api_name = 'ml.get_buckets'
1687
- 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"}}
1688
- request(api_name, api_spec, params)
1689
- end
1690
-
1691
- # ml.get_calendar_events
1692
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar-event.html", "description"=>"Retrieves information about the scheduled events in calendars."}
1693
- def ml_get_calendar_events(params = {})
1694
- api_name = 'ml.get_calendar_events'
1695
- 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"}}}
1696
- request(api_name, api_spec, params)
1697
- end
1698
-
1699
- # ml.get_calendars
1700
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar.html", "description"=>"Retrieves configuration information for calendars."}
1701
- def ml_get_calendars(params = {})
1702
- api_name = 'ml.get_calendars'
1703
- 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"}}
1704
- request(api_name, api_spec, params)
1705
- end
1706
-
1707
- # ml.get_categories
1708
- # {"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."}
1709
- def ml_get_categories(params = {})
1710
- api_name = 'ml.get_categories'
1711
- 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"}}
1712
- request(api_name, api_spec, params)
1713
- end
1714
-
1715
- # ml.get_data_frame_analytics
1716
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html", "description"=>"Retrieves configuration information for data frame analytics jobs."}
1717
- def ml_get_data_frame_analytics(params = {})
1718
- api_name = 'ml.get_data_frame_analytics'
1719
- 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"}}}
1720
- request(api_name, api_spec, params)
1721
- end
1722
-
1723
- # ml.get_data_frame_analytics_stats
1724
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics-stats.html", "description"=>"Retrieves usage information for data frame analytics jobs."}
1725
- def ml_get_data_frame_analytics_stats(params = {})
1726
- api_name = 'ml.get_data_frame_analytics_stats'
1727
- 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}}}
1728
- request(api_name, api_spec, params)
1729
- end
1730
-
1731
- # ml.get_datafeed_stats
1732
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html", "description"=>"Retrieves usage information for datafeeds."}
1733
- def ml_get_datafeed_stats(params = {})
1734
- api_name = 'ml.get_datafeed_stats'
1735
- 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}}}
1736
- request(api_name, api_spec, params)
1737
- end
1738
-
1739
- # ml.get_datafeeds
1740
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html", "description"=>"Retrieves configuration information for datafeeds."}
1741
- def ml_get_datafeeds(params = {})
1742
- api_name = 'ml.get_datafeeds'
1743
- 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"}}}
1744
- request(api_name, api_spec, params)
1745
- end
1746
-
1747
- # ml.get_filters
1748
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-filter.html", "description"=>"Retrieves filters."}
1749
- def ml_get_filters(params = {})
1750
- api_name = 'ml.get_filters'
1751
- 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"}}}
1752
- request(api_name, api_spec, params)
1753
- end
1754
-
1755
- # ml.get_influencers
1756
- # {"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."}
1757
- def ml_get_influencers(params = {})
1758
- api_name = 'ml.get_influencers'
1759
- 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"}}
1760
- request(api_name, api_spec, params)
1761
- end
1762
-
1763
- # ml.get_job_stats
1764
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats.html", "description"=>"Retrieves usage information for anomaly detection jobs."}
1765
- def ml_get_job_stats(params = {})
1766
- api_name = 'ml.get_job_stats'
1767
- 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}}}
1768
- request(api_name, api_spec, params)
1769
- end
1770
-
1771
- # ml.get_jobs
1772
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html", "description"=>"Retrieves configuration information for anomaly detection jobs."}
1773
- def ml_get_jobs(params = {})
1774
- api_name = 'ml.get_jobs'
1775
- 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"}}}
1776
- request(api_name, api_spec, params)
1777
- end
1778
-
1779
- # ml.get_model_snapshots
1780
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-snapshot.html", "description"=>"Retrieves information about model snapshots."}
1781
- def ml_get_model_snapshots(params = {})
1782
- api_name = 'ml.get_model_snapshots'
1783
- 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"}}
1784
- request(api_name, api_spec, params)
1785
- end
1786
-
1787
- # ml.get_overall_buckets
1788
- # {"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."}
1789
- def ml_get_overall_buckets(params = {})
1790
- api_name = 'ml.get_overall_buckets'
1791
- 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"}}
1792
- request(api_name, api_spec, params)
1793
- end
1794
-
1795
- # ml.get_records
1796
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-record.html", "description"=>"Retrieves anomaly records for an anomaly detection job."}
1797
- def ml_get_records(params = {})
1798
- api_name = 'ml.get_records'
1799
- 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"}}
1800
- request(api_name, api_spec, params)
1801
- end
1802
-
1803
- # ml.get_trained_models
1804
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models.html", "description"=>"Retrieves configuration information for a trained inference model."}
1805
- def ml_get_trained_models(params = {})
1806
- api_name = 'ml.get_trained_models'
1807
- 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"}}}
1808
- request(api_name, api_spec, params)
1809
- end
1810
-
1811
- # ml.get_trained_models_stats
1812
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models-stats.html", "description"=>"Retrieves usage information for trained inference models."}
1813
- def ml_get_trained_models_stats(params = {})
1814
- api_name = 'ml.get_trained_models_stats'
1815
- 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}}}
1816
- request(api_name, api_spec, params)
1817
- end
1818
-
1819
- # ml.info
1820
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-info.html", "description"=>"Returns defaults and limits used by machine learning."}
1821
- def ml_info(params = {})
1822
- api_name = 'ml.info'
1823
- 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"]}]}}
1824
- request(api_name, api_spec, params)
1825
- end
1826
-
1827
- # ml.open_job
1828
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html", "description"=>"Opens one or more anomaly detection jobs."}
1829
- def ml_open_job(params = {})
1830
- api_name = 'ml.open_job'
1831
- 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"}}}]}}
1832
- request(api_name, api_spec, params)
1833
- end
1834
-
1835
- # ml.post_calendar_events
1836
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-calendar-event.html", "description"=>"Posts scheduled events in a calendar."}
1837
- def ml_post_calendar_events(params = {})
1838
- api_name = 'ml.post_calendar_events'
1839
- 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}}
1840
- request(api_name, api_spec, params)
1841
- end
1842
-
1843
- # ml.post_data
1844
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-data.html", "description"=>"Sends data to an anomaly detection job for analysis."}
1845
- def ml_post_data(params = {})
1846
- api_name = 'ml.post_data'
1847
- 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"}}
1848
- request(api_name, api_spec, params)
1849
- end
1850
-
1851
- # ml.preview_data_frame_analytics
1852
- # {"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."}
1853
- def ml_preview_data_frame_analytics(params = {})
1854
- api_name = 'ml.preview_data_frame_analytics'
1855
- 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}}
1856
- request(api_name, api_spec, params)
1857
- end
1858
-
1859
- # ml.preview_datafeed
1860
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html", "description"=>"Previews a datafeed."}
1861
- def ml_preview_datafeed(params = {})
1862
- api_name = 'ml.preview_datafeed'
1863
- 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}}
1864
- request(api_name, api_spec, params)
1865
- end
1866
-
1867
- # ml.put_calendar
1868
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar.html", "description"=>"Instantiates a calendar."}
1869
- def ml_put_calendar(params = {})
1870
- api_name = 'ml.put_calendar'
1871
- 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}}
1872
- request(api_name, api_spec, params)
1873
- end
1874
-
1875
- # ml.put_calendar_job
1876
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar-job.html", "description"=>"Adds an anomaly detection job to a calendar."}
1877
- def ml_put_calendar_job(params = {})
1878
- api_name = 'ml.put_calendar_job'
1879
- 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"}}}]}}
1880
- request(api_name, api_spec, params)
1881
- end
1882
-
1883
- # ml.put_data_frame_analytics
1884
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/put-dfanalytics.html", "description"=>"Instantiates a data frame analytics job."}
1885
- def ml_put_data_frame_analytics(params = {})
1886
- api_name = 'ml.put_data_frame_analytics'
1887
- 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}}
1888
- request(api_name, api_spec, params)
1889
- end
1890
-
1891
- # ml.put_datafeed
1892
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-datafeed.html", "description"=>"Instantiates a datafeed."}
1893
- def ml_put_datafeed(params = {})
1894
- api_name = 'ml.put_datafeed'
1895
- 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)"}}}
1896
- request(api_name, api_spec, params)
1897
- end
1898
-
1899
- # ml.put_filter
1900
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-filter.html", "description"=>"Instantiates a filter."}
1901
- def ml_put_filter(params = {})
1902
- api_name = 'ml.put_filter'
1903
- 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}}
1904
- request(api_name, api_spec, params)
1905
- end
1906
-
1907
- # ml.put_job
1908
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-job.html", "description"=>"Instantiates an anomaly detection job."}
1909
- def ml_put_job(params = {})
1910
- api_name = 'ml.put_job'
1911
- 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}}
1912
- request(api_name, api_spec, params)
1913
- end
1914
-
1915
- # ml.put_trained_model
1916
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models.html", "description"=>"Creates an inference trained model."}
1917
- def ml_put_trained_model(params = {})
1918
- api_name = 'ml.put_trained_model'
1919
- 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}}
1920
- request(api_name, api_spec, params)
1921
- end
1922
-
1923
- # ml.put_trained_model_alias
1924
- # {"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"}
1925
- def ml_put_trained_model_alias(params = {})
1926
- api_name = 'ml.put_trained_model_alias'
1927
- 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."}}}
1928
- request(api_name, api_spec, params)
1929
- end
1930
-
1931
- # ml.reset_job
1932
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-reset-job.html", "description"=>"Resets an existing anomaly detection job."}
1933
- def ml_reset_job(params = {})
1934
- api_name = 'ml.reset_job'
1935
- 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}}}
1936
- request(api_name, api_spec, params)
1937
- end
1938
-
1939
- # ml.revert_model_snapshot
1940
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-revert-snapshot.html", "description"=>"Reverts to a specific snapshot."}
1941
- def ml_revert_model_snapshot(params = {})
1942
- api_name = 'ml.revert_model_snapshot'
1943
- 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"}}
1944
- request(api_name, api_spec, params)
1945
- end
1946
-
1947
- # ml.set_upgrade_mode
1948
- # {"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."}
1949
- def ml_set_upgrade_mode(params = {})
1950
- api_name = 'ml.set_upgrade_mode'
1951
- 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"}}}
1952
- request(api_name, api_spec, params)
1953
- end
1954
-
1955
- # ml.start_data_frame_analytics
1956
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/start-dfanalytics.html", "description"=>"Starts a data frame analytics job."}
1957
- def ml_start_data_frame_analytics(params = {})
1958
- api_name = 'ml.start_data_frame_analytics'
1959
- 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"}}
1960
- request(api_name, api_spec, params)
1961
- end
1962
-
1963
- # ml.start_datafeed
1964
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-datafeed.html", "description"=>"Starts one or more datafeeds."}
1965
- def ml_start_datafeed(params = {})
1966
- api_name = 'ml.start_datafeed'
1967
- 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"}}
1968
- request(api_name, api_spec, params)
1969
- end
1970
-
1971
- # ml.stop_data_frame_analytics
1972
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-dfanalytics.html", "description"=>"Stops one or more data frame analytics jobs."}
1973
- def ml_stop_data_frame_analytics(params = {})
1974
- api_name = 'ml.stop_data_frame_analytics'
1975
- 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"}}
1976
- request(api_name, api_spec, params)
1977
- end
1978
-
1979
- # ml.stop_datafeed
1980
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-stop-datafeed.html", "description"=>"Stops one or more datafeeds."}
1981
- def ml_stop_datafeed(params = {})
1982
- api_name = 'ml.stop_datafeed'
1983
- 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}}
1984
- request(api_name, api_spec, params)
1985
- end
1986
-
1987
- # ml.update_data_frame_analytics
1988
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/update-dfanalytics.html", "description"=>"Updates certain properties of a data frame analytics job."}
1989
- def ml_update_data_frame_analytics(params = {})
1990
- api_name = 'ml.update_data_frame_analytics'
1991
- 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}}
1992
- request(api_name, api_spec, params)
1993
- end
1994
-
1995
- # ml.update_datafeed
1996
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-datafeed.html", "description"=>"Updates certain properties of a datafeed."}
1997
- def ml_update_datafeed(params = {})
1998
- api_name = 'ml.update_datafeed'
1999
- 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)"}}}
2000
- request(api_name, api_spec, params)
2001
- end
2002
-
2003
- # ml.update_filter
2004
- # {"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."}
2005
- def ml_update_filter(params = {})
2006
- api_name = 'ml.update_filter'
2007
- 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}}
2008
- request(api_name, api_spec, params)
2009
- end
2010
-
2011
- # ml.update_job
2012
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-job.html", "description"=>"Updates certain properties of an anomaly detection job."}
2013
- def ml_update_job(params = {})
2014
- api_name = 'ml.update_job'
2015
- 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}}
2016
- request(api_name, api_spec, params)
2017
- end
2018
-
2019
- # ml.update_model_snapshot
2020
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-snapshot.html", "description"=>"Updates certain properties of a snapshot."}
2021
- def ml_update_model_snapshot(params = {})
2022
- api_name = 'ml.update_model_snapshot'
2023
- 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}}
2024
- request(api_name, api_spec, params)
2025
- end
2026
-
2027
- # ml.upgrade_job_snapshot
2028
- # {"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."}
2029
- def ml_upgrade_job_snapshot(params = {})
2030
- api_name = 'ml.upgrade_job_snapshot'
2031
- 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."}}}
2032
- request(api_name, api_spec, params)
2033
- end
2034
-
2035
- # ml.validate
2036
- # {"url"=>"https://www.elastic.co/guide/en/machine-learning/current/ml-jobs.html", "description"=>"Validates an anomaly detection job."}
2037
- def ml_validate(params = {})
2038
- api_name = 'ml.validate'
2039
- 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}}
2040
- request(api_name, api_spec, params)
2041
- end
2042
-
2043
- # ml.validate_detector
2044
- # {"url"=>"https://www.elastic.co/guide/en/machine-learning/current/ml-jobs.html", "description"=>"Validates an anomaly detection detector."}
2045
- def ml_validate_detector(params = {})
2046
- api_name = 'ml.validate_detector'
2047
- 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}}
2048
- request(api_name, api_spec, params)
2049
- end
2050
-
2051
- # monitoring.bulk
2052
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/monitor-elasticsearch-cluster.html", "description"=>"Used by the monitoring features to send monitoring data."}
2053
- def monitoring_bulk(params = {})
2054
- api_name = 'monitoring.bulk'
2055
- 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"}}
2056
- request(api_name, api_spec, params)
2057
- end
2058
-
2059
- # msearch
2060
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html", "description"=>"Allows to execute several search operations in one request."}
2061
- def msearch(params = {})
2062
- api_name = 'msearch'
2063
- 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"}}
2064
- request(api_name, api_spec, params)
2065
- end
2066
-
2067
- # msearch_template
2068
- # {"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."}
2069
- def msearch_template(params = {})
2070
- api_name = 'msearch_template'
2071
- 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"}}
2072
- request(api_name, api_spec, params)
2073
- end
2074
-
2075
- # mtermvectors
2076
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html", "description"=>"Returns multiple termvectors in one request."}
2077
- def mtermvectors(params = {})
2078
- api_name = 'mtermvectors'
2079
- 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}}
2080
- request(api_name, api_spec, params)
2081
- end
2082
-
2083
- # nodes.hot_threads
2084
- # {"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."}
2085
- def nodes_hot_threads(params = {})
2086
- api_name = 'nodes.hot_threads'
2087
- 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"}}}
2088
- request(api_name, api_spec, params)
2089
- end
2090
-
2091
- # nodes.info
2092
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-info.html", "description"=>"Returns information about nodes in the cluster."}
2093
- def nodes_info(params = {})
2094
- api_name = 'nodes.info'
2095
- 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"}}}
2096
- request(api_name, api_spec, params)
2097
- end
2098
-
2099
- # nodes.reload_secure_settings
2100
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/secure-settings.html#reloadable-secure-settings", "description"=>"Reloads secure settings."}
2101
- def nodes_reload_secure_settings(params = {})
2102
- api_name = 'nodes.reload_secure_settings'
2103
- 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}}
2104
- request(api_name, api_spec, params)
2105
- end
2106
-
2107
- # nodes.stats
2108
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-stats.html", "description"=>"Returns statistical information about nodes in the cluster."}
2109
- def nodes_stats(params = {})
2110
- api_name = 'nodes.stats'
2111
- 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}}}
2112
- request(api_name, api_spec, params)
2113
- end
2114
-
2115
- # nodes.usage
2116
- # {"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."}
2117
- def nodes_usage(params = {})
2118
- api_name = 'nodes.usage'
2119
- 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"}}}
2120
- request(api_name, api_spec, params)
2121
- end
2122
-
2123
- # open_point_in_time
2124
- # {"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"}
2125
- def open_point_in_time(params = {})
2126
- api_name = 'open_point_in_time'
2127
- 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"}}}
2128
- request(api_name, api_spec, params)
2129
- end
2130
-
2131
- # ping
2132
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html", "description"=>"Returns whether the cluster is running."}
2133
- def ping(params = {})
2134
- api_name = 'ping'
2135
- 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"=>{}}
2136
- request(api_name, api_spec, params)
2137
- end
2138
- alias :ping? :ping
2139
-
2140
- # put_script
2141
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", "description"=>"Creates or updates a script."}
2142
- def put_script(params = {})
2143
- api_name = 'put_script'
2144
- 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}}
2145
- request(api_name, api_spec, params)
2146
- end
2147
-
2148
- # rank_eval
2149
- # {"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"}
2150
- def rank_eval(params = {})
2151
- api_name = 'rank_eval'
2152
- 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}}
2153
- request(api_name, api_spec, params)
2154
- end
2155
-
2156
- # reindex
2157
- # {"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."}
2158
- def reindex(params = {})
2159
- api_name = 'reindex'
2160
- 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}}
2161
- request(api_name, api_spec, params)
2162
- end
2163
-
2164
- # reindex_rethrottle
2165
- # {"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."}
2166
- def reindex_rethrottle(params = {})
2167
- api_name = 'reindex_rethrottle'
2168
- 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."}}}
2169
- request(api_name, api_spec, params)
2170
- end
2171
-
2172
- # render_search_template
2173
- # {"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."}
2174
- def render_search_template(params = {})
2175
- api_name = 'render_search_template'
2176
- 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"}}
2177
- request(api_name, api_spec, params)
2178
- end
2179
-
2180
- # rollup.delete_job
2181
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-delete-job.html", "description"=>"Deletes an existing rollup job."}
2182
- def rollup_delete_job(params = {})
2183
- api_name = 'rollup.delete_job'
2184
- 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"}}}]}}
2185
- request(api_name, api_spec, params)
2186
- end
2187
-
2188
- # rollup.get_jobs
2189
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-job.html", "description"=>"Retrieves the configuration, stats, and status of rollup jobs."}
2190
- def rollup_get_jobs(params = {})
2191
- api_name = 'rollup.get_jobs'
2192
- 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"]}]}}
2193
- request(api_name, api_spec, params)
2194
- end
2195
-
2196
- # rollup.get_rollup_caps
2197
- # {"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."}
2198
- def rollup_get_rollup_caps(params = {})
2199
- api_name = 'rollup.get_rollup_caps'
2200
- 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"]}]}}
2201
- request(api_name, api_spec, params)
2202
- end
2203
-
2204
- # rollup.get_rollup_index_caps
2205
- # {"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)."}
2206
- def rollup_get_rollup_index_caps(params = {})
2207
- api_name = 'rollup.get_rollup_index_caps'
2208
- 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."}}}]}}
2209
- request(api_name, api_spec, params)
2210
- end
2211
-
2212
- # rollup.put_job
2213
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-put-job.html", "description"=>"Creates a rollup job."}
2214
- def rollup_put_job(params = {})
2215
- api_name = 'rollup.put_job'
2216
- 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}}
2217
- request(api_name, api_spec, params)
2218
- end
2219
-
2220
- # rollup.rollup
2221
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-rollup.html", "description"=>"Rollup an index"}
2222
- def rollup_rollup(params = {})
2223
- api_name = 'rollup.rollup'
2224
- 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}}
2225
- request(api_name, api_spec, params)
2226
- end
2227
-
2228
- # rollup.rollup_search
2229
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-search.html", "description"=>"Enables searching rolled-up data using the standard query DSL."}
2230
- def rollup_rollup_search(params = {})
2231
- api_name = 'rollup.rollup_search'
2232
- 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}}
2233
- request(api_name, api_spec, params)
2234
- end
2235
-
2236
- # rollup.start_job
2237
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-start-job.html", "description"=>"Starts an existing, stopped rollup job."}
2238
- def rollup_start_job(params = {})
2239
- api_name = 'rollup.start_job'
2240
- 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"}}}]}}
2241
- request(api_name, api_spec, params)
2242
- end
2243
-
2244
- # rollup.stop_job
2245
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-stop-job.html", "description"=>"Stops an existing, started rollup job."}
2246
- def rollup_stop_job(params = {})
2247
- api_name = 'rollup.stop_job'
2248
- 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."}}}
2249
- request(api_name, api_spec, params)
2250
- end
2251
-
2252
- # scripts_painless_execute
2253
- # {"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"}
2254
- def scripts_painless_execute(params = {})
2255
- api_name = 'scripts_painless_execute'
2256
- 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"}}
2257
- request(api_name, api_spec, params)
2258
- end
2259
-
2260
- # scroll
2261
- # {"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."}
2262
- def scroll(params = {})
2263
- api_name = 'scroll'
2264
- 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."}}
2265
- request(api_name, api_spec, params)
2266
- end
2267
-
2268
- # search
2269
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html", "description"=>"Returns results matching a query."}
2270
- def search(params = {})
2271
- api_name = 'search'
2272
- 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"}}
2273
- request(api_name, api_spec, params)
2274
- end
2275
-
2276
- # search_shards
2277
- # {"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."}
2278
- def search_shards(params = {})
2279
- api_name = 'search_shards'
2280
- 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."}}}
2281
- request(api_name, api_spec, params)
2282
- end
2283
-
2284
- # search_template
2285
- # {"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."}
2286
- def search_template(params = {})
2287
- api_name = 'search_template'
2288
- 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}}
2289
- request(api_name, api_spec, params)
2290
- end
2291
-
2292
- # searchable_snapshots.cache_stats
2293
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-apis.html", "description"=>"Retrieve node-level cache statistics about searchable snapshots."}
2294
- def searchable_snapshots_cache_stats(params = {})
2295
- api_name = 'searchable_snapshots.cache_stats'
2296
- 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"}}}]}}
2297
- request(api_name, api_spec, params)
2298
- end
2299
-
2300
- # searchable_snapshots.clear_cache
2301
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-apis.html", "description"=>"Clear the cache of searchable snapshots."}
2302
- def searchable_snapshots_clear_cache(params = {})
2303
- api_name = 'searchable_snapshots.clear_cache'
2304
- 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"}}}
2305
- request(api_name, api_spec, params)
2306
- end
2307
-
2308
- # searchable_snapshots.mount
2309
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-api-mount-snapshot.html", "description"=>"Mount a snapshot as a searchable index."}
2310
- def searchable_snapshots_mount(params = {})
2311
- api_name = 'searchable_snapshots.mount'
2312
- 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}}
2313
- request(api_name, api_spec, params)
2314
- end
2315
-
2316
- # searchable_snapshots.repository_stats
2317
- # {"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."}
2318
- def searchable_snapshots_repository_stats(params = {})
2319
- api_name = 'searchable_snapshots.repository_stats'
2320
- 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"}}}]}}
2321
- request(api_name, api_spec, params)
2322
- end
2323
-
2324
- # searchable_snapshots.stats
2325
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-apis.html", "description"=>"Retrieve shard-level statistics about searchable snapshots."}
2326
- def searchable_snapshots_stats(params = {})
2327
- api_name = 'searchable_snapshots.stats'
2328
- 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"}}}
2329
- request(api_name, api_spec, params)
2330
- end
2331
-
2332
- # security.authenticate
2333
- # {"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."}
2334
- def security_authenticate(params = {})
2335
- api_name = 'security.authenticate'
2336
- 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"=>{}}
2337
- request(api_name, api_spec, params)
2338
- end
2339
-
2340
- # security.change_password
2341
- # {"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."}
2342
- def security_change_password(params = {})
2343
- api_name = 'security.change_password'
2344
- 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}}
2345
- request(api_name, api_spec, params)
2346
- end
2347
-
2348
- # security.clear_api_key_cache
2349
- # {"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."}
2350
- def security_clear_api_key_cache(params = {})
2351
- api_name = 'security.clear_api_key_cache'
2352
- 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"=>{}}
2353
- request(api_name, api_spec, params)
2354
- end
2355
-
2356
- # security.clear_cached_privileges
2357
- # {"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."}
2358
- def security_clear_cached_privileges(params = {})
2359
- api_name = 'security.clear_cached_privileges'
2360
- 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"=>{}}
2361
- request(api_name, api_spec, params)
2362
- end
2363
-
2364
- # security.clear_cached_realms
2365
- # {"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."}
2366
- def security_clear_cached_realms(params = {})
2367
- api_name = 'security.clear_cached_realms'
2368
- 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}}}
2369
- request(api_name, api_spec, params)
2370
- end
2371
-
2372
- # security.clear_cached_roles
2373
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-role-cache.html", "description"=>"Evicts roles from the native role cache."}
2374
- def security_clear_cached_roles(params = {})
2375
- api_name = 'security.clear_cached_roles'
2376
- 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"=>{}}
2377
- request(api_name, api_spec, params)
2378
- end
2379
-
2380
- # security.clear_cached_service_tokens
2381
- # {"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."}
2382
- def security_clear_cached_service_tokens(params = {})
2383
- api_name = 'security.clear_cached_service_tokens'
2384
- 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"=>{}}
2385
- request(api_name, api_spec, params)
2386
- end
2387
-
2388
- # security.create_api_key
2389
- # {"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."}
2390
- def security_create_api_key(params = {})
2391
- api_name = 'security.create_api_key'
2392
- 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}}
2393
- request(api_name, api_spec, params)
2394
- end
2395
-
2396
- # security.create_service_token
2397
- # {"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."}
2398
- def security_create_service_token(params = {})
2399
- api_name = 'security.create_service_token'
2400
- 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."}}}
2401
- request(api_name, api_spec, params)
2402
- end
2403
-
2404
- # security.delete_privileges
2405
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-privilege.html", "description"=>"Removes application privileges."}
2406
- def security_delete_privileges(params = {})
2407
- api_name = 'security.delete_privileges'
2408
- 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."}}}
2409
- request(api_name, api_spec, params)
2410
- end
2411
-
2412
- # security.delete_role
2413
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role.html", "description"=>"Removes roles in the native realm."}
2414
- def security_delete_role(params = {})
2415
- api_name = 'security.delete_role'
2416
- 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."}}}
2417
- request(api_name, api_spec, params)
2418
- end
2419
-
2420
- # security.delete_role_mapping
2421
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role-mapping.html", "description"=>"Removes role mappings."}
2422
- def security_delete_role_mapping(params = {})
2423
- api_name = 'security.delete_role_mapping'
2424
- 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."}}}
2425
- request(api_name, api_spec, params)
2426
- end
2427
-
2428
- # security.delete_service_token
2429
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-service-token.html", "description"=>"Deletes a service account token."}
2430
- def security_delete_service_token(params = {})
2431
- api_name = 'security.delete_service_token'
2432
- 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."}}}
2433
- request(api_name, api_spec, params)
2434
- end
2435
-
2436
- # security.delete_user
2437
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-user.html", "description"=>"Deletes users from the native realm."}
2438
- def security_delete_user(params = {})
2439
- api_name = 'security.delete_user'
2440
- 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."}}}
2441
- request(api_name, api_spec, params)
2442
- end
2443
-
2444
- # security.disable_user
2445
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-disable-user.html", "description"=>"Disables users in the native realm."}
2446
- def security_disable_user(params = {})
2447
- api_name = 'security.disable_user'
2448
- 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."}}}
2449
- request(api_name, api_spec, params)
2450
- end
2451
-
2452
- # security.enable_user
2453
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-enable-user.html", "description"=>"Enables users in the native realm."}
2454
- def security_enable_user(params = {})
2455
- api_name = 'security.enable_user'
2456
- 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."}}}
2457
- request(api_name, api_spec, params)
2458
- end
2459
-
2460
- # security.get_api_key
2461
- # {"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."}
2462
- def security_get_api_key(params = {})
2463
- api_name = 'security.get_api_key'
2464
- 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"}}}
2465
- request(api_name, api_spec, params)
2466
- end
2467
-
2468
- # security.get_builtin_privileges
2469
- # {"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."}
2470
- def security_get_builtin_privileges(params = {})
2471
- api_name = 'security.get_builtin_privileges'
2472
- 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"=>{}}
2473
- request(api_name, api_spec, params)
2474
- end
2475
-
2476
- # security.get_privileges
2477
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-privileges.html", "description"=>"Retrieves application privileges."}
2478
- def security_get_privileges(params = {})
2479
- api_name = 'security.get_privileges'
2480
- 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"=>{}}
2481
- request(api_name, api_spec, params)
2482
- end
2483
-
2484
- # security.get_role
2485
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html", "description"=>"Retrieves roles in the native realm."}
2486
- def security_get_role(params = {})
2487
- api_name = 'security.get_role'
2488
- 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"=>{}}
2489
- request(api_name, api_spec, params)
2490
- end
2491
-
2492
- # security.get_role_mapping
2493
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role-mapping.html", "description"=>"Retrieves role mappings."}
2494
- def security_get_role_mapping(params = {})
2495
- api_name = 'security.get_role_mapping'
2496
- 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"=>{}}
2497
- request(api_name, api_spec, params)
2498
- end
2499
-
2500
- # security.get_service_accounts
2501
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-accounts.html", "description"=>"Retrieves information about service accounts."}
2502
- def security_get_service_accounts(params = {})
2503
- api_name = 'security.get_service_accounts'
2504
- 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"=>{}}
2505
- request(api_name, api_spec, params)
2506
- end
2507
-
2508
- # security.get_service_credentials
2509
- # {"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."}
2510
- def security_get_service_credentials(params = {})
2511
- api_name = 'security.get_service_credentials'
2512
- 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"=>{}}
2513
- request(api_name, api_spec, params)
2514
- end
2515
-
2516
- # security.get_token
2517
- # {"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."}
2518
- def security_get_token(params = {})
2519
- api_name = 'security.get_token'
2520
- 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}}
2521
- request(api_name, api_spec, params)
2522
- end
2523
-
2524
- # security.get_user
2525
- # {"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."}
2526
- def security_get_user(params = {})
2527
- api_name = 'security.get_user'
2528
- 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"=>{}}
2529
- request(api_name, api_spec, params)
2530
- end
2531
-
2532
- # security.get_user_privileges
2533
- # {"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."}
2534
- def security_get_user_privileges(params = {})
2535
- api_name = 'security.get_user_privileges'
2536
- 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"=>{}}
2537
- request(api_name, api_spec, params)
2538
- end
2539
-
2540
- # security.grant_api_key
2541
- # {"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."}
2542
- def security_grant_api_key(params = {})
2543
- api_name = 'security.grant_api_key'
2544
- 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}}
2545
- request(api_name, api_spec, params)
2546
- end
2547
-
2548
- # security.has_privileges
2549
- # {"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."}
2550
- def security_has_privileges(params = {})
2551
- api_name = 'security.has_privileges'
2552
- 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}}
2553
- request(api_name, api_spec, params)
2554
- end
2555
-
2556
- # security.invalidate_api_key
2557
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-api-key.html", "description"=>"Invalidates one or more API keys."}
2558
- def security_invalidate_api_key(params = {})
2559
- api_name = 'security.invalidate_api_key'
2560
- 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}}
2561
- request(api_name, api_spec, params)
2562
- end
2563
-
2564
- # security.invalidate_token
2565
- # {"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."}
2566
- def security_invalidate_token(params = {})
2567
- api_name = 'security.invalidate_token'
2568
- 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}}
2569
- request(api_name, api_spec, params)
2570
- end
2571
-
2572
- # security.put_privileges
2573
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-privileges.html", "description"=>"Adds or updates application privileges."}
2574
- def security_put_privileges(params = {})
2575
- api_name = 'security.put_privileges'
2576
- 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}}
2577
- request(api_name, api_spec, params)
2578
- end
2579
-
2580
- # security.put_role
2581
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html", "description"=>"Adds and updates roles in the native realm."}
2582
- def security_put_role(params = {})
2583
- api_name = 'security.put_role'
2584
- 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}}
2585
- request(api_name, api_spec, params)
2586
- end
2587
-
2588
- # security.put_role_mapping
2589
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role-mapping.html", "description"=>"Creates and updates role mappings."}
2590
- def security_put_role_mapping(params = {})
2591
- api_name = 'security.put_role_mapping'
2592
- 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}}
2593
- request(api_name, api_spec, params)
2594
- end
2595
-
2596
- # security.put_user
2597
- # {"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."}
2598
- def security_put_user(params = {})
2599
- api_name = 'security.put_user'
2600
- 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}}
2601
- request(api_name, api_spec, params)
2602
- end
2603
-
2604
- # security.saml_authenticate
2605
- # {"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"}
2606
- def security_saml_authenticate(params = {})
2607
- api_name = 'security.saml_authenticate'
2608
- 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}}
2609
- request(api_name, api_spec, params)
2610
- end
2611
-
2612
- # security.saml_complete_logout
2613
- # {"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"}
2614
- def security_saml_complete_logout(params = {})
2615
- api_name = 'security.saml_complete_logout'
2616
- 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}}
2617
- request(api_name, api_spec, params)
2618
- end
2619
-
2620
- # security.saml_invalidate
2621
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-invalidate.html", "description"=>"Consumes a SAML LogoutRequest"}
2622
- def security_saml_invalidate(params = {})
2623
- api_name = 'security.saml_invalidate'
2624
- 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}}
2625
- request(api_name, api_spec, params)
2626
- end
2627
-
2628
- # security.saml_logout
2629
- # {"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"}
2630
- def security_saml_logout(params = {})
2631
- api_name = 'security.saml_logout'
2632
- 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}}
2633
- request(api_name, api_spec, params)
2634
- end
2635
-
2636
- # security.saml_prepare_authentication
2637
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-prepare-authentication.html", "description"=>"Creates a SAML authentication request"}
2638
- def security_saml_prepare_authentication(params = {})
2639
- api_name = 'security.saml_prepare_authentication'
2640
- 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}}
2641
- request(api_name, api_spec, params)
2642
- end
2643
-
2644
- # security.saml_service_provider_metadata
2645
- # {"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"}
2646
- def security_saml_service_provider_metadata(params = {})
2647
- api_name = 'security.saml_service_provider_metadata'
2648
- 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"}}}]}}
2649
- request(api_name, api_spec, params)
2650
- end
2651
-
2652
- # shutdown.delete_node
2653
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current", "description"=>"Removes a node from the shutdown list"}
2654
- def shutdown_delete_node(params = {})
2655
- api_name = 'shutdown.delete_node'
2656
- 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"=>{}}
2657
- request(api_name, api_spec, params)
2658
- end
2659
-
2660
- # shutdown.get_node
2661
- # {"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"}
2662
- def shutdown_get_node(params = {})
2663
- api_name = 'shutdown.get_node'
2664
- 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"=>{}}
2665
- request(api_name, api_spec, params)
2666
- end
2667
-
2668
- # shutdown.put_node
2669
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current", "description"=>"Adds a node to be shut down"}
2670
- def shutdown_put_node(params = {})
2671
- api_name = 'shutdown.put_node'
2672
- 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}}
2673
- request(api_name, api_spec, params)
2674
- end
2675
-
2676
- # slm.delete_lifecycle
2677
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-delete-policy.html", "description"=>"Deletes an existing snapshot lifecycle policy."}
2678
- def slm_delete_lifecycle(params = {})
2679
- api_name = 'slm.delete_lifecycle'
2680
- 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"=>{}}
2681
- request(api_name, api_spec, params)
2682
- end
2683
-
2684
- # slm.execute_lifecycle
2685
- # {"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."}
2686
- def slm_execute_lifecycle(params = {})
2687
- api_name = 'slm.execute_lifecycle'
2688
- 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"=>{}}
2689
- request(api_name, api_spec, params)
2690
- end
2691
-
2692
- # slm.execute_retention
2693
- # {"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."}
2694
- def slm_execute_retention(params = {})
2695
- api_name = 'slm.execute_retention'
2696
- 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"=>{}}
2697
- request(api_name, api_spec, params)
2698
- end
2699
-
2700
- # slm.get_lifecycle
2701
- # {"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."}
2702
- def slm_get_lifecycle(params = {})
2703
- api_name = 'slm.get_lifecycle'
2704
- 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"=>{}}
2705
- request(api_name, api_spec, params)
2706
- end
2707
-
2708
- # slm.get_stats
2709
- # {"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."}
2710
- def slm_get_stats(params = {})
2711
- api_name = 'slm.get_stats'
2712
- 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"=>{}}
2713
- request(api_name, api_spec, params)
2714
- end
2715
-
2716
- # slm.get_status
2717
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get-status.html", "description"=>"Retrieves the status of snapshot lifecycle management (SLM)."}
2718
- def slm_get_status(params = {})
2719
- api_name = 'slm.get_status'
2720
- 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"=>{}}
2721
- request(api_name, api_spec, params)
2722
- end
2723
-
2724
- # slm.put_lifecycle
2725
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-put-policy.html", "description"=>"Creates or updates a snapshot lifecycle policy."}
2726
- def slm_put_lifecycle(params = {})
2727
- api_name = 'slm.put_lifecycle'
2728
- 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"}}
2729
- request(api_name, api_spec, params)
2730
- end
2731
-
2732
- # slm.start
2733
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-start.html", "description"=>"Turns on snapshot lifecycle management (SLM)."}
2734
- def slm_start(params = {})
2735
- api_name = 'slm.start'
2736
- 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"=>{}}
2737
- request(api_name, api_spec, params)
2738
- end
2739
-
2740
- # slm.stop
2741
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-stop.html", "description"=>"Turns off snapshot lifecycle management (SLM)."}
2742
- def slm_stop(params = {})
2743
- api_name = 'slm.stop'
2744
- 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"=>{}}
2745
- request(api_name, api_spec, params)
2746
- end
2747
-
2748
- # snapshot.cleanup_repository
2749
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/clean-up-snapshot-repo-api.html", "description"=>"Removes stale data from repository."}
2750
- def snapshot_cleanup_repository(params = {})
2751
- api_name = 'snapshot.cleanup_repository'
2752
- 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"}}}
2753
- request(api_name, api_spec, params)
2754
- end
2755
-
2756
- # snapshot.clone
2757
- # {"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."}
2758
- def snapshot_clone(params = {})
2759
- api_name = 'snapshot.clone'
2760
- 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}}
2761
- request(api_name, api_spec, params)
2762
- end
2763
-
2764
- # snapshot.create
2765
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "description"=>"Creates a snapshot in a repository."}
2766
- def snapshot_create(params = {})
2767
- api_name = 'snapshot.create'
2768
- 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}}
2769
- request(api_name, api_spec, params)
2770
- end
2771
-
2772
- # snapshot.create_repository
2773
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "description"=>"Creates a repository."}
2774
- def snapshot_create_repository(params = {})
2775
- api_name = 'snapshot.create_repository'
2776
- 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}}
2777
- request(api_name, api_spec, params)
2778
- end
2779
-
2780
- # snapshot.delete
2781
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "description"=>"Deletes a snapshot."}
2782
- def snapshot_delete(params = {})
2783
- api_name = 'snapshot.delete'
2784
- 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"}}}
2785
- request(api_name, api_spec, params)
2786
- end
2787
-
2788
- # snapshot.delete_repository
2789
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "description"=>"Deletes a repository."}
2790
- def snapshot_delete_repository(params = {})
2791
- api_name = 'snapshot.delete_repository'
2792
- 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"}}}
2793
- request(api_name, api_spec, params)
2794
- end
2795
-
2796
- # snapshot.get
2797
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "description"=>"Returns information about a snapshot."}
2798
- def snapshot_get(params = {})
2799
- api_name = 'snapshot.get'
2800
- 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"}}}
2801
- request(api_name, api_spec, params)
2802
- end
2803
-
2804
- # snapshot.get_repository
2805
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "description"=>"Returns information about a repository."}
2806
- def snapshot_get_repository(params = {})
2807
- api_name = 'snapshot.get_repository'
2808
- 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)"}}}
2809
- request(api_name, api_spec, params)
2810
- end
2811
-
2812
- # snapshot.repository_analyze
2813
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "description"=>"Analyzes a repository for correctness and performance"}
2814
- def snapshot_repository_analyze(params = {})
2815
- api_name = 'snapshot.repository_analyze'
2816
- 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'."}}}
2817
- request(api_name, api_spec, params)
2818
- end
2819
-
2820
- # snapshot.restore
2821
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "description"=>"Restores a snapshot."}
2822
- def snapshot_restore(params = {})
2823
- api_name = 'snapshot.restore'
2824
- 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}}
2825
- request(api_name, api_spec, params)
2826
- end
2827
-
2828
- # snapshot.status
2829
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "description"=>"Returns information about the status of a snapshot."}
2830
- def snapshot_status(params = {})
2831
- api_name = 'snapshot.status'
2832
- 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"}}}
2833
- request(api_name, api_spec, params)
2834
- end
2835
-
2836
- # snapshot.verify_repository
2837
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "description"=>"Verifies a repository."}
2838
- def snapshot_verify_repository(params = {})
2839
- api_name = 'snapshot.verify_repository'
2840
- 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"}}}
2841
- request(api_name, api_spec, params)
2842
- end
2843
-
2844
- # sql.clear_cursor
2845
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-sql-cursor-api.html", "description"=>"Clears the SQL cursor"}
2846
- def sql_clear_cursor(params = {})
2847
- api_name = 'sql.clear_cursor'
2848
- 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}}
2849
- request(api_name, api_spec, params)
2850
- end
2851
-
2852
- # sql.delete_async
2853
- # {"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."}
2854
- def sql_delete_async(params = {})
2855
- api_name = 'sql.delete_async'
2856
- 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"}}}]}}
2857
- request(api_name, api_spec, params)
2858
- end
2859
-
2860
- # sql.get_async
2861
- # {"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"}
2862
- def sql_get_async(params = {})
2863
- api_name = 'sql.get_async'
2864
- 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"}}}
2865
- request(api_name, api_spec, params)
2866
- end
2867
-
2868
- # sql.get_async_status
2869
- # {"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"}
2870
- def sql_get_async_status(params = {})
2871
- api_name = 'sql.get_async_status'
2872
- 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"}}}]}}
2873
- request(api_name, api_spec, params)
2874
- end
2875
-
2876
- # sql.query
2877
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-search-api.html", "description"=>"Executes a SQL request"}
2878
- def sql_query(params = {})
2879
- api_name = 'sql.query'
2880
- 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}}
2881
- request(api_name, api_spec, params)
2882
- end
2883
-
2884
- # sql.translate
2885
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-translate-api.html", "description"=>"Translates SQL into Elasticsearch queries"}
2886
- def sql_translate(params = {})
2887
- api_name = 'sql.translate'
2888
- 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}}
2889
- request(api_name, api_spec, params)
2890
- end
2891
-
2892
- # ssl.certificates
2893
- # {"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."}
2894
- def ssl_certificates(params = {})
2895
- api_name = 'ssl.certificates'
2896
- 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"=>{}}
2897
- request(api_name, api_spec, params)
2898
- end
2899
-
2900
- # tasks.cancel
2901
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html", "description"=>"Cancels a task, if it can be cancelled through an API."}
2902
- def tasks_cancel(params = {})
2903
- api_name = 'tasks.cancel'
2904
- 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"}}}
2905
- request(api_name, api_spec, params)
2906
- end
2907
-
2908
- # tasks.get
2909
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html", "description"=>"Returns information about a task."}
2910
- def tasks_get(params = {})
2911
- api_name = 'tasks.get'
2912
- 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"}}}
2913
- request(api_name, api_spec, params)
2914
- end
2915
-
2916
- # tasks.list
2917
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html", "description"=>"Returns a list of tasks."}
2918
- def tasks_list(params = {})
2919
- api_name = 'tasks.list'
2920
- 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"}}}
2921
- request(api_name, api_spec, params)
2922
- end
2923
-
2924
- # terms_enum
2925
- # {"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."}
2926
- def terms_enum(params = {})
2927
- api_name = 'terms_enum'
2928
- 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"}}
2929
- request(api_name, api_spec, params)
2930
- end
2931
-
2932
- # termvectors
2933
- # {"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."}
2934
- def termvectors(params = {})
2935
- api_name = 'termvectors'
2936
- 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}}
2937
- request(api_name, api_spec, params)
2938
- end
2939
-
2940
- # text_structure.find_structure
2941
- # {"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."}
2942
- def text_structure_find_structure(params = {})
2943
- api_name = 'text_structure.find_structure'
2944
- 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"}}
2945
- request(api_name, api_spec, params)
2946
- end
2947
-
2948
- # transform.delete_transform
2949
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html", "description"=>"Deletes an existing transform."}
2950
- def transform_delete_transform(params = {})
2951
- api_name = 'transform.delete_transform'
2952
- 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."}}}
2953
- request(api_name, api_spec, params)
2954
- end
2955
-
2956
- # transform.get_transform
2957
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html", "description"=>"Retrieves configuration information for transforms."}
2958
- def transform_get_transform(params = {})
2959
- api_name = 'transform.get_transform'
2960
- 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"}}}
2961
- request(api_name, api_spec, params)
2962
- end
2963
-
2964
- # transform.get_transform_stats
2965
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-stats.html", "description"=>"Retrieves usage information for transforms."}
2966
- def transform_get_transform_stats(params = {})
2967
- api_name = 'transform.get_transform_stats'
2968
- 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)"}}}
2969
- request(api_name, api_spec, params)
2970
- end
2971
-
2972
- # transform.preview_transform
2973
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html", "description"=>"Previews a transform."}
2974
- def transform_preview_transform(params = {})
2975
- api_name = 'transform.preview_transform'
2976
- 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}}
2977
- request(api_name, api_spec, params)
2978
- end
2979
-
2980
- # transform.put_transform
2981
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html", "description"=>"Instantiates a transform."}
2982
- def transform_put_transform(params = {})
2983
- api_name = 'transform.put_transform'
2984
- 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}}
2985
- request(api_name, api_spec, params)
2986
- end
2987
-
2988
- # transform.start_transform
2989
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html", "description"=>"Starts one or more transforms."}
2990
- def transform_start_transform(params = {})
2991
- api_name = 'transform.start_transform'
2992
- 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"}}}
2993
- request(api_name, api_spec, params)
2994
- end
2995
-
2996
- # transform.stop_transform
2997
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html", "description"=>"Stops one or more transforms."}
2998
- def transform_stop_transform(params = {})
2999
- api_name = 'transform.stop_transform'
3000
- 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"}}}
3001
- request(api_name, api_spec, params)
3002
- end
3003
-
3004
- # transform.update_transform
3005
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html", "description"=>"Updates certain properties of a transform."}
3006
- def transform_update_transform(params = {})
3007
- api_name = 'transform.update_transform'
3008
- 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}}
3009
- request(api_name, api_spec, params)
3010
- end
3011
-
3012
- # update
3013
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html", "description"=>"Updates a document with a script or partial document."}
3014
- def update(params = {})
3015
- api_name = 'update'
3016
- 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}}
3017
- request(api_name, api_spec, params)
3018
- end
3019
-
3020
- # update_by_query
3021
- # {"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."}
3022
- def update_by_query(params = {})
3023
- api_name = 'update_by_query'
3024
- 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"}}
3025
- request(api_name, api_spec, params)
3026
- end
3027
-
3028
- # update_by_query_rethrottle
3029
- # {"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."}
3030
- def update_by_query_rethrottle(params = {})
3031
- api_name = 'update_by_query_rethrottle'
3032
- 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."}}}
3033
- request(api_name, api_spec, params)
3034
- end
3035
-
3036
- # watcher.ack_watch
3037
- # {"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."}
3038
- def watcher_ack_watch(params = {})
3039
- api_name = 'watcher.ack_watch'
3040
- 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"}}}]}}
3041
- request(api_name, api_spec, params)
3042
- end
3043
-
3044
- # watcher.activate_watch
3045
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-activate-watch.html", "description"=>"Activates a currently inactive watch."}
3046
- def watcher_activate_watch(params = {})
3047
- api_name = 'watcher.activate_watch'
3048
- 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"}}}]}}
3049
- request(api_name, api_spec, params)
3050
- end
3051
-
3052
- # watcher.deactivate_watch
3053
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-deactivate-watch.html", "description"=>"Deactivates a currently active watch."}
3054
- def watcher_deactivate_watch(params = {})
3055
- api_name = 'watcher.deactivate_watch'
3056
- 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"}}}]}}
3057
- request(api_name, api_spec, params)
3058
- end
3059
-
3060
- # watcher.delete_watch
3061
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-delete-watch.html", "description"=>"Removes a watch from Watcher."}
3062
- def watcher_delete_watch(params = {})
3063
- api_name = 'watcher.delete_watch'
3064
- 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"}}}]}}
3065
- request(api_name, api_spec, params)
3066
- end
3067
-
3068
- # watcher.execute_watch
3069
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-execute-watch.html", "description"=>"Forces the execution of a stored watch."}
3070
- def watcher_execute_watch(params = {})
3071
- api_name = 'watcher.execute_watch'
3072
- 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}}
3073
- request(api_name, api_spec, params)
3074
- end
3075
-
3076
- # watcher.get_watch
3077
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-get-watch.html", "description"=>"Retrieves a watch by its ID."}
3078
- def watcher_get_watch(params = {})
3079
- api_name = 'watcher.get_watch'
3080
- 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"=>{}}
3081
- request(api_name, api_spec, params)
3082
- end
3083
-
3084
- # watcher.put_watch
3085
- # {"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."}
3086
- def watcher_put_watch(params = {})
3087
- api_name = 'watcher.put_watch'
3088
- 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}}
3089
- request(api_name, api_spec, params)
3090
- end
3091
-
3092
- # watcher.query_watches
3093
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-query-watches.html", "description"=>"Retrieves stored watches."}
3094
- def watcher_query_watches(params = {})
3095
- api_name = 'watcher.query_watches'
3096
- 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}}
3097
- request(api_name, api_spec, params)
3098
- end
3099
-
3100
- # watcher.start
3101
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-start.html", "description"=>"Starts Watcher if it is not already running."}
3102
- def watcher_start(params = {})
3103
- api_name = 'watcher.start'
3104
- 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"=>{}}
3105
- request(api_name, api_spec, params)
3106
- end
3107
-
3108
- # watcher.stats
3109
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stats.html", "description"=>"Retrieves the current Watcher metrics."}
3110
- def watcher_stats(params = {})
3111
- api_name = 'watcher.stats'
3112
- 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}}}
3113
- request(api_name, api_spec, params)
3114
- end
3115
-
3116
- # watcher.stop
3117
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stop.html", "description"=>"Stops Watcher if it is running."}
3118
- def watcher_stop(params = {})
3119
- api_name = 'watcher.stop'
3120
- 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"=>{}}
3121
- request(api_name, api_spec, params)
3122
- end
3123
-
3124
- # xpack.info
3125
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/info-api.html", "description"=>"Retrieves information about the installed X-Pack features."}
3126
- def xpack_info(params = {})
3127
- api_name = 'xpack.info'
3128
- 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)"}}}
3129
- request(api_name, api_spec, params)
3130
- end
3131
-
3132
- # xpack.usage
3133
- # {"url"=>"https://www.elastic.co/guide/en/elasticsearch/reference/current/usage-api.html", "description"=>"Retrieves usage information about the installed X-Pack features."}
3134
- def xpack_usage(params = {})
3135
- api_name = 'xpack.usage'
3136
- 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"}}}
3137
- request(api_name, api_spec, params)
3138
- end
3139
- end
3140
- end
3141
- end