elasticsearch-serverless 0.3.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (64) hide show
  1. checksums.yaml +4 -4
  2. data/lib/elasticsearch-serverless/api/indices/create_data_stream.rb +3 -1
  3. data/lib/elasticsearch-serverless/api/indices/delete_data_stream.rb +1 -0
  4. data/lib/elasticsearch-serverless/api/indices/get_data_lifecycle.rb +1 -0
  5. data/lib/elasticsearch-serverless/api/indices/get_data_stream.rb +2 -0
  6. data/lib/elasticsearch-serverless/api/indices/migrate_to_data_stream.rb +3 -1
  7. data/lib/elasticsearch-serverless/api/indices/resolve_index.rb +4 -0
  8. data/lib/elasticsearch-serverless/api/machine_learning/flush_job.rb +1 -1
  9. data/lib/elasticsearch-serverless/api/machine_learning/get_calendar_events.rb +1 -1
  10. data/lib/elasticsearch-serverless/api/machine_learning/get_calendars.rb +1 -1
  11. data/lib/elasticsearch-serverless/api/machine_learning/get_data_frame_analytics.rb +1 -1
  12. data/lib/elasticsearch-serverless/api/machine_learning/get_data_frame_analytics_stats.rb +1 -1
  13. data/lib/elasticsearch-serverless/api/machine_learning/get_datafeed_stats.rb +1 -1
  14. data/lib/elasticsearch-serverless/api/machine_learning/get_datafeeds.rb +1 -1
  15. data/lib/elasticsearch-serverless/api/machine_learning/get_filters.rb +1 -1
  16. data/lib/elasticsearch-serverless/api/machine_learning/get_job_stats.rb +1 -1
  17. data/lib/elasticsearch-serverless/api/machine_learning/get_jobs.rb +1 -1
  18. data/lib/elasticsearch-serverless/api/machine_learning/get_overall_buckets.rb +2 -1
  19. data/lib/elasticsearch-serverless/api/machine_learning/get_trained_models.rb +1 -1
  20. data/lib/elasticsearch-serverless/api/machine_learning/get_trained_models_stats.rb +2 -1
  21. data/lib/elasticsearch-serverless/api/machine_learning/open_job.rb +2 -3
  22. data/lib/elasticsearch-serverless/api/machine_learning/post_calendar_events.rb +1 -1
  23. data/lib/elasticsearch-serverless/api/machine_learning/preview_data_frame_analytics.rb +1 -0
  24. data/lib/elasticsearch-serverless/api/machine_learning/preview_datafeed.rb +1 -1
  25. data/lib/elasticsearch-serverless/api/machine_learning/put_calendar.rb +1 -1
  26. data/lib/elasticsearch-serverless/api/machine_learning/put_calendar_job.rb +1 -1
  27. data/lib/elasticsearch-serverless/api/machine_learning/put_data_frame_analytics.rb +1 -1
  28. data/lib/elasticsearch-serverless/api/machine_learning/put_datafeed.rb +1 -1
  29. data/lib/elasticsearch-serverless/api/machine_learning/put_filter.rb +1 -1
  30. data/lib/elasticsearch-serverless/api/machine_learning/put_trained_model.rb +2 -1
  31. data/lib/elasticsearch-serverless/api/machine_learning/put_trained_model_alias.rb +3 -2
  32. data/lib/elasticsearch-serverless/api/machine_learning/put_trained_model_definition_part.rb +1 -1
  33. data/lib/elasticsearch-serverless/api/machine_learning/put_trained_model_vocabulary.rb +1 -1
  34. data/lib/elasticsearch-serverless/api/machine_learning/reset_job.rb +1 -1
  35. data/lib/elasticsearch-serverless/api/machine_learning/start_data_frame_analytics.rb +1 -1
  36. data/lib/elasticsearch-serverless/api/machine_learning/start_datafeed.rb +1 -1
  37. data/lib/elasticsearch-serverless/api/machine_learning/start_trained_model_deployment.rb +2 -1
  38. data/lib/elasticsearch-serverless/api/machine_learning/stop_data_frame_analytics.rb +1 -1
  39. data/lib/elasticsearch-serverless/api/machine_learning/stop_datafeed.rb +1 -1
  40. data/lib/elasticsearch-serverless/api/machine_learning/stop_trained_model_deployment.rb +1 -1
  41. data/lib/elasticsearch-serverless/api/machine_learning/update_data_frame_analytics.rb +1 -1
  42. data/lib/elasticsearch-serverless/api/machine_learning/update_datafeed.rb +1 -1
  43. data/lib/elasticsearch-serverless/api/machine_learning/update_filter.rb +1 -0
  44. data/lib/elasticsearch-serverless/api/machine_learning/update_job.rb +1 -0
  45. data/lib/elasticsearch-serverless/api/machine_learning/update_trained_model_deployment.rb +1 -1
  46. data/lib/elasticsearch-serverless/api/msearch.rb +7 -9
  47. data/lib/elasticsearch-serverless/api/open_point_in_time.rb +2 -1
  48. data/lib/elasticsearch-serverless/api/search_application/delete.rb +2 -1
  49. data/lib/elasticsearch-serverless/api/search_application/delete_behavioral_analytics.rb +1 -0
  50. data/lib/elasticsearch-serverless/api/search_application/get.rb +1 -1
  51. data/lib/elasticsearch-serverless/api/search_application/get_behavioral_analytics.rb +1 -1
  52. data/lib/elasticsearch-serverless/api/search_application/put.rb +1 -1
  53. data/lib/elasticsearch-serverless/api/search_application/put_behavioral_analytics.rb +1 -1
  54. data/lib/elasticsearch-serverless/api/search_application/search.rb +3 -1
  55. data/lib/elasticsearch-serverless/api/update_by_query.rb +1 -0
  56. data/lib/elasticsearch-serverless/api.rb +0 -1
  57. data/lib/elasticsearch-serverless/version.rb +1 -1
  58. metadata +7 -13
  59. data/lib/elasticsearch-serverless/api/esql/query.rb +0 -57
  60. data/lib/elasticsearch-serverless/api/indices/data_streams_stats.rb +0 -68
  61. data/lib/elasticsearch-serverless/api/indices/put_template.rb +0 -71
  62. data/lib/elasticsearch-serverless/api/machine_learning/infer_trained_model.rb +0 -71
  63. data/lib/elasticsearch-serverless/api/security/update_api_key.rb +0 -75
  64. data/lib/elasticsearch-serverless/api/tasks/get.rb +0 -67
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f65fea7b65dd1eae81bcd4369221d71d2809895df40f168196005179f10a6c05
4
- data.tar.gz: 4a958e6a4bf23122ba8709c89fa82e932ec240f18146a07f5dc8cde39c0dffa7
3
+ metadata.gz: 8bde730a1cac096779c66fa3d59c1d58c20c7134e68a2b009bb7ef5e6a9d8ae7
4
+ data.tar.gz: b2b1909d53c9ef64ebbf651ca0dd7b61bf409c6333840b78d4c477f4871edb87
5
5
  SHA512:
6
- metadata.gz: f913a7e87f209fc6190a2fa18fd59036ddff358b08a05a333f530cb55134c6b2a067463311948cda968118b99c03bb72c5d3b4550e8c4e6f18c2a337e439acc2
7
- data.tar.gz: d274e0623ae7970d614631f0a57ea518fdbb108f340557d5e9faac7621516c4d6e2247cd700837a00452577a8632022485101cafe4140217b6117814ef410c4e
6
+ metadata.gz: 8b3192c5235b479cdfc5fc4b2b9e80f80c97624aad53140d37bfb066f31be1a594cea00b0e31bb5401949d5903f11856aece51f9c022d7fa33d2c9796a0e86fa
7
+ data.tar.gz: d94a7b20610597b151002b81fcc61a51b6b59f4eb9a7d5d714dd6e32935b6fde759c571145dd73977827a9bcb88c963d5a6645d40f4af362e22ee1784b1e5c1d
@@ -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)
@@ -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
@@ -23,9 +23,8 @@ module ElasticsearchServerless
23
23
  module MachineLearning
24
24
  module Actions
25
25
  # Open anomaly detection jobs.
26
- # An anomaly detection job must be opened in order for it to be ready to
27
- # receive and analyze data. It can be opened and closed multiple times
28
- # throughout its lifecycle.
26
+ # An anomaly detection job must be opened to be ready to receive and analyze
27
+ # data. It can be opened and closed multiple times throughout its lifecycle.
29
28
  # When you open a new job, it starts with an empty model.
30
29
  # When you open an existing job, the most recent model state is automatically
31
30
  # loaded. The job is ready to resume its analysis from where it left off, once
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Adds scheduled events to a calendar.
25
+ # Add scheduled events to the 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
@@ -22,6 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
+ # Preview features used by data frame analytics.
25
26
  # Previews the extracted features used by a data frame analytics config.
26
27
  #
27
28
  # @option arguments [String] :id Identifier for the data frame analytics job.
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Previews a datafeed.
25
+ # Preview a datafeed.
26
26
  # This API returns the first "page" of search results from a datafeed.
27
27
  # You can preview an existing datafeed or provide configuration details for a datafeed
28
28
  # and anomaly detection job in the API. The preview shows the structure of the data
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Creates a calendar.
25
+ # Create 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
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Adds an anomaly detection job to a calendar.
25
+ # Add anomaly detection job to calendar.
26
26
  #
27
27
  # @option arguments [String] :calendar_id A string that uniquely identifies a calendar. (*Required*)
28
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*)
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Instantiates a data frame analytics job.
25
+ # Create a data frame analytics job.
26
26
  # This API creates a data frame analytics job that performs an analysis on the
27
27
  # source indices and stores the outcome in a destination index.
28
28
  #
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Instantiates a datafeed.
25
+ # Create a datafeed.
26
26
  # Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.
27
27
  # You can associate only one datafeed with each anomaly detection job.
28
28
  # The datafeed contains a query that runs at a defined interval (+frequency+).
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Instantiates a filter.
25
+ # Create a filter.
26
26
  # A filter contains a list of strings. It can be used by one or more anomaly detection jobs.
27
27
  # Specifically, filters are referenced in the +custom_rules+ property of detector configuration objects.
28
28
  #
@@ -22,7 +22,8 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Enables you to supply a trained model that is not created by data frame analytics.
25
+ # Create a trained model.
26
+ # Enable you to supply a trained model that is not created by data frame analytics.
26
27
  #
27
28
  # @option arguments [String] :model_id The unique identifier of the trained model. (*Required*)
28
29
  # @option arguments [Boolean] :defer_definition_decompression If set to +true+ and a +compressed_definition+ is provided,
@@ -22,8 +22,9 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Creates or updates a trained model alias. A trained model alias is a logical
26
- # name used to reference a single trained model.
25
+ # Create or update a trained model alias.
26
+ # A trained model alias is a logical name used to reference a single trained
27
+ # model.
27
28
  # You can use aliases instead of trained model identifiers to make it easier to
28
29
  # reference your models. For example, you can use aliases in inference
29
30
  # aggregations and processors.
@@ -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
+ # Create 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
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Creates a trained model vocabulary.
25
+ # Create a trained model vocabulary.
26
26
  # This API is supported only for natural language processing (NLP) models.
27
27
  # The vocabulary is stored in the index as described in +inference_config.*.vocabulary+ of the trained model definition.
28
28
  #
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Resets an anomaly detection job.
25
+ # Reset an anomaly detection job.
26
26
  # All model state and results are deleted. The job is ready to start over as if
27
27
  # it had just been created.
28
28
  # It is not currently possible to reset multiple jobs using wildcards or a
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Starts a data frame analytics job.
25
+ # Start a data frame analytics job.
26
26
  # A data frame analytics job can be started and stopped multiple times
27
27
  # throughout its lifecycle.
28
28
  # If the destination index does not exist, it is created automatically the
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Starts one or more datafeeds.
25
+ # Start datafeeds.
26
26
  # A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped
27
27
  # multiple times throughout its lifecycle.
28
28
  # Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs.
@@ -22,7 +22,8 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Starts a trained model deployment, which allocates the model to every machine learning node.
25
+ # Start a trained model deployment.
26
+ # It allocates the model to every machine learning node.
26
27
  #
27
28
  # @option arguments [String] :model_id The unique identifier of the trained model. Currently, only PyTorch models are supported. (*Required*)
28
29
  # @option arguments [Integer, String] :cache_size The inference cache size (in memory outside the JVM heap) per node for the model.
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Stops one or more data frame analytics jobs.
25
+ # Stop data frame analytics jobs.
26
26
  # A data frame analytics job can be started and stopped multiple times
27
27
  # throughout its lifecycle.
28
28
  #
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Stops one or more datafeeds.
25
+ # Stop datafeeds.
26
26
  # A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped
27
27
  # multiple times throughout its lifecycle.
28
28
  #
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Stops a trained model deployment.
25
+ # Stop 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;
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Updates an existing data frame analytics job.
25
+ # Update a data frame analytics job.
26
26
  #
27
27
  # @option arguments [String] :id Identifier for the data frame analytics job. This identifier can contain
28
28
  # lowercase alphanumeric characters (a-z and 0-9), hyphens, and
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Updates the properties of a datafeed.
25
+ # Update a datafeed.
26
26
  # You must stop and start the datafeed for the changes to be applied.
27
27
  # When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at
28
28
  # the time of the update and runs the query using those same roles. If you provide secondary authorization headers,
@@ -22,6 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
+ # Update a filter.
25
26
  # Updates the description of a filter, adds items, or removes items from the list.
26
27
  #
27
28
  # @option arguments [String] :filter_id A string that uniquely identifies a filter. (*Required*)
@@ -22,6 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
+ # Update an anomaly detection job.
25
26
  # Updates certain properties of an anomaly detection job.
26
27
  #
27
28
  # @option arguments [String] :job_id Identifier for the job. (*Required*)
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module MachineLearning
24
24
  module Actions
25
- # Starts a trained model deployment, which allocates the model to every machine learning node.
25
+ # Update a trained model deployment.
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] :number_of_allocations The number of model allocations on each node where the model is deployed.
@@ -75,16 +75,14 @@ module ElasticsearchServerless
75
75
 
76
76
  case
77
77
  when body.is_a?(Array) && body.any? { |d| d.has_key? :search }
78
- payload = body
79
- .inject([]) do |sum, item|
80
- meta = item
81
- data = meta.delete(:search)
78
+ payload = body.inject([]) do |sum, item|
79
+ meta = item
80
+ data = meta.delete(:search)
82
81
 
83
- sum << meta
84
- sum << data
85
- sum
86
- end
87
- .map { |item| ElasticsearchServerless::API.serializer.dump(item) }
82
+ sum << meta
83
+ sum << data
84
+ sum
85
+ end.map { |item| ElasticsearchServerless::API.serializer.dump(item) }
88
86
  payload << "" unless payload.empty?
89
87
  payload = payload.join("\n")
90
88
  when body.is_a?(Array)
@@ -38,6 +38,7 @@ module ElasticsearchServerless
38
38
  # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
39
39
  # Supports comma-separated values, such as +open,hidden+. Valid values are: +all+, +open+, +closed+, +hidden+, +none+. Server default: open.
40
40
  # @option arguments [Hash] :headers Custom HTTP headers
41
+ # @option arguments [Hash] :body request body
41
42
  #
42
43
  # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/point-in-time-api.html
43
44
  #
@@ -55,7 +56,7 @@ module ElasticsearchServerless
55
56
  arguments = arguments.clone
56
57
  headers = arguments.delete(:headers) || {}
57
58
 
58
- body = nil
59
+ body = arguments.delete(:body)
59
60
 
60
61
  _index = arguments.delete(:index)
61
62
 
@@ -22,7 +22,8 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module SearchApplication
24
24
  module Actions
25
- # Deletes a search application.
25
+ # Delete a search application.
26
+ # Remove a search application and its associated alias. Indices attached to the search application are not removed.
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
@@ -23,6 +23,7 @@ module ElasticsearchServerless
23
23
  module SearchApplication
24
24
  module Actions
25
25
  # Delete a behavioral analytics collection.
26
+ # The associated data stream is also deleted.
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,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module SearchApplication
24
24
  module Actions
25
- # Returns the details about a search application
25
+ # Get search application details.
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 SearchApplication
24
24
  module Actions
25
- # Returns the existing behavioral analytics collections.
25
+ # Get behavioral analytics collections.
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,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module SearchApplication
24
24
  module Actions
25
- # Creates or updates a search application.
25
+ # Create or update a search application.
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 SearchApplication
24
24
  module Actions
25
- # Creates a behavioral analytics collection.
25
+ # Create a behavioral analytics collection.
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,9 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module SearchApplication
24
24
  module Actions
25
- # Perform a search against a search application.
25
+ # Run a search application search.
26
+ # Generate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template.
27
+ # Unspecified template parameters are assigned their default values if applicable.
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
@@ -50,6 +50,7 @@ module ElasticsearchServerless
50
50
  # If a final pipeline is configured it will always run, regardless of the value of this parameter.
51
51
  # @option arguments [String] :preference Specifies the node or shard the operation should be performed on.
52
52
  # Random by default.
53
+ # @option arguments [String] :q Query in the Lucene query string syntax.
53
54
  # @option arguments [Boolean] :refresh If +true+, Elasticsearch refreshes affected shards to make the operation visible to search.
54
55
  # @option arguments [Boolean] :request_cache If +true+, the request cache is used for this request.
55
56
  # @option arguments [Float] :requests_per_second The throttle for this request in sub-requests per second. Server default: -1.
@@ -62,7 +62,6 @@ module ElasticsearchServerless
62
62
  :connector,
63
63
  :enrich,
64
64
  :eql,
65
- :esql,
66
65
  :graph,
67
66
  :indices,
68
67
  :inference,
@@ -17,6 +17,6 @@
17
17
 
18
18
  module ElasticsearchServerless
19
19
  API_VERSION = '2023-10-31'.freeze
20
- CLIENT_VERSION = '0.3.0'.freeze
20
+ CLIENT_VERSION = '0.4.0'.freeze
21
21
  VERSION = CLIENT_VERSION
22
22
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: elasticsearch-serverless
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.0
4
+ version: 0.4.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Fernando Briano
8
- autorequire:
8
+ autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-08-13 00:00:00.000000000 Z
11
+ date: 2024-10-02 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: elastic-transport
@@ -24,7 +24,7 @@ dependencies:
24
24
  - - "~>"
25
25
  - !ruby/object:Gem::Version
26
26
  version: '8.3'
27
- description:
27
+ description:
28
28
  email: support@elastic.co
29
29
  executables: []
30
30
  extensions: []
@@ -92,7 +92,6 @@ files:
92
92
  - lib/elasticsearch-serverless/api/eql/get.rb
93
93
  - lib/elasticsearch-serverless/api/eql/get_status.rb
94
94
  - lib/elasticsearch-serverless/api/eql/search.rb
95
- - lib/elasticsearch-serverless/api/esql/query.rb
96
95
  - lib/elasticsearch-serverless/api/exists.rb
97
96
  - lib/elasticsearch-serverless/api/exists_source.rb
98
97
  - lib/elasticsearch-serverless/api/explain.rb
@@ -106,7 +105,6 @@ files:
106
105
  - lib/elasticsearch-serverless/api/indices/analyze.rb
107
106
  - lib/elasticsearch-serverless/api/indices/create.rb
108
107
  - lib/elasticsearch-serverless/api/indices/create_data_stream.rb
109
- - lib/elasticsearch-serverless/api/indices/data_streams_stats.rb
110
108
  - lib/elasticsearch-serverless/api/indices/delete.rb
111
109
  - lib/elasticsearch-serverless/api/indices/delete_alias.rb
112
110
  - lib/elasticsearch-serverless/api/indices/delete_data_lifecycle.rb
@@ -130,7 +128,6 @@ files:
130
128
  - lib/elasticsearch-serverless/api/indices/put_index_template.rb
131
129
  - lib/elasticsearch-serverless/api/indices/put_mapping.rb
132
130
  - lib/elasticsearch-serverless/api/indices/put_settings.rb
133
- - lib/elasticsearch-serverless/api/indices/put_template.rb
134
131
  - lib/elasticsearch-serverless/api/indices/refresh.rb
135
132
  - lib/elasticsearch-serverless/api/indices/resolve_index.rb
136
133
  - lib/elasticsearch-serverless/api/indices/rollover.rb
@@ -177,7 +174,6 @@ files:
177
174
  - lib/elasticsearch-serverless/api/machine_learning/get_overall_buckets.rb
178
175
  - lib/elasticsearch-serverless/api/machine_learning/get_trained_models.rb
179
176
  - lib/elasticsearch-serverless/api/machine_learning/get_trained_models_stats.rb
180
- - lib/elasticsearch-serverless/api/machine_learning/infer_trained_model.rb
181
177
  - lib/elasticsearch-serverless/api/machine_learning/open_job.rb
182
178
  - lib/elasticsearch-serverless/api/machine_learning/post_calendar_events.rb
183
179
  - lib/elasticsearch-serverless/api/machine_learning/preview_data_frame_analytics.rb
@@ -241,7 +237,6 @@ files:
241
237
  - lib/elasticsearch-serverless/api/security/has_privileges.rb
242
238
  - lib/elasticsearch-serverless/api/security/invalidate_api_key.rb
243
239
  - lib/elasticsearch-serverless/api/security/query_api_keys.rb
244
- - lib/elasticsearch-serverless/api/security/update_api_key.rb
245
240
  - lib/elasticsearch-serverless/api/sql/clear_cursor.rb
246
241
  - lib/elasticsearch-serverless/api/sql/delete_async.rb
247
242
  - lib/elasticsearch-serverless/api/sql/get_async.rb
@@ -255,7 +250,6 @@ files:
255
250
  - lib/elasticsearch-serverless/api/synonyms/get_synonyms_sets.rb
256
251
  - lib/elasticsearch-serverless/api/synonyms/put_synonym.rb
257
252
  - lib/elasticsearch-serverless/api/synonyms/put_synonym_rule.rb
258
- - lib/elasticsearch-serverless/api/tasks/get.rb
259
253
  - lib/elasticsearch-serverless/api/terms_enum.rb
260
254
  - lib/elasticsearch-serverless/api/termvectors.rb
261
255
  - lib/elasticsearch-serverless/api/transform/delete_transform.rb
@@ -276,7 +270,7 @@ homepage: https://rubygems.org/gems/elasticsearch-serverless
276
270
  licenses:
277
271
  - Apache-2.0
278
272
  metadata: {}
279
- post_install_message:
273
+ post_install_message:
280
274
  rdoc_options: []
281
275
  require_paths:
282
276
  - lib
@@ -291,8 +285,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
291
285
  - !ruby/object:Gem::Version
292
286
  version: '0'
293
287
  requirements: []
294
- rubygems_version: 3.5.11
295
- signing_key:
288
+ rubygems_version: 3.5.16
289
+ signing_key:
296
290
  specification_version: 4
297
291
  summary: Elasticsearch Serverless Client
298
292
  test_files: []
@@ -1,57 +0,0 @@
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 Esql
24
- module Actions
25
- # Executes an ES|QL request
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
- #
31
- # @option arguments [String] :format A short version of the Accept header, e.g. json, yaml.
32
- # @option arguments [String] :delimiter The character to use between values within a CSV row. Only valid for the CSV format.
33
- # @option arguments [Hash] :headers Custom HTTP headers
34
- # @option arguments [Hash] :body request body
35
- #
36
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-rest.html
37
- #
38
- def query(arguments = {})
39
- raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
40
-
41
- arguments = arguments.clone
42
- headers = arguments.delete(:headers) || {}
43
-
44
- body = arguments.delete(:body)
45
-
46
- method = ElasticsearchServerless::API::HTTP_POST
47
- path = "_query"
48
- params = Utils.process_params(arguments)
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
@@ -1,68 +0,0 @@
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 Indices
24
- module Actions
25
- # Get data stream stats.
26
- # Retrieves statistics for one or more data streams.
27
- #
28
- # @option arguments [String] :name Comma-separated list of data streams used to limit the request.
29
- # Wildcard expressions (+*+) are supported.
30
- # To target all data streams in a cluster, omit this parameter or use +*+.
31
- # @option arguments [String, Array<String>] :expand_wildcards Type of data stream that wildcard patterns can match.
32
- # Supports comma-separated values, such as +open,hidden+. Server default: open.
33
- # @option arguments [Hash] :headers Custom HTTP headers
34
- #
35
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html
36
- #
37
- def data_streams_stats(arguments = {})
38
- request_opts = { endpoint: arguments[:endpoint] || "indices.data_streams_stats" }
39
-
40
- defined_params = [:name].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
-
46
- arguments = arguments.clone
47
- headers = arguments.delete(:headers) || {}
48
-
49
- body = nil
50
-
51
- _name = arguments.delete(:name)
52
-
53
- method = ElasticsearchServerless::API::HTTP_GET
54
- path = if _name
55
- "_data_stream/#{Utils.listify(_name)}/_stats"
56
- else
57
- "_data_stream/_stats"
58
- end
59
- params = Utils.process_params(arguments)
60
-
61
- ElasticsearchServerless::API::Response.new(
62
- perform_request(method, path, params, body, headers, request_opts)
63
- )
64
- end
65
- end
66
- end
67
- end
68
- end
@@ -1,71 +0,0 @@
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 Indices
24
- module Actions
25
- # Create or update an index template.
26
- # Index templates define settings, mappings, and aliases that can be applied automatically to new indices.
27
- #
28
- # @option arguments [String] :name The name of the template (*Required*)
29
- # @option arguments [Boolean] :create If true, this request cannot replace or update existing index templates.
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 error. Server default: 30s.
32
- # @option arguments [Integer] :order Order in which Elasticsearch applies this template if index
33
- # matches multiple templates.Templates with lower 'order' values are merged first. Templates with higher
34
- # 'order' values are merged later, overriding templates with lower values.
35
- # @option arguments [String] :cause [TODO]
36
- # @option arguments [Hash] :headers Custom HTTP headers
37
- # @option arguments [Hash] :body request body
38
- #
39
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates-v1.html
40
- #
41
- def put_template(arguments = {})
42
- request_opts = { endpoint: arguments[:endpoint] || "indices.put_template" }
43
-
44
- defined_params = [:name].inject({}) do |set_variables, variable|
45
- set_variables[variable] = arguments[variable] if arguments.key?(variable)
46
- set_variables
47
- end
48
- request_opts[:defined_params] = defined_params unless defined_params.empty?
49
-
50
- raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
51
- raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
52
-
53
- arguments = arguments.clone
54
- headers = arguments.delete(:headers) || {}
55
-
56
- body = arguments.delete(:body)
57
-
58
- _name = arguments.delete(:name)
59
-
60
- method = ElasticsearchServerless::API::HTTP_PUT
61
- path = "_template/#{Utils.listify(_name)}"
62
- params = Utils.process_params(arguments)
63
-
64
- ElasticsearchServerless::API::Response.new(
65
- perform_request(method, path, params, body, headers, request_opts)
66
- )
67
- end
68
- end
69
- end
70
- end
71
- end
@@ -1,71 +0,0 @@
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
- # Evaluates a trained model.
26
- #
27
- # @option arguments [String] :model_id The unique identifier of the trained model. (*Required*)
28
- # @option arguments [Time] :timeout Controls the amount of time to wait for inference results. Server default: 10s.
29
- # @option arguments [Hash] :headers Custom HTTP headers
30
- # @option arguments [Hash] :body request body
31
- #
32
- # *Deprecation notice*:
33
- # /_ml/trained_models/{model_id}/deployment/_infer is deprecated. Use /_ml/trained_models/{model_id}/_infer instead
34
- # Deprecated since version 8.3.0
35
- #
36
- #
37
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/infer-trained-model.html
38
- #
39
- def infer_trained_model(arguments = {})
40
- request_opts = { endpoint: arguments[:endpoint] || "ml.infer_trained_model" }
41
-
42
- defined_params = [:model_id].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
-
48
- raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
49
- raise ArgumentError, "Required argument 'model_id' missing" unless arguments[:model_id]
50
-
51
- arguments = arguments.clone
52
- headers = arguments.delete(:headers) || {}
53
-
54
- body = arguments.delete(:body)
55
-
56
- _model_id = arguments.delete(:model_id)
57
-
58
- method = ElasticsearchServerless::API::HTTP_POST
59
- path = if _model_id
60
- "_ml/trained_models/#{Utils.listify(_model_id)}/deployment/_infer"
61
- end
62
- params = Utils.process_params(arguments)
63
-
64
- ElasticsearchServerless::API::Response.new(
65
- perform_request(method, path, params, body, headers, request_opts)
66
- )
67
- end
68
- end
69
- end
70
- end
71
- end
@@ -1,75 +0,0 @@
1
- # Licensed to Elasticsearch B.V. under one or more contributor
2
- # license agreements. See the NOTICE file distributed with
3
- # this work for additional information regarding copyright
4
- # ownership. Elasticsearch B.V. licenses this file to you under
5
- # the Apache License, Version 2.0 (the "License"); you may
6
- # not use this file except in compliance with the License.
7
- # You may obtain a copy of the License at
8
- #
9
- # http://www.apache.org/licenses/LICENSE-2.0
10
- #
11
- # Unless required by applicable law or agreed to in writing,
12
- # software distributed under the License is distributed on an
13
- # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
- # KIND, either express or implied. See the License for the
15
- # specific language governing permissions and limitations
16
- # under the License.
17
- #
18
- # Auto generated from commit f284cc16f4d4b4289bc679aa1529bb504190fe80
19
- # @see https://github.com/elastic/elasticsearch-specification
20
- #
21
- module ElasticsearchServerless
22
- module API
23
- module Security
24
- module Actions
25
- # Update an API key.
26
- # Updates attributes of an existing API key.
27
- # Users can only update API keys that they created or that were granted to them.
28
- # Use this API to update API keys created by the create API Key or grant API Key APIs.
29
- # If you need to apply the same update to many API keys, you can use bulk update API Keys to reduce overhead.
30
- # It’s not possible to update expired API keys, or API keys that have been invalidated by invalidate API Key.
31
- # This API supports updates to an API key’s access scope and metadata.
32
- # The access scope of an API key is derived from the +role_descriptors+ you specify in the request, and a snapshot of the owner user’s permissions at the time of the request.
33
- # The snapshot of the owner’s permissions is updated automatically on every call.
34
- # If you don’t specify +role_descriptors+ in the request, a call to this API might still change the API key’s access scope.
35
- # This change can occur if the owner user’s permissions have changed since the API key was created or last modified.
36
- # To update another user’s API key, use the +run_as+ feature to submit a request on behalf of another user.
37
- # IMPORTANT: It’s not possible to use an API key as the authentication credential for this API.
38
- # To update an API key, the owner user’s credentials are required.
39
- #
40
- # @option arguments [String] :id The ID of the API key to update. (*Required*)
41
- # @option arguments [Hash] :headers Custom HTTP headers
42
- # @option arguments [Hash] :body request body
43
- #
44
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-api-key.html
45
- #
46
- def update_api_key(arguments = {})
47
- request_opts = { endpoint: arguments[:endpoint] || "security.update_api_key" }
48
-
49
- defined_params = [:id].inject({}) do |set_variables, variable|
50
- set_variables[variable] = arguments[variable] if arguments.key?(variable)
51
- set_variables
52
- end
53
- request_opts[:defined_params] = defined_params unless defined_params.empty?
54
-
55
- raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
56
-
57
- arguments = arguments.clone
58
- headers = arguments.delete(:headers) || {}
59
-
60
- body = arguments.delete(:body)
61
-
62
- _id = arguments.delete(:id)
63
-
64
- method = ElasticsearchServerless::API::HTTP_PUT
65
- path = "_security/api_key/#{Utils.listify(_id)}"
66
- params = {}
67
-
68
- ElasticsearchServerless::API::Response.new(
69
- perform_request(method, path, params, body, headers, request_opts)
70
- )
71
- end
72
- end
73
- end
74
- end
75
- end
@@ -1,67 +0,0 @@
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 Tasks
24
- module Actions
25
- # Get task information.
26
- # Returns information about the tasks currently executing in the cluster.
27
- # This functionality is Experimental and may be changed or removed
28
- # completely in a future release. Elastic will take a best effort approach
29
- # to fix any issues, but experimental features are not subject to the
30
- # support SLA of official GA features.
31
- #
32
- # @option arguments [String] :task_id ID of the task. (*Required*)
33
- # @option arguments [Time] :timeout Period to wait for a response.
34
- # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
35
- # @option arguments [Boolean] :wait_for_completion If +true+, the request blocks until the task has completed.
36
- # @option arguments [Hash] :headers Custom HTTP headers
37
- #
38
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html
39
- #
40
- def get(arguments = {})
41
- request_opts = { endpoint: arguments[:endpoint] || "tasks.get" }
42
-
43
- defined_params = [:task_id].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
-
49
- arguments = arguments.clone
50
- headers = arguments.delete(:headers) || {}
51
-
52
- body = nil
53
-
54
- _task_id = arguments.delete(:task_id)
55
-
56
- method = ElasticsearchServerless::API::HTTP_GET
57
- path = "_tasks/#{Utils.listify(_task_id)}"
58
- params = Utils.process_params(arguments)
59
-
60
- ElasticsearchServerless::API::Response.new(
61
- perform_request(method, path, params, body, headers, request_opts)
62
- )
63
- end
64
- end
65
- end
66
- end
67
- end