elasticsearch-serverless 0.2.0 → 0.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (242) hide show
  1. checksums.yaml +4 -4
  2. data/lib/elasticsearch-serverless/api/async_search/delete.rb +9 -1
  3. data/lib/elasticsearch-serverless/api/async_search/get.rb +17 -3
  4. data/lib/elasticsearch-serverless/api/async_search/status.rb +9 -1
  5. data/lib/elasticsearch-serverless/api/async_search/submit.rb +15 -4
  6. data/lib/elasticsearch-serverless/api/bulk.rb +17 -4
  7. data/lib/elasticsearch-serverless/api/cat/aliases.rb +22 -6
  8. data/lib/elasticsearch-serverless/api/cat/component_templates.rb +22 -6
  9. data/lib/elasticsearch-serverless/api/cat/count.rb +25 -8
  10. data/lib/elasticsearch-serverless/api/cat/help.rb +16 -6
  11. data/lib/elasticsearch-serverless/api/cat/indices.rb +31 -9
  12. data/lib/elasticsearch-serverless/api/cat/ml_data_frame_analytics.rb +24 -8
  13. data/lib/elasticsearch-serverless/api/cat/ml_datafeeds.rb +29 -8
  14. data/lib/elasticsearch-serverless/api/cat/ml_jobs.rb +29 -8
  15. data/lib/elasticsearch-serverless/api/cat/ml_trained_models.rb +25 -8
  16. data/lib/elasticsearch-serverless/api/cat/transforms.rb +27 -9
  17. data/lib/elasticsearch-serverless/api/clear_scroll.rb +12 -3
  18. data/lib/elasticsearch-serverless/api/close_point_in_time.rb +3 -1
  19. data/lib/elasticsearch-serverless/api/cluster/delete_component_template.rb +14 -3
  20. data/lib/elasticsearch-serverless/api/cluster/exists_component_template.rb +18 -5
  21. data/lib/elasticsearch-serverless/api/cluster/get_component_template.rb +16 -4
  22. data/lib/elasticsearch-serverless/api/cluster/info.rb +11 -2
  23. data/lib/elasticsearch-serverless/api/cluster/put_component_template.rb +17 -7
  24. data/lib/elasticsearch-serverless/api/connector/check_in.rb +9 -1
  25. data/lib/elasticsearch-serverless/api/connector/delete.rb +14 -6
  26. data/lib/elasticsearch-serverless/api/connector/get.rb +13 -5
  27. data/lib/elasticsearch-serverless/api/connector/list.rb +7 -5
  28. data/lib/elasticsearch-serverless/api/connector/post.rb +7 -5
  29. data/lib/elasticsearch-serverless/api/connector/put.rb +14 -6
  30. data/lib/elasticsearch-serverless/api/connector/sync_job_cancel.rb +13 -5
  31. data/lib/elasticsearch-serverless/api/connector/sync_job_delete.rb +13 -5
  32. data/lib/elasticsearch-serverless/api/connector/sync_job_get.rb +13 -5
  33. data/lib/elasticsearch-serverless/api/connector/sync_job_list.rb +8 -6
  34. data/lib/elasticsearch-serverless/api/connector/sync_job_post.rb +7 -5
  35. data/lib/elasticsearch-serverless/api/connector/update_active_filtering.rb +9 -1
  36. data/lib/elasticsearch-serverless/api/connector/update_api_key_id.rb +13 -5
  37. data/lib/elasticsearch-serverless/api/connector/update_configuration.rb +13 -5
  38. data/lib/elasticsearch-serverless/api/connector/update_error.rb +9 -1
  39. data/lib/elasticsearch-serverless/api/connector/update_filtering.rb +13 -5
  40. data/lib/elasticsearch-serverless/api/connector/update_filtering_validation.rb +9 -1
  41. data/lib/elasticsearch-serverless/api/connector/update_index_name.rb +13 -5
  42. data/lib/elasticsearch-serverless/api/connector/update_name.rb +13 -5
  43. data/lib/elasticsearch-serverless/api/connector/update_native.rb +13 -5
  44. data/lib/elasticsearch-serverless/api/connector/update_pipeline.rb +13 -5
  45. data/lib/elasticsearch-serverless/api/connector/update_scheduling.rb +13 -5
  46. data/lib/elasticsearch-serverless/api/connector/update_service_type.rb +13 -5
  47. data/lib/elasticsearch-serverless/api/connector/update_status.rb +9 -1
  48. data/lib/elasticsearch-serverless/api/count.rb +30 -10
  49. data/lib/elasticsearch-serverless/api/create.rb +21 -5
  50. data/lib/elasticsearch-serverless/api/delete.rb +17 -5
  51. data/lib/elasticsearch-serverless/api/delete_by_query.rb +38 -11
  52. data/lib/elasticsearch-serverless/api/delete_script.rb +14 -3
  53. data/lib/elasticsearch-serverless/api/enrich/delete_policy.rb +10 -1
  54. data/lib/elasticsearch-serverless/api/enrich/execute_policy.rb +9 -1
  55. data/lib/elasticsearch-serverless/api/enrich/get_policy.rb +12 -2
  56. data/lib/elasticsearch-serverless/api/enrich/put_policy.rb +10 -1
  57. data/lib/elasticsearch-serverless/api/enrich/stats.rb +4 -1
  58. data/lib/elasticsearch-serverless/api/eql/delete.rb +12 -2
  59. data/lib/elasticsearch-serverless/api/eql/get.rb +13 -3
  60. data/lib/elasticsearch-serverless/api/eql/get_status.rb +9 -1
  61. data/lib/elasticsearch-serverless/api/eql/search.rb +9 -1
  62. data/lib/elasticsearch-serverless/api/exists.rb +20 -6
  63. data/lib/elasticsearch-serverless/api/exists_source.rb +16 -4
  64. data/lib/elasticsearch-serverless/api/explain.rb +17 -5
  65. data/lib/elasticsearch-serverless/api/field_caps.rb +12 -2
  66. data/lib/elasticsearch-serverless/api/get.rb +18 -5
  67. data/lib/elasticsearch-serverless/api/get_script.rb +10 -1
  68. data/lib/elasticsearch-serverless/api/get_source.rb +10 -1
  69. data/lib/elasticsearch-serverless/api/graph/explore.rb +12 -2
  70. data/lib/elasticsearch-serverless/api/index.rb +25 -6
  71. data/lib/elasticsearch-serverless/api/indices/add_block.rb +11 -2
  72. data/lib/elasticsearch-serverless/api/indices/analyze.rb +12 -2
  73. data/lib/elasticsearch-serverless/api/indices/create.rb +16 -4
  74. data/lib/elasticsearch-serverless/api/indices/create_data_stream.rb +16 -2
  75. data/lib/elasticsearch-serverless/api/indices/data_streams_stats.rb +15 -3
  76. data/lib/elasticsearch-serverless/api/indices/delete.rb +25 -7
  77. data/lib/elasticsearch-serverless/api/indices/delete_alias.rb +18 -5
  78. data/lib/elasticsearch-serverless/api/indices/delete_data_lifecycle.rb +11 -2
  79. data/lib/elasticsearch-serverless/api/indices/delete_data_stream.rb +10 -1
  80. data/lib/elasticsearch-serverless/api/indices/delete_index_template.rb +9 -1
  81. data/lib/elasticsearch-serverless/api/indices/exists.rb +17 -4
  82. data/lib/elasticsearch-serverless/api/indices/exists_alias.rb +19 -5
  83. data/lib/elasticsearch-serverless/api/indices/exists_index_template.rb +9 -1
  84. data/lib/elasticsearch-serverless/api/indices/explain_data_lifecycle.rb +11 -2
  85. data/lib/elasticsearch-serverless/api/indices/get.rb +18 -4
  86. data/lib/elasticsearch-serverless/api/indices/get_alias.rb +23 -6
  87. data/lib/elasticsearch-serverless/api/indices/get_data_lifecycle.rb +16 -3
  88. data/lib/elasticsearch-serverless/api/indices/get_data_stream.rb +14 -3
  89. data/lib/elasticsearch-serverless/api/indices/get_index_template.rb +9 -1
  90. data/lib/elasticsearch-serverless/api/indices/get_mapping.rb +21 -5
  91. data/lib/elasticsearch-serverless/api/indices/get_settings.rb +26 -6
  92. data/lib/elasticsearch-serverless/api/indices/migrate_to_data_stream.rb +10 -1
  93. data/lib/elasticsearch-serverless/api/indices/modify_data_stream.rb +4 -1
  94. data/lib/elasticsearch-serverless/api/indices/put_alias.rb +20 -5
  95. data/lib/elasticsearch-serverless/api/indices/put_data_lifecycle.rb +22 -6
  96. data/lib/elasticsearch-serverless/api/indices/put_index_template.rb +11 -2
  97. data/lib/elasticsearch-serverless/api/indices/put_mapping.rb +20 -5
  98. data/lib/elasticsearch-serverless/api/indices/put_settings.rb +28 -7
  99. data/lib/elasticsearch-serverless/api/indices/put_template.rb +14 -3
  100. data/lib/elasticsearch-serverless/api/indices/refresh.rb +19 -4
  101. data/lib/elasticsearch-serverless/api/indices/resolve_index.rb +15 -3
  102. data/lib/elasticsearch-serverless/api/indices/rollover.rb +19 -5
  103. data/lib/elasticsearch-serverless/api/indices/simulate_index_template.rb +9 -1
  104. data/lib/elasticsearch-serverless/api/indices/simulate_template.rb +11 -2
  105. data/lib/elasticsearch-serverless/api/indices/update_aliases.rb +8 -3
  106. data/lib/elasticsearch-serverless/api/indices/validate_query.rb +24 -7
  107. data/lib/elasticsearch-serverless/api/inference/delete.rb +9 -1
  108. data/lib/elasticsearch-serverless/api/inference/get.rb +9 -1
  109. data/lib/elasticsearch-serverless/api/inference/inference.rb +9 -1
  110. data/lib/elasticsearch-serverless/api/inference/put.rb +9 -1
  111. data/lib/elasticsearch-serverless/api/info.rb +4 -1
  112. data/lib/elasticsearch-serverless/api/ingest/delete_pipeline.rb +15 -4
  113. data/lib/elasticsearch-serverless/api/ingest/get_pipeline.rb +14 -3
  114. data/lib/elasticsearch-serverless/api/ingest/processor_grok.rb +3 -1
  115. data/lib/elasticsearch-serverless/api/ingest/put_pipeline.rb +9 -1
  116. data/lib/elasticsearch-serverless/api/ingest/simulate.rb +11 -2
  117. data/lib/elasticsearch-serverless/api/license/get.rb +8 -4
  118. data/lib/elasticsearch-serverless/api/logstash/delete_pipeline.rb +9 -1
  119. data/lib/elasticsearch-serverless/api/logstash/get_pipeline.rb +9 -1
  120. data/lib/elasticsearch-serverless/api/logstash/put_pipeline.rb +9 -1
  121. data/lib/elasticsearch-serverless/api/machine_learning/close_job.rb +14 -4
  122. data/lib/elasticsearch-serverless/api/machine_learning/delete_calendar.rb +10 -1
  123. data/lib/elasticsearch-serverless/api/machine_learning/delete_calendar_event.rb +12 -3
  124. data/lib/elasticsearch-serverless/api/machine_learning/delete_calendar_job.rb +12 -3
  125. data/lib/elasticsearch-serverless/api/machine_learning/delete_data_frame_analytics.rb +10 -2
  126. data/lib/elasticsearch-serverless/api/machine_learning/delete_datafeed.rb +16 -4
  127. data/lib/elasticsearch-serverless/api/machine_learning/delete_filter.rb +10 -2
  128. data/lib/elasticsearch-serverless/api/machine_learning/delete_job.rb +17 -6
  129. data/lib/elasticsearch-serverless/api/machine_learning/delete_trained_model.rb +11 -3
  130. data/lib/elasticsearch-serverless/api/machine_learning/delete_trained_model_alias.rb +10 -2
  131. data/lib/elasticsearch-serverless/api/machine_learning/estimate_model_memory.rb +4 -1
  132. data/lib/elasticsearch-serverless/api/machine_learning/evaluate_data_frame.rb +4 -2
  133. data/lib/elasticsearch-serverless/api/machine_learning/flush_job.rb +19 -6
  134. data/lib/elasticsearch-serverless/api/machine_learning/get_calendar_events.rb +9 -1
  135. data/lib/elasticsearch-serverless/api/machine_learning/get_calendars.rb +9 -1
  136. data/lib/elasticsearch-serverless/api/machine_learning/get_data_frame_analytics.rb +24 -4
  137. data/lib/elasticsearch-serverless/api/machine_learning/get_data_frame_analytics_stats.rb +21 -3
  138. data/lib/elasticsearch-serverless/api/machine_learning/get_datafeed_stats.rb +20 -3
  139. data/lib/elasticsearch-serverless/api/machine_learning/get_datafeeds.rb +23 -4
  140. data/lib/elasticsearch-serverless/api/machine_learning/get_filters.rb +9 -1
  141. data/lib/elasticsearch-serverless/api/machine_learning/get_job_stats.rb +21 -3
  142. data/lib/elasticsearch-serverless/api/machine_learning/get_jobs.rb +23 -4
  143. data/lib/elasticsearch-serverless/api/machine_learning/get_overall_buckets.rb +30 -7
  144. data/lib/elasticsearch-serverless/api/machine_learning/get_trained_models.rb +28 -7
  145. data/lib/elasticsearch-serverless/api/machine_learning/get_trained_models_stats.rb +17 -3
  146. data/lib/elasticsearch-serverless/api/machine_learning/infer_trained_model.rb +9 -1
  147. data/lib/elasticsearch-serverless/api/machine_learning/open_job.rb +10 -2
  148. data/lib/elasticsearch-serverless/api/machine_learning/post_calendar_events.rb +9 -1
  149. data/lib/elasticsearch-serverless/api/machine_learning/preview_data_frame_analytics.rb +9 -1
  150. data/lib/elasticsearch-serverless/api/machine_learning/preview_datafeed.rb +13 -2
  151. data/lib/elasticsearch-serverless/api/machine_learning/put_calendar.rb +9 -1
  152. data/lib/elasticsearch-serverless/api/machine_learning/put_calendar_job.rb +9 -1
  153. data/lib/elasticsearch-serverless/api/machine_learning/put_data_frame_analytics.rb +12 -2
  154. data/lib/elasticsearch-serverless/api/machine_learning/put_datafeed.rb +17 -5
  155. data/lib/elasticsearch-serverless/api/machine_learning/put_filter.rb +9 -1
  156. data/lib/elasticsearch-serverless/api/machine_learning/put_job.rb +11 -2
  157. data/lib/elasticsearch-serverless/api/machine_learning/put_trained_model.rb +14 -3
  158. data/lib/elasticsearch-serverless/api/machine_learning/put_trained_model_alias.rb +12 -2
  159. data/lib/elasticsearch-serverless/api/machine_learning/put_trained_model_definition_part.rb +11 -2
  160. data/lib/elasticsearch-serverless/api/machine_learning/put_trained_model_vocabulary.rb +9 -1
  161. data/lib/elasticsearch-serverless/api/machine_learning/reset_job.rb +14 -3
  162. data/lib/elasticsearch-serverless/api/machine_learning/start_data_frame_analytics.rb +14 -3
  163. data/lib/elasticsearch-serverless/api/machine_learning/start_datafeed.rb +27 -8
  164. data/lib/elasticsearch-serverless/api/machine_learning/start_trained_model_deployment.rb +25 -5
  165. data/lib/elasticsearch-serverless/api/machine_learning/stop_data_frame_analytics.rb +23 -4
  166. data/lib/elasticsearch-serverless/api/machine_learning/stop_datafeed.rb +19 -3
  167. data/lib/elasticsearch-serverless/api/machine_learning/stop_trained_model_deployment.rb +15 -3
  168. data/lib/elasticsearch-serverless/api/machine_learning/update_data_frame_analytics.rb +12 -2
  169. data/lib/elasticsearch-serverless/api/machine_learning/update_datafeed.rb +21 -4
  170. data/lib/elasticsearch-serverless/api/machine_learning/update_filter.rb +9 -1
  171. data/lib/elasticsearch-serverless/api/machine_learning/update_job.rb +9 -1
  172. data/lib/elasticsearch-serverless/api/machine_learning/update_trained_model_deployment.rb +15 -2
  173. data/lib/elasticsearch-serverless/api/mget.rb +17 -4
  174. data/lib/elasticsearch-serverless/api/msearch.rb +15 -1
  175. data/lib/elasticsearch-serverless/api/msearch_template.rb +16 -4
  176. data/lib/elasticsearch-serverless/api/mtermvectors.rb +14 -8
  177. data/lib/elasticsearch-serverless/api/open_point_in_time.rb +14 -3
  178. data/lib/elasticsearch-serverless/api/ping.rb +4 -1
  179. data/lib/elasticsearch-serverless/api/put_script.rb +18 -5
  180. data/lib/elasticsearch-serverless/api/query_rules/delete_rule.rb +9 -1
  181. data/lib/elasticsearch-serverless/api/query_rules/delete_ruleset.rb +9 -1
  182. data/lib/elasticsearch-serverless/api/query_rules/get_rule.rb +9 -1
  183. data/lib/elasticsearch-serverless/api/query_rules/get_ruleset.rb +9 -1
  184. data/lib/elasticsearch-serverless/api/query_rules/list_rulesets.rb +3 -1
  185. data/lib/elasticsearch-serverless/api/query_rules/put_rule.rb +9 -1
  186. data/lib/elasticsearch-serverless/api/query_rules/put_ruleset.rb +9 -1
  187. data/lib/elasticsearch-serverless/api/rank_eval.rb +11 -2
  188. data/lib/elasticsearch-serverless/api/reindex.rb +11 -7
  189. data/lib/elasticsearch-serverless/api/render_search_template.rb +11 -2
  190. data/lib/elasticsearch-serverless/api/scripts_painless_execute.rb +4 -1
  191. data/lib/elasticsearch-serverless/api/scroll.rb +9 -1
  192. data/lib/elasticsearch-serverless/api/search.rb +107 -30
  193. data/lib/elasticsearch-serverless/api/search_application/delete.rb +9 -1
  194. data/lib/elasticsearch-serverless/api/search_application/delete_behavioral_analytics.rb +9 -1
  195. data/lib/elasticsearch-serverless/api/search_application/get.rb +9 -1
  196. data/lib/elasticsearch-serverless/api/search_application/get_behavioral_analytics.rb +9 -1
  197. data/lib/elasticsearch-serverless/api/search_application/list.rb +3 -1
  198. data/lib/elasticsearch-serverless/api/search_application/put.rb +9 -1
  199. data/lib/elasticsearch-serverless/api/search_application/put_behavioral_analytics.rb +9 -1
  200. data/lib/elasticsearch-serverless/api/search_application/search.rb +9 -1
  201. data/lib/elasticsearch-serverless/api/search_mvt.rb +27 -7
  202. data/lib/elasticsearch-serverless/api/search_template.rb +22 -6
  203. data/lib/elasticsearch-serverless/api/security/authenticate.rb +6 -2
  204. data/lib/elasticsearch-serverless/api/security/create_api_key.rb +4 -1
  205. data/lib/elasticsearch-serverless/api/security/get_api_key.rb +19 -7
  206. data/lib/elasticsearch-serverless/api/security/has_privileges.rb +10 -1
  207. data/lib/elasticsearch-serverless/api/security/invalidate_api_key.rb +4 -1
  208. data/lib/elasticsearch-serverless/api/security/query_api_keys.rb +7 -3
  209. data/lib/elasticsearch-serverless/api/security/update_api_key.rb +10 -1
  210. data/lib/elasticsearch-serverless/api/sql/clear_cursor.rb +3 -1
  211. data/lib/elasticsearch-serverless/api/sql/delete_async.rb +9 -1
  212. data/lib/elasticsearch-serverless/api/sql/get_async.rb +15 -4
  213. data/lib/elasticsearch-serverless/api/sql/get_async_status.rb +9 -1
  214. data/lib/elasticsearch-serverless/api/sql/query.rb +3 -1
  215. data/lib/elasticsearch-serverless/api/sql/translate.rb +3 -1
  216. data/lib/elasticsearch-serverless/api/synonyms/delete_synonym.rb +9 -1
  217. data/lib/elasticsearch-serverless/api/synonyms/delete_synonym_rule.rb +9 -1
  218. data/lib/elasticsearch-serverless/api/synonyms/get_synonym.rb +9 -1
  219. data/lib/elasticsearch-serverless/api/synonyms/get_synonym_rule.rb +9 -1
  220. data/lib/elasticsearch-serverless/api/synonyms/get_synonyms_sets.rb +3 -1
  221. data/lib/elasticsearch-serverless/api/synonyms/put_synonym.rb +9 -1
  222. data/lib/elasticsearch-serverless/api/synonyms/put_synonym_rule.rb +9 -1
  223. data/lib/elasticsearch-serverless/api/tasks/get.rb +13 -3
  224. data/lib/elasticsearch-serverless/api/terms_enum.rb +9 -1
  225. data/lib/elasticsearch-serverless/api/termvectors.rb +21 -9
  226. data/lib/elasticsearch-serverless/api/transform/delete_transform.rb +14 -3
  227. data/lib/elasticsearch-serverless/api/transform/get_transform.rb +23 -4
  228. data/lib/elasticsearch-serverless/api/transform/get_transform_stats.rb +20 -3
  229. data/lib/elasticsearch-serverless/api/transform/preview_transform.rb +15 -5
  230. data/lib/elasticsearch-serverless/api/transform/put_transform.rb +17 -7
  231. data/lib/elasticsearch-serverless/api/transform/reset_transform.rb +14 -3
  232. data/lib/elasticsearch-serverless/api/transform/schedule_now_transform.rb +11 -3
  233. data/lib/elasticsearch-serverless/api/transform/start_transform.rb +10 -3
  234. data/lib/elasticsearch-serverless/api/transform/stop_transform.rb +23 -6
  235. data/lib/elasticsearch-serverless/api/transform/update_transform.rb +15 -4
  236. data/lib/elasticsearch-serverless/api/update.rb +23 -7
  237. data/lib/elasticsearch-serverless/api/update_by_query.rb +36 -9
  238. data/lib/elasticsearch-serverless/api.rb +3 -2
  239. data/lib/elasticsearch-serverless/version.rb +1 -1
  240. data/lib/elasticsearch-serverless.rb +4 -3
  241. metadata +5 -76
  242. data/lib/elasticsearch-serverless/api/connector/last_sync.rb +0 -59
@@ -22,32 +22,53 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Cat
24
24
  module Actions
25
+ # Get datafeeds.
25
26
  # Returns configuration and usage information about datafeeds.
26
27
  # This API returns a maximum of 10,000 datafeeds.
27
28
  # If the Elasticsearch security features are enabled, you must have +monitor_ml+, +monitor+, +manage_ml+, or +manage+
28
29
  # cluster privileges to use this API.
29
- #
30
- # IMPORTANT: cat APIs are only intended for human consumption using the Kibana
30
+ # 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
  #
34
34
  # @option arguments [String] :datafeed_id A numerical character string that uniquely identifies the datafeed.
35
- # @option arguments [Boolean] :allow_no_match Specifies what to do when the request: * Contains wildcard expressions and there are no datafeeds that match. * Contains the +_all+ string or no identifiers and there are no matches. * Contains wildcard expressions and there are only partial matches. If +true+, the API returns an empty datafeeds array when there are no matches and the subset of results when there are partial matches. If +false+, the API returns a 404 status code when there are no matches or only partial matches. Server default: true.
35
+ # @option arguments [Boolean] :allow_no_match Specifies what to do when the request:
36
+ # - Contains wildcard expressions and there are no datafeeds that match.
37
+ # - Contains the +_all+ string or no identifiers and there are no matches.
38
+ # - Contains wildcard expressions and there are only partial matches.
39
+ # If +true+, the API returns an empty datafeeds array when there are no matches and the subset of results when
40
+ # there are partial matches. If +false+, the API returns a 404 status code when there are no matches or only
41
+ # partial matches. Server default: true.
36
42
  # @option arguments [String, Array<String>] :h Comma-separated list of column names to display. Server default: ['bc', 'id', 'sc', 's'].
37
43
  # @option arguments [String, Array<String>] :s Comma-separated list of column names or column aliases used to sort the response.
38
44
  # @option arguments [String] :time The unit used to display time values.
39
- # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
45
+ # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
46
+ # +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
40
47
  # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
41
- # @option arguments [Boolean] :help When set to +true+ will output available columns. This option can't be combined with any other query string option.
42
- # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the local cluster state. If +false+ the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.
48
+ # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
49
+ # 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.
43
54
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
44
- # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting +:asc+ or +:desc+ as a suffix to the column name.
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.
45
58
  # @option arguments [Boolean] :v When set to +true+ will enable verbose output.
46
59
  # @option arguments [Hash] :headers Custom HTTP headers
47
60
  #
48
61
  # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html
49
62
  #
50
63
  def ml_datafeeds(arguments = {})
64
+ request_opts = { endpoint: arguments[:endpoint] || "cat.ml_datafeeds" }
65
+
66
+ defined_params = [:datafeed_id].inject({}) do |set_variables, variable|
67
+ set_variables[variable] = arguments[variable] if arguments.key?(variable)
68
+ set_variables
69
+ end
70
+ request_opts[:defined_params] = defined_params unless defined_params.empty?
71
+
51
72
  arguments = arguments.clone
52
73
  headers = arguments.delete(:headers) || {}
53
74
 
@@ -64,7 +85,7 @@ module ElasticsearchServerless
64
85
  params = Utils.process_params(arguments)
65
86
 
66
87
  ElasticsearchServerless::API::Response.new(
67
- perform_request(method, path, params, body, headers)
88
+ perform_request(method, path, params, body, headers, request_opts)
68
89
  )
69
90
  end
70
91
  end
@@ -22,33 +22,54 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Cat
24
24
  module Actions
25
+ # Get anomaly detection jobs.
25
26
  # Returns configuration and usage information for anomaly detection jobs.
26
27
  # This API returns a maximum of 10,000 jobs.
27
28
  # If the Elasticsearch security features are enabled, you must have +monitor_ml+,
28
29
  # +monitor+, +manage_ml+, or +manage+ cluster privileges to use this API.
29
- #
30
- # IMPORTANT: cat APIs are only intended for human consumption using the Kibana
30
+ # 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
  #
34
34
  # @option arguments [String] :job_id Identifier for the anomaly detection job.
35
- # @option arguments [Boolean] :allow_no_match Specifies what to do when the request: * Contains wildcard expressions and there are no jobs that match. * Contains the +_all+ string or no identifiers and there are no matches. * Contains wildcard expressions and there are only partial matches. If +true+, the API returns an empty jobs array when there are no matches and the subset of results when there are partial matches. If +false+, the API returns a 404 status code when there are no matches or only partial matches. Server default: true.
35
+ # @option arguments [Boolean] :allow_no_match Specifies what to do when the request:
36
+ # - Contains wildcard expressions and there are no jobs that match.
37
+ # - Contains the +_all+ string or no identifiers and there are no matches.
38
+ # - Contains wildcard expressions and there are only partial matches.
39
+ # If +true+, the API returns an empty jobs array when there are no matches and the subset of results when there
40
+ # are partial matches. If +false+, the API returns a 404 status code when there are no matches or only partial
41
+ # matches. Server default: true.
36
42
  # @option arguments [String] :bytes The unit used to display byte values.
37
43
  # @option arguments [String, Array<String>] :h Comma-separated list of column names to display. Server default: buckets.count,data.processed_records,forecasts.total,id,model.bytes,model.memory_status,state.
38
44
  # @option arguments [String, Array<String>] :s Comma-separated list of column names or column aliases used to sort the response.
39
45
  # @option arguments [String] :time The unit used to display time values.
40
- # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
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.
41
48
  # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
42
- # @option arguments [Boolean] :help When set to +true+ will output available columns. This option 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 local cluster state. If +false+ the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.
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.
44
55
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
45
- # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting +:asc+ or +:desc+ as a suffix to the column name.
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.
46
59
  # @option arguments [Boolean] :v When set to +true+ will enable verbose output.
47
60
  # @option arguments [Hash] :headers Custom HTTP headers
48
61
  #
49
62
  # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-anomaly-detectors.html
50
63
  #
51
64
  def ml_jobs(arguments = {})
65
+ request_opts = { endpoint: arguments[:endpoint] || "cat.ml_jobs" }
66
+
67
+ defined_params = [:job_id].inject({}) do |set_variables, variable|
68
+ set_variables[variable] = arguments[variable] if arguments.key?(variable)
69
+ set_variables
70
+ end
71
+ request_opts[:defined_params] = defined_params unless defined_params.empty?
72
+
52
73
  arguments = arguments.clone
53
74
  headers = arguments.delete(:headers) || {}
54
75
 
@@ -65,7 +86,7 @@ module ElasticsearchServerless
65
86
  params = Utils.process_params(arguments)
66
87
 
67
88
  ElasticsearchServerless::API::Response.new(
68
- perform_request(method, path, params, body, headers)
89
+ perform_request(method, path, params, body, headers, request_opts)
69
90
  )
70
91
  end
71
92
  end
@@ -22,31 +22,48 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Cat
24
24
  module Actions
25
+ # Get trained models.
25
26
  # Returns configuration and usage information about inference trained models.
26
- #
27
- # IMPORTANT: cat APIs are only intended for human consumption using the Kibana
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 trained models statistics API.
30
30
  #
31
31
  # @option arguments [String] :model_id A unique identifier for the trained model.
32
- # @option arguments [Boolean] :allow_no_match Specifies what to do when the request: contains wildcard expressions and there are no models that match; contains the +_all+ string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches. If +true+, the API returns an empty array when there are no matches and the subset of results when there are partial matches. If +false+, the API returns a 404 status code when there are no matches or only partial matches. Server default: true.
32
+ # @option arguments [Boolean] :allow_no_match Specifies what to do when the request: contains wildcard expressions and there are no models that match; contains the +_all+ string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches.
33
+ # If +true+, the API returns an empty array when there are no matches and the subset of results when there are partial matches.
34
+ # If +false+, the API returns a 404 status code when there are no matches or only partial matches. Server default: true.
33
35
  # @option arguments [String] :bytes The unit used to display byte values.
34
36
  # @option arguments [String, Array<String>] :h A comma-separated list of column names to display.
35
37
  # @option arguments [String, Array<String>] :s A comma-separated list of column names or aliases used to sort the response.
36
38
  # @option arguments [Integer] :from Skips the specified number of transforms.
37
39
  # @option arguments [Integer] :size The maximum number of transforms to display.
38
- # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
40
+ # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
41
+ # +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
39
42
  # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
40
- # @option arguments [Boolean] :help When set to +true+ will output available columns. This option can't be combined with any other query string option.
41
- # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the local cluster state. If +false+ the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.
43
+ # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
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.
42
49
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
43
- # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting +:asc+ or +:desc+ as a suffix to the column name.
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.
44
53
  # @option arguments [Boolean] :v When set to +true+ will enable verbose output.
45
54
  # @option arguments [Hash] :headers Custom HTTP headers
46
55
  #
47
56
  # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-trained-model.html
48
57
  #
49
58
  def ml_trained_models(arguments = {})
59
+ request_opts = { endpoint: arguments[:endpoint] || "cat.ml_trained_models" }
60
+
61
+ defined_params = [:model_id].inject({}) do |set_variables, variable|
62
+ set_variables[variable] = arguments[variable] if arguments.key?(variable)
63
+ set_variables
64
+ end
65
+ request_opts[:defined_params] = defined_params unless defined_params.empty?
66
+
50
67
  arguments = arguments.clone
51
68
  headers = arguments.delete(:headers) || {}
52
69
 
@@ -63,7 +80,7 @@ module ElasticsearchServerless
63
80
  params = Utils.process_params(arguments)
64
81
 
65
82
  ElasticsearchServerless::API::Response.new(
66
- perform_request(method, path, params, body, headers)
83
+ perform_request(method, path, params, body, headers, request_opts)
67
84
  )
68
85
  end
69
86
  end
@@ -22,31 +22,49 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Cat
24
24
  module Actions
25
+ # Get transforms.
25
26
  # Returns configuration and usage information about transforms.
26
- #
27
- # IMPORTANT: cat APIs are only intended for human consumption using the Kibana
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.
30
30
  #
31
- # @option arguments [String] :transform_id A transform identifier or a wildcard expression. If you do not specify one of these options, the API returns information for all transforms.
32
- # @option arguments [Boolean] :allow_no_match Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; contains the +_all+ string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches. If +true+, it returns an empty transforms array when there are no matches and the subset of results when there are partial matches. If +false+, the request returns a 404 status code when there are no matches or only partial matches. Server default: true.
31
+ # @option arguments [String] :transform_id A transform identifier or a wildcard expression.
32
+ # If you do not specify one of these options, the API returns information for all transforms.
33
+ # @option arguments [Boolean] :allow_no_match Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; contains the +_all+ string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches.
34
+ # If +true+, it returns an empty transforms array when there are no matches and the subset of results when there are partial matches.
35
+ # If +false+, the request returns a 404 status code when there are no matches or only partial matches. Server default: true.
33
36
  # @option arguments [Integer] :from Skips the specified number of transforms. Server default: 0.
34
37
  # @option arguments [String, Array<String>] :h Comma-separated list of column names to display. Server default: changes_last_detection_time,checkpoint,checkpoint_progress,documents_processed,id,last_search_time,state.
35
38
  # @option arguments [String, Array<String>] :s Comma-separated list of column names or column aliases used to sort the response.
36
39
  # @option arguments [String] :time The unit used to display time values.
37
40
  # @option arguments [Integer] :size The maximum number of transforms to obtain. Server default: 100.
38
- # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
41
+ # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
42
+ # +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
39
43
  # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
40
- # @option arguments [Boolean] :help When set to +true+ will output available columns. This option can't be combined with any other query string option.
41
- # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the local cluster state. If +false+ the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.
44
+ # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
45
+ # 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.
42
50
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
43
- # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting +:asc+ or +:desc+ as a suffix to the column name.
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.
44
54
  # @option arguments [Boolean] :v When set to +true+ will enable verbose output.
45
55
  # @option arguments [Hash] :headers Custom HTTP headers
46
56
  #
47
57
  # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-transforms.html
48
58
  #
49
59
  def transforms(arguments = {})
60
+ request_opts = { endpoint: arguments[:endpoint] || "cat.transforms" }
61
+
62
+ defined_params = [:transform_id].inject({}) do |set_variables, variable|
63
+ set_variables[variable] = arguments[variable] if arguments.key?(variable)
64
+ set_variables
65
+ end
66
+ request_opts[:defined_params] = defined_params unless defined_params.empty?
67
+
50
68
  arguments = arguments.clone
51
69
  headers = arguments.delete(:headers) || {}
52
70
 
@@ -63,7 +81,7 @@ module ElasticsearchServerless
63
81
  params = Utils.process_params(arguments)
64
82
 
65
83
  ElasticsearchServerless::API::Response.new(
66
- perform_request(method, path, params, body, headers)
84
+ perform_request(method, path, params, body, headers, request_opts)
67
85
  )
68
86
  end
69
87
  end
@@ -23,7 +23,8 @@ module ElasticsearchServerless
23
23
  module Actions
24
24
  # Clears the search context and results for a scrolling search.
25
25
  #
26
- # @option arguments [String, Array] :scroll_id Comma-separated list of scroll IDs to clear. To clear all scroll IDs, use +_all+.
26
+ # @option arguments [String, Array] :scroll_id Comma-separated list of scroll IDs to clear.
27
+ # To clear all scroll IDs, use +_all+.
27
28
  # @option arguments [Hash] :headers Custom HTTP headers
28
29
  # @option arguments [Hash] :body request body
29
30
  #
@@ -35,6 +36,14 @@ module ElasticsearchServerless
35
36
  # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-scroll-api.html
36
37
  #
37
38
  def clear_scroll(arguments = {})
39
+ request_opts = { endpoint: arguments[:endpoint] || "clear_scroll" }
40
+
41
+ defined_params = [:scroll_id].inject({}) do |set_variables, variable|
42
+ set_variables[variable] = arguments[variable] if arguments.key?(variable)
43
+ set_variables
44
+ end
45
+ request_opts[:defined_params] = defined_params unless defined_params.empty?
46
+
38
47
  arguments = arguments.clone
39
48
  headers = arguments.delete(:headers) || {}
40
49
 
@@ -53,12 +62,12 @@ module ElasticsearchServerless
53
62
  if Array(arguments[:ignore]).include?(404)
54
63
  Utils.rescue_from_not_found {
55
64
  ElasticsearchServerless::API::Response.new(
56
- perform_request(method, path, params, body, headers)
65
+ perform_request(method, path, params, body, headers, request_opts)
57
66
  )
58
67
  }
59
68
  else
60
69
  ElasticsearchServerless::API::Response.new(
61
- perform_request(method, path, params, body, headers)
70
+ perform_request(method, path, params, body, headers, request_opts)
62
71
  )
63
72
  end
64
73
  end
@@ -29,6 +29,8 @@ module ElasticsearchServerless
29
29
  # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/point-in-time-api.html
30
30
  #
31
31
  def close_point_in_time(arguments = {})
32
+ request_opts = { endpoint: arguments[:endpoint] || "close_point_in_time" }
33
+
32
34
  arguments = arguments.clone
33
35
  headers = arguments.delete(:headers) || {}
34
36
 
@@ -39,7 +41,7 @@ module ElasticsearchServerless
39
41
  params = {}
40
42
 
41
43
  ElasticsearchServerless::API::Response.new(
42
- perform_request(method, path, params, body, headers)
44
+ perform_request(method, path, params, body, headers, request_opts)
43
45
  )
44
46
  end
45
47
  end
@@ -22,17 +22,28 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Cluster
24
24
  module Actions
25
+ # Delete component templates.
25
26
  # Deletes component templates.
26
27
  # Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.
27
28
  #
28
29
  # @option arguments [String, Array<String>] :name Comma-separated list or wildcard expression of component template names used to limit the request. (*Required*)
29
- # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
30
- # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
30
+ # @option arguments [Time] :master_timeout Period to wait for a connection to the master node.
31
+ # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
32
+ # @option arguments [Time] :timeout Period to wait for a response.
33
+ # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
31
34
  # @option arguments [Hash] :headers Custom HTTP headers
32
35
  #
33
36
  # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html
34
37
  #
35
38
  def delete_component_template(arguments = {})
39
+ request_opts = { endpoint: arguments[:endpoint] || "cluster.delete_component_template" }
40
+
41
+ defined_params = [:name].inject({}) do |set_variables, variable|
42
+ set_variables[variable] = arguments[variable] if arguments.key?(variable)
43
+ set_variables
44
+ end
45
+ request_opts[:defined_params] = defined_params unless defined_params.empty?
46
+
36
47
  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
37
48
 
38
49
  arguments = arguments.clone
@@ -47,7 +58,7 @@ module ElasticsearchServerless
47
58
  params = Utils.process_params(arguments)
48
59
 
49
60
  ElasticsearchServerless::API::Response.new(
50
- perform_request(method, path, params, body, headers)
61
+ perform_request(method, path, params, body, headers, request_opts)
51
62
  )
52
63
  end
53
64
  end
@@ -22,16 +22,29 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Cluster
24
24
  module Actions
25
- # Returns information about whether a particular component template exist
25
+ # Check component templates.
26
+ # Returns information about whether a particular component template exists.
26
27
  #
27
- # @option arguments [String, Array<String>] :name Comma-separated list of component template names used to limit the request. Wildcard (*) expressions are supported. (*Required*)
28
- # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
29
- # @option arguments [Boolean] :local If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.
28
+ # @option arguments [String, Array<String>] :name Comma-separated list of component template names used to limit the request.
29
+ # Wildcard (*) expressions are supported. (*Required*)
30
+ # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. If no response is
31
+ # received before the timeout expires, the request fails and returns an
32
+ # error. Server default: 30s.
33
+ # @option arguments [Boolean] :local If true, the request retrieves information from the local node only.
34
+ # Defaults to false, which means information is retrieved from the master node.
30
35
  # @option arguments [Hash] :headers Custom HTTP headers
31
36
  #
32
37
  # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html
33
38
  #
34
39
  def exists_component_template(arguments = {})
40
+ request_opts = { endpoint: arguments[:endpoint] || "cluster.exists_component_template" }
41
+
42
+ defined_params = [:name].inject({}) do |set_variables, variable|
43
+ set_variables[variable] = arguments[variable] if arguments.key?(variable)
44
+ set_variables
45
+ end
46
+ request_opts[:defined_params] = defined_params unless defined_params.empty?
47
+
35
48
  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
36
49
 
37
50
  arguments = arguments.clone
@@ -46,7 +59,7 @@ module ElasticsearchServerless
46
59
  params = Utils.process_params(arguments)
47
60
 
48
61
  ElasticsearchServerless::API::Response.new(
49
- perform_request(method, path, params, body, headers)
62
+ perform_request(method, path, params, body, headers, request_opts)
50
63
  )
51
64
  end
52
65
 
@@ -22,18 +22,30 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Cluster
24
24
  module Actions
25
+ # Get component templates.
25
26
  # Retrieves information about component templates.
26
27
  #
27
- # @option arguments [String] :name Comma-separated list of component template names used to limit the request. Wildcard (+*+) expressions are supported.
28
+ # @option arguments [String] :name Comma-separated list of component template names used to limit the request.
29
+ # Wildcard (+*+) expressions are supported.
28
30
  # @option arguments [Boolean] :flat_settings If +true+, returns settings in flat format.
29
31
  # @option arguments [Boolean] :include_defaults Return all default configurations for the component template (default: false)
30
- # @option arguments [Boolean] :local If +true+, the request retrieves information from the local node only. If +false+, information is retrieved from the master node.
31
- # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
32
+ # @option arguments [Boolean] :local If +true+, the request retrieves information from the local node only.
33
+ # If +false+, information is retrieved from the master node.
34
+ # @option arguments [Time] :master_timeout Period to wait for a connection to the master node.
35
+ # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
32
36
  # @option arguments [Hash] :headers Custom HTTP headers
33
37
  #
34
38
  # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html
35
39
  #
36
40
  def get_component_template(arguments = {})
41
+ request_opts = { endpoint: arguments[:endpoint] || "cluster.get_component_template" }
42
+
43
+ defined_params = [:name].inject({}) do |set_variables, variable|
44
+ set_variables[variable] = arguments[variable] if arguments.key?(variable)
45
+ set_variables
46
+ end
47
+ request_opts[:defined_params] = defined_params unless defined_params.empty?
48
+
37
49
  arguments = arguments.clone
38
50
  headers = arguments.delete(:headers) || {}
39
51
 
@@ -50,7 +62,7 @@ module ElasticsearchServerless
50
62
  params = Utils.process_params(arguments)
51
63
 
52
64
  ElasticsearchServerless::API::Response.new(
53
- perform_request(method, path, params, body, headers)
65
+ perform_request(method, path, params, body, headers, request_opts)
54
66
  )
55
67
  end
56
68
  end
@@ -22,7 +22,8 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Cluster
24
24
  module Actions
25
- # Returns different information about the cluster.
25
+ # Get cluster info.
26
+ # Returns basic information about the cluster.
26
27
  #
27
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*)
28
29
  # @option arguments [Hash] :headers Custom HTTP headers
@@ -30,6 +31,14 @@ module ElasticsearchServerless
30
31
  # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-info.html
31
32
  #
32
33
  def info(arguments = {})
34
+ request_opts = { endpoint: arguments[:endpoint] || "cluster.info" }
35
+
36
+ defined_params = [:target].inject({}) do |set_variables, variable|
37
+ set_variables[variable] = arguments[variable] if arguments.key?(variable)
38
+ set_variables
39
+ end
40
+ request_opts[:defined_params] = defined_params unless defined_params.empty?
41
+
33
42
  raise ArgumentError, "Required argument 'target' missing" unless arguments[:target]
34
43
 
35
44
  arguments = arguments.clone
@@ -44,7 +53,7 @@ module ElasticsearchServerless
44
53
  params = {}
45
54
 
46
55
  ElasticsearchServerless::API::Response.new(
47
- perform_request(method, path, params, body, headers)
56
+ perform_request(method, path, params, body, headers, request_opts)
48
57
  )
49
58
  end
50
59
  end
@@ -22,31 +22,41 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Cluster
24
24
  module Actions
25
+ # Create or update a component template.
25
26
  # Creates or updates a component template.
26
27
  # Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.
27
- #
28
28
  # An index template can be composed of multiple component templates.
29
29
  # To use a component template, specify it in an index template’s +composed_of+ list.
30
30
  # Component templates are only applied to new data streams and indices as part of a matching index template.
31
- #
32
31
  # Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.
33
- #
34
32
  # Component templates are only used during index creation.
35
33
  # For data streams, this includes data stream creation and the creation of a stream’s backing indices.
36
34
  # Changes to component templates do not affect existing indices, including a stream’s backing indices.
37
- #
38
35
  # You can use C-style +/* *\/+ block comments in component templates.
39
36
  # You can include comments anywhere in the request body except before the opening curly bracket.
40
37
  #
41
- # @option arguments [String] :name Name of the component template to create. Elasticsearch includes the following built-in component templates: +logs-mappings+; 'logs-settings+; +metrics-mappings+; +metrics-settings+;+synthetics-mapping+; +synthetics-settings+. Elastic Agent uses these templates to configure backing indices for its data streams. If you use Elastic Agent and want to overwrite one of these templates, set the +version+ for your replacement template higher than the current version. If you don’t use Elastic Agent and want to disable all built-in component and index templates, set +stack.templates.enabled+ to +false+ using the cluster update settings API. (*Required*)
38
+ # @option arguments [String] :name Name of the component template to create.
39
+ # Elasticsearch includes the following built-in component templates: +logs-mappings+; +logs-settings+; +metrics-mappings+; +metrics-settings+;+synthetics-mapping+; +synthetics-settings+.
40
+ # Elastic Agent uses these templates to configure backing indices for its data streams.
41
+ # If you use Elastic Agent and want to overwrite one of these templates, set the +version+ for your replacement template higher than the current version.
42
+ # If you don’t use Elastic Agent and want to disable all built-in component and index templates, set +stack.templates.enabled+ to +false+ using the cluster update settings API. (*Required*)
42
43
  # @option arguments [Boolean] :create If +true+, this request cannot replace or update existing component templates.
43
- # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
44
+ # @option arguments [Time] :master_timeout Period to wait for a connection to the master node.
45
+ # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
44
46
  # @option arguments [Hash] :headers Custom HTTP headers
45
47
  # @option arguments [Hash] :body request body
46
48
  #
47
49
  # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html
48
50
  #
49
51
  def put_component_template(arguments = {})
52
+ request_opts = { endpoint: arguments[:endpoint] || "cluster.put_component_template" }
53
+
54
+ defined_params = [:name].inject({}) do |set_variables, variable|
55
+ set_variables[variable] = arguments[variable] if arguments.key?(variable)
56
+ set_variables
57
+ end
58
+ request_opts[:defined_params] = defined_params unless defined_params.empty?
59
+
50
60
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
51
61
  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
52
62
 
@@ -62,7 +72,7 @@ module ElasticsearchServerless
62
72
  params = Utils.process_params(arguments)
63
73
 
64
74
  ElasticsearchServerless::API::Response.new(
65
- perform_request(method, path, params, body, headers)
75
+ perform_request(method, path, params, body, headers, request_opts)
66
76
  )
67
77
  end
68
78
  end
@@ -34,6 +34,14 @@ module ElasticsearchServerless
34
34
  # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/check-in-connector-api.html
35
35
  #
36
36
  def check_in(arguments = {})
37
+ request_opts = { endpoint: arguments[:endpoint] || "connector.check_in" }
38
+
39
+ defined_params = [:connector_id].inject({}) do |set_variables, variable|
40
+ set_variables[variable] = arguments[variable] if arguments.key?(variable)
41
+ set_variables
42
+ end
43
+ request_opts[:defined_params] = defined_params unless defined_params.empty?
44
+
37
45
  raise ArgumentError, "Required argument 'connector_id' missing" unless arguments[:connector_id]
38
46
 
39
47
  arguments = arguments.clone
@@ -48,7 +56,7 @@ module ElasticsearchServerless
48
56
  params = {}
49
57
 
50
58
  ElasticsearchServerless::API::Response.new(
51
- perform_request(method, path, params, body, headers)
59
+ perform_request(method, path, params, body, headers, request_opts)
52
60
  )
53
61
  end
54
62
  end
@@ -23,18 +23,26 @@ module ElasticsearchServerless
23
23
  module Connector
24
24
  module Actions
25
25
  # Deletes a connector.
26
- # This functionality is Experimental and may be changed or removed
27
- # completely in a future release. Elastic will take a best effort approach
28
- # to fix any issues, but experimental features are not subject to the
29
- # support SLA of official GA features.
26
+ # This functionality is in Beta and is subject to change. The design and
27
+ # code is less mature than official GA features and is being provided
28
+ # as-is with no warranties. Beta features are not subject to the support
29
+ # SLA of official GA features.
30
30
  #
31
31
  # @option arguments [String] :connector_id The unique identifier of the connector to be deleted (*Required*)
32
- # @option arguments [Boolean] :delete_sync_jobs Determines whether associated sync jobs are also deleted. (*Required*)
32
+ # @option arguments [Boolean] :delete_sync_jobs A flag indicating if associated sync jobs should be also removed. Defaults to false.
33
33
  # @option arguments [Hash] :headers Custom HTTP headers
34
34
  #
35
35
  # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-connector-api.html
36
36
  #
37
37
  def delete(arguments = {})
38
+ request_opts = { endpoint: arguments[:endpoint] || "connector.delete" }
39
+
40
+ defined_params = [:connector_id].inject({}) do |set_variables, variable|
41
+ set_variables[variable] = arguments[variable] if arguments.key?(variable)
42
+ set_variables
43
+ end
44
+ request_opts[:defined_params] = defined_params unless defined_params.empty?
45
+
38
46
  raise ArgumentError, "Required argument 'connector_id' missing" unless arguments[:connector_id]
39
47
 
40
48
  arguments = arguments.clone
@@ -49,7 +57,7 @@ module ElasticsearchServerless
49
57
  params = Utils.process_params(arguments)
50
58
 
51
59
  ElasticsearchServerless::API::Response.new(
52
- perform_request(method, path, params, body, headers)
60
+ perform_request(method, path, params, body, headers, request_opts)
53
61
  )
54
62
  end
55
63
  end