elasticsearch-serverless 0.3.0 → 0.5.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (105) hide show
  1. checksums.yaml +4 -4
  2. data/lib/elasticsearch-serverless/api/async_search/delete.rb +2 -2
  3. data/lib/elasticsearch-serverless/api/async_search/get.rb +2 -1
  4. data/lib/elasticsearch-serverless/api/async_search/status.rb +2 -2
  5. data/lib/elasticsearch-serverless/api/async_search/submit.rb +4 -4
  6. data/lib/elasticsearch-serverless/api/clear_scroll.rb +1 -11
  7. data/lib/elasticsearch-serverless/api/connector/check_in.rb +2 -1
  8. data/lib/elasticsearch-serverless/api/connector/delete.rb +5 -1
  9. data/lib/elasticsearch-serverless/api/connector/get.rb +2 -1
  10. data/lib/elasticsearch-serverless/api/connector/list.rb +2 -1
  11. data/lib/elasticsearch-serverless/api/connector/post.rb +4 -1
  12. data/lib/elasticsearch-serverless/api/connector/put.rb +1 -1
  13. data/lib/elasticsearch-serverless/api/connector/sync_job_cancel.rb +3 -1
  14. data/lib/elasticsearch-serverless/api/connector/sync_job_delete.rb +3 -1
  15. data/lib/elasticsearch-serverless/api/connector/sync_job_get.rb +1 -1
  16. data/lib/elasticsearch-serverless/api/connector/sync_job_list.rb +2 -1
  17. data/lib/elasticsearch-serverless/api/connector/sync_job_post.rb +2 -1
  18. data/lib/elasticsearch-serverless/api/connector/update_active_filtering.rb +1 -0
  19. data/lib/elasticsearch-serverless/api/connector/update_api_key_id.rb +5 -1
  20. data/lib/elasticsearch-serverless/api/connector/update_configuration.rb +2 -1
  21. data/lib/elasticsearch-serverless/api/connector/update_error.rb +4 -1
  22. data/lib/elasticsearch-serverless/api/connector/update_filtering.rb +4 -1
  23. data/lib/elasticsearch-serverless/api/connector/update_filtering_validation.rb +2 -1
  24. data/lib/elasticsearch-serverless/api/connector/update_index_name.rb +2 -1
  25. data/lib/elasticsearch-serverless/api/connector/update_name.rb +1 -1
  26. data/lib/elasticsearch-serverless/api/connector/update_native.rb +1 -1
  27. data/lib/elasticsearch-serverless/api/connector/update_pipeline.rb +2 -1
  28. data/lib/elasticsearch-serverless/api/connector/update_scheduling.rb +1 -1
  29. data/lib/elasticsearch-serverless/api/connector/update_service_type.rb +1 -1
  30. data/lib/elasticsearch-serverless/api/connector/update_status.rb +1 -1
  31. data/lib/elasticsearch-serverless/api/indices/analyze.rb +2 -1
  32. data/lib/elasticsearch-serverless/api/indices/create_data_stream.rb +3 -1
  33. data/lib/elasticsearch-serverless/api/indices/delete_data_stream.rb +1 -0
  34. data/lib/elasticsearch-serverless/api/indices/get_data_lifecycle.rb +1 -0
  35. data/lib/elasticsearch-serverless/api/indices/get_data_stream.rb +2 -0
  36. data/lib/elasticsearch-serverless/api/indices/migrate_to_data_stream.rb +3 -1
  37. data/lib/elasticsearch-serverless/api/indices/put_data_lifecycle.rb +2 -1
  38. data/lib/elasticsearch-serverless/api/indices/resolve_index.rb +4 -0
  39. data/lib/elasticsearch-serverless/api/machine_learning/flush_job.rb +1 -1
  40. data/lib/elasticsearch-serverless/api/machine_learning/get_calendar_events.rb +1 -1
  41. data/lib/elasticsearch-serverless/api/machine_learning/get_calendars.rb +1 -1
  42. data/lib/elasticsearch-serverless/api/machine_learning/get_data_frame_analytics.rb +1 -1
  43. data/lib/elasticsearch-serverless/api/machine_learning/get_data_frame_analytics_stats.rb +1 -1
  44. data/lib/elasticsearch-serverless/api/machine_learning/get_datafeed_stats.rb +1 -1
  45. data/lib/elasticsearch-serverless/api/machine_learning/get_datafeeds.rb +1 -1
  46. data/lib/elasticsearch-serverless/api/machine_learning/get_filters.rb +1 -1
  47. data/lib/elasticsearch-serverless/api/machine_learning/get_job_stats.rb +1 -1
  48. data/lib/elasticsearch-serverless/api/machine_learning/get_jobs.rb +1 -1
  49. data/lib/elasticsearch-serverless/api/machine_learning/get_overall_buckets.rb +2 -1
  50. data/lib/elasticsearch-serverless/api/machine_learning/get_trained_models.rb +1 -1
  51. data/lib/elasticsearch-serverless/api/machine_learning/get_trained_models_stats.rb +2 -1
  52. data/lib/elasticsearch-serverless/api/machine_learning/infer_trained_model.rb +2 -4
  53. data/lib/elasticsearch-serverless/api/machine_learning/open_job.rb +2 -3
  54. data/lib/elasticsearch-serverless/api/machine_learning/post_calendar_events.rb +1 -1
  55. data/lib/elasticsearch-serverless/api/machine_learning/preview_data_frame_analytics.rb +1 -0
  56. data/lib/elasticsearch-serverless/api/machine_learning/preview_datafeed.rb +1 -1
  57. data/lib/elasticsearch-serverless/api/machine_learning/put_calendar.rb +1 -1
  58. data/lib/elasticsearch-serverless/api/machine_learning/put_calendar_job.rb +1 -1
  59. data/lib/elasticsearch-serverless/api/machine_learning/put_data_frame_analytics.rb +1 -1
  60. data/lib/elasticsearch-serverless/api/machine_learning/put_datafeed.rb +3 -3
  61. data/lib/elasticsearch-serverless/api/machine_learning/put_filter.rb +1 -1
  62. data/lib/elasticsearch-serverless/api/machine_learning/put_trained_model.rb +2 -1
  63. data/lib/elasticsearch-serverless/api/machine_learning/put_trained_model_alias.rb +3 -2
  64. data/lib/elasticsearch-serverless/api/machine_learning/put_trained_model_definition_part.rb +1 -1
  65. data/lib/elasticsearch-serverless/api/machine_learning/put_trained_model_vocabulary.rb +1 -1
  66. data/lib/elasticsearch-serverless/api/machine_learning/reset_job.rb +1 -1
  67. data/lib/elasticsearch-serverless/api/machine_learning/start_data_frame_analytics.rb +1 -1
  68. data/lib/elasticsearch-serverless/api/machine_learning/start_datafeed.rb +1 -1
  69. data/lib/elasticsearch-serverless/api/machine_learning/start_trained_model_deployment.rb +2 -1
  70. data/lib/elasticsearch-serverless/api/machine_learning/stop_data_frame_analytics.rb +1 -1
  71. data/lib/elasticsearch-serverless/api/machine_learning/stop_datafeed.rb +1 -1
  72. data/lib/elasticsearch-serverless/api/machine_learning/stop_trained_model_deployment.rb +1 -1
  73. data/lib/elasticsearch-serverless/api/machine_learning/update_data_frame_analytics.rb +1 -1
  74. data/lib/elasticsearch-serverless/api/machine_learning/update_datafeed.rb +1 -1
  75. data/lib/elasticsearch-serverless/api/machine_learning/update_filter.rb +1 -0
  76. data/lib/elasticsearch-serverless/api/machine_learning/update_job.rb +1 -0
  77. data/lib/elasticsearch-serverless/api/machine_learning/update_trained_model_deployment.rb +1 -1
  78. data/lib/elasticsearch-serverless/api/mget.rb +4 -1
  79. data/lib/elasticsearch-serverless/api/msearch.rb +18 -10
  80. data/lib/elasticsearch-serverless/api/mtermvectors.rb +5 -1
  81. data/lib/elasticsearch-serverless/api/open_point_in_time.rb +2 -1
  82. data/lib/elasticsearch-serverless/api/{esql/query.rb → query_rules/test.rb} +19 -13
  83. data/lib/elasticsearch-serverless/api/scroll.rb +11 -12
  84. data/lib/elasticsearch-serverless/api/search_application/delete.rb +2 -1
  85. data/lib/elasticsearch-serverless/api/search_application/delete_behavioral_analytics.rb +1 -0
  86. data/lib/elasticsearch-serverless/api/search_application/get.rb +1 -1
  87. data/lib/elasticsearch-serverless/api/search_application/get_behavioral_analytics.rb +1 -1
  88. data/lib/elasticsearch-serverless/api/search_application/put.rb +1 -1
  89. data/lib/elasticsearch-serverless/api/search_application/put_behavioral_analytics.rb +1 -1
  90. data/lib/elasticsearch-serverless/api/search_application/search.rb +3 -1
  91. data/lib/elasticsearch-serverless/api/security/create_api_key.rb +1 -1
  92. data/lib/elasticsearch-serverless/api/{indices/delete_data_lifecycle.rb → security/delete_role.rb} +9 -11
  93. data/lib/elasticsearch-serverless/api/{enrich/stats.rb → security/get_builtin_privileges.rb} +7 -7
  94. data/lib/elasticsearch-serverless/api/{indices/data_streams_stats.rb → security/get_role.rb} +20 -16
  95. data/lib/elasticsearch-serverless/api/security/has_privileges.rb +1 -1
  96. data/lib/elasticsearch-serverless/api/security/invalidate_api_key.rb +3 -2
  97. data/lib/elasticsearch-serverless/api/{indices/put_template.rb → security/put_role.rb} +11 -15
  98. data/lib/elasticsearch-serverless/api/security/query_api_keys.rb +2 -2
  99. data/lib/elasticsearch-serverless/api/tasks/get.rb +2 -0
  100. data/lib/elasticsearch-serverless/api/terms_enum.rb +6 -1
  101. data/lib/elasticsearch-serverless/api/update_by_query.rb +1 -0
  102. data/lib/elasticsearch-serverless/api.rb +1 -1
  103. data/lib/elasticsearch-serverless/version.rb +1 -1
  104. metadata +12 -13
  105. data/lib/elasticsearch-serverless/api/security/update_api_key.rb +0 -75
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f65fea7b65dd1eae81bcd4369221d71d2809895df40f168196005179f10a6c05
4
- data.tar.gz: 4a958e6a4bf23122ba8709c89fa82e932ec240f18146a07f5dc8cde39c0dffa7
3
+ metadata.gz: aedc93a8ab9cc3c28fe2fa52d0a4225e1e1a030c0ccd72dd1a29c003035bbdfc
4
+ data.tar.gz: f7c1fd06c870c37792572d51168583accc36c03b11e9b0e49c198dc0c42a1071
5
5
  SHA512:
6
- metadata.gz: f913a7e87f209fc6190a2fa18fd59036ddff358b08a05a333f530cb55134c6b2a067463311948cda968118b99c03bb72c5d3b4550e8c4e6f18c2a337e439acc2
7
- data.tar.gz: d274e0623ae7970d614631f0a57ea518fdbb108f340557d5e9faac7621516c4d6e2247cd700837a00452577a8632022485101cafe4140217b6117814ef410c4e
6
+ metadata.gz: 55389aab59bfd1d8958156062c455b9c017d41f9e67f52bed901bf3f16c6b319b7655553caf8dd7b2d43a2756e15c7b72f85da6e56c79937252722ce2e143cf7
7
+ data.tar.gz: e554159e81d7e519e9e18c600150a19d4df80dc3707fbdd6c417ba4389743b85d622b50bce66746ba5e9baa2fdc5994928c3402be5d3a8d3b90074e28a9640f7
@@ -22,8 +22,8 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module AsyncSearch
24
24
  module Actions
25
- # Deletes an async search by identifier.
26
- # If the search is still running, the search request will be cancelled.
25
+ # Delete an async search.
26
+ # If the asynchronous search is still running, it is cancelled.
27
27
  # Otherwise, the saved search results are deleted.
28
28
  # If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the +cancel_task+ cluster privilege.
29
29
  #
@@ -22,7 +22,8 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module AsyncSearch
24
24
  module Actions
25
- # Retrieves the results of a previously submitted async search request given its identifier.
25
+ # Get async search results.
26
+ # Retrieve the results of a previously submitted asynchronous search request.
26
27
  # If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.
27
28
  #
28
29
  # @option arguments [String] :id A unique identifier for the async search. (*Required*)
@@ -22,8 +22,8 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module AsyncSearch
24
24
  module Actions
25
- # Get async search status
26
- # Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.
25
+ # Get async search status.
26
+ # Retrieve the status of a previously submitted async search request given its identifier, without retrieving search results.
27
27
  # If the Elasticsearch security features are enabled, use of this API is restricted to the +monitoring_user+ role.
28
28
  #
29
29
  # @option arguments [String] :id A unique identifier for the async search. (*Required*)
@@ -22,10 +22,10 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module AsyncSearch
24
24
  module Actions
25
- # Runs a search request asynchronously.
26
- # When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.
27
- # Warning: Async search does not support scroll nor search requests that only include the suggest section.
28
- # By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.
25
+ # Run an async search.
26
+ # When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested.
27
+ # Warning: Asynchronous search does not support scroll or search requests that include only the suggest section.
28
+ # By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.
29
29
  # The maximum allowed size for a stored async search response can be set by changing the +search.max_async_search_response_size+ cluster level setting.
30
30
  #
31
31
  # @option arguments [String, Array] :index A comma-separated list of index names to search; use +_all+ or empty string to perform the operation on all indices
@@ -38,12 +38,6 @@ module ElasticsearchServerless
38
38
  def clear_scroll(arguments = {})
39
39
  request_opts = { endpoint: arguments[:endpoint] || "clear_scroll" }
40
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
-
47
41
  arguments = arguments.clone
48
42
  headers = arguments.delete(:headers) || {}
49
43
 
@@ -52,11 +46,7 @@ module ElasticsearchServerless
52
46
  _scroll_id = arguments.delete(:scroll_id)
53
47
 
54
48
  method = ElasticsearchServerless::API::HTTP_DELETE
55
- path = if _scroll_id
56
- "_search/scroll/#{Utils.listify(_scroll_id)}"
57
- else
58
- "_search/scroll"
59
- end
49
+ path = "_search/scroll"
60
50
  params = Utils.process_params(arguments)
61
51
 
62
52
  if Array(arguments[:ignore]).include?(404)
@@ -22,7 +22,8 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Connector
24
24
  module Actions
25
- # Updates the last_seen field in the connector, and sets it to current timestamp
25
+ # Check in a connector.
26
+ # Update the +last_seen+ field in the connector and set it to the current timestamp.
26
27
  # This functionality is Experimental and may be changed or removed
27
28
  # completely in a future release. Elastic will take a best effort approach
28
29
  # to fix any issues, but experimental features are not subject to the
@@ -22,7 +22,11 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Connector
24
24
  module Actions
25
- # Deletes a connector.
25
+ # Delete a connector.
26
+ # Removes a connector and associated sync jobs.
27
+ # This is a destructive action that is not recoverable.
28
+ # NOTE: This action doesn’t delete any API keys, ingest pipelines, or data indices associated with the connector.
29
+ # These need to be removed manually.
26
30
  # This functionality is in Beta and is subject to change. The design and
27
31
  # code is less mature than official GA features and is being provided
28
32
  # as-is with no warranties. Beta features are not subject to the support
@@ -22,7 +22,8 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Connector
24
24
  module Actions
25
- # Retrieves a connector.
25
+ # Get a connector.
26
+ # Get the details about a connector.
26
27
  # This functionality is in Beta and is subject to change. The design and
27
28
  # code is less mature than official GA features and is being provided
28
29
  # as-is with no warranties. Beta features are not subject to the support
@@ -22,7 +22,8 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Connector
24
24
  module Actions
25
- # Returns existing connectors.
25
+ # Get all connectors.
26
+ # Get information about all connectors.
26
27
  # This functionality is in Beta and is subject to change. The design and
27
28
  # code is less mature than official GA features and is being provided
28
29
  # as-is with no warranties. Beta features are not subject to the support
@@ -22,7 +22,10 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Connector
24
24
  module Actions
25
- # Creates a connector.
25
+ # Create a connector.
26
+ # Connectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure.
27
+ # Elastic managed connectors (Native connectors) are a managed service on Elastic Cloud.
28
+ # Self-managed connectors (Connector clients) are self-managed on your infrastructure.
26
29
  # This functionality is in Beta and is subject to change. The design and
27
30
  # code is less mature than official GA features and is being provided
28
31
  # as-is with no warranties. Beta features are not subject to the support
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Connector
24
24
  module Actions
25
- # Creates or updates a connector.
25
+ # Create or update a connector.
26
26
  # This functionality is in Beta and is subject to change. The design and
27
27
  # code is less mature than official GA features and is being provided
28
28
  # as-is with no warranties. Beta features are not subject to the support
@@ -22,7 +22,9 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Connector
24
24
  module Actions
25
- # Cancels a connector sync job.
25
+ # Cancel a connector sync job.
26
+ # Cancel a connector sync job, which sets the status to cancelling and updates +cancellation_requested_at+ to the current time.
27
+ # The connector service is then responsible for setting the status of connector sync jobs to cancelled.
26
28
  # This functionality is in Beta and is subject to change. The design and
27
29
  # code is less mature than official GA features and is being provided
28
30
  # as-is with no warranties. Beta features are not subject to the support
@@ -22,7 +22,9 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Connector
24
24
  module Actions
25
- # Deletes a connector sync job.
25
+ # Delete a connector sync job.
26
+ # Remove a connector sync job and its associated data.
27
+ # This is a destructive action that is not recoverable.
26
28
  # This functionality is in Beta and is subject to change. The design and
27
29
  # code is less mature than official GA features and is being provided
28
30
  # as-is with no warranties. Beta features are not subject to the support
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Connector
24
24
  module Actions
25
- # Retrieves a connector sync job.
25
+ # Get a connector sync job.
26
26
  # This functionality is in Beta and is subject to change. The design and
27
27
  # code is less mature than official GA features and is being provided
28
28
  # as-is with no warranties. Beta features are not subject to the support
@@ -22,7 +22,8 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Connector
24
24
  module Actions
25
- # Lists connector sync jobs.
25
+ # Get all connector sync jobs.
26
+ # Get information about all stored connector sync jobs listed by their creation date in ascending order.
26
27
  # This functionality is in Beta and is subject to change. The design and
27
28
  # code is less mature than official GA features and is being provided
28
29
  # as-is with no warranties. Beta features are not subject to the support
@@ -22,7 +22,8 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Connector
24
24
  module Actions
25
- # Creates a connector sync job.
25
+ # Create a connector sync job.
26
+ # Create a connector sync job document in the internal index and initialize its counters and timestamps with default values.
26
27
  # This functionality is in Beta and is subject to change. The design and
27
28
  # code is less mature than official GA features and is being provided
28
29
  # as-is with no warranties. Beta features are not subject to the support
@@ -22,6 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Connector
24
24
  module Actions
25
+ # Activate the connector draft filter.
25
26
  # Activates the valid draft filtering for a connector.
26
27
  # This functionality is Experimental and may be changed or removed
27
28
  # completely in a future release. Elastic will take a best effort approach
@@ -22,7 +22,11 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Connector
24
24
  module Actions
25
- # Updates the API key id in the connector document
25
+ # Update the connector API key ID.
26
+ # Update the +api_key_id+ and +api_key_secret_id+ fields of a connector.
27
+ # You can specify the ID of the API key used for authorization and the ID of the connector secret where the API key is stored.
28
+ # The connector secret ID is required only for Elastic managed (native) connectors.
29
+ # Self-managed connectors (connector clients) do not use this field.
26
30
  # This functionality is in Beta and is subject to change. The design and
27
31
  # code is less mature than official GA features and is being provided
28
32
  # as-is with no warranties. Beta features are not subject to the support
@@ -22,7 +22,8 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Connector
24
24
  module Actions
25
- # Updates the configuration field in the connector document
25
+ # Update the connector configuration.
26
+ # Update the configuration field in the connector document.
26
27
  # This functionality is in Beta and is subject to change. The design and
27
28
  # code is less mature than official GA features and is being provided
28
29
  # as-is with no warranties. Beta features are not subject to the support
@@ -22,7 +22,10 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Connector
24
24
  module Actions
25
- # Updates the filtering field in the connector document
25
+ # Update the connector error field.
26
+ # Set the error field for the connector.
27
+ # If the error provided in the request body is non-null, the connector’s status is updated to error.
28
+ # Otherwise, if the error is reset to null, the connector status is updated to connected.
26
29
  # This functionality is Experimental and may be changed or removed
27
30
  # completely in a future release. Elastic will take a best effort approach
28
31
  # to fix any issues, but experimental features are not subject to the
@@ -22,7 +22,10 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Connector
24
24
  module Actions
25
- # Updates the filtering field in the connector document
25
+ # Update the connector filtering.
26
+ # Update the draft filtering configuration of a connector and marks the draft validation state as edited.
27
+ # The filtering draft is activated once validated by the running Elastic connector service.
28
+ # The filtering property is used to configure sync rules (both basic and advanced) for a connector.
26
29
  # This functionality is in Beta and is subject to change. The design and
27
30
  # code is less mature than official GA features and is being provided
28
31
  # as-is with no warranties. Beta features are not subject to the support
@@ -22,7 +22,8 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Connector
24
24
  module Actions
25
- # Updates the draft filtering validation info for a connector.
25
+ # Update the connector draft filtering validation.
26
+ # Update the draft filtering validation info for a connector.
26
27
  # This functionality is Experimental and may be changed or removed
27
28
  # completely in a future release. Elastic will take a best effort approach
28
29
  # to fix any issues, but experimental features are not subject to the
@@ -22,7 +22,8 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Connector
24
24
  module Actions
25
- # Updates the index_name in the connector document
25
+ # Update the connector index name.
26
+ # Update the +index_name+ field of a connector, specifying the index where the data ingested by the connector is stored.
26
27
  # This functionality is in Beta and is subject to change. The design and
27
28
  # code is less mature than official GA features and is being provided
28
29
  # as-is with no warranties. Beta features are not subject to the support
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Connector
24
24
  module Actions
25
- # Updates the name and description fields in the connector document
25
+ # Update the connector name and description.
26
26
  # This functionality is in Beta and is subject to change. The design and
27
27
  # code is less mature than official GA features and is being provided
28
28
  # as-is with no warranties. Beta features are not subject to the support
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Connector
24
24
  module Actions
25
- # Updates the is_native flag in the connector document
25
+ # Update the connector is_native flag.
26
26
  # This functionality is in Beta and is subject to change. The design and
27
27
  # code is less mature than official GA features and is being provided
28
28
  # as-is with no warranties. Beta features are not subject to the support
@@ -22,7 +22,8 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Connector
24
24
  module Actions
25
- # Updates the pipeline field in the connector document
25
+ # Update the connector pipeline.
26
+ # When you create a new connector, the configuration of an ingest pipeline is populated with default settings.
26
27
  # This functionality is in Beta and is subject to change. The design and
27
28
  # code is less mature than official GA features and is being provided
28
29
  # as-is with no warranties. Beta features are not subject to the support
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Connector
24
24
  module Actions
25
- # Updates the scheduling field in the connector document
25
+ # Update the connector scheduling.
26
26
  # This functionality is in Beta and is subject to change. The design and
27
27
  # code is less mature than official GA features and is being provided
28
28
  # as-is with no warranties. Beta features are not subject to the support
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Connector
24
24
  module Actions
25
- # Updates the service type of the connector
25
+ # Update the connector service type.
26
26
  # This functionality is in Beta and is subject to change. The design and
27
27
  # code is less mature than official GA features and is being provided
28
28
  # as-is with no warranties. Beta features are not subject to the support
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Connector
24
24
  module Actions
25
- # Updates the status of the connector
25
+ # Update the connector status.
26
26
  # This functionality is Experimental and may be changed or removed
27
27
  # completely in a future release. Elastic will take a best effort approach
28
28
  # to fix any issues, but experimental features are not subject to the
@@ -22,7 +22,8 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Indices
24
24
  module Actions
25
- # Performs analysis on a text string and returns the resulting tokens.
25
+ # Get tokens from text analysis.
26
+ # The analyze API performs {https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html analysis} on a text string and returns the resulting tokens.
26
27
  #
27
28
  # @option arguments [String] :index Index used to derive the analyzer.
28
29
  # If specified, the +analyzer+ or field parameter overrides this value.
@@ -32,6 +32,8 @@ module ElasticsearchServerless
32
32
  # Cannot start with +-+, +_+, +++, or +.ds-+;
33
33
  # Cannot be +.+ or +..+;
34
34
  # Cannot be longer than 255 bytes. Multi-byte characters count towards this limit faster. (*Required*)
35
+ # @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.
36
+ # @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.
35
37
  # @option arguments [Hash] :headers Custom HTTP headers
36
38
  #
37
39
  # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html
@@ -56,7 +58,7 @@ module ElasticsearchServerless
56
58
 
57
59
  method = ElasticsearchServerless::API::HTTP_PUT
58
60
  path = "_data_stream/#{Utils.listify(_name)}"
59
- params = {}
61
+ params = Utils.process_params(arguments)
60
62
 
61
63
  ElasticsearchServerless::API::Response.new(
62
64
  perform_request(method, path, params, body, headers, request_opts)
@@ -26,6 +26,7 @@ module ElasticsearchServerless
26
26
  # Deletes one or more data streams and their backing indices.
27
27
  #
28
28
  # @option arguments [String, Array<String>] :name Comma-separated list of data streams to delete. Wildcard (+*+) expressions are supported. (*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.
29
30
  # @option arguments [String, Array<String>] :expand_wildcards Type of data stream that wildcard patterns can match. Supports comma-separated values,such as +open,hidden+. Server default: open.
30
31
  # @option arguments [Hash] :headers Custom HTTP headers
31
32
  #
@@ -32,6 +32,7 @@ module ElasticsearchServerless
32
32
  # Supports comma-separated values, such as +open,hidden+.
33
33
  # Valid values are: +all+, +open+, +closed+, +hidden+, +none+. Server default: open.
34
34
  # @option arguments [Boolean] :include_defaults If +true+, return all default settings in the response.
35
+ # @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.
35
36
  # @option arguments [Hash] :headers Custom HTTP headers
36
37
  #
37
38
  # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-get-lifecycle.html
@@ -30,6 +30,8 @@ module ElasticsearchServerless
30
30
  # @option arguments [String, Array<String>] :expand_wildcards Type of data stream that wildcard patterns can match.
31
31
  # Supports comma-separated values, such as +open,hidden+. Server default: open.
32
32
  # @option arguments [Boolean] :include_defaults If true, returns all relevant default configurations for the index template.
33
+ # @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.
34
+ # @option arguments [Boolean] :verbose Whether the maximum timestamp for each data stream should be calculated and returned.
33
35
  # @option arguments [Hash] :headers Custom HTTP headers
34
36
  #
35
37
  # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html
@@ -35,6 +35,8 @@ module ElasticsearchServerless
35
35
  # The write index for the alias becomes the write index for the stream.
36
36
  #
37
37
  # @option arguments [String] :name Name of the index alias to convert to a data stream. (*Required*)
38
+ # @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.
39
+ # @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.
38
40
  # @option arguments [Hash] :headers Custom HTTP headers
39
41
  #
40
42
  # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html
@@ -59,7 +61,7 @@ module ElasticsearchServerless
59
61
 
60
62
  method = ElasticsearchServerless::API::HTTP_POST
61
63
  path = "_data_stream/_migrate/#{Utils.listify(_name)}"
62
- params = {}
64
+ params = Utils.process_params(arguments)
63
65
 
64
66
  ElasticsearchServerless::API::Response.new(
65
67
  perform_request(method, path, params, body, headers, request_opts)
@@ -37,7 +37,7 @@ module ElasticsearchServerless
37
37
  # @option arguments [Time] :timeout Period to wait for a response.
38
38
  # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
39
39
  # @option arguments [Hash] :headers Custom HTTP headers
40
- # @option arguments [Hash] :body request body
40
+ # @option arguments [Hash] :body lifecycle
41
41
  #
42
42
  # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-put-lifecycle.html
43
43
  #
@@ -50,6 +50,7 @@ module ElasticsearchServerless
50
50
  end
51
51
  request_opts[:defined_params] = defined_params unless defined_params.empty?
52
52
 
53
+ raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
53
54
  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
54
55
 
55
56
  arguments = arguments.clone
@@ -31,6 +31,10 @@ module ElasticsearchServerless
31
31
  # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
32
32
  # Supports comma-separated values, such as +open,hidden+.
33
33
  # Valid values are: +all+, +open+, +closed+, +hidden+, +none+. Server default: open.
34
+ # @option arguments [Boolean] :ignore_unavailable If +false+, the request returns an error if it targets a missing or closed index.
35
+ # @option arguments [Boolean] :allow_no_indices If +false+, the request returns an error if any wildcard expression, index alias, or +_all+ value targets only missing or closed indices.
36
+ # This behavior applies even if the request targets other open indices.
37
+ # For example, a request targeting +foo*,bar*+ returns an error if an index starts with +foo+ but no index starts with +bar+. Server default: true.
34
38
  # @option arguments [Hash] :headers Custom HTTP headers
35
39
  #
36
40
  # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-resolve-index-api.html
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Forces any buffered data to be processed by the job.
25
+ # Force buffered data to be processed.
26
26
  # The flush jobs API is only applicable when sending data for analysis using
27
27
  # the post data API. Depending on the content of the buffer, then it might
28
28
  # additionally calculate new results. Both flush and close operations are
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Retrieves information about the scheduled events in calendars.
25
+ # Get info about events in calendars.
26
26
  #
27
27
  # @option arguments [String] :calendar_id A string that uniquely identifies a calendar. You can get information for multiple calendars by using a comma-separated list of ids or a wildcard expression. You can get information for all calendars by using +_all+ or +*+ or by omitting the calendar identifier. (*Required*)
28
28
  # @option arguments [String, Time] :end Specifies to get events with timestamps earlier than this time.
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Retrieves configuration information for calendars.
25
+ # Get calendar configuration info.
26
26
  #
27
27
  # @option arguments [String] :calendar_id A string that uniquely identifies a calendar. You can get information for multiple calendars by using a comma-separated list of ids or a wildcard expression. You can get information for all calendars by using +_all+ or +*+ or by omitting the calendar identifier.
28
28
  # @option arguments [Integer] :from Skips the specified number of calendars. This parameter is supported only when you omit the calendar identifier. Server default: 0.
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Retrieves configuration information for data frame analytics jobs.
25
+ # Get data frame analytics job configuration info.
26
26
  # You can get information for multiple data frame analytics jobs in a single
27
27
  # API request by using a comma-separated list of data frame analytics jobs or a
28
28
  # wildcard expression.
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Retrieves usage information for data frame analytics jobs.
25
+ # Get data frame analytics jobs usage info.
26
26
  #
27
27
  # @option arguments [String] :id Identifier for the data frame analytics job. If you do not specify this
28
28
  # option, the API returns information for the first hundred data frame
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Retrieves usage information for datafeeds.
25
+ # Get datafeeds usage info.
26
26
  # You can get statistics for multiple datafeeds in a single API request by
27
27
  # using a comma-separated list of datafeeds or a wildcard expression. You can
28
28
  # get statistics for all datafeeds by using +_all+, by specifying +*+ as the
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Retrieves configuration information for datafeeds.
25
+ # Get datafeeds configuration info.
26
26
  # You can get information for multiple datafeeds in a single API request by
27
27
  # using a comma-separated list of datafeeds or a wildcard expression. You can
28
28
  # get information for all datafeeds by using +_all+, by specifying +*+ as the
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Retrieves filters.
25
+ # Get filters.
26
26
  # You can get a single filter or all filters.
27
27
  #
28
28
  # @option arguments [String, Array] :filter_id A string that uniquely identifies a filter.
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Retrieves usage information for anomaly detection jobs.
25
+ # Get anomaly detection jobs usage info.
26
26
  #
27
27
  # @option arguments [String] :job_id Identifier for the anomaly detection job. It can be a job identifier, a
28
28
  # group name, a comma-separated list of jobs, or a wildcard expression. If
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Retrieves configuration information for anomaly detection jobs.
25
+ # Get anomaly detection jobs configuration info.
26
26
  # You can get information for multiple anomaly detection jobs in a single API
27
27
  # request by using a group name, a comma-separated list of jobs, or a wildcard
28
28
  # expression. You can get information for all anomaly detection jobs by using
@@ -22,7 +22,8 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Retrieves overall bucket results that summarize the bucket results of
25
+ # Get overall bucket results.
26
+ # Retrievs overall bucket results that summarize the bucket results of
26
27
  # multiple anomaly detection jobs.
27
28
  # The +overall_score+ is calculated by combining the scores of all the
28
29
  # buckets within the overall bucket span. First, the maximum
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Retrieves configuration information for a trained model.
25
+ # Get trained model configuration info.
26
26
  #
27
27
  # @option arguments [String, Array] :model_id The unique identifier of the trained model or a model alias.You can get information for multiple trained models in a single API
28
28
  # request by using a comma-separated list of model IDs or a wildcard
@@ -22,7 +22,8 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Retrieves usage information for trained models. You can get usage information for multiple trained
25
+ # Get trained models usage info.
26
+ # You can get usage information for multiple trained
26
27
  # models in a single API request by using a comma-separated list of model IDs or a wildcard expression.
27
28
  #
28
29
  # @option arguments [String, Array] :model_id The unique identifier of the trained model or a model alias. It can be a