elasticsearch-serverless 0.1.0.20231031.pre → 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (192) hide show
  1. checksums.yaml +4 -4
  2. data/lib/elasticsearch-serverless/api/async_search/delete.rb +4 -1
  3. data/lib/elasticsearch-serverless/api/async_search/get.rb +2 -1
  4. data/lib/elasticsearch-serverless/api/async_search/status.rb +3 -1
  5. data/lib/elasticsearch-serverless/api/async_search/submit.rb +5 -1
  6. data/lib/elasticsearch-serverless/api/bulk.rb +2 -1
  7. data/lib/elasticsearch-serverless/api/cat/aliases.rb +3 -1
  8. data/lib/elasticsearch-serverless/api/cat/component_templates.rb +4 -1
  9. data/lib/elasticsearch-serverless/api/cat/count.rb +4 -1
  10. data/lib/elasticsearch-serverless/api/cat/indices.rb +6 -1
  11. data/lib/elasticsearch-serverless/api/cat/ml_data_frame_analytics.rb +5 -1
  12. data/lib/elasticsearch-serverless/api/cat/ml_datafeeds.rb +8 -1
  13. data/lib/elasticsearch-serverless/api/cat/ml_jobs.rb +8 -1
  14. data/lib/elasticsearch-serverless/api/cat/ml_trained_models.rb +5 -1
  15. data/lib/elasticsearch-serverless/api/cat/transforms.rb +5 -1
  16. data/lib/elasticsearch-serverless/api/clear_scroll.rb +1 -1
  17. data/lib/elasticsearch-serverless/api/close_point_in_time.rb +1 -1
  18. data/lib/elasticsearch-serverless/api/cluster/delete_component_template.rb +2 -1
  19. data/lib/elasticsearch-serverless/api/cluster/get_component_template.rb +1 -1
  20. data/lib/elasticsearch-serverless/api/cluster/put_component_template.rb +15 -1
  21. data/lib/elasticsearch-serverless/api/connector/check_in.rb +57 -0
  22. data/lib/elasticsearch-serverless/api/connector/delete.rb +58 -0
  23. data/lib/elasticsearch-serverless/api/connector/get.rb +57 -0
  24. data/lib/elasticsearch-serverless/api/connector/last_sync.rb +59 -0
  25. data/lib/elasticsearch-serverless/api/connector/list.rb +58 -0
  26. data/lib/elasticsearch-serverless/api/connector/post.rb +53 -0
  27. data/lib/elasticsearch-serverless/api/connector/put.rb +60 -0
  28. data/lib/elasticsearch-serverless/api/connector/sync_job_cancel.rb +58 -0
  29. data/lib/elasticsearch-serverless/api/connector/sync_job_delete.rb +58 -0
  30. data/lib/elasticsearch-serverless/api/connector/sync_job_get.rb +58 -0
  31. data/lib/elasticsearch-serverless/api/connector/sync_job_list.rb +57 -0
  32. data/lib/elasticsearch-serverless/api/connector/sync_job_post.rb +55 -0
  33. data/lib/elasticsearch-serverless/api/connector/update_active_filtering.rb +57 -0
  34. data/lib/elasticsearch-serverless/api/connector/update_api_key_id.rb +59 -0
  35. data/lib/elasticsearch-serverless/api/connector/update_configuration.rb +59 -0
  36. data/lib/elasticsearch-serverless/api/connector/update_error.rb +59 -0
  37. data/lib/elasticsearch-serverless/api/connector/update_filtering.rb +59 -0
  38. data/lib/elasticsearch-serverless/api/connector/update_filtering_validation.rb +59 -0
  39. data/lib/elasticsearch-serverless/api/connector/update_index_name.rb +59 -0
  40. data/lib/elasticsearch-serverless/api/connector/update_name.rb +59 -0
  41. data/lib/elasticsearch-serverless/api/connector/update_native.rb +59 -0
  42. data/lib/elasticsearch-serverless/api/connector/update_pipeline.rb +59 -0
  43. data/lib/elasticsearch-serverless/api/connector/update_scheduling.rb +59 -0
  44. data/lib/elasticsearch-serverless/api/connector/update_service_type.rb +59 -0
  45. data/lib/elasticsearch-serverless/api/connector/update_status.rb +59 -0
  46. data/lib/elasticsearch-serverless/api/create.rb +2 -3
  47. data/lib/elasticsearch-serverless/api/delete.rb +1 -1
  48. data/lib/elasticsearch-serverless/api/delete_by_query.rb +1 -1
  49. data/lib/elasticsearch-serverless/api/delete_script.rb +1 -1
  50. data/lib/elasticsearch-serverless/api/enrich/get_policy.rb +1 -1
  51. data/lib/elasticsearch-serverless/api/enrich/put_policy.rb +1 -1
  52. data/lib/elasticsearch-serverless/api/enrich/stats.rb +1 -1
  53. data/lib/elasticsearch-serverless/api/eql/delete.rb +2 -1
  54. data/lib/elasticsearch-serverless/api/eql/get.rb +1 -1
  55. data/lib/elasticsearch-serverless/api/eql/get_status.rb +1 -1
  56. data/lib/elasticsearch-serverless/api/esql/query.rb +57 -0
  57. data/lib/elasticsearch-serverless/api/exists.rb +1 -1
  58. data/lib/elasticsearch-serverless/api/exists_source.rb +1 -1
  59. data/lib/elasticsearch-serverless/api/explain.rb +1 -1
  60. data/lib/elasticsearch-serverless/api/field_caps.rb +4 -1
  61. data/lib/elasticsearch-serverless/api/get.rb +1 -0
  62. data/lib/elasticsearch-serverless/api/get_script.rb +1 -1
  63. data/lib/elasticsearch-serverless/api/graph/explore.rb +1 -1
  64. data/lib/elasticsearch-serverless/api/index.rb +2 -1
  65. data/lib/elasticsearch-serverless/api/indices/analyze.rb +1 -1
  66. data/lib/elasticsearch-serverless/api/indices/create.rb +2 -2
  67. data/lib/elasticsearch-serverless/api/indices/create_data_stream.rb +2 -1
  68. data/lib/elasticsearch-serverless/api/indices/data_streams_stats.rb +1 -1
  69. data/lib/elasticsearch-serverless/api/indices/delete.rb +1 -1
  70. data/lib/elasticsearch-serverless/api/indices/delete_alias.rb +1 -1
  71. data/lib/elasticsearch-serverless/api/indices/delete_data_lifecycle.rb +1 -1
  72. data/lib/elasticsearch-serverless/api/indices/delete_data_stream.rb +1 -1
  73. data/lib/elasticsearch-serverless/api/indices/delete_index_template.rb +4 -1
  74. data/lib/elasticsearch-serverless/api/indices/exists.rb +1 -1
  75. data/lib/elasticsearch-serverless/api/indices/exists_alias.rb +1 -1
  76. data/lib/elasticsearch-serverless/api/indices/get.rb +2 -1
  77. data/lib/elasticsearch-serverless/api/indices/get_alias.rb +1 -1
  78. data/lib/elasticsearch-serverless/api/indices/get_data_lifecycle.rb +1 -1
  79. data/lib/elasticsearch-serverless/api/indices/get_data_stream.rb +1 -1
  80. data/lib/elasticsearch-serverless/api/indices/get_index_template.rb +2 -1
  81. data/lib/elasticsearch-serverless/api/indices/get_mapping.rb +2 -1
  82. data/lib/elasticsearch-serverless/api/indices/get_settings.rb +2 -1
  83. data/lib/elasticsearch-serverless/api/indices/migrate_to_data_stream.rb +10 -1
  84. data/lib/elasticsearch-serverless/api/indices/modify_data_stream.rb +1 -1
  85. data/lib/elasticsearch-serverless/api/indices/put_alias.rb +1 -1
  86. data/lib/elasticsearch-serverless/api/indices/put_data_lifecycle.rb +1 -1
  87. data/lib/elasticsearch-serverless/api/indices/put_index_template.rb +4 -1
  88. data/lib/elasticsearch-serverless/api/indices/put_mapping.rb +3 -1
  89. data/lib/elasticsearch-serverless/api/indices/put_settings.rb +2 -1
  90. data/lib/elasticsearch-serverless/api/indices/put_template.rb +60 -0
  91. data/lib/elasticsearch-serverless/api/indices/refresh.rb +2 -1
  92. data/lib/elasticsearch-serverless/api/indices/resolve_index.rb +2 -1
  93. data/lib/elasticsearch-serverless/api/indices/rollover.rb +1 -2
  94. data/lib/elasticsearch-serverless/api/indices/simulate_index_template.rb +4 -5
  95. data/lib/elasticsearch-serverless/api/indices/simulate_template.rb +3 -2
  96. data/lib/elasticsearch-serverless/api/indices/update_aliases.rb +1 -1
  97. data/lib/elasticsearch-serverless/api/indices/validate_query.rb +1 -1
  98. data/lib/elasticsearch-serverless/api/inference/delete.rb +66 -0
  99. data/lib/elasticsearch-serverless/api/inference/get.rb +64 -0
  100. data/lib/elasticsearch-serverless/api/inference/inference.rb +66 -0
  101. data/lib/elasticsearch-serverless/api/inference/put.rb +66 -0
  102. data/lib/elasticsearch-serverless/api/ingest/delete_pipeline.rb +1 -1
  103. data/lib/elasticsearch-serverless/api/ingest/get_pipeline.rb +2 -1
  104. data/lib/elasticsearch-serverless/api/ingest/processor_grok.rb +3 -1
  105. data/lib/elasticsearch-serverless/api/ingest/put_pipeline.rb +2 -1
  106. data/lib/elasticsearch-serverless/api/ingest/simulate.rb +1 -1
  107. data/lib/elasticsearch-serverless/api/license/get.rb +2 -1
  108. data/lib/elasticsearch-serverless/api/logstash/delete_pipeline.rb +1 -1
  109. data/lib/elasticsearch-serverless/api/logstash/get_pipeline.rb +1 -1
  110. data/lib/elasticsearch-serverless/api/logstash/put_pipeline.rb +1 -1
  111. data/lib/elasticsearch-serverless/api/machine_learning/close_job.rb +5 -1
  112. data/lib/elasticsearch-serverless/api/machine_learning/delete_calendar.rb +1 -1
  113. data/lib/elasticsearch-serverless/api/machine_learning/delete_data_frame_analytics.rb +1 -1
  114. data/lib/elasticsearch-serverless/api/machine_learning/delete_filter.rb +2 -0
  115. data/lib/elasticsearch-serverless/api/machine_learning/delete_job.rb +8 -1
  116. data/lib/elasticsearch-serverless/api/machine_learning/delete_trained_model.rb +2 -1
  117. data/lib/elasticsearch-serverless/api/machine_learning/delete_trained_model_alias.rb +4 -1
  118. data/lib/elasticsearch-serverless/api/machine_learning/estimate_model_memory.rb +3 -1
  119. data/lib/elasticsearch-serverless/api/machine_learning/evaluate_data_frame.rb +4 -0
  120. data/lib/elasticsearch-serverless/api/machine_learning/flush_job.rb +8 -0
  121. data/lib/elasticsearch-serverless/api/machine_learning/get_data_frame_analytics.rb +3 -0
  122. data/lib/elasticsearch-serverless/api/machine_learning/get_datafeed_stats.rb +6 -0
  123. data/lib/elasticsearch-serverless/api/machine_learning/get_datafeeds.rb +5 -0
  124. data/lib/elasticsearch-serverless/api/machine_learning/get_filters.rb +1 -0
  125. data/lib/elasticsearch-serverless/api/machine_learning/get_jobs.rb +4 -0
  126. data/lib/elasticsearch-serverless/api/machine_learning/get_overall_buckets.rb +17 -1
  127. data/lib/elasticsearch-serverless/api/machine_learning/get_trained_models.rb +2 -2
  128. data/lib/elasticsearch-serverless/api/machine_learning/get_trained_models_stats.rb +2 -1
  129. data/lib/elasticsearch-serverless/api/machine_learning/infer_trained_model.rb +63 -0
  130. data/lib/elasticsearch-serverless/api/machine_learning/open_job.rb +7 -0
  131. data/lib/elasticsearch-serverless/api/machine_learning/post_calendar_events.rb +1 -1
  132. data/lib/elasticsearch-serverless/api/machine_learning/preview_data_frame_analytics.rb +1 -1
  133. data/lib/elasticsearch-serverless/api/machine_learning/preview_datafeed.rb +8 -0
  134. data/lib/elasticsearch-serverless/api/machine_learning/put_calendar.rb +1 -1
  135. data/lib/elasticsearch-serverless/api/machine_learning/put_calendar_job.rb +1 -1
  136. data/lib/elasticsearch-serverless/api/machine_learning/put_data_frame_analytics.rb +2 -0
  137. data/lib/elasticsearch-serverless/api/machine_learning/put_datafeed.rb +9 -0
  138. data/lib/elasticsearch-serverless/api/machine_learning/put_filter.rb +2 -0
  139. data/lib/elasticsearch-serverless/api/machine_learning/put_job.rb +1 -1
  140. data/lib/elasticsearch-serverless/api/machine_learning/put_trained_model.rb +2 -1
  141. data/lib/elasticsearch-serverless/api/machine_learning/put_trained_model_alias.rb +16 -1
  142. data/lib/elasticsearch-serverless/api/machine_learning/put_trained_model_definition_part.rb +1 -1
  143. data/lib/elasticsearch-serverless/api/machine_learning/put_trained_model_vocabulary.rb +3 -1
  144. data/lib/elasticsearch-serverless/api/machine_learning/reset_job.rb +5 -1
  145. data/lib/elasticsearch-serverless/api/machine_learning/start_data_frame_analytics.rb +11 -0
  146. data/lib/elasticsearch-serverless/api/machine_learning/start_datafeed.rb +12 -0
  147. data/lib/elasticsearch-serverless/api/machine_learning/start_trained_model_deployment.rb +1 -1
  148. data/lib/elasticsearch-serverless/api/machine_learning/stop_data_frame_analytics.rb +2 -0
  149. data/lib/elasticsearch-serverless/api/machine_learning/stop_datafeed.rb +2 -0
  150. data/lib/elasticsearch-serverless/api/machine_learning/stop_trained_model_deployment.rb +1 -1
  151. data/lib/elasticsearch-serverless/api/machine_learning/update_data_frame_analytics.rb +1 -1
  152. data/lib/elasticsearch-serverless/api/machine_learning/update_datafeed.rb +5 -1
  153. data/lib/elasticsearch-serverless/api/machine_learning/update_filter.rb +1 -1
  154. data/lib/elasticsearch-serverless/api/machine_learning/update_trained_model_deployment.rb +55 -0
  155. data/lib/elasticsearch-serverless/api/mget.rb +1 -0
  156. data/lib/elasticsearch-serverless/api/msearch_template.rb +1 -1
  157. data/lib/elasticsearch-serverless/api/open_point_in_time.rb +6 -1
  158. data/lib/elasticsearch-serverless/api/put_script.rb +1 -1
  159. data/lib/elasticsearch-serverless/api/query_rules/delete_rule.rb +57 -0
  160. data/lib/elasticsearch-serverless/api/{query_ruleset/delete.rb → query_rules/delete_ruleset.rb} +2 -6
  161. data/lib/elasticsearch-serverless/api/query_rules/get_rule.rb +57 -0
  162. data/lib/elasticsearch-serverless/api/{query_ruleset/get.rb → query_rules/get_ruleset.rb} +3 -7
  163. data/lib/elasticsearch-serverless/api/{query_ruleset/list.rb → query_rules/list_rulesets.rb} +3 -7
  164. data/lib/elasticsearch-serverless/api/query_rules/put_rule.rb +59 -0
  165. data/lib/elasticsearch-serverless/api/{query_ruleset/put.rb → query_rules/put_ruleset.rb} +2 -6
  166. data/lib/elasticsearch-serverless/api/rank_eval.rb +1 -1
  167. data/lib/elasticsearch-serverless/api/render_search_template.rb +1 -1
  168. data/lib/elasticsearch-serverless/api/scripts_painless_execute.rb +1 -1
  169. data/lib/elasticsearch-serverless/api/search.rb +4 -1
  170. data/lib/elasticsearch-serverless/api/search_application/get.rb +1 -1
  171. data/lib/elasticsearch-serverless/api/search_application/search.rb +3 -2
  172. data/lib/elasticsearch-serverless/api/search_template.rb +1 -1
  173. data/lib/elasticsearch-serverless/api/security/authenticate.rb +3 -1
  174. data/lib/elasticsearch-serverless/api/security/create_api_key.rb +3 -0
  175. data/lib/elasticsearch-serverless/api/security/get_api_key.rb +4 -0
  176. data/lib/elasticsearch-serverless/api/security/invalidate_api_key.rb +6 -0
  177. data/lib/elasticsearch-serverless/api/security/query_api_keys.rb +4 -2
  178. data/lib/elasticsearch-serverless/api/security/update_api_key.rb +66 -0
  179. data/lib/elasticsearch-serverless/api/synonyms/put_synonym.rb +1 -1
  180. data/lib/elasticsearch-serverless/api/tasks/get.rb +57 -0
  181. data/lib/elasticsearch-serverless/api/transform/delete_transform.rb +1 -1
  182. data/lib/elasticsearch-serverless/api/transform/preview_transform.rb +4 -0
  183. data/lib/elasticsearch-serverless/api/transform/put_transform.rb +21 -1
  184. data/lib/elasticsearch-serverless/api/transform/reset_transform.rb +3 -1
  185. data/lib/elasticsearch-serverless/api/transform/schedule_now_transform.rb +5 -0
  186. data/lib/elasticsearch-serverless/api/transform/start_transform.rb +16 -1
  187. data/lib/elasticsearch-serverless/api/transform/update_transform.rb +6 -0
  188. data/lib/elasticsearch-serverless/api/update_by_query.rb +2 -2
  189. data/lib/elasticsearch-serverless/api.rb +6 -4
  190. data/lib/elasticsearch-serverless/version.rb +3 -3
  191. data/lib/elasticsearch-serverless.rb +13 -5
  192. metadata +59 -7
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Previews that will be analyzed given a data frame analytics config.
25
+ # Previews the extracted features used by a data frame analytics config.
26
26
  #
27
27
  # @option arguments [String] :id Identifier for the data frame analytics job.
28
28
  # @option arguments [Hash] :headers Custom HTTP headers
@@ -23,6 +23,14 @@ module ElasticsearchServerless
23
23
  module MachineLearning
24
24
  module Actions
25
25
  # Previews a datafeed.
26
+ # This API returns the first "page" of search results from a datafeed.
27
+ # You can preview an existing datafeed or provide configuration details for a datafeed
28
+ # and anomaly detection job in the API. The preview shows the structure of the data
29
+ # that will be passed to the anomaly detection engine.
30
+ # IMPORTANT: When Elasticsearch security features are enabled, the preview uses the credentials of the user that
31
+ # called the API. However, when the datafeed starts it uses the roles of the last user that created or updated the
32
+ # datafeed. To get a preview that accurately reflects the behavior of the datafeed, use the appropriate credentials.
33
+ # You can also use secondary authorization headers to supply the credentials.
26
34
  #
27
35
  # @option arguments [String] :datafeed_id A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. NOTE: If you use this path parameter, you cannot provide datafeed or anomaly detection job configuration details in the request body.
28
36
  # @option arguments [String, Time] :start The start time from where the datafeed preview should begin
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Instantiates a calendar.
25
+ # Creates a calendar.
26
26
  #
27
27
  # @option arguments [String] :calendar_id A string that uniquely identifies a calendar. (*Required*)
28
28
  # @option arguments [Hash] :headers Custom HTTP headers
@@ -25,7 +25,7 @@ module ElasticsearchServerless
25
25
  # Adds an anomaly detection job to a calendar.
26
26
  #
27
27
  # @option arguments [String] :calendar_id A string that uniquely identifies a calendar. (*Required*)
28
- # @option arguments [String] :job_id An identifier for the anomaly detection jobs. It can be a job identifier, a group name, or a comma-separated list of jobs or groups. (*Required*)
28
+ # @option arguments [String, Array] :job_id An identifier for the anomaly detection jobs. It can be a job identifier, a group name, or a comma-separated list of jobs or groups. (*Required*)
29
29
  # @option arguments [Hash] :headers Custom HTTP headers
30
30
  #
31
31
  # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar-job.html
@@ -23,6 +23,8 @@ module ElasticsearchServerless
23
23
  module MachineLearning
24
24
  module Actions
25
25
  # Instantiates a data frame analytics job.
26
+ # This API creates a data frame analytics job that performs an analysis on the
27
+ # source indices and stores the outcome in a destination index.
26
28
  #
27
29
  # @option arguments [String] :id Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. (*Required*)
28
30
  # @option arguments [Hash] :headers Custom HTTP headers
@@ -23,6 +23,15 @@ module ElasticsearchServerless
23
23
  module MachineLearning
24
24
  module Actions
25
25
  # Instantiates a datafeed.
26
+ # Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.
27
+ # You can associate only one datafeed with each anomaly detection job.
28
+ # The datafeed contains a query that runs at a defined interval (+frequency+).
29
+ # If you are concerned about delayed data, you can add a delay (+query_delay') at each interval.
30
+ # When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had
31
+ # at the time of creation and runs the query using those same roles. If you provide secondary authorization headers,
32
+ # those credentials are used instead.
33
+ # You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed
34
+ # directly to the +.ml-config+ index. Do not give users +write+ privileges on the +.ml-config+ index.
26
35
  #
27
36
  # @option arguments [String] :datafeed_id A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. (*Required*)
28
37
  # @option arguments [Boolean] :allow_no_indices If true, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the +_all+ string or when no indices are specified. Server default: true.
@@ -23,6 +23,8 @@ module ElasticsearchServerless
23
23
  module MachineLearning
24
24
  module Actions
25
25
  # Instantiates a filter.
26
+ # A filter contains a list of strings. It can be used by one or more anomaly detection jobs.
27
+ # Specifically, filters are referenced in the +custom_rules+ property of detector configuration objects.
26
28
  #
27
29
  # @option arguments [String] :filter_id A string that uniquely identifies a filter. (*Required*)
28
30
  # @option arguments [Hash] :headers Custom HTTP headers
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Instantiates an anomaly detection job.
25
+ # Instantiates an anomaly detection job. If you include a +datafeed_config+, you must have read index privileges on the source index.
26
26
  #
27
27
  # @option arguments [String] :job_id The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. (*Required*)
28
28
  # @option arguments [Hash] :headers Custom HTTP headers
@@ -22,10 +22,11 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Creates an inference trained model.
25
+ # Enables you to supply a trained model that is not created by data frame analytics.
26
26
  #
27
27
  # @option arguments [String] :model_id The unique identifier of the trained model. (*Required*)
28
28
  # @option arguments [Boolean] :defer_definition_decompression If set to +true+ and a +compressed_definition+ is provided, the request defers definition decompression and skips relevant validations.
29
+ # @option arguments [Boolean] :wait_for_completion Whether to wait for all child operations (e.g. model download) to complete.
29
30
  # @option arguments [Hash] :headers Custom HTTP headers
30
31
  # @option arguments [Hash] :body request body
31
32
  #
@@ -22,7 +22,22 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Creates a new model alias (or reassigns an existing one) to refer to the trained model
25
+ # Creates or updates a trained model alias. A trained model alias is a logical
26
+ # name used to reference a single trained model.
27
+ # You can use aliases instead of trained model identifiers to make it easier to
28
+ # reference your models. For example, you can use aliases in inference
29
+ # aggregations and processors.
30
+ # An alias must be unique and refer to only a single trained model. However,
31
+ # you can have multiple aliases for each trained model.
32
+ # If you use this API to update an alias such that it references a different
33
+ # trained model ID and the model uses a different type of data frame analytics,
34
+ # an error occurs. For example, this situation occurs if you have a trained
35
+ # model for regression analysis and a trained model for classification
36
+ # analysis; you cannot reassign an alias from one type of trained model to
37
+ # another.
38
+ # If you use this API to update an alias and there are very few input fields in
39
+ # common between the old and new trained models for the model alias, the API
40
+ # returns a warning.
26
41
  #
27
42
  # @option arguments [String] :model_alias The alias to create or update. This value cannot end in numbers. (*Required*)
28
43
  # @option arguments [String] :model_id The identifier for the trained model that the alias refers to. (*Required*)
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Creates part of a trained model definition
25
+ # Creates part of a trained model definition.
26
26
  #
27
27
  # @option arguments [String] :model_id The unique identifier of the trained model. (*Required*)
28
28
  # @option arguments [Integer] :part The definition part number. When the definition is loaded for inference the definition parts are streamed in the order of their part number. The first part must be +0+ and the final part must be +total_parts - 1+. (*Required*)
@@ -22,7 +22,9 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Creates a trained model vocabulary
25
+ # Creates a trained model vocabulary.
26
+ # This API is supported only for natural language processing (NLP) models.
27
+ # The vocabulary is stored in the index as described in +inference_config.*.vocabulary+ of the trained model definition.
26
28
  #
27
29
  # @option arguments [String] :model_id The unique identifier of the trained model. (*Required*)
28
30
  # @option arguments [Hash] :headers Custom HTTP headers
@@ -22,7 +22,11 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Resets an existing anomaly detection job.
25
+ # Resets an anomaly detection job.
26
+ # All model state and results are deleted. The job is ready to start over as if
27
+ # it had just been created.
28
+ # It is not currently possible to reset multiple jobs using wildcards or a
29
+ # comma separated list.
26
30
  #
27
31
  # @option arguments [String] :job_id The ID of the job to reset. (*Required*)
28
32
  # @option arguments [Boolean] :wait_for_completion Should this request wait until the operation has completed before returning. Server default: true.
@@ -23,6 +23,17 @@ module ElasticsearchServerless
23
23
  module MachineLearning
24
24
  module Actions
25
25
  # Starts a data frame analytics job.
26
+ # A data frame analytics job can be started and stopped multiple times
27
+ # throughout its lifecycle.
28
+ # If the destination index does not exist, it is created automatically the
29
+ # first time you start the data frame analytics job. The
30
+ # +index.number_of_shards+ and +index.number_of_replicas+ settings for the
31
+ # destination index are copied from the source index. If there are multiple
32
+ # source indices, the destination index copies the highest setting values. The
33
+ # mappings for the destination index are also copied from the source indices.
34
+ # If there are any mapping conflicts, the job fails to start.
35
+ # If the destination index exists, it is used as is. You can therefore set up
36
+ # the destination index in advance with custom settings and mappings.
26
37
  #
27
38
  # @option arguments [String] :id Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. (*Required*)
28
39
  # @option arguments [Time] :timeout Controls the amount of time to wait until the data frame analytics job starts. Server default: 20s.
@@ -24,6 +24,18 @@ module ElasticsearchServerless
24
24
  module Actions
25
25
  # Starts one or more datafeeds.
26
26
  #
27
+ # A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped
28
+ # multiple times throughout its lifecycle.
29
+ #
30
+ # Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs.
31
+ #
32
+ # If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped.
33
+ # If new data was indexed for that exact millisecond between stopping and starting, it will be ignored.
34
+ #
35
+ # When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or
36
+ # update it had at the time of creation or update and runs the query using those same roles. If you provided secondary
37
+ # authorization headers when you created or updated the datafeed, those credentials are used instead.
38
+ #
27
39
  # @option arguments [String] :datafeed_id A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. (*Required*)
28
40
  # @option arguments [String, Time] :end The time that the datafeed should end, which can be specified by using one of the following formats: * ISO 8601 format with milliseconds, for example +2017-01-22T06:00:00.000Z+ * ISO 8601 format without milliseconds, for example +2017-01-22T06:00:00+00:00+ * Milliseconds since the epoch, for example +1485061200000+ Date-time arguments using either of the ISO 8601 formats must have a time zone designator, where +Z+ is accepted as an abbreviation for UTC time. When a URL is expected (for example, in browsers), the +++ used in time zone designators must be encoded as +%2B+. The end time value is exclusive. If you do not specify an end time, the datafeed runs continuously.
29
41
  # @option arguments [String, Time] :start The time that the datafeed should begin, which can be specified by using the same formats as the +end+ parameter. This value is inclusive. If you do not specify a start time and the datafeed is associated with a new anomaly detection job, the analysis starts from the earliest time for which data is available. If you restart a stopped datafeed and specify a start value that is earlier than the timestamp of the latest processed record, the datafeed continues from 1 millisecond after the timestamp of the latest processed record.
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Start a trained model deployment.
25
+ # Starts a trained model deployment, which allocates the model to every machine learning node.
26
26
  #
27
27
  # @option arguments [String] :model_id The unique identifier of the trained model. Currently, only PyTorch models are supported. (*Required*)
28
28
  # @option arguments [Integer, String] :cache_size The inference cache size (in memory outside the JVM heap) per node for the model. The default value is the same size as the +model_size_bytes+. To disable the cache, +0b+ can be provided.
@@ -23,6 +23,8 @@ module ElasticsearchServerless
23
23
  module MachineLearning
24
24
  module Actions
25
25
  # Stops one or more data frame analytics jobs.
26
+ # A data frame analytics job can be started and stopped multiple times
27
+ # throughout its lifecycle.
26
28
  #
27
29
  # @option arguments [String] :id Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. (*Required*)
28
30
  # @option arguments [Boolean] :allow_no_match Specifies what to do when the request: 1. Contains wildcard expressions and there are no data frame analytics jobs that match. 2. Contains the _all string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches. The default value is true, which returns an empty data_frame_analytics array when there are no matches and the subset of results when there are partial matches. If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches. Server default: true.
@@ -23,6 +23,8 @@ module ElasticsearchServerless
23
23
  module MachineLearning
24
24
  module Actions
25
25
  # Stops one or more datafeeds.
26
+ # A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped
27
+ # multiple times throughout its lifecycle.
26
28
  #
27
29
  # @option arguments [String] :datafeed_id Identifier for the datafeed. You can stop multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can close all datafeeds by using +_all+ or by specifying +*+ as the identifier. (*Required*)
28
30
  # @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.
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Stop a trained model deployment.
25
+ # Stops a trained model deployment.
26
26
  #
27
27
  # @option arguments [String] :model_id The unique identifier of the trained model. (*Required*)
28
28
  # @option arguments [Boolean] :allow_no_match Specifies what to do when the request: contains wildcard expressions and there are no deployments that match; contains the +_all+ string or no identifiers and there are no matches; or contains wildcard expressions and there are only partial matches. By default, it returns an empty 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.
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Updates certain properties of a data frame analytics job.
25
+ # Updates an existing data frame analytics job.
26
26
  #
27
27
  # @option arguments [String] :id Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. (*Required*)
28
28
  # @option arguments [Hash] :headers Custom HTTP headers
@@ -22,7 +22,11 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Updates certain properties of a datafeed.
25
+ # Updates the properties of a datafeed.
26
+ # You must stop and start the datafeed for the changes to be applied.
27
+ # When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at
28
+ # the time of the update and runs the query using those same roles. If you provide secondary authorization headers,
29
+ # those credentials are used instead.
26
30
  #
27
31
  # @option arguments [String] :datafeed_id A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. (*Required*)
28
32
  # @option arguments [Boolean] :allow_no_indices If +true+, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the +_all+ string or when no indices are specified. Server default: true.
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Updates the description of a filter, adds items, or removes items.
25
+ # Updates the description of a filter, adds items, or removes items from the list.
26
26
  #
27
27
  # @option arguments [String] :filter_id A string that uniquely identifies a filter. (*Required*)
28
28
  # @option arguments [Hash] :headers Custom HTTP headers
@@ -0,0 +1,55 @@
1
+ # Licensed to Elasticsearch B.V. under one or more contributor
2
+ # license agreements. See the NOTICE file distributed with
3
+ # this work for additional information regarding copyright
4
+ # ownership. Elasticsearch B.V. licenses this file to you under
5
+ # the Apache License, Version 2.0 (the "License"); you may
6
+ # not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing,
12
+ # software distributed under the License is distributed on an
13
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
+ # KIND, either express or implied. See the License for the
15
+ # specific language governing permissions and limitations
16
+ # under the License.
17
+ #
18
+ # Auto generated from commit f284cc16f4d4b4289bc679aa1529bb504190fe80
19
+ # @see https://github.com/elastic/elasticsearch-specification
20
+ #
21
+ module ElasticsearchServerless
22
+ module API
23
+ module MachineLearning
24
+ module Actions
25
+ # Starts a trained model deployment, which allocates the model to every machine learning node.
26
+ #
27
+ # @option arguments [String] :model_id The unique identifier of the trained model. Currently, only PyTorch models are supported. (*Required*)
28
+ # @option arguments [Integer] :number_of_allocations The number of model allocations on each node where the model is deployed. All allocations on a node share the same copy of the model in memory but use a separate set of threads to evaluate the model. Increasing this value generally increases the throughput. If this setting is greater than the number of hardware threads it will automatically be changed to a value less than the number of hardware threads. Server default: 1.
29
+ # @option arguments [Hash] :headers Custom HTTP headers
30
+ # @option arguments [Hash] :body request body
31
+ #
32
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-trained-model-deployment.html
33
+ #
34
+ def update_trained_model_deployment(arguments = {})
35
+ raise ArgumentError, "Required argument 'model_id' missing" unless arguments[:model_id]
36
+
37
+ arguments = arguments.clone
38
+ headers = arguments.delete(:headers) || {}
39
+
40
+ body = arguments.delete(:body)
41
+
42
+ _model_id = arguments.delete(:model_id)
43
+
44
+ method = ElasticsearchServerless::API::HTTP_POST
45
+ path = "_ml/trained_models/#{Utils.listify(_model_id)}/deployment/_update"
46
+ params = Utils.process_params(arguments)
47
+
48
+ ElasticsearchServerless::API::Response.new(
49
+ perform_request(method, path, params, body, headers)
50
+ )
51
+ end
52
+ end
53
+ end
54
+ end
55
+ end
@@ -24,6 +24,7 @@ module ElasticsearchServerless
24
24
  # Allows to get multiple documents in one request.
25
25
  #
26
26
  # @option arguments [String] :index Name of the index to retrieve documents from when +ids+ are specified, or when a document in the +docs+ array does not specify an index.
27
+ # @option arguments [Boolean] :force_synthetic_source Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index.
27
28
  # @option arguments [String] :preference Specifies the node or shard the operation should be performed on. Random by default.
28
29
  # @option arguments [Boolean] :realtime If +true+, the request is real-time as opposed to near-real-time. Server default: true.
29
30
  # @option arguments [Boolean] :refresh If +true+, the request refreshes relevant shards before retrieving documents.
@@ -21,7 +21,7 @@
21
21
  module ElasticsearchServerless
22
22
  module API
23
23
  module Actions
24
- # Allows to execute several search template operations in one request.
24
+ # Runs multiple templated searches with a single request.
25
25
  #
26
26
  # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (+*+). To search all data streams and indices, omit this parameter or use +*+.
27
27
  # @option arguments [Boolean] :ccs_minimize_roundtrips If +true+, network round-trips are minimized for cross-cluster search requests. Server default: true.
@@ -21,7 +21,12 @@
21
21
  module ElasticsearchServerless
22
22
  module API
23
23
  module Actions
24
- # Open a point in time that can be used in subsequent searches
24
+ # A search request by default executes against the most recent visible data of the target indices,
25
+ # which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the
26
+ # state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple
27
+ # search requests using the same point in time. For example, if refreshes happen between
28
+ # +search_after+ requests, then the results of those requests might not be consistent as changes happening
29
+ # between searches are only visible to the more recent point in time.
25
30
  #
26
31
  # @option arguments [String, Array] :index A comma-separated list of index names to open point in time; use +_all+ or empty string to perform the operation on all indices (*Required*)
27
32
  # @option arguments [Time] :keep_alive Extends the time to live of the corresponding point in time. (*Required*)
@@ -21,7 +21,7 @@
21
21
  module ElasticsearchServerless
22
22
  module API
23
23
  module Actions
24
- # Creates or updates a script.
24
+ # Creates or updates a stored script or search template.
25
25
  #
26
26
  # @option arguments [String] :id Identifier for the stored script or search template. Must be unique within the cluster. (*Required*)
27
27
  # @option arguments [String] :context Context in which the script or search template should run. To prevent errors, the API immediately compiles the script or template in this context.
@@ -0,0 +1,57 @@
1
+ # Licensed to Elasticsearch B.V. under one or more contributor
2
+ # license agreements. See the NOTICE file distributed with
3
+ # this work for additional information regarding copyright
4
+ # ownership. Elasticsearch B.V. licenses this file to you under
5
+ # the Apache License, Version 2.0 (the "License"); you may
6
+ # not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing,
12
+ # software distributed under the License is distributed on an
13
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
+ # KIND, either express or implied. See the License for the
15
+ # specific language governing permissions and limitations
16
+ # under the License.
17
+ #
18
+ # Auto generated from commit f284cc16f4d4b4289bc679aa1529bb504190fe80
19
+ # @see https://github.com/elastic/elasticsearch-specification
20
+ #
21
+ module ElasticsearchServerless
22
+ module API
23
+ module QueryRules
24
+ module Actions
25
+ # Deletes a query rule within a query ruleset.
26
+ #
27
+ # @option arguments [String] :ruleset_id The unique identifier of the query ruleset containing the rule to delete (*Required*)
28
+ # @option arguments [String] :rule_id The unique identifier of the query rule within the specified ruleset to delete (*Required*)
29
+ # @option arguments [Hash] :headers Custom HTTP headers
30
+ #
31
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-query-rule.html
32
+ #
33
+ def delete_rule(arguments = {})
34
+ raise ArgumentError, "Required argument 'ruleset_id' missing" unless arguments[:ruleset_id]
35
+ raise ArgumentError, "Required argument 'rule_id' missing" unless arguments[:rule_id]
36
+
37
+ arguments = arguments.clone
38
+ headers = arguments.delete(:headers) || {}
39
+
40
+ body = nil
41
+
42
+ _ruleset_id = arguments.delete(:ruleset_id)
43
+
44
+ _rule_id = arguments.delete(:rule_id)
45
+
46
+ method = ElasticsearchServerless::API::HTTP_DELETE
47
+ path = "_query_rules/#{Utils.listify(_ruleset_id)}/_rule/#{Utils.listify(_rule_id)}"
48
+ params = {}
49
+
50
+ ElasticsearchServerless::API::Response.new(
51
+ perform_request(method, path, params, body, headers)
52
+ )
53
+ end
54
+ end
55
+ end
56
+ end
57
+ end
@@ -20,20 +20,16 @@
20
20
  #
21
21
  module ElasticsearchServerless
22
22
  module API
23
- module QueryRuleset
23
+ module QueryRules
24
24
  module Actions
25
25
  # Deletes a query ruleset.
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.
30
26
  #
31
27
  # @option arguments [String] :ruleset_id The unique identifier of the query ruleset to delete (*Required*)
32
28
  # @option arguments [Hash] :headers Custom HTTP headers
33
29
  #
34
30
  # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-query-ruleset.html
35
31
  #
36
- def delete(arguments = {})
32
+ def delete_ruleset(arguments = {})
37
33
  raise ArgumentError, "Required argument 'ruleset_id' missing" unless arguments[:ruleset_id]
38
34
 
39
35
  arguments = arguments.clone
@@ -0,0 +1,57 @@
1
+ # Licensed to Elasticsearch B.V. under one or more contributor
2
+ # license agreements. See the NOTICE file distributed with
3
+ # this work for additional information regarding copyright
4
+ # ownership. Elasticsearch B.V. licenses this file to you under
5
+ # the Apache License, Version 2.0 (the "License"); you may
6
+ # not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing,
12
+ # software distributed under the License is distributed on an
13
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
+ # KIND, either express or implied. See the License for the
15
+ # specific language governing permissions and limitations
16
+ # under the License.
17
+ #
18
+ # Auto generated from commit f284cc16f4d4b4289bc679aa1529bb504190fe80
19
+ # @see https://github.com/elastic/elasticsearch-specification
20
+ #
21
+ module ElasticsearchServerless
22
+ module API
23
+ module QueryRules
24
+ module Actions
25
+ # Returns the details about a query rule within a query ruleset
26
+ #
27
+ # @option arguments [String] :ruleset_id The unique identifier of the query ruleset containing the rule to retrieve (*Required*)
28
+ # @option arguments [String] :rule_id The unique identifier of the query rule within the specified ruleset to retrieve (*Required*)
29
+ # @option arguments [Hash] :headers Custom HTTP headers
30
+ #
31
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/get-query-rule.html
32
+ #
33
+ def get_rule(arguments = {})
34
+ raise ArgumentError, "Required argument 'ruleset_id' missing" unless arguments[:ruleset_id]
35
+ raise ArgumentError, "Required argument 'rule_id' missing" unless arguments[:rule_id]
36
+
37
+ arguments = arguments.clone
38
+ headers = arguments.delete(:headers) || {}
39
+
40
+ body = nil
41
+
42
+ _ruleset_id = arguments.delete(:ruleset_id)
43
+
44
+ _rule_id = arguments.delete(:rule_id)
45
+
46
+ method = ElasticsearchServerless::API::HTTP_GET
47
+ path = "_query_rules/#{Utils.listify(_ruleset_id)}/_rule/#{Utils.listify(_rule_id)}"
48
+ params = {}
49
+
50
+ ElasticsearchServerless::API::Response.new(
51
+ perform_request(method, path, params, body, headers)
52
+ )
53
+ end
54
+ end
55
+ end
56
+ end
57
+ end
@@ -20,20 +20,16 @@
20
20
  #
21
21
  module ElasticsearchServerless
22
22
  module API
23
- module QueryRuleset
23
+ module QueryRules
24
24
  module Actions
25
- # Returns the details about a query ruleset.
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.
25
+ # Returns the details about a query ruleset
30
26
  #
31
27
  # @option arguments [String] :ruleset_id The unique identifier of the query ruleset (*Required*)
32
28
  # @option arguments [Hash] :headers Custom HTTP headers
33
29
  #
34
30
  # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/get-query-ruleset.html
35
31
  #
36
- def get(arguments = {})
32
+ def get_ruleset(arguments = {})
37
33
  raise ArgumentError, "Required argument 'ruleset_id' missing" unless arguments[:ruleset_id]
38
34
 
39
35
  arguments = arguments.clone
@@ -20,13 +20,9 @@
20
20
  #
21
21
  module ElasticsearchServerless
22
22
  module API
23
- module QueryRuleset
23
+ module QueryRules
24
24
  module Actions
25
- # Lists query rulesets.
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.
25
+ # Returns summarized information about existing query rulesets.
30
26
  #
31
27
  # @option arguments [Integer] :from Starting offset (default: 0)
32
28
  # @option arguments [Integer] :size specifies a max number of results to get
@@ -34,7 +30,7 @@ module ElasticsearchServerless
34
30
  #
35
31
  # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/list-query-rulesets.html
36
32
  #
37
- def list(arguments = {})
33
+ def list_rulesets(arguments = {})
38
34
  arguments = arguments.clone
39
35
  headers = arguments.delete(:headers) || {}
40
36