elasticsearch-api 7.9.0.pre → 7.11.0.pre.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +18 -2
- data/elasticsearch-api.gemspec +1 -1
- data/lib/elasticsearch/api/actions/bulk.rb +5 -6
- data/lib/elasticsearch/api/actions/cat/aliases.rb +2 -4
- data/lib/elasticsearch/api/actions/cat/allocation.rb +2 -4
- data/lib/elasticsearch/api/actions/cat/count.rb +1 -1
- data/lib/elasticsearch/api/actions/cat/fielddata.rb +2 -5
- data/lib/elasticsearch/api/actions/cat/health.rb +2 -4
- data/lib/elasticsearch/api/actions/cat/help.rb +1 -1
- data/lib/elasticsearch/api/actions/cat/indices.rb +6 -14
- data/lib/elasticsearch/api/actions/cat/master.rb +1 -1
- data/lib/elasticsearch/api/actions/cat/nodeattrs.rb +1 -1
- data/lib/elasticsearch/api/actions/cat/nodes.rb +4 -8
- data/lib/elasticsearch/api/actions/cat/pending_tasks.rb +2 -4
- data/lib/elasticsearch/api/actions/cat/plugins.rb +1 -1
- data/lib/elasticsearch/api/actions/cat/recovery.rb +3 -8
- data/lib/elasticsearch/api/actions/cat/repositories.rb +1 -1
- data/lib/elasticsearch/api/actions/cat/segments.rb +2 -4
- data/lib/elasticsearch/api/actions/cat/shards.rb +4 -8
- data/lib/elasticsearch/api/actions/cat/snapshots.rb +2 -4
- data/lib/elasticsearch/api/actions/cat/tasks.rb +6 -8
- data/lib/elasticsearch/api/actions/cat/templates.rb +1 -1
- data/lib/elasticsearch/api/actions/cat/thread_pool.rb +2 -4
- data/lib/elasticsearch/api/actions/clear_scroll.rb +2 -2
- data/lib/elasticsearch/api/actions/cluster/allocation_explain.rb +1 -1
- data/lib/elasticsearch/api/actions/cluster/delete_component_template.rb +1 -1
- data/lib/elasticsearch/api/actions/cluster/delete_voting_config_exclusions.rb +1 -1
- data/lib/elasticsearch/api/actions/cluster/exists_component_template.rb +1 -1
- data/lib/elasticsearch/api/actions/cluster/get_component_template.rb +1 -1
- data/lib/elasticsearch/api/actions/cluster/get_settings.rb +1 -1
- data/lib/elasticsearch/api/actions/cluster/health.rb +5 -13
- data/lib/elasticsearch/api/actions/cluster/pending_tasks.rb +1 -1
- data/lib/elasticsearch/api/actions/cluster/post_voting_config_exclusions.rb +1 -1
- data/lib/elasticsearch/api/actions/cluster/put_component_template.rb +1 -1
- data/lib/elasticsearch/api/actions/cluster/put_settings.rb +1 -1
- data/lib/elasticsearch/api/actions/cluster/remote_info.rb +1 -1
- data/lib/elasticsearch/api/actions/cluster/reroute.rb +2 -4
- data/lib/elasticsearch/api/actions/cluster/state.rb +3 -7
- data/lib/elasticsearch/api/actions/cluster/stats.rb +1 -1
- data/lib/elasticsearch/api/actions/count.rb +3 -7
- data/lib/elasticsearch/api/actions/create.rb +4 -8
- data/lib/elasticsearch/api/actions/dangling_indices/delete_dangling_index.rb +1 -1
- data/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb +1 -1
- data/lib/elasticsearch/api/actions/dangling_indices/list_dangling_indices.rb +1 -1
- data/lib/elasticsearch/api/actions/delete.rb +4 -8
- data/lib/elasticsearch/api/actions/delete_by_query.rb +6 -14
- data/lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb +2 -2
- data/lib/elasticsearch/api/actions/delete_script.rb +1 -1
- data/lib/elasticsearch/api/actions/exists.rb +3 -5
- data/lib/elasticsearch/api/actions/exists_source.rb +3 -5
- data/lib/elasticsearch/api/actions/explain.rb +3 -5
- data/lib/elasticsearch/api/actions/field_caps.rb +2 -4
- data/lib/elasticsearch/api/actions/get.rb +3 -5
- data/lib/elasticsearch/api/actions/get_script.rb +1 -1
- data/lib/elasticsearch/api/actions/get_script_context.rb +5 -1
- data/lib/elasticsearch/api/actions/get_script_languages.rb +5 -1
- data/lib/elasticsearch/api/actions/get_source.rb +3 -5
- data/lib/elasticsearch/api/actions/index.rb +8 -12
- data/lib/elasticsearch/api/actions/indices/add_block.rb +2 -4
- data/lib/elasticsearch/api/actions/indices/analyze.rb +1 -2
- data/lib/elasticsearch/api/actions/indices/clear_cache.rb +2 -5
- data/lib/elasticsearch/api/actions/indices/clone.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/close.rb +2 -4
- data/lib/elasticsearch/api/actions/indices/create.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/delete.rb +2 -4
- data/lib/elasticsearch/api/actions/indices/delete_alias.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/delete_index_template.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/delete_template.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/exists.rb +2 -4
- data/lib/elasticsearch/api/actions/indices/exists_alias.rb +2 -4
- data/lib/elasticsearch/api/actions/indices/exists_index_template.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/exists_template.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/exists_type.rb +2 -4
- data/lib/elasticsearch/api/actions/indices/flush.rb +2 -4
- data/lib/elasticsearch/api/actions/indices/flush_synced.rb +7 -4
- data/lib/elasticsearch/api/actions/indices/forcemerge.rb +2 -4
- data/lib/elasticsearch/api/actions/indices/get.rb +2 -4
- data/lib/elasticsearch/api/actions/indices/get_alias.rb +2 -4
- data/lib/elasticsearch/api/actions/indices/get_field_mapping.rb +3 -5
- data/lib/elasticsearch/api/actions/indices/get_index_template.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/get_mapping.rb +4 -6
- data/lib/elasticsearch/api/actions/indices/get_settings.rb +2 -4
- data/lib/elasticsearch/api/actions/indices/get_template.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/get_upgrade.rb +8 -5
- data/lib/elasticsearch/api/actions/indices/open.rb +2 -4
- data/lib/elasticsearch/api/actions/indices/put_alias.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/put_index_template.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/put_mapping.rb +3 -5
- data/lib/elasticsearch/api/actions/indices/put_settings.rb +2 -4
- data/lib/elasticsearch/api/actions/indices/put_template.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/recovery.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/refresh.rb +2 -4
- data/lib/elasticsearch/api/actions/indices/resolve_index.rb +6 -4
- data/lib/elasticsearch/api/actions/indices/rollover.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/segments.rb +2 -4
- data/lib/elasticsearch/api/actions/indices/shard_stores.rb +3 -7
- data/lib/elasticsearch/api/actions/indices/shrink.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/simulate_index_template.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/simulate_template.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/split.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/stats.rb +4 -10
- data/lib/elasticsearch/api/actions/indices/update_aliases.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/upgrade.rb +8 -5
- data/lib/elasticsearch/api/actions/indices/validate_query.rb +4 -8
- data/lib/elasticsearch/api/actions/info.rb +1 -1
- data/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb +1 -1
- data/lib/elasticsearch/api/actions/ingest/get_pipeline.rb +1 -1
- data/lib/elasticsearch/api/actions/ingest/processor_grok.rb +1 -1
- data/lib/elasticsearch/api/actions/ingest/put_pipeline.rb +1 -1
- data/lib/elasticsearch/api/actions/ingest/simulate.rb +1 -1
- data/lib/elasticsearch/api/actions/mget.rb +2 -2
- data/lib/elasticsearch/api/actions/msearch.rb +4 -8
- data/lib/elasticsearch/api/actions/msearch_template.rb +2 -4
- data/lib/elasticsearch/api/actions/mtermvectors.rb +2 -4
- data/lib/elasticsearch/api/actions/nodes/hot_threads.rb +2 -4
- data/lib/elasticsearch/api/actions/nodes/info.rb +2 -4
- data/lib/elasticsearch/api/actions/nodes/reload_secure_settings.rb +1 -1
- data/lib/elasticsearch/api/actions/nodes/stats.rb +4 -10
- data/lib/elasticsearch/api/actions/nodes/usage.rb +2 -4
- data/lib/elasticsearch/api/actions/ping.rb +1 -1
- data/lib/elasticsearch/api/actions/put_script.rb +1 -2
- data/lib/elasticsearch/api/actions/rank_eval.rb +7 -7
- data/lib/elasticsearch/api/actions/reindex.rb +1 -1
- data/lib/elasticsearch/api/actions/reindex_rethrottle.rb +2 -2
- data/lib/elasticsearch/api/actions/render_search_template.rb +1 -1
- data/lib/elasticsearch/api/actions/scripts_painless_execute.rb +5 -1
- data/lib/elasticsearch/api/actions/scroll.rb +2 -3
- data/lib/elasticsearch/api/actions/search.rb +5 -13
- data/lib/elasticsearch/api/actions/search_shards.rb +2 -4
- data/lib/elasticsearch/api/actions/search_template.rb +3 -7
- data/lib/elasticsearch/api/actions/snapshot/cleanup_repository.rb +1 -1
- data/lib/elasticsearch/api/actions/snapshot/clone.rb +66 -0
- data/lib/elasticsearch/api/actions/snapshot/create.rb +1 -1
- data/lib/elasticsearch/api/actions/snapshot/create_repository.rb +1 -1
- data/lib/elasticsearch/api/actions/snapshot/delete.rb +1 -1
- data/lib/elasticsearch/api/actions/snapshot/delete_repository.rb +1 -1
- data/lib/elasticsearch/api/actions/snapshot/get.rb +1 -1
- data/lib/elasticsearch/api/actions/snapshot/get_repository.rb +1 -1
- data/lib/elasticsearch/api/actions/snapshot/restore.rb +1 -1
- data/lib/elasticsearch/api/actions/snapshot/status.rb +1 -1
- data/lib/elasticsearch/api/actions/snapshot/verify_repository.rb +1 -1
- data/lib/elasticsearch/api/actions/tasks/cancel.rb +5 -1
- data/lib/elasticsearch/api/actions/tasks/get.rb +5 -1
- data/lib/elasticsearch/api/actions/tasks/list.rb +6 -4
- data/lib/elasticsearch/api/actions/termvectors.rb +3 -5
- data/lib/elasticsearch/api/actions/update.rb +6 -6
- data/lib/elasticsearch/api/actions/update_by_query.rb +6 -14
- data/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb +2 -2
- data/lib/elasticsearch/api/version.rb +1 -1
- data/spec/elasticsearch/api/actions/msearch_spec.rb +16 -33
- data/spec/elasticsearch/api/actions/snapshot/clone_spec.rb +67 -0
- data/spec/elasticsearch/api/rest_api_yaml_spec.rb +13 -6
- data/spec/rest_yaml_tests_helper.rb +13 -9
- data/utils/thor/generate_source.rb +32 -4
- data/utils/thor/generator/endpoint_specifics.rb +2 -2
- data/utils/thor/templates/_documentation_top.erb +2 -1
- metadata +8 -11
- data/lib/elasticsearch/api/actions/indices/create_data_stream.rb +0 -49
- data/lib/elasticsearch/api/actions/indices/data_streams_stats.rb +0 -62
- data/lib/elasticsearch/api/actions/indices/delete_data_stream.rb +0 -48
- data/lib/elasticsearch/api/actions/indices/get_data_stream.rb +0 -50
- data/spec/elasticsearch/api/actions/indices/data_streams_stats_spec.rb +0 -72
|
@@ -26,12 +26,10 @@ module Elasticsearch
|
|
|
26
26
|
# @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
|
|
27
27
|
# @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
|
28
28
|
# @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
|
|
29
|
-
# @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
|
|
30
|
-
# (options: open,closed,hidden,none,all)
|
|
31
|
-
|
|
29
|
+
# @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
|
|
32
30
|
# @option arguments [Hash] :headers Custom HTTP headers
|
|
33
31
|
#
|
|
34
|
-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.
|
|
32
|
+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/search-shards.html
|
|
35
33
|
#
|
|
36
34
|
def search_shards(arguments = {})
|
|
37
35
|
headers = arguments.delete(:headers) || {}
|
|
@@ -25,15 +25,11 @@ module Elasticsearch
|
|
|
25
25
|
# @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
|
26
26
|
# @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled
|
|
27
27
|
# @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
|
|
28
|
-
# @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
|
|
29
|
-
# (options: open,closed,hidden,none,all)
|
|
30
|
-
|
|
28
|
+
# @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
|
|
31
29
|
# @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
|
|
32
30
|
# @option arguments [List] :routing A comma-separated list of specific routing values
|
|
33
31
|
# @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search
|
|
34
|
-
# @option arguments [String] :search_type Search operation type
|
|
35
|
-
# (options: query_then_fetch,query_and_fetch,dfs_query_then_fetch,dfs_query_and_fetch)
|
|
36
|
-
|
|
32
|
+
# @option arguments [String] :search_type Search operation type (options: query_then_fetch, query_and_fetch, dfs_query_then_fetch, dfs_query_and_fetch)
|
|
37
33
|
# @option arguments [Boolean] :explain Specify whether to return detailed information about score computation as part of a hit
|
|
38
34
|
# @option arguments [Boolean] :profile Specify whether to profile the query execution
|
|
39
35
|
# @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
|
|
@@ -47,7 +43,7 @@ module Elasticsearch
|
|
|
47
43
|
# Deprecated since version 7.0.0
|
|
48
44
|
#
|
|
49
45
|
#
|
|
50
|
-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.
|
|
46
|
+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/search-template.html
|
|
51
47
|
#
|
|
52
48
|
def search_template(arguments = {})
|
|
53
49
|
raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
|
|
@@ -26,7 +26,7 @@ module Elasticsearch
|
|
|
26
26
|
# @option arguments [Time] :timeout Explicit operation timeout
|
|
27
27
|
# @option arguments [Hash] :headers Custom HTTP headers
|
|
28
28
|
#
|
|
29
|
-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.
|
|
29
|
+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/clean-up-snapshot-repo-api.html
|
|
30
30
|
#
|
|
31
31
|
def cleanup_repository(arguments = {})
|
|
32
32
|
raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
|
|
@@ -0,0 +1,66 @@
|
|
|
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
|
+
module Elasticsearch
|
|
19
|
+
module API
|
|
20
|
+
module Snapshot
|
|
21
|
+
module Actions
|
|
22
|
+
# Clones indices from one snapshot into another snapshot in the same repository.
|
|
23
|
+
#
|
|
24
|
+
# @option arguments [String] :repository A repository name
|
|
25
|
+
# @option arguments [String] :snapshot The name of the snapshot to clone from
|
|
26
|
+
# @option arguments [String] :target_snapshot The name of the cloned snapshot to create
|
|
27
|
+
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
|
|
28
|
+
# @option arguments [Hash] :headers Custom HTTP headers
|
|
29
|
+
# @option arguments [Hash] :body The snapshot clone definition (*Required*)
|
|
30
|
+
#
|
|
31
|
+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/modules-snapshots.html
|
|
32
|
+
#
|
|
33
|
+
def clone(arguments = {})
|
|
34
|
+
raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
|
|
35
|
+
raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
|
|
36
|
+
raise ArgumentError, "Required argument 'snapshot' missing" unless arguments[:snapshot]
|
|
37
|
+
raise ArgumentError, "Required argument 'target_snapshot' missing" unless arguments[:target_snapshot]
|
|
38
|
+
|
|
39
|
+
headers = arguments.delete(:headers) || {}
|
|
40
|
+
|
|
41
|
+
arguments = arguments.clone
|
|
42
|
+
|
|
43
|
+
_repository = arguments.delete(:repository)
|
|
44
|
+
|
|
45
|
+
_snapshot = arguments.delete(:snapshot)
|
|
46
|
+
|
|
47
|
+
_target_snapshot = arguments.delete(:target_snapshot)
|
|
48
|
+
|
|
49
|
+
method = Elasticsearch::API::HTTP_PUT
|
|
50
|
+
path = "_snapshot/#{Utils.__listify(_repository)}/#{Utils.__listify(_snapshot)}/_clone/#{Utils.__listify(_target_snapshot)}"
|
|
51
|
+
params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
|
|
52
|
+
|
|
53
|
+
body = arguments[:body]
|
|
54
|
+
perform_request(method, path, params, body, headers).body
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
# Register this action with its valid params when the module is loaded.
|
|
58
|
+
#
|
|
59
|
+
# @since 6.2.0
|
|
60
|
+
ParamsRegistry.register(:clone, [
|
|
61
|
+
:master_timeout
|
|
62
|
+
].freeze)
|
|
63
|
+
end
|
|
64
|
+
end
|
|
65
|
+
end
|
|
66
|
+
end
|
|
@@ -28,7 +28,7 @@ module Elasticsearch
|
|
|
28
28
|
# @option arguments [Hash] :headers Custom HTTP headers
|
|
29
29
|
# @option arguments [Hash] :body The snapshot definition
|
|
30
30
|
#
|
|
31
|
-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.
|
|
31
|
+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/modules-snapshots.html
|
|
32
32
|
#
|
|
33
33
|
def create(arguments = {})
|
|
34
34
|
raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
|
|
@@ -28,7 +28,7 @@ module Elasticsearch
|
|
|
28
28
|
# @option arguments [Hash] :headers Custom HTTP headers
|
|
29
29
|
# @option arguments [Hash] :body The repository definition (*Required*)
|
|
30
30
|
#
|
|
31
|
-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.
|
|
31
|
+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/modules-snapshots.html
|
|
32
32
|
#
|
|
33
33
|
def create_repository(arguments = {})
|
|
34
34
|
raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
|
|
@@ -26,7 +26,7 @@ module Elasticsearch
|
|
|
26
26
|
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
|
|
27
27
|
# @option arguments [Hash] :headers Custom HTTP headers
|
|
28
28
|
#
|
|
29
|
-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.
|
|
29
|
+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/modules-snapshots.html
|
|
30
30
|
#
|
|
31
31
|
def delete(arguments = {})
|
|
32
32
|
raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
|
|
@@ -26,7 +26,7 @@ module Elasticsearch
|
|
|
26
26
|
# @option arguments [Time] :timeout Explicit operation timeout
|
|
27
27
|
# @option arguments [Hash] :headers Custom HTTP headers
|
|
28
28
|
#
|
|
29
|
-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.
|
|
29
|
+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/modules-snapshots.html
|
|
30
30
|
#
|
|
31
31
|
def delete_repository(arguments = {})
|
|
32
32
|
raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
|
|
@@ -28,7 +28,7 @@ module Elasticsearch
|
|
|
28
28
|
# @option arguments [Boolean] :verbose Whether to show verbose snapshot info or only show the basic info found in the repository index blob
|
|
29
29
|
# @option arguments [Hash] :headers Custom HTTP headers
|
|
30
30
|
#
|
|
31
|
-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.
|
|
31
|
+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/modules-snapshots.html
|
|
32
32
|
#
|
|
33
33
|
def get(arguments = {})
|
|
34
34
|
raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
|
|
@@ -26,7 +26,7 @@ module Elasticsearch
|
|
|
26
26
|
# @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
|
|
27
27
|
# @option arguments [Hash] :headers Custom HTTP headers
|
|
28
28
|
#
|
|
29
|
-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.
|
|
29
|
+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/modules-snapshots.html
|
|
30
30
|
#
|
|
31
31
|
def get_repository(arguments = {})
|
|
32
32
|
headers = arguments.delete(:headers) || {}
|
|
@@ -28,7 +28,7 @@ module Elasticsearch
|
|
|
28
28
|
# @option arguments [Hash] :headers Custom HTTP headers
|
|
29
29
|
# @option arguments [Hash] :body Details of what to restore
|
|
30
30
|
#
|
|
31
|
-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.
|
|
31
|
+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/modules-snapshots.html
|
|
32
32
|
#
|
|
33
33
|
def restore(arguments = {})
|
|
34
34
|
raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
|
|
@@ -27,7 +27,7 @@ module Elasticsearch
|
|
|
27
27
|
# @option arguments [Boolean] :ignore_unavailable Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown
|
|
28
28
|
# @option arguments [Hash] :headers Custom HTTP headers
|
|
29
29
|
#
|
|
30
|
-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.
|
|
30
|
+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/modules-snapshots.html
|
|
31
31
|
#
|
|
32
32
|
def status(arguments = {})
|
|
33
33
|
headers = arguments.delete(:headers) || {}
|
|
@@ -26,7 +26,7 @@ module Elasticsearch
|
|
|
26
26
|
# @option arguments [Time] :timeout Explicit operation timeout
|
|
27
27
|
# @option arguments [Hash] :headers Custom HTTP headers
|
|
28
28
|
#
|
|
29
|
-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.
|
|
29
|
+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/modules-snapshots.html
|
|
30
30
|
#
|
|
31
31
|
def verify_repository(arguments = {})
|
|
32
32
|
raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
|
|
@@ -20,6 +20,10 @@ module Elasticsearch
|
|
|
20
20
|
module Tasks
|
|
21
21
|
module Actions
|
|
22
22
|
# Cancels a task, if it can be cancelled through an API.
|
|
23
|
+
# This functionality is Experimental and may be changed or removed
|
|
24
|
+
# completely in a future release. Elastic will take a best effort approach
|
|
25
|
+
# to fix any issues, but experimental features are not subject to the
|
|
26
|
+
# support SLA of official GA features.
|
|
23
27
|
#
|
|
24
28
|
# @option arguments [String] :task_id Cancel the task with specified task id (node_id:task_number)
|
|
25
29
|
# @option arguments [List] :nodes A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
|
|
@@ -28,7 +32,7 @@ module Elasticsearch
|
|
|
28
32
|
# @option arguments [Boolean] :wait_for_completion Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false
|
|
29
33
|
# @option arguments [Hash] :headers Custom HTTP headers
|
|
30
34
|
#
|
|
31
|
-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.
|
|
35
|
+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/tasks.html
|
|
32
36
|
#
|
|
33
37
|
def cancel(arguments = {})
|
|
34
38
|
headers = arguments.delete(:headers) || {}
|
|
@@ -20,13 +20,17 @@ module Elasticsearch
|
|
|
20
20
|
module Tasks
|
|
21
21
|
module Actions
|
|
22
22
|
# Returns information about a task.
|
|
23
|
+
# This functionality is Experimental and may be changed or removed
|
|
24
|
+
# completely in a future release. Elastic will take a best effort approach
|
|
25
|
+
# to fix any issues, but experimental features are not subject to the
|
|
26
|
+
# support SLA of official GA features.
|
|
23
27
|
#
|
|
24
28
|
# @option arguments [String] :task_id Return the task with specified id (node_id:task_number)
|
|
25
29
|
# @option arguments [Boolean] :wait_for_completion Wait for the matching tasks to complete (default: false)
|
|
26
30
|
# @option arguments [Time] :timeout Explicit operation timeout
|
|
27
31
|
# @option arguments [Hash] :headers Custom HTTP headers
|
|
28
32
|
#
|
|
29
|
-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.
|
|
33
|
+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/tasks.html
|
|
30
34
|
#
|
|
31
35
|
def get(arguments = {})
|
|
32
36
|
headers = arguments.delete(:headers) || {}
|
|
@@ -20,19 +20,21 @@ module Elasticsearch
|
|
|
20
20
|
module Tasks
|
|
21
21
|
module Actions
|
|
22
22
|
# Returns a list of tasks.
|
|
23
|
+
# This functionality is Experimental and may be changed or removed
|
|
24
|
+
# completely in a future release. Elastic will take a best effort approach
|
|
25
|
+
# to fix any issues, but experimental features are not subject to the
|
|
26
|
+
# support SLA of official GA features.
|
|
23
27
|
#
|
|
24
28
|
# @option arguments [List] :nodes A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
|
|
25
29
|
# @option arguments [List] :actions A comma-separated list of actions that should be returned. Leave empty to return all.
|
|
26
30
|
# @option arguments [Boolean] :detailed Return detailed task information (default: false)
|
|
27
31
|
# @option arguments [String] :parent_task_id Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all.
|
|
28
32
|
# @option arguments [Boolean] :wait_for_completion Wait for the matching tasks to complete (default: false)
|
|
29
|
-
# @option arguments [String] :group_by Group tasks by nodes or parent/child relationships
|
|
30
|
-
# (options: nodes,parents,none)
|
|
31
|
-
|
|
33
|
+
# @option arguments [String] :group_by Group tasks by nodes or parent/child relationships (options: nodes, parents, none)
|
|
32
34
|
# @option arguments [Time] :timeout Explicit operation timeout
|
|
33
35
|
# @option arguments [Hash] :headers Custom HTTP headers
|
|
34
36
|
#
|
|
35
|
-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.
|
|
37
|
+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/tasks.html
|
|
36
38
|
#
|
|
37
39
|
def list(arguments = {})
|
|
38
40
|
headers = arguments.delete(:headers) || {}
|
|
@@ -20,7 +20,7 @@ module Elasticsearch
|
|
|
20
20
|
module Actions
|
|
21
21
|
# Returns information and statistics about terms in the fields of a particular document.
|
|
22
22
|
#
|
|
23
|
-
# @option arguments [String] :index The index in which the document resides.
|
|
23
|
+
# @option arguments [String] :index The index in which the document resides. (*Required*)
|
|
24
24
|
# @option arguments [String] :id The id of the document, when not specified a doc param should be supplied.
|
|
25
25
|
# @option arguments [String] :type The type of the document.
|
|
26
26
|
# @option arguments [Boolean] :term_statistics Specifies if total term frequency and document frequency should be returned.
|
|
@@ -33,9 +33,7 @@ module Elasticsearch
|
|
|
33
33
|
# @option arguments [String] :routing Specific routing value.
|
|
34
34
|
# @option arguments [Boolean] :realtime Specifies if request is real-time as opposed to near-real-time (default: true).
|
|
35
35
|
# @option arguments [Number] :version Explicit version number for concurrency control
|
|
36
|
-
# @option arguments [String] :version_type Specific version type
|
|
37
|
-
# (options: internal,external,external_gte,force)
|
|
38
|
-
|
|
36
|
+
# @option arguments [String] :version_type Specific version type (options: internal, external, external_gte, force)
|
|
39
37
|
# @option arguments [Hash] :headers Custom HTTP headers
|
|
40
38
|
# @option arguments [Hash] :body Define parameters and or supply a document to get termvectors for. See documentation.
|
|
41
39
|
#
|
|
@@ -44,7 +42,7 @@ module Elasticsearch
|
|
|
44
42
|
# Deprecated since version 7.0.0
|
|
45
43
|
#
|
|
46
44
|
#
|
|
47
|
-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.
|
|
45
|
+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/docs-termvectors.html
|
|
48
46
|
#
|
|
49
47
|
def termvectors(arguments = {})
|
|
50
48
|
raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
|
|
@@ -22,20 +22,19 @@ module Elasticsearch
|
|
|
22
22
|
#
|
|
23
23
|
# @option arguments [String] :id Document ID
|
|
24
24
|
# @option arguments [String] :index The name of the index
|
|
25
|
-
# @option arguments [String] :type The type of the document
|
|
25
|
+
# @option arguments [String] :type The type of the document *Deprecated*
|
|
26
26
|
# @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the update operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
|
|
27
27
|
# @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return
|
|
28
28
|
# @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field
|
|
29
29
|
# @option arguments [List] :_source_includes A list of fields to extract and return from the _source field
|
|
30
30
|
# @option arguments [String] :lang The script language (default: painless)
|
|
31
|
-
# @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes.
|
|
32
|
-
# (options: true,false,wait_for)
|
|
33
|
-
|
|
31
|
+
# @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (options: true, false, wait_for)
|
|
34
32
|
# @option arguments [Number] :retry_on_conflict Specify how many times should the operation be retried when a conflict occurs (default: 0)
|
|
35
33
|
# @option arguments [String] :routing Specific routing value
|
|
36
34
|
# @option arguments [Time] :timeout Explicit operation timeout
|
|
37
35
|
# @option arguments [Number] :if_seq_no only perform the update operation if the last operation that has changed the document has the specified sequence number
|
|
38
36
|
# @option arguments [Number] :if_primary_term only perform the update operation if the last operation that has changed the document has the specified primary term
|
|
37
|
+
# @option arguments [Boolean] :require_alias When true, requires destination is an alias. Default is false
|
|
39
38
|
# @option arguments [Hash] :headers Custom HTTP headers
|
|
40
39
|
# @option arguments [Hash] :body The request definition requires either `script` or partial `doc` (*Required*)
|
|
41
40
|
#
|
|
@@ -44,7 +43,7 @@ module Elasticsearch
|
|
|
44
43
|
# Deprecated since version 7.0.0
|
|
45
44
|
#
|
|
46
45
|
#
|
|
47
|
-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.
|
|
46
|
+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/docs-update.html
|
|
48
47
|
#
|
|
49
48
|
def update(arguments = {})
|
|
50
49
|
raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
|
|
@@ -91,7 +90,8 @@ module Elasticsearch
|
|
|
91
90
|
:routing,
|
|
92
91
|
:timeout,
|
|
93
92
|
:if_seq_no,
|
|
94
|
-
:if_primary_term
|
|
93
|
+
:if_primary_term,
|
|
94
|
+
:require_alias
|
|
95
95
|
].freeze)
|
|
96
96
|
end
|
|
97
97
|
end
|
|
@@ -21,32 +21,24 @@ module Elasticsearch
|
|
|
21
21
|
# Performs an update on every document in the index without changing the source,
|
|
22
22
|
# for example to pick up a mapping change.
|
|
23
23
|
#
|
|
24
|
-
# @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
|
24
|
+
# @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices (*Required*)
|
|
25
25
|
# @option arguments [List] :type A comma-separated list of document types to search; leave empty to perform the operation on all types
|
|
26
26
|
# @option arguments [String] :analyzer The analyzer to use for the query string
|
|
27
27
|
# @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false)
|
|
28
|
-
# @option arguments [String] :default_operator The default operator for query string query (AND or OR)
|
|
29
|
-
# (options: AND,OR)
|
|
30
|
-
|
|
28
|
+
# @option arguments [String] :default_operator The default operator for query string query (AND or OR) (options: AND, OR)
|
|
31
29
|
# @option arguments [String] :df The field to use as default where no field prefix is given in the query string
|
|
32
30
|
# @option arguments [Number] :from Starting offset (default: 0)
|
|
33
31
|
# @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
|
34
32
|
# @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
|
|
35
|
-
# @option arguments [String] :conflicts What to do when the update by query hits version conflicts?
|
|
36
|
-
#
|
|
37
|
-
|
|
38
|
-
# @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
|
|
39
|
-
# (options: open,closed,hidden,none,all)
|
|
40
|
-
|
|
33
|
+
# @option arguments [String] :conflicts What to do when the update by query hits version conflicts? (options: abort, proceed)
|
|
34
|
+
# @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
|
|
41
35
|
# @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
|
|
42
36
|
# @option arguments [String] :pipeline Ingest pipeline to set on index requests made by this action. (default: none)
|
|
43
37
|
# @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
|
|
44
38
|
# @option arguments [String] :q Query in the Lucene query string syntax
|
|
45
39
|
# @option arguments [List] :routing A comma-separated list of specific routing values
|
|
46
40
|
# @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search
|
|
47
|
-
# @option arguments [String] :search_type Search operation type
|
|
48
|
-
# (options: query_then_fetch,dfs_query_then_fetch)
|
|
49
|
-
|
|
41
|
+
# @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch)
|
|
50
42
|
# @option arguments [Time] :search_timeout Explicit timeout for each search request. Defaults to no timeout.
|
|
51
43
|
# @option arguments [Number] :size Deprecated, please use `max_docs` instead
|
|
52
44
|
# @option arguments [Number] :max_docs Maximum number of documents to process (default: all documents)
|
|
@@ -74,7 +66,7 @@ module Elasticsearch
|
|
|
74
66
|
# Deprecated since version 7.0.0
|
|
75
67
|
#
|
|
76
68
|
#
|
|
77
|
-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.
|
|
69
|
+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/docs-update-by-query.html
|
|
78
70
|
#
|
|
79
71
|
def update_by_query(arguments = {})
|
|
80
72
|
raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
|
|
@@ -21,10 +21,10 @@ module Elasticsearch
|
|
|
21
21
|
# Changes the number of requests per second for a particular Update By Query operation.
|
|
22
22
|
#
|
|
23
23
|
# @option arguments [String] :task_id The task id to rethrottle
|
|
24
|
-
# @option arguments [Number] :requests_per_second The throttle to set on this request in floating sub-requests per second. -1 means set no throttle.
|
|
24
|
+
# @option arguments [Number] :requests_per_second The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. (*Required*)
|
|
25
25
|
# @option arguments [Hash] :headers Custom HTTP headers
|
|
26
26
|
#
|
|
27
|
-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.
|
|
27
|
+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/docs-update-by-query.html
|
|
28
28
|
#
|
|
29
29
|
def update_by_query_rethrottle(arguments = {})
|
|
30
30
|
raise ArgumentError, "Required argument 'task_id' missing" unless arguments[:task_id]
|
|
@@ -49,13 +49,12 @@ describe 'client#msearch' do
|
|
|
49
49
|
end
|
|
50
50
|
|
|
51
51
|
it 'requires the :body argument' do
|
|
52
|
-
expect
|
|
52
|
+
expect do
|
|
53
53
|
client.msearch
|
|
54
|
-
|
|
54
|
+
end.to raise_exception(ArgumentError)
|
|
55
55
|
end
|
|
56
56
|
|
|
57
57
|
context 'when the body is an object' do
|
|
58
|
-
|
|
59
58
|
let(:body) do
|
|
60
59
|
<<-PAYLOAD.gsub(/^\s+/, '')
|
|
61
60
|
{"index":"foo"}
|
|
@@ -68,16 +67,19 @@ describe 'client#msearch' do
|
|
|
68
67
|
end
|
|
69
68
|
|
|
70
69
|
it 'performs the request' do
|
|
71
|
-
expect(
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
70
|
+
expect(
|
|
71
|
+
client_double.msearch(
|
|
72
|
+
body: [
|
|
73
|
+
{ index: 'foo', search: { query: { match_all: {} } } },
|
|
74
|
+
{ index: 'bar', search: { query: { match: { foo: 'bar' } } } },
|
|
75
|
+
{ search_type: 'count', search: { facets: { tags: {} } } }
|
|
76
|
+
]
|
|
77
|
+
)
|
|
78
|
+
)
|
|
76
79
|
end
|
|
77
80
|
end
|
|
78
81
|
|
|
79
82
|
context 'when the body is a string' do
|
|
80
|
-
|
|
81
83
|
let(:body) do
|
|
82
84
|
%Q|{"foo":"bar"}\n{"moo":"lam"}|
|
|
83
85
|
end
|
|
@@ -88,7 +90,6 @@ describe 'client#msearch' do
|
|
|
88
90
|
end
|
|
89
91
|
|
|
90
92
|
context 'when an index is specified' do
|
|
91
|
-
|
|
92
93
|
let(:url) do
|
|
93
94
|
'foo/_msearch'
|
|
94
95
|
end
|
|
@@ -102,25 +103,9 @@ describe 'client#msearch' do
|
|
|
102
103
|
end
|
|
103
104
|
end
|
|
104
105
|
|
|
105
|
-
context 'when
|
|
106
|
-
|
|
107
|
-
let(:url) do
|
|
108
|
-
'foo/bar/_msearch'
|
|
109
|
-
end
|
|
110
|
-
|
|
111
|
-
let(:body) do
|
|
112
|
-
''
|
|
113
|
-
end
|
|
114
|
-
|
|
115
|
-
it 'performs the request' do
|
|
116
|
-
expect(client_double.msearch(index: 'foo', type: 'bar', body: []))
|
|
117
|
-
end
|
|
118
|
-
end
|
|
119
|
-
|
|
120
|
-
context 'when multiple indices and multiple types are specified' do
|
|
121
|
-
|
|
106
|
+
context 'when multiple indices are specified' do
|
|
122
107
|
let(:url) do
|
|
123
|
-
'foo,bar/
|
|
108
|
+
'foo,bar/_msearch'
|
|
124
109
|
end
|
|
125
110
|
|
|
126
111
|
let(:body) do
|
|
@@ -128,14 +113,13 @@ describe 'client#msearch' do
|
|
|
128
113
|
end
|
|
129
114
|
|
|
130
115
|
it 'performs the request' do
|
|
131
|
-
expect(client_double.msearch(index: ['foo', 'bar'],
|
|
116
|
+
expect(client_double.msearch(index: ['foo', 'bar'], body: []))
|
|
132
117
|
end
|
|
133
118
|
end
|
|
134
119
|
|
|
135
120
|
context 'when the request needs to be URL-escaped' do
|
|
136
|
-
|
|
137
121
|
let(:url) do
|
|
138
|
-
'foo%5Ebar/
|
|
122
|
+
'foo%5Ebar/_msearch'
|
|
139
123
|
end
|
|
140
124
|
|
|
141
125
|
let(:body) do
|
|
@@ -143,12 +127,11 @@ describe 'client#msearch' do
|
|
|
143
127
|
end
|
|
144
128
|
|
|
145
129
|
it 'performs the request' do
|
|
146
|
-
expect(client_double.msearch(index: 'foo^bar',
|
|
130
|
+
expect(client_double.msearch(index: 'foo^bar', body: [])).to eq({})
|
|
147
131
|
end
|
|
148
132
|
end
|
|
149
133
|
|
|
150
134
|
context 'when the URL params need to be URL-encoded' do
|
|
151
|
-
|
|
152
135
|
let(:url) do
|
|
153
136
|
'_msearch'
|
|
154
137
|
end
|