elasticsearch-api 6.2.0 → 6.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (184) hide show
  1. checksums.yaml +4 -4
  2. data/lib/elasticsearch/api/actions/abort_benchmark.rb +1 -1
  3. data/lib/elasticsearch/api/actions/benchmark.rb +1 -1
  4. data/lib/elasticsearch/api/actions/bulk.rb +4 -6
  5. data/lib/elasticsearch/api/actions/cat/aliases.rb +10 -10
  6. data/lib/elasticsearch/api/actions/cat/allocation.rb +11 -11
  7. data/lib/elasticsearch/api/actions/cat/count.rb +10 -10
  8. data/lib/elasticsearch/api/actions/cat/fielddata.rb +9 -7
  9. data/lib/elasticsearch/api/actions/cat/health.rb +11 -11
  10. data/lib/elasticsearch/api/actions/cat/help.rb +4 -2
  11. data/lib/elasticsearch/api/actions/cat/indices.rb +14 -15
  12. data/lib/elasticsearch/api/actions/cat/master.rb +10 -10
  13. data/lib/elasticsearch/api/actions/cat/nodeattrs.rb +6 -4
  14. data/lib/elasticsearch/api/actions/cat/nodes.rb +10 -10
  15. data/lib/elasticsearch/api/actions/cat/pending_tasks.rb +10 -10
  16. data/lib/elasticsearch/api/actions/cat/plugins.rb +7 -6
  17. data/lib/elasticsearch/api/actions/cat/recovery.rb +10 -12
  18. data/lib/elasticsearch/api/actions/cat/repositories.rb +7 -3
  19. data/lib/elasticsearch/api/actions/cat/segments.rb +9 -7
  20. data/lib/elasticsearch/api/actions/cat/shards.rb +12 -12
  21. data/lib/elasticsearch/api/actions/cat/snapshots.rb +8 -4
  22. data/lib/elasticsearch/api/actions/cat/tasks.rb +4 -6
  23. data/lib/elasticsearch/api/actions/cat/templates.rb +6 -6
  24. data/lib/elasticsearch/api/actions/cat/thread_pool.rb +13 -17
  25. data/lib/elasticsearch/api/actions/clear_scroll.rb +7 -0
  26. data/lib/elasticsearch/api/actions/cluster/allocation_explain.rb +2 -3
  27. data/lib/elasticsearch/api/actions/cluster/get_settings.rb +5 -2
  28. data/lib/elasticsearch/api/actions/cluster/health.rb +11 -20
  29. data/lib/elasticsearch/api/actions/cluster/pending_tasks.rb +2 -3
  30. data/lib/elasticsearch/api/actions/cluster/put_settings.rb +8 -3
  31. data/lib/elasticsearch/api/actions/cluster/remote_info.rb +7 -1
  32. data/lib/elasticsearch/api/actions/cluster/reroute.rb +7 -7
  33. data/lib/elasticsearch/api/actions/cluster/state.rb +18 -15
  34. data/lib/elasticsearch/api/actions/cluster/stats.rb +12 -5
  35. data/lib/elasticsearch/api/actions/count.rb +12 -23
  36. data/lib/elasticsearch/api/actions/count_percolate.rb +1 -1
  37. data/lib/elasticsearch/api/actions/delete.rb +16 -8
  38. data/lib/elasticsearch/api/actions/delete_by_query.rb +7 -9
  39. data/lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb +29 -0
  40. data/lib/elasticsearch/api/actions/delete_script.rb +5 -6
  41. data/lib/elasticsearch/api/actions/exists.rb +3 -4
  42. data/lib/elasticsearch/api/actions/exists_source.rb +51 -0
  43. data/lib/elasticsearch/api/actions/explain.rb +11 -25
  44. data/lib/elasticsearch/api/actions/field_caps.rb +2 -2
  45. data/lib/elasticsearch/api/actions/get.rb +13 -19
  46. data/lib/elasticsearch/api/actions/get_script.rb +9 -2
  47. data/lib/elasticsearch/api/actions/get_source.rb +10 -14
  48. data/lib/elasticsearch/api/actions/index.rb +10 -16
  49. data/lib/elasticsearch/api/actions/indices/analyze.rb +3 -27
  50. data/lib/elasticsearch/api/actions/indices/clear_cache.rb +2 -4
  51. data/lib/elasticsearch/api/actions/indices/close.rb +9 -15
  52. data/lib/elasticsearch/api/actions/indices/create.rb +7 -7
  53. data/lib/elasticsearch/api/actions/indices/delete.rb +3 -4
  54. data/lib/elasticsearch/api/actions/indices/delete_alias.rb +7 -4
  55. data/lib/elasticsearch/api/actions/indices/delete_template.rb +5 -2
  56. data/lib/elasticsearch/api/actions/indices/exists.rb +11 -17
  57. data/lib/elasticsearch/api/actions/indices/exists_alias.rb +6 -14
  58. data/lib/elasticsearch/api/actions/indices/exists_template.rb +8 -4
  59. data/lib/elasticsearch/api/actions/indices/exists_type.rb +6 -15
  60. data/lib/elasticsearch/api/actions/indices/flush.rb +5 -9
  61. data/lib/elasticsearch/api/actions/indices/flush_synced.rb +1 -1
  62. data/lib/elasticsearch/api/actions/indices/forcemerge.rb +13 -11
  63. data/lib/elasticsearch/api/actions/indices/freeze.rb +0 -1
  64. data/lib/elasticsearch/api/actions/indices/get.rb +9 -15
  65. data/lib/elasticsearch/api/actions/indices/get_alias.rb +6 -14
  66. data/lib/elasticsearch/api/actions/indices/get_field_mapping.rb +11 -15
  67. data/lib/elasticsearch/api/actions/indices/get_mapping.rb +12 -16
  68. data/lib/elasticsearch/api/actions/indices/get_settings.rb +12 -21
  69. data/lib/elasticsearch/api/actions/indices/get_template.rb +8 -5
  70. data/lib/elasticsearch/api/actions/indices/open.rb +9 -15
  71. data/lib/elasticsearch/api/actions/indices/put_alias.rb +6 -3
  72. data/lib/elasticsearch/api/actions/indices/put_mapping.rb +11 -23
  73. data/lib/elasticsearch/api/actions/indices/put_settings.rb +10 -20
  74. data/lib/elasticsearch/api/actions/indices/put_template.rb +10 -5
  75. data/lib/elasticsearch/api/actions/indices/recovery.rb +2 -4
  76. data/lib/elasticsearch/api/actions/indices/refresh.rb +6 -14
  77. data/lib/elasticsearch/api/actions/indices/rollover.rb +6 -5
  78. data/lib/elasticsearch/api/actions/indices/segments.rb +6 -14
  79. data/lib/elasticsearch/api/actions/indices/shard_stores.rb +2 -4
  80. data/lib/elasticsearch/api/actions/indices/shrink.rb +6 -7
  81. data/lib/elasticsearch/api/actions/indices/split.rb +2 -1
  82. data/lib/elasticsearch/api/actions/indices/update_aliases.rb +7 -4
  83. data/lib/elasticsearch/api/actions/indices/upgrade.rb +10 -13
  84. data/lib/elasticsearch/api/actions/indices/validate_query.rb +14 -25
  85. data/lib/elasticsearch/api/actions/info.rb +6 -0
  86. data/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb +1 -1
  87. data/lib/elasticsearch/api/actions/ingest/get_pipeline.rb +4 -3
  88. data/lib/elasticsearch/api/actions/ingest/processor_grok.rb +29 -0
  89. data/lib/elasticsearch/api/actions/ingest/put_pipeline.rb +1 -1
  90. data/lib/elasticsearch/api/actions/ingest/simulate.rb +5 -5
  91. data/lib/elasticsearch/api/actions/mget.rb +8 -17
  92. data/lib/elasticsearch/api/actions/msearch.rb +7 -2
  93. data/lib/elasticsearch/api/actions/msearch_template.rb +8 -1
  94. data/lib/elasticsearch/api/actions/mtermvectors.rb +21 -22
  95. data/lib/elasticsearch/api/actions/nodes/hot_threads.rb +4 -6
  96. data/lib/elasticsearch/api/actions/nodes/info.rb +6 -26
  97. data/lib/elasticsearch/api/actions/nodes/reload_secure_settings.rb +10 -4
  98. data/lib/elasticsearch/api/actions/nodes/stats.rb +11 -30
  99. data/lib/elasticsearch/api/actions/nodes/usage.rb +31 -0
  100. data/lib/elasticsearch/api/actions/ping.rb +6 -0
  101. data/lib/elasticsearch/api/actions/put_script.rb +10 -9
  102. data/lib/elasticsearch/api/actions/rank_eval.rb +36 -0
  103. data/lib/elasticsearch/api/actions/reindex.rb +9 -14
  104. data/lib/elasticsearch/api/actions/reindex_rethrottle.rb +29 -0
  105. data/lib/elasticsearch/api/actions/render_search_template.rb +1 -1
  106. data/lib/elasticsearch/api/actions/scripts_painless_execute.rb +27 -0
  107. data/lib/elasticsearch/api/actions/scroll.rb +3 -2
  108. data/lib/elasticsearch/api/actions/search.rb +36 -53
  109. data/lib/elasticsearch/api/actions/search_shards.rb +7 -14
  110. data/lib/elasticsearch/api/actions/search_template.rb +20 -19
  111. data/lib/elasticsearch/api/actions/snapshot/create.rb +2 -3
  112. data/lib/elasticsearch/api/actions/snapshot/create_repository.rb +4 -3
  113. data/lib/elasticsearch/api/actions/snapshot/delete.rb +3 -3
  114. data/lib/elasticsearch/api/actions/snapshot/delete_repository.rb +1 -2
  115. data/lib/elasticsearch/api/actions/snapshot/get.rb +3 -3
  116. data/lib/elasticsearch/api/actions/snapshot/get_repository.rb +3 -6
  117. data/lib/elasticsearch/api/actions/snapshot/restore.rb +1 -1
  118. data/lib/elasticsearch/api/actions/snapshot/status.rb +4 -5
  119. data/lib/elasticsearch/api/actions/snapshot/verify_repository.rb +1 -2
  120. data/lib/elasticsearch/api/actions/tasks/cancel.rb +7 -13
  121. data/lib/elasticsearch/api/actions/tasks/get.rb +6 -3
  122. data/lib/elasticsearch/api/actions/tasks/list.rb +10 -16
  123. data/lib/elasticsearch/api/actions/termvectors.rb +22 -21
  124. data/lib/elasticsearch/api/actions/update.rb +19 -33
  125. data/lib/elasticsearch/api/actions/update_by_query.rb +13 -33
  126. data/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb +29 -0
  127. data/lib/elasticsearch/api/version.rb +1 -1
  128. data/spec/elasticsearch/api/actions/cluster/state_spec.rb +0 -17
  129. data/spec/elasticsearch/api/actions/cluster/stats_spec.rb +17 -0
  130. data/spec/elasticsearch/api/actions/indices/analyze_spec.rb +0 -37
  131. data/spec/elasticsearch/api/actions/indices/put_settings_spec.rb +0 -15
  132. data/spec/elasticsearch/api/actions/indices/refresh_spec.rb +0 -15
  133. data/spec/elasticsearch/api/actions/indices/segments_spec.rb +0 -15
  134. data/spec/elasticsearch/api/actions/mget_spec.rb +0 -15
  135. data/spec/elasticsearch/api/actions/search_spec.rb +0 -15
  136. data/test/integration/yaml_test_runner.rb +2 -4
  137. data/utils/thor/generate_source.rb +1 -0
  138. data/utils/thor/templates/ruby/method.erb +7 -5
  139. metadata +12 -73
  140. data/lib/elasticsearch/api/actions/delete_template.rb +0 -21
  141. data/lib/elasticsearch/api/actions/field_stats.rb +0 -36
  142. data/lib/elasticsearch/api/actions/get_template.rb +0 -27
  143. data/lib/elasticsearch/api/actions/indices/delete_mapping.rb +0 -26
  144. data/lib/elasticsearch/api/actions/indices/delete_warmer.rb +0 -32
  145. data/lib/elasticsearch/api/actions/indices/get_aliases.rb +0 -37
  146. data/lib/elasticsearch/api/actions/indices/get_warmer.rb +0 -62
  147. data/lib/elasticsearch/api/actions/indices/optimize.rb +0 -77
  148. data/lib/elasticsearch/api/actions/indices/put_warmer.rb +0 -65
  149. data/lib/elasticsearch/api/actions/indices/seal.rb +0 -24
  150. data/lib/elasticsearch/api/actions/indices/snapshot_index.rb +0 -44
  151. data/lib/elasticsearch/api/actions/indices/status.rb +0 -63
  152. data/lib/elasticsearch/api/actions/list_benchmarks.rb +0 -27
  153. data/lib/elasticsearch/api/actions/mlt.rb +0 -130
  154. data/lib/elasticsearch/api/actions/mpercolate.rb +0 -62
  155. data/lib/elasticsearch/api/actions/nodes/shutdown.rb +0 -39
  156. data/lib/elasticsearch/api/actions/percolate.rb +0 -73
  157. data/lib/elasticsearch/api/actions/put_template.rb +0 -25
  158. data/lib/elasticsearch/api/actions/remote/info.rb +0 -21
  159. data/lib/elasticsearch/api/actions/search_exists.rb +0 -63
  160. data/lib/elasticsearch/api/actions/suggest.rb +0 -49
  161. data/spec/elasticsearch/api/actions/delete_template_spec.rb +0 -17
  162. data/spec/elasticsearch/api/actions/field_stats_spec.rb +0 -17
  163. data/spec/elasticsearch/api/actions/get_template_spec.rb +0 -52
  164. data/spec/elasticsearch/api/actions/indices/delete_mapping_spec.rb +0 -77
  165. data/spec/elasticsearch/api/actions/indices/delete_warmer_spec.rb +0 -86
  166. data/spec/elasticsearch/api/actions/indices/freeze_spec.rb +0 -68
  167. data/spec/elasticsearch/api/actions/indices/get_aliases_spec.rb +0 -55
  168. data/spec/elasticsearch/api/actions/indices/get_warmer_spec.rb +0 -48
  169. data/spec/elasticsearch/api/actions/indices/optimize_spec.rb +0 -63
  170. data/spec/elasticsearch/api/actions/indices/put_warmer_spec.rb +0 -101
  171. data/spec/elasticsearch/api/actions/indices/seal_spec.rb +0 -18
  172. data/spec/elasticsearch/api/actions/indices/snapshot_index_spec.rb +0 -89
  173. data/spec/elasticsearch/api/actions/indices/stats_spec.rb +0 -108
  174. data/spec/elasticsearch/api/actions/indices/status_spec.rb +0 -92
  175. data/spec/elasticsearch/api/actions/indices/unfreeze_spec.rb +0 -68
  176. data/spec/elasticsearch/api/actions/list_benchmarks_spec.rb +0 -17
  177. data/spec/elasticsearch/api/actions/mlt_spec.rb +0 -117
  178. data/spec/elasticsearch/api/actions/mpercolate_spec.rb +0 -49
  179. data/spec/elasticsearch/api/actions/nodes/shutdown_spec.rb +0 -59
  180. data/spec/elasticsearch/api/actions/percolate_spec.rb +0 -67
  181. data/spec/elasticsearch/api/actions/put_template_spec.rb +0 -17
  182. data/spec/elasticsearch/api/actions/remote/info_spec.rb +0 -18
  183. data/spec/elasticsearch/api/actions/search_exists_spec.rb +0 -17
  184. data/spec/elasticsearch/api/actions/suggest_spec.rb +0 -77
@@ -4,22 +4,15 @@ module Elasticsearch
4
4
 
5
5
  # Returns the names of indices and shards on which a search request would be executed
6
6
  #
7
- # @option arguments [String] :index The name of the index
8
- # @option arguments [String] :type The type of the document
9
- # @option arguments [String] :preference Specify the node or shard the operation should be performed on
10
- # (default: random)
7
+ # @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
8
+ # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
11
9
  # @option arguments [String] :routing Specific routing value
12
- # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
13
- # (default: false)
14
- # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
15
- # unavailable (missing or closed)
16
- # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves
17
- # into no concrete indices.
18
- # (This includes `_all` or when no indices have been specified)
19
- # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices
20
- # that are open, closed or both. (options: open, closed)
10
+ # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
11
+ # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
12
+ # @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)
13
+ # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, none, all)
21
14
  #
22
- # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-shards.html
15
+ # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-shards.html
23
16
  #
24
17
  def search_shards(arguments={})
25
18
  method = HTTP_GET
@@ -18,25 +18,21 @@ module Elasticsearch
18
18
  # params: { start: "2014-02-01", end: "2014-03-01" }
19
19
  # }
20
20
  #
21
- # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty
22
- # string to perform the operation on all indices
23
- # @option arguments [List] :type A comma-separated list of document types to search;
24
- # leave empty to perform the operation on all types
25
- # @option arguments [Hash] :body The search definition template and its params
26
- # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored
27
- # when unavailable (missing or closed)
28
- # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into
29
- # no concrete indices. (This includes `_all` string or when no
30
- # indices have been specified)
31
- # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices
32
- # that are open, closed or both. (options: open, closed)
33
- # @option arguments [String] :preference Specify the node or shard the operation should be performed on
34
- # (default: random)
21
+ # @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
22
+ # @option arguments [List] :type A comma-separated list of document types to search; leave empty to perform the operation on all types
23
+ # @option arguments [Hash] :body The search definition template and its params (*Required*)
24
+ # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
25
+ # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled
26
+ # @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)
27
+ # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, none, all)
28
+ # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
35
29
  # @option arguments [List] :routing A comma-separated list of specific routing values
36
- # @option arguments [Duration] :scroll Specify how long a consistent view of the index should be maintained
37
- # for scrolled search
38
- # @option arguments [String] :search_type Search operation type (options: query_then_fetch, query_and_fetch,
39
- # dfs_query_then_fetch, dfs_query_and_fetch, count, scan)
30
+ # @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search
31
+ # @option arguments [String] :search_type Search operation type (options: query_then_fetch, query_and_fetch, dfs_query_then_fetch, dfs_query_and_fetch)
32
+ # @option arguments [Boolean] :explain Specify whether to return detailed information about score computation as part of a hit
33
+ # @option arguments [Boolean] :profile Specify whether to profile the query execution
34
+ # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
35
+ # @option arguments [Boolean] :rest_total_hits_as_int This parameter is ignored in this version. It is used in the next major version to control whether the rest response should render the total.hits as an object or a number
40
36
  #
41
37
  # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-template.html
42
38
  #
@@ -54,12 +50,17 @@ module Elasticsearch
54
50
  # @since 6.2.0
55
51
  ParamsRegistry.register(:search_template, [
56
52
  :ignore_unavailable,
53
+ :ignore_throttled,
57
54
  :allow_no_indices,
58
55
  :expand_wildcards,
59
56
  :preference,
60
57
  :routing,
61
58
  :scroll,
62
- :search_type ].freeze)
59
+ :search_type,
60
+ :explain,
61
+ :profile,
62
+ :typed_keys,
63
+ :rest_total_hits_as_int ].freeze)
63
64
  end
64
65
  end
65
66
  end
@@ -19,10 +19,9 @@ module Elasticsearch
19
19
  # @option arguments [String] :snapshot A snapshot name (*Required*)
20
20
  # @option arguments [Hash] :body The snapshot definition
21
21
  # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
22
- # @option arguments [Boolean] :wait_for_completion Whether the request should block and wait until
23
- # the operation has completed
22
+ # @option arguments [Boolean] :wait_for_completion Should this request wait until the operation has completed before returning
24
23
  #
25
- # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html#_snapshot
24
+ # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html
26
25
  #
27
26
  def create(arguments={})
28
27
  raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
@@ -17,8 +17,9 @@ module Elasticsearch
17
17
  # @option arguments [Hash] :body The repository definition (*Required*)
18
18
  # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
19
19
  # @option arguments [Time] :timeout Explicit operation timeout
20
+ # @option arguments [Boolean] :verify Whether to verify the repository after creation
20
21
  #
21
- # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html#_repositories
22
+ # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html
22
23
  #
23
24
  def create_repository(arguments={})
24
25
  raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
@@ -38,9 +39,9 @@ module Elasticsearch
38
39
  #
39
40
  # @since 6.2.0
40
41
  ParamsRegistry.register(:create_repository, [
41
- :repository,
42
42
  :master_timeout,
43
- :timeout ].freeze)
43
+ :timeout,
44
+ :verify ].freeze)
44
45
  end
45
46
  end
46
47
  end
@@ -14,9 +14,8 @@ module Elasticsearch
14
14
  # @option arguments [String] :repository A repository name (*Required*)
15
15
  # @option arguments [String] :snapshot A snapshot name (*Required*)
16
16
  # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
17
- # @option arguments [Number,List] :ignore The list of HTTP errors to ignore
18
17
  #
19
- # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html
18
+ # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html
20
19
  #
21
20
  def delete(arguments={})
22
21
  raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
@@ -40,7 +39,8 @@ module Elasticsearch
40
39
  # Register this action with its valid params when the module is loaded.
41
40
  #
42
41
  # @since 6.2.0
43
- ParamsRegistry.register(:delete, [ :master_timeout ].freeze)
42
+ ParamsRegistry.register(:delete, [
43
+ :master_timeout ].freeze)
44
44
  end
45
45
  end
46
46
  end
@@ -12,9 +12,8 @@ module Elasticsearch
12
12
  # @option arguments [List] :repository A comma-separated list of repository names (*Required*)
13
13
  # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
14
14
  # @option arguments [Time] :timeout Explicit operation timeout
15
- # @option arguments [Number,List] :ignore The list of HTTP errors to ignore
16
15
  #
17
- # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html
16
+ # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html
18
17
  #
19
18
  def delete_repository(arguments={})
20
19
  raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
@@ -19,11 +19,11 @@ module Elasticsearch
19
19
  #
20
20
  # @option arguments [String] :repository A repository name (*Required*)
21
21
  # @option arguments [List] :snapshot A comma-separated list of snapshot names (*Required*)
22
- # @option arguments [Boolean] :ignore_unavailable Whether to ignore unavailable snapshots, defaults to # false which means a SnapshotMissingException is thrown
23
22
  # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
23
+ # @option arguments [Boolean] :ignore_unavailable Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown
24
24
  # @option arguments [Boolean] :verbose Whether to show verbose snapshot info or only show the basic info found in the repository index blob
25
25
  #
26
- # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html
26
+ # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html
27
27
  #
28
28
  def get(arguments={})
29
29
  raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
@@ -48,8 +48,8 @@ module Elasticsearch
48
48
  #
49
49
  # @since 6.2.0
50
50
  ParamsRegistry.register(:get, [
51
- :ignore_unavailable,
52
51
  :master_timeout,
52
+ :ignore_unavailable,
53
53
  :verbose ].freeze)
54
54
  end
55
55
  end
@@ -13,14 +13,11 @@ module Elasticsearch
13
13
  #
14
14
  # client.snapshot.get_repository repository: 'my-backups'
15
15
  #
16
- # @option arguments [List] :repository A comma-separated list of repository names. Leave blank or use `_all`
17
- # to get a list of repositories
16
+ # @option arguments [List] :repository A comma-separated list of repository names
18
17
  # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
19
- # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
20
- # (default: false)
21
- # @option arguments [Number,List] :ignore The list of HTTP errors to ignore
18
+ # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
22
19
  #
23
- # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html
20
+ # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html
24
21
  #
25
22
  def get_repository(arguments={})
26
23
  repository = arguments.delete(:repository)
@@ -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 [Boolean] :wait_for_completion Should this request wait until the operation has completed before returning
28
28
  #
29
- # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html
29
+ # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html
30
30
  #
31
31
  def restore(arguments={})
32
32
  raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
@@ -15,11 +15,10 @@ module Elasticsearch
15
15
  #
16
16
  # @option arguments [String] :repository A repository name
17
17
  # @option arguments [List] :snapshot A comma-separated list of snapshot names
18
- # @option arguments [Boolean] :ignore_unavailable Whether to ignore unavailable snapshots, defaults to # false which means a SnapshotMissingException is thrown
19
18
  # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
20
- # @option arguments [Number,List] :ignore The list of HTTP errors to ignore
19
+ # @option arguments [Boolean] :ignore_unavailable Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown
21
20
  #
22
- # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html#_snapshot_status
21
+ # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html
23
22
  #
24
23
  def status(arguments={})
25
24
  repository = arguments.delete(:repository)
@@ -42,8 +41,8 @@ module Elasticsearch
42
41
  #
43
42
  # @since 6.2.0
44
43
  ParamsRegistry.register(:status, [
45
- :ignore_unavailable,
46
- :master_timeout ].freeze)
44
+ :master_timeout,
45
+ :ignore_unavailable ].freeze)
47
46
  end
48
47
  end
49
48
  end
@@ -9,7 +9,7 @@ module Elasticsearch
9
9
  # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
10
10
  # @option arguments [Time] :timeout Explicit operation timeout
11
11
  #
12
- # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html
12
+ # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html
13
13
  #
14
14
  def verify_repository(arguments={})
15
15
  raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
@@ -26,7 +26,6 @@ module Elasticsearch
26
26
  #
27
27
  # @since 6.2.0
28
28
  ParamsRegistry.register(:verify_repository, [
29
- :repository,
30
29
  :master_timeout,
31
30
  :timeout ].freeze)
32
31
  end
@@ -5,17 +5,12 @@ module Elasticsearch
5
5
 
6
6
  # Cancel a specific task
7
7
  #
8
- # @option arguments [Number] :task_id Cancel the task with specified id
9
- # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned
10
- # information; use `_local` to return information from the node
11
- # you're connecting to, leave empty to get information from all nodes
12
- # @option arguments [List] :actions A comma-separated list of actions that should be returned.
13
- # Leave empty to return all.
14
- # @option arguments [String] :parent_node Cancel tasks with specified parent node.
15
- # @option arguments [Number] :parent_task Cancel tasks with specified parent task id.
16
- # Set to -1 to cancel all.
8
+ # @option arguments [String] :task_id Cancel the task with specified task id (node_id:task_number)
9
+ # @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
10
+ # @option arguments [List] :actions A comma-separated list of actions that should be cancelled. Leave empty to cancel all.
11
+ # @option arguments [String] :parent_task_id Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all.
17
12
  #
18
- # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/tasks-cancel.html
13
+ # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html
19
14
  #
20
15
  def cancel(arguments={})
21
16
  arguments = arguments.clone
@@ -33,10 +28,9 @@ module Elasticsearch
33
28
  #
34
29
  # @since 6.2.0
35
30
  ParamsRegistry.register(:cancel, [
36
- :node_id,
31
+ :nodes,
37
32
  :actions,
38
- :parent_node,
39
- :parent_task ].freeze)
33
+ :parent_task_id ].freeze)
40
34
  end
41
35
  end
42
36
  end
@@ -5,10 +5,11 @@ module Elasticsearch
5
5
 
6
6
  # Return information about a specific task
7
7
  #
8
- # @option arguments [String] :task_id Return the task with specified id (node_id:task_number)
8
+ # @option arguments [String] :task_id Return the task with specified id (node_id:task_number) (*Required*)
9
9
  # @option arguments [Boolean] :wait_for_completion Wait for the matching tasks to complete (default: false)
10
+ # @option arguments [Time] :timeout Explicit operation timeout
10
11
  #
11
- # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html
12
+ # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html
12
13
  #
13
14
  def get(arguments={})
14
15
  arguments = arguments.clone
@@ -24,7 +25,9 @@ module Elasticsearch
24
25
  # Register this action with its valid params when the module is loaded.
25
26
  #
26
27
  # @since 6.2.0
27
- ParamsRegistry.register(:get, [ :wait_for_completion ].freeze)
28
+ ParamsRegistry.register(:get, [
29
+ :wait_for_completion,
30
+ :timeout ].freeze)
28
31
  end
29
32
  end
30
33
  end
@@ -5,21 +5,15 @@ module Elasticsearch
5
5
 
6
6
  # Return the list of tasks
7
7
  #
8
- # @option arguments [Number] :task_id Return the task with specified id
9
- # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned
10
- # information; use `_local` to return information from the node
11
- # you're connecting to, leave empty to get information from all nodes
12
- # @option arguments [List] :actions A comma-separated list of actions that should be returned.
13
- # Leave empty to return all.
8
+ # @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
9
+ # @option arguments [List] :actions A comma-separated list of actions that should be returned. Leave empty to return all.
14
10
  # @option arguments [Boolean] :detailed Return detailed task information (default: false)
15
- # @option arguments [String] :parent_node Return tasks with specified parent node.
16
- # @option arguments [Number] :parent_task Return tasks with specified parent task id.
17
- # Set to -1 to return all.
18
- # @option arguments [String] :group_by Group tasks by nodes or parent/child relationships
19
- # Options: nodes, parents
11
+ # @option arguments [String] :parent_task_id Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all.
20
12
  # @option arguments [Boolean] :wait_for_completion Wait for the matching tasks to complete (default: false)
13
+ # @option arguments [String] :group_by Group tasks by nodes or parent/child relationships (options: nodes, parents, none)
14
+ # @option arguments [Time] :timeout Explicit operation timeout
21
15
  #
22
- # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/tasks-list.html
16
+ # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html
23
17
  #
24
18
  def list(arguments={})
25
19
  arguments = arguments.clone
@@ -37,13 +31,13 @@ module Elasticsearch
37
31
  #
38
32
  # @since 6.2.0
39
33
  ParamsRegistry.register(:list, [
40
- :node_id,
34
+ :nodes,
41
35
  :actions,
42
36
  :detailed,
43
- :parent_node,
44
- :parent_task,
37
+ :parent_task_id,
38
+ :wait_for_completion,
45
39
  :group_by,
46
- :wait_for_completion ].freeze)
40
+ :timeout ].freeze)
47
41
  end
48
42
  end
49
43
  end
@@ -36,26 +36,25 @@ module Elasticsearch
36
36
  # }
37
37
  # # => { ..., "term_vectors" => { "text" => { "field_statistics" => { ... }, "terms" => { "bar" => ... } } }
38
38
  #
39
- # @option arguments [String] :index The name of the index (*Required*)
40
- # @option arguments [String] :type The type of the document (*Required*)
41
- # @option arguments [String] :id The document ID
42
- # @option arguments [Hash] :body The request definition
43
- # @option arguments [Boolean] :term_statistics Whether total term frequency and
44
- # document frequency should be returned
45
- # @option arguments [Boolean] :field_statistics Whether document count, sum of document frequencies
46
- # and sum of total term frequencies should be returned
47
- # @option arguments [List] :fields A comma-separated list of fields to return
48
- # @option arguments [Boolean] :offsets Whether term offsets should be returned
49
- # @option arguments [Boolean] :positions Whether term positions should be returned
50
- # @option arguments [Boolean] :payloads Whether term payloads should be returned
51
- # @option arguments [String] :preference Specify the node or shard the operation should be performed on
52
- # (default: random)
53
- # @option arguments [String] :realtime Specifies if requests are real-time as opposed to near-real-time
54
- # (default: true)
55
- # @option arguments [String] :routing Specific routing value
56
- # @option arguments [String] :parent Parent ID of the documents
57
39
  #
58
- # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/docs-termvectors.html
40
+ # @option arguments [String] :index The index in which the document resides. (*Required*)
41
+ # @option arguments [String] :type The type of the document. (*Required*)
42
+ # @option arguments [String] :id The id of the document, when not specified a doc param should be supplied.
43
+ # @option arguments [Hash] :body Define parameters and or supply a document to get termvectors for. See documentation.
44
+ # @option arguments [Boolean] :term_statistics Specifies if total term frequency and document frequency should be returned.
45
+ # @option arguments [Boolean] :field_statistics Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.
46
+ # @option arguments [List] :fields A comma-separated list of fields to return.
47
+ # @option arguments [Boolean] :offsets Specifies if term offsets should be returned.
48
+ # @option arguments [Boolean] :positions Specifies if term positions should be returned.
49
+ # @option arguments [Boolean] :payloads Specifies if term payloads should be returned.
50
+ # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random).
51
+ # @option arguments [String] :routing Specific routing value.
52
+ # @option arguments [String] :parent Parent id of documents.
53
+ # @option arguments [Boolean] :realtime Specifies if request is real-time as opposed to near-real-time (default: true).
54
+ # @option arguments [Number] :version Explicit version number for concurrency control
55
+ # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte, force)
56
+ #
57
+ # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-termvectors.html
59
58
  #
60
59
  def termvectors(arguments={})
61
60
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -91,9 +90,11 @@ module Elasticsearch
91
90
  :positions,
92
91
  :payloads,
93
92
  :preference,
94
- :realtime,
95
93
  :routing,
96
- :parent ].freeze)
94
+ :parent,
95
+ :realtime,
96
+ :version,
97
+ :version_type ].freeze)
97
98
  end
98
99
  end
99
100
  end
@@ -33,34 +33,24 @@ module Elasticsearch
33
33
  # body: { script: 'ctx._source.tags.contains(params.tag) ? ctx.op = "delete" : ctx.op = "none"',
34
34
  # params: { tag: 'to-delete' } }
35
35
  #
36
+ #
36
37
  # @option arguments [String] :id Document ID (*Required*)
37
- # @option arguments [Number,List] :ignore The list of HTTP errors to ignore; only `404` supported at the moment
38
38
  # @option arguments [String] :index The name of the index (*Required*)
39
39
  # @option arguments [String] :type The type of the document (*Required*)
40
- # @option arguments [Hash] :body The request definition using either `script` or partial `doc` (*Required*)
41
- # @option arguments [String] :consistency Explicit write consistency setting for the operation
42
- # (options: one, quorum, all)
40
+ # @option arguments [Hash] :body The request definition requires either `script` or partial `doc` (*Required*)
41
+ # @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)
43
42
  # @option arguments [List] :fields A comma-separated list of fields to return in the response
44
- # @option arguments [String] :lang The script language (default: mvel)
45
- # @option arguments [String] :parent ID of the parent document
46
- # @option arguments [String] :percolate Perform percolation during the operation;
47
- # use specific registered query name, attribute, or wildcard
48
- # @option arguments [Boolean] :refresh Refresh the index after performing the operation
49
- # @option arguments [String] :replication Specific replication type (options: sync, async)
50
- # @option arguments [Number] :retry_on_conflict Specify how many times should the operation be retried
51
- # when a conflict occurs (default: 0)
43
+ # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return
44
+ # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field
45
+ # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field
46
+ # @option arguments [String] :lang The script language (default: painless)
47
+ # @option arguments [String] :parent ID of the parent document. Is is only used for routing and when for the upsert request
48
+ # @option arguments [String] :refresh If `true` then refresh the effected 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)
49
+ # @option arguments [Number] :retry_on_conflict Specify how many times should the operation be retried when a conflict occurs (default: 0)
52
50
  # @option arguments [String] :routing Specific routing value
53
- # @option arguments [String] :script The URL-encoded script definition (instead of using request body)
54
- # @option arguments [String] :_source Specify whether the _source field should be returned,
55
- # or a list of fields to return
56
- # @option arguments [String] :_source_exclude A list of fields to exclude from the returned _source field
57
- # @option arguments [String] :_source_include A list of fields to extract and return from the _source field
58
51
  # @option arguments [Time] :timeout Explicit operation timeout
59
- # @option arguments [Time] :timestamp Explicit timestamp for the document
60
- # @option arguments [Duration] :ttl Expiration time for the document
61
52
  # @option arguments [Number] :version Explicit version number for concurrency control
62
- # @option arguments [Number] :version_type Explicit version number for concurrency control
63
- #
53
+ # @option arguments [String] :version_type Specific version type (options: internal, force)
64
54
  # @since 0.20
65
55
  #
66
56
  # @see http://elasticsearch.org/guide/reference/api/update/
@@ -91,26 +81,22 @@ module Elasticsearch
91
81
  #
92
82
  # @since 6.2.0
93
83
  ParamsRegistry.register(:update, [
94
- :consistency,
84
+ :wait_for_active_shards,
95
85
  :fields,
86
+ :_source,
87
+ :_source_excludes,
88
+ :_source_includes,
96
89
  :lang,
97
90
  :parent,
98
- :percolate,
99
91
  :refresh,
100
- :replication,
101
92
  :retry_on_conflict,
102
93
  :routing,
103
- :script,
104
- :_source,
105
- :_source_include,
106
- :_source_includes,
107
- :_source_exclude,
108
- :_source_excludes,
109
94
  :timeout,
110
- :timestamp,
111
- :ttl,
112
95
  :version,
113
- :version_type ].freeze)
96
+ :version_type,
97
+ :if_seq_no,
98
+ :include_type_name,
99
+ :if_primary_term ].freeze)
114
100
  end
115
101
  end
116
102
  end