elasticsearch-serverless 0.5.0 → 0.7.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 (250) hide show
  1. checksums.yaml +4 -4
  2. data/lib/elasticsearch-serverless/api/async_search/delete.rb +3 -4
  3. data/lib/elasticsearch-serverless/api/async_search/get.rb +4 -5
  4. data/lib/elasticsearch-serverless/api/async_search/status.rb +11 -8
  5. data/lib/elasticsearch-serverless/api/async_search/submit.rb +6 -10
  6. data/lib/elasticsearch-serverless/api/bulk.rb +109 -22
  7. data/lib/elasticsearch-serverless/api/cat/aliases.rb +17 -18
  8. data/lib/elasticsearch-serverless/api/cat/component_templates.rb +17 -16
  9. data/lib/elasticsearch-serverless/api/cat/count.rb +13 -18
  10. data/lib/elasticsearch-serverless/api/cat/help.rb +5 -19
  11. data/lib/elasticsearch-serverless/api/cat/indices.rb +10 -15
  12. data/lib/elasticsearch-serverless/api/cat/ml_data_frame_analytics.rb +7 -17
  13. data/lib/elasticsearch-serverless/api/cat/ml_datafeeds.rb +6 -16
  14. data/lib/elasticsearch-serverless/api/cat/ml_jobs.rb +6 -16
  15. data/lib/elasticsearch-serverless/api/cat/ml_trained_models.rb +7 -16
  16. data/lib/elasticsearch-serverless/api/cat/transforms.rb +6 -16
  17. data/lib/elasticsearch-serverless/api/clear_scroll.rb +9 -7
  18. data/lib/elasticsearch-serverless/api/close_point_in_time.rb +8 -4
  19. data/lib/elasticsearch-serverless/api/cluster/delete_component_template.rb +3 -5
  20. data/lib/elasticsearch-serverless/api/cluster/exists_component_template.rb +4 -5
  21. data/lib/elasticsearch-serverless/api/cluster/get_component_template.rb +5 -6
  22. data/lib/elasticsearch-serverless/api/cluster/info.rb +3 -4
  23. data/lib/elasticsearch-serverless/api/cluster/put_component_template.rb +6 -5
  24. data/lib/elasticsearch-serverless/api/connector/check_in.rb +3 -4
  25. data/lib/elasticsearch-serverless/api/connector/delete.rb +4 -4
  26. data/lib/elasticsearch-serverless/api/connector/get.rb +5 -5
  27. data/lib/elasticsearch-serverless/api/connector/list.rb +4 -3
  28. data/lib/elasticsearch-serverless/api/connector/post.rb +3 -3
  29. data/lib/elasticsearch-serverless/api/connector/put.rb +4 -5
  30. data/lib/elasticsearch-serverless/api/connector/sync_job_cancel.rb +7 -6
  31. data/lib/elasticsearch-serverless/api/connector/sync_job_delete.rb +7 -6
  32. data/lib/elasticsearch-serverless/api/connector/sync_job_get.rb +7 -6
  33. data/lib/elasticsearch-serverless/api/connector/sync_job_list.rb +3 -3
  34. data/lib/elasticsearch-serverless/api/connector/sync_job_post.rb +3 -3
  35. data/lib/elasticsearch-serverless/api/connector/update_active_filtering.rb +3 -4
  36. data/lib/elasticsearch-serverless/api/connector/update_api_key_id.rb +3 -4
  37. data/lib/elasticsearch-serverless/api/connector/update_configuration.rb +3 -4
  38. data/lib/elasticsearch-serverless/api/connector/update_error.rb +3 -4
  39. data/lib/elasticsearch-serverless/api/connector/update_filtering.rb +3 -4
  40. data/lib/elasticsearch-serverless/api/connector/update_filtering_validation.rb +2 -3
  41. data/lib/elasticsearch-serverless/api/connector/update_index_name.rb +3 -4
  42. data/lib/elasticsearch-serverless/api/connector/update_name.rb +3 -4
  43. data/lib/elasticsearch-serverless/api/connector/update_native.rb +2 -3
  44. data/lib/elasticsearch-serverless/api/connector/update_pipeline.rb +3 -4
  45. data/lib/elasticsearch-serverless/api/connector/update_scheduling.rb +3 -4
  46. data/lib/elasticsearch-serverless/api/connector/update_service_type.rb +3 -4
  47. data/lib/elasticsearch-serverless/api/connector/update_status.rb +3 -4
  48. data/lib/elasticsearch-serverless/api/count.rb +36 -25
  49. data/lib/elasticsearch-serverless/api/create.rb +77 -22
  50. data/lib/elasticsearch-serverless/api/delete.rb +44 -18
  51. data/lib/elasticsearch-serverless/api/delete_by_query.rb +91 -29
  52. data/lib/elasticsearch-serverless/api/delete_script.rb +10 -9
  53. data/lib/elasticsearch-serverless/api/enrich/delete_policy.rb +5 -5
  54. data/lib/elasticsearch-serverless/api/enrich/execute_policy.rb +6 -5
  55. data/lib/elasticsearch-serverless/api/enrich/get_policy.rb +6 -6
  56. data/lib/elasticsearch-serverless/api/enrich/put_policy.rb +5 -5
  57. data/lib/elasticsearch-serverless/api/eql/delete.rb +5 -5
  58. data/lib/elasticsearch-serverless/api/eql/get.rb +5 -5
  59. data/lib/elasticsearch-serverless/api/eql/get_status.rb +5 -5
  60. data/lib/elasticsearch-serverless/api/eql/search.rb +9 -5
  61. data/lib/elasticsearch-serverless/api/exists.rb +38 -19
  62. data/lib/elasticsearch-serverless/api/exists_source.rb +23 -18
  63. data/lib/elasticsearch-serverless/api/explain.rb +25 -16
  64. data/lib/elasticsearch-serverless/api/field_caps.rb +16 -13
  65. data/lib/elasticsearch-serverless/api/get.rb +71 -21
  66. data/lib/elasticsearch-serverless/api/get_script.rb +7 -6
  67. data/lib/elasticsearch-serverless/api/get_source.rb +25 -15
  68. data/lib/elasticsearch-serverless/api/graph/explore.rb +9 -5
  69. data/lib/elasticsearch-serverless/api/index.rb +110 -21
  70. data/lib/elasticsearch-serverless/api/indices/add_block.rb +23 -12
  71. data/lib/elasticsearch-serverless/api/indices/analyze.rb +9 -6
  72. data/lib/elasticsearch-serverless/api/indices/create.rb +19 -6
  73. data/lib/elasticsearch-serverless/api/indices/create_data_stream.rb +3 -5
  74. data/lib/elasticsearch-serverless/api/indices/delete.rb +11 -8
  75. data/lib/elasticsearch-serverless/api/indices/delete_alias.rb +4 -7
  76. data/lib/elasticsearch-serverless/api/indices/delete_data_stream.rb +3 -4
  77. data/lib/elasticsearch-serverless/api/indices/delete_index_template.rb +3 -4
  78. data/lib/elasticsearch-serverless/api/indices/exists.rb +7 -8
  79. data/lib/elasticsearch-serverless/api/indices/exists_alias.rb +8 -8
  80. data/lib/elasticsearch-serverless/api/indices/exists_index_template.rb +6 -6
  81. data/lib/elasticsearch-serverless/api/indices/explain_data_lifecycle.rb +4 -5
  82. data/lib/elasticsearch-serverless/api/indices/get.rb +5 -6
  83. data/lib/elasticsearch-serverless/api/indices/get_alias.rb +6 -6
  84. data/lib/elasticsearch-serverless/api/indices/get_data_lifecycle.rb +4 -5
  85. data/lib/elasticsearch-serverless/api/indices/get_data_stream.rb +5 -6
  86. data/lib/elasticsearch-serverless/api/indices/get_index_template.rb +5 -6
  87. data/lib/elasticsearch-serverless/api/indices/get_mapping.rb +4 -6
  88. data/lib/elasticsearch-serverless/api/indices/get_settings.rb +6 -7
  89. data/lib/elasticsearch-serverless/api/indices/migrate_to_data_stream.rb +3 -4
  90. data/lib/elasticsearch-serverless/api/indices/modify_data_stream.rb +3 -3
  91. data/lib/elasticsearch-serverless/api/indices/put_alias.rb +4 -7
  92. data/lib/elasticsearch-serverless/api/indices/put_data_lifecycle.rb +4 -6
  93. data/lib/elasticsearch-serverless/api/indices/put_index_template.rb +22 -4
  94. data/lib/elasticsearch-serverless/api/indices/put_mapping.rb +21 -6
  95. data/lib/elasticsearch-serverless/api/indices/put_settings.rb +17 -7
  96. data/lib/elasticsearch-serverless/api/indices/refresh.rb +11 -5
  97. data/lib/elasticsearch-serverless/api/indices/resolve_index.rb +5 -5
  98. data/lib/elasticsearch-serverless/api/indices/rollover.rb +28 -5
  99. data/lib/elasticsearch-serverless/api/indices/simulate_index_template.rb +4 -5
  100. data/lib/elasticsearch-serverless/api/indices/simulate_template.rb +5 -6
  101. data/lib/elasticsearch-serverless/api/indices/update_aliases.rb +3 -3
  102. data/lib/elasticsearch-serverless/api/indices/validate_query.rb +4 -5
  103. data/lib/elasticsearch-serverless/api/inference/chat_completion_unified.rb +62 -0
  104. data/lib/elasticsearch-serverless/api/inference/completion.rb +62 -0
  105. data/lib/elasticsearch-serverless/api/inference/delete.rb +6 -11
  106. data/lib/elasticsearch-serverless/api/inference/get.rb +4 -9
  107. data/lib/elasticsearch-serverless/api/inference/inference.rb +0 -4
  108. data/lib/elasticsearch-serverless/api/inference/put.rb +12 -9
  109. data/lib/elasticsearch-serverless/api/inference/put_watsonx.rb +78 -0
  110. data/lib/elasticsearch-serverless/api/inference/rerank.rb +62 -0
  111. data/lib/elasticsearch-serverless/api/inference/sparse_embedding.rb +62 -0
  112. data/lib/elasticsearch-serverless/api/inference/text_embedding.rb +62 -0
  113. data/lib/elasticsearch-serverless/api/info.rb +4 -4
  114. data/lib/elasticsearch-serverless/api/ingest/delete_pipeline.rb +5 -5
  115. data/lib/elasticsearch-serverless/api/ingest/get_pipeline.rb +6 -6
  116. data/lib/elasticsearch-serverless/api/ingest/processor_grok.rb +5 -4
  117. data/lib/elasticsearch-serverless/api/ingest/put_pipeline.rb +3 -4
  118. data/lib/elasticsearch-serverless/api/ingest/simulate.rb +9 -8
  119. data/lib/elasticsearch-serverless/api/license/get.rb +4 -5
  120. data/lib/elasticsearch-serverless/api/logstash/delete_pipeline.rb +7 -6
  121. data/lib/elasticsearch-serverless/api/logstash/get_pipeline.rb +7 -7
  122. data/lib/elasticsearch-serverless/api/logstash/put_pipeline.rb +7 -6
  123. data/lib/elasticsearch-serverless/api/machine_learning/close_job.rb +3 -4
  124. data/lib/elasticsearch-serverless/api/machine_learning/delete_calendar.rb +4 -5
  125. data/lib/elasticsearch-serverless/api/machine_learning/delete_calendar_event.rb +3 -4
  126. data/lib/elasticsearch-serverless/api/machine_learning/delete_calendar_job.rb +3 -4
  127. data/lib/elasticsearch-serverless/api/machine_learning/delete_data_frame_analytics.rb +3 -4
  128. data/lib/elasticsearch-serverless/api/machine_learning/delete_datafeed.rb +3 -4
  129. data/lib/elasticsearch-serverless/api/machine_learning/delete_filter.rb +3 -4
  130. data/lib/elasticsearch-serverless/api/machine_learning/delete_job.rb +3 -4
  131. data/lib/elasticsearch-serverless/api/machine_learning/delete_trained_model.rb +4 -4
  132. data/lib/elasticsearch-serverless/api/machine_learning/delete_trained_model_alias.rb +3 -4
  133. data/lib/elasticsearch-serverless/api/machine_learning/estimate_model_memory.rb +5 -5
  134. data/lib/elasticsearch-serverless/api/machine_learning/evaluate_data_frame.rb +3 -3
  135. data/lib/elasticsearch-serverless/api/machine_learning/flush_job.rb +3 -4
  136. data/lib/elasticsearch-serverless/api/machine_learning/get_calendar_events.rb +3 -4
  137. data/lib/elasticsearch-serverless/api/machine_learning/get_calendars.rb +4 -5
  138. data/lib/elasticsearch-serverless/api/machine_learning/get_data_frame_analytics.rb +4 -5
  139. data/lib/elasticsearch-serverless/api/machine_learning/get_data_frame_analytics_stats.rb +4 -5
  140. data/lib/elasticsearch-serverless/api/machine_learning/get_datafeed_stats.rb +4 -5
  141. data/lib/elasticsearch-serverless/api/machine_learning/get_datafeeds.rb +4 -5
  142. data/lib/elasticsearch-serverless/api/machine_learning/get_filters.rb +4 -5
  143. data/lib/elasticsearch-serverless/api/machine_learning/get_job_stats.rb +4 -5
  144. data/lib/elasticsearch-serverless/api/machine_learning/get_jobs.rb +4 -5
  145. data/lib/elasticsearch-serverless/api/machine_learning/get_overall_buckets.rb +3 -4
  146. data/lib/elasticsearch-serverless/api/machine_learning/get_trained_models.rb +4 -5
  147. data/lib/elasticsearch-serverless/api/machine_learning/get_trained_models_stats.rb +4 -5
  148. data/lib/elasticsearch-serverless/api/machine_learning/infer_trained_model.rb +3 -9
  149. data/lib/elasticsearch-serverless/api/machine_learning/open_job.rb +3 -4
  150. data/lib/elasticsearch-serverless/api/machine_learning/post_calendar_events.rb +3 -4
  151. data/lib/elasticsearch-serverless/api/machine_learning/preview_data_frame_analytics.rb +5 -6
  152. data/lib/elasticsearch-serverless/api/machine_learning/preview_datafeed.rb +4 -5
  153. data/lib/elasticsearch-serverless/api/machine_learning/put_calendar.rb +3 -4
  154. data/lib/elasticsearch-serverless/api/machine_learning/put_calendar_job.rb +3 -4
  155. data/lib/elasticsearch-serverless/api/machine_learning/put_data_frame_analytics.rb +6 -4
  156. data/lib/elasticsearch-serverless/api/machine_learning/put_datafeed.rb +6 -6
  157. data/lib/elasticsearch-serverless/api/machine_learning/put_filter.rb +3 -4
  158. data/lib/elasticsearch-serverless/api/machine_learning/put_job.rb +16 -5
  159. data/lib/elasticsearch-serverless/api/machine_learning/put_trained_model.rb +3 -4
  160. data/lib/elasticsearch-serverless/api/machine_learning/put_trained_model_alias.rb +3 -4
  161. data/lib/elasticsearch-serverless/api/machine_learning/put_trained_model_definition_part.rb +3 -4
  162. data/lib/elasticsearch-serverless/api/machine_learning/put_trained_model_vocabulary.rb +3 -4
  163. data/lib/elasticsearch-serverless/api/machine_learning/reset_job.rb +3 -4
  164. data/lib/elasticsearch-serverless/api/machine_learning/start_data_frame_analytics.rb +3 -4
  165. data/lib/elasticsearch-serverless/api/machine_learning/start_datafeed.rb +3 -4
  166. data/lib/elasticsearch-serverless/api/machine_learning/start_trained_model_deployment.rb +7 -6
  167. data/lib/elasticsearch-serverless/api/machine_learning/stop_data_frame_analytics.rb +3 -4
  168. data/lib/elasticsearch-serverless/api/machine_learning/stop_datafeed.rb +3 -4
  169. data/lib/elasticsearch-serverless/api/machine_learning/stop_trained_model_deployment.rb +3 -4
  170. data/lib/elasticsearch-serverless/api/machine_learning/update_data_frame_analytics.rb +3 -4
  171. data/lib/elasticsearch-serverless/api/machine_learning/update_datafeed.rb +3 -4
  172. data/lib/elasticsearch-serverless/api/machine_learning/update_filter.rb +3 -4
  173. data/lib/elasticsearch-serverless/api/machine_learning/update_job.rb +3 -4
  174. data/lib/elasticsearch-serverless/api/machine_learning/update_trained_model_deployment.rb +3 -4
  175. data/lib/elasticsearch-serverless/api/mget.rb +12 -5
  176. data/lib/elasticsearch-serverless/api/msearch.rb +16 -17
  177. data/lib/elasticsearch-serverless/api/msearch_template.rb +23 -16
  178. data/lib/elasticsearch-serverless/api/mtermvectors.rb +15 -12
  179. data/lib/elasticsearch-serverless/api/open_point_in_time.rb +33 -11
  180. data/lib/elasticsearch-serverless/api/ping.rb +8 -10
  181. data/lib/elasticsearch-serverless/api/put_script.rb +12 -11
  182. data/lib/elasticsearch-serverless/api/query_rules/delete_rule.rb +6 -5
  183. data/lib/elasticsearch-serverless/api/query_rules/delete_ruleset.rb +6 -5
  184. data/lib/elasticsearch-serverless/api/query_rules/get_rule.rb +5 -5
  185. data/lib/elasticsearch-serverless/api/query_rules/get_ruleset.rb +5 -5
  186. data/lib/elasticsearch-serverless/api/query_rules/list_rulesets.rb +7 -6
  187. data/lib/elasticsearch-serverless/api/query_rules/put_rule.rb +11 -7
  188. data/lib/elasticsearch-serverless/api/query_rules/put_ruleset.rb +11 -6
  189. data/lib/elasticsearch-serverless/api/query_rules/test.rb +5 -5
  190. data/lib/elasticsearch-serverless/api/rank_eval.rb +8 -7
  191. data/lib/elasticsearch-serverless/api/reindex.rb +146 -9
  192. data/lib/elasticsearch-serverless/api/render_search_template.rb +7 -7
  193. data/lib/elasticsearch-serverless/api/response.rb +1 -1
  194. data/lib/elasticsearch-serverless/api/scripts_painless_execute.rb +7 -3
  195. data/lib/elasticsearch-serverless/api/scroll.rb +4 -4
  196. data/lib/elasticsearch-serverless/api/search.rb +79 -72
  197. data/lib/elasticsearch-serverless/api/search_application/delete.rb +4 -5
  198. data/lib/elasticsearch-serverless/api/search_application/delete_behavioral_analytics.rb +3 -4
  199. data/lib/elasticsearch-serverless/api/search_application/get.rb +3 -4
  200. data/lib/elasticsearch-serverless/api/search_application/get_behavioral_analytics.rb +4 -5
  201. data/lib/elasticsearch-serverless/api/search_application/list.rb +5 -4
  202. data/lib/elasticsearch-serverless/api/search_application/put.rb +3 -4
  203. data/lib/elasticsearch-serverless/api/search_application/put_behavioral_analytics.rb +3 -4
  204. data/lib/elasticsearch-serverless/api/search_application/search.rb +3 -4
  205. data/lib/elasticsearch-serverless/api/search_mvt.rb +132 -10
  206. data/lib/elasticsearch-serverless/api/search_template.rb +13 -13
  207. data/lib/elasticsearch-serverless/api/security/authenticate.rb +3 -3
  208. data/lib/elasticsearch-serverless/api/security/create_api_key.rb +7 -3
  209. data/lib/elasticsearch-serverless/api/security/delete_role.rb +6 -5
  210. data/lib/elasticsearch-serverless/api/security/get_api_key.rb +3 -3
  211. data/lib/elasticsearch-serverless/api/security/get_builtin_privileges.rb +3 -3
  212. data/lib/elasticsearch-serverless/api/security/get_role.rb +11 -8
  213. data/lib/elasticsearch-serverless/api/security/has_privileges.rb +6 -5
  214. data/lib/elasticsearch-serverless/api/security/invalidate_api_key.rb +8 -6
  215. data/lib/elasticsearch-serverless/api/security/put_role.rb +3 -4
  216. data/lib/elasticsearch-serverless/api/security/query_api_keys.rb +12 -6
  217. data/lib/elasticsearch-serverless/api/security/query_role.rb +61 -0
  218. data/lib/elasticsearch-serverless/api/security/update_api_key.rb +74 -0
  219. data/lib/elasticsearch-serverless/api/sql/clear_cursor.rb +4 -4
  220. data/lib/elasticsearch-serverless/api/sql/delete_async.rb +10 -6
  221. data/lib/elasticsearch-serverless/api/sql/get_async.rb +16 -13
  222. data/lib/elasticsearch-serverless/api/sql/get_async_status.rb +6 -6
  223. data/lib/elasticsearch-serverless/api/sql/query.rb +8 -5
  224. data/lib/elasticsearch-serverless/api/sql/translate.rb +6 -4
  225. data/lib/elasticsearch-serverless/api/synonyms/delete_synonym.rb +17 -6
  226. data/lib/elasticsearch-serverless/api/synonyms/delete_synonym_rule.rb +7 -7
  227. data/lib/elasticsearch-serverless/api/synonyms/get_synonym.rb +7 -8
  228. data/lib/elasticsearch-serverless/api/synonyms/get_synonym_rule.rb +7 -7
  229. data/lib/elasticsearch-serverless/api/synonyms/get_synonyms_sets.rb +7 -6
  230. data/lib/elasticsearch-serverless/api/synonyms/put_synonym.rb +9 -6
  231. data/lib/elasticsearch-serverless/api/synonyms/put_synonym_rule.rb +9 -7
  232. data/lib/elasticsearch-serverless/api/tasks/get.rb +9 -7
  233. data/lib/elasticsearch-serverless/api/terms_enum.rb +7 -9
  234. data/lib/elasticsearch-serverless/api/termvectors.rb +40 -17
  235. data/lib/elasticsearch-serverless/api/transform/delete_transform.rb +3 -5
  236. data/lib/elasticsearch-serverless/api/transform/get_transform.rb +5 -6
  237. data/lib/elasticsearch-serverless/api/transform/get_transform_stats.rb +4 -5
  238. data/lib/elasticsearch-serverless/api/transform/preview_transform.rb +4 -5
  239. data/lib/elasticsearch-serverless/api/transform/put_transform.rb +3 -4
  240. data/lib/elasticsearch-serverless/api/transform/reset_transform.rb +4 -5
  241. data/lib/elasticsearch-serverless/api/transform/schedule_now_transform.rb +7 -8
  242. data/lib/elasticsearch-serverless/api/transform/start_transform.rb +3 -5
  243. data/lib/elasticsearch-serverless/api/transform/stop_transform.rb +3 -4
  244. data/lib/elasticsearch-serverless/api/transform/update_transform.rb +3 -4
  245. data/lib/elasticsearch-serverless/api/update.rb +36 -24
  246. data/lib/elasticsearch-serverless/api/update_by_query.rb +102 -31
  247. data/lib/elasticsearch-serverless/api.rb +22 -25
  248. data/lib/elasticsearch-serverless/version.rb +1 -1
  249. data/lib/elasticsearch-serverless.rb +7 -0
  250. metadata +18 -7
@@ -0,0 +1,74 @@
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 Security
24
+ module Actions
25
+ # Update an API key.
26
+ # Update attributes of an existing API key.
27
+ # This API supports updates to an API key's access scope, expiration, and metadata.
28
+ # To use this API, you must have at least the +manage_own_api_key+ cluster privilege.
29
+ # Users can only update API keys that they created or that were granted to them.
30
+ # To update another user’s API key, use the +run_as+ feature to submit a request on behalf of another user.
31
+ # IMPORTANT: It's not possible to use an API key as the authentication credential for this API. The owner user’s credentials are required.
32
+ # Use this API to update API keys created by the create API key or grant API Key APIs.
33
+ # If you need to apply the same update to many API keys, you can use the bulk update API keys API to reduce overhead.
34
+ # It's not possible to update expired API keys or API keys that have been invalidated by the invalidate API key API.
35
+ # The access scope of an API key is derived from the +role_descriptors+ you specify in the request and a snapshot of the owner user's permissions at the time of the request.
36
+ # The snapshot of the owner's permissions is updated automatically on every call.
37
+ # IMPORTANT: If you don't specify +role_descriptors+ in the request, a call to this API might still change the API key's access scope.
38
+ # This change can occur if the owner user's permissions have changed since the API key was created or last modified.
39
+ #
40
+ # @option arguments [String] :id The ID of the API key to update. (*Required*)
41
+ # @option arguments [Hash] :headers Custom HTTP headers
42
+ # @option arguments [Hash] :body request body
43
+ #
44
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-update-api-key
45
+ #
46
+ def update_api_key(arguments = {})
47
+ request_opts = { endpoint: arguments[:endpoint] || 'security.update_api_key' }
48
+
49
+ defined_params = [:id].each_with_object({}) do |variable, set_variables|
50
+ set_variables[variable] = arguments[variable] if arguments.key?(variable)
51
+ end
52
+ request_opts[:defined_params] = defined_params unless defined_params.empty?
53
+
54
+ raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
55
+
56
+ arguments = arguments.clone
57
+ headers = arguments.delete(:headers) || {}
58
+
59
+ body = arguments.delete(:body)
60
+
61
+ _id = arguments.delete(:id)
62
+
63
+ method = ElasticsearchServerless::API::HTTP_PUT
64
+ path = "_security/api_key/#{Utils.listify(_id)}"
65
+ params = {}
66
+
67
+ ElasticsearchServerless::API::Response.new(
68
+ perform_request(method, path, params, body, headers, request_opts)
69
+ )
70
+ end
71
+ end
72
+ end
73
+ end
74
+ end
@@ -22,15 +22,15 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module SQL
24
24
  module Actions
25
- # Clears the SQL cursor
25
+ # Clear an SQL search cursor.
26
26
  #
27
27
  # @option arguments [Hash] :headers Custom HTTP headers
28
28
  # @option arguments [Hash] :body request body
29
29
  #
30
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-sql-cursor-api.html
30
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-clear-cursor
31
31
  #
32
32
  def clear_cursor(arguments = {})
33
- request_opts = { endpoint: arguments[:endpoint] || "sql.clear_cursor" }
33
+ request_opts = { endpoint: arguments[:endpoint] || 'sql.clear_cursor' }
34
34
 
35
35
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
36
36
 
@@ -40,7 +40,7 @@ module ElasticsearchServerless
40
40
  body = arguments.delete(:body)
41
41
 
42
42
  method = ElasticsearchServerless::API::HTTP_POST
43
- path = "_sql/close"
43
+ path = '_sql/close'
44
44
  params = {}
45
45
 
46
46
  ElasticsearchServerless::API::Response.new(
@@ -22,19 +22,23 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module SQL
24
24
  module Actions
25
- # Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it.
25
+ # Delete an async SQL search.
26
+ # Delete an async SQL search or a stored synchronous SQL search.
27
+ # If the search is still running, the API cancels it.
28
+ # If the Elasticsearch security features are enabled, only the following users can use this API to delete a search:
29
+ # * Users with the +cancel_task+ cluster privilege.
30
+ # * The user who first submitted the search.
26
31
  #
27
- # @option arguments [String] :id Identifier for the search. (*Required*)
32
+ # @option arguments [String] :id The identifier for the search. (*Required*)
28
33
  # @option arguments [Hash] :headers Custom HTTP headers
29
34
  #
30
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-async-sql-search-api.html
35
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-delete-async
31
36
  #
32
37
  def delete_async(arguments = {})
33
- request_opts = { endpoint: arguments[:endpoint] || "sql.delete_async" }
38
+ request_opts = { endpoint: arguments[:endpoint] || 'sql.delete_async' }
34
39
 
35
- defined_params = [:id].inject({}) do |set_variables, variable|
40
+ defined_params = [:id].each_with_object({}) do |variable, set_variables|
36
41
  set_variables[variable] = arguments[variable] if arguments.key?(variable)
37
- set_variables
38
42
  end
39
43
  request_opts[:defined_params] = defined_params unless defined_params.empty?
40
44
 
@@ -22,26 +22,29 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module SQL
24
24
  module Actions
25
- # Returns the current status and available results for an async SQL search or stored synchronous SQL search
25
+ # Get async SQL search results.
26
+ # Get the current status and available results for an async SQL search or stored synchronous SQL search.
27
+ # If the Elasticsearch security features are enabled, only the user who first submitted the SQL search can retrieve the search using this API.
26
28
  #
27
- # @option arguments [String] :id Identifier for the search. (*Required*)
28
- # @option arguments [String] :delimiter Separator for CSV results. The API only supports this parameter for CSV responses. Server default: ,.
29
- # @option arguments [String] :format Format for the response. You must specify a format using this parameter or the
30
- # Accept HTTP header. If you specify both, the API uses this parameter.
31
- # @option arguments [Time] :keep_alive Retention period for the search and its results. Defaults
32
- # to the +keep_alive+ period for the original SQL search.
33
- # @option arguments [Time] :wait_for_completion_timeout Period to wait for complete results. Defaults to no timeout,
34
- # meaning the request waits for complete search results.
29
+ # @option arguments [String] :id The identifier for the search. (*Required*)
30
+ # @option arguments [String] :delimiter The separator for CSV results.
31
+ # The API supports this parameter only for CSV responses. Server default: ,.
32
+ # @option arguments [String] :format The format for the response.
33
+ # You must specify a format using this parameter or the +Accept+ HTTP header.
34
+ # If you specify both, the API uses this parameter.
35
+ # @option arguments [Time] :keep_alive The retention period for the search and its results.
36
+ # It defaults to the +keep_alive+ period for the original SQL search.
37
+ # @option arguments [Time] :wait_for_completion_timeout The period to wait for complete results.
38
+ # It defaults to no timeout, meaning the request waits for complete search results.
35
39
  # @option arguments [Hash] :headers Custom HTTP headers
36
40
  #
37
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-sql-search-api.html
41
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-get-async
38
42
  #
39
43
  def get_async(arguments = {})
40
- request_opts = { endpoint: arguments[:endpoint] || "sql.get_async" }
44
+ request_opts = { endpoint: arguments[:endpoint] || 'sql.get_async' }
41
45
 
42
- defined_params = [:id].inject({}) do |set_variables, variable|
46
+ defined_params = [:id].each_with_object({}) do |variable, set_variables|
43
47
  set_variables[variable] = arguments[variable] if arguments.key?(variable)
44
- set_variables
45
48
  end
46
49
  request_opts[:defined_params] = defined_params unless defined_params.empty?
47
50
 
@@ -22,19 +22,19 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module SQL
24
24
  module Actions
25
- # Returns the current status of an async SQL search or a stored synchronous SQL search
25
+ # Get the async SQL search status.
26
+ # Get the current status of an async SQL search or a stored synchronous SQL search.
26
27
  #
27
- # @option arguments [String] :id Identifier for the search. (*Required*)
28
+ # @option arguments [String] :id The identifier for the search. (*Required*)
28
29
  # @option arguments [Hash] :headers Custom HTTP headers
29
30
  #
30
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-sql-search-status-api.html
31
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-get-async-status
31
32
  #
32
33
  def get_async_status(arguments = {})
33
- request_opts = { endpoint: arguments[:endpoint] || "sql.get_async_status" }
34
+ request_opts = { endpoint: arguments[:endpoint] || 'sql.get_async_status' }
34
35
 
35
- defined_params = [:id].inject({}) do |set_variables, variable|
36
+ defined_params = [:id].each_with_object({}) do |variable, set_variables|
36
37
  set_variables[variable] = arguments[variable] if arguments.key?(variable)
37
- set_variables
38
38
  end
39
39
  request_opts[:defined_params] = defined_params unless defined_params.empty?
40
40
 
@@ -22,16 +22,19 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module SQL
24
24
  module Actions
25
- # Executes a SQL request
25
+ # Get SQL search results.
26
+ # Run an SQL request.
26
27
  #
27
- # @option arguments [String] :format Format for the response.
28
+ # @option arguments [String] :format The format for the response.
29
+ # You can also specify a format using the +Accept+ HTTP header.
30
+ # If you specify both this parameter and the +Accept+ HTTP header, this parameter takes precedence.
28
31
  # @option arguments [Hash] :headers Custom HTTP headers
29
32
  # @option arguments [Hash] :body request body
30
33
  #
31
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-search-api.html
34
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-query
32
35
  #
33
36
  def query(arguments = {})
34
- request_opts = { endpoint: arguments[:endpoint] || "sql.query" }
37
+ request_opts = { endpoint: arguments[:endpoint] || 'sql.query' }
35
38
 
36
39
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
37
40
 
@@ -41,7 +44,7 @@ module ElasticsearchServerless
41
44
  body = arguments.delete(:body)
42
45
 
43
46
  method = ElasticsearchServerless::API::HTTP_POST
44
- path = "_sql"
47
+ path = '_sql'
45
48
  params = Utils.process_params(arguments)
46
49
 
47
50
  ElasticsearchServerless::API::Response.new(
@@ -22,15 +22,17 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module SQL
24
24
  module Actions
25
- # Translates SQL into Elasticsearch queries
25
+ # Translate SQL into Elasticsearch queries.
26
+ # Translate an SQL search into a search API request containing Query DSL.
27
+ # It accepts the same request body parameters as the SQL search API, excluding +cursor+.
26
28
  #
27
29
  # @option arguments [Hash] :headers Custom HTTP headers
28
30
  # @option arguments [Hash] :body request body
29
31
  #
30
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-translate-api.html
32
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-translate
31
33
  #
32
34
  def translate(arguments = {})
33
- request_opts = { endpoint: arguments[:endpoint] || "sql.translate" }
35
+ request_opts = { endpoint: arguments[:endpoint] || 'sql.translate' }
34
36
 
35
37
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
36
38
 
@@ -40,7 +42,7 @@ module ElasticsearchServerless
40
42
  body = arguments.delete(:body)
41
43
 
42
44
  method = ElasticsearchServerless::API::HTTP_POST
43
- path = "_sql/translate"
45
+ path = '_sql/translate'
44
46
  params = {}
45
47
 
46
48
  ElasticsearchServerless::API::Response.new(
@@ -22,19 +22,30 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Synonyms
24
24
  module Actions
25
- # Deletes a synonym set
25
+ # Delete a synonym set.
26
+ # You can only delete a synonyms set that is not in use by any index analyzer.
27
+ # Synonyms sets can be used in synonym graph token filters and synonym token filters.
28
+ # These synonym filters can be used as part of search analyzers.
29
+ # Analyzers need to be loaded when an index is restored (such as when a node starts, or the index becomes open).
30
+ # Even if the analyzer is not used on any field mapping, it still needs to be loaded on the index recovery phase.
31
+ # If any analyzers cannot be loaded, the index becomes unavailable and the cluster status becomes red or yellow as index shards are not available.
32
+ # To prevent that, synonyms sets that are used in analyzers can't be deleted.
33
+ # A delete request in this case will return a 400 response code.
34
+ # To remove a synonyms set, you must first remove all indices that contain analyzers using it.
35
+ # You can migrate an index by creating a new index that does not contain the token filter with the synonyms set, and use the reindex API in order to copy over the index data.
36
+ # Once finished, you can delete the index.
37
+ # When the synonyms set is not used in analyzers, you will be able to delete it.
26
38
  #
27
- # @option arguments [String] :id The id of the synonyms set to be deleted (*Required*)
39
+ # @option arguments [String] :id The synonyms set identifier to delete. (*Required*)
28
40
  # @option arguments [Hash] :headers Custom HTTP headers
29
41
  #
30
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-synonyms-set.html
42
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-delete-synonym
31
43
  #
32
44
  def delete_synonym(arguments = {})
33
- request_opts = { endpoint: arguments[:endpoint] || "synonyms.delete_synonym" }
45
+ request_opts = { endpoint: arguments[:endpoint] || 'synonyms.delete_synonym' }
34
46
 
35
- defined_params = [:id].inject({}) do |set_variables, variable|
47
+ defined_params = [:id].each_with_object({}) do |variable, set_variables|
36
48
  set_variables[variable] = arguments[variable] if arguments.key?(variable)
37
- set_variables
38
49
  end
39
50
  request_opts[:defined_params] = defined_params unless defined_params.empty?
40
51
 
@@ -22,20 +22,20 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Synonyms
24
24
  module Actions
25
- # Deletes a synonym rule in a synonym set
25
+ # Delete a synonym rule.
26
+ # Delete a synonym rule from a synonym set.
26
27
  #
27
- # @option arguments [String] :set_id The id of the synonym set to be updated (*Required*)
28
- # @option arguments [String] :rule_id The id of the synonym rule to be deleted (*Required*)
28
+ # @option arguments [String] :set_id The ID of the synonym set to update. (*Required*)
29
+ # @option arguments [String] :rule_id The ID of the synonym rule to delete. (*Required*)
29
30
  # @option arguments [Hash] :headers Custom HTTP headers
30
31
  #
31
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-synonym-rule.html
32
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-delete-synonym-rule
32
33
  #
33
34
  def delete_synonym_rule(arguments = {})
34
- request_opts = { endpoint: arguments[:endpoint] || "synonyms.delete_synonym_rule" }
35
+ request_opts = { endpoint: arguments[:endpoint] || 'synonyms.delete_synonym_rule' }
35
36
 
36
- defined_params = [:set_id, :rule_id].inject({}) do |set_variables, variable|
37
+ defined_params = [:set_id, :rule_id].each_with_object({}) do |variable, set_variables|
37
38
  set_variables[variable] = arguments[variable] if arguments.key?(variable)
38
- set_variables
39
39
  end
40
40
  request_opts[:defined_params] = defined_params unless defined_params.empty?
41
41
 
@@ -22,21 +22,20 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Synonyms
24
24
  module Actions
25
- # Retrieves a synonym set
25
+ # Get a synonym set.
26
26
  #
27
- # @option arguments [String] :id "The id of the synonyms set to be retrieved (*Required*)
28
- # @option arguments [Integer] :from Starting offset for query rules to be retrieved Server default: 0.
29
- # @option arguments [Integer] :size specifies a max number of query rules to retrieve Server default: 10.
27
+ # @option arguments [String] :id The synonyms set identifier to retrieve. (*Required*)
28
+ # @option arguments [Integer] :from The starting offset for query rules to retrieve. Server default: 0.
29
+ # @option arguments [Integer] :size The max number of query rules to retrieve. Server default: 10.
30
30
  # @option arguments [Hash] :headers Custom HTTP headers
31
31
  #
32
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/get-synonyms-set.html
32
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-get-synonym
33
33
  #
34
34
  def get_synonym(arguments = {})
35
- request_opts = { endpoint: arguments[:endpoint] || "synonyms.get_synonym" }
35
+ request_opts = { endpoint: arguments[:endpoint] || 'synonyms.get_synonym' }
36
36
 
37
- defined_params = [:id].inject({}) do |set_variables, variable|
37
+ defined_params = [:id].each_with_object({}) do |variable, set_variables|
38
38
  set_variables[variable] = arguments[variable] if arguments.key?(variable)
39
- set_variables
40
39
  end
41
40
  request_opts[:defined_params] = defined_params unless defined_params.empty?
42
41
 
@@ -22,20 +22,20 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Synonyms
24
24
  module Actions
25
- # Retrieves a synonym rule from a synonym set
25
+ # Get a synonym rule.
26
+ # Get a synonym rule from a synonym set.
26
27
  #
27
- # @option arguments [String] :set_id The id of the synonym set to retrieve the synonym rule from (*Required*)
28
- # @option arguments [String] :rule_id The id of the synonym rule to retrieve (*Required*)
28
+ # @option arguments [String] :set_id The ID of the synonym set to retrieve the synonym rule from. (*Required*)
29
+ # @option arguments [String] :rule_id The ID of the synonym rule to retrieve. (*Required*)
29
30
  # @option arguments [Hash] :headers Custom HTTP headers
30
31
  #
31
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/get-synonym-rule.html
32
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-get-synonym-rule
32
33
  #
33
34
  def get_synonym_rule(arguments = {})
34
- request_opts = { endpoint: arguments[:endpoint] || "synonyms.get_synonym_rule" }
35
+ request_opts = { endpoint: arguments[:endpoint] || 'synonyms.get_synonym_rule' }
35
36
 
36
- defined_params = [:set_id, :rule_id].inject({}) do |set_variables, variable|
37
+ defined_params = [:set_id, :rule_id].each_with_object({}) do |variable, set_variables|
37
38
  set_variables[variable] = arguments[variable] if arguments.key?(variable)
38
- set_variables
39
39
  end
40
40
  request_opts[:defined_params] = defined_params unless defined_params.empty?
41
41
 
@@ -22,16 +22,17 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Synonyms
24
24
  module Actions
25
- # Retrieves a summary of all defined synonym sets
25
+ # Get all synonym sets.
26
+ # Get a summary of all defined synonym sets.
26
27
  #
27
- # @option arguments [Integer] :from Starting offset Server default: 0.
28
- # @option arguments [Integer] :size specifies a max number of results to get Server default: 10.
28
+ # @option arguments [Integer] :from The starting offset for synonyms sets to retrieve. Server default: 0.
29
+ # @option arguments [Integer] :size The maximum number of synonyms sets to retrieve. Server default: 10.
29
30
  # @option arguments [Hash] :headers Custom HTTP headers
30
31
  #
31
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/list-synonyms-sets.html
32
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-get-synonym
32
33
  #
33
34
  def get_synonyms_sets(arguments = {})
34
- request_opts = { endpoint: arguments[:endpoint] || "synonyms.get_synonyms_sets" }
35
+ request_opts = { endpoint: arguments[:endpoint] || 'synonyms.get_synonyms_sets' }
35
36
 
36
37
  arguments = arguments.clone
37
38
  headers = arguments.delete(:headers) || {}
@@ -39,7 +40,7 @@ module ElasticsearchServerless
39
40
  body = nil
40
41
 
41
42
  method = ElasticsearchServerless::API::HTTP_GET
42
- path = "_synonyms"
43
+ path = '_synonyms'
43
44
  params = Utils.process_params(arguments)
44
45
 
45
46
  ElasticsearchServerless::API::Response.new(
@@ -22,20 +22,23 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Synonyms
24
24
  module Actions
25
- # Creates or updates a synonym set.
25
+ # Create or update a synonym set.
26
+ # Synonyms sets are limited to a maximum of 10,000 synonym rules per set.
27
+ # If you need to manage more synonym rules, you can create multiple synonym sets.
28
+ # When an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices.
29
+ # This is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.
26
30
  #
27
- # @option arguments [String] :id The id of the synonyms set to be created or updated (*Required*)
31
+ # @option arguments [String] :id The ID of the synonyms set to be created or updated. (*Required*)
28
32
  # @option arguments [Hash] :headers Custom HTTP headers
29
33
  # @option arguments [Hash] :body request body
30
34
  #
31
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/put-synonyms-set.html
35
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-put-synonym
32
36
  #
33
37
  def put_synonym(arguments = {})
34
- request_opts = { endpoint: arguments[:endpoint] || "synonyms.put_synonym" }
38
+ request_opts = { endpoint: arguments[:endpoint] || 'synonyms.put_synonym' }
35
39
 
36
- defined_params = [:id].inject({}) do |set_variables, variable|
40
+ defined_params = [:id].each_with_object({}) do |variable, set_variables|
37
41
  set_variables[variable] = arguments[variable] if arguments.key?(variable)
38
- set_variables
39
42
  end
40
43
  request_opts[:defined_params] = defined_params unless defined_params.empty?
41
44
 
@@ -22,21 +22,23 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Synonyms
24
24
  module Actions
25
- # Creates or updates a synonym rule in a synonym set
25
+ # Create or update a synonym rule.
26
+ # Create or update a synonym rule in a synonym set.
27
+ # If any of the synonym rules included is invalid, the API returns an error.
28
+ # When you update a synonym rule, all analyzers using the synonyms set will be reloaded automatically to reflect the new rule.
26
29
  #
27
- # @option arguments [String] :set_id The id of the synonym set to be updated with the synonym rule (*Required*)
28
- # @option arguments [String] :rule_id The id of the synonym rule to be updated or created (*Required*)
30
+ # @option arguments [String] :set_id The ID of the synonym set. (*Required*)
31
+ # @option arguments [String] :rule_id The ID of the synonym rule to be updated or created. (*Required*)
29
32
  # @option arguments [Hash] :headers Custom HTTP headers
30
33
  # @option arguments [Hash] :body request body
31
34
  #
32
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/put-synonym-rule.html
35
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-put-synonym-rule
33
36
  #
34
37
  def put_synonym_rule(arguments = {})
35
- request_opts = { endpoint: arguments[:endpoint] || "synonyms.put_synonym_rule" }
38
+ request_opts = { endpoint: arguments[:endpoint] || 'synonyms.put_synonym_rule' }
36
39
 
37
- defined_params = [:set_id, :rule_id].inject({}) do |set_variables, variable|
40
+ defined_params = [:set_id, :rule_id].each_with_object({}) do |variable, set_variables|
38
41
  set_variables[variable] = arguments[variable] if arguments.key?(variable)
39
- set_variables
40
42
  end
41
43
  request_opts[:defined_params] = defined_params unless defined_params.empty?
42
44
 
@@ -23,26 +23,28 @@ module ElasticsearchServerless
23
23
  module Tasks
24
24
  module Actions
25
25
  # Get task information.
26
- # Returns information about the tasks currently executing in the cluster.
26
+ # Get information about a task currently running in the cluster.
27
+ # WARNING: The task management API is new and should still be considered a beta feature.
28
+ # The API may change in ways that are not backwards compatible.
29
+ # If the task identifier is not found, a 404 response code indicates that there are no resources that match the request.
27
30
  # This functionality is Experimental and may be changed or removed
28
31
  # completely in a future release. Elastic will take a best effort approach
29
32
  # to fix any issues, but experimental features are not subject to the
30
33
  # support SLA of official GA features.
31
34
  #
32
- # @option arguments [String] :task_id ID of the task. (*Required*)
33
- # @option arguments [Time] :timeout Period to wait for a response.
35
+ # @option arguments [String] :task_id The task identifier. (*Required*)
36
+ # @option arguments [Time] :timeout The period to wait for a response.
34
37
  # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
35
38
  # @option arguments [Boolean] :wait_for_completion If +true+, the request blocks until the task has completed.
36
39
  # @option arguments [Hash] :headers Custom HTTP headers
37
40
  #
38
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html
41
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks
39
42
  #
40
43
  def get(arguments = {})
41
- request_opts = { endpoint: arguments[:endpoint] || "tasks.get" }
44
+ request_opts = { endpoint: arguments[:endpoint] || 'tasks.get' }
42
45
 
43
- defined_params = [:task_id].inject({}) do |set_variables, variable|
46
+ defined_params = [:task_id].each_with_object({}) do |variable, set_variables|
44
47
  set_variables[variable] = arguments[variable] if arguments.key?(variable)
45
- set_variables
46
48
  end
47
49
  request_opts[:defined_params] = defined_params unless defined_params.empty?
48
50
 
@@ -23,23 +23,21 @@ module ElasticsearchServerless
23
23
  module Actions
24
24
  # Get terms in an index.
25
25
  # Discover terms that match a partial string in an index.
26
- # This "terms enum" API is designed for low-latency look-ups used in auto-complete scenarios.
27
- # If the +complete+ property in the response is false, the returned terms set may be incomplete and should be treated as approximate.
28
- # This can occur due to a few reasons, such as a request timeout or a node error.
29
- # NOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents.
26
+ # This API is designed for low-latency look-ups used in auto-complete scenarios.
30
27
  #
31
- # @option arguments [String] :index Comma-separated list of data streams, indices, and index aliases to search. Wildcard (*) expressions are supported. (*Required*)
28
+ # @option arguments [String] :index A comma-separated list of data streams, indices, and index aliases to search.
29
+ # Wildcard (+*+) expressions are supported.
30
+ # To search all data streams or indices, omit this parameter or use +*+ or +_all+. (*Required*)
32
31
  # @option arguments [Hash] :headers Custom HTTP headers
33
32
  # @option arguments [Hash] :body request body
34
33
  #
35
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-terms-enum.html
34
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-terms-enum
36
35
  #
37
36
  def terms_enum(arguments = {})
38
- request_opts = { endpoint: arguments[:endpoint] || "terms_enum" }
37
+ request_opts = { endpoint: arguments[:endpoint] || 'terms_enum' }
39
38
 
40
- defined_params = [:index].inject({}) do |set_variables, variable|
39
+ defined_params = [:index].each_with_object({}) do |variable, set_variables|
41
40
  set_variables[variable] = arguments[variable] if arguments.key?(variable)
42
- set_variables
43
41
  end
44
42
  request_opts[:defined_params] = defined_params unless defined_params.empty?
45
43