elasticsearch-api 9.2.0 → 9.3.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.
- checksums.yaml +4 -4
- data/elasticsearch-api.gemspec +1 -0
- data/lib/elasticsearch/api/actions/async_search/submit.rb +13 -18
- data/lib/elasticsearch/api/actions/bulk.rb +2 -1
- data/lib/elasticsearch/api/actions/cat/aliases.rb +1 -1
- data/lib/elasticsearch/api/actions/cat/circuit_breaker.rb +96 -0
- data/lib/elasticsearch/api/actions/cat/count.rb +8 -10
- data/lib/elasticsearch/api/actions/cat/indices.rb +1 -1
- data/lib/elasticsearch/api/actions/cat/segments.rb +10 -0
- data/lib/elasticsearch/api/actions/cat/tasks.rb +3 -4
- data/lib/elasticsearch/api/actions/cluster/get_component_template.rb +2 -3
- data/lib/elasticsearch/api/actions/cluster/health.rb +25 -12
- data/lib/elasticsearch/api/actions/cluster/put_settings.rb +3 -3
- data/lib/elasticsearch/api/actions/cluster/reroute.rb +1 -1
- data/lib/elasticsearch/api/actions/cluster/state.rb +6 -5
- data/lib/elasticsearch/api/actions/connector/check_in.rb +3 -4
- data/lib/elasticsearch/api/actions/connector/sync_job_check_in.rb +3 -4
- data/lib/elasticsearch/api/actions/connector/sync_job_claim.rb +3 -4
- data/lib/elasticsearch/api/actions/connector/sync_job_error.rb +3 -4
- data/lib/elasticsearch/api/actions/connector/sync_job_update_stats.rb +3 -4
- data/lib/elasticsearch/api/actions/connector/update_active_filtering.rb +3 -4
- data/lib/elasticsearch/api/actions/connector/update_error.rb +3 -4
- data/lib/elasticsearch/api/actions/connector/update_features.rb +3 -4
- data/lib/elasticsearch/api/actions/connector/update_filtering_validation.rb +3 -4
- data/lib/elasticsearch/api/actions/connector/update_status.rb +3 -4
- data/lib/elasticsearch/api/actions/count.rb +1 -9
- data/lib/elasticsearch/api/actions/create.rb +1 -1
- data/lib/elasticsearch/api/actions/cross_cluster_replication/forget_follower.rb +1 -1
- data/lib/elasticsearch/api/actions/cross_cluster_replication/resume_follow.rb +1 -1
- data/lib/elasticsearch/api/actions/dangling_indices/delete_dangling_index.rb +3 -3
- data/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb +3 -3
- data/lib/elasticsearch/api/actions/delete.rb +1 -1
- data/lib/elasticsearch/api/actions/delete_by_query.rb +1 -1
- data/lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb +1 -1
- data/lib/elasticsearch/api/actions/eql/search.rb +3 -10
- data/lib/elasticsearch/api/actions/esql/delete_view.rb +75 -0
- data/lib/elasticsearch/api/actions/esql/get_query.rb +3 -4
- data/lib/elasticsearch/api/actions/esql/get_view.rb +77 -0
- data/lib/elasticsearch/api/actions/esql/list_queries.rb +3 -4
- data/lib/elasticsearch/api/actions/esql/put_view.rb +76 -0
- data/lib/elasticsearch/api/actions/exists.rb +1 -1
- data/lib/elasticsearch/api/actions/exists_source.rb +1 -1
- data/lib/elasticsearch/api/actions/explain.rb +1 -1
- data/lib/elasticsearch/api/actions/features/reset_features.rb +3 -4
- data/lib/elasticsearch/api/actions/field_caps.rb +1 -9
- data/lib/elasticsearch/api/actions/fleet/msearch.rb +3 -4
- data/lib/elasticsearch/api/actions/fleet/search.rb +4 -5
- data/lib/elasticsearch/api/actions/get.rb +1 -1
- data/lib/elasticsearch/api/actions/get_source.rb +1 -1
- data/lib/elasticsearch/api/actions/graph/explore.rb +1 -1
- data/lib/elasticsearch/api/actions/index.rb +4 -1
- data/lib/elasticsearch/api/actions/indices/add_block.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/cancel_migrate_reindex.rb +0 -4
- data/lib/elasticsearch/api/actions/indices/create_from.rb +0 -4
- data/lib/elasticsearch/api/actions/indices/data_streams_stats.rb +2 -2
- data/lib/elasticsearch/api/actions/indices/delete.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/delete_data_lifecycle.rb +5 -4
- data/lib/elasticsearch/api/actions/indices/delete_data_stream_options.rb +5 -4
- data/lib/elasticsearch/api/actions/indices/delete_sample_configuration.rb +80 -0
- data/lib/elasticsearch/api/actions/indices/disk_usage.rb +3 -4
- data/lib/elasticsearch/api/actions/indices/downsample.rb +8 -6
- data/lib/elasticsearch/api/actions/indices/exists_alias.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/explain_data_lifecycle.rb +3 -3
- data/lib/elasticsearch/api/actions/indices/field_usage_stats.rb +4 -5
- data/lib/elasticsearch/api/actions/indices/forcemerge.rb +5 -4
- data/lib/elasticsearch/api/actions/indices/get_alias.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/get_all_sample_configuration.rb +68 -0
- data/lib/elasticsearch/api/actions/indices/get_index_template.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/get_migrate_reindex_status.rb +0 -4
- data/lib/elasticsearch/api/actions/indices/get_sample.rb +74 -0
- data/lib/elasticsearch/api/actions/indices/get_sample_configuration.rb +78 -0
- data/lib/elasticsearch/api/actions/indices/get_sample_stats.rb +74 -0
- data/lib/elasticsearch/api/actions/indices/migrate_reindex.rb +0 -4
- data/lib/elasticsearch/api/actions/indices/open.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/promote_data_stream.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/put_index_template.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/put_mapping.rb +2 -1
- data/lib/elasticsearch/api/actions/indices/put_sample_configuration.rb +82 -0
- data/lib/elasticsearch/api/actions/indices/put_template.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/reload_search_analyzers.rb +3 -2
- data/lib/elasticsearch/api/actions/indices/remove_block.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/resolve_index.rb +8 -10
- data/lib/elasticsearch/api/actions/indices/stats.rb +2 -2
- data/lib/elasticsearch/api/actions/inference/chat_completion_unified.rb +3 -3
- data/lib/elasticsearch/api/actions/inference/completion.rb +5 -1
- data/lib/elasticsearch/api/actions/inference/delete.rb +3 -2
- data/lib/elasticsearch/api/actions/inference/get.rb +2 -1
- data/lib/elasticsearch/api/actions/inference/put.rb +5 -2
- data/lib/elasticsearch/api/actions/inference/put_groq.rb +79 -0
- data/lib/elasticsearch/api/actions/inference/put_nvidia.rb +84 -0
- data/lib/elasticsearch/api/actions/inference/put_openshift_ai.rb +84 -0
- data/lib/elasticsearch/api/actions/inference/rerank.rb +1 -1
- data/lib/elasticsearch/api/actions/inference/sparse_embedding.rb +1 -1
- data/lib/elasticsearch/api/actions/inference/stream_completion.rb +1 -1
- data/lib/elasticsearch/api/actions/inference/text_embedding.rb +1 -1
- data/lib/elasticsearch/api/actions/ingest/get_pipeline.rb +1 -1
- data/lib/elasticsearch/api/actions/license/post_start_basic.rb +1 -1
- data/lib/elasticsearch/api/actions/license/post_start_trial.rb +2 -2
- data/lib/elasticsearch/api/actions/machine_learning/start_data_frame_analytics.rb +2 -1
- data/lib/elasticsearch/api/actions/machine_learning/start_trained_model_deployment.rb +1 -1
- data/lib/elasticsearch/api/actions/machine_learning/stop_data_frame_analytics.rb +2 -1
- data/lib/elasticsearch/api/actions/machine_learning/stop_datafeed.rb +1 -0
- data/lib/elasticsearch/api/actions/machine_learning/stop_trained_model_deployment.rb +2 -1
- data/lib/elasticsearch/api/actions/mget.rb +1 -1
- data/lib/elasticsearch/api/actions/msearch.rb +2 -2
- data/lib/elasticsearch/api/actions/mtermvectors.rb +1 -1
- data/lib/elasticsearch/api/actions/nodes/clear_repositories_metering_archive.rb +3 -4
- data/lib/elasticsearch/api/actions/nodes/get_repositories_metering_info.rb +3 -4
- data/lib/elasticsearch/api/actions/nodes/hot_threads.rb +1 -1
- data/lib/elasticsearch/api/actions/nodes/stats.rb +1 -1
- data/lib/elasticsearch/api/actions/nodes/usage.rb +3 -2
- data/lib/elasticsearch/api/actions/open_point_in_time.rb +1 -9
- data/lib/elasticsearch/api/actions/project/tags.rb +8 -6
- data/lib/elasticsearch/api/actions/rank_eval.rb +1 -1
- data/lib/elasticsearch/api/actions/reindex.rb +2 -1
- data/lib/elasticsearch/api/actions/reindex_rethrottle.rb +1 -1
- data/lib/elasticsearch/api/actions/scripts_painless_execute.rb +3 -4
- data/lib/elasticsearch/api/actions/search.rb +1 -9
- data/lib/elasticsearch/api/actions/search_application/delete_behavioral_analytics.rb +3 -4
- data/lib/elasticsearch/api/actions/search_application/get_behavioral_analytics.rb +3 -4
- data/lib/elasticsearch/api/actions/search_application/post_behavioral_analytics_event.rb +3 -4
- data/lib/elasticsearch/api/actions/search_application/put_behavioral_analytics.rb +3 -4
- data/lib/elasticsearch/api/actions/search_application/render_query.rb +3 -4
- data/lib/elasticsearch/api/actions/search_mvt.rb +12 -5
- data/lib/elasticsearch/api/actions/search_shards.rb +1 -1
- data/lib/elasticsearch/api/actions/search_template.rb +2 -2
- data/lib/elasticsearch/api/actions/searchable_snapshots/cache_stats.rb +3 -4
- data/lib/elasticsearch/api/actions/searchable_snapshots/clear_cache.rb +6 -6
- data/lib/elasticsearch/api/actions/security/clear_cached_privileges.rb +1 -1
- data/lib/elasticsearch/api/actions/security/create_service_token.rb +1 -1
- data/lib/elasticsearch/api/actions/security/delete_service_token.rb +1 -1
- data/lib/elasticsearch/api/actions/simulate/ingest.rb +3 -4
- data/lib/elasticsearch/api/actions/snapshot/delete.rb +1 -1
- data/lib/elasticsearch/api/actions/snapshot/repository_verify_integrity.rb +3 -4
- data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_lifecycle.rb +1 -1
- data/lib/elasticsearch/api/actions/sql/query.rb +0 -8
- data/lib/elasticsearch/api/actions/streams/logs_disable.rb +3 -4
- data/lib/elasticsearch/api/actions/streams/logs_enable.rb +3 -4
- data/lib/elasticsearch/api/actions/streams/status.rb +3 -4
- data/lib/elasticsearch/api/actions/tasks/cancel.rb +3 -4
- data/lib/elasticsearch/api/actions/tasks/get.rb +3 -4
- data/lib/elasticsearch/api/actions/tasks/list.rb +3 -4
- data/lib/elasticsearch/api/actions/terms_enum.rb +1 -1
- data/lib/elasticsearch/api/actions/termvectors.rb +1 -1
- data/lib/elasticsearch/api/actions/text_structure/find_field_structure.rb +1 -1
- data/lib/elasticsearch/api/actions/text_structure/find_message_structure.rb +1 -1
- data/lib/elasticsearch/api/actions/text_structure/find_structure.rb +1 -1
- data/lib/elasticsearch/api/actions/transform/get_node_stats.rb +15 -3
- data/lib/elasticsearch/api/actions/transform/get_transform_stats.rb +1 -1
- data/lib/elasticsearch/api/actions/update.rb +1 -1
- data/lib/elasticsearch/api/actions/update_by_query.rb +2 -2
- data/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb +1 -1
- data/lib/elasticsearch/api/actions/watcher/put_watch.rb +2 -2
- data/lib/elasticsearch/api/actions/xpack/info.rb +1 -1
- data/lib/elasticsearch/api/utils.rb +0 -4
- data/lib/elasticsearch/api/version.rb +2 -2
- data/lib/elasticsearch/api.rb +1 -0
- metadata +29 -2
|
@@ -38,6 +38,7 @@ module Elasticsearch
|
|
|
38
38
|
# partial matches. Server default: true.
|
|
39
39
|
# @option arguments [Boolean] :force If `true`, the datafeed is stopped forcefully.
|
|
40
40
|
# @option arguments [Time] :timeout Specifies the amount of time to wait until a datafeed stops. Server default: 20s.
|
|
41
|
+
# @option arguments [Boolean] :close_job If `true` the job associated with the datafeed is closed.
|
|
41
42
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
42
43
|
# when they occur.
|
|
43
44
|
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
@@ -43,6 +43,7 @@ module Elasticsearch
|
|
|
43
43
|
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
|
44
44
|
# this option for debugging only.
|
|
45
45
|
# @option arguments [Hash] :headers Custom HTTP headers
|
|
46
|
+
# @option arguments [Hash] :body request body
|
|
46
47
|
#
|
|
47
48
|
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-stop-trained-model-deployment
|
|
48
49
|
#
|
|
@@ -59,7 +60,7 @@ module Elasticsearch
|
|
|
59
60
|
arguments = arguments.clone
|
|
60
61
|
headers = arguments.delete(:headers) || {}
|
|
61
62
|
|
|
62
|
-
body =
|
|
63
|
+
body = arguments.delete(:body)
|
|
63
64
|
|
|
64
65
|
_model_id = arguments.delete(:model_id)
|
|
65
66
|
|
|
@@ -41,7 +41,7 @@ module Elasticsearch
|
|
|
41
41
|
# @option arguments [String] :preference Specifies the node or shard the operation should be performed on. Random by default.
|
|
42
42
|
# @option arguments [Boolean] :realtime If `true`, the request is real-time as opposed to near-real-time. Server default: true.
|
|
43
43
|
# @option arguments [Boolean] :refresh If `true`, the request refreshes relevant shards before retrieving documents.
|
|
44
|
-
# @option arguments [String] :routing Custom value used to route operations to a specific shard.
|
|
44
|
+
# @option arguments [String, Array<String>] :routing Custom value used to route operations to a specific shard.
|
|
45
45
|
# @option arguments [Boolean, String, Array<String>] :_source True or false to return the `_source` field or not, or a list of fields to return.
|
|
46
46
|
# @option arguments [String, Array<String>] :_source_excludes A comma-separated list of source fields to exclude from the response.
|
|
47
47
|
# You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.
|
|
@@ -44,7 +44,7 @@ module Elasticsearch
|
|
|
44
44
|
# @option arguments [String, Array] :index Comma-separated list of data streams, indices, and index aliases to search.
|
|
45
45
|
# @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.
|
|
46
46
|
# @option arguments [Boolean] :ccs_minimize_roundtrips If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests. Server default: true.
|
|
47
|
-
# @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
|
|
47
|
+
# @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Server default: open.
|
|
48
48
|
# @option arguments [Boolean] :ignore_throttled If true, concrete, expanded or aliased indices are ignored when frozen.
|
|
49
49
|
# @option arguments [Boolean] :ignore_unavailable If true, missing or closed indices are not included in the response.
|
|
50
50
|
# @option arguments [Boolean] :include_named_queries_score Indicates whether hit.matched_queries should be rendered as a map that includes
|
|
@@ -65,7 +65,7 @@ module Elasticsearch
|
|
|
65
65
|
# _alias:*pr*
|
|
66
66
|
# Supported in serverless only.
|
|
67
67
|
# @option arguments [Boolean] :rest_total_hits_as_int If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object.
|
|
68
|
-
# @option arguments [String] :routing Custom routing value used to route search operations to a specific shard.
|
|
68
|
+
# @option arguments [String, Array<String>] :routing Custom routing value used to route search operations to a specific shard.
|
|
69
69
|
# @option arguments [String] :search_type Indicates whether global term and document frequencies should be used when scoring returned documents.
|
|
70
70
|
# @option arguments [Boolean] :typed_keys Specifies whether aggregation and suggester names should be prefixed by their respective types in the response.
|
|
71
71
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
@@ -42,7 +42,7 @@ module Elasticsearch
|
|
|
42
42
|
# @option arguments [String] :preference The node or shard the operation should be performed on.
|
|
43
43
|
# It is random by default.
|
|
44
44
|
# @option arguments [Boolean] :realtime If true, the request is real-time as opposed to near-real-time. Server default: true.
|
|
45
|
-
# @option arguments [String] :routing A custom value used to route operations to a specific shard.
|
|
45
|
+
# @option arguments [String, Array<String>] :routing A custom value used to route operations to a specific shard.
|
|
46
46
|
# @option arguments [Boolean] :term_statistics If true, the response includes term frequency and document frequency.
|
|
47
47
|
# @option arguments [Integer] :version If `true`, returns the document version as part of a hit.
|
|
48
48
|
# @option arguments [String] :version_type The version type.
|
|
@@ -24,10 +24,9 @@ module Elasticsearch
|
|
|
24
24
|
module Actions
|
|
25
25
|
# Clear the archived repositories metering.
|
|
26
26
|
# Clear the archived repositories metering information in the cluster.
|
|
27
|
-
# This functionality is
|
|
28
|
-
#
|
|
29
|
-
#
|
|
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, Array] :node_id Comma-separated list of node IDs or names used to limit returned information. (*Required*)
|
|
33
32
|
# @option arguments [Integer] :max_archive_version Specifies the maximum `archive_version` to be cleared from the archive. (*Required*)
|
|
@@ -26,10 +26,9 @@ module Elasticsearch
|
|
|
26
26
|
# Get repositories metering information for a cluster.
|
|
27
27
|
# This API exposes monotonically non-decreasing counters and it is expected that clients would durably store the information needed to compute aggregations over a period of time.
|
|
28
28
|
# Additionally, the information exposed by this API is volatile, meaning that it will not be present after node restarts.
|
|
29
|
-
# This functionality is
|
|
30
|
-
#
|
|
31
|
-
#
|
|
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, Array] :node_id Comma-separated list of node IDs or names used to limit returned information. (*Required*)
|
|
35
34
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
@@ -35,7 +35,7 @@ module Elasticsearch
|
|
|
35
35
|
# @option arguments [Time] :timeout Period to wait for a response. If no response is received
|
|
36
36
|
# before the timeout expires, the request fails and returns an error. Server default: 30s.
|
|
37
37
|
# @option arguments [String] :type The type to sample. Server default: cpu.
|
|
38
|
-
# @option arguments [String] :sort The sort order for 'cpu' type
|
|
38
|
+
# @option arguments [String] :sort The sort order for 'cpu' type Server default: total.
|
|
39
39
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
40
40
|
# when they occur.
|
|
41
41
|
# @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
|
# By default, all stats are returned. You can limit the returned information by using metrics.
|
|
28
28
|
#
|
|
29
29
|
# @option arguments [String, Array] :node_id Comma-separated list of node IDs or names used to limit returned information.
|
|
30
|
-
# @option arguments [String, Array<String>] :metric
|
|
30
|
+
# @option arguments [String, Array<String>] :metric Limits the information returned to the specific metrics.
|
|
31
31
|
# @option arguments [String, Array<String>] :index_metric Limit the information returned for indices metric to the specific index metrics. It can be used only if indices (or all) metric is specified.
|
|
32
32
|
# @option arguments [String, Array<String>] :completion_fields Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics.
|
|
33
33
|
# @option arguments [String, Array<String>] :fielddata_fields Comma-separated list or wildcard expressions of fields to include in fielddata statistics.
|
|
@@ -24,9 +24,10 @@ module Elasticsearch
|
|
|
24
24
|
module Actions
|
|
25
25
|
# Get feature usage information.
|
|
26
26
|
#
|
|
27
|
-
# @option arguments [String, Array] :node_id A comma-separated list of node IDs or names to limit the returned information
|
|
27
|
+
# @option arguments [String, Array] :node_id A comma-separated list of node IDs or names to limit the returned information.
|
|
28
|
+
# Use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.
|
|
28
29
|
# @option arguments [String, Array<String>] :metric Limits the information returned to the specific metrics.
|
|
29
|
-
# A comma-separated list of the following options: `_all`, `rest_actions`.
|
|
30
|
+
# A comma-separated list of the following options: `_all`, `rest_actions`, `aggregations`.
|
|
30
31
|
# @option arguments [Time] :timeout Period to wait for a response.
|
|
31
32
|
# If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
|
|
32
33
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
@@ -53,15 +53,7 @@ module Elasticsearch
|
|
|
53
53
|
# @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index.
|
|
54
54
|
# @option arguments [String] :preference The node or shard the operation should be performed on.
|
|
55
55
|
# By default, it is random.
|
|
56
|
-
# @option arguments [String] :
|
|
57
|
-
# metadata tags in a subset of Lucene query syntax.
|
|
58
|
-
# Allowed Lucene queries: the _alias tag and a single value (possibly wildcarded).
|
|
59
|
-
# Examples:
|
|
60
|
-
# _alias:my-project
|
|
61
|
-
# _alias:_origin
|
|
62
|
-
# _alias:*pr*
|
|
63
|
-
# Supported in serverless only.
|
|
64
|
-
# @option arguments [String] :routing A custom value that is used to route operations to a specific shard.
|
|
56
|
+
# @option arguments [String, Array<String>] :routing A custom value that is used to route operations to a specific shard.
|
|
65
57
|
# @option arguments [String, Array<String>] :expand_wildcards The type of index that wildcard patterns can match.
|
|
66
58
|
# If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
|
|
67
59
|
# It supports comma-separated values, such as `open,hidden`. Server default: open.
|
|
@@ -22,12 +22,14 @@ module Elasticsearch
|
|
|
22
22
|
module API
|
|
23
23
|
module Project
|
|
24
24
|
module Actions
|
|
25
|
-
#
|
|
26
|
-
#
|
|
27
|
-
#
|
|
28
|
-
#
|
|
29
|
-
#
|
|
25
|
+
# Get tags.
|
|
26
|
+
# Get the tags that are defined for the project.
|
|
27
|
+
# This API is only available in Serverless.
|
|
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.
|
|
30
31
|
#
|
|
32
|
+
# @option arguments [String] :project_routing A Lucene query using project metadata tags used to filter which projects are returned in the response, such as _alias:_origin or _alias:*pr*.
|
|
31
33
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
32
34
|
# when they occur.
|
|
33
35
|
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
@@ -41,7 +43,7 @@ module Elasticsearch
|
|
|
41
43
|
# this option for debugging only.
|
|
42
44
|
# @option arguments [Hash] :headers Custom HTTP headers
|
|
43
45
|
#
|
|
44
|
-
# @see
|
|
46
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch-serverless/operation/operation-project-tags
|
|
45
47
|
#
|
|
46
48
|
def tags(arguments = {})
|
|
47
49
|
request_opts = { endpoint: arguments[:endpoint] || 'project.tags' }
|
|
@@ -28,7 +28,7 @@ module Elasticsearch
|
|
|
28
28
|
# Wildcard (`*`) expressions are supported.
|
|
29
29
|
# To target all data streams and indices in a cluster, omit this parameter or use `_all` or `*`.
|
|
30
30
|
# @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`. Server default: true.
|
|
31
|
-
# @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
|
|
31
|
+
# @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. Server default: open.
|
|
32
32
|
# @option arguments [Boolean] :ignore_unavailable If `true`, missing or closed indices are not included in the response.
|
|
33
33
|
# @option arguments [String] :search_type Search operation type
|
|
34
34
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
@@ -36,7 +36,8 @@ module Elasticsearch
|
|
|
36
36
|
# * The `write` index privilege for the destination data stream, index, or index alias.
|
|
37
37
|
# * To automatically create a data stream or index with a reindex API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege for the destination data stream, index, or alias.
|
|
38
38
|
# * If reindexing from a remote cluster, the `source.remote.user` must have the `monitor` cluster privilege and the `read` index privilege for the source data stream, index, or alias.
|
|
39
|
-
# If reindexing from a remote cluster, you must explicitly allow the remote host
|
|
39
|
+
# If reindexing from a remote cluster into a cluster using Elastic Stack, you must explicitly allow the remote host using the `reindex.remote.whitelist` node setting on the destination cluster.
|
|
40
|
+
# If reindexing from a remote cluster into an Elastic Cloud Serverless project, only remote hosts from Elastic Cloud Hosted are allowed.
|
|
40
41
|
# Automatic data stream creation requires a matching index template with data stream enabled.
|
|
41
42
|
# The `dest` element can be configured like the index API to control optimistic concurrency control.
|
|
42
43
|
# Omitting `version_type` or setting it to `internal` causes Elasticsearch to blindly dump documents into the destination, overwriting any that happen to have the same ID.
|
|
@@ -35,7 +35,7 @@ module Elasticsearch
|
|
|
35
35
|
#
|
|
36
36
|
# @option arguments [String] :task_id The task identifier, which can be found by using the tasks API. (*Required*)
|
|
37
37
|
# @option arguments [Float] :requests_per_second The throttle for this request in sub-requests per second.
|
|
38
|
-
# It can be either `-1` to turn off throttling or any decimal number like `1.7` or `12` to throttle to that level.
|
|
38
|
+
# It can be either `-1` to turn off throttling or any decimal number like `1.7` or `12` to throttle to that level. (*Required*)
|
|
39
39
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
40
40
|
# when they occur.
|
|
41
41
|
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
@@ -27,10 +27,9 @@ module Elasticsearch
|
|
|
27
27
|
# This API requires very few dependencies and is especially useful if you don't have permissions to write documents on a cluster.
|
|
28
28
|
# The API uses several _contexts_, which control how scripts are run, what variables are available at runtime, and what the return type is.
|
|
29
29
|
# Each context requires a script, but additional parameters depend on the context you're using for that script.
|
|
30
|
-
# This functionality is
|
|
31
|
-
#
|
|
32
|
-
#
|
|
33
|
-
# support SLA of official GA features.
|
|
30
|
+
# This functionality is in technical preview and may be changed or removed in a future
|
|
31
|
+
# release. Elastic will apply best effort to fix any issues, but features in technical
|
|
32
|
+
# preview are not subject to the support SLA of official GA features.
|
|
34
33
|
#
|
|
35
34
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
36
35
|
# when they occur.
|
|
@@ -84,17 +84,9 @@ module Elasticsearch
|
|
|
84
84
|
# - The request targets more than 128 shards.
|
|
85
85
|
# - The request targets one or more read-only index.
|
|
86
86
|
# - The primary sort of the query targets an indexed field.
|
|
87
|
-
# @option arguments [String] :project_routing Specifies a subset of projects to target for the search using project
|
|
88
|
-
# metadata tags in a subset of Lucene query syntax.
|
|
89
|
-
# Allowed Lucene queries: the _alias tag and a single value (possibly wildcarded).
|
|
90
|
-
# Examples:
|
|
91
|
-
# _alias:my-project
|
|
92
|
-
# _alias:_origin
|
|
93
|
-
# _alias:*pr*
|
|
94
|
-
# Supported in serverless only.
|
|
95
87
|
# @option arguments [Boolean] :request_cache If `true`, the caching of search results is enabled for requests where `size` is `0`.
|
|
96
88
|
# It defaults to index level settings.
|
|
97
|
-
# @option arguments [String] :routing A custom value that is used to route operations to a specific shard.
|
|
89
|
+
# @option arguments [String, Array<String>] :routing A custom value that is used to route operations to a specific shard.
|
|
98
90
|
# @option arguments [Time] :scroll The period to retain the search context for scrolling.
|
|
99
91
|
# By default, this value cannot exceed `1d` (24 hours).
|
|
100
92
|
# You can change this limit by using the `search.max_keep_alive` cluster-level setting.
|
|
@@ -24,10 +24,9 @@ module Elasticsearch
|
|
|
24
24
|
module Actions
|
|
25
25
|
# Delete a behavioral analytics collection.
|
|
26
26
|
# The associated data stream is also deleted.
|
|
27
|
-
# This functionality is
|
|
28
|
-
#
|
|
29
|
-
#
|
|
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] :name The name of the analytics collection to be deleted (*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 SearchApplication
|
|
24
24
|
module Actions
|
|
25
25
|
# Get behavioral analytics collections.
|
|
26
|
-
# This functionality is
|
|
27
|
-
#
|
|
28
|
-
#
|
|
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 [Array<String>] :name A list of analytics collections to limit the returned information
|
|
32
31
|
# @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 SearchApplication
|
|
24
24
|
module Actions
|
|
25
25
|
# Create a behavioral analytics collection event.
|
|
26
|
-
# This functionality is
|
|
27
|
-
#
|
|
28
|
-
#
|
|
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] :collection_name The name of the behavioral analytics collection. (*Required*)
|
|
32
31
|
# @option arguments [String] :event_type The analytics event type. (*Required*)
|
|
@@ -23,10 +23,9 @@ module Elasticsearch
|
|
|
23
23
|
module SearchApplication
|
|
24
24
|
module Actions
|
|
25
25
|
# Create a behavioral analytics collection.
|
|
26
|
-
# This functionality is
|
|
27
|
-
#
|
|
28
|
-
#
|
|
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] :name The name of the analytics collection to be created or updated. (*Required*)
|
|
32
31
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
@@ -27,10 +27,9 @@ module Elasticsearch
|
|
|
27
27
|
# If a parameter used in the search template is not specified in `params`, the parameter's default value will be used.
|
|
28
28
|
# The API returns the specific Elasticsearch query that would be generated and run by calling the search application search API.
|
|
29
29
|
# You must have `read` privileges on the backing alias of the search application.
|
|
30
|
-
# This functionality is
|
|
31
|
-
#
|
|
32
|
-
#
|
|
33
|
-
# support SLA of official GA features.
|
|
30
|
+
# This functionality is in technical preview and may be changed or removed in a future
|
|
31
|
+
# release. Elastic will apply best effort to fix any issues, but features in technical
|
|
32
|
+
# preview are not subject to the support SLA of official GA features.
|
|
34
33
|
#
|
|
35
34
|
# @option arguments [String] :name The name of the search application to render teh query for. (*Required*)
|
|
36
35
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
@@ -96,11 +96,18 @@ module Elasticsearch
|
|
|
96
96
|
# Elasticsearch uses the H3 resolution that is closest to the corresponding geotile density.
|
|
97
97
|
# Learn how to use the vector tile search API with practical examples in the {https://www.elastic.co/docs/reference/elasticsearch/rest-apis/vector-tile-search Vector tile search examples} guide.
|
|
98
98
|
#
|
|
99
|
-
# @option arguments [String, Array] :index
|
|
100
|
-
#
|
|
101
|
-
#
|
|
102
|
-
#
|
|
103
|
-
# @option arguments [
|
|
99
|
+
# @option arguments [String, Array] :index A list of indices, data streams, or aliases to search.
|
|
100
|
+
# It supports wildcards (`*`).
|
|
101
|
+
# To search all data streams and indices, omit this parameter or use `*` or `_all`.
|
|
102
|
+
# To search a remote cluster, use the `<cluster>:<target>` syntax. (*Required*)
|
|
103
|
+
# @option arguments [String] :field A field that contains the geospatial data to return.
|
|
104
|
+
# It must be a `geo_point` or `geo_shape` field.
|
|
105
|
+
# The field must have doc values enabled. It cannot be a nested field.NOTE: Vector tiles do not natively support geometry collections.
|
|
106
|
+
# For `geometrycollection` values in a `geo_shape` field, the API returns a hits layer feature for each element of the collection.
|
|
107
|
+
# This behavior may change in a future release. (*Required*)
|
|
108
|
+
# @option arguments [Integer] :zoom The zoom level of the vector tile to search. It accepts `0` to `29`. (*Required*)
|
|
109
|
+
# @option arguments [Integer] :x The X coordinate for the vector tile to search. (*Required*)
|
|
110
|
+
# @option arguments [Integer] :y The Y coordinate for the vector tile to search. (*Required*)
|
|
104
111
|
# @option arguments [Boolean] :exact_bounds If `false`, the meta layer's feature is the bounding box of the tile.
|
|
105
112
|
# If true, the meta layer's feature is a bounding box resulting from a
|
|
106
113
|
# geo_bounds aggregation. The aggregation runs on <field> values that intersect
|
|
@@ -43,7 +43,7 @@ module Elasticsearch
|
|
|
43
43
|
# IT can also be set to `-1` to indicate that the request should never timeout. Server default: 30s.
|
|
44
44
|
# @option arguments [String] :preference The node or shard the operation should be performed on.
|
|
45
45
|
# It is random by default.
|
|
46
|
-
# @option arguments [String] :routing A custom value used to route operations to a specific shard.
|
|
46
|
+
# @option arguments [String, Array<String>] :routing A custom value used to route operations to a specific shard.
|
|
47
47
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
48
48
|
# when they occur.
|
|
49
49
|
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
@@ -31,7 +31,7 @@ module Elasticsearch
|
|
|
31
31
|
# @option arguments [Boolean] :ccs_minimize_roundtrips If `true`, network round-trips are minimized for cross-cluster search requests.
|
|
32
32
|
# @option arguments [String, Array<String>] :expand_wildcards The type of index that wildcard patterns can match.
|
|
33
33
|
# If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
|
|
34
|
-
# Supports comma-separated values, such as `open,hidden`.
|
|
34
|
+
# Supports comma-separated values, such as `open,hidden`. Server default: open.
|
|
35
35
|
# @option arguments [Boolean] :explain If `true`, the response includes additional details about score computation as part of a hit.
|
|
36
36
|
# @option arguments [Boolean] :ignore_throttled If `true`, specified concrete, expanded, or aliased indices are not included in the response when throttled. Server default: true.
|
|
37
37
|
# @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index.
|
|
@@ -46,7 +46,7 @@ module Elasticsearch
|
|
|
46
46
|
# _alias:_origin
|
|
47
47
|
# _alias:*pr*
|
|
48
48
|
# Supported in serverless only.
|
|
49
|
-
# @option arguments [String] :routing A custom value used to route operations to a specific shard.
|
|
49
|
+
# @option arguments [String, Array<String>] :routing A custom value used to route operations to a specific shard.
|
|
50
50
|
# @option arguments [Time] :scroll Specifies how long a consistent view of the index
|
|
51
51
|
# should be maintained for scrolled search.
|
|
52
52
|
# @option arguments [String] :search_type The type of the search operation.
|
|
@@ -24,10 +24,9 @@ module Elasticsearch
|
|
|
24
24
|
module Actions
|
|
25
25
|
# Get cache statistics.
|
|
26
26
|
# Get statistics about the shared cache for partially mounted indices.
|
|
27
|
-
# This functionality is
|
|
28
|
-
#
|
|
29
|
-
#
|
|
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, Array] :node_id The names of the nodes in the cluster to target.
|
|
33
32
|
# @option arguments [Time] :master_timeout [TODO]
|
|
@@ -24,15 +24,15 @@ module Elasticsearch
|
|
|
24
24
|
module Actions
|
|
25
25
|
# Clear the cache.
|
|
26
26
|
# Clear indices and data streams from the shared cache for partially mounted indices.
|
|
27
|
-
# This functionality is
|
|
28
|
-
#
|
|
29
|
-
#
|
|
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, Array] :index A comma-separated list of data streams, indices, and aliases to clear from the cache.
|
|
33
32
|
# It supports wildcards (`*`).
|
|
34
|
-
# @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
|
|
35
|
-
# @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices.
|
|
33
|
+
# @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both Server default: open.
|
|
34
|
+
# @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices.
|
|
35
|
+
# (This includes `_all` string or when no indices have been specified)
|
|
36
36
|
# @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
|
37
37
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
38
38
|
# when they occur.
|
|
@@ -26,7 +26,7 @@ module Elasticsearch
|
|
|
26
26
|
# Evict privileges from the native application privilege cache.
|
|
27
27
|
# The cache is also automatically cleared for applications that have their privileges updated.
|
|
28
28
|
#
|
|
29
|
-
# @option arguments [String] :application A comma-separated list of applications.
|
|
29
|
+
# @option arguments [String, Array<String>] :application A comma-separated list of applications.
|
|
30
30
|
# To clear all applications, use an asterism (`*`).
|
|
31
31
|
# It does not support other wildcard patterns. (*Required*)
|
|
32
32
|
# @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
|
# If omitted, a random name will be generated.Token names must be at least one and no more than 256 characters.
|
|
34
34
|
# They can contain alphanumeric characters (a-z, A-Z, 0-9), dashes (`-`), and underscores (`_`), but cannot begin with an underscore.NOTE: Token names must be unique in the context of the associated service account.
|
|
35
35
|
# They must also be globally unique with their fully qualified names, which are comprised of the service account principal and token name, such as `<namespace>/<service>/<token-name>`.
|
|
36
|
-
# @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for`
|
|
36
|
+
# @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.
|
|
37
37
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
38
38
|
# when they occur.
|
|
39
39
|
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
@@ -28,7 +28,7 @@ module Elasticsearch
|
|
|
28
28
|
# @option arguments [String] :namespace The namespace, which is a top-level grouping of service accounts. (*Required*)
|
|
29
29
|
# @option arguments [String] :service The service name. (*Required*)
|
|
30
30
|
# @option arguments [String] :name The name of the service account token. (*Required*)
|
|
31
|
-
# @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for`
|
|
31
|
+
# @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.
|
|
32
32
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
33
33
|
# when they occur.
|
|
34
34
|
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
@@ -35,10 +35,9 @@ module Elasticsearch
|
|
|
35
35
|
# By default, the pipeline definitions that are currently in the system are used.
|
|
36
36
|
# However, you can supply substitute pipeline definitions in the body of the request.
|
|
37
37
|
# These will be used in place of the pipeline definitions that are already in the system. This can be used to replace existing pipeline definitions or to create new ones. The pipeline substitutions are used only within this request.
|
|
38
|
-
# This functionality is
|
|
39
|
-
#
|
|
40
|
-
#
|
|
41
|
-
# support SLA of official GA features.
|
|
38
|
+
# This functionality is in technical preview and may be changed or removed in a future
|
|
39
|
+
# release. Elastic will apply best effort to fix any issues, but features in technical
|
|
40
|
+
# preview are not subject to the support SLA of official GA features.
|
|
42
41
|
#
|
|
43
42
|
# @option arguments [String] :index The index to simulate ingesting into.
|
|
44
43
|
# This value can be overridden by specifying an index on each document.
|
|
@@ -25,7 +25,7 @@ module Elasticsearch
|
|
|
25
25
|
# Delete snapshots.
|
|
26
26
|
#
|
|
27
27
|
# @option arguments [String] :repository The name of the repository to delete a snapshot from. (*Required*)
|
|
28
|
-
# @option arguments [String] :snapshot A comma-separated list of snapshot names to delete.
|
|
28
|
+
# @option arguments [String, Array<String>] :snapshot A comma-separated list of snapshot names to delete.
|
|
29
29
|
# It also accepts wildcards (`*`). (*Required*)
|
|
30
30
|
# @option arguments [Time] :master_timeout The period to wait for the master node.
|
|
31
31
|
# If the master node is not available before the timeout expires, the request fails and returns an error.
|
|
@@ -48,10 +48,9 @@ module Elasticsearch
|
|
|
48
48
|
# For large repositories, consider setting up a separate single-node Elasticsearch cluster just for running the integrity verification API.
|
|
49
49
|
# The response exposes implementation details of the analysis which may change from version to version.
|
|
50
50
|
# The response body format is therefore not considered stable and may be different in newer versions.
|
|
51
|
-
# This functionality is
|
|
52
|
-
#
|
|
53
|
-
#
|
|
54
|
-
# support SLA of official GA features.
|
|
51
|
+
# This functionality is in technical preview and may be changed or removed in a future
|
|
52
|
+
# release. Elastic will apply best effort to fix any issues, but features in technical
|
|
53
|
+
# preview are not subject to the support SLA of official GA features.
|
|
55
54
|
#
|
|
56
55
|
# @option arguments [String, Array<String>] :repository The name of the snapshot repository. (*Required*)
|
|
57
56
|
# @option arguments [Integer] :blob_thread_pool_concurrency If `verify_blob_contents` is `true`, this parameter specifies how many blobs to verify at once. Server default: 1.
|
|
@@ -25,7 +25,7 @@ module Elasticsearch
|
|
|
25
25
|
# Get policy information.
|
|
26
26
|
# Get snapshot lifecycle policy definitions and information about the latest snapshot attempts.
|
|
27
27
|
#
|
|
28
|
-
# @option arguments [String, Array<String>] :policy_id
|
|
28
|
+
# @option arguments [String, Array<String>] :policy_id A comma-separated list of snapshot lifecycle policy identifiers.
|
|
29
29
|
# @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
|
|
30
30
|
# If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
|
|
31
31
|
# @option arguments [Time] :timeout The period to wait for a response.
|
|
@@ -28,14 +28,6 @@ module Elasticsearch
|
|
|
28
28
|
# @option arguments [String] :format The format for the response.
|
|
29
29
|
# You can also specify a format using the `Accept` HTTP header.
|
|
30
30
|
# If you specify both this parameter and the `Accept` HTTP header, this parameter takes precedence.
|
|
31
|
-
# @option arguments [String] :project_routing Specifies a subset of projects to target for the search using project
|
|
32
|
-
# metadata tags in a subset of Lucene query syntax.
|
|
33
|
-
# Allowed Lucene queries: the _alias tag and a single value (possibly wildcarded).
|
|
34
|
-
# Examples:
|
|
35
|
-
# _alias:my-project
|
|
36
|
-
# _alias:_origin
|
|
37
|
-
# _alias:*pr*
|
|
38
|
-
# Supported in serverless only.
|
|
39
31
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
40
32
|
# when they occur.
|
|
41
33
|
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
@@ -24,10 +24,9 @@ module Elasticsearch
|
|
|
24
24
|
module Actions
|
|
25
25
|
# Disable logs stream.
|
|
26
26
|
# Turn off the logs stream feature for this cluster.
|
|
27
|
-
# This functionality is
|
|
28
|
-
#
|
|
29
|
-
#
|
|
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 [Time] :master_timeout The period to wait for a connection to the master node.
|
|
33
32
|
# If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
|
|
@@ -27,10 +27,9 @@ module Elasticsearch
|
|
|
27
27
|
# NOTE: To protect existing data, this feature can be turned on only if the
|
|
28
28
|
# cluster does not have existing indices or data streams that match the pattern `logs|logs.*`.
|
|
29
29
|
# If those indices or data streams exist, a `409 - Conflict` response and error is returned.
|
|
30
|
-
# This functionality is
|
|
31
|
-
#
|
|
32
|
-
#
|
|
33
|
-
# support SLA of official GA features.
|
|
30
|
+
# This functionality is in technical preview and may be changed or removed in a future
|
|
31
|
+
# release. Elastic will apply best effort to fix any issues, but features in technical
|
|
32
|
+
# preview are not subject to the support SLA of official GA features.
|
|
34
33
|
#
|
|
35
34
|
# @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
|
|
36
35
|
# If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
|
|
@@ -24,10 +24,9 @@ module Elasticsearch
|
|
|
24
24
|
module Actions
|
|
25
25
|
# Get the status of streams.
|
|
26
26
|
# Get the current status for all types of streams.
|
|
27
|
-
# This functionality is
|
|
28
|
-
#
|
|
29
|
-
#
|
|
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 [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.
|
|
33
32
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|