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
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 53c546506e26aa06e475332f9b71e3ff8b0bb863eab32ee56aad5c5795b59547
|
|
4
|
+
data.tar.gz: 40b27e5aa17848625953d5e6b2ca036828c66ce92992d5c7388cb5034240ff7f
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: f5494f5e8835f8e2094e6547a4ed5e69cfd77398fa1b8e87f81188dfbf688de7e2cfb08b89220c439de6ae667ce59c7bbf0eb5fe730f92115cb99fe58ad871d9
|
|
7
|
+
data.tar.gz: 02dbe09b72742453667e2d1e575a15f4738db89e387b25540e3a755a6c6f7d94635c8461f86e0cf0b3be39d0b8c0b3f0ae4d952a411dd183bab719f1547b531b
|
data/elasticsearch-api.gemspec
CHANGED
|
@@ -34,33 +34,27 @@ module Elasticsearch
|
|
|
34
34
|
# @option arguments [Time] :keep_alive Specifies how long the async search needs to be available.
|
|
35
35
|
# Ongoing async searches and any saved search results are deleted after this period. Server default: 5d.
|
|
36
36
|
# @option arguments [Boolean] :keep_on_completion If `true`, results are stored for later retrieval when the search completes within the `wait_for_completion_timeout`.
|
|
37
|
-
# @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices.
|
|
37
|
+
# @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices.
|
|
38
|
+
# (This includes `_all` string or when no indices have been specified)
|
|
38
39
|
# @option arguments [Boolean] :allow_partial_search_results Indicate if an error should be returned if there is a partial search failure or timeout Server default: true.
|
|
39
40
|
# @option arguments [String] :analyzer The analyzer to use for the query string
|
|
40
|
-
# @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed
|
|
41
|
+
# @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed
|
|
41
42
|
# @option arguments [Integer] :batched_reduce_size Affects how often partial results become available, which happens whenever shard results are reduced.
|
|
42
43
|
# A partial reduction is performed every time the coordinating node has received a certain number of new shard responses (5 by default). Server default: 5.
|
|
43
44
|
# @option arguments [Boolean] :ccs_minimize_roundtrips The default value is the only supported value.
|
|
44
45
|
# @option arguments [String] :default_operator The default operator for query string query (AND or OR) Server default: or.
|
|
45
46
|
# @option arguments [String] :df The field to use as default where no field prefix is given in the query string
|
|
46
47
|
# @option arguments [String, Array<String>] :docvalue_fields A comma-separated list of fields to return as the docvalue representation of a field for each hit
|
|
47
|
-
# @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
|
|
48
|
+
# @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both Server default: open.
|
|
48
49
|
# @option arguments [Boolean] :explain Specify whether to return detailed information about score computation as part of a hit
|
|
49
50
|
# @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled
|
|
50
51
|
# @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
|
51
52
|
# @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
|
|
52
|
-
# @option arguments [Integer] :max_concurrent_shard_requests The number of concurrent shard requests per node this search executes concurrently.
|
|
53
|
-
#
|
|
54
|
-
# @option arguments [String] :
|
|
55
|
-
# metadata tags in a subset of Lucene query syntax.
|
|
56
|
-
# Allowed Lucene queries: the _alias tag and a single value (possibly wildcarded).
|
|
57
|
-
# Examples:
|
|
58
|
-
# _alias:my-project
|
|
59
|
-
# _alias:_origin
|
|
60
|
-
# _alias:*pr*
|
|
61
|
-
# Supported in serverless only.
|
|
53
|
+
# @option arguments [Integer] :max_concurrent_shard_requests The number of concurrent shard requests per node this search executes concurrently.
|
|
54
|
+
# This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests Server default: 5.
|
|
55
|
+
# @option arguments [String] :preference Specify the node or shard the operation should be performed on Server default: random.
|
|
62
56
|
# @option arguments [Boolean] :request_cache Specify if request cache should be used for this request or not, defaults to true Server default: true.
|
|
63
|
-
# @option arguments [String] :routing A comma-separated list of specific routing values
|
|
57
|
+
# @option arguments [String, Array<String>] :routing A comma-separated list of specific routing values
|
|
64
58
|
# @option arguments [String] :search_type Search operation type
|
|
65
59
|
# @option arguments [Array<String>] :stats Specific 'tag' of the request for logging and statistical purposes
|
|
66
60
|
# @option arguments [String, Array<String>] :stored_fields A comma-separated list of stored fields to return as part of a hit
|
|
@@ -68,9 +62,10 @@ module Elasticsearch
|
|
|
68
62
|
# @option arguments [String] :suggest_mode Specify suggest mode Server default: missing.
|
|
69
63
|
# @option arguments [Integer] :suggest_size How many suggestions to return in response
|
|
70
64
|
# @option arguments [String] :suggest_text The source text for which the suggestions should be returned.
|
|
71
|
-
# @option arguments [Integer] :terminate_after The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early
|
|
65
|
+
# @option arguments [Integer] :terminate_after The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early
|
|
72
66
|
# @option arguments [Time] :timeout Explicit operation timeout
|
|
73
|
-
# @option arguments [Boolean, Integer] :track_total_hits Indicate if the number of documents that match the query should be tracked.
|
|
67
|
+
# @option arguments [Boolean, Integer] :track_total_hits Indicate if the number of documents that match the query should be tracked.
|
|
68
|
+
# A number can also be specified, to accurately track the total hit count up to the number.
|
|
74
69
|
# @option arguments [Boolean] :track_scores Whether to calculate and return scores even if they are not used for sorting
|
|
75
70
|
# @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
|
|
76
71
|
# @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response
|
|
@@ -80,8 +75,8 @@ module Elasticsearch
|
|
|
80
75
|
# @option arguments [String, Array<String>] :_source_includes A list of fields to extract and return from the _source field
|
|
81
76
|
# @option arguments [Boolean] :seq_no_primary_term Specify whether to return sequence number and primary term of the last modification of each hit
|
|
82
77
|
# @option arguments [String] :q Query in the Lucene query string syntax
|
|
83
|
-
# @option arguments [Integer] :size Number of hits to return
|
|
84
|
-
# @option arguments [Integer] :from Starting offset
|
|
78
|
+
# @option arguments [Integer] :size Number of hits to return Server default: 10.
|
|
79
|
+
# @option arguments [Integer] :from Starting offset Server default: 0.
|
|
85
80
|
# @option arguments [String, Array<String>] :sort A comma-separated list of <field>:<direction> pairs
|
|
86
81
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
87
82
|
# when they occur.
|
|
@@ -76,6 +76,7 @@ module Elasticsearch
|
|
|
76
76
|
# * Perl: Check out `Search::Elasticsearch::Client::5_0::Bulk` and `Search::Elasticsearch::Client::5_0::Scroll`
|
|
77
77
|
# * Python: Check out `elasticsearch.helpers.*`
|
|
78
78
|
# * JavaScript: Check out `client.helpers.*`
|
|
79
|
+
# * Java: Check out `co.elastic.clients.elasticsearch._helpers.bulk.BulkIngester`
|
|
79
80
|
# * .NET: Check out `BulkAllObservable`
|
|
80
81
|
# * PHP: Check out bulk indexing.
|
|
81
82
|
# * Ruby: Check out `Elasticsearch::Helpers::BulkHelper`
|
|
@@ -123,7 +124,7 @@ module Elasticsearch
|
|
|
123
124
|
# If `wait_for`, wait for a refresh to make this operation visible to search.
|
|
124
125
|
# If `false`, do nothing with refreshes.
|
|
125
126
|
# Valid values: `true`, `false`, `wait_for`. Server default: false.
|
|
126
|
-
# @option arguments [String] :routing A custom value that is used to route operations to a specific shard.
|
|
127
|
+
# @option arguments [String, Array<String>] :routing A custom value that is used to route operations to a specific shard.
|
|
127
128
|
# @option arguments [Boolean, String, Array<String>] :_source Indicates whether to return the `_source` field (`true` or `false`) or contains a list of fields to return.
|
|
128
129
|
# @option arguments [String, Array<String>] :_source_excludes A comma-separated list of source fields to exclude from the response.
|
|
129
130
|
# You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.
|
|
@@ -34,7 +34,7 @@ module Elasticsearch
|
|
|
34
34
|
# or `:desc` as a suffix to the column name.
|
|
35
35
|
# @option arguments [String, Array<String>] :expand_wildcards The type of index that wildcard patterns can match.
|
|
36
36
|
# If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
|
|
37
|
-
# It supports comma-separated values, such as `open,hidden`.
|
|
37
|
+
# It supports comma-separated values, such as `open,hidden`. Server default: all.
|
|
38
38
|
# @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
|
|
39
39
|
# If the master node is not available before the timeout expires, the request fails and returns an error.
|
|
40
40
|
# To indicated that the request should never timeout, you can set it to `-1`. Server default: 30s.
|
|
@@ -0,0 +1,96 @@
|
|
|
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 Cat
|
|
24
|
+
module Actions
|
|
25
|
+
# Get circuit breakers statistics.IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.
|
|
26
|
+
#
|
|
27
|
+
# @option arguments [String, Array<String>] :circuit_breaker_patterns A comma-separated list of regular-expressions to filter the circuit breakers in the output
|
|
28
|
+
# @option arguments [String, Array<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
|
|
29
|
+
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
|
|
30
|
+
# Sorting defaults to ascending and can be changed by setting `:asc`
|
|
31
|
+
# or `:desc` as a suffix to the column name.
|
|
32
|
+
# @option arguments [Boolean] :local If `true`, the request computes the list of selected nodes from the
|
|
33
|
+
# local cluster state. If `false` the list of selected nodes are computed
|
|
34
|
+
# from the cluster state of the master node. In both cases the coordinating
|
|
35
|
+
# node will send requests for further information to each selected node.
|
|
36
|
+
# @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
|
|
37
|
+
# @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
|
|
38
|
+
# `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
|
|
39
|
+
# @option arguments [Boolean] :help When set to `true` will output available columns. This option
|
|
40
|
+
# can't be combined with any other query string option.
|
|
41
|
+
# @option arguments [Boolean] :v When set to `true` will enable verbose output.
|
|
42
|
+
# @option arguments [String] :bytes Sets the units for columns that contain a byte-size value.
|
|
43
|
+
# Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.
|
|
44
|
+
# If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
|
|
45
|
+
# If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.
|
|
46
|
+
# Values that are not an exact multiple of the chosen unit are rounded down.
|
|
47
|
+
# @option arguments [String] :time Sets the units for columns that contain a time duration.
|
|
48
|
+
# If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
|
|
49
|
+
# If given, time duration values are rendered as an integer with no suffix.
|
|
50
|
+
# Values that are not an exact multiple of the chosen unit are rounded down.
|
|
51
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
52
|
+
# when they occur.
|
|
53
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
54
|
+
# returned by Elasticsearch.
|
|
55
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
|
56
|
+
# For example `"exists_time": "1h"` for humans and
|
|
57
|
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
|
|
58
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
|
59
|
+
# only by machines.
|
|
60
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
|
61
|
+
# this option for debugging only.
|
|
62
|
+
# @option arguments [Hash] :headers Custom HTTP headers
|
|
63
|
+
#
|
|
64
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch#TODO
|
|
65
|
+
#
|
|
66
|
+
def circuit_breaker(arguments = {})
|
|
67
|
+
request_opts = { endpoint: arguments[:endpoint] || 'cat.circuit_breaker' }
|
|
68
|
+
|
|
69
|
+
defined_params = [:circuit_breaker_patterns].each_with_object({}) do |variable, set_variables|
|
|
70
|
+
set_variables[variable] = arguments[variable] if arguments.key?(variable)
|
|
71
|
+
end
|
|
72
|
+
request_opts[:defined_params] = defined_params unless defined_params.empty?
|
|
73
|
+
|
|
74
|
+
arguments = arguments.clone
|
|
75
|
+
headers = arguments.delete(:headers) || {}
|
|
76
|
+
|
|
77
|
+
body = nil
|
|
78
|
+
|
|
79
|
+
_circuit_breaker_patterns = arguments.delete(:circuit_breaker_patterns)
|
|
80
|
+
|
|
81
|
+
method = Elasticsearch::API::HTTP_GET
|
|
82
|
+
path = if _circuit_breaker_patterns
|
|
83
|
+
"_cat/circuit_breaker/#{Utils.listify(_circuit_breaker_patterns)}"
|
|
84
|
+
else
|
|
85
|
+
'_cat/circuit_breaker'
|
|
86
|
+
end
|
|
87
|
+
params = Utils.process_params(arguments)
|
|
88
|
+
|
|
89
|
+
Elasticsearch::API::Response.new(
|
|
90
|
+
perform_request(method, path, params, body, headers, request_opts)
|
|
91
|
+
)
|
|
92
|
+
end
|
|
93
|
+
end
|
|
94
|
+
end
|
|
95
|
+
end
|
|
96
|
+
end
|
|
@@ -32,14 +32,6 @@ module Elasticsearch
|
|
|
32
32
|
# It supports wildcards (`*`).
|
|
33
33
|
# To target all data streams and indices, omit this parameter or use `*` or `_all`.
|
|
34
34
|
# @option arguments [String, Array<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
|
|
35
|
-
# @option arguments [String] :project_routing Specifies a subset of projects to target for the search using project
|
|
36
|
-
# metadata tags in a subset of Lucene query syntax.
|
|
37
|
-
# Allowed Lucene queries: the _alias tag and a single value (possibly wildcarded).
|
|
38
|
-
# Examples:
|
|
39
|
-
# _alias:my-project
|
|
40
|
-
# _alias:_origin
|
|
41
|
-
# _alias:*pr*
|
|
42
|
-
# Supported in serverless only.
|
|
43
35
|
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
|
|
44
36
|
# Sorting defaults to ascending and can be changed by setting `:asc`
|
|
45
37
|
# or `:desc` as a suffix to the column name.
|
|
@@ -69,6 +61,7 @@ module Elasticsearch
|
|
|
69
61
|
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
|
70
62
|
# this option for debugging only.
|
|
71
63
|
# @option arguments [Hash] :headers Custom HTTP headers
|
|
64
|
+
# @option arguments [Hash] :body request body
|
|
72
65
|
#
|
|
73
66
|
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-count
|
|
74
67
|
#
|
|
@@ -83,11 +76,16 @@ module Elasticsearch
|
|
|
83
76
|
arguments = arguments.clone
|
|
84
77
|
headers = arguments.delete(:headers) || {}
|
|
85
78
|
|
|
86
|
-
body =
|
|
79
|
+
body = arguments.delete(:body)
|
|
87
80
|
|
|
88
81
|
_index = arguments.delete(:index)
|
|
89
82
|
|
|
90
|
-
method =
|
|
83
|
+
method = if body
|
|
84
|
+
Elasticsearch::API::HTTP_POST
|
|
85
|
+
else
|
|
86
|
+
Elasticsearch::API::HTTP_GET
|
|
87
|
+
end
|
|
88
|
+
|
|
91
89
|
path = if _index
|
|
92
90
|
"_cat/count/#{Utils.listify(_index)}"
|
|
93
91
|
else
|
|
@@ -37,7 +37,7 @@ module Elasticsearch
|
|
|
37
37
|
#
|
|
38
38
|
# @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases used to limit the request.
|
|
39
39
|
# Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.
|
|
40
|
-
# @option arguments [String, Array<String>] :expand_wildcards The type of index that wildcard patterns can match.
|
|
40
|
+
# @option arguments [String, Array<String>] :expand_wildcards The type of index that wildcard patterns can match. Server default: all.
|
|
41
41
|
# @option arguments [String] :health The health status used to limit returned indices. By default, the response includes indices of any health status.
|
|
42
42
|
# @option arguments [Boolean] :include_unloaded_segments If true, the response includes information from segments that are not loaded into memory.
|
|
43
43
|
# @option arguments [Boolean] :pri If true, the response only includes information from primary shards.
|
|
@@ -40,6 +40,16 @@ module Elasticsearch
|
|
|
40
40
|
# from the cluster state of the master node. In both cases the coordinating
|
|
41
41
|
# node will send requests for further information to each selected node.
|
|
42
42
|
# @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
|
|
43
|
+
# @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard expressions can match. If the request can target data streams, this argument
|
|
44
|
+
# determines whether wildcard expressions match hidden data streams. Supports comma-separated values,
|
|
45
|
+
# such as open,hidden. Server default: open.
|
|
46
|
+
# @option arguments [Boolean] :allow_no_indices If false, the request returns an error if any wildcard expression, index alias, or _all value targets only
|
|
47
|
+
# missing or closed indices. This behavior applies even if the request targets other open indices. For example,
|
|
48
|
+
# a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. Server default: true.
|
|
49
|
+
# @option arguments [Boolean] :ignore_throttled If true, concrete, expanded or aliased indices are ignored when frozen.
|
|
50
|
+
# @option arguments [Boolean] :ignore_unavailable If true, missing or closed indices are not included in the response.
|
|
51
|
+
# @option arguments [Boolean] :allow_closed If true, allow closed indices to be returned in the response otherwise if false, keep the legacy behaviour
|
|
52
|
+
# of throwing an exception if index pattern matches closed indices
|
|
43
53
|
# @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
|
|
44
54
|
# `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
|
|
45
55
|
# @option arguments [Boolean] :help When set to `true` will output available columns. This option
|
|
@@ -25,10 +25,9 @@ module Elasticsearch
|
|
|
25
25
|
# Get task information.
|
|
26
26
|
# Get information about tasks currently running in the cluster.
|
|
27
27
|
# IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API.
|
|
28
|
-
# This functionality is
|
|
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 [Array<String>] :actions The task action names, which are used to limit the response.
|
|
34
33
|
# @option arguments [Boolean] :detailed If `true`, the response includes detailed information about shard recoveries.
|
|
@@ -25,11 +25,10 @@ module Elasticsearch
|
|
|
25
25
|
# Get component templates.
|
|
26
26
|
# Get information about component templates.
|
|
27
27
|
#
|
|
28
|
-
# @option arguments [String] :name
|
|
29
|
-
# Wildcard (`*`) expressions are supported.
|
|
28
|
+
# @option arguments [String] :name Name of component template to retrieve. Wildcard (`*`) expressions are supported.
|
|
30
29
|
# @option arguments [Boolean] :flat_settings If `true`, returns settings in flat format.
|
|
31
30
|
# @option arguments [String, Array<String>] :settings_filter Filter out results, for example to filter out sensitive information. Supports wildcards or full settings keys
|
|
32
|
-
# @option arguments [Boolean] :include_defaults Return all default configurations for the component template
|
|
31
|
+
# @option arguments [Boolean] :include_defaults Return all default configurations for the component template
|
|
33
32
|
# @option arguments [Boolean] :local If `true`, the request retrieves information from the local node only.
|
|
34
33
|
# If `false`, information is retrieved from the master node.
|
|
35
34
|
# @option arguments [Time] :master_timeout Period to wait for a connection to the master node.
|
|
@@ -31,18 +31,31 @@ module Elasticsearch
|
|
|
31
31
|
# One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level.
|
|
32
32
|
# The cluster status is controlled by the worst index status.
|
|
33
33
|
#
|
|
34
|
-
# @option arguments [String, Array] :index
|
|
35
|
-
#
|
|
36
|
-
#
|
|
37
|
-
# @option arguments [
|
|
38
|
-
# @option arguments [
|
|
39
|
-
# @option arguments [
|
|
40
|
-
#
|
|
41
|
-
# @option arguments [
|
|
42
|
-
#
|
|
43
|
-
# @option arguments [
|
|
44
|
-
#
|
|
45
|
-
# @option arguments [String] :
|
|
34
|
+
# @option arguments [String, Array] :index A comma-separated list of data streams, indices, and index aliases that limit the request.
|
|
35
|
+
# Wildcard expressions (`*`) are supported.
|
|
36
|
+
# To target all data streams and indices in a cluster, omit this parameter or use _all or `*`.
|
|
37
|
+
# @option arguments [String, Array<String>] :expand_wildcards Expand wildcard expression to concrete indices that are open, closed or both. Server default: all.
|
|
38
|
+
# @option arguments [String] :level Return health information at a specific level of detail. Server default: cluster.
|
|
39
|
+
# @option arguments [Boolean] :local If true, retrieve information from the local node only.
|
|
40
|
+
# If false, retrieve information from the master node.
|
|
41
|
+
# @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
|
|
42
|
+
# If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
|
|
43
|
+
# @option arguments [Time] :timeout The period to wait for a response.
|
|
44
|
+
# If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
|
|
45
|
+
# @option arguments [Integer, String] :wait_for_active_shards Wait for the specified number of active shards.
|
|
46
|
+
# Use `all` to wait for all shards in the cluster to be active.
|
|
47
|
+
# Use `0` to not wait. Server default: 0.
|
|
48
|
+
# @option arguments [String] :wait_for_events Wait until all currently queued events with the given priority are processed.
|
|
49
|
+
# @option arguments [String, Integer] :wait_for_nodes Wait until the specified number (N) of nodes is available.
|
|
50
|
+
# It also accepts `>=N`, `<=N`, `>N` and `<N`.
|
|
51
|
+
# Alternatively, use the notations `ge(N)`, `le(N)`, `gt(N)`, and `lt(N)`.
|
|
52
|
+
# @option arguments [Boolean] :wait_for_no_initializing_shards Wait (until the timeout expires) for the cluster to have no shard initializations.
|
|
53
|
+
# If false, the request does not wait for initializing shards.
|
|
54
|
+
# @option arguments [Boolean] :wait_for_no_relocating_shards Wait (until the timeout expires) for the cluster to have no shard relocations.
|
|
55
|
+
# If false, the request not wait for relocating shards.
|
|
56
|
+
# @option arguments [String] :wait_for_status Wait (until the timeout expires) for the cluster to reach a specific health status (or a better status).
|
|
57
|
+
# A green status is better than yellow and yellow is better than red.
|
|
58
|
+
# By default, the request does not wait for a particular status.
|
|
46
59
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
47
60
|
# when they occur.
|
|
48
61
|
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
@@ -37,9 +37,9 @@ module Elasticsearch
|
|
|
37
37
|
# WARNING: Transient cluster settings are no longer recommended. Use persistent cluster settings instead.
|
|
38
38
|
# If a cluster becomes unstable, transient settings can clear unexpectedly, resulting in a potentially undesired cluster configuration.
|
|
39
39
|
#
|
|
40
|
-
# @option arguments [Boolean] :flat_settings Return settings in flat format
|
|
41
|
-
# @option arguments [Time] :master_timeout
|
|
42
|
-
# @option arguments [Time] :timeout
|
|
40
|
+
# @option arguments [Boolean] :flat_settings Return settings in flat format
|
|
41
|
+
# @option arguments [Time] :master_timeout The period to wait for a connection to the master node. Server default: 30s.
|
|
42
|
+
# @option arguments [Time] :timeout The period to wait for a response. Server default: 30s.
|
|
43
43
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
44
44
|
# when they occur.
|
|
45
45
|
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
@@ -36,7 +36,7 @@ module Elasticsearch
|
|
|
36
36
|
# @option arguments [Boolean] :dry_run If true, then the request simulates the operation.
|
|
37
37
|
# It will calculate the result of applying the commands to the current cluster state and return the resulting cluster state after the commands (and rebalancing) have been applied; it will not actually perform the requested changes.
|
|
38
38
|
# @option arguments [Boolean] :explain If true, then the response contains an explanation of why the commands can or cannot run.
|
|
39
|
-
# @option arguments [String, Array<String>] :metric Limits the information returned to the specified metrics.
|
|
39
|
+
# @option arguments [String, Array<String>] :metric Limits the information returned to the specified metrics.
|
|
40
40
|
# @option arguments [Boolean] :retry_failed If true, then retries allocation of shards that are blocked due to too many subsequent allocation failures.
|
|
41
41
|
# @option arguments [Time] :master_timeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
|
|
42
42
|
# @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.
|
|
@@ -37,13 +37,14 @@ module Elasticsearch
|
|
|
37
37
|
# Do not query this API using external monitoring tools.
|
|
38
38
|
# Instead, obtain the information you require using other more stable cluster APIs.
|
|
39
39
|
#
|
|
40
|
-
# @option arguments [String, Array<String>] :metric Limit the information returned to the specified metrics
|
|
40
|
+
# @option arguments [String, Array<String>] :metric Limit the information returned to the specified metrics.
|
|
41
41
|
# @option arguments [String, Array] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
|
42
|
-
# @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices.
|
|
43
|
-
#
|
|
44
|
-
# @option arguments [
|
|
42
|
+
# @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices.
|
|
43
|
+
# (This includes `_all` string or when no indices have been specified) Server default: true.
|
|
44
|
+
# @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both Server default: open.
|
|
45
|
+
# @option arguments [Boolean] :flat_settings Return settings in flat format
|
|
45
46
|
# @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
|
46
|
-
# @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
|
|
47
|
+
# @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
|
|
47
48
|
# @option arguments [Time] :master_timeout Timeout for waiting for new cluster state in case it is blocked Server default: 30s.
|
|
48
49
|
# @option arguments [Integer] :wait_for_metadata_version Wait for the metadata version to be equal or greater than the specified metadata version
|
|
49
50
|
# @option arguments [Time] :wait_for_timeout The maximum time to wait for wait_for_metadata_version before timing out
|
|
@@ -24,10 +24,9 @@ module Elasticsearch
|
|
|
24
24
|
module Actions
|
|
25
25
|
# Check in a connector.
|
|
26
26
|
# Update the `last_seen` field in the connector and set it to the current timestamp.
|
|
27
|
-
# This functionality is
|
|
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] :connector_id The unique identifier of the connector to be checked in (*Required*)
|
|
33
32
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
@@ -26,10 +26,9 @@ module Elasticsearch
|
|
|
26
26
|
# Check in a connector sync job and set the `last_seen` field to the current time before updating it in the internal index.
|
|
27
27
|
# To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.
|
|
28
28
|
# This service runs automatically on Elastic Cloud for Elastic managed connectors.
|
|
29
|
-
# This functionality is
|
|
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] :connector_sync_job_id The unique identifier of the connector sync job to be checked in. (*Required*)
|
|
35
34
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
@@ -29,10 +29,9 @@ module Elasticsearch
|
|
|
29
29
|
# It supports the implementation of services that utilize the connector protocol to communicate with Elasticsearch.
|
|
30
30
|
# To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.
|
|
31
31
|
# This service runs automatically on Elastic Cloud for Elastic managed connectors.
|
|
32
|
-
# This functionality is
|
|
33
|
-
#
|
|
34
|
-
#
|
|
35
|
-
# support SLA of official GA features.
|
|
32
|
+
# This functionality is in technical preview and may be changed or removed in a future
|
|
33
|
+
# release. Elastic will apply best effort to fix any issues, but features in technical
|
|
34
|
+
# preview are not subject to the support SLA of official GA features.
|
|
36
35
|
#
|
|
37
36
|
# @option arguments [String] :connector_sync_job_id The unique identifier of the connector sync job. (*Required*)
|
|
38
37
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
@@ -26,10 +26,9 @@ module Elasticsearch
|
|
|
26
26
|
# Set the `error` field for a connector sync job and set its `status` to `error`.
|
|
27
27
|
# To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.
|
|
28
28
|
# This service runs automatically on Elastic Cloud for Elastic managed connectors.
|
|
29
|
-
# This functionality is
|
|
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] :connector_sync_job_id The unique identifier for the connector sync job. (*Required*)
|
|
35
34
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
@@ -28,10 +28,9 @@ module Elasticsearch
|
|
|
28
28
|
# This API is mainly used by the connector service for updating sync job information.
|
|
29
29
|
# To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.
|
|
30
30
|
# This service runs automatically on Elastic Cloud for Elastic managed connectors.
|
|
31
|
-
# This functionality is
|
|
32
|
-
#
|
|
33
|
-
#
|
|
34
|
-
# support SLA of official GA features.
|
|
31
|
+
# This functionality is in technical preview and may be changed or removed in a future
|
|
32
|
+
# release. Elastic will apply best effort to fix any issues, but features in technical
|
|
33
|
+
# preview are not subject to the support SLA of official GA features.
|
|
35
34
|
#
|
|
36
35
|
# @option arguments [String] :connector_sync_job_id The unique identifier of the connector sync job. (*Required*)
|
|
37
36
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
@@ -24,10 +24,9 @@ module Elasticsearch
|
|
|
24
24
|
module Actions
|
|
25
25
|
# Activate the connector draft filter.
|
|
26
26
|
# Activates the valid draft filtering for a connector.
|
|
27
|
-
# This functionality is
|
|
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] :connector_id The unique identifier of the connector to be updated (*Required*)
|
|
33
32
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
@@ -26,10 +26,9 @@ module Elasticsearch
|
|
|
26
26
|
# Set the error field for the connector.
|
|
27
27
|
# If the error provided in the request body is non-null, the connector’s status is updated to error.
|
|
28
28
|
# Otherwise, if the error is reset to null, the connector status is updated to connected.
|
|
29
|
-
# This functionality is
|
|
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] :connector_id The unique identifier of the connector to be updated (*Required*)
|
|
35
34
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
@@ -33,10 +33,9 @@ module Elasticsearch
|
|
|
33
33
|
# However, you can use this API to override the default behavior.
|
|
34
34
|
# To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.
|
|
35
35
|
# This service runs automatically on Elastic Cloud for Elastic managed connectors.
|
|
36
|
-
# This functionality is
|
|
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 [String] :connector_id The unique identifier of the connector to be updated. (*Required*)
|
|
42
41
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
@@ -24,10 +24,9 @@ module Elasticsearch
|
|
|
24
24
|
module Actions
|
|
25
25
|
# Update the connector draft filtering validation.
|
|
26
26
|
# Update the draft filtering validation info for a connector.
|
|
27
|
-
# This functionality is
|
|
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] :connector_id The unique identifier of the connector to be updated (*Required*)
|
|
33
32
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
@@ -23,10 +23,9 @@ module Elasticsearch
|
|
|
23
23
|
module Connector
|
|
24
24
|
module Actions
|
|
25
25
|
# Update the connector status.
|
|
26
|
-
# This functionality is
|
|
27
|
-
#
|
|
28
|
-
#
|
|
29
|
-
# support SLA of official GA features.
|
|
26
|
+
# This functionality is in technical preview and may be changed or removed in a future
|
|
27
|
+
# release. Elastic will apply best effort to fix any issues, but features in technical
|
|
28
|
+
# preview are not subject to the support SLA of official GA features.
|
|
30
29
|
#
|
|
31
30
|
# @option arguments [String] :connector_id The unique identifier of the connector to be updated (*Required*)
|
|
32
31
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
@@ -54,15 +54,7 @@ module Elasticsearch
|
|
|
54
54
|
# @option arguments [Float] :min_score The minimum `_score` value that documents must have to be included in the result.
|
|
55
55
|
# @option arguments [String] :preference The node or shard the operation should be performed on.
|
|
56
56
|
# By default, it is random.
|
|
57
|
-
# @option arguments [String] :
|
|
58
|
-
# metadata tags in a subset of Lucene query syntax.
|
|
59
|
-
# Allowed Lucene queries: the _alias tag and a single value (possibly wildcarded).
|
|
60
|
-
# Examples:
|
|
61
|
-
# _alias:my-project
|
|
62
|
-
# _alias:_origin
|
|
63
|
-
# _alias:*pr*
|
|
64
|
-
# Supported in serverless only.
|
|
65
|
-
# @option arguments [String] :routing A custom value used to route operations to a specific shard.
|
|
57
|
+
# @option arguments [String, Array<String>] :routing A custom value used to route operations to a specific shard.
|
|
66
58
|
# @option arguments [Integer] :terminate_after The maximum number of documents to collect for each shard.
|
|
67
59
|
# If a query reaches this limit, Elasticsearch terminates the query early.
|
|
68
60
|
# Elasticsearch collects documents before sorting.IMPORTANT: Use with caution.
|