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
@@ -23,7 +23,7 @@ module ElasticsearchServerless
23
23
  module Cat
24
24
  module Actions
25
25
  # Get index information.
26
- # Returns high-level information about indices in a cluster, including backing indices for data streams.
26
+ # Get high-level information about indices in a cluster, including backing indices for data streams.
27
27
  # Use this request to get the following information for each index in a cluster:
28
28
  # - shard count
29
29
  # - document count
@@ -43,30 +43,25 @@ module ElasticsearchServerless
43
43
  # @option arguments [Boolean] :include_unloaded_segments If true, the response includes information from segments that are not loaded into memory.
44
44
  # @option arguments [Boolean] :pri If true, the response only includes information from primary shards.
45
45
  # @option arguments [String] :time The unit used to display time values.
46
- # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
47
- # +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
48
- # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
49
- # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
50
- # can't be combined with any other query string option.
51
- # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the
52
- # local cluster state. If +false+ the list of selected nodes are computed
53
- # from the cluster state of the master node. In both cases the coordinating
54
- # node will send requests for further information to each selected node.
55
46
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
47
+ # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
56
48
  # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
57
49
  # Sorting defaults to ascending and can be changed by setting +:asc+
58
50
  # or +:desc+ as a suffix to the column name.
51
+ # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
52
+ # +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
53
+ # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
54
+ # can't be combined with any other query string option.
59
55
  # @option arguments [Boolean] :v When set to +true+ will enable verbose output.
60
56
  # @option arguments [Hash] :headers Custom HTTP headers
61
57
  #
62
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-indices.html
58
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-indices
63
59
  #
64
60
  def indices(arguments = {})
65
- request_opts = { endpoint: arguments[:endpoint] || "cat.indices" }
61
+ request_opts = { endpoint: arguments[:endpoint] || 'cat.indices' }
66
62
 
67
- defined_params = [:index].inject({}) do |set_variables, variable|
63
+ defined_params = [:index].each_with_object({}) do |variable, set_variables|
68
64
  set_variables[variable] = arguments[variable] if arguments.key?(variable)
69
- set_variables
70
65
  end
71
66
  request_opts[:defined_params] = defined_params unless defined_params.empty?
72
67
 
@@ -81,7 +76,7 @@ module ElasticsearchServerless
81
76
  path = if _index
82
77
  "_cat/indices/#{Utils.listify(_index)}"
83
78
  else
84
- "_cat/indices"
79
+ '_cat/indices'
85
80
  end
86
81
  params = Utils.process_params(arguments)
87
82
  params[:h] = Utils.listify(params[:h]) if params[:h]
@@ -23,8 +23,8 @@ module ElasticsearchServerless
23
23
  module Cat
24
24
  module Actions
25
25
  # Get data frame analytics jobs.
26
- # Returns configuration and usage information about data frame analytics jobs.
27
- # CAT APIs are only intended for human consumption using the Kibana
26
+ # Get configuration and usage information about data frame analytics jobs.
27
+ # IMPORTANT: CAT APIs are only intended for human consumption using the Kibana
28
28
  # console or command line. They are not intended for use by applications. For
29
29
  # application consumption, use the get data frame analytics jobs statistics API.
30
30
  #
@@ -34,31 +34,21 @@ module ElasticsearchServerless
34
34
  # @option arguments [String, Array<String>] :h Comma-separated list of column names to display. Server default: create_time,id,state,type.
35
35
  # @option arguments [String, Array<String>] :s Comma-separated list of column names or column aliases used to sort the
36
36
  # response.
37
- # @option arguments [Time] :time Unit used to display time values.
37
+ # @option arguments [String] :time Unit used to display time values.
38
38
  # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
39
39
  # +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
40
- # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
41
40
  # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
42
41
  # can't be combined with any other query string option.
43
- # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the
44
- # local cluster state. If +false+ the list of selected nodes are computed
45
- # from the cluster state of the master node. In both cases the coordinating
46
- # node will send requests for further information to each selected node.
47
- # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
48
- # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
49
- # Sorting defaults to ascending and can be changed by setting +:asc+
50
- # or +:desc+ as a suffix to the column name.
51
42
  # @option arguments [Boolean] :v When set to +true+ will enable verbose output.
52
43
  # @option arguments [Hash] :headers Custom HTTP headers
53
44
  #
54
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-dfanalytics.html
45
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-data-frame-analytics
55
46
  #
56
47
  def ml_data_frame_analytics(arguments = {})
57
- request_opts = { endpoint: arguments[:endpoint] || "cat.ml_data_frame_analytics" }
48
+ request_opts = { endpoint: arguments[:endpoint] || 'cat.ml_data_frame_analytics' }
58
49
 
59
- defined_params = [:id].inject({}) do |set_variables, variable|
50
+ defined_params = [:id].each_with_object({}) do |variable, set_variables|
60
51
  set_variables[variable] = arguments[variable] if arguments.key?(variable)
61
- set_variables
62
52
  end
63
53
  request_opts[:defined_params] = defined_params unless defined_params.empty?
64
54
 
@@ -73,7 +63,7 @@ module ElasticsearchServerless
73
63
  path = if _id
74
64
  "_cat/ml/data_frame/analytics/#{Utils.listify(_id)}"
75
65
  else
76
- "_cat/ml/data_frame/analytics"
66
+ '_cat/ml/data_frame/analytics'
77
67
  end
78
68
  params = Utils.process_params(arguments)
79
69
 
@@ -23,11 +23,11 @@ module ElasticsearchServerless
23
23
  module Cat
24
24
  module Actions
25
25
  # Get datafeeds.
26
- # Returns configuration and usage information about datafeeds.
26
+ # Get configuration and usage information about datafeeds.
27
27
  # This API returns a maximum of 10,000 datafeeds.
28
28
  # If the Elasticsearch security features are enabled, you must have +monitor_ml+, +monitor+, +manage_ml+, or +manage+
29
29
  # cluster privileges to use this API.
30
- # CAT APIs are only intended for human consumption using the Kibana
30
+ # IMPORTANT: CAT APIs are only intended for human consumption using the Kibana
31
31
  # console or command line. They are not intended for use by applications. For
32
32
  # application consumption, use the get datafeed statistics API.
33
33
  #
@@ -44,28 +44,18 @@ module ElasticsearchServerless
44
44
  # @option arguments [String] :time The unit used to display time values.
45
45
  # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
46
46
  # +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
47
- # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
48
47
  # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
49
48
  # can't be combined with any other query string option.
50
- # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the
51
- # local cluster state. If +false+ the list of selected nodes are computed
52
- # from the cluster state of the master node. In both cases the coordinating
53
- # node will send requests for further information to each selected node.
54
- # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
55
- # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
56
- # Sorting defaults to ascending and can be changed by setting +:asc+
57
- # or +:desc+ as a suffix to the column name.
58
49
  # @option arguments [Boolean] :v When set to +true+ will enable verbose output.
59
50
  # @option arguments [Hash] :headers Custom HTTP headers
60
51
  #
61
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html
52
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-datafeeds
62
53
  #
63
54
  def ml_datafeeds(arguments = {})
64
- request_opts = { endpoint: arguments[:endpoint] || "cat.ml_datafeeds" }
55
+ request_opts = { endpoint: arguments[:endpoint] || 'cat.ml_datafeeds' }
65
56
 
66
- defined_params = [:datafeed_id].inject({}) do |set_variables, variable|
57
+ defined_params = [:datafeed_id].each_with_object({}) do |variable, set_variables|
67
58
  set_variables[variable] = arguments[variable] if arguments.key?(variable)
68
- set_variables
69
59
  end
70
60
  request_opts[:defined_params] = defined_params unless defined_params.empty?
71
61
 
@@ -80,7 +70,7 @@ module ElasticsearchServerless
80
70
  path = if _datafeed_id
81
71
  "_cat/ml/datafeeds/#{Utils.listify(_datafeed_id)}"
82
72
  else
83
- "_cat/ml/datafeeds"
73
+ '_cat/ml/datafeeds'
84
74
  end
85
75
  params = Utils.process_params(arguments)
86
76
 
@@ -23,11 +23,11 @@ module ElasticsearchServerless
23
23
  module Cat
24
24
  module Actions
25
25
  # Get anomaly detection jobs.
26
- # Returns configuration and usage information for anomaly detection jobs.
26
+ # Get configuration and usage information for anomaly detection jobs.
27
27
  # This API returns a maximum of 10,000 jobs.
28
28
  # If the Elasticsearch security features are enabled, you must have +monitor_ml+,
29
29
  # +monitor+, +manage_ml+, or +manage+ cluster privileges to use this API.
30
- # CAT APIs are only intended for human consumption using the Kibana
30
+ # IMPORTANT: CAT APIs are only intended for human consumption using the Kibana
31
31
  # console or command line. They are not intended for use by applications. For
32
32
  # application consumption, use the get anomaly detection job statistics API.
33
33
  #
@@ -45,28 +45,18 @@ module ElasticsearchServerless
45
45
  # @option arguments [String] :time The unit used to display time values.
46
46
  # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
47
47
  # +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
48
- # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
49
48
  # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
50
49
  # can't be combined with any other query string option.
51
- # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the
52
- # local cluster state. If +false+ the list of selected nodes are computed
53
- # from the cluster state of the master node. In both cases the coordinating
54
- # node will send requests for further information to each selected node.
55
- # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
56
- # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
57
- # Sorting defaults to ascending and can be changed by setting +:asc+
58
- # or +:desc+ as a suffix to the column name.
59
50
  # @option arguments [Boolean] :v When set to +true+ will enable verbose output.
60
51
  # @option arguments [Hash] :headers Custom HTTP headers
61
52
  #
62
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-anomaly-detectors.html
53
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-jobs
63
54
  #
64
55
  def ml_jobs(arguments = {})
65
- request_opts = { endpoint: arguments[:endpoint] || "cat.ml_jobs" }
56
+ request_opts = { endpoint: arguments[:endpoint] || 'cat.ml_jobs' }
66
57
 
67
- defined_params = [:job_id].inject({}) do |set_variables, variable|
58
+ defined_params = [:job_id].each_with_object({}) do |variable, set_variables|
68
59
  set_variables[variable] = arguments[variable] if arguments.key?(variable)
69
- set_variables
70
60
  end
71
61
  request_opts[:defined_params] = defined_params unless defined_params.empty?
72
62
 
@@ -81,7 +71,7 @@ module ElasticsearchServerless
81
71
  path = if _job_id
82
72
  "_cat/ml/anomaly_detectors/#{Utils.listify(_job_id)}"
83
73
  else
84
- "_cat/ml/anomaly_detectors"
74
+ '_cat/ml/anomaly_detectors'
85
75
  end
86
76
  params = Utils.process_params(arguments)
87
77
 
@@ -23,8 +23,8 @@ module ElasticsearchServerless
23
23
  module Cat
24
24
  module Actions
25
25
  # Get trained models.
26
- # Returns configuration and usage information about inference trained models.
27
- # CAT APIs are only intended for human consumption using the Kibana
26
+ # Get configuration and usage information about inference trained models.
27
+ # IMPORTANT: CAT APIs are only intended for human consumption using the Kibana
28
28
  # console or command line. They are not intended for use by applications. For
29
29
  # application consumption, use the get trained models statistics API.
30
30
  #
@@ -37,30 +37,21 @@ module ElasticsearchServerless
37
37
  # @option arguments [String, Array<String>] :s A comma-separated list of column names or aliases used to sort the response.
38
38
  # @option arguments [Integer] :from Skips the specified number of transforms.
39
39
  # @option arguments [Integer] :size The maximum number of transforms to display.
40
+ # @option arguments [String] :time Unit used to display time values.
40
41
  # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
41
42
  # +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
42
- # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
43
43
  # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
44
44
  # can't be combined with any other query string option.
45
- # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the
46
- # local cluster state. If +false+ the list of selected nodes are computed
47
- # from the cluster state of the master node. In both cases the coordinating
48
- # node will send requests for further information to each selected node.
49
- # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
50
- # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
51
- # Sorting defaults to ascending and can be changed by setting +:asc+
52
- # or +:desc+ as a suffix to the column name.
53
45
  # @option arguments [Boolean] :v When set to +true+ will enable verbose output.
54
46
  # @option arguments [Hash] :headers Custom HTTP headers
55
47
  #
56
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-trained-model.html
48
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-trained-models
57
49
  #
58
50
  def ml_trained_models(arguments = {})
59
- request_opts = { endpoint: arguments[:endpoint] || "cat.ml_trained_models" }
51
+ request_opts = { endpoint: arguments[:endpoint] || 'cat.ml_trained_models' }
60
52
 
61
- defined_params = [:model_id].inject({}) do |set_variables, variable|
53
+ defined_params = [:model_id].each_with_object({}) do |variable, set_variables|
62
54
  set_variables[variable] = arguments[variable] if arguments.key?(variable)
63
- set_variables
64
55
  end
65
56
  request_opts[:defined_params] = defined_params unless defined_params.empty?
66
57
 
@@ -75,7 +66,7 @@ module ElasticsearchServerless
75
66
  path = if _model_id
76
67
  "_cat/ml/trained_models/#{Utils.listify(_model_id)}"
77
68
  else
78
- "_cat/ml/trained_models"
69
+ '_cat/ml/trained_models'
79
70
  end
80
71
  params = Utils.process_params(arguments)
81
72
 
@@ -22,8 +22,8 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Cat
24
24
  module Actions
25
- # Get transforms.
26
- # Returns configuration and usage information about transforms.
25
+ # Get transform information.
26
+ # Get configuration and usage information about transforms.
27
27
  # CAT APIs are only intended for human consumption using the Kibana
28
28
  # console or command line. They are not intended for use by applications. For
29
29
  # application consumption, use the get transform statistics API.
@@ -40,28 +40,18 @@ module ElasticsearchServerless
40
40
  # @option arguments [Integer] :size The maximum number of transforms to obtain. Server default: 100.
41
41
  # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
42
42
  # +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
43
- # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
44
43
  # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
45
44
  # can't be combined with any other query string option.
46
- # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the
47
- # local cluster state. If +false+ the list of selected nodes are computed
48
- # from the cluster state of the master node. In both cases the coordinating
49
- # node will send requests for further information to each selected node.
50
- # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
51
- # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
52
- # Sorting defaults to ascending and can be changed by setting +:asc+
53
- # or +:desc+ as a suffix to the column name.
54
45
  # @option arguments [Boolean] :v When set to +true+ will enable verbose output.
55
46
  # @option arguments [Hash] :headers Custom HTTP headers
56
47
  #
57
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-transforms.html
48
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-transforms
58
49
  #
59
50
  def transforms(arguments = {})
60
- request_opts = { endpoint: arguments[:endpoint] || "cat.transforms" }
51
+ request_opts = { endpoint: arguments[:endpoint] || 'cat.transforms' }
61
52
 
62
- defined_params = [:transform_id].inject({}) do |set_variables, variable|
53
+ defined_params = [:transform_id].each_with_object({}) do |variable, set_variables|
63
54
  set_variables[variable] = arguments[variable] if arguments.key?(variable)
64
- set_variables
65
55
  end
66
56
  request_opts[:defined_params] = defined_params unless defined_params.empty?
67
57
 
@@ -76,7 +66,7 @@ module ElasticsearchServerless
76
66
  path = if _transform_id
77
67
  "_cat/transforms/#{Utils.listify(_transform_id)}"
78
68
  else
79
- "_cat/transforms"
69
+ '_cat/transforms'
80
70
  end
81
71
  params = Utils.process_params(arguments)
82
72
 
@@ -21,10 +21,12 @@
21
21
  module ElasticsearchServerless
22
22
  module API
23
23
  module Actions
24
- # Clears the search context and results for a scrolling search.
24
+ # Clear a scrolling search.
25
+ # Clear the search context and results for a scrolling search.
25
26
  #
26
- # @option arguments [String, Array] :scroll_id Comma-separated list of scroll IDs to clear.
27
+ # @option arguments [String, Array] :scroll_id A comma-separated list of scroll IDs to clear.
27
28
  # To clear all scroll IDs, use +_all+.
29
+ # IMPORTANT: Scroll IDs can be long. It is recommended to specify scroll IDs in the request body parameter.
28
30
  # @option arguments [Hash] :headers Custom HTTP headers
29
31
  # @option arguments [Hash] :body request body
30
32
  #
@@ -33,10 +35,10 @@ module ElasticsearchServerless
33
35
  # Deprecated since version 7.0.0
34
36
  #
35
37
  #
36
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-scroll-api.html
38
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-clear-scroll
37
39
  #
38
40
  def clear_scroll(arguments = {})
39
- request_opts = { endpoint: arguments[:endpoint] || "clear_scroll" }
41
+ request_opts = { endpoint: arguments[:endpoint] || 'clear_scroll' }
40
42
 
41
43
  arguments = arguments.clone
42
44
  headers = arguments.delete(:headers) || {}
@@ -46,15 +48,15 @@ module ElasticsearchServerless
46
48
  _scroll_id = arguments.delete(:scroll_id)
47
49
 
48
50
  method = ElasticsearchServerless::API::HTTP_DELETE
49
- path = "_search/scroll"
51
+ path = '_search/scroll'
50
52
  params = Utils.process_params(arguments)
51
53
 
52
54
  if Array(arguments[:ignore]).include?(404)
53
- Utils.rescue_from_not_found {
55
+ Utils.rescue_from_not_found do
54
56
  ElasticsearchServerless::API::Response.new(
55
57
  perform_request(method, path, params, body, headers, request_opts)
56
58
  )
57
- }
59
+ end
58
60
  else
59
61
  ElasticsearchServerless::API::Response.new(
60
62
  perform_request(method, path, params, body, headers, request_opts)
@@ -21,15 +21,19 @@
21
21
  module ElasticsearchServerless
22
22
  module API
23
23
  module Actions
24
- # Closes a point-in-time.
24
+ # Close a point in time.
25
+ # A point in time must be opened explicitly before being used in search requests.
26
+ # The +keep_alive+ parameter tells Elasticsearch how long it should persist.
27
+ # A point in time is automatically closed when the +keep_alive+ period has elapsed.
28
+ # However, keeping points in time has a cost; close them as soon as they are no longer required for search requests.
25
29
  #
26
30
  # @option arguments [Hash] :headers Custom HTTP headers
27
31
  # @option arguments [Hash] :body request body
28
32
  #
29
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/point-in-time-api.html
33
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-open-point-in-time
30
34
  #
31
35
  def close_point_in_time(arguments = {})
32
- request_opts = { endpoint: arguments[:endpoint] || "close_point_in_time" }
36
+ request_opts = { endpoint: arguments[:endpoint] || 'close_point_in_time' }
33
37
 
34
38
  arguments = arguments.clone
35
39
  headers = arguments.delete(:headers) || {}
@@ -37,7 +41,7 @@ module ElasticsearchServerless
37
41
  body = arguments.delete(:body)
38
42
 
39
43
  method = ElasticsearchServerless::API::HTTP_DELETE
40
- path = "_pit"
44
+ path = '_pit'
41
45
  params = {}
42
46
 
43
47
  ElasticsearchServerless::API::Response.new(
@@ -23,7 +23,6 @@ module ElasticsearchServerless
23
23
  module Cluster
24
24
  module Actions
25
25
  # Delete component templates.
26
- # Deletes component templates.
27
26
  # Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.
28
27
  #
29
28
  # @option arguments [String, Array<String>] :name Comma-separated list or wildcard expression of component template names used to limit the request. (*Required*)
@@ -33,14 +32,13 @@ module ElasticsearchServerless
33
32
  # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
34
33
  # @option arguments [Hash] :headers Custom HTTP headers
35
34
  #
36
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html
35
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template
37
36
  #
38
37
  def delete_component_template(arguments = {})
39
- request_opts = { endpoint: arguments[:endpoint] || "cluster.delete_component_template" }
38
+ request_opts = { endpoint: arguments[:endpoint] || 'cluster.delete_component_template' }
40
39
 
41
- defined_params = [:name].inject({}) do |set_variables, variable|
40
+ defined_params = [:name].each_with_object({}) do |variable, set_variables|
42
41
  set_variables[variable] = arguments[variable] if arguments.key?(variable)
43
- set_variables
44
42
  end
45
43
  request_opts[:defined_params] = defined_params unless defined_params.empty?
46
44
 
@@ -34,14 +34,13 @@ module ElasticsearchServerless
34
34
  # Defaults to false, which means information is retrieved from the master node.
35
35
  # @option arguments [Hash] :headers Custom HTTP headers
36
36
  #
37
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html
37
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template
38
38
  #
39
39
  def exists_component_template(arguments = {})
40
- request_opts = { endpoint: arguments[:endpoint] || "cluster.exists_component_template" }
40
+ request_opts = { endpoint: arguments[:endpoint] || 'cluster.exists_component_template' }
41
41
 
42
- defined_params = [:name].inject({}) do |set_variables, variable|
42
+ defined_params = [:name].each_with_object({}) do |variable, set_variables|
43
43
  set_variables[variable] = arguments[variable] if arguments.key?(variable)
44
- set_variables
45
44
  end
46
45
  request_opts[:defined_params] = defined_params unless defined_params.empty?
47
46
 
@@ -63,7 +62,7 @@ module ElasticsearchServerless
63
62
  )
64
63
  end
65
64
 
66
- alias_method :exists_component_template?, :exists_component_template
65
+ alias exists_component_template? exists_component_template
67
66
  end
68
67
  end
69
68
  end
@@ -23,7 +23,7 @@ module ElasticsearchServerless
23
23
  module Cluster
24
24
  module Actions
25
25
  # Get component templates.
26
- # Retrieves information about component templates.
26
+ # Get information about component templates.
27
27
  #
28
28
  # @option arguments [String] :name Comma-separated list of component template names used to limit the request.
29
29
  # Wildcard (+*+) expressions are supported.
@@ -35,14 +35,13 @@ module ElasticsearchServerless
35
35
  # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
36
36
  # @option arguments [Hash] :headers Custom HTTP headers
37
37
  #
38
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html
38
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template
39
39
  #
40
40
  def get_component_template(arguments = {})
41
- request_opts = { endpoint: arguments[:endpoint] || "cluster.get_component_template" }
41
+ request_opts = { endpoint: arguments[:endpoint] || 'cluster.get_component_template' }
42
42
 
43
- defined_params = [:name].inject({}) do |set_variables, variable|
43
+ defined_params = [:name].each_with_object({}) do |variable, set_variables|
44
44
  set_variables[variable] = arguments[variable] if arguments.key?(variable)
45
- set_variables
46
45
  end
47
46
  request_opts[:defined_params] = defined_params unless defined_params.empty?
48
47
 
@@ -57,7 +56,7 @@ module ElasticsearchServerless
57
56
  path = if _name
58
57
  "_component_template/#{Utils.listify(_name)}"
59
58
  else
60
- "_component_template"
59
+ '_component_template'
61
60
  end
62
61
  params = Utils.process_params(arguments)
63
62
 
@@ -28,14 +28,13 @@ module ElasticsearchServerless
28
28
  # @option arguments [String, Array<String>] :target Limits the information returned to the specific target. Supports a comma-separated list, such as http,ingest. (*Required*)
29
29
  # @option arguments [Hash] :headers Custom HTTP headers
30
30
  #
31
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-info.html
31
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-info
32
32
  #
33
33
  def info(arguments = {})
34
- request_opts = { endpoint: arguments[:endpoint] || "cluster.info" }
34
+ request_opts = { endpoint: arguments[:endpoint] || 'cluster.info' }
35
35
 
36
- defined_params = [:target].inject({}) do |set_variables, variable|
36
+ defined_params = [:target].each_with_object({}) do |variable, set_variables|
37
37
  set_variables[variable] = arguments[variable] if arguments.key?(variable)
38
- set_variables
39
38
  end
40
39
  request_opts[:defined_params] = defined_params unless defined_params.empty?
41
40
 
@@ -23,7 +23,6 @@ module ElasticsearchServerless
23
23
  module Cluster
24
24
  module Actions
25
25
  # Create or update a component template.
26
- # Creates or updates a component template.
27
26
  # Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.
28
27
  # An index template can be composed of multiple component templates.
29
28
  # To use a component template, specify it in an index template’s +composed_of+ list.
@@ -34,6 +33,9 @@ module ElasticsearchServerless
34
33
  # Changes to component templates do not affect existing indices, including a stream’s backing indices.
35
34
  # You can use C-style +/* *\/+ block comments in component templates.
36
35
  # You can include comments anywhere in the request body except before the opening curly bracket.
36
+ # **Applying component templates**
37
+ # You cannot directly apply a component template to a data stream or index.
38
+ # To be applied, a component template must be included in an index template's +composed_of+ list.
37
39
  #
38
40
  # @option arguments [String] :name Name of the component template to create.
39
41
  # Elasticsearch includes the following built-in component templates: +logs-mappings+; +logs-settings+; +metrics-mappings+; +metrics-settings+;+synthetics-mapping+; +synthetics-settings+.
@@ -46,14 +48,13 @@ module ElasticsearchServerless
46
48
  # @option arguments [Hash] :headers Custom HTTP headers
47
49
  # @option arguments [Hash] :body request body
48
50
  #
49
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html
51
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template
50
52
  #
51
53
  def put_component_template(arguments = {})
52
- request_opts = { endpoint: arguments[:endpoint] || "cluster.put_component_template" }
54
+ request_opts = { endpoint: arguments[:endpoint] || 'cluster.put_component_template' }
53
55
 
54
- defined_params = [:name].inject({}) do |set_variables, variable|
56
+ defined_params = [:name].each_with_object({}) do |variable, set_variables|
55
57
  set_variables[variable] = arguments[variable] if arguments.key?(variable)
56
- set_variables
57
58
  end
58
59
  request_opts[:defined_params] = defined_params unless defined_params.empty?
59
60
 
@@ -32,14 +32,13 @@ module ElasticsearchServerless
32
32
  # @option arguments [String] :connector_id The unique identifier of the connector to be checked in (*Required*)
33
33
  # @option arguments [Hash] :headers Custom HTTP headers
34
34
  #
35
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/check-in-connector-api.html
35
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-check-in
36
36
  #
37
37
  def check_in(arguments = {})
38
- request_opts = { endpoint: arguments[:endpoint] || "connector.check_in" }
38
+ request_opts = { endpoint: arguments[:endpoint] || 'connector.check_in' }
39
39
 
40
- defined_params = [:connector_id].inject({}) do |set_variables, variable|
40
+ defined_params = [:connector_id].each_with_object({}) do |variable, set_variables|
41
41
  set_variables[variable] = arguments[variable] if arguments.key?(variable)
42
- set_variables
43
42
  end
44
43
  request_opts[:defined_params] = defined_params unless defined_params.empty?
45
44
 
@@ -34,16 +34,16 @@ module ElasticsearchServerless
34
34
  #
35
35
  # @option arguments [String] :connector_id The unique identifier of the connector to be deleted (*Required*)
36
36
  # @option arguments [Boolean] :delete_sync_jobs A flag indicating if associated sync jobs should be also removed. Defaults to false.
37
+ # @option arguments [Boolean] :hard A flag indicating if the connector should be hard deleted.
37
38
  # @option arguments [Hash] :headers Custom HTTP headers
38
39
  #
39
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-connector-api.html
40
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-delete
40
41
  #
41
42
  def delete(arguments = {})
42
- request_opts = { endpoint: arguments[:endpoint] || "connector.delete" }
43
+ request_opts = { endpoint: arguments[:endpoint] || 'connector.delete' }
43
44
 
44
- defined_params = [:connector_id].inject({}) do |set_variables, variable|
45
+ defined_params = [:connector_id].each_with_object({}) do |variable, set_variables|
45
46
  set_variables[variable] = arguments[variable] if arguments.key?(variable)
46
- set_variables
47
47
  end
48
48
  request_opts[:defined_params] = defined_params unless defined_params.empty?
49
49
 
@@ -30,16 +30,16 @@ module ElasticsearchServerless
30
30
  # SLA of official GA features.
31
31
  #
32
32
  # @option arguments [String] :connector_id The unique identifier of the connector (*Required*)
33
+ # @option arguments [Boolean] :include_deleted A flag to indicate if the desired connector should be fetched, even if it was soft-deleted.
33
34
  # @option arguments [Hash] :headers Custom HTTP headers
34
35
  #
35
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-connector-api.html
36
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-get
36
37
  #
37
38
  def get(arguments = {})
38
- request_opts = { endpoint: arguments[:endpoint] || "connector.get" }
39
+ request_opts = { endpoint: arguments[:endpoint] || 'connector.get' }
39
40
 
40
- defined_params = [:connector_id].inject({}) do |set_variables, variable|
41
+ defined_params = [:connector_id].each_with_object({}) do |variable, set_variables|
41
42
  set_variables[variable] = arguments[variable] if arguments.key?(variable)
42
- set_variables
43
43
  end
44
44
  request_opts[:defined_params] = defined_params unless defined_params.empty?
45
45
 
@@ -54,7 +54,7 @@ module ElasticsearchServerless
54
54
 
55
55
  method = ElasticsearchServerless::API::HTTP_GET
56
56
  path = "_connector/#{Utils.listify(_connector_id)}"
57
- params = {}
57
+ params = Utils.process_params(arguments)
58
58
 
59
59
  ElasticsearchServerless::API::Response.new(
60
60
  perform_request(method, path, params, body, headers, request_opts)