elasticsearch-serverless 0.0.8.20231031.pre

Sign up to get free protection for your applications and to get access to all the features.
Files changed (211) hide show
  1. checksums.yaml +7 -0
  2. data/lib/elasticsearch-serverless/api/async_search/delete.rb +53 -0
  3. data/lib/elasticsearch-serverless/api/async_search/get.rb +56 -0
  4. data/lib/elasticsearch-serverless/api/async_search/status.rb +53 -0
  5. data/lib/elasticsearch-serverless/api/async_search/submit.rb +102 -0
  6. data/lib/elasticsearch-serverless/api/bulk.rb +72 -0
  7. data/lib/elasticsearch-serverless/api/cat/aliases.rb +64 -0
  8. data/lib/elasticsearch-serverless/api/cat/component_templates.rb +62 -0
  9. data/lib/elasticsearch-serverless/api/cat/count.rb +63 -0
  10. data/lib/elasticsearch-serverless/api/cat/help.rb +55 -0
  11. data/lib/elasticsearch-serverless/api/cat/indices.rb +69 -0
  12. data/lib/elasticsearch-serverless/api/cat/ml_data_frame_analytics.rb +67 -0
  13. data/lib/elasticsearch-serverless/api/cat/ml_datafeeds.rb +66 -0
  14. data/lib/elasticsearch-serverless/api/cat/ml_jobs.rb +67 -0
  15. data/lib/elasticsearch-serverless/api/cat/ml_trained_models.rb +68 -0
  16. data/lib/elasticsearch-serverless/api/cat/transforms.rb +68 -0
  17. data/lib/elasticsearch-serverless/api/clear_scroll.rb +67 -0
  18. data/lib/elasticsearch-serverless/api/close_point_in_time.rb +47 -0
  19. data/lib/elasticsearch-serverless/api/cluster/delete_component_template.rb +55 -0
  20. data/lib/elasticsearch-serverless/api/cluster/exists_component_template.rb +57 -0
  21. data/lib/elasticsearch-serverless/api/cluster/get_component_template.rb +59 -0
  22. data/lib/elasticsearch-serverless/api/cluster/info.rb +53 -0
  23. data/lib/elasticsearch-serverless/api/cluster/put_component_template.rb +57 -0
  24. data/lib/elasticsearch-serverless/api/count.rb +73 -0
  25. data/lib/elasticsearch-serverless/api/create.rb +51 -0
  26. data/lib/elasticsearch-serverless/api/delete.rb +71 -0
  27. data/lib/elasticsearch-serverless/api/delete_by_query.rb +82 -0
  28. data/lib/elasticsearch-serverless/api/delete_script.rb +53 -0
  29. data/lib/elasticsearch-serverless/api/enrich/delete_policy.rb +53 -0
  30. data/lib/elasticsearch-serverless/api/enrich/execute_policy.rb +54 -0
  31. data/lib/elasticsearch-serverless/api/enrich/get_policy.rb +55 -0
  32. data/lib/elasticsearch-serverless/api/enrich/put_policy.rb +55 -0
  33. data/lib/elasticsearch-serverless/api/enrich/stats.rb +48 -0
  34. data/lib/elasticsearch-serverless/api/eql/delete.rb +53 -0
  35. data/lib/elasticsearch-serverless/api/eql/get.rb +55 -0
  36. data/lib/elasticsearch-serverless/api/eql/get_status.rb +53 -0
  37. data/lib/elasticsearch-serverless/api/eql/search.rb +61 -0
  38. data/lib/elasticsearch-serverless/api/exists.rb +67 -0
  39. data/lib/elasticsearch-serverless/api/exists_source.rb +66 -0
  40. data/lib/elasticsearch-serverless/api/explain.rb +73 -0
  41. data/lib/elasticsearch-serverless/api/field_caps.rb +66 -0
  42. data/lib/elasticsearch-serverless/api/get.rb +73 -0
  43. data/lib/elasticsearch-serverless/api/get_script.rb +52 -0
  44. data/lib/elasticsearch-serverless/api/get_source.rb +65 -0
  45. data/lib/elasticsearch-serverless/api/graph/explore.rb +61 -0
  46. data/lib/elasticsearch-serverless/api/index.rb +71 -0
  47. data/lib/elasticsearch-serverless/api/indices/add_block.rb +62 -0
  48. data/lib/elasticsearch-serverless/api/indices/analyze.rb +61 -0
  49. data/lib/elasticsearch-serverless/api/indices/create.rb +57 -0
  50. data/lib/elasticsearch-serverless/api/indices/create_data_stream.rb +53 -0
  51. data/lib/elasticsearch-serverless/api/indices/data_streams_stats.rb +56 -0
  52. data/lib/elasticsearch-serverless/api/indices/delete.rb +66 -0
  53. data/lib/elasticsearch-serverless/api/indices/delete_alias.rb +61 -0
  54. data/lib/elasticsearch-serverless/api/indices/delete_data_lifecycle.rb +56 -0
  55. data/lib/elasticsearch-serverless/api/indices/delete_data_stream.rb +54 -0
  56. data/lib/elasticsearch-serverless/api/indices/delete_index_template.rb +55 -0
  57. data/lib/elasticsearch-serverless/api/indices/exists.rb +61 -0
  58. data/lib/elasticsearch-serverless/api/indices/exists_alias.rb +66 -0
  59. data/lib/elasticsearch-serverless/api/indices/exists_index_template.rb +56 -0
  60. data/lib/elasticsearch-serverless/api/indices/explain_data_lifecycle.rb +55 -0
  61. data/lib/elasticsearch-serverless/api/indices/get.rb +61 -0
  62. data/lib/elasticsearch-serverless/api/indices/get_alias.rb +66 -0
  63. data/lib/elasticsearch-serverless/api/indices/get_data_lifecycle.rb +55 -0
  64. data/lib/elasticsearch-serverless/api/indices/get_data_stream.rb +57 -0
  65. data/lib/elasticsearch-serverless/api/indices/get_index_template.rb +59 -0
  66. data/lib/elasticsearch-serverless/api/indices/get_mapping.rb +60 -0
  67. data/lib/elasticsearch-serverless/api/indices/get_settings.rb +69 -0
  68. data/lib/elasticsearch-serverless/api/indices/migrate_to_data_stream.rb +53 -0
  69. data/lib/elasticsearch-serverless/api/indices/modify_data_stream.rb +51 -0
  70. data/lib/elasticsearch-serverless/api/indices/put_alias.rb +62 -0
  71. data/lib/elasticsearch-serverless/api/indices/put_data_lifecycle.rb +57 -0
  72. data/lib/elasticsearch-serverless/api/indices/put_index_template.rb +56 -0
  73. data/lib/elasticsearch-serverless/api/indices/put_mapping.rb +61 -0
  74. data/lib/elasticsearch-serverless/api/indices/put_settings.rb +65 -0
  75. data/lib/elasticsearch-serverless/api/indices/put_template.rb +60 -0
  76. data/lib/elasticsearch-serverless/api/indices/refresh.rb +58 -0
  77. data/lib/elasticsearch-serverless/api/indices/resolve_index.rb +54 -0
  78. data/lib/elasticsearch-serverless/api/indices/rollover.rb +66 -0
  79. data/lib/elasticsearch-serverless/api/indices/simulate_index_template.rb +57 -0
  80. data/lib/elasticsearch-serverless/api/indices/simulate_template.rb +59 -0
  81. data/lib/elasticsearch-serverless/api/indices/update_aliases.rb +53 -0
  82. data/lib/elasticsearch-serverless/api/indices/validate_query.rb +73 -0
  83. data/lib/elasticsearch-serverless/api/info.rb +46 -0
  84. data/lib/elasticsearch-serverless/api/ingest/delete_pipeline.rb +55 -0
  85. data/lib/elasticsearch-serverless/api/ingest/get_pipeline.rb +57 -0
  86. data/lib/elasticsearch-serverless/api/ingest/processor_grok.rb +48 -0
  87. data/lib/elasticsearch-serverless/api/ingest/put_pipeline.rb +58 -0
  88. data/lib/elasticsearch-serverless/api/ingest/simulate.rb +59 -0
  89. data/lib/elasticsearch-serverless/api/license/get.rb +50 -0
  90. data/lib/elasticsearch-serverless/api/logstash/delete_pipeline.rb +53 -0
  91. data/lib/elasticsearch-serverless/api/logstash/get_pipeline.rb +55 -0
  92. data/lib/elasticsearch-serverless/api/logstash/put_pipeline.rb +55 -0
  93. data/lib/elasticsearch-serverless/api/machine_learning/close_job.rb +57 -0
  94. data/lib/elasticsearch-serverless/api/machine_learning/delete_calendar.rb +53 -0
  95. data/lib/elasticsearch-serverless/api/machine_learning/delete_calendar_event.rb +57 -0
  96. data/lib/elasticsearch-serverless/api/machine_learning/delete_calendar_job.rb +57 -0
  97. data/lib/elasticsearch-serverless/api/machine_learning/delete_data_frame_analytics.rb +55 -0
  98. data/lib/elasticsearch-serverless/api/machine_learning/delete_datafeed.rb +54 -0
  99. data/lib/elasticsearch-serverless/api/machine_learning/delete_filter.rb +53 -0
  100. data/lib/elasticsearch-serverless/api/machine_learning/delete_job.rb +56 -0
  101. data/lib/elasticsearch-serverless/api/machine_learning/delete_trained_model.rb +54 -0
  102. data/lib/elasticsearch-serverless/api/machine_learning/delete_trained_model_alias.rb +57 -0
  103. data/lib/elasticsearch-serverless/api/machine_learning/estimate_model_memory.rb +51 -0
  104. data/lib/elasticsearch-serverless/api/machine_learning/evaluate_data_frame.rb +51 -0
  105. data/lib/elasticsearch-serverless/api/machine_learning/flush_job.rb +59 -0
  106. data/lib/elasticsearch-serverless/api/machine_learning/get_calendar_events.rb +58 -0
  107. data/lib/elasticsearch-serverless/api/machine_learning/get_calendars.rb +63 -0
  108. data/lib/elasticsearch-serverless/api/machine_learning/get_data_frame_analytics.rb +59 -0
  109. data/lib/elasticsearch-serverless/api/machine_learning/get_data_frame_analytics_stats.rb +59 -0
  110. data/lib/elasticsearch-serverless/api/machine_learning/get_datafeed_stats.rb +56 -0
  111. data/lib/elasticsearch-serverless/api/machine_learning/get_datafeeds.rb +57 -0
  112. data/lib/elasticsearch-serverless/api/machine_learning/get_filters.rb +57 -0
  113. data/lib/elasticsearch-serverless/api/machine_learning/get_job_stats.rb +56 -0
  114. data/lib/elasticsearch-serverless/api/machine_learning/get_jobs.rb +57 -0
  115. data/lib/elasticsearch-serverless/api/machine_learning/get_overall_buckets.rb +66 -0
  116. data/lib/elasticsearch-serverless/api/machine_learning/get_trained_models.rb +62 -0
  117. data/lib/elasticsearch-serverless/api/machine_learning/get_trained_models_stats.rb +58 -0
  118. data/lib/elasticsearch-serverless/api/machine_learning/infer_trained_model.rb +63 -0
  119. data/lib/elasticsearch-serverless/api/machine_learning/open_job.rb +55 -0
  120. data/lib/elasticsearch-serverless/api/machine_learning/post_calendar_events.rb +55 -0
  121. data/lib/elasticsearch-serverless/api/machine_learning/preview_data_frame_analytics.rb +61 -0
  122. data/lib/elasticsearch-serverless/api/machine_learning/preview_datafeed.rb +63 -0
  123. data/lib/elasticsearch-serverless/api/machine_learning/put_calendar.rb +54 -0
  124. data/lib/elasticsearch-serverless/api/machine_learning/put_calendar_job.rb +57 -0
  125. data/lib/elasticsearch-serverless/api/machine_learning/put_data_frame_analytics.rb +55 -0
  126. data/lib/elasticsearch-serverless/api/machine_learning/put_datafeed.rb +59 -0
  127. data/lib/elasticsearch-serverless/api/machine_learning/put_filter.rb +55 -0
  128. data/lib/elasticsearch-serverless/api/machine_learning/put_job.rb +55 -0
  129. data/lib/elasticsearch-serverless/api/machine_learning/put_trained_model.rb +56 -0
  130. data/lib/elasticsearch-serverless/api/machine_learning/put_trained_model_alias.rb +58 -0
  131. data/lib/elasticsearch-serverless/api/machine_learning/put_trained_model_definition_part.rb +59 -0
  132. data/lib/elasticsearch-serverless/api/machine_learning/put_trained_model_vocabulary.rb +55 -0
  133. data/lib/elasticsearch-serverless/api/machine_learning/reset_job.rb +55 -0
  134. data/lib/elasticsearch-serverless/api/machine_learning/start_data_frame_analytics.rb +54 -0
  135. data/lib/elasticsearch-serverless/api/machine_learning/start_datafeed.rb +57 -0
  136. data/lib/elasticsearch-serverless/api/machine_learning/start_trained_model_deployment.rb +60 -0
  137. data/lib/elasticsearch-serverless/api/machine_learning/stop_data_frame_analytics.rb +56 -0
  138. data/lib/elasticsearch-serverless/api/machine_learning/stop_datafeed.rb +57 -0
  139. data/lib/elasticsearch-serverless/api/machine_learning/stop_trained_model_deployment.rb +55 -0
  140. data/lib/elasticsearch-serverless/api/machine_learning/update_data_frame_analytics.rb +55 -0
  141. data/lib/elasticsearch-serverless/api/machine_learning/update_datafeed.rb +59 -0
  142. data/lib/elasticsearch-serverless/api/machine_learning/update_filter.rb +55 -0
  143. data/lib/elasticsearch-serverless/api/machine_learning/update_job.rb +55 -0
  144. data/lib/elasticsearch-serverless/api/mget.rb +64 -0
  145. data/lib/elasticsearch-serverless/api/msearch.rb +91 -0
  146. data/lib/elasticsearch-serverless/api/msearch_template.rb +72 -0
  147. data/lib/elasticsearch-serverless/api/mtermvectors.rb +75 -0
  148. data/lib/elasticsearch-serverless/api/open_point_in_time.rb +56 -0
  149. data/lib/elasticsearch-serverless/api/ping.rb +52 -0
  150. data/lib/elasticsearch-serverless/api/put_script.rb +62 -0
  151. data/lib/elasticsearch-serverless/api/query_ruleset/delete.rb +57 -0
  152. data/lib/elasticsearch-serverless/api/query_ruleset/get.rb +57 -0
  153. data/lib/elasticsearch-serverless/api/query_ruleset/list.rb +54 -0
  154. data/lib/elasticsearch-serverless/api/query_ruleset/put.rb +59 -0
  155. data/lib/elasticsearch-serverless/api/rank_eval.rb +60 -0
  156. data/lib/elasticsearch-serverless/api/reindex.rb +59 -0
  157. data/lib/elasticsearch-serverless/api/render_search_template.rb +59 -0
  158. data/lib/elasticsearch-serverless/api/response.rb +48 -0
  159. data/lib/elasticsearch-serverless/api/scripts_painless_execute.rb +56 -0
  160. data/lib/elasticsearch-serverless/api/scroll.rb +66 -0
  161. data/lib/elasticsearch-serverless/api/search.rb +102 -0
  162. data/lib/elasticsearch-serverless/api/search_application/delete.rb +57 -0
  163. data/lib/elasticsearch-serverless/api/search_application/delete_behavioral_analytics.rb +57 -0
  164. data/lib/elasticsearch-serverless/api/search_application/get.rb +57 -0
  165. data/lib/elasticsearch-serverless/api/search_application/get_behavioral_analytics.rb +59 -0
  166. data/lib/elasticsearch-serverless/api/search_application/list.rb +55 -0
  167. data/lib/elasticsearch-serverless/api/search_application/put.rb +60 -0
  168. data/lib/elasticsearch-serverless/api/search_application/put_behavioral_analytics.rb +57 -0
  169. data/lib/elasticsearch-serverless/api/search_application/search.rb +63 -0
  170. data/lib/elasticsearch-serverless/api/search_mvt.rb +75 -0
  171. data/lib/elasticsearch-serverless/api/search_template.rb +69 -0
  172. data/lib/elasticsearch-serverless/api/security/authenticate.rb +48 -0
  173. data/lib/elasticsearch-serverless/api/security/create_api_key.rb +52 -0
  174. data/lib/elasticsearch-serverless/api/security/get_api_key.rb +54 -0
  175. data/lib/elasticsearch-serverless/api/security/has_privileges.rb +58 -0
  176. data/lib/elasticsearch-serverless/api/security/invalidate_api_key.rb +51 -0
  177. data/lib/elasticsearch-serverless/api/security/query_api_keys.rb +55 -0
  178. data/lib/elasticsearch-serverless/api/security/update_api_key.rb +54 -0
  179. data/lib/elasticsearch-serverless/api/sql/clear_cursor.rb +51 -0
  180. data/lib/elasticsearch-serverless/api/sql/delete_async.rb +53 -0
  181. data/lib/elasticsearch-serverless/api/sql/get_async.rb +57 -0
  182. data/lib/elasticsearch-serverless/api/sql/get_async_status.rb +53 -0
  183. data/lib/elasticsearch-serverless/api/sql/query.rb +52 -0
  184. data/lib/elasticsearch-serverless/api/sql/translate.rb +51 -0
  185. data/lib/elasticsearch-serverless/api/synonyms/delete_synonym.rb +57 -0
  186. data/lib/elasticsearch-serverless/api/synonyms/delete_synonym_rule.rb +61 -0
  187. data/lib/elasticsearch-serverless/api/synonyms/get_synonym.rb +59 -0
  188. data/lib/elasticsearch-serverless/api/synonyms/get_synonym_rule.rb +61 -0
  189. data/lib/elasticsearch-serverless/api/synonyms/get_synonyms_sets.rb +54 -0
  190. data/lib/elasticsearch-serverless/api/synonyms/put_synonym.rb +59 -0
  191. data/lib/elasticsearch-serverless/api/synonyms/put_synonym_rule.rb +63 -0
  192. data/lib/elasticsearch-serverless/api/tasks/get.rb +57 -0
  193. data/lib/elasticsearch-serverless/api/terms_enum.rb +57 -0
  194. data/lib/elasticsearch-serverless/api/termvectors.rb +82 -0
  195. data/lib/elasticsearch-serverless/api/transform/delete_transform.rb +55 -0
  196. data/lib/elasticsearch-serverless/api/transform/get_transform.rb +59 -0
  197. data/lib/elasticsearch-serverless/api/transform/get_transform_stats.rb +57 -0
  198. data/lib/elasticsearch-serverless/api/transform/preview_transform.rb +62 -0
  199. data/lib/elasticsearch-serverless/api/transform/put_transform.rb +57 -0
  200. data/lib/elasticsearch-serverless/api/transform/reset_transform.rb +54 -0
  201. data/lib/elasticsearch-serverless/api/transform/schedule_now_transform.rb +54 -0
  202. data/lib/elasticsearch-serverless/api/transform/start_transform.rb +55 -0
  203. data/lib/elasticsearch-serverless/api/transform/stop_transform.rb +58 -0
  204. data/lib/elasticsearch-serverless/api/transform/update_transform.rb +57 -0
  205. data/lib/elasticsearch-serverless/api/update.rb +77 -0
  206. data/lib/elasticsearch-serverless/api/update_by_query.rb +83 -0
  207. data/lib/elasticsearch-serverless/api/utils.rb +138 -0
  208. data/lib/elasticsearch-serverless/api.rb +98 -0
  209. data/lib/elasticsearch-serverless/version.rb +22 -0
  210. data/lib/elasticsearch-serverless.rb +105 -0
  211. metadata +321 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 360407581095acc1e52ffcc4c03f1f2d263d56427a0b1c48807aba4d7a776e82
4
+ data.tar.gz: 890548d5242aa5688ad25d5c85dff021015091190dc8585f025c1e4273d0993d
5
+ SHA512:
6
+ metadata.gz: a78500ad31ed7be19428791d702a4c1807130d8f091855ce5b2036c8cc1352d787f335b8fc0facd13933dc6b9a14b12352348be531f66f7d1b3c2aab95c11fdb
7
+ data.tar.gz: 0be05a9426b1ca80fb829929eb7992a9d7741b7f05bc2114ee1138a5daa49f570ad33435cdf87b674948eef89aec5616313677eedb9e65ca59711747af353e09
@@ -0,0 +1,53 @@
1
+ # Licensed to Elasticsearch B.V. under one or more contributor
2
+ # license agreements. See the NOTICE file distributed with
3
+ # this work for additional information regarding copyright
4
+ # ownership. Elasticsearch B.V. licenses this file to you under
5
+ # the Apache License, Version 2.0 (the "License"); you may
6
+ # not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing,
12
+ # software distributed under the License is distributed on an
13
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
+ # KIND, either express or implied. See the License for the
15
+ # specific language governing permissions and limitations
16
+ # under the License.
17
+ #
18
+ # Auto generated from commit f284cc16f4d4b4289bc679aa1529bb504190fe80
19
+ # @see https://github.com/elastic/elasticsearch-specification
20
+ #
21
+ module ElasticsearchServerless
22
+ module API
23
+ module AsyncSearch
24
+ module Actions
25
+ # 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.
26
+ #
27
+ # @option arguments [String] :id A unique identifier for the async search. (*Required*)
28
+ # @option arguments [Hash] :headers Custom HTTP headers
29
+ #
30
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html
31
+ #
32
+ def delete(arguments = {})
33
+ raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
34
+
35
+ arguments = arguments.clone
36
+ headers = arguments.delete(:headers) || {}
37
+
38
+ body = nil
39
+
40
+ _id = arguments.delete(:id)
41
+
42
+ method = ElasticsearchServerless::API::HTTP_DELETE
43
+ path = "_async_search/#{Utils.listify(_id)}"
44
+ params = {}
45
+
46
+ ElasticsearchServerless::API::Response.new(
47
+ perform_request(method, path, params, body, headers)
48
+ )
49
+ end
50
+ end
51
+ end
52
+ end
53
+ end
@@ -0,0 +1,56 @@
1
+ # Licensed to Elasticsearch B.V. under one or more contributor
2
+ # license agreements. See the NOTICE file distributed with
3
+ # this work for additional information regarding copyright
4
+ # ownership. Elasticsearch B.V. licenses this file to you under
5
+ # the Apache License, Version 2.0 (the "License"); you may
6
+ # not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing,
12
+ # software distributed under the License is distributed on an
13
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
+ # KIND, either express or implied. See the License for the
15
+ # specific language governing permissions and limitations
16
+ # under the License.
17
+ #
18
+ # Auto generated from commit f284cc16f4d4b4289bc679aa1529bb504190fe80
19
+ # @see https://github.com/elastic/elasticsearch-specification
20
+ #
21
+ module ElasticsearchServerless
22
+ module API
23
+ module AsyncSearch
24
+ module Actions
25
+ # Retrieves the results of a previously submitted async search request given its ID.
26
+ #
27
+ # @option arguments [String] :id A unique identifier for the async search. (*Required*)
28
+ # @option arguments [Time] :keep_alive Specifies how long the async search should be available in the cluster. When not specified, the +keep_alive+ set with the corresponding submit async request will be used. Otherwise, it is possible to override the value and extend the validity of the request. When this period expires, the search, if still running, is cancelled. If the search is completed, its saved results are deleted.
29
+ # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
30
+ # @option arguments [Time] :wait_for_completion_timeout Specifies to wait for the search to be completed up until the provided timeout. Final results will be returned if available before the timeout expires, otherwise the currently available results will be returned once the timeout expires. By default no timeout is set meaning that the currently available results will be returned without any additional wait.
31
+ # @option arguments [Hash] :headers Custom HTTP headers
32
+ #
33
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html
34
+ #
35
+ def get(arguments = {})
36
+ raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
37
+
38
+ arguments = arguments.clone
39
+ headers = arguments.delete(:headers) || {}
40
+
41
+ body = nil
42
+
43
+ _id = arguments.delete(:id)
44
+
45
+ method = ElasticsearchServerless::API::HTTP_GET
46
+ path = "_async_search/#{Utils.listify(_id)}"
47
+ params = Utils.process_params(arguments)
48
+
49
+ ElasticsearchServerless::API::Response.new(
50
+ perform_request(method, path, params, body, headers)
51
+ )
52
+ end
53
+ end
54
+ end
55
+ end
56
+ end
@@ -0,0 +1,53 @@
1
+ # Licensed to Elasticsearch B.V. under one or more contributor
2
+ # license agreements. See the NOTICE file distributed with
3
+ # this work for additional information regarding copyright
4
+ # ownership. Elasticsearch B.V. licenses this file to you under
5
+ # the Apache License, Version 2.0 (the "License"); you may
6
+ # not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing,
12
+ # software distributed under the License is distributed on an
13
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
+ # KIND, either express or implied. See the License for the
15
+ # specific language governing permissions and limitations
16
+ # under the License.
17
+ #
18
+ # Auto generated from commit f284cc16f4d4b4289bc679aa1529bb504190fe80
19
+ # @see https://github.com/elastic/elasticsearch-specification
20
+ #
21
+ module ElasticsearchServerless
22
+ module API
23
+ module AsyncSearch
24
+ module Actions
25
+ # Retrieves the status of a previously submitted async search request given its ID.
26
+ #
27
+ # @option arguments [String] :id A unique identifier for the async search. (*Required*)
28
+ # @option arguments [Hash] :headers Custom HTTP headers
29
+ #
30
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html
31
+ #
32
+ def status(arguments = {})
33
+ raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
34
+
35
+ arguments = arguments.clone
36
+ headers = arguments.delete(:headers) || {}
37
+
38
+ body = nil
39
+
40
+ _id = arguments.delete(:id)
41
+
42
+ method = ElasticsearchServerless::API::HTTP_GET
43
+ path = "_async_search/status/#{Utils.listify(_id)}"
44
+ params = {}
45
+
46
+ ElasticsearchServerless::API::Response.new(
47
+ perform_request(method, path, params, body, headers)
48
+ )
49
+ end
50
+ end
51
+ end
52
+ end
53
+ end
@@ -0,0 +1,102 @@
1
+ # Licensed to Elasticsearch B.V. under one or more contributor
2
+ # license agreements. See the NOTICE file distributed with
3
+ # this work for additional information regarding copyright
4
+ # ownership. Elasticsearch B.V. licenses this file to you under
5
+ # the Apache License, Version 2.0 (the "License"); you may
6
+ # not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing,
12
+ # software distributed under the License is distributed on an
13
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
+ # KIND, either express or implied. See the License for the
15
+ # specific language governing permissions and limitations
16
+ # under the License.
17
+ #
18
+ # Auto generated from commit f284cc16f4d4b4289bc679aa1529bb504190fe80
19
+ # @see https://github.com/elastic/elasticsearch-specification
20
+ #
21
+ module ElasticsearchServerless
22
+ module API
23
+ module AsyncSearch
24
+ module Actions
25
+ # Executes a search request asynchronously.
26
+ #
27
+ # @option arguments [String, Array] :index A comma-separated list of index names to search; use +_all+ or empty string to perform the operation on all indices
28
+ # @option arguments [Time] :wait_for_completion_timeout Blocks and waits until the search is completed up to a certain timeout. When the async search completes within the timeout, the response won’t include the ID as the results are not stored in the cluster. Server default: 1s.
29
+ # @option arguments [Boolean] :keep_on_completion If +true+, results are stored for later retrieval when the search completes within the +wait_for_completion_timeout+.
30
+ # @option arguments [Time] :keep_alive Specifies how long the async search needs to be available. Ongoing async searches and any saved search results are deleted after this period. Server default: 5d.
31
+ # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes +_all+ string or when no indices have been specified)
32
+ # @option arguments [Boolean] :allow_partial_search_results Indicate if an error should be returned if there is a partial search failure or timeout
33
+ # @option arguments [String] :analyzer The analyzer to use for the query string
34
+ # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false)
35
+ # @option arguments [Integer] :batched_reduce_size Affects how often partial results become available, which happens whenever shard results are reduced. A partial reduction is performed every time the coordinating node has received a certain number of new shard responses (5 by default). Server default: 5.
36
+ # @option arguments [Boolean] :ccs_minimize_roundtrips The default value is the only supported value.
37
+ # @option arguments [String] :default_operator The default operator for query string query (AND or OR)
38
+ # @option arguments [String] :df The field to use as default where no field prefix is given in the query string
39
+ # @option arguments [String, Array<String>] :docvalue_fields A comma-separated list of fields to return as the docvalue representation of a field for each hit
40
+ # @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
41
+ # @option arguments [Boolean] :explain Specify whether to return detailed information about score computation as part of a hit
42
+ # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled
43
+ # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
44
+ # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
45
+ # @option arguments [Integer] :max_concurrent_shard_requests 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
46
+ # @option arguments [String] :min_compatible_shard_node [TODO]
47
+ # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
48
+ # @option arguments [Integer] :pre_filter_shard_size The default value cannot be changed, which enforces the execution of a pre-filter roundtrip to retrieve statistics from each shard so that the ones that surely don’t hold any document matching the query get skipped. Server default: 1.
49
+ # @option arguments [Boolean] :request_cache Specify if request cache should be used for this request or not, defaults to true Server default: true.
50
+ # @option arguments [String] :routing A comma-separated list of specific routing values
51
+ # @option arguments [Time] :scroll [TODO]
52
+ # @option arguments [String] :search_type Search operation type
53
+ # @option arguments [Array<String>] :stats Specific 'tag' of the request for logging and statistical purposes
54
+ # @option arguments [String, Array<String>] :stored_fields A comma-separated list of stored fields to return as part of a hit
55
+ # @option arguments [String] :suggest_field Specifies which field to use for suggestions.
56
+ # @option arguments [String] :suggest_mode Specify suggest mode
57
+ # @option arguments [Integer] :suggest_size How many suggestions to return in response
58
+ # @option arguments [String] :suggest_text The source text for which the suggestions should be returned.
59
+ # @option arguments [Integer] :terminate_after The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
60
+ # @option arguments [Time] :timeout Explicit operation timeout
61
+ # @option arguments [Boolean, Integer] :track_total_hits Indicate if the number of documents that match the query should be tracked. A number can also be specified, to accurately track the total hit count up to the number.
62
+ # @option arguments [Boolean] :track_scores Whether to calculate and return scores even if they are not used for sorting
63
+ # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
64
+ # @option arguments [Boolean] :rest_total_hits_as_int [TODO]
65
+ # @option arguments [Boolean] :version Specify whether to return document version as part of a hit
66
+ # @option arguments [Boolean, String, Array<String>] :_source True or false to return the _source field or not, or a list of fields to return
67
+ # @option arguments [String, Array<String>] :_source_excludes A list of fields to exclude from the returned _source field
68
+ # @option arguments [String, Array<String>] :_source_includes A list of fields to extract and return from the _source field
69
+ # @option arguments [Boolean] :seq_no_primary_term Specify whether to return sequence number and primary term of the last modification of each hit
70
+ # @option arguments [String] :q Query in the Lucene query string syntax
71
+ # @option arguments [Integer] :size Number of hits to return (default: 10)
72
+ # @option arguments [Integer] :from Starting offset (default: 0)
73
+ # @option arguments [String] :sort A comma-separated list of <field>:<direction> pairs
74
+ # @option arguments [Hash] :headers Custom HTTP headers
75
+ # @option arguments [Hash] :body request body
76
+ #
77
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html
78
+ #
79
+ def submit(arguments = {})
80
+ arguments = arguments.clone
81
+ headers = arguments.delete(:headers) || {}
82
+
83
+ body = arguments.delete(:body)
84
+
85
+ _index = arguments.delete(:index)
86
+
87
+ method = ElasticsearchServerless::API::HTTP_POST
88
+ path = if _index
89
+ "#{Utils.listify(_index)}/_async_search"
90
+ else
91
+ "_async_search"
92
+ end
93
+ params = Utils.process_params(arguments)
94
+
95
+ ElasticsearchServerless::API::Response.new(
96
+ perform_request(method, path, params, body, headers)
97
+ )
98
+ end
99
+ end
100
+ end
101
+ end
102
+ end
@@ -0,0 +1,72 @@
1
+ # Licensed to Elasticsearch B.V. under one or more contributor
2
+ # license agreements. See the NOTICE file distributed with
3
+ # this work for additional information regarding copyright
4
+ # ownership. Elasticsearch B.V. licenses this file to you under
5
+ # the Apache License, Version 2.0 (the "License"); you may
6
+ # not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing,
12
+ # software distributed under the License is distributed on an
13
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
+ # KIND, either express or implied. See the License for the
15
+ # specific language governing permissions and limitations
16
+ # under the License.
17
+ #
18
+ # Auto generated from commit f284cc16f4d4b4289bc679aa1529bb504190fe80
19
+ # @see https://github.com/elastic/elasticsearch-specification
20
+ #
21
+ module ElasticsearchServerless
22
+ module API
23
+ module Actions
24
+ # Allows to perform multiple index/update/delete operations in a single request.
25
+ #
26
+ # @option arguments [String] :index Name of the data stream, index, or index alias to perform bulk actions on.
27
+ # @option arguments [String] :pipeline ID of the pipeline to use to preprocess incoming documents. If the index has a default ingest pipeline specified, then setting the value to +_none+ disables the default ingest pipeline for this request. If a final pipeline is configured it will always run, regardless of the value of this parameter.
28
+ # @option arguments [String] :refresh If +true+, Elasticsearch refreshes 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+ do nothing with refreshes. Valid values: +true+, +false+, +wait_for+. Server default: false.
29
+ # @option arguments [String] :routing Custom value used to route operations to a specific shard.
30
+ # @option arguments [Boolean, String, Array<String>] :_source +true+ or +false+ to return the +_source+ field or not, or a list of fields to return.
31
+ # @option arguments [String, Array<String>] :_source_excludes A comma-separated list of source fields to exclude from the response.
32
+ # @option arguments [String, Array<String>] :_source_includes A comma-separated list of source fields to include in the response.
33
+ # @option arguments [Time] :timeout Period each action waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. Server default: 1m.
34
+ # @option arguments [Integer, String] :wait_for_active_shards The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (+number_of_replicas+1+). Server default: 1.
35
+ # @option arguments [Boolean] :require_alias If +true+, the request’s actions must target an index alias.
36
+ # @option arguments [Hash] :headers Custom HTTP headers
37
+ # @option arguments [String|Array] :body operations. Array of Strings, Header/Data pairs, or the conveniency "combined" format can be passed, refer to ElasticsearchServerless::API::Utils.bulkify documentation.
38
+ #
39
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html
40
+ #
41
+ def bulk(arguments = {})
42
+ raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
43
+
44
+ arguments = arguments.clone
45
+ headers = arguments.delete(:headers) || {}
46
+
47
+ body = arguments.delete(:body)
48
+
49
+ _index = arguments.delete(:index)
50
+
51
+ method = ElasticsearchServerless::API::HTTP_POST
52
+ path = if _index
53
+ "#{Utils.listify(_index)}/_bulk"
54
+ else
55
+ "_bulk"
56
+ end
57
+ params = Utils.process_params(arguments)
58
+
59
+ if body.is_a? Array
60
+ payload = ElasticsearchServerless::API::Utils.bulkify(body)
61
+ else
62
+ payload = body
63
+ end
64
+
65
+ headers.merge!("Content-Type" => "application/x-ndjson")
66
+ ElasticsearchServerless::API::Response.new(
67
+ perform_request(method, path, params, payload, headers)
68
+ )
69
+ end
70
+ end
71
+ end
72
+ end
@@ -0,0 +1,64 @@
1
+ # Licensed to Elasticsearch B.V. under one or more contributor
2
+ # license agreements. See the NOTICE file distributed with
3
+ # this work for additional information regarding copyright
4
+ # ownership. Elasticsearch B.V. licenses this file to you under
5
+ # the Apache License, Version 2.0 (the "License"); you may
6
+ # not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing,
12
+ # software distributed under the License is distributed on an
13
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
+ # KIND, either express or implied. See the License for the
15
+ # specific language governing permissions and limitations
16
+ # under the License.
17
+ #
18
+ # Auto generated from commit f284cc16f4d4b4289bc679aa1529bb504190fe80
19
+ # @see https://github.com/elastic/elasticsearch-specification
20
+ #
21
+ module ElasticsearchServerless
22
+ module API
23
+ module Cat
24
+ module Actions
25
+ # Shows information about currently configured aliases to indices including filter and routing infos.
26
+ #
27
+ # @option arguments [String, Array<String>] :name A comma-separated list of aliases to retrieve. Supports wildcards (+*+). To retrieve all aliases, omit this parameter or use +*+ or +_all+.
28
+ # @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
29
+ # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
30
+ # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
31
+ # @option arguments [Boolean] :help When set to +true+ will output available columns. This option can't be combined with any other query string option.
32
+ # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the local cluster state. If +false+ the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.
33
+ # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
34
+ # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting +:asc+ or +:desc+ as a suffix to the column name.
35
+ # @option arguments [Boolean] :v When set to +true+ will enable verbose output.
36
+ # @option arguments [Hash] :headers Custom HTTP headers
37
+ #
38
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-alias.html
39
+ #
40
+ def aliases(arguments = {})
41
+ arguments = arguments.clone
42
+ headers = arguments.delete(:headers) || {}
43
+
44
+ body = nil
45
+
46
+ _name = arguments.delete(:name)
47
+
48
+ method = ElasticsearchServerless::API::HTTP_GET
49
+ path = if _name
50
+ "_cat/aliases/#{Utils.listify(_name)}"
51
+ else
52
+ "_cat/aliases"
53
+ end
54
+ params = Utils.process_params(arguments)
55
+ params[:h] = Utils.listify(params[:h]) if params[:h]
56
+
57
+ ElasticsearchServerless::API::Response.new(
58
+ perform_request(method, path, params, body, headers)
59
+ )
60
+ end
61
+ end
62
+ end
63
+ end
64
+ end
@@ -0,0 +1,62 @@
1
+ # Licensed to Elasticsearch B.V. under one or more contributor
2
+ # license agreements. See the NOTICE file distributed with
3
+ # this work for additional information regarding copyright
4
+ # ownership. Elasticsearch B.V. licenses this file to you under
5
+ # the Apache License, Version 2.0 (the "License"); you may
6
+ # not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing,
12
+ # software distributed under the License is distributed on an
13
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
+ # KIND, either express or implied. See the License for the
15
+ # specific language governing permissions and limitations
16
+ # under the License.
17
+ #
18
+ # Auto generated from commit f284cc16f4d4b4289bc679aa1529bb504190fe80
19
+ # @see https://github.com/elastic/elasticsearch-specification
20
+ #
21
+ module ElasticsearchServerless
22
+ module API
23
+ module Cat
24
+ module Actions
25
+ # Returns information about existing component_templates templates.
26
+ #
27
+ # @option arguments [String] :name The name of the component template. Accepts wildcard expressions. If omitted, all component templates are returned.
28
+ # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
29
+ # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
30
+ # @option arguments [Boolean] :help When set to +true+ will output available columns. This option can't be combined with any other query string option.
31
+ # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the local cluster state. If +false+ the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.
32
+ # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
33
+ # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting +:asc+ or +:desc+ as a suffix to the column name.
34
+ # @option arguments [Boolean] :v When set to +true+ will enable verbose output.
35
+ # @option arguments [Hash] :headers Custom HTTP headers
36
+ #
37
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-component-templates.html
38
+ #
39
+ def component_templates(arguments = {})
40
+ arguments = arguments.clone
41
+ headers = arguments.delete(:headers) || {}
42
+
43
+ body = nil
44
+
45
+ _name = arguments.delete(:name)
46
+
47
+ method = ElasticsearchServerless::API::HTTP_GET
48
+ path = if _name
49
+ "_cat/component_templates/#{Utils.listify(_name)}"
50
+ else
51
+ "_cat/component_templates"
52
+ end
53
+ params = Utils.process_params(arguments)
54
+
55
+ ElasticsearchServerless::API::Response.new(
56
+ perform_request(method, path, params, body, headers)
57
+ )
58
+ end
59
+ end
60
+ end
61
+ end
62
+ end
@@ -0,0 +1,63 @@
1
+ # Licensed to Elasticsearch B.V. under one or more contributor
2
+ # license agreements. See the NOTICE file distributed with
3
+ # this work for additional information regarding copyright
4
+ # ownership. Elasticsearch B.V. licenses this file to you under
5
+ # the Apache License, Version 2.0 (the "License"); you may
6
+ # not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing,
12
+ # software distributed under the License is distributed on an
13
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
+ # KIND, either express or implied. See the License for the
15
+ # specific language governing permissions and limitations
16
+ # under the License.
17
+ #
18
+ # Auto generated from commit f284cc16f4d4b4289bc679aa1529bb504190fe80
19
+ # @see https://github.com/elastic/elasticsearch-specification
20
+ #
21
+ module ElasticsearchServerless
22
+ module API
23
+ module Cat
24
+ module Actions
25
+ # Provides quick access to the document count of the entire cluster, or individual indices.
26
+ #
27
+ # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (+*+). To target all data streams and indices, omit this parameter or use +*+ or +_all+.
28
+ # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
29
+ # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
30
+ # @option arguments [Boolean] :help When set to +true+ will output available columns. This option can't be combined with any other query string option.
31
+ # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the local cluster state. If +false+ the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.
32
+ # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
33
+ # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting +:asc+ or +:desc+ as a suffix to the column name.
34
+ # @option arguments [Boolean] :v When set to +true+ will enable verbose output.
35
+ # @option arguments [Hash] :headers Custom HTTP headers
36
+ #
37
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-count.html
38
+ #
39
+ def count(arguments = {})
40
+ arguments = arguments.clone
41
+ headers = arguments.delete(:headers) || {}
42
+
43
+ body = nil
44
+
45
+ _index = arguments.delete(:index)
46
+
47
+ method = ElasticsearchServerless::API::HTTP_GET
48
+ path = if _index
49
+ "_cat/count/#{Utils.listify(_index)}"
50
+ else
51
+ "_cat/count"
52
+ end
53
+ params = Utils.process_params(arguments)
54
+ params[:h] = Utils.listify(params[:h]) if params[:h]
55
+
56
+ ElasticsearchServerless::API::Response.new(
57
+ perform_request(method, path, params, body, headers)
58
+ )
59
+ end
60
+ end
61
+ end
62
+ end
63
+ end
@@ -0,0 +1,55 @@
1
+ # Licensed to Elasticsearch B.V. under one or more contributor
2
+ # license agreements. See the NOTICE file distributed with
3
+ # this work for additional information regarding copyright
4
+ # ownership. Elasticsearch B.V. licenses this file to you under
5
+ # the Apache License, Version 2.0 (the "License"); you may
6
+ # not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing,
12
+ # software distributed under the License is distributed on an
13
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
+ # KIND, either express or implied. See the License for the
15
+ # specific language governing permissions and limitations
16
+ # under the License.
17
+ #
18
+ # Auto generated from commit f284cc16f4d4b4289bc679aa1529bb504190fe80
19
+ # @see https://github.com/elastic/elasticsearch-specification
20
+ #
21
+ module ElasticsearchServerless
22
+ module API
23
+ module Cat
24
+ module Actions
25
+ # Returns help for the Cat APIs.
26
+ #
27
+ # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
28
+ # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
29
+ # @option arguments [Boolean] :help When set to +true+ will output available columns. This option can't be combined with any other query string option.
30
+ # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the local cluster state. If +false+ the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.
31
+ # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
32
+ # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting +:asc+ or +:desc+ as a suffix to the column name.
33
+ # @option arguments [Boolean] :v When set to +true+ will enable verbose output.
34
+ # @option arguments [Hash] :headers Custom HTTP headers
35
+ #
36
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat.html
37
+ #
38
+ def help(arguments = {})
39
+ arguments = arguments.clone
40
+ headers = arguments.delete(:headers) || {}
41
+
42
+ body = nil
43
+
44
+ method = ElasticsearchServerless::API::HTTP_GET
45
+ path = "_cat"
46
+ params = Utils.process_params(arguments)
47
+
48
+ ElasticsearchServerless::API::Response.new(
49
+ perform_request(method, path, params, body, headers)
50
+ )
51
+ end
52
+ end
53
+ end
54
+ end
55
+ end