elasticsearch-api 9.2.0 → 9.2.1

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 (134) hide show
  1. checksums.yaml +4 -4
  2. data/lib/elasticsearch/api/actions/async_search/submit.rb +12 -9
  3. data/lib/elasticsearch/api/actions/bulk.rb +1 -0
  4. data/lib/elasticsearch/api/actions/cat/aliases.rb +1 -1
  5. data/lib/elasticsearch/api/actions/cat/indices.rb +3 -1
  6. data/lib/elasticsearch/api/actions/cat/segments.rb +10 -0
  7. data/lib/elasticsearch/api/actions/cat/tasks.rb +3 -4
  8. data/lib/elasticsearch/api/actions/cluster/get_component_template.rb +2 -3
  9. data/lib/elasticsearch/api/actions/cluster/health.rb +25 -12
  10. data/lib/elasticsearch/api/actions/cluster/put_settings.rb +3 -3
  11. data/lib/elasticsearch/api/actions/cluster/state.rb +6 -5
  12. data/lib/elasticsearch/api/actions/connector/check_in.rb +3 -4
  13. data/lib/elasticsearch/api/actions/connector/sync_job_check_in.rb +3 -4
  14. data/lib/elasticsearch/api/actions/connector/sync_job_claim.rb +3 -5
  15. data/lib/elasticsearch/api/actions/connector/sync_job_error.rb +3 -5
  16. data/lib/elasticsearch/api/actions/connector/sync_job_update_stats.rb +3 -5
  17. data/lib/elasticsearch/api/actions/connector/update_active_filtering.rb +3 -4
  18. data/lib/elasticsearch/api/actions/connector/update_error.rb +3 -4
  19. data/lib/elasticsearch/api/actions/connector/update_features.rb +3 -4
  20. data/lib/elasticsearch/api/actions/connector/update_filtering_validation.rb +3 -4
  21. data/lib/elasticsearch/api/actions/connector/update_status.rb +3 -4
  22. data/lib/elasticsearch/api/actions/cross_cluster_replication/forget_follower.rb +1 -1
  23. data/lib/elasticsearch/api/actions/cross_cluster_replication/resume_follow.rb +1 -1
  24. data/lib/elasticsearch/api/actions/dangling_indices/delete_dangling_index.rb +3 -3
  25. data/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb +3 -3
  26. data/lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb +1 -1
  27. data/lib/elasticsearch/api/actions/eql/search.rb +3 -2
  28. data/lib/elasticsearch/api/actions/esql/get_query.rb +3 -4
  29. data/lib/elasticsearch/api/actions/esql/list_queries.rb +3 -4
  30. data/lib/elasticsearch/api/actions/features/reset_features.rb +3 -4
  31. data/lib/elasticsearch/api/actions/fleet/msearch.rb +3 -4
  32. data/lib/elasticsearch/api/actions/fleet/search.rb +3 -4
  33. data/lib/elasticsearch/api/actions/index.rb +3 -0
  34. data/lib/elasticsearch/api/actions/indices/cancel_migrate_reindex.rb +0 -4
  35. data/lib/elasticsearch/api/actions/indices/create_from.rb +0 -4
  36. data/lib/elasticsearch/api/actions/indices/data_streams_stats.rb +1 -1
  37. data/lib/elasticsearch/api/actions/indices/delete.rb +1 -1
  38. data/lib/elasticsearch/api/actions/indices/delete_data_lifecycle.rb +5 -4
  39. data/lib/elasticsearch/api/actions/indices/delete_data_stream_options.rb +5 -4
  40. data/lib/elasticsearch/api/actions/indices/disk_usage.rb +3 -4
  41. data/lib/elasticsearch/api/actions/indices/downsample.rb +3 -4
  42. data/lib/elasticsearch/api/actions/indices/exists_alias.rb +1 -1
  43. data/lib/elasticsearch/api/actions/indices/explain_data_lifecycle.rb +3 -3
  44. data/lib/elasticsearch/api/actions/indices/field_usage_stats.rb +4 -5
  45. data/lib/elasticsearch/api/actions/indices/forcemerge.rb +5 -4
  46. data/lib/elasticsearch/api/actions/indices/get_alias.rb +1 -1
  47. data/lib/elasticsearch/api/actions/indices/get_index_template.rb +1 -1
  48. data/lib/elasticsearch/api/actions/indices/get_migrate_reindex_status.rb +0 -4
  49. data/lib/elasticsearch/api/actions/indices/migrate_reindex.rb +0 -4
  50. data/lib/elasticsearch/api/actions/indices/open.rb +1 -1
  51. data/lib/elasticsearch/api/actions/indices/promote_data_stream.rb +1 -1
  52. data/lib/elasticsearch/api/actions/indices/put_index_template.rb +1 -1
  53. data/lib/elasticsearch/api/actions/indices/put_mapping.rb +2 -1
  54. data/lib/elasticsearch/api/actions/indices/put_template.rb +1 -1
  55. data/lib/elasticsearch/api/actions/indices/reload_search_analyzers.rb +3 -2
  56. data/lib/elasticsearch/api/actions/indices/shrink.rb +1 -0
  57. data/lib/elasticsearch/api/actions/indices/stats.rb +2 -2
  58. data/lib/elasticsearch/api/actions/inference/chat_completion_unified.rb +3 -3
  59. data/lib/elasticsearch/api/actions/inference/completion.rb +5 -1
  60. data/lib/elasticsearch/api/actions/inference/delete.rb +3 -2
  61. data/lib/elasticsearch/api/actions/inference/get.rb +7 -3
  62. data/lib/elasticsearch/api/actions/inference/put.rb +1 -1
  63. data/lib/elasticsearch/api/actions/inference/put_alibabacloud.rb +0 -1
  64. data/lib/elasticsearch/api/actions/inference/put_amazonbedrock.rb +0 -1
  65. data/lib/elasticsearch/api/actions/inference/put_amazonsagemaker.rb +0 -1
  66. data/lib/elasticsearch/api/actions/inference/put_anthropic.rb +0 -1
  67. data/lib/elasticsearch/api/actions/inference/put_azureaistudio.rb +0 -1
  68. data/lib/elasticsearch/api/actions/inference/put_azureopenai.rb +0 -1
  69. data/lib/elasticsearch/api/actions/inference/put_cohere.rb +0 -1
  70. data/lib/elasticsearch/api/actions/inference/put_contextualai.rb +0 -1
  71. data/lib/elasticsearch/api/actions/inference/put_custom.rb +0 -1
  72. data/lib/elasticsearch/api/actions/inference/put_deepseek.rb +0 -1
  73. data/lib/elasticsearch/api/actions/inference/put_elasticsearch.rb +0 -1
  74. data/lib/elasticsearch/api/actions/inference/put_googleaistudio.rb +0 -1
  75. data/lib/elasticsearch/api/actions/inference/put_googlevertexai.rb +0 -1
  76. data/lib/elasticsearch/api/actions/inference/put_hugging_face.rb +0 -1
  77. data/lib/elasticsearch/api/actions/inference/put_jinaai.rb +0 -1
  78. data/lib/elasticsearch/api/actions/inference/put_mistral.rb +0 -1
  79. data/lib/elasticsearch/api/actions/inference/put_openai.rb +0 -1
  80. data/lib/elasticsearch/api/actions/inference/put_voyageai.rb +0 -1
  81. data/lib/elasticsearch/api/actions/inference/put_watsonx.rb +0 -1
  82. data/lib/elasticsearch/api/actions/inference/rerank.rb +1 -1
  83. data/lib/elasticsearch/api/actions/inference/sparse_embedding.rb +1 -1
  84. data/lib/elasticsearch/api/actions/inference/stream_completion.rb +1 -1
  85. data/lib/elasticsearch/api/actions/inference/text_embedding.rb +1 -1
  86. data/lib/elasticsearch/api/actions/ingest/get_pipeline.rb +1 -1
  87. data/lib/elasticsearch/api/actions/license/post_start_basic.rb +1 -1
  88. data/lib/elasticsearch/api/actions/license/post_start_trial.rb +2 -2
  89. data/lib/elasticsearch/api/actions/machine_learning/start_data_frame_analytics.rb +2 -1
  90. data/lib/elasticsearch/api/actions/machine_learning/start_trained_model_deployment.rb +1 -1
  91. data/lib/elasticsearch/api/actions/machine_learning/stop_data_frame_analytics.rb +2 -1
  92. data/lib/elasticsearch/api/actions/machine_learning/stop_trained_model_deployment.rb +2 -1
  93. data/lib/elasticsearch/api/actions/migration/deprecations.rb +6 -3
  94. data/lib/elasticsearch/api/actions/msearch.rb +1 -1
  95. data/lib/elasticsearch/api/actions/nodes/clear_repositories_metering_archive.rb +3 -5
  96. data/lib/elasticsearch/api/actions/nodes/get_repositories_metering_info.rb +3 -4
  97. data/lib/elasticsearch/api/actions/nodes/hot_threads.rb +1 -1
  98. data/lib/elasticsearch/api/actions/nodes/stats.rb +1 -1
  99. data/lib/elasticsearch/api/actions/nodes/usage.rb +2 -1
  100. data/lib/elasticsearch/api/actions/project/tags.rb +9 -6
  101. data/lib/elasticsearch/api/actions/rank_eval.rb +1 -1
  102. data/lib/elasticsearch/api/actions/reindex_rethrottle.rb +1 -1
  103. data/lib/elasticsearch/api/actions/scripts_painless_execute.rb +3 -4
  104. data/lib/elasticsearch/api/actions/search_application/delete_behavioral_analytics.rb +3 -4
  105. data/lib/elasticsearch/api/actions/search_application/get_behavioral_analytics.rb +3 -4
  106. data/lib/elasticsearch/api/actions/search_application/post_behavioral_analytics_event.rb +3 -4
  107. data/lib/elasticsearch/api/actions/search_application/put_behavioral_analytics.rb +3 -4
  108. data/lib/elasticsearch/api/actions/search_application/render_query.rb +3 -4
  109. data/lib/elasticsearch/api/actions/search_mvt.rb +12 -5
  110. data/lib/elasticsearch/api/actions/search_template.rb +2 -2
  111. data/lib/elasticsearch/api/actions/searchable_snapshots/cache_stats.rb +3 -5
  112. data/lib/elasticsearch/api/actions/searchable_snapshots/clear_cache.rb +6 -6
  113. data/lib/elasticsearch/api/actions/security/create_service_token.rb +1 -1
  114. data/lib/elasticsearch/api/actions/security/delete_service_token.rb +1 -1
  115. data/lib/elasticsearch/api/actions/simulate/ingest.rb +3 -4
  116. data/lib/elasticsearch/api/actions/snapshot/get.rb +1 -1
  117. data/lib/elasticsearch/api/actions/snapshot/repository_verify_integrity.rb +3 -4
  118. data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_lifecycle.rb +1 -1
  119. data/lib/elasticsearch/api/actions/streams/logs_disable.rb +6 -4
  120. data/lib/elasticsearch/api/actions/streams/logs_enable.rb +6 -4
  121. data/lib/elasticsearch/api/actions/streams/status.rb +6 -4
  122. data/lib/elasticsearch/api/actions/synonyms/put_synonym.rb +0 -1
  123. data/lib/elasticsearch/api/actions/tasks/cancel.rb +3 -4
  124. data/lib/elasticsearch/api/actions/tasks/get.rb +3 -4
  125. data/lib/elasticsearch/api/actions/tasks/list.rb +3 -4
  126. data/lib/elasticsearch/api/actions/transform/get_node_stats.rb +15 -3
  127. data/lib/elasticsearch/api/actions/transform/get_transform_stats.rb +1 -1
  128. data/lib/elasticsearch/api/actions/update_by_query.rb +2 -2
  129. data/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb +1 -1
  130. data/lib/elasticsearch/api/actions/watcher/put_watch.rb +2 -2
  131. data/lib/elasticsearch/api/actions/xpack/info.rb +1 -1
  132. data/lib/elasticsearch/api/version.rb +2 -2
  133. data/lib/elasticsearch/api.rb +1 -0
  134. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6e2038b3f672cc606ab10912496c8ca767b970532ab39f0200631f248ffb5ded
4
- data.tar.gz: 29f3e2870f65ad58c5f1a5bd2bd5d17c85ddc6da65fc9843bc2d8f27a1225378
3
+ metadata.gz: 6d8a67d5fa8414a8e09624ea2d41332567167610104a71e90d98ef526a9f5c43
4
+ data.tar.gz: 8cf41f2ea31c275b6f53e3250a0b5cd4ebff0b35e28b205cdd5d31feb8c9744f
5
5
  SHA512:
6
- metadata.gz: a9679ac647fc9165740fc38d71decdc4b11a61c2b17f5aabe3bee3ccd008f4f55ed72534f3784018dea55b22cbf2cddb084c0d34c6e3601a0fff5228a3f40ccd
7
- data.tar.gz: 741518f968028106d28fe6bcb2cc320dbc6e2b147b244520eed4d737adf69fe8f3ae4bea34d5746bf65a38d813e7451c630c5a028b6ec90ae5a3fc1992850a85
6
+ metadata.gz: 17a9ce971775e193083d266768731a0ace9ebdc04656847dbf00d6c3f4d6ad0980619314dfd0cb3ecebb1a29ef6eebb3e744add150e88c3f92d714301fe5e805
7
+ data.tar.gz: 6b5afa5dbf3deba0364541e23675682a0ffe6b22e07c7c3c7559926c7a2987b7fb724d15a8dbedccc5affe2d7fad6861ae5f3e6c13d062232ed9a437074b96e9
@@ -34,23 +34,25 @@ module Elasticsearch
34
34
  # @option arguments [Time] :keep_alive Specifies how long the async search needs to be available.
35
35
  # Ongoing async searches and any saved search results are deleted after this period. Server default: 5d.
36
36
  # @option arguments [Boolean] :keep_on_completion If `true`, results are stored for later retrieval when the search completes within the `wait_for_completion_timeout`.
37
- # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
37
+ # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices.
38
+ # (This includes `_all` string or when no indices have been specified)
38
39
  # @option arguments [Boolean] :allow_partial_search_results Indicate if an error should be returned if there is a partial search failure or timeout Server default: true.
39
40
  # @option arguments [String] :analyzer The analyzer to use for the query string
40
- # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false)
41
+ # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed
41
42
  # @option arguments [Integer] :batched_reduce_size Affects how often partial results become available, which happens whenever shard results are reduced.
42
43
  # A partial reduction is performed every time the coordinating node has received a certain number of new shard responses (5 by default). Server default: 5.
43
44
  # @option arguments [Boolean] :ccs_minimize_roundtrips The default value is the only supported value.
44
45
  # @option arguments [String] :default_operator The default operator for query string query (AND or OR) Server default: or.
45
46
  # @option arguments [String] :df The field to use as default where no field prefix is given in the query string
46
47
  # @option arguments [String, Array<String>] :docvalue_fields A comma-separated list of fields to return as the docvalue representation of a field for each hit
47
- # @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
48
+ # @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both Server default: open.
48
49
  # @option arguments [Boolean] :explain Specify whether to return detailed information about score computation as part of a hit
49
50
  # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled
50
51
  # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
51
52
  # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
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 Server default: 5.
53
- # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
53
+ # @option arguments [Integer] :max_concurrent_shard_requests The number of concurrent shard requests per node this search executes concurrently.
54
+ # 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.
55
+ # @option arguments [String] :preference Specify the node or shard the operation should be performed on Server default: random.
54
56
  # @option arguments [String] :project_routing Specifies a subset of projects to target for the search using project
55
57
  # metadata tags in a subset of Lucene query syntax.
56
58
  # Allowed Lucene queries: the _alias tag and a single value (possibly wildcarded).
@@ -68,9 +70,10 @@ module Elasticsearch
68
70
  # @option arguments [String] :suggest_mode Specify suggest mode Server default: missing.
69
71
  # @option arguments [Integer] :suggest_size How many suggestions to return in response
70
72
  # @option arguments [String] :suggest_text The source text for which the suggestions should be returned.
71
- # @option arguments [Integer] :terminate_after The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
73
+ # @option arguments [Integer] :terminate_after The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early
72
74
  # @option arguments [Time] :timeout Explicit operation timeout
73
- # @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.
75
+ # @option arguments [Boolean, Integer] :track_total_hits Indicate if the number of documents that match the query should be tracked.
76
+ # A number can also be specified, to accurately track the total hit count up to the number.
74
77
  # @option arguments [Boolean] :track_scores Whether to calculate and return scores even if they are not used for sorting
75
78
  # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
76
79
  # @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
@@ -80,8 +83,8 @@ module Elasticsearch
80
83
  # @option arguments [String, Array<String>] :_source_includes A list of fields to extract and return from the _source field
81
84
  # @option arguments [Boolean] :seq_no_primary_term Specify whether to return sequence number and primary term of the last modification of each hit
82
85
  # @option arguments [String] :q Query in the Lucene query string syntax
83
- # @option arguments [Integer] :size Number of hits to return (default: 10)
84
- # @option arguments [Integer] :from Starting offset (default: 0)
86
+ # @option arguments [Integer] :size Number of hits to return Server default: 10.
87
+ # @option arguments [Integer] :from Starting offset Server default: 0.
85
88
  # @option arguments [String, Array<String>] :sort A comma-separated list of <field>:<direction> pairs
86
89
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
87
90
  # when they occur.
@@ -76,6 +76,7 @@ module Elasticsearch
76
76
  # * Perl: Check out `Search::Elasticsearch::Client::5_0::Bulk` and `Search::Elasticsearch::Client::5_0::Scroll`
77
77
  # * Python: Check out `elasticsearch.helpers.*`
78
78
  # * JavaScript: Check out `client.helpers.*`
79
+ # * Java: Check out `co.elastic.clients.elasticsearch._helpers.bulk.BulkIngester`
79
80
  # * .NET: Check out `BulkAllObservable`
80
81
  # * PHP: Check out bulk indexing.
81
82
  # * Ruby: Check out `Elasticsearch::Helpers::BulkHelper`
@@ -34,7 +34,7 @@ module Elasticsearch
34
34
  # or `:desc` as a suffix to the column name.
35
35
  # @option arguments [String, Array<String>] :expand_wildcards The type of index that wildcard patterns can match.
36
36
  # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
37
- # It supports comma-separated values, such as `open,hidden`.
37
+ # It supports comma-separated values, such as `open,hidden`. Server default: all.
38
38
  # @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
39
39
  # If the master node is not available before the timeout expires, the request fails and returns an error.
40
40
  # To indicated that the request should never timeout, you can set it to `-1`. Server default: 30s.
@@ -32,12 +32,14 @@ module Elasticsearch
32
32
  # - total store size of all shards, including shard replicas
33
33
  # These metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents.
34
34
  # To get an accurate count of Elasticsearch documents, use the cat count or count APIs.
35
+ # NOTE: Storage metrics reported by this API reflect the post-compression size of the indices on disk. Because these values are calculated after Elasticsearch compresses the data and processes deletions, they are typically significantly smaller than the raw, uncompressed data volume ingested.
36
+ # IMPORTANT: For Elastic Cloud Serverless, ingest billing is based on the raw, uncompressed data volume, not the post-compression metrics reported here. To learn more, refer to {https://www.elastic.co/docs/deploy-manage/cloud-organization/billing/elasticsearch-billing-dimensions Elasticsearch billing dimensions}.
35
37
  # CAT APIs are only intended for human consumption using the command line or Kibana console.
36
38
  # They are not intended for use by applications. For application consumption, use an index endpoint.
37
39
  #
38
40
  # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases used to limit the request.
39
41
  # Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.
40
- # @option arguments [String, Array<String>] :expand_wildcards The type of index that wildcard patterns can match.
42
+ # @option arguments [String, Array<String>] :expand_wildcards The type of index that wildcard patterns can match. Server default: all.
41
43
  # @option arguments [String] :health The health status used to limit returned indices. By default, the response includes indices of any health status.
42
44
  # @option arguments [Boolean] :include_unloaded_segments If true, the response includes information from segments that are not loaded into memory.
43
45
  # @option arguments [Boolean] :pri If true, the response only includes information from primary shards.
@@ -40,6 +40,16 @@ module Elasticsearch
40
40
  # from the cluster state of the master node. In both cases the coordinating
41
41
  # node will send requests for further information to each selected node.
42
42
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
43
+ # @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard expressions can match. If the request can target data streams, this argument
44
+ # determines whether wildcard expressions match hidden data streams. Supports comma-separated values,
45
+ # such as open,hidden. Server default: open.
46
+ # @option arguments [Boolean] :allow_no_indices If false, the request returns an error if any wildcard expression, index alias, or _all value targets only
47
+ # missing or closed indices. This behavior applies even if the request targets other open indices. For example,
48
+ # a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. Server default: true.
49
+ # @option arguments [Boolean] :ignore_throttled If true, concrete, expanded or aliased indices are ignored when frozen.
50
+ # @option arguments [Boolean] :ignore_unavailable If true, missing or closed indices are not included in the response.
51
+ # @option arguments [Boolean] :allow_closed If true, allow closed indices to be returned in the response otherwise if false, keep the legacy behaviour
52
+ # of throwing an exception if index pattern matches closed indices
43
53
  # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
44
54
  # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
45
55
  # @option arguments [Boolean] :help When set to `true` will output available columns. This option
@@ -25,10 +25,9 @@ module Elasticsearch
25
25
  # Get task information.
26
26
  # Get information about tasks currently running in the cluster.
27
27
  # IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API.
28
- # This functionality is Experimental and may be changed or removed
29
- # completely in a future release. Elastic will take a best effort approach
30
- # to fix any issues, but experimental features are not subject to the
31
- # support SLA of official GA features.
28
+ # This functionality is in technical preview and may be changed or removed in a future
29
+ # release. Elastic will apply best effort to fix any issues, but features in technical
30
+ # preview are not subject to the support SLA of official GA features.
32
31
  #
33
32
  # @option arguments [Array<String>] :actions The task action names, which are used to limit the response.
34
33
  # @option arguments [Boolean] :detailed If `true`, the response includes detailed information about shard recoveries.
@@ -25,11 +25,10 @@ module Elasticsearch
25
25
  # Get component templates.
26
26
  # Get information about component templates.
27
27
  #
28
- # @option arguments [String] :name Comma-separated list of component template names used to limit the request.
29
- # Wildcard (`*`) expressions are supported.
28
+ # @option arguments [String] :name Name of component template to retrieve. Wildcard (`*`) expressions are supported.
30
29
  # @option arguments [Boolean] :flat_settings If `true`, returns settings in flat format.
31
30
  # @option arguments [String, Array<String>] :settings_filter Filter out results, for example to filter out sensitive information. Supports wildcards or full settings keys
32
- # @option arguments [Boolean] :include_defaults Return all default configurations for the component template (default: false)
31
+ # @option arguments [Boolean] :include_defaults Return all default configurations for the component template
33
32
  # @option arguments [Boolean] :local If `true`, the request retrieves information from the local node only.
34
33
  # If `false`, information is retrieved from the master node.
35
34
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node.
@@ -31,18 +31,31 @@ module Elasticsearch
31
31
  # One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level.
32
32
  # The cluster status is controlled by the worst index status.
33
33
  #
34
- # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (`*`) are supported. To target all data streams and indices in a cluster, omit this parameter or use _all or `*`.
35
- # @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
36
- # @option arguments [String] :level Can be one of cluster, indices or shards. Controls the details level of the health information returned. Server default: cluster.
37
- # @option arguments [Boolean] :local If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.
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.
40
- # @option arguments [Integer, String] :wait_for_active_shards A number controlling to how many active shards to wait for, all to wait for all shards in the cluster to be active, or 0 to not wait. Server default: 0.
41
- # @option arguments [String] :wait_for_events Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with the given priority are processed.
42
- # @option arguments [String, Integer] :wait_for_nodes The request waits until the specified number N of nodes is available. It also accepts >=N, <=N, >N and <N. Alternatively, it is possible to use ge(N), le(N), gt(N) and lt(N) notation.
43
- # @option arguments [Boolean] :wait_for_no_initializing_shards A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard initializations. Defaults to false, which means it will not wait for initializing shards.
44
- # @option arguments [Boolean] :wait_for_no_relocating_shards A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard relocations. Defaults to false, which means it will not wait for relocating shards.
45
- # @option arguments [String] :wait_for_status One of green, yellow or red. Will wait (until the timeout provided) until the status of the cluster changes to the one provided or better, i.e. green > yellow > red. By default, will not wait for any status.
34
+ # @option arguments [String, Array] :index A comma-separated list of data streams, indices, and index aliases that limit the request.
35
+ # Wildcard expressions (`*`) are supported.
36
+ # To target all data streams and indices in a cluster, omit this parameter or use _all or `*`.
37
+ # @option arguments [String, Array<String>] :expand_wildcards Expand wildcard expression to concrete indices that are open, closed or both. Server default: all.
38
+ # @option arguments [String] :level Return health information at a specific level of detail. Server default: cluster.
39
+ # @option arguments [Boolean] :local If true, retrieve information from the local node only.
40
+ # If false, retrieve information from the master node.
41
+ # @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
42
+ # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
43
+ # @option arguments [Time] :timeout The period to wait for a response.
44
+ # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
45
+ # @option arguments [Integer, String] :wait_for_active_shards Wait for the specified number of active shards.
46
+ # Use `all` to wait for all shards in the cluster to be active.
47
+ # Use `0` to not wait. Server default: 0.
48
+ # @option arguments [String] :wait_for_events Wait until all currently queued events with the given priority are processed.
49
+ # @option arguments [String, Integer] :wait_for_nodes Wait until the specified number (N) of nodes is available.
50
+ # It also accepts `>=N`, `<=N`, `>N` and `<N`.
51
+ # Alternatively, use the notations `ge(N)`, `le(N)`, `gt(N)`, and `lt(N)`.
52
+ # @option arguments [Boolean] :wait_for_no_initializing_shards Wait (until the timeout expires) for the cluster to have no shard initializations.
53
+ # If false, the request does not wait for initializing shards.
54
+ # @option arguments [Boolean] :wait_for_no_relocating_shards Wait (until the timeout expires) for the cluster to have no shard relocations.
55
+ # If false, the request not wait for relocating shards.
56
+ # @option arguments [String] :wait_for_status Wait (until the timeout expires) for the cluster to reach a specific health status (or a better status).
57
+ # A green status is better than yellow and yellow is better than red.
58
+ # By default, the request does not wait for a particular status.
46
59
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
47
60
  # when they occur.
48
61
  # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
@@ -37,9 +37,9 @@ module Elasticsearch
37
37
  # WARNING: Transient cluster settings are no longer recommended. Use persistent cluster settings instead.
38
38
  # If a cluster becomes unstable, transient settings can clear unexpectedly, resulting in a potentially undesired cluster configuration.
39
39
  #
40
- # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
41
- # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node Server default: 30s.
42
- # @option arguments [Time] :timeout Explicit operation timeout Server default: 30s.
40
+ # @option arguments [Boolean] :flat_settings Return settings in flat format
41
+ # @option arguments [Time] :master_timeout The period to wait for a connection to the master node. Server default: 30s.
42
+ # @option arguments [Time] :timeout The period to wait for a response. Server default: 30s.
43
43
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
44
44
  # when they occur.
45
45
  # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
@@ -37,13 +37,14 @@ module Elasticsearch
37
37
  # Do not query this API using external monitoring tools.
38
38
  # Instead, obtain the information you require using other more stable cluster APIs.
39
39
  #
40
- # @option arguments [String, Array<String>] :metric Limit the information returned to the specified metrics
40
+ # @option arguments [String, Array<String>] :metric Limit the information returned to the specified metrics.
41
41
  # @option arguments [String, Array] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
42
- # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) Server default: true.
43
- # @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
44
- # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
42
+ # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices.
43
+ # (This includes `_all` string or when no indices have been specified) Server default: true.
44
+ # @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both Server default: open.
45
+ # @option arguments [Boolean] :flat_settings Return settings in flat format
45
46
  # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
46
- # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
47
+ # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
47
48
  # @option arguments [Time] :master_timeout Timeout for waiting for new cluster state in case it is blocked Server default: 30s.
48
49
  # @option arguments [Integer] :wait_for_metadata_version Wait for the metadata version to be equal or greater than the specified metadata version
49
50
  # @option arguments [Time] :wait_for_timeout The maximum time to wait for wait_for_metadata_version before timing out
@@ -24,10 +24,9 @@ module Elasticsearch
24
24
  module Actions
25
25
  # Check in a connector.
26
26
  # Update the `last_seen` field in the connector and set it to the current timestamp.
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.
27
+ # This functionality is in technical preview and may be changed or removed in a future
28
+ # release. Elastic will apply best effort to fix any issues, but features in technical
29
+ # preview are not subject to the support SLA of official GA features.
31
30
  #
32
31
  # @option arguments [String] :connector_id The unique identifier of the connector to be checked in (*Required*)
33
32
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
@@ -26,10 +26,9 @@ module Elasticsearch
26
26
  # Check in a connector sync job and set the `last_seen` field to the current time before updating it in the internal index.
27
27
  # To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.
28
28
  # This service runs automatically on Elastic Cloud for Elastic managed connectors.
29
- # This functionality is Experimental and may be changed or removed
30
- # completely in a future release. Elastic will take a best effort approach
31
- # to fix any issues, but experimental features are not subject to the
32
- # support SLA of official GA features.
29
+ # This functionality is in technical preview and may be changed or removed in a future
30
+ # release. Elastic will apply best effort to fix any issues, but features in technical
31
+ # preview are not subject to the support SLA of official GA features.
33
32
  #
34
33
  # @option arguments [String] :connector_sync_job_id The unique identifier of the connector sync job to be checked in. (*Required*)
35
34
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
@@ -29,10 +29,9 @@ module Elasticsearch
29
29
  # It supports the implementation of services that utilize the connector protocol to communicate with Elasticsearch.
30
30
  # To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.
31
31
  # This service runs automatically on Elastic Cloud for Elastic managed connectors.
32
- # This functionality is Experimental and may be changed or removed
33
- # completely in a future release. Elastic will take a best effort approach
34
- # to fix any issues, but experimental features are not subject to the
35
- # support SLA of official GA features.
32
+ # This functionality is in technical preview and may be changed or removed in a future
33
+ # release. Elastic will apply best effort to fix any issues, but features in technical
34
+ # preview are not subject to the support SLA of official GA features.
36
35
  #
37
36
  # @option arguments [String] :connector_sync_job_id The unique identifier of the connector sync job. (*Required*)
38
37
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
@@ -60,7 +59,6 @@ module Elasticsearch
60
59
  request_opts[:defined_params] = defined_params unless defined_params.empty?
61
60
 
62
61
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
63
-
64
62
  unless arguments[:connector_sync_job_id]
65
63
  raise ArgumentError,
66
64
  "Required argument 'connector_sync_job_id' missing"
@@ -26,10 +26,9 @@ module Elasticsearch
26
26
  # Set the `error` field for a connector sync job and set its `status` to `error`.
27
27
  # To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.
28
28
  # This service runs automatically on Elastic Cloud for Elastic managed connectors.
29
- # This functionality is Experimental and may be changed or removed
30
- # completely in a future release. Elastic will take a best effort approach
31
- # to fix any issues, but experimental features are not subject to the
32
- # support SLA of official GA features.
29
+ # This functionality is in technical preview and may be changed or removed in a future
30
+ # release. Elastic will apply best effort to fix any issues, but features in technical
31
+ # preview are not subject to the support SLA of official GA features.
33
32
  #
34
33
  # @option arguments [String] :connector_sync_job_id The unique identifier for the connector sync job. (*Required*)
35
34
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
@@ -57,7 +56,6 @@ module Elasticsearch
57
56
  request_opts[:defined_params] = defined_params unless defined_params.empty?
58
57
 
59
58
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
60
-
61
59
  unless arguments[:connector_sync_job_id]
62
60
  raise ArgumentError,
63
61
  "Required argument 'connector_sync_job_id' missing"
@@ -28,10 +28,9 @@ module Elasticsearch
28
28
  # This API is mainly used by the connector service for updating sync job information.
29
29
  # To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.
30
30
  # This service runs automatically on Elastic Cloud for Elastic managed connectors.
31
- # This functionality is Experimental and may be changed or removed
32
- # completely in a future release. Elastic will take a best effort approach
33
- # to fix any issues, but experimental features are not subject to the
34
- # support SLA of official GA features.
31
+ # This functionality is in technical preview and may be changed or removed in a future
32
+ # release. Elastic will apply best effort to fix any issues, but features in technical
33
+ # preview are not subject to the support SLA of official GA features.
35
34
  #
36
35
  # @option arguments [String] :connector_sync_job_id The unique identifier of the connector sync job. (*Required*)
37
36
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
@@ -59,7 +58,6 @@ module Elasticsearch
59
58
  request_opts[:defined_params] = defined_params unless defined_params.empty?
60
59
 
61
60
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
62
-
63
61
  unless arguments[:connector_sync_job_id]
64
62
  raise ArgumentError,
65
63
  "Required argument 'connector_sync_job_id' missing"
@@ -24,10 +24,9 @@ module Elasticsearch
24
24
  module Actions
25
25
  # Activate the connector draft filter.
26
26
  # Activates the valid draft filtering for a connector.
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.
27
+ # This functionality is in technical preview and may be changed or removed in a future
28
+ # release. Elastic will apply best effort to fix any issues, but features in technical
29
+ # preview are not subject to the support SLA of official GA features.
31
30
  #
32
31
  # @option arguments [String] :connector_id The unique identifier of the connector to be updated (*Required*)
33
32
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
@@ -26,10 +26,9 @@ module Elasticsearch
26
26
  # Set the error field for the connector.
27
27
  # If the error provided in the request body is non-null, the connector’s status is updated to error.
28
28
  # Otherwise, if the error is reset to null, the connector status is updated to connected.
29
- # This functionality is Experimental and may be changed or removed
30
- # completely in a future release. Elastic will take a best effort approach
31
- # to fix any issues, but experimental features are not subject to the
32
- # support SLA of official GA features.
29
+ # This functionality is in technical preview and may be changed or removed in a future
30
+ # release. Elastic will apply best effort to fix any issues, but features in technical
31
+ # preview are not subject to the support SLA of official GA features.
33
32
  #
34
33
  # @option arguments [String] :connector_id The unique identifier of the connector to be updated (*Required*)
35
34
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
@@ -33,10 +33,9 @@ module Elasticsearch
33
33
  # However, you can use this API to override the default behavior.
34
34
  # To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.
35
35
  # This service runs automatically on Elastic Cloud for Elastic managed connectors.
36
- # This functionality is Experimental and may be changed or removed
37
- # completely in a future release. Elastic will take a best effort approach
38
- # to fix any issues, but experimental features are not subject to the
39
- # support SLA of official GA features.
36
+ # This functionality is in technical preview and may be changed or removed in a future
37
+ # release. Elastic will apply best effort to fix any issues, but features in technical
38
+ # preview are not subject to the support SLA of official GA features.
40
39
  #
41
40
  # @option arguments [String] :connector_id The unique identifier of the connector to be updated. (*Required*)
42
41
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
@@ -24,10 +24,9 @@ module Elasticsearch
24
24
  module Actions
25
25
  # Update the connector draft filtering validation.
26
26
  # Update the draft filtering validation info for a connector.
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.
27
+ # This functionality is in technical preview and may be changed or removed in a future
28
+ # release. Elastic will apply best effort to fix any issues, but features in technical
29
+ # preview are not subject to the support SLA of official GA features.
31
30
  #
32
31
  # @option arguments [String] :connector_id The unique identifier of the connector to be updated (*Required*)
33
32
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
@@ -23,10 +23,9 @@ module Elasticsearch
23
23
  module Connector
24
24
  module Actions
25
25
  # Update the connector status.
26
- # This functionality is Experimental and may be changed or removed
27
- # completely in a future release. Elastic will take a best effort approach
28
- # to fix any issues, but experimental features are not subject to the
29
- # support SLA of official GA features.
26
+ # This functionality is in technical preview and may be changed or removed in a future
27
+ # release. Elastic will apply best effort to fix any issues, but features in technical
28
+ # preview are not subject to the support SLA of official GA features.
30
29
  #
31
30
  # @option arguments [String] :connector_id The unique identifier of the connector to be updated (*Required*)
32
31
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
@@ -33,7 +33,7 @@ module Elasticsearch
33
33
  # NOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader.
34
34
  # The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked.
35
35
  #
36
- # @option arguments [String] :index the name of the leader index for which specified follower retention leases should be removed (*Required*)
36
+ # @option arguments [String] :index Name of the leader index for which specified follower retention leases should be removed (*Required*)
37
37
  # @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
38
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
39
39
  # when they occur.
@@ -28,7 +28,7 @@ module Elasticsearch
28
28
  # Alternatively it could be paused due to replication that cannot be retried due to failures during following tasks.
29
29
  # When this API returns, the follower index will resume fetching operations from the leader index.
30
30
  #
31
- # @option arguments [String] :index The name of the follow index to resume following. (*Required*)
31
+ # @option arguments [String] :index Name of the follow index to resume following (*Required*)
32
32
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
33
33
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
34
34
  # when they occur.
@@ -27,9 +27,9 @@ module Elasticsearch
27
27
  # For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.
28
28
  #
29
29
  # @option arguments [String] :index_uuid The UUID of the index to delete. Use the get dangling indices API to find the UUID. (*Required*)
30
- # @option arguments [Boolean] :accept_data_loss This parameter must be set to true to acknowledge that it will no longer be possible to recove data from the dangling index. (*Required*)
31
- # @option arguments [Time] :master_timeout Specify timeout for connection to master Server default: 30s.
32
- # @option arguments [Time] :timeout Explicit operation timeout
30
+ # @option arguments [Boolean] :accept_data_loss This parameter must be set to true to acknowledge that it will no longer be possible to recove data from the dangling index.
31
+ # @option arguments [Time] :master_timeout The period to wait for a connection to the master node. Server default: 30s.
32
+ # @option arguments [Time] :timeout The period to wait for a response. Server default: 30s.
33
33
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
34
34
  # when they occur.
35
35
  # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
@@ -28,9 +28,9 @@ module Elasticsearch
28
28
  #
29
29
  # @option arguments [String] :index_uuid The UUID of the index to import. Use the get dangling indices API to locate the UUID. (*Required*)
30
30
  # @option arguments [Boolean] :accept_data_loss This parameter must be set to true to import a dangling index.
31
- # Because Elasticsearch cannot know where the dangling index data came from or determine which shard copies are fresh and which are stale, it cannot guarantee that the imported data represents the latest state of the index when it was last in the cluster. (*Required*)
32
- # @option arguments [Time] :master_timeout Specify timeout for connection to master Server default: 30s.
33
- # @option arguments [Time] :timeout Explicit operation timeout
31
+ # Because Elasticsearch cannot know where the dangling index data came from or determine which shard copies are fresh and which are stale, it cannot guarantee that the imported data represents the latest state of the index when it was last in the cluster.
32
+ # @option arguments [Time] :master_timeout The period to wait for a connection to the master node. Server default: 30s.
33
+ # @option arguments [Time] :timeout The period to wait for a response. Server default: 30s.
34
34
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
35
35
  # when they occur.
36
36
  # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
@@ -27,7 +27,7 @@ module Elasticsearch
27
27
  #
28
28
  # @option arguments [String] :task_id The ID for the task. (*Required*)
29
29
  # @option arguments [Float] :requests_per_second The throttle for this request in sub-requests per second.
30
- # To disable throttling, set it to `-1`.
30
+ # To disable throttling, set it to `-1`. (*Required*)
31
31
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
32
32
  # when they occur.
33
33
  # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
@@ -26,8 +26,9 @@ module Elasticsearch
26
26
  # Returns search results for an Event Query Language (EQL) query.
27
27
  # EQL assumes each document in a data stream or index corresponds to an event.
28
28
  #
29
- # @option arguments [String, Array] :index The name of the index to scope the operation (*Required*)
30
- # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) Server default: true.
29
+ # @option arguments [String, Array] :index Comma-separated list of index names to scope the operation (*Required*)
30
+ # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices.
31
+ # (This includes `_all` string or when no indices have been specified) Server default: true.
31
32
  # @option arguments [Boolean] :allow_partial_search_results If true, returns partial results if there are shard failures. If false, returns an error with no partial results. Server default: true.
32
33
  # @option arguments [Boolean] :allow_partial_sequence_results If true, sequence queries will return partial results in case of shard failures. If false, they will return no results at all.
33
34
  # This flag has effect only if allow_partial_search_results is true.
@@ -24,10 +24,9 @@ module Elasticsearch
24
24
  module Actions
25
25
  # Get a specific running ES|QL query information.
26
26
  # Returns an object extended information about a running ES|QL query.
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.
27
+ # This functionality is in technical preview and may be changed or removed in a future
28
+ # release. Elastic will apply best effort to fix any issues, but features in technical
29
+ # preview are not subject to the support SLA of official GA features.
31
30
  #
32
31
  # @option arguments [String] :id The query ID (*Required*)
33
32
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
@@ -24,10 +24,9 @@ module Elasticsearch
24
24
  module Actions
25
25
  # Get running ES|QL queries information.
26
26
  # Returns an object containing IDs and other information about the running ES|QL queries.
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.
27
+ # This functionality is in technical preview and may be changed or removed in a future
28
+ # release. Elastic will apply best effort to fix any issues, but features in technical
29
+ # preview are not subject to the support SLA of official GA features.
31
30
  #
32
31
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
33
32
  # when they occur.
@@ -33,10 +33,9 @@ module Elasticsearch
33
33
  # Using this API resets all features, both those that are built-in and implemented as plugins.
34
34
  # To list the features that will be affected, use the get features API.
35
35
  # IMPORTANT: The features installed on the node you submit this request to are the features that will be reset. Run on the master node if you have any doubts about which plugins are installed on individual nodes.
36
- # This functionality is Experimental and may be changed or removed
37
- # completely in a future release. Elastic will take a best effort approach
38
- # to fix any issues, but experimental features are not subject to the
39
- # support SLA of official GA features.
36
+ # This functionality is in technical preview and may be changed or removed in a future
37
+ # release. Elastic will apply best effort to fix any issues, but features in technical
38
+ # preview are not subject to the support SLA of official GA features.
40
39
  #
41
40
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
42
41
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
@@ -26,10 +26,9 @@ module Elasticsearch
26
26
  # Run several Fleet searches with a single API request.
27
27
  # The API follows the same structure as the multi search API.
28
28
  # However, similar to the Fleet search API, it supports the `wait_for_checkpoints` parameter.
29
- # This functionality is Experimental and may be changed or removed
30
- # completely in a future release. Elastic will take a best effort approach
31
- # to fix any issues, but experimental features are not subject to the
32
- # support SLA of official GA features.
29
+ # This functionality is in technical preview and may be changed or removed in a future
30
+ # release. Elastic will apply best effort to fix any issues, but features in technical
31
+ # preview are not subject to the support SLA of official GA features.
33
32
  #
34
33
  # @option arguments [String] :index A single target to search. If the target is an index alias, it must resolve to a single index.
35
34
  # @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. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.