elasticsearch-serverless 0.5.0 → 0.6.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (32) hide show
  1. checksums.yaml +4 -4
  2. data/lib/elasticsearch-serverless/api/async_search/status.rb +5 -3
  3. data/lib/elasticsearch-serverless/api/async_search/submit.rb +1 -3
  4. data/lib/elasticsearch-serverless/api/cat/aliases.rb +0 -4
  5. data/lib/elasticsearch-serverless/api/cat/component_templates.rb +4 -4
  6. data/lib/elasticsearch-serverless/api/cat/count.rb +0 -4
  7. data/lib/elasticsearch-serverless/api/cat/help.rb +0 -4
  8. data/lib/elasticsearch-serverless/api/cat/indices.rb +0 -4
  9. data/lib/elasticsearch-serverless/api/cat/ml_data_frame_analytics.rb +0 -4
  10. data/lib/elasticsearch-serverless/api/cat/ml_datafeeds.rb +0 -4
  11. data/lib/elasticsearch-serverless/api/cat/ml_jobs.rb +0 -4
  12. data/lib/elasticsearch-serverless/api/cat/ml_trained_models.rb +0 -4
  13. data/lib/elasticsearch-serverless/api/cat/transforms.rb +0 -4
  14. data/lib/elasticsearch-serverless/api/clear_scroll.rb +2 -1
  15. data/lib/elasticsearch-serverless/api/close_point_in_time.rb +5 -1
  16. data/lib/elasticsearch-serverless/api/field_caps.rb +5 -3
  17. data/lib/elasticsearch-serverless/api/indices/exists_alias.rb +0 -1
  18. data/lib/elasticsearch-serverless/api/indices/get_alias.rb +0 -1
  19. data/lib/elasticsearch-serverless/api/inference/delete.rb +0 -4
  20. data/lib/elasticsearch-serverless/api/inference/get.rb +0 -4
  21. data/lib/elasticsearch-serverless/api/inference/inference.rb +0 -4
  22. data/lib/elasticsearch-serverless/api/inference/put.rb +0 -4
  23. data/lib/elasticsearch-serverless/api/msearch_template.rb +1 -1
  24. data/lib/elasticsearch-serverless/api/open_point_in_time.rb +6 -1
  25. data/lib/elasticsearch-serverless/api/rank_eval.rb +2 -1
  26. data/lib/elasticsearch-serverless/api/render_search_template.rb +2 -1
  27. data/lib/elasticsearch-serverless/api/search.rb +2 -3
  28. data/lib/elasticsearch-serverless/api/search_mvt.rb +1 -1
  29. data/lib/elasticsearch-serverless/api/search_template.rb +1 -1
  30. data/lib/elasticsearch-serverless/api/termvectors.rb +1 -1
  31. data/lib/elasticsearch-serverless/version.rb +1 -1
  32. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: aedc93a8ab9cc3c28fe2fa52d0a4225e1e1a030c0ccd72dd1a29c003035bbdfc
4
- data.tar.gz: f7c1fd06c870c37792572d51168583accc36c03b11e9b0e49c198dc0c42a1071
3
+ metadata.gz: cdef5260655fb867303a0f21bff2a4e1cd1fbdbbdf34ce476572f41d698d5f48
4
+ data.tar.gz: d6eb14791d6586ea674f7c39d1aed581cc8042aee6d73f35ec48b9369aa2930b
5
5
  SHA512:
6
- metadata.gz: 55389aab59bfd1d8958156062c455b9c017d41f9e67f52bed901bf3f16c6b319b7655553caf8dd7b2d43a2756e15c7b72f85da6e56c79937252722ce2e143cf7
7
- data.tar.gz: e554159e81d7e519e9e18c600150a19d4df80dc3707fbdd6c417ba4389743b85d622b50bce66746ba5e9baa2fdc5994928c3402be5d3a8d3b90074e28a9640f7
6
+ metadata.gz: 5b1cc8e830d266068443087c17f610f3e6a16d3ef4ac23a937d32241166a0b04568f69ed55b0dda49478e78ca8beb10d78c9c893c34b2d0c0312008d3a555c37
7
+ data.tar.gz: 1ee71b1b19b311b011bc4c2a4361486303011c5e058e9bc7d3dcbbfcdb62f76d7e0f4a0a501ed6c7d2dc2bf4b091e3aec7189533e55116c970a90ab19399127c
@@ -22,11 +22,13 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module AsyncSearch
24
24
  module Actions
25
- # Get async search status.
26
- # Retrieve the status of a previously submitted async search request given its identifier, without retrieving search results.
25
+ # Get the async search status.
26
+ # Get 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*)
30
+ # @option arguments [Time] :keep_alive Specifies how long the async search needs to be available.
31
+ # Ongoing async searches and any saved search results are deleted after this period. Server default: 5d.
30
32
  # @option arguments [Hash] :headers Custom HTTP headers
31
33
  #
32
34
  # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html
@@ -51,7 +53,7 @@ module ElasticsearchServerless
51
53
 
52
54
  method = ElasticsearchServerless::API::HTTP_GET
53
55
  path = "_async_search/status/#{Utils.listify(_id)}"
54
- params = {}
56
+ params = Utils.process_params(arguments)
55
57
 
56
58
  ElasticsearchServerless::API::Response.new(
57
59
  perform_request(method, path, params, body, headers, request_opts)
@@ -50,12 +50,10 @@ module ElasticsearchServerless
50
50
  # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
51
51
  # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
52
52
  # @option arguments [Integer] :max_concurrent_shard_requests The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
53
- # @option arguments [String] :min_compatible_shard_node [TODO]
54
53
  # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
55
54
  # @option arguments [Integer] :pre_filter_shard_size The default value cannot be changed, which enforces the execution of a pre-filter roundtrip to retrieve statistics from each shard so that the ones that surely don’t hold any document matching the query get skipped. Server default: 1.
56
55
  # @option arguments [Boolean] :request_cache Specify if request cache should be used for this request or not, defaults to true Server default: true.
57
56
  # @option arguments [String] :routing A comma-separated list of specific routing values
58
- # @option arguments [Time] :scroll [TODO]
59
57
  # @option arguments [String] :search_type Search operation type
60
58
  # @option arguments [Array<String>] :stats Specific 'tag' of the request for logging and statistical purposes
61
59
  # @option arguments [String, Array<String>] :stored_fields A comma-separated list of stored fields to return as part of a hit
@@ -68,7 +66,7 @@ module ElasticsearchServerless
68
66
  # @option arguments [Boolean, Integer] :track_total_hits Indicate if the number of documents that match the query should be tracked. A number can also be specified, to accurately track the total hit count up to the number.
69
67
  # @option arguments [Boolean] :track_scores Whether to calculate and return scores even if they are not used for sorting
70
68
  # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
71
- # @option arguments [Boolean] :rest_total_hits_as_int [TODO]
69
+ # @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response
72
70
  # @option arguments [Boolean] :version Specify whether to return document version as part of a hit
73
71
  # @option arguments [Boolean, String, Array<String>] :_source True or false to return the _source field or not, or a list of fields to return
74
72
  # @option arguments [String, Array<String>] :_source_excludes A list of fields to exclude from the returned _source field
@@ -34,10 +34,6 @@ module ElasticsearchServerless
34
34
  # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
35
35
  # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
36
36
  # can't be combined with any other query string option.
37
- # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the
38
- # local cluster state. If +false+ the list of selected nodes are computed
39
- # from the cluster state of the master node. In both cases the coordinating
40
- # node will send requests for further information to each selected node.
41
37
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
42
38
  # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
43
39
  # Sorting defaults to ascending and can be changed by setting +:asc+
@@ -29,15 +29,15 @@ module ElasticsearchServerless
29
29
  # They are not intended for use by applications. For application consumption, use the get component template API.
30
30
  #
31
31
  # @option arguments [String] :name The name of the component template. Accepts wildcard expressions. If omitted, all component templates are returned.
32
+ # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the
33
+ # local cluster state. If +false+ the list of selected nodes are computed
34
+ # from the cluster state of the master node. In both cases the coordinating
35
+ # node will send requests for further information to each selected node.
32
36
  # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
33
37
  # +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
34
38
  # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
35
39
  # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
36
40
  # can't be combined with any other query string option.
37
- # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the
38
- # local cluster state. If +false+ the list of selected nodes are computed
39
- # from the cluster state of the master node. In both cases the coordinating
40
- # node will send requests for further information to each selected node.
41
41
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
42
42
  # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
43
43
  # Sorting defaults to ascending and can be changed by setting +:asc+
@@ -35,10 +35,6 @@ module ElasticsearchServerless
35
35
  # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
36
36
  # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
37
37
  # can't be combined with any other query string option.
38
- # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the
39
- # local cluster state. If +false+ the list of selected nodes are computed
40
- # from the cluster state of the master node. In both cases the coordinating
41
- # node will send requests for further information to each selected node.
42
38
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
43
39
  # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
44
40
  # Sorting defaults to ascending and can be changed by setting +:asc+
@@ -30,10 +30,6 @@ module ElasticsearchServerless
30
30
  # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
31
31
  # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
32
32
  # can't be combined with any other query string option.
33
- # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the
34
- # local cluster state. If +false+ the list of selected nodes are computed
35
- # from the cluster state of the master node. In both cases the coordinating
36
- # node will send requests for further information to each selected node.
37
33
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
38
34
  # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
39
35
  # Sorting defaults to ascending and can be changed by setting +:asc+
@@ -48,10 +48,6 @@ module ElasticsearchServerless
48
48
  # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
49
49
  # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
50
50
  # can't be combined with any other query string option.
51
- # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the
52
- # local cluster state. If +false+ the list of selected nodes are computed
53
- # from the cluster state of the master node. In both cases the coordinating
54
- # node will send requests for further information to each selected node.
55
51
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
56
52
  # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
57
53
  # Sorting defaults to ascending and can be changed by setting +:asc+
@@ -40,10 +40,6 @@ module ElasticsearchServerless
40
40
  # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
41
41
  # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
42
42
  # can't be combined with any other query string option.
43
- # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the
44
- # local cluster state. If +false+ the list of selected nodes are computed
45
- # from the cluster state of the master node. In both cases the coordinating
46
- # node will send requests for further information to each selected node.
47
43
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
48
44
  # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
49
45
  # Sorting defaults to ascending and can be changed by setting +:asc+
@@ -47,10 +47,6 @@ module ElasticsearchServerless
47
47
  # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
48
48
  # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
49
49
  # can't be combined with any other query string option.
50
- # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the
51
- # local cluster state. If +false+ the list of selected nodes are computed
52
- # from the cluster state of the master node. In both cases the coordinating
53
- # node will send requests for further information to each selected node.
54
50
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
55
51
  # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
56
52
  # Sorting defaults to ascending and can be changed by setting +:asc+
@@ -48,10 +48,6 @@ module ElasticsearchServerless
48
48
  # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
49
49
  # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
50
50
  # can't be combined with any other query string option.
51
- # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the
52
- # local cluster state. If +false+ the list of selected nodes are computed
53
- # from the cluster state of the master node. In both cases the coordinating
54
- # node will send requests for further information to each selected node.
55
51
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
56
52
  # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
57
53
  # Sorting defaults to ascending and can be changed by setting +:asc+
@@ -42,10 +42,6 @@ module ElasticsearchServerless
42
42
  # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
43
43
  # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
44
44
  # can't be combined with any other query string option.
45
- # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the
46
- # local cluster state. If +false+ the list of selected nodes are computed
47
- # from the cluster state of the master node. In both cases the coordinating
48
- # node will send requests for further information to each selected node.
49
45
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
50
46
  # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
51
47
  # Sorting defaults to ascending and can be changed by setting +:asc+
@@ -43,10 +43,6 @@ module ElasticsearchServerless
43
43
  # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
44
44
  # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
45
45
  # can't be combined with any other query string option.
46
- # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the
47
- # local cluster state. If +false+ the list of selected nodes are computed
48
- # from the cluster state of the master node. In both cases the coordinating
49
- # node will send requests for further information to each selected node.
50
46
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
51
47
  # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
52
48
  # Sorting defaults to ascending and can be changed by setting +:asc+
@@ -21,7 +21,8 @@
21
21
  module ElasticsearchServerless
22
22
  module API
23
23
  module Actions
24
- # Clears the search context and results for a scrolling search.
24
+ # Clear a scrolling search.
25
+ # Clear the search context and results for a scrolling search.
25
26
  #
26
27
  # @option arguments [String, Array] :scroll_id Comma-separated list of scroll IDs to clear.
27
28
  # To clear all scroll IDs, use +_all+.
@@ -21,7 +21,11 @@
21
21
  module ElasticsearchServerless
22
22
  module API
23
23
  module Actions
24
- # Closes a point-in-time.
24
+ # Close a point in time.
25
+ # A point in time must be opened explicitly before being used in search requests.
26
+ # The +keep_alive+ parameter tells Elasticsearch how long it should persist.
27
+ # A point in time is automatically closed when the +keep_alive+ period has elapsed.
28
+ # However, keeping points in time has a cost; close them as soon as they are no longer required for search requests.
25
29
  #
26
30
  # @option arguments [Hash] :headers Custom HTTP headers
27
31
  # @option arguments [Hash] :body request body
@@ -21,9 +21,11 @@
21
21
  module ElasticsearchServerless
22
22
  module API
23
23
  module Actions
24
- # The field capabilities API returns the information about the capabilities of fields among multiple indices.
25
- # The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type
26
- # of keyword is returned as any other field that belongs to the +keyword+ family.
24
+ # Get the field capabilities.
25
+ # Get information about the capabilities of fields among multiple indices.
26
+ # For data streams, the API returns field capabilities among the stream’s backing indices.
27
+ # It returns runtime fields like any other field.
28
+ # For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the +keyword+ family.
27
29
  #
28
30
  # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.
29
31
  # @option arguments [Boolean] :allow_no_indices If false, the request returns an error if any wildcard expression, index alias,
@@ -35,7 +35,6 @@ module ElasticsearchServerless
35
35
  # Supports comma-separated values, such as +open,hidden+.
36
36
  # Valid values are: +all+, +open+, +closed+, +hidden+, +none+. Server default: open.
37
37
  # @option arguments [Boolean] :ignore_unavailable If +false+, requests that include a missing data stream or index in the target indices or data streams return an error.
38
- # @option arguments [Boolean] :local If +true+, the request retrieves information from the local node only.
39
38
  # @option arguments [Hash] :headers Custom HTTP headers
40
39
  #
41
40
  # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html
@@ -38,7 +38,6 @@ module ElasticsearchServerless
38
38
  # Supports comma-separated values, such as +open,hidden+.
39
39
  # Valid values are: +all+, +open+, +closed+, +hidden+, +none+. Server default: open.
40
40
  # @option arguments [Boolean] :ignore_unavailable If +false+, the request returns an error if it targets a missing or closed index.
41
- # @option arguments [Boolean] :local If +true+, the request retrieves information from the local node only.
42
41
  # @option arguments [Hash] :headers Custom HTTP headers
43
42
  #
44
43
  # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html
@@ -23,10 +23,6 @@ module ElasticsearchServerless
23
23
  module Inference
24
24
  module Actions
25
25
  # Delete an inference endpoint
26
- # This functionality is Experimental and may be changed or removed
27
- # completely in a future release. Elastic will take a best effort approach
28
- # to fix any issues, but experimental features are not subject to the
29
- # support SLA of official GA features.
30
26
  #
31
27
  # @option arguments [String] :task_type The task type
32
28
  # @option arguments [String] :inference_id The inference Id (*Required*)
@@ -23,10 +23,6 @@ module ElasticsearchServerless
23
23
  module Inference
24
24
  module Actions
25
25
  # Get an inference endpoint
26
- # This functionality is Experimental and may be changed or removed
27
- # completely in a future release. Elastic will take a best effort approach
28
- # to fix any issues, but experimental features are not subject to the
29
- # support SLA of official GA features.
30
26
  #
31
27
  # @option arguments [String] :task_type The task type
32
28
  # @option arguments [String] :inference_id The inference Id
@@ -23,10 +23,6 @@ module ElasticsearchServerless
23
23
  module Inference
24
24
  module Actions
25
25
  # Perform inference on the service
26
- # This functionality is Experimental and may be changed or removed
27
- # completely in a future release. Elastic will take a best effort approach
28
- # to fix any issues, but experimental features are not subject to the
29
- # support SLA of official GA features.
30
26
  #
31
27
  # @option arguments [String] :task_type The task type
32
28
  # @option arguments [String] :inference_id The inference Id (*Required*)
@@ -23,10 +23,6 @@ module ElasticsearchServerless
23
23
  module Inference
24
24
  module Actions
25
25
  # Create an inference endpoint
26
- # This functionality is Experimental and may be changed or removed
27
- # completely in a future release. Elastic will take a best effort approach
28
- # to fix any issues, but experimental features are not subject to the
29
- # support SLA of official GA features.
30
26
  #
31
27
  # @option arguments [String] :task_type The task type
32
28
  # @option arguments [String] :inference_id The inference Id (*Required*)
@@ -21,7 +21,7 @@
21
21
  module ElasticsearchServerless
22
22
  module API
23
23
  module Actions
24
- # Runs multiple templated searches with a single request.
24
+ # Run multiple templated searches.
25
25
  #
26
26
  # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases to search.
27
27
  # Supports wildcards (+*+).
@@ -21,12 +21,15 @@
21
21
  module ElasticsearchServerless
22
22
  module API
23
23
  module Actions
24
- # A search request by default executes against the most recent visible data of the target indices,
24
+ # Open a point in time.
25
+ # A search request by default runs against the most recent visible data of the target indices,
25
26
  # which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the
26
27
  # state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple
27
28
  # search requests using the same point in time. For example, if refreshes happen between
28
29
  # +search_after+ requests, then the results of those requests might not be consistent as changes happening
29
30
  # between searches are only visible to the more recent point in time.
31
+ # A point in time must be opened explicitly before being used in search requests.
32
+ # The +keep_alive+ parameter tells Elasticsearch how long it should persist.
30
33
  #
31
34
  # @option arguments [String, Array] :index A comma-separated list of index names to open point in time; use +_all+ or empty string to perform the operation on all indices (*Required*)
32
35
  # @option arguments [Time] :keep_alive Extends the time to live of the corresponding point in time. (*Required*)
@@ -37,6 +40,8 @@ module ElasticsearchServerless
37
40
  # @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match.
38
41
  # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
39
42
  # Supports comma-separated values, such as +open,hidden+. Valid values are: +all+, +open+, +closed+, +hidden+, +none+. Server default: open.
43
+ # @option arguments [Boolean] :allow_partial_search_results If +false+, creating a point in time request when a shard is missing or unavailable will throw an exception.
44
+ # If +true+, the point in time will contain all the shards that are available at the time of the request.
40
45
  # @option arguments [Hash] :headers Custom HTTP headers
41
46
  # @option arguments [Hash] :body request body
42
47
  #
@@ -21,7 +21,8 @@
21
21
  module ElasticsearchServerless
22
22
  module API
23
23
  module Actions
24
- # Enables you to evaluate the quality of ranked search results over a set of typical search queries.
24
+ # Evaluate ranked search results.
25
+ # Evaluate the quality of ranked search results over a set of typical search queries.
25
26
  #
26
27
  # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard (+*+) expressions are supported.
27
28
  # To target all data streams and indices in a cluster, omit this parameter or use +_all+ or +*+.
@@ -21,7 +21,8 @@
21
21
  module ElasticsearchServerless
22
22
  module API
23
23
  module Actions
24
- # Renders a search template as a search request body.
24
+ # Render a search template.
25
+ # Render a search template as a search request body.
25
26
  #
26
27
  # @option arguments [String] :id ID of the search template to render.
27
28
  # If no +source+ is specified, this or the +id+ request body parameter is required.
@@ -21,7 +21,8 @@
21
21
  module ElasticsearchServerless
22
22
  module API
23
23
  module Actions
24
- # Returns search hits that match the query defined in the request.
24
+ # Run a search.
25
+ # Get search hits that match the query defined in the request.
25
26
  # You can provide search queries using the +q+ query string parameter or the request body.
26
27
  # If both are specified, only the query parameter is used.
27
28
  #
@@ -60,8 +61,6 @@ module ElasticsearchServerless
60
61
  # This parameter can only be used when the +q+ query string parameter is specified.
61
62
  # @option arguments [Integer] :max_concurrent_shard_requests Defines the number of concurrent shard requests per node this search executes concurrently.
62
63
  # This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests. Server default: 5.
63
- # @option arguments [String] :min_compatible_shard_node The minimum version of the node that can handle the request
64
- # Any handling node with a lower version will fail the request.
65
64
  # @option arguments [String] :preference Nodes and shards used for the search.
66
65
  # By default, Elasticsearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness. Valid values are:
67
66
  # +_only_local+ to run the search only on shards on the local node;
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Actions
24
24
  # Search a vector tile.
25
- # Searches a vector tile for geospatial values.
25
+ # Search a vector tile for geospatial values.
26
26
  #
27
27
  # @option arguments [String, Array] :index Comma-separated list of data streams, indices, or aliases to search (*Required*)
28
28
  # @option arguments [String] :field Field containing geospatial data to return (*Required*)
@@ -21,7 +21,7 @@
21
21
  module ElasticsearchServerless
22
22
  module API
23
23
  module Actions
24
- # Runs a search with a search template.
24
+ # Run a search with a search template.
25
25
  #
26
26
  # @option arguments [String, Array] :index Comma-separated list of data streams, indices,
27
27
  # and aliases to search. Supports wildcards (*).
@@ -22,7 +22,7 @@ module ElasticsearchServerless
22
22
  module API
23
23
  module Actions
24
24
  # Get term vector information.
25
- # Returns information and statistics about terms in the fields of a particular document.
25
+ # Get information and statistics about terms in the fields of a particular document.
26
26
  #
27
27
  # @option arguments [String] :index Name of the index that contains the document. (*Required*)
28
28
  # @option arguments [String] :id Unique identifier of the document.
@@ -17,6 +17,6 @@
17
17
 
18
18
  module ElasticsearchServerless
19
19
  API_VERSION = '2023-10-31'.freeze
20
- CLIENT_VERSION = '0.5.0'.freeze
20
+ CLIENT_VERSION = '0.6.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.5.0
4
+ version: 0.6.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Fernando Briano
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-11-05 00:00:00.000000000 Z
11
+ date: 2024-12-03 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: elastic-transport