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
|
@@ -86,7 +86,7 @@ module Elasticsearch
|
|
|
86
86
|
# If `false`, it does nothing with refreshes. Server default: false.
|
|
87
87
|
# @option arguments [Boolean] :require_alias If `true`, the destination must be an index alias.
|
|
88
88
|
# @option arguments [Boolean] :require_data_stream If `true`, the request's actions must target a data stream (existing or to be created).
|
|
89
|
-
# @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.
|
|
90
90
|
# @option arguments [Time] :timeout The period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.
|
|
91
91
|
# Elasticsearch waits for at least the specified timeout period before failing.
|
|
92
92
|
# The actual wait time could be longer, particularly when multiple waits occur.This parameter is useful for situations where the primary shard assigned to perform the operation might not be available when the operation runs.
|
|
@@ -33,7 +33,7 @@ module Elasticsearch
|
|
|
33
33
|
# NOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader.
|
|
34
34
|
# The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked.
|
|
35
35
|
#
|
|
36
|
-
# @option arguments [String] :index
|
|
36
|
+
# @option arguments [String] :index Name of the leader index for which specified follower retention leases should be removed (*Required*)
|
|
37
37
|
# @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
|
|
38
38
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
39
39
|
# when they occur.
|
|
@@ -28,7 +28,7 @@ module Elasticsearch
|
|
|
28
28
|
# Alternatively it could be paused due to replication that cannot be retried due to failures during following tasks.
|
|
29
29
|
# When this API returns, the follower index will resume fetching operations from the leader index.
|
|
30
30
|
#
|
|
31
|
-
# @option arguments [String] :index
|
|
31
|
+
# @option arguments [String] :index Name of the follow index to resume following (*Required*)
|
|
32
32
|
# @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
|
|
33
33
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
34
34
|
# when they occur.
|
|
@@ -27,9 +27,9 @@ module Elasticsearch
|
|
|
27
27
|
# For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.
|
|
28
28
|
#
|
|
29
29
|
# @option arguments [String] :index_uuid The UUID of the index to delete. Use the get dangling indices API to find the UUID. (*Required*)
|
|
30
|
-
# @option arguments [Boolean] :accept_data_loss This parameter must be set to true to acknowledge that it will no longer be possible to recove data from the dangling index.
|
|
31
|
-
# @option arguments [Time] :master_timeout
|
|
32
|
-
# @option arguments [Time] :timeout
|
|
30
|
+
# @option arguments [Boolean] :accept_data_loss This parameter must be set to true to acknowledge that it will no longer be possible to recove data from the dangling index.
|
|
31
|
+
# @option arguments [Time] :master_timeout The period to wait for a connection to the master node. Server default: 30s.
|
|
32
|
+
# @option arguments [Time] :timeout The period to wait for a response. Server default: 30s.
|
|
33
33
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
34
34
|
# when they occur.
|
|
35
35
|
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
@@ -28,9 +28,9 @@ module Elasticsearch
|
|
|
28
28
|
#
|
|
29
29
|
# @option arguments [String] :index_uuid The UUID of the index to import. Use the get dangling indices API to locate the UUID. (*Required*)
|
|
30
30
|
# @option arguments [Boolean] :accept_data_loss This parameter must be set to true to import a dangling index.
|
|
31
|
-
# Because Elasticsearch cannot know where the dangling index data came from or determine which shard copies are fresh and which are stale, it cannot guarantee that the imported data represents the latest state of the index when it was last in the cluster.
|
|
32
|
-
# @option arguments [Time] :master_timeout
|
|
33
|
-
# @option arguments [Time] :timeout
|
|
31
|
+
# Because Elasticsearch cannot know where the dangling index data came from or determine which shard copies are fresh and which are stale, it cannot guarantee that the imported data represents the latest state of the index when it was last in the cluster.
|
|
32
|
+
# @option arguments [Time] :master_timeout The period to wait for a connection to the master node. Server default: 30s.
|
|
33
|
+
# @option arguments [Time] :timeout The period to wait for a response. Server default: 30s.
|
|
34
34
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
35
35
|
# when they occur.
|
|
36
36
|
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
@@ -56,7 +56,7 @@ module Elasticsearch
|
|
|
56
56
|
# @option arguments [String] :refresh If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search.
|
|
57
57
|
# If `wait_for`, it waits for a refresh to make this operation visible to search.
|
|
58
58
|
# If `false`, it does nothing with refreshes. Server default: false.
|
|
59
|
-
# @option arguments [String] :routing A custom value used to route operations to a specific shard.
|
|
59
|
+
# @option arguments [String, Array<String>] :routing A custom value used to route operations to a specific shard.
|
|
60
60
|
# @option arguments [Time] :timeout The period to wait for active shards.This parameter is useful for situations where the primary shard assigned to perform the delete operation might not be available when the delete operation runs.
|
|
61
61
|
# Some reasons for this might be that the primary shard is currently recovering from a store or undergoing relocation.
|
|
62
62
|
# By default, the delete operation will wait on the primary shard to become available for up to 1 minute before failing and responding with an error. Server default: 1m.
|
|
@@ -115,7 +115,7 @@ module Elasticsearch
|
|
|
115
115
|
# @option arguments [Boolean] :request_cache If `true`, the request cache is used for this request.
|
|
116
116
|
# Defaults to the index-level setting.
|
|
117
117
|
# @option arguments [Float] :requests_per_second The throttle for this request in sub-requests per second. Server default: -1.
|
|
118
|
-
# @option arguments [String] :routing A custom value used to route operations to a specific shard.
|
|
118
|
+
# @option arguments [String, Array<String>] :routing A custom value used to route operations to a specific shard.
|
|
119
119
|
# @option arguments [String] :q A query in the Lucene query string syntax.
|
|
120
120
|
# @option arguments [Time] :scroll The period to retain the search context for scrolling.
|
|
121
121
|
# @option arguments [Integer] :scroll_size The size of the scroll request that powers the operation. Server default: 1000.
|
|
@@ -27,7 +27,7 @@ module Elasticsearch
|
|
|
27
27
|
#
|
|
28
28
|
# @option arguments [String] :task_id The ID for the task. (*Required*)
|
|
29
29
|
# @option arguments [Float] :requests_per_second The throttle for this request in sub-requests per second.
|
|
30
|
-
# To disable throttling, set it to `-1`.
|
|
30
|
+
# To disable throttling, set it to `-1`. (*Required*)
|
|
31
31
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
32
32
|
# when they occur.
|
|
33
33
|
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
@@ -26,8 +26,9 @@ module Elasticsearch
|
|
|
26
26
|
# Returns search results for an Event Query Language (EQL) query.
|
|
27
27
|
# EQL assumes each document in a data stream or index corresponds to an event.
|
|
28
28
|
#
|
|
29
|
-
# @option arguments [String, Array] :index
|
|
30
|
-
# @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices.
|
|
29
|
+
# @option arguments [String, Array] :index Comma-separated list of index names to scope the operation (*Required*)
|
|
30
|
+
# @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices.
|
|
31
|
+
# (This includes `_all` string or when no indices have been specified) Server default: true.
|
|
31
32
|
# @option arguments [Boolean] :allow_partial_search_results If true, returns partial results if there are shard failures. If false, returns an error with no partial results. Server default: true.
|
|
32
33
|
# @option arguments [Boolean] :allow_partial_sequence_results If true, sequence queries will return partial results in case of shard failures. If false, they will return no results at all.
|
|
33
34
|
# This flag has effect only if allow_partial_search_results is true.
|
|
@@ -36,14 +37,6 @@ module Elasticsearch
|
|
|
36
37
|
# @option arguments [Boolean] :ignore_unavailable If true, missing or closed indices are not included in the response. Server default: true.
|
|
37
38
|
# @option arguments [Time] :keep_alive Period for which the search and its results are stored on the cluster. Server default: 5d.
|
|
38
39
|
# @option arguments [Boolean] :keep_on_completion If true, the search and its results are stored on the cluster.
|
|
39
|
-
# @option arguments [String] :project_routing Specifies a subset of projects to target for the search using project
|
|
40
|
-
# metadata tags in a subset of Lucene query syntax.
|
|
41
|
-
# Allowed Lucene queries: the _alias tag and a single value (possibly wildcarded).
|
|
42
|
-
# Examples:
|
|
43
|
-
# _alias:my-project
|
|
44
|
-
# _alias:_origin
|
|
45
|
-
# _alias:*pr*
|
|
46
|
-
# Supported in serverless only.
|
|
47
40
|
# @option arguments [Time] :wait_for_completion_timeout Timeout duration to wait for the request to finish. Defaults to no timeout, meaning the request waits for complete search results.
|
|
48
41
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
49
42
|
# when they occur.
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
# Licensed to Elasticsearch B.V. under one or more contributor
|
|
2
|
+
# license agreements. See the NOTICE file distributed with
|
|
3
|
+
# this work for additional information regarding copyright
|
|
4
|
+
# ownership. Elasticsearch B.V. licenses this file to you under
|
|
5
|
+
# the Apache License, Version 2.0 (the "License"); you may
|
|
6
|
+
# not use this file except in compliance with the License.
|
|
7
|
+
# You may obtain a copy of the License at
|
|
8
|
+
#
|
|
9
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
#
|
|
11
|
+
# Unless required by applicable law or agreed to in writing,
|
|
12
|
+
# software distributed under the License is distributed on an
|
|
13
|
+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
14
|
+
# KIND, either express or implied. See the License for the
|
|
15
|
+
# specific language governing permissions and limitations
|
|
16
|
+
# under the License.
|
|
17
|
+
#
|
|
18
|
+
# This code was automatically generated from the Elasticsearch Specification
|
|
19
|
+
# See https://github.com/elastic/elasticsearch-specification
|
|
20
|
+
# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
|
|
21
|
+
module Elasticsearch
|
|
22
|
+
module API
|
|
23
|
+
module Esql
|
|
24
|
+
module Actions
|
|
25
|
+
# Delete an ES|QL view.
|
|
26
|
+
# Deletes a stored ES|QL view.
|
|
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.
|
|
30
|
+
#
|
|
31
|
+
# @option arguments [String] :name The view name to remove. (*Required*)
|
|
32
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
33
|
+
# when they occur.
|
|
34
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
35
|
+
# returned by Elasticsearch.
|
|
36
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
|
37
|
+
# For example `"exists_time": "1h"` for humans and
|
|
38
|
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
|
|
39
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
|
40
|
+
# only by machines.
|
|
41
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
|
42
|
+
# this option for debugging only.
|
|
43
|
+
# @option arguments [Hash] :headers Custom HTTP headers
|
|
44
|
+
#
|
|
45
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch#TODO
|
|
46
|
+
#
|
|
47
|
+
def delete_view(arguments = {})
|
|
48
|
+
request_opts = { endpoint: arguments[:endpoint] || 'esql.delete_view' }
|
|
49
|
+
|
|
50
|
+
defined_params = [:name].each_with_object({}) do |variable, set_variables|
|
|
51
|
+
set_variables[variable] = arguments[variable] if arguments.key?(variable)
|
|
52
|
+
end
|
|
53
|
+
request_opts[:defined_params] = defined_params unless defined_params.empty?
|
|
54
|
+
|
|
55
|
+
raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
|
|
56
|
+
|
|
57
|
+
arguments = arguments.clone
|
|
58
|
+
headers = arguments.delete(:headers) || {}
|
|
59
|
+
|
|
60
|
+
body = nil
|
|
61
|
+
|
|
62
|
+
_name = arguments.delete(:name)
|
|
63
|
+
|
|
64
|
+
method = Elasticsearch::API::HTTP_DELETE
|
|
65
|
+
path = "_query/view/#{Utils.listify(_name)}"
|
|
66
|
+
params = Utils.process_params(arguments)
|
|
67
|
+
|
|
68
|
+
Elasticsearch::API::Response.new(
|
|
69
|
+
perform_request(method, path, params, body, headers, request_opts)
|
|
70
|
+
)
|
|
71
|
+
end
|
|
72
|
+
end
|
|
73
|
+
end
|
|
74
|
+
end
|
|
75
|
+
end
|
|
@@ -24,10 +24,9 @@ module Elasticsearch
|
|
|
24
24
|
module Actions
|
|
25
25
|
# Get a specific running ES|QL query information.
|
|
26
26
|
# Returns an object extended information about a running ES|QL query.
|
|
27
|
-
# This functionality is
|
|
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] :id The query ID (*Required*)
|
|
33
32
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
# Licensed to Elasticsearch B.V. under one or more contributor
|
|
2
|
+
# license agreements. See the NOTICE file distributed with
|
|
3
|
+
# this work for additional information regarding copyright
|
|
4
|
+
# ownership. Elasticsearch B.V. licenses this file to you under
|
|
5
|
+
# the Apache License, Version 2.0 (the "License"); you may
|
|
6
|
+
# not use this file except in compliance with the License.
|
|
7
|
+
# You may obtain a copy of the License at
|
|
8
|
+
#
|
|
9
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
#
|
|
11
|
+
# Unless required by applicable law or agreed to in writing,
|
|
12
|
+
# software distributed under the License is distributed on an
|
|
13
|
+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
14
|
+
# KIND, either express or implied. See the License for the
|
|
15
|
+
# specific language governing permissions and limitations
|
|
16
|
+
# under the License.
|
|
17
|
+
#
|
|
18
|
+
# This code was automatically generated from the Elasticsearch Specification
|
|
19
|
+
# See https://github.com/elastic/elasticsearch-specification
|
|
20
|
+
# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
|
|
21
|
+
module Elasticsearch
|
|
22
|
+
module API
|
|
23
|
+
module Esql
|
|
24
|
+
module Actions
|
|
25
|
+
# Get an ES|QL view.
|
|
26
|
+
# Returns a stored ES|QL view.
|
|
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.
|
|
30
|
+
#
|
|
31
|
+
# @option arguments [String] :name The comma-separated view names to retrieve.
|
|
32
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
33
|
+
# when they occur.
|
|
34
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
35
|
+
# returned by Elasticsearch.
|
|
36
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
|
37
|
+
# For example `"exists_time": "1h"` for humans and
|
|
38
|
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
|
|
39
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
|
40
|
+
# only by machines.
|
|
41
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
|
42
|
+
# this option for debugging only.
|
|
43
|
+
# @option arguments [Hash] :headers Custom HTTP headers
|
|
44
|
+
#
|
|
45
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch#TODO
|
|
46
|
+
#
|
|
47
|
+
def get_view(arguments = {})
|
|
48
|
+
request_opts = { endpoint: arguments[:endpoint] || 'esql.get_view' }
|
|
49
|
+
|
|
50
|
+
defined_params = [:name].each_with_object({}) do |variable, set_variables|
|
|
51
|
+
set_variables[variable] = arguments[variable] if arguments.key?(variable)
|
|
52
|
+
end
|
|
53
|
+
request_opts[:defined_params] = defined_params unless defined_params.empty?
|
|
54
|
+
|
|
55
|
+
arguments = arguments.clone
|
|
56
|
+
headers = arguments.delete(:headers) || {}
|
|
57
|
+
|
|
58
|
+
body = nil
|
|
59
|
+
|
|
60
|
+
_name = arguments.delete(:name)
|
|
61
|
+
|
|
62
|
+
method = Elasticsearch::API::HTTP_GET
|
|
63
|
+
path = if _name
|
|
64
|
+
"_query/view/#{Utils.listify(_name)}"
|
|
65
|
+
else
|
|
66
|
+
'_query/view'
|
|
67
|
+
end
|
|
68
|
+
params = Utils.process_params(arguments)
|
|
69
|
+
|
|
70
|
+
Elasticsearch::API::Response.new(
|
|
71
|
+
perform_request(method, path, params, body, headers, request_opts)
|
|
72
|
+
)
|
|
73
|
+
end
|
|
74
|
+
end
|
|
75
|
+
end
|
|
76
|
+
end
|
|
77
|
+
end
|
|
@@ -24,10 +24,9 @@ module Elasticsearch
|
|
|
24
24
|
module Actions
|
|
25
25
|
# Get running ES|QL queries information.
|
|
26
26
|
# Returns an object containing IDs and other information about the running ES|QL queries.
|
|
27
|
-
# This functionality is
|
|
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 [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
33
32
|
# when they occur.
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
# Licensed to Elasticsearch B.V. under one or more contributor
|
|
2
|
+
# license agreements. See the NOTICE file distributed with
|
|
3
|
+
# this work for additional information regarding copyright
|
|
4
|
+
# ownership. Elasticsearch B.V. licenses this file to you under
|
|
5
|
+
# the Apache License, Version 2.0 (the "License"); you may
|
|
6
|
+
# not use this file except in compliance with the License.
|
|
7
|
+
# You may obtain a copy of the License at
|
|
8
|
+
#
|
|
9
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
#
|
|
11
|
+
# Unless required by applicable law or agreed to in writing,
|
|
12
|
+
# software distributed under the License is distributed on an
|
|
13
|
+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
14
|
+
# KIND, either express or implied. See the License for the
|
|
15
|
+
# specific language governing permissions and limitations
|
|
16
|
+
# under the License.
|
|
17
|
+
#
|
|
18
|
+
# This code was automatically generated from the Elasticsearch Specification
|
|
19
|
+
# See https://github.com/elastic/elasticsearch-specification
|
|
20
|
+
# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
|
|
21
|
+
module Elasticsearch
|
|
22
|
+
module API
|
|
23
|
+
module Esql
|
|
24
|
+
module Actions
|
|
25
|
+
# Create or update an ES|QL view.
|
|
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.
|
|
29
|
+
#
|
|
30
|
+
# @option arguments [String] :name The view name to create or update. (*Required*)
|
|
31
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
32
|
+
# when they occur.
|
|
33
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
34
|
+
# returned by Elasticsearch.
|
|
35
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
|
36
|
+
# For example `"exists_time": "1h"` for humans and
|
|
37
|
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
|
|
38
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
|
39
|
+
# only by machines.
|
|
40
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
|
41
|
+
# this option for debugging only.
|
|
42
|
+
# @option arguments [Hash] :headers Custom HTTP headers
|
|
43
|
+
# @option arguments [Hash] :body request body
|
|
44
|
+
#
|
|
45
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch#TODO
|
|
46
|
+
#
|
|
47
|
+
def put_view(arguments = {})
|
|
48
|
+
request_opts = { endpoint: arguments[:endpoint] || 'esql.put_view' }
|
|
49
|
+
|
|
50
|
+
defined_params = [:name].each_with_object({}) do |variable, set_variables|
|
|
51
|
+
set_variables[variable] = arguments[variable] if arguments.key?(variable)
|
|
52
|
+
end
|
|
53
|
+
request_opts[:defined_params] = defined_params unless defined_params.empty?
|
|
54
|
+
|
|
55
|
+
raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
|
|
56
|
+
raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
|
|
57
|
+
|
|
58
|
+
arguments = arguments.clone
|
|
59
|
+
headers = arguments.delete(:headers) || {}
|
|
60
|
+
|
|
61
|
+
body = arguments.delete(:body)
|
|
62
|
+
|
|
63
|
+
_name = arguments.delete(:name)
|
|
64
|
+
|
|
65
|
+
method = Elasticsearch::API::HTTP_PUT
|
|
66
|
+
path = "_query/view/#{Utils.listify(_name)}"
|
|
67
|
+
params = Utils.process_params(arguments)
|
|
68
|
+
|
|
69
|
+
Elasticsearch::API::Response.new(
|
|
70
|
+
perform_request(method, path, params, body, headers, request_opts)
|
|
71
|
+
)
|
|
72
|
+
end
|
|
73
|
+
end
|
|
74
|
+
end
|
|
75
|
+
end
|
|
76
|
+
end
|
|
@@ -48,7 +48,7 @@ module Elasticsearch
|
|
|
48
48
|
# @option arguments [Boolean] :realtime If `true`, the request is real-time as opposed to near-real-time. Server default: true.
|
|
49
49
|
# @option arguments [Boolean] :refresh If `true`, the request refreshes the relevant shards before retrieving the document.
|
|
50
50
|
# Setting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).
|
|
51
|
-
# @option arguments [String] :routing A custom value used to route operations to a specific shard.
|
|
51
|
+
# @option arguments [String, Array<String>] :routing A custom value used to route operations to a specific shard.
|
|
52
52
|
# @option arguments [Boolean, String, Array<String>] :_source Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return.
|
|
53
53
|
# @option arguments [String, Array<String>] :_source_excludes A comma-separated list of source fields to exclude from the response.
|
|
54
54
|
# You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.
|
|
@@ -39,7 +39,7 @@ module Elasticsearch
|
|
|
39
39
|
# @option arguments [Boolean] :realtime If `true`, the request is real-time as opposed to near-real-time. Server default: true.
|
|
40
40
|
# @option arguments [Boolean] :refresh If `true`, the request refreshes the relevant shards before retrieving the document.
|
|
41
41
|
# Setting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).
|
|
42
|
-
# @option arguments [String] :routing A custom value used to route operations to a specific shard.
|
|
42
|
+
# @option arguments [String, Array<String>] :routing A custom value used to route operations to a specific shard.
|
|
43
43
|
# @option arguments [Boolean, String, Array<String>] :_source Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return.
|
|
44
44
|
# @option arguments [String, Array<String>] :_source_excludes A comma-separated list of source fields to exclude in the response.
|
|
45
45
|
# @option arguments [String, Array<String>] :_source_includes A comma-separated list of source fields to include in the response.
|
|
@@ -40,7 +40,7 @@ module Elasticsearch
|
|
|
40
40
|
# This parameter can be used only when the `q` query string parameter is specified.
|
|
41
41
|
# @option arguments [String] :preference The node or shard the operation should be performed on.
|
|
42
42
|
# It is random by default.
|
|
43
|
-
# @option arguments [String] :routing A custom value used to route operations to a specific shard.
|
|
43
|
+
# @option arguments [String, Array<String>] :routing A custom value used to route operations to a specific shard.
|
|
44
44
|
# @option arguments [Boolean, String, Array<String>] :_source `True` or `false` to return the `_source` field or not or a list of fields to return.
|
|
45
45
|
# @option arguments [String, Array<String>] :_source_excludes A comma-separated list of source fields to exclude from the response.
|
|
46
46
|
# You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.
|
|
@@ -33,10 +33,9 @@ module Elasticsearch
|
|
|
33
33
|
# Using this API resets all features, both those that are built-in and implemented as plugins.
|
|
34
34
|
# To list the features that will be affected, use the get features API.
|
|
35
35
|
# IMPORTANT: The features installed on the node you submit this request to are the features that will be reset. Run on the master node if you have any doubts about which plugins are installed on individual nodes.
|
|
36
|
-
# This functionality is
|
|
37
|
-
#
|
|
38
|
-
#
|
|
39
|
-
# support SLA of official GA features.
|
|
36
|
+
# This functionality is in technical preview and may be changed or removed in a future
|
|
37
|
+
# release. Elastic will apply best effort to fix any issues, but features in technical
|
|
38
|
+
# preview are not subject to the support SLA of official GA features.
|
|
40
39
|
#
|
|
41
40
|
# @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
|
|
42
41
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
@@ -35,19 +35,11 @@ module Elasticsearch
|
|
|
35
35
|
# @option arguments [String, Array<String>] :fields A comma-separated list of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported.
|
|
36
36
|
# @option arguments [Boolean] :ignore_unavailable If `true`, missing or closed indices are not included in the response.
|
|
37
37
|
# @option arguments [Boolean] :include_unmapped If true, unmapped fields are included in the response.
|
|
38
|
-
# @option arguments [String] :filters A comma-separated list of filters to apply to the response.
|
|
38
|
+
# @option arguments [String, Array<String>] :filters A comma-separated list of filters to apply to the response.
|
|
39
39
|
# @option arguments [Array<String>] :types A comma-separated list of field types to include.
|
|
40
40
|
# Any fields that do not match one of these types will be excluded from the results.
|
|
41
41
|
# It defaults to empty, meaning that all field types are returned.
|
|
42
42
|
# @option arguments [Boolean] :include_empty_fields If false, empty fields are not included in the response. Server default: true.
|
|
43
|
-
# @option arguments [String] :project_routing Specifies a subset of projects to target for the field-caps query using project
|
|
44
|
-
# metadata tags in a subset of Lucene query syntax.
|
|
45
|
-
# Allowed Lucene queries: the _alias tag and a single value (possibly wildcarded).
|
|
46
|
-
# Examples:
|
|
47
|
-
# _alias:my-project
|
|
48
|
-
# _alias:_origin
|
|
49
|
-
# _alias:*pr*
|
|
50
|
-
# Supported in serverless only.
|
|
51
43
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
52
44
|
# when they occur.
|
|
53
45
|
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
@@ -26,10 +26,9 @@ module Elasticsearch
|
|
|
26
26
|
# Run several Fleet searches with a single API request.
|
|
27
27
|
# The API follows the same structure as the multi search API.
|
|
28
28
|
# However, similar to the Fleet search API, it supports the `wait_for_checkpoints` parameter.
|
|
29
|
-
# This functionality is
|
|
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] :index A single target to search. If the target is an index alias, it must resolve to a single index.
|
|
35
34
|
# @option arguments [Boolean] :allow_no_indices If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.
|
|
@@ -25,10 +25,9 @@ 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
|
-
#
|
|
31
|
-
# support SLA of official GA features.
|
|
28
|
+
# This functionality is in technical preview and may be changed or removed in a future
|
|
29
|
+
# release. Elastic will apply best effort to fix any issues, but features in technical
|
|
30
|
+
# preview are not subject to the support SLA of official GA features.
|
|
32
31
|
#
|
|
33
32
|
# @option arguments [String] :index A single target to search. If the target is an index alias, it must resolve to a single index. (*Required*)
|
|
34
33
|
# @option arguments [Boolean] :allow_no_indices [TODO]
|
|
@@ -48,7 +47,7 @@ module Elasticsearch
|
|
|
48
47
|
# @option arguments [String] :preference [TODO]
|
|
49
48
|
# @option arguments [Integer] :pre_filter_shard_size [TODO]
|
|
50
49
|
# @option arguments [Boolean] :request_cache [TODO]
|
|
51
|
-
# @option arguments [String] :routing [TODO]
|
|
50
|
+
# @option arguments [String, Array<String>] :routing [TODO]
|
|
52
51
|
# @option arguments [Time] :scroll [TODO]
|
|
53
52
|
# @option arguments [String] :search_type [TODO]
|
|
54
53
|
# @option arguments [Array<String>] :stats [TODO]
|
|
@@ -83,7 +83,7 @@ module Elasticsearch
|
|
|
83
83
|
# @option arguments [Boolean] :realtime If `true`, the request is real-time as opposed to near-real-time. Server default: true.
|
|
84
84
|
# @option arguments [Boolean] :refresh If `true`, the request refreshes the relevant shards before retrieving the document.
|
|
85
85
|
# Setting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).
|
|
86
|
-
# @option arguments [String] :routing A custom value used to route operations to a specific shard.
|
|
86
|
+
# @option arguments [String, Array<String>] :routing A custom value used to route operations to a specific shard.
|
|
87
87
|
# @option arguments [Boolean, String, Array<String>] :_source Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return.
|
|
88
88
|
# @option arguments [String, Array<String>] :_source_excludes A comma-separated list of source fields to exclude from the response.
|
|
89
89
|
# You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.
|
|
@@ -42,7 +42,7 @@ module Elasticsearch
|
|
|
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 the relevant shards before retrieving the document.
|
|
44
44
|
# Setting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).
|
|
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, String, Array<String>] :_source Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return.
|
|
47
47
|
# @option arguments [String, Array<String>] :_source_excludes A comma-separated list of source fields to exclude in the response.
|
|
48
48
|
# @option arguments [String, Array<String>] :_source_includes A comma-separated list of source fields to include in the response.
|
|
@@ -30,7 +30,7 @@ module Elasticsearch
|
|
|
30
30
|
# You can exclude vertices that have already been returned.
|
|
31
31
|
#
|
|
32
32
|
# @option arguments [String, Array] :index Name of the index. (*Required*)
|
|
33
|
-
# @option arguments [String] :routing Custom value used to route operations to a specific shard.
|
|
33
|
+
# @option arguments [String, Array<String>] :routing Custom value used to route operations to a specific shard.
|
|
34
34
|
# @option arguments [Time] :timeout Specifies the period of time to wait for a response from each shard.
|
|
35
35
|
# If no response is received before the timeout expires, the request fails and returns an error.
|
|
36
36
|
# Defaults to no timeout.
|
|
@@ -93,6 +93,7 @@ module Elasticsearch
|
|
|
93
93
|
# When using the external version type, the system checks to see if the version number passed to the index request is greater than the version of the currently stored document.
|
|
94
94
|
# If true, the document will be indexed and the new version number used.
|
|
95
95
|
# If the value provided is less than or equal to the stored document's version number, a version conflict will occur and the index operation will fail. For example:
|
|
96
|
+
#
|
|
96
97
|
# ```
|
|
97
98
|
# PUT my-index-000001/_doc/1?version=2&version_type=external
|
|
98
99
|
# {
|
|
@@ -100,6 +101,8 @@ module Elasticsearch
|
|
|
100
101
|
# "id": "elkbee"
|
|
101
102
|
# }
|
|
102
103
|
# }
|
|
104
|
+
# ```
|
|
105
|
+
#
|
|
103
106
|
# In this example, the operation will succeed since the supplied version of 2 is higher than the current document version of 1.
|
|
104
107
|
# If the document was already updated and its version was set to 2 or higher, the indexing command will fail and result in a conflict (409 HTTP status code).
|
|
105
108
|
# A nice side effect is that there is no need to maintain strict ordering of async indexing operations run as a result of changes to a source database, as long as version numbers from the source database are used.
|
|
@@ -126,7 +129,7 @@ module Elasticsearch
|
|
|
126
129
|
# @option arguments [String] :refresh If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search.
|
|
127
130
|
# If `wait_for`, it waits for a refresh to make this operation visible to search.
|
|
128
131
|
# If `false`, it does nothing with refreshes. Server default: false.
|
|
129
|
-
# @option arguments [String] :routing A custom value that is used to route operations to a specific shard.
|
|
132
|
+
# @option arguments [String, Array<String>] :routing A custom value that is used to route operations to a specific shard.
|
|
130
133
|
# @option arguments [Time] :timeout The period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.This parameter is useful for situations where the primary shard assigned to perform the operation might not be available when the operation runs.
|
|
131
134
|
# Some reasons for this might be that the primary shard is currently recovering from a gateway or undergoing relocation.
|
|
132
135
|
# By default, the operation will wait on the primary shard to become available for at least 1 minute before failing and responding with an error.
|
|
@@ -26,7 +26,7 @@ module Elasticsearch
|
|
|
26
26
|
# Add an index block to an index.
|
|
27
27
|
# Index blocks limit the operations allowed on an index by blocking specific operation types.
|
|
28
28
|
#
|
|
29
|
-
# @option arguments [String] :index A comma-separated list or wildcard expression of index names used to limit the request.
|
|
29
|
+
# @option arguments [String, Array] :index A comma-separated list or wildcard expression of index names used to limit the request.
|
|
30
30
|
# By default, you must explicitly name the indices you are adding blocks to.
|
|
31
31
|
# To allow the adding of blocks to indices with `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to `false`.
|
|
32
32
|
# You can update this setting in the `elasticsearch.yml` file or by using the cluster update settings API. (*Required*)
|
|
@@ -24,10 +24,6 @@ module Elasticsearch
|
|
|
24
24
|
module Actions
|
|
25
25
|
# Cancel a migration reindex operation.
|
|
26
26
|
# Cancel a migration reindex attempt for a data stream or index.
|
|
27
|
-
# This functionality is Experimental and may be changed or removed
|
|
28
|
-
# completely in a future release. Elastic will take a best effort approach
|
|
29
|
-
# to fix any issues, but experimental features are not subject to the
|
|
30
|
-
# support SLA of official GA features.
|
|
31
27
|
#
|
|
32
28
|
# @option arguments [String, Array] :index The index or data stream name (*Required*)
|
|
33
29
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
@@ -24,10 +24,6 @@ module Elasticsearch
|
|
|
24
24
|
module Actions
|
|
25
25
|
# Create an index from a source index.
|
|
26
26
|
# Copy the mappings and settings from the source index to a destination index while allowing request settings and mappings to override the source values.
|
|
27
|
-
# This functionality is Experimental and may be changed or removed
|
|
28
|
-
# completely in a future release. Elastic will take a best effort approach
|
|
29
|
-
# to fix any issues, but experimental features are not subject to the
|
|
30
|
-
# support SLA of official GA features.
|
|
31
27
|
#
|
|
32
28
|
# @option arguments [String] :source The source index or data stream name (*Required*)
|
|
33
29
|
# @option arguments [String] :dest The destination index or data stream name (*Required*)
|
|
@@ -25,11 +25,11 @@ module Elasticsearch
|
|
|
25
25
|
# Get data stream stats.
|
|
26
26
|
# Get statistics for one or more data streams.
|
|
27
27
|
#
|
|
28
|
-
# @option arguments [String] :name Comma-separated list of data streams used to limit the request.
|
|
28
|
+
# @option arguments [String, Array] :name Comma-separated list of data streams used to limit the request.
|
|
29
29
|
# Wildcard expressions (`*`) are supported.
|
|
30
30
|
# To target all data streams in a cluster, omit this parameter or use `*`.
|
|
31
31
|
# @option arguments [String, Array<String>] :expand_wildcards Type of data stream that wildcard patterns can match.
|
|
32
|
-
# Supports comma-separated values, such as `open,hidden`. Server default: open.
|
|
32
|
+
# Supports comma-separated values, such as `open,hidden`. Server default: open,closed.
|
|
33
33
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
34
34
|
# when they occur.
|
|
35
35
|
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
@@ -37,7 +37,7 @@ module Elasticsearch
|
|
|
37
37
|
# This behavior applies even if the request targets other open indices. Server default: true.
|
|
38
38
|
# @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match.
|
|
39
39
|
# If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
|
|
40
|
-
# Supports comma-separated values, such as `open,hidden`. Server default: open.
|
|
40
|
+
# Supports comma-separated values, such as `open,hidden`. Server default: open,closed.
|
|
41
41
|
# @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index.
|
|
42
42
|
# @option arguments [Time] :master_timeout Period to wait for a connection to the master node.
|
|
43
43
|
# If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
|