elasticsearch-api 9.4.0 → 9.4.2
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/lib/elasticsearch/api/actions/cancel_reindex.rb +4 -3
- data/lib/elasticsearch/api/actions/cat/tasks.rb +4 -3
- data/lib/elasticsearch/api/actions/connector/check_in.rb +4 -3
- data/lib/elasticsearch/api/actions/connector/delete.rb +4 -4
- data/lib/elasticsearch/api/actions/connector/get.rb +4 -4
- data/lib/elasticsearch/api/actions/connector/list.rb +4 -4
- data/lib/elasticsearch/api/actions/connector/post.rb +4 -4
- data/lib/elasticsearch/api/actions/connector/put.rb +4 -4
- data/lib/elasticsearch/api/actions/connector/sync_job_cancel.rb +4 -4
- data/lib/elasticsearch/api/actions/connector/sync_job_check_in.rb +4 -3
- data/lib/elasticsearch/api/actions/connector/sync_job_claim.rb +4 -3
- data/lib/elasticsearch/api/actions/connector/sync_job_delete.rb +4 -4
- data/lib/elasticsearch/api/actions/connector/sync_job_error.rb +4 -3
- data/lib/elasticsearch/api/actions/connector/sync_job_get.rb +4 -4
- data/lib/elasticsearch/api/actions/connector/sync_job_list.rb +4 -4
- data/lib/elasticsearch/api/actions/connector/sync_job_post.rb +4 -4
- data/lib/elasticsearch/api/actions/connector/sync_job_update_stats.rb +4 -3
- data/lib/elasticsearch/api/actions/connector/update_active_filtering.rb +4 -3
- data/lib/elasticsearch/api/actions/connector/update_api_key_id.rb +4 -4
- data/lib/elasticsearch/api/actions/connector/update_configuration.rb +4 -4
- data/lib/elasticsearch/api/actions/connector/update_error.rb +4 -3
- data/lib/elasticsearch/api/actions/connector/update_features.rb +4 -3
- data/lib/elasticsearch/api/actions/connector/update_filtering.rb +4 -4
- data/lib/elasticsearch/api/actions/connector/update_filtering_validation.rb +4 -3
- data/lib/elasticsearch/api/actions/connector/update_index_name.rb +4 -4
- data/lib/elasticsearch/api/actions/connector/update_name.rb +4 -4
- data/lib/elasticsearch/api/actions/connector/update_native.rb +4 -4
- data/lib/elasticsearch/api/actions/connector/update_pipeline.rb +4 -4
- data/lib/elasticsearch/api/actions/connector/update_scheduling.rb +4 -4
- data/lib/elasticsearch/api/actions/connector/update_service_type.rb +4 -4
- data/lib/elasticsearch/api/actions/connector/update_status.rb +4 -3
- data/lib/elasticsearch/api/actions/esql/delete_view.rb +5 -4
- data/lib/elasticsearch/api/actions/esql/get_query.rb +4 -3
- data/lib/elasticsearch/api/actions/esql/get_view.rb +4 -3
- data/lib/elasticsearch/api/actions/esql/list_queries.rb +4 -3
- data/lib/elasticsearch/api/actions/esql/put_view.rb +4 -3
- data/lib/elasticsearch/api/actions/features/reset_features.rb +4 -3
- data/lib/elasticsearch/api/actions/fleet/msearch.rb +4 -3
- data/lib/elasticsearch/api/actions/fleet/search.rb +4 -3
- data/lib/elasticsearch/api/actions/get_reindex.rb +4 -3
- data/lib/elasticsearch/api/actions/indices/disk_usage.rb +4 -3
- data/lib/elasticsearch/api/actions/indices/field_usage_stats.rb +4 -3
- data/lib/elasticsearch/api/actions/indices/split.rb +1 -0
- data/lib/elasticsearch/api/actions/inference/embedding.rb +4 -3
- data/lib/elasticsearch/api/actions/inference/stream_completion.rb +1 -1
- data/lib/elasticsearch/api/actions/list_reindex.rb +4 -3
- data/lib/elasticsearch/api/actions/nodes/clear_repositories_metering_archive.rb +4 -3
- data/lib/elasticsearch/api/actions/nodes/get_repositories_metering_info.rb +4 -3
- data/lib/elasticsearch/api/actions/project/create_many_routing.rb +4 -3
- data/lib/elasticsearch/api/actions/project/create_routing.rb +4 -3
- data/lib/elasticsearch/api/actions/project/delete_routing.rb +4 -3
- data/lib/elasticsearch/api/actions/project/get_many_routing.rb +4 -3
- data/lib/elasticsearch/api/actions/project/get_routing.rb +4 -3
- data/lib/elasticsearch/api/actions/project/tags.rb +4 -3
- data/lib/elasticsearch/api/actions/reindex.rb +2 -1
- data/lib/elasticsearch/api/actions/scripts_painless_execute.rb +4 -3
- data/lib/elasticsearch/api/actions/search_application/delete.rb +4 -4
- data/lib/elasticsearch/api/actions/search_application/delete_behavioral_analytics.rb +4 -3
- data/lib/elasticsearch/api/actions/search_application/get.rb +4 -4
- data/lib/elasticsearch/api/actions/search_application/get_behavioral_analytics.rb +4 -3
- data/lib/elasticsearch/api/actions/search_application/list.rb +4 -4
- data/lib/elasticsearch/api/actions/search_application/post_behavioral_analytics_event.rb +4 -3
- data/lib/elasticsearch/api/actions/search_application/put.rb +4 -4
- data/lib/elasticsearch/api/actions/search_application/put_behavioral_analytics.rb +4 -3
- data/lib/elasticsearch/api/actions/search_application/render_query.rb +4 -3
- data/lib/elasticsearch/api/actions/search_application/search.rb +4 -4
- data/lib/elasticsearch/api/actions/searchable_snapshots/cache_stats.rb +4 -3
- data/lib/elasticsearch/api/actions/searchable_snapshots/clear_cache.rb +4 -3
- data/lib/elasticsearch/api/actions/security/clone_api_key.rb +4 -3
- data/lib/elasticsearch/api/actions/simulate/ingest.rb +4 -3
- data/lib/elasticsearch/api/actions/snapshot/repository_verify_integrity.rb +4 -3
- data/lib/elasticsearch/api/actions/streams/logs_disable.rb +4 -3
- data/lib/elasticsearch/api/actions/streams/logs_enable.rb +4 -3
- data/lib/elasticsearch/api/actions/streams/status.rb +4 -3
- data/lib/elasticsearch/api/actions/tasks/cancel.rb +4 -3
- data/lib/elasticsearch/api/actions/tasks/get.rb +4 -3
- data/lib/elasticsearch/api/actions/tasks/list.rb +4 -3
- data/lib/elasticsearch/api/utils.rb +1 -1
- data/lib/elasticsearch/api/version.rb +2 -2
- metadata +2 -2
|
@@ -26,9 +26,10 @@ module Elasticsearch
|
|
|
26
26
|
#
|
|
27
27
|
# This API is only available behind a feature flag: `esql_views`.
|
|
28
28
|
#
|
|
29
|
-
# This functionality is
|
|
30
|
-
#
|
|
31
|
-
#
|
|
29
|
+
# This functionality is experimental and is not ready for production usage. Experimental
|
|
30
|
+
# features may change or be removed at any time. Elastic will work to fix any issues, but
|
|
31
|
+
# experimental features are not subject to the support SLA of official GA features. Specific
|
|
32
|
+
# Support terms apply.
|
|
32
33
|
#
|
|
33
34
|
# @option arguments [String] :name The view name to create or update. (*Required*)
|
|
34
35
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
@@ -33,9 +33,10 @@ 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
|
|
37
|
-
#
|
|
38
|
-
#
|
|
36
|
+
# This functionality is experimental and is not ready for production usage. Experimental
|
|
37
|
+
# features may change or be removed at any time. Elastic will work to fix any issues, but
|
|
38
|
+
# experimental features are not subject to the support SLA of official GA features. Specific
|
|
39
|
+
# Support terms apply.
|
|
39
40
|
#
|
|
40
41
|
# @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
|
|
41
42
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
@@ -26,9 +26,10 @@ 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
|
|
30
|
-
#
|
|
31
|
-
#
|
|
29
|
+
# This functionality is experimental and is not ready for production usage. Experimental
|
|
30
|
+
# features may change or be removed at any time. Elastic will work to fix any issues, but
|
|
31
|
+
# experimental features are not subject to the support SLA of official GA features. Specific
|
|
32
|
+
# Support terms apply.
|
|
32
33
|
#
|
|
33
34
|
# @option arguments [String] :index A single target to search. If the target is an index alias, it must resolve to a single index.
|
|
34
35
|
# @option arguments [Boolean] :allow_no_indices A setting that does two separate checks on the index expression.
|
|
@@ -25,9 +25,10 @@ module Elasticsearch
|
|
|
25
25
|
# Run a Fleet search.
|
|
26
26
|
# The purpose of the Fleet search API is to provide an API where the search will be run only
|
|
27
27
|
# after the provided checkpoint has been processed and is visible for searches inside of Elasticsearch.
|
|
28
|
-
# This functionality is
|
|
29
|
-
#
|
|
30
|
-
#
|
|
28
|
+
# This functionality is experimental and is not ready for production usage. Experimental
|
|
29
|
+
# features may change or be removed at any time. Elastic will work to fix any issues, but
|
|
30
|
+
# experimental features are not subject to the support SLA of official GA features. Specific
|
|
31
|
+
# Support terms apply.
|
|
31
32
|
#
|
|
32
33
|
# @option arguments [String] :index A single target to search. If the target is an index alias, it must resolve to a single index. (*Required*)
|
|
33
34
|
# @option arguments [Boolean] :allow_no_indices A setting that does two separate checks on the index expression.
|
|
@@ -26,9 +26,10 @@ module Elasticsearch
|
|
|
26
26
|
#
|
|
27
27
|
# This API is only available behind a feature flag: `reindex_management_api`.
|
|
28
28
|
#
|
|
29
|
-
# This functionality is
|
|
30
|
-
#
|
|
31
|
-
#
|
|
29
|
+
# This functionality is experimental and is not ready for production usage. Experimental
|
|
30
|
+
# features may change or be removed at any time. Elastic will work to fix any issues, but
|
|
31
|
+
# experimental features are not subject to the support SLA of official GA features. Specific
|
|
32
|
+
# Support terms apply.
|
|
32
33
|
#
|
|
33
34
|
# @option arguments [String] :task_id The ID of the reindex task to retrieve. (*Required*)
|
|
34
35
|
# @option arguments [Boolean] :wait_for_completion If `true`, the request blocks until the reindex task completes, then returns the result.
|
|
@@ -30,9 +30,10 @@ module Elasticsearch
|
|
|
30
30
|
# Since stored fields are stored together in a compressed format, the sizes of stored fields are also estimates and can be inaccurate.
|
|
31
31
|
# The stored size of the `_id` field is likely underestimated while the `_source` field is overestimated.
|
|
32
32
|
# For usage examples see the External documentation or refer to {https://www.elastic.co/docs/reference/elasticsearch/rest-apis/index-disk-usage Analyze the index disk usage example} for an example.
|
|
33
|
-
# This functionality is
|
|
34
|
-
#
|
|
35
|
-
#
|
|
33
|
+
# This functionality is experimental and is not ready for production usage. Experimental
|
|
34
|
+
# features may change or be removed at any time. Elastic will work to fix any issues, but
|
|
35
|
+
# experimental features are not subject to the support SLA of official GA features. Specific
|
|
36
|
+
# Support terms apply.
|
|
36
37
|
#
|
|
37
38
|
# @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases used to limit the request.
|
|
38
39
|
# It’s recommended to execute this API with a single index (or the latest backing index of a data stream) as the API consumes resources significantly. (*Required*)
|
|
@@ -28,9 +28,10 @@ module Elasticsearch
|
|
|
28
28
|
# A shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use.
|
|
29
29
|
# The response body reports the per-shard usage count of the data structures that back the fields in the index.
|
|
30
30
|
# A given request will increment each count by a maximum value of 1, even if the request accesses the same field multiple times.
|
|
31
|
-
# This functionality is
|
|
32
|
-
#
|
|
33
|
-
#
|
|
31
|
+
# This functionality is experimental and is not ready for production usage. Experimental
|
|
32
|
+
# features may change or be removed at any time. Elastic will work to fix any issues, but
|
|
33
|
+
# experimental features are not subject to the support SLA of official GA features. Specific
|
|
34
|
+
# Support terms apply.
|
|
34
35
|
#
|
|
35
36
|
# @option arguments [String, Array] :index Comma-separated list or wildcard expression of index names used to limit the request. (*Required*)
|
|
36
37
|
# @option arguments [Boolean] :allow_no_indices A setting that does two separate checks on the index expression.
|
|
@@ -47,6 +47,7 @@ module Elasticsearch
|
|
|
47
47
|
# * The target index must not exist.
|
|
48
48
|
# * The source index must have fewer primary shards than the target index.
|
|
49
49
|
# * The number of primary shards in the target index must be a multiple of the number of primary shards in the source index.
|
|
50
|
+
# * The number of primary shards in the target index must be a divisor of the source index's `index.number_of_routing_shards`.
|
|
50
51
|
# * The node handling the split process must have sufficient free disk space to accommodate a second copy of the existing index.
|
|
51
52
|
#
|
|
52
53
|
# @option arguments [String] :index Name of the source index to split. (*Required*)
|
|
@@ -23,9 +23,10 @@ module Elasticsearch
|
|
|
23
23
|
module Inference
|
|
24
24
|
module Actions
|
|
25
25
|
# Perform dense embedding inference on the service.
|
|
26
|
-
# This functionality is
|
|
27
|
-
#
|
|
28
|
-
#
|
|
26
|
+
# This functionality is experimental and is not ready for production usage. Experimental
|
|
27
|
+
# features may change or be removed at any time. Elastic will work to fix any issues, but
|
|
28
|
+
# experimental features are not subject to the support SLA of official GA features. Specific
|
|
29
|
+
# Support terms apply.
|
|
29
30
|
#
|
|
30
31
|
# @option arguments [String] :inference_id The inference Id (*Required*)
|
|
31
32
|
# @option arguments [Time] :timeout Specifies the amount of time to wait for the inference request to complete. Server default: 30s.
|
|
@@ -44,7 +44,7 @@ module Elasticsearch
|
|
|
44
44
|
# @option arguments [Hash] :headers Custom HTTP headers
|
|
45
45
|
# @option arguments [Hash] :body request body
|
|
46
46
|
#
|
|
47
|
-
# @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation-inference-stream-
|
|
47
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-stream-completion
|
|
48
48
|
#
|
|
49
49
|
def stream_completion(arguments = {})
|
|
50
50
|
request_opts = { endpoint: arguments[:endpoint] || 'inference.stream_completion' }
|
|
@@ -26,9 +26,10 @@ module Elasticsearch
|
|
|
26
26
|
#
|
|
27
27
|
# This API is only available behind a feature flag: `reindex_management_api`.
|
|
28
28
|
#
|
|
29
|
-
# This functionality is
|
|
30
|
-
#
|
|
31
|
-
#
|
|
29
|
+
# This functionality is experimental and is not ready for production usage. Experimental
|
|
30
|
+
# features may change or be removed at any time. Elastic will work to fix any issues, but
|
|
31
|
+
# experimental features are not subject to the support SLA of official GA features. Specific
|
|
32
|
+
# Support terms apply.
|
|
32
33
|
#
|
|
33
34
|
# @option arguments [Boolean] :detailed If `true`, include detailed task status information in the response.
|
|
34
35
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
@@ -24,9 +24,10 @@ 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
|
-
#
|
|
27
|
+
# This functionality is experimental and is not ready for production usage. Experimental
|
|
28
|
+
# features may change or be removed at any time. Elastic will work to fix any issues, but
|
|
29
|
+
# experimental features are not subject to the support SLA of official GA features. Specific
|
|
30
|
+
# Support terms apply.
|
|
30
31
|
#
|
|
31
32
|
# @option arguments [String, Array] :node_id Comma-separated list of node IDs or names used to limit returned information. (*Required*)
|
|
32
33
|
# @option arguments [Integer] :max_archive_version Specifies the maximum `archive_version` to be cleared from the archive. (*Required*)
|
|
@@ -26,9 +26,10 @@ 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
|
-
#
|
|
29
|
+
# This functionality is experimental and is not ready for production usage. Experimental
|
|
30
|
+
# features may change or be removed at any time. Elastic will work to fix any issues, but
|
|
31
|
+
# experimental features are not subject to the support SLA of official GA features. Specific
|
|
32
|
+
# Support terms apply.
|
|
32
33
|
#
|
|
33
34
|
# @option arguments [String, Array] :node_id Comma-separated list of node IDs or names used to limit returned information. (*Required*)
|
|
34
35
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
@@ -26,9 +26,10 @@ module Elasticsearch
|
|
|
26
26
|
#
|
|
27
27
|
# This API is only available in Serverless.
|
|
28
28
|
#
|
|
29
|
-
# This functionality is
|
|
30
|
-
#
|
|
31
|
-
#
|
|
29
|
+
# This functionality is experimental and is not ready for production usage. Experimental
|
|
30
|
+
# features may change or be removed at any time. Elastic will work to fix any issues, but
|
|
31
|
+
# experimental features are not subject to the support SLA of official GA features. Specific
|
|
32
|
+
# Support terms apply.
|
|
32
33
|
#
|
|
33
34
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
34
35
|
# when they occur.
|
|
@@ -26,9 +26,10 @@ module Elasticsearch
|
|
|
26
26
|
#
|
|
27
27
|
# This API is only available in Serverless.
|
|
28
28
|
#
|
|
29
|
-
# This functionality is
|
|
30
|
-
#
|
|
31
|
-
#
|
|
29
|
+
# This functionality is experimental and is not ready for production usage. Experimental
|
|
30
|
+
# features may change or be removed at any time. Elastic will work to fix any issues, but
|
|
31
|
+
# experimental features are not subject to the support SLA of official GA features. Specific
|
|
32
|
+
# Support terms apply.
|
|
32
33
|
#
|
|
33
34
|
# @option arguments [String] :name The name of project routing expression (*Required*)
|
|
34
35
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
@@ -26,9 +26,10 @@ module Elasticsearch
|
|
|
26
26
|
#
|
|
27
27
|
# This API is only available in Serverless.
|
|
28
28
|
#
|
|
29
|
-
# This functionality is
|
|
30
|
-
#
|
|
31
|
-
#
|
|
29
|
+
# This functionality is experimental and is not ready for production usage. Experimental
|
|
30
|
+
# features may change or be removed at any time. Elastic will work to fix any issues, but
|
|
31
|
+
# experimental features are not subject to the support SLA of official GA features. Specific
|
|
32
|
+
# Support terms apply.
|
|
32
33
|
#
|
|
33
34
|
# @option arguments [String] :name The name of project routing expression (*Required*)
|
|
34
35
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
@@ -26,9 +26,10 @@ module Elasticsearch
|
|
|
26
26
|
#
|
|
27
27
|
# This API is only available in Serverless.
|
|
28
28
|
#
|
|
29
|
-
# This functionality is
|
|
30
|
-
#
|
|
31
|
-
#
|
|
29
|
+
# This functionality is experimental and is not ready for production usage. Experimental
|
|
30
|
+
# features may change or be removed at any time. Elastic will work to fix any issues, but
|
|
31
|
+
# experimental features are not subject to the support SLA of official GA features. Specific
|
|
32
|
+
# Support terms apply.
|
|
32
33
|
#
|
|
33
34
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
34
35
|
# when they occur.
|
|
@@ -26,9 +26,10 @@ module Elasticsearch
|
|
|
26
26
|
#
|
|
27
27
|
# This API is only available in Serverless.
|
|
28
28
|
#
|
|
29
|
-
# This functionality is
|
|
30
|
-
#
|
|
31
|
-
#
|
|
29
|
+
# This functionality is experimental and is not ready for production usage. Experimental
|
|
30
|
+
# features may change or be removed at any time. Elastic will work to fix any issues, but
|
|
31
|
+
# experimental features are not subject to the support SLA of official GA features. Specific
|
|
32
|
+
# Support terms apply.
|
|
32
33
|
#
|
|
33
34
|
# @option arguments [String] :name The name of project routing expression (*Required*)
|
|
34
35
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
@@ -27,9 +27,10 @@ module Elasticsearch
|
|
|
27
27
|
#
|
|
28
28
|
# This API is only available in Serverless.
|
|
29
29
|
#
|
|
30
|
-
# This functionality is
|
|
31
|
-
#
|
|
32
|
-
#
|
|
30
|
+
# This functionality is experimental and is not ready for production usage. Experimental
|
|
31
|
+
# features may change or be removed at any time. Elastic will work to fix any issues, but
|
|
32
|
+
# experimental features are not subject to the support SLA of official GA features. Specific
|
|
33
|
+
# Support terms apply.
|
|
33
34
|
#
|
|
34
35
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
35
36
|
# when they occur.
|
|
@@ -70,7 +70,8 @@ module Elasticsearch
|
|
|
70
70
|
# If there are multiple sources, it will choose the number of slices based on the index or backing index with the smallest number of shards. Server default: 1.
|
|
71
71
|
# @option arguments [Integer] :max_docs The maximum number of documents to reindex.
|
|
72
72
|
# By default, all documents are reindexed.
|
|
73
|
-
# If it is a value less then or equal to `scroll_size`, a scroll will not be used to retrieve the results for the operation.If `conflicts` is set to `proceed`, the reindex operation could attempt to reindex more documents from the source than `max_docs` until it has successfully indexed `max_docs` documents into the target or it has gone through every document in the source query.
|
|
73
|
+
# If it is a value less then or equal to `scroll_size`, a scroll will not be used to retrieve the results for the operation.If `conflicts` is set to `proceed`, the reindex operation could attempt to reindex more documents from the source than `max_docs` until it has successfully indexed `max_docs` documents into the target or it has gone through every document in the source query.If `slices` is set, the `max_docs` limit is split evenly across the slices.
|
|
74
|
+
# If the number of documents in the source is equal to or slightly more than `max_docs`, this could result in slightly fewer than `max_docs` documents being reindexed, due to skew in the slicing.
|
|
74
75
|
# @option arguments [Time] :timeout The period each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards.
|
|
75
76
|
# By default, Elasticsearch waits for at least one minute before failing.
|
|
76
77
|
# The actual wait time could be longer, particularly when multiple waits occur. Server default: 1m.
|
|
@@ -27,9 +27,10 @@ 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
|
-
#
|
|
30
|
+
# This functionality is experimental and is not ready for production usage. Experimental
|
|
31
|
+
# features may change or be removed at any time. Elastic will work to fix any issues, but
|
|
32
|
+
# experimental features are not subject to the support SLA of official GA features. Specific
|
|
33
|
+
# Support terms apply.
|
|
33
34
|
#
|
|
34
35
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
35
36
|
# when they occur.
|
|
@@ -24,10 +24,10 @@ module Elasticsearch
|
|
|
24
24
|
module Actions
|
|
25
25
|
# Delete a search application.
|
|
26
26
|
# Remove a search application and its associated alias. Indices attached to the search application are not removed.
|
|
27
|
-
# This functionality is in
|
|
28
|
-
# code is less mature than official GA features and is being
|
|
29
|
-
# as-is with no warranties. Beta features are not subject to the support
|
|
30
|
-
#
|
|
27
|
+
# This functionality is in beta and is not ready for production usage. For beta
|
|
28
|
+
# features, the design and code is less mature than official GA features and is being
|
|
29
|
+
# provided as-is with no warranties. Beta features are not subject to the support SLA of
|
|
30
|
+
# official GA features. Specific Support terms apply.
|
|
31
31
|
#
|
|
32
32
|
# @option arguments [String] :name The name of the search application to delete. (*Required*)
|
|
33
33
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
@@ -24,9 +24,10 @@ 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
|
-
#
|
|
27
|
+
# This functionality is experimental and is not ready for production usage. Experimental
|
|
28
|
+
# features may change or be removed at any time. Elastic will work to fix any issues, but
|
|
29
|
+
# experimental features are not subject to the support SLA of official GA features. Specific
|
|
30
|
+
# Support terms apply.
|
|
30
31
|
#
|
|
31
32
|
# @option arguments [String] :name The name of the analytics collection to be deleted (*Required*)
|
|
32
33
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
@@ -23,10 +23,10 @@ module Elasticsearch
|
|
|
23
23
|
module SearchApplication
|
|
24
24
|
module Actions
|
|
25
25
|
# Get search application details.
|
|
26
|
-
# This functionality is in
|
|
27
|
-
# code is less mature than official GA features and is being
|
|
28
|
-
# as-is with no warranties. Beta features are not subject to the support
|
|
29
|
-
#
|
|
26
|
+
# This functionality is in beta and is not ready for production usage. For beta
|
|
27
|
+
# features, the design and code is less mature than official GA features and is being
|
|
28
|
+
# provided as-is with no warranties. Beta features are not subject to the support SLA of
|
|
29
|
+
# official GA features. Specific Support terms apply.
|
|
30
30
|
#
|
|
31
31
|
# @option arguments [String] :name The name of the search application (*Required*)
|
|
32
32
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
@@ -23,9 +23,10 @@ module Elasticsearch
|
|
|
23
23
|
module SearchApplication
|
|
24
24
|
module Actions
|
|
25
25
|
# Get behavioral analytics collections.
|
|
26
|
-
# This functionality is
|
|
27
|
-
#
|
|
28
|
-
#
|
|
26
|
+
# This functionality is experimental and is not ready for production usage. Experimental
|
|
27
|
+
# features may change or be removed at any time. Elastic will work to fix any issues, but
|
|
28
|
+
# experimental features are not subject to the support SLA of official GA features. Specific
|
|
29
|
+
# Support terms apply.
|
|
29
30
|
#
|
|
30
31
|
# @option arguments [Array<String>] :name A list of analytics collections to limit the returned information
|
|
31
32
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
@@ -24,10 +24,10 @@ module Elasticsearch
|
|
|
24
24
|
module Actions
|
|
25
25
|
# Get search applications.
|
|
26
26
|
# Get information about search applications.
|
|
27
|
-
# This functionality is in
|
|
28
|
-
# code is less mature than official GA features and is being
|
|
29
|
-
# as-is with no warranties. Beta features are not subject to the support
|
|
30
|
-
#
|
|
27
|
+
# This functionality is in beta and is not ready for production usage. For beta
|
|
28
|
+
# features, the design and code is less mature than official GA features and is being
|
|
29
|
+
# provided as-is with no warranties. Beta features are not subject to the support SLA of
|
|
30
|
+
# official GA features. Specific Support terms apply.
|
|
31
31
|
#
|
|
32
32
|
# @option arguments [String] :q Query in the Lucene query string syntax.
|
|
33
33
|
# @option arguments [Integer] :from Starting offset. Server default: 0.
|
|
@@ -23,9 +23,10 @@ module Elasticsearch
|
|
|
23
23
|
module SearchApplication
|
|
24
24
|
module Actions
|
|
25
25
|
# Create a behavioral analytics collection event.
|
|
26
|
-
# This functionality is
|
|
27
|
-
#
|
|
28
|
-
#
|
|
26
|
+
# This functionality is experimental and is not ready for production usage. Experimental
|
|
27
|
+
# features may change or be removed at any time. Elastic will work to fix any issues, but
|
|
28
|
+
# experimental features are not subject to the support SLA of official GA features. Specific
|
|
29
|
+
# Support terms apply.
|
|
29
30
|
#
|
|
30
31
|
# @option arguments [String] :collection_name The name of the behavioral analytics collection. (*Required*)
|
|
31
32
|
# @option arguments [String] :event_type The analytics event type. (*Required*)
|
|
@@ -23,10 +23,10 @@ module Elasticsearch
|
|
|
23
23
|
module SearchApplication
|
|
24
24
|
module Actions
|
|
25
25
|
# Create or update a search application.
|
|
26
|
-
# This functionality is in
|
|
27
|
-
# code is less mature than official GA features and is being
|
|
28
|
-
# as-is with no warranties. Beta features are not subject to the support
|
|
29
|
-
#
|
|
26
|
+
# This functionality is in beta and is not ready for production usage. For beta
|
|
27
|
+
# features, the design and code is less mature than official GA features and is being
|
|
28
|
+
# provided as-is with no warranties. Beta features are not subject to the support SLA of
|
|
29
|
+
# official GA features. Specific Support terms apply.
|
|
30
30
|
#
|
|
31
31
|
# @option arguments [String] :name The name of the search application to be created or updated. (*Required*)
|
|
32
32
|
# @option arguments [Boolean] :create If `true`, this request cannot replace or update existing Search Applications.
|
|
@@ -23,9 +23,10 @@ module Elasticsearch
|
|
|
23
23
|
module SearchApplication
|
|
24
24
|
module Actions
|
|
25
25
|
# Create a behavioral analytics collection.
|
|
26
|
-
# This functionality is
|
|
27
|
-
#
|
|
28
|
-
#
|
|
26
|
+
# This functionality is experimental and is not ready for production usage. Experimental
|
|
27
|
+
# features may change or be removed at any time. Elastic will work to fix any issues, but
|
|
28
|
+
# experimental features are not subject to the support SLA of official GA features. Specific
|
|
29
|
+
# Support terms apply.
|
|
29
30
|
#
|
|
30
31
|
# @option arguments [String] :name The name of the analytics collection to be created or updated. (*Required*)
|
|
31
32
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
@@ -27,9 +27,10 @@ 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
|
-
#
|
|
30
|
+
# This functionality is experimental and is not ready for production usage. Experimental
|
|
31
|
+
# features may change or be removed at any time. Elastic will work to fix any issues, but
|
|
32
|
+
# experimental features are not subject to the support SLA of official GA features. Specific
|
|
33
|
+
# Support terms apply.
|
|
33
34
|
#
|
|
34
35
|
# @option arguments [String] :name The name of the search application to render teh query for. (*Required*)
|
|
35
36
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
@@ -25,10 +25,10 @@ module Elasticsearch
|
|
|
25
25
|
# Run a search application search.
|
|
26
26
|
# Generate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template.
|
|
27
27
|
# Unspecified template parameters are assigned their default values if applicable.
|
|
28
|
-
# This functionality is in
|
|
29
|
-
# code is less mature than official GA features and is being
|
|
30
|
-
# as-is with no warranties. Beta features are not subject to the support
|
|
31
|
-
#
|
|
28
|
+
# This functionality is in beta and is not ready for production usage. For beta
|
|
29
|
+
# features, the design and code is less mature than official GA features and is being
|
|
30
|
+
# provided as-is with no warranties. Beta features are not subject to the support SLA of
|
|
31
|
+
# official GA features. Specific Support terms apply.
|
|
32
32
|
#
|
|
33
33
|
# @option arguments [String] :name The name of the search application to be searched. (*Required*)
|
|
34
34
|
# @option arguments [Boolean] :typed_keys Determines whether aggregation names are prefixed by their respective types in the response.
|
|
@@ -24,9 +24,10 @@ 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
|
-
#
|
|
27
|
+
# This functionality is experimental and is not ready for production usage. Experimental
|
|
28
|
+
# features may change or be removed at any time. Elastic will work to fix any issues, but
|
|
29
|
+
# experimental features are not subject to the support SLA of official GA features. Specific
|
|
30
|
+
# Support terms apply.
|
|
30
31
|
#
|
|
31
32
|
# @option arguments [String, Array] :node_id The names of the nodes in the cluster to target.
|
|
32
33
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
@@ -24,9 +24,10 @@ 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
|
-
#
|
|
27
|
+
# This functionality is experimental and is not ready for production usage. Experimental
|
|
28
|
+
# features may change or be removed at any time. Elastic will work to fix any issues, but
|
|
29
|
+
# experimental features are not subject to the support SLA of official GA features. Specific
|
|
30
|
+
# Support terms apply.
|
|
30
31
|
#
|
|
31
32
|
# @option arguments [String, Array] :index A comma-separated list of data streams, indices, and aliases to clear from the cache.
|
|
32
33
|
# It supports wildcards (`*`).
|
|
@@ -28,9 +28,10 @@ module Elasticsearch
|
|
|
28
28
|
# This is intended for applications (such as Kibana) that need to
|
|
29
29
|
# create API keys on behalf of a user using an existing API key credential,
|
|
30
30
|
# since derived API keys (API keys created by API keys) are not otherwise supported.
|
|
31
|
-
# This functionality is
|
|
32
|
-
#
|
|
33
|
-
#
|
|
31
|
+
# This functionality is experimental and is not ready for production usage. Experimental
|
|
32
|
+
# features may change or be removed at any time. Elastic will work to fix any issues, but
|
|
33
|
+
# experimental features are not subject to the support SLA of official GA features. Specific
|
|
34
|
+
# Support terms apply.
|
|
34
35
|
#
|
|
35
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.
|
|
36
37
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
@@ -35,9 +35,10 @@ 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
|
-
#
|
|
38
|
+
# This functionality is experimental and is not ready for production usage. Experimental
|
|
39
|
+
# features may change or be removed at any time. Elastic will work to fix any issues, but
|
|
40
|
+
# experimental features are not subject to the support SLA of official GA features. Specific
|
|
41
|
+
# Support terms apply.
|
|
41
42
|
#
|
|
42
43
|
# @option arguments [String] :index The index to simulate ingesting into.
|
|
43
44
|
# This value can be overridden by specifying an index on each document.
|
|
@@ -48,9 +48,10 @@ 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
|
-
#
|
|
51
|
+
# This functionality is experimental and is not ready for production usage. Experimental
|
|
52
|
+
# features may change or be removed at any time. Elastic will work to fix any issues, but
|
|
53
|
+
# experimental features are not subject to the support SLA of official GA features. Specific
|
|
54
|
+
# Support terms apply.
|
|
54
55
|
#
|
|
55
56
|
# @option arguments [String, Array<String>] :repository The name of the snapshot repository. (*Required*)
|
|
56
57
|
# @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.
|
|
@@ -24,9 +24,10 @@ module Elasticsearch
|
|
|
24
24
|
module Actions
|
|
25
25
|
# Disable a named stream.
|
|
26
26
|
# Turn off the named stream feature for this cluster.
|
|
27
|
-
# This functionality is
|
|
28
|
-
#
|
|
29
|
-
#
|
|
27
|
+
# This functionality is experimental and is not ready for production usage. Experimental
|
|
28
|
+
# features may change or be removed at any time. Elastic will work to fix any issues, but
|
|
29
|
+
# experimental features are not subject to the support SLA of official GA features. Specific
|
|
30
|
+
# Support terms apply.
|
|
30
31
|
#
|
|
31
32
|
# @option arguments [String] :name The stream type to disable. (*Required*)
|
|
32
33
|
# @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
|
|
@@ -28,9 +28,10 @@ module Elasticsearch
|
|
|
28
28
|
# existing indices or data streams that match the pattern `<name>|<name>.*` for the enabled stream
|
|
29
29
|
# type name. If those indices or data streams exist, a `409 - Conflict` response and error is
|
|
30
30
|
# returned.
|
|
31
|
-
# This functionality is
|
|
32
|
-
#
|
|
33
|
-
#
|
|
31
|
+
# This functionality is experimental and is not ready for production usage. Experimental
|
|
32
|
+
# features may change or be removed at any time. Elastic will work to fix any issues, but
|
|
33
|
+
# experimental features are not subject to the support SLA of official GA features. Specific
|
|
34
|
+
# Support terms apply.
|
|
34
35
|
#
|
|
35
36
|
# @option arguments [String] :name The stream type to enable. (*Required*)
|
|
36
37
|
# @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
|