elasticsearch-api 7.13.0 → 7.14.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (172) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +4 -4
  3. data/README.md +4 -4
  4. data/elasticsearch-api.gemspec +1 -3
  5. data/lib/elasticsearch/api/actions/bulk.rb +1 -1
  6. data/lib/elasticsearch/api/actions/cat/aliases.rb +1 -1
  7. data/lib/elasticsearch/api/actions/cat/allocation.rb +1 -1
  8. data/lib/elasticsearch/api/actions/cat/count.rb +1 -1
  9. data/lib/elasticsearch/api/actions/cat/fielddata.rb +1 -1
  10. data/lib/elasticsearch/api/actions/cat/health.rb +1 -1
  11. data/lib/elasticsearch/api/actions/cat/help.rb +1 -1
  12. data/lib/elasticsearch/api/actions/cat/indices.rb +1 -1
  13. data/lib/elasticsearch/api/actions/cat/master.rb +1 -1
  14. data/lib/elasticsearch/api/actions/cat/nodeattrs.rb +1 -1
  15. data/lib/elasticsearch/api/actions/cat/nodes.rb +1 -1
  16. data/lib/elasticsearch/api/actions/cat/pending_tasks.rb +1 -1
  17. data/lib/elasticsearch/api/actions/cat/plugins.rb +1 -1
  18. data/lib/elasticsearch/api/actions/cat/recovery.rb +1 -1
  19. data/lib/elasticsearch/api/actions/cat/repositories.rb +1 -1
  20. data/lib/elasticsearch/api/actions/cat/segments.rb +1 -1
  21. data/lib/elasticsearch/api/actions/cat/shards.rb +1 -1
  22. data/lib/elasticsearch/api/actions/cat/snapshots.rb +1 -1
  23. data/lib/elasticsearch/api/actions/cat/tasks.rb +1 -1
  24. data/lib/elasticsearch/api/actions/cat/templates.rb +1 -1
  25. data/lib/elasticsearch/api/actions/cat/thread_pool.rb +1 -1
  26. data/lib/elasticsearch/api/actions/clear_scroll.rb +1 -1
  27. data/lib/elasticsearch/api/actions/close_point_in_time.rb +1 -1
  28. data/lib/elasticsearch/api/actions/cluster/allocation_explain.rb +1 -1
  29. data/lib/elasticsearch/api/actions/cluster/delete_component_template.rb +1 -1
  30. data/lib/elasticsearch/api/actions/cluster/delete_voting_config_exclusions.rb +1 -1
  31. data/lib/elasticsearch/api/actions/cluster/exists_component_template.rb +2 -1
  32. data/lib/elasticsearch/api/actions/cluster/get_component_template.rb +1 -1
  33. data/lib/elasticsearch/api/actions/cluster/get_settings.rb +1 -1
  34. data/lib/elasticsearch/api/actions/cluster/health.rb +1 -1
  35. data/lib/elasticsearch/api/actions/cluster/pending_tasks.rb +1 -1
  36. data/lib/elasticsearch/api/actions/cluster/post_voting_config_exclusions.rb +1 -1
  37. data/lib/elasticsearch/api/actions/cluster/put_component_template.rb +1 -1
  38. data/lib/elasticsearch/api/actions/cluster/put_settings.rb +1 -1
  39. data/lib/elasticsearch/api/actions/cluster/remote_info.rb +1 -1
  40. data/lib/elasticsearch/api/actions/cluster/reroute.rb +1 -1
  41. data/lib/elasticsearch/api/actions/cluster/state.rb +1 -1
  42. data/lib/elasticsearch/api/actions/cluster/stats.rb +1 -1
  43. data/lib/elasticsearch/api/actions/count.rb +1 -1
  44. data/lib/elasticsearch/api/actions/create.rb +1 -1
  45. data/lib/elasticsearch/api/actions/dangling_indices/delete_dangling_index.rb +1 -1
  46. data/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb +1 -1
  47. data/lib/elasticsearch/api/actions/dangling_indices/list_dangling_indices.rb +1 -1
  48. data/lib/elasticsearch/api/actions/delete.rb +1 -1
  49. data/lib/elasticsearch/api/actions/delete_by_query.rb +1 -1
  50. data/lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb +1 -1
  51. data/lib/elasticsearch/api/actions/delete_script.rb +1 -1
  52. data/lib/elasticsearch/api/actions/exists.rb +2 -1
  53. data/lib/elasticsearch/api/actions/exists_source.rb +2 -1
  54. data/lib/elasticsearch/api/actions/explain.rb +6 -6
  55. data/lib/elasticsearch/api/actions/features/get_features.rb +1 -1
  56. data/lib/elasticsearch/api/actions/features/reset_features.rb +1 -1
  57. data/lib/elasticsearch/api/actions/field_caps.rb +6 -6
  58. data/lib/elasticsearch/api/actions/get.rb +1 -1
  59. data/lib/elasticsearch/api/actions/get_script.rb +1 -1
  60. data/lib/elasticsearch/api/actions/get_script_context.rb +1 -1
  61. data/lib/elasticsearch/api/actions/get_script_languages.rb +1 -1
  62. data/lib/elasticsearch/api/actions/get_source.rb +1 -1
  63. data/lib/elasticsearch/api/actions/index.rb +1 -1
  64. data/lib/elasticsearch/api/actions/indices/add_block.rb +1 -1
  65. data/lib/elasticsearch/api/actions/indices/analyze.rb +6 -6
  66. data/lib/elasticsearch/api/actions/indices/clear_cache.rb +1 -1
  67. data/lib/elasticsearch/api/actions/indices/clone.rb +1 -1
  68. data/lib/elasticsearch/api/actions/indices/close.rb +1 -1
  69. data/lib/elasticsearch/api/actions/indices/create.rb +1 -1
  70. data/lib/elasticsearch/api/actions/indices/delete.rb +1 -1
  71. data/lib/elasticsearch/api/actions/indices/delete_alias.rb +1 -1
  72. data/lib/elasticsearch/api/actions/indices/delete_index_template.rb +1 -1
  73. data/lib/elasticsearch/api/actions/indices/delete_template.rb +1 -1
  74. data/lib/elasticsearch/api/actions/indices/exists.rb +2 -1
  75. data/lib/elasticsearch/api/actions/indices/exists_alias.rb +2 -1
  76. data/lib/elasticsearch/api/actions/indices/exists_index_template.rb +2 -1
  77. data/lib/elasticsearch/api/actions/indices/exists_template.rb +2 -1
  78. data/lib/elasticsearch/api/actions/indices/exists_type.rb +2 -1
  79. data/lib/elasticsearch/api/actions/indices/flush.rb +1 -1
  80. data/lib/elasticsearch/api/actions/indices/flush_synced.rb +1 -1
  81. data/lib/elasticsearch/api/actions/indices/forcemerge.rb +1 -1
  82. data/lib/elasticsearch/api/actions/indices/get.rb +1 -1
  83. data/lib/elasticsearch/api/actions/indices/get_alias.rb +1 -1
  84. data/lib/elasticsearch/api/actions/indices/get_field_mapping.rb +1 -1
  85. data/lib/elasticsearch/api/actions/indices/get_index_template.rb +1 -1
  86. data/lib/elasticsearch/api/actions/indices/get_mapping.rb +1 -1
  87. data/lib/elasticsearch/api/actions/indices/get_settings.rb +1 -1
  88. data/lib/elasticsearch/api/actions/indices/get_template.rb +1 -1
  89. data/lib/elasticsearch/api/actions/indices/get_upgrade.rb +1 -1
  90. data/lib/elasticsearch/api/actions/indices/open.rb +1 -1
  91. data/lib/elasticsearch/api/actions/indices/put_alias.rb +1 -1
  92. data/lib/elasticsearch/api/actions/indices/put_index_template.rb +1 -1
  93. data/lib/elasticsearch/api/actions/indices/put_mapping.rb +1 -1
  94. data/lib/elasticsearch/api/actions/indices/put_settings.rb +1 -1
  95. data/lib/elasticsearch/api/actions/indices/put_template.rb +1 -1
  96. data/lib/elasticsearch/api/actions/indices/recovery.rb +1 -1
  97. data/lib/elasticsearch/api/actions/indices/refresh.rb +1 -1
  98. data/lib/elasticsearch/api/actions/indices/resolve_index.rb +1 -1
  99. data/lib/elasticsearch/api/actions/indices/rollover.rb +1 -1
  100. data/lib/elasticsearch/api/actions/indices/segments.rb +1 -1
  101. data/lib/elasticsearch/api/actions/indices/shard_stores.rb +1 -1
  102. data/lib/elasticsearch/api/actions/indices/shrink.rb +1 -1
  103. data/lib/elasticsearch/api/actions/indices/simulate_index_template.rb +1 -1
  104. data/lib/elasticsearch/api/actions/indices/simulate_template.rb +1 -1
  105. data/lib/elasticsearch/api/actions/indices/split.rb +1 -1
  106. data/lib/elasticsearch/api/actions/indices/stats.rb +1 -1
  107. data/lib/elasticsearch/api/actions/indices/update_aliases.rb +1 -1
  108. data/lib/elasticsearch/api/actions/indices/upgrade.rb +1 -1
  109. data/lib/elasticsearch/api/actions/indices/validate_query.rb +8 -8
  110. data/lib/elasticsearch/api/actions/info.rb +1 -1
  111. data/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb +1 -1
  112. data/lib/elasticsearch/api/actions/ingest/geo_ip_stats.rb +1 -1
  113. data/lib/elasticsearch/api/actions/ingest/get_pipeline.rb +1 -1
  114. data/lib/elasticsearch/api/actions/ingest/processor_grok.rb +1 -1
  115. data/lib/elasticsearch/api/actions/ingest/put_pipeline.rb +1 -1
  116. data/lib/elasticsearch/api/actions/ingest/simulate.rb +1 -1
  117. data/lib/elasticsearch/api/actions/mget.rb +1 -1
  118. data/lib/elasticsearch/api/actions/msearch.rb +2 -2
  119. data/lib/elasticsearch/api/actions/msearch_template.rb +2 -2
  120. data/lib/elasticsearch/api/actions/mtermvectors.rb +8 -8
  121. data/lib/elasticsearch/api/actions/nodes/hot_threads.rb +1 -1
  122. data/lib/elasticsearch/api/actions/nodes/info.rb +1 -1
  123. data/lib/elasticsearch/api/actions/nodes/reload_secure_settings.rb +1 -1
  124. data/lib/elasticsearch/api/actions/nodes/stats.rb +1 -1
  125. data/lib/elasticsearch/api/actions/nodes/usage.rb +1 -1
  126. data/lib/elasticsearch/api/actions/open_point_in_time.rb +1 -1
  127. data/lib/elasticsearch/api/actions/ping.rb +3 -3
  128. data/lib/elasticsearch/api/actions/put_script.rb +1 -1
  129. data/lib/elasticsearch/api/actions/rank_eval.rb +1 -1
  130. data/lib/elasticsearch/api/actions/reindex.rb +1 -1
  131. data/lib/elasticsearch/api/actions/reindex_rethrottle.rb +1 -1
  132. data/lib/elasticsearch/api/actions/render_search_template.rb +6 -6
  133. data/lib/elasticsearch/api/actions/scripts_painless_execute.rb +2 -2
  134. data/lib/elasticsearch/api/actions/scroll.rb +6 -6
  135. data/lib/elasticsearch/api/actions/search.rb +8 -8
  136. data/lib/elasticsearch/api/actions/search_shards.rb +1 -1
  137. data/lib/elasticsearch/api/actions/search_template.rb +2 -2
  138. data/lib/elasticsearch/api/actions/snapshot/cleanup_repository.rb +1 -1
  139. data/lib/elasticsearch/api/actions/snapshot/clone.rb +1 -1
  140. data/lib/elasticsearch/api/actions/snapshot/create.rb +1 -1
  141. data/lib/elasticsearch/api/actions/snapshot/create_repository.rb +1 -1
  142. data/lib/elasticsearch/api/actions/snapshot/delete.rb +1 -1
  143. data/lib/elasticsearch/api/actions/snapshot/delete_repository.rb +1 -1
  144. data/lib/elasticsearch/api/actions/snapshot/get.rb +3 -1
  145. data/lib/elasticsearch/api/actions/snapshot/get_repository.rb +1 -1
  146. data/lib/elasticsearch/api/actions/snapshot/repository_analyze.rb +76 -0
  147. data/lib/elasticsearch/api/actions/snapshot/restore.rb +1 -1
  148. data/lib/elasticsearch/api/actions/snapshot/status.rb +1 -1
  149. data/lib/elasticsearch/api/actions/snapshot/verify_repository.rb +1 -1
  150. data/lib/elasticsearch/api/actions/tasks/cancel.rb +1 -1
  151. data/lib/elasticsearch/api/actions/tasks/get.rb +1 -1
  152. data/lib/elasticsearch/api/actions/tasks/list.rb +1 -1
  153. data/lib/elasticsearch/api/actions/termvectors.rb +11 -10
  154. data/lib/elasticsearch/api/actions/update.rb +1 -1
  155. data/lib/elasticsearch/api/actions/update_by_query.rb +1 -1
  156. data/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb +1 -1
  157. data/lib/elasticsearch/api/namespace/security.rb +36 -0
  158. data/lib/elasticsearch/api/version.rb +1 -1
  159. data/spec/elasticsearch/api/actions/indices/clear_cache_spec.rb +16 -3
  160. data/spec/elasticsearch/api/actions/snapshot/repository_analize_spec.rb +48 -0
  161. data/spec/elasticsearch/api/rest_api_yaml_spec.rb +17 -4
  162. data/spec/rest_yaml_tests_helper.rb +2 -2
  163. data/spec/spec_helper.rb +4 -1
  164. data/utils/README.md +6 -1
  165. data/utils/thor/generator/files_helper.rb +1 -1
  166. data/utils/thor/templates/_documentation_top.erb +19 -0
  167. data/utils/thor/templates/_method_setup.erb +18 -0
  168. data/utils/thor/templates/_params_registry.erb +19 -0
  169. data/utils/thor/templates/_perform_request.erb +18 -0
  170. data/utils/thor/templates/test.erb +16 -3
  171. data/utils/thor/templates/test_helper.rb +0 -4
  172. metadata +7 -37
@@ -22,7 +22,7 @@ module Elasticsearch
22
22
  #
23
23
  # @option arguments [List] :index A comma-separated list of index names to use as default
24
24
  # @option arguments [List] :type A comma-separated list of document types to use as default
25
- # @option arguments [String] :search_type Search operation type (options: query_then_fetch, query_and_fetch, dfs_query_then_fetch, dfs_query_and_fetch)
25
+ # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch)
26
26
  # @option arguments [Number] :max_concurrent_searches Controls the maximum number of concurrent searches the multi search api will execute
27
27
  # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
28
28
  # @option arguments [Number] :pre_filter_shard_size A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.
@@ -37,7 +37,7 @@ module Elasticsearch
37
37
  # Deprecated since version 7.0.0
38
38
  #
39
39
  #
40
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/search-multi-search.html
40
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/search-multi-search.html
41
41
  #
42
42
  def msearch(arguments = {})
43
43
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -22,7 +22,7 @@ module Elasticsearch
22
22
  #
23
23
  # @option arguments [List] :index A comma-separated list of index names to use as default
24
24
  # @option arguments [List] :type A comma-separated list of document types to use as default
25
- # @option arguments [String] :search_type Search operation type (options: query_then_fetch, query_and_fetch, dfs_query_then_fetch, dfs_query_and_fetch)
25
+ # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch)
26
26
  # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
27
27
  # @option arguments [Number] :max_concurrent_searches Controls the maximum number of concurrent searches the multi search api will execute
28
28
  # @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
@@ -35,7 +35,7 @@ module Elasticsearch
35
35
  # Deprecated since version 7.0.0
36
36
  #
37
37
  #
38
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/search-multi-search.html
38
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/search-multi-search.html
39
39
  #
40
40
  def msearch_template(arguments = {})
41
41
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -42,7 +42,7 @@ module Elasticsearch
42
42
  # Deprecated since version 7.0.0
43
43
  #
44
44
  #
45
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/docs-multi-termvectors.html
45
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/docs-multi-termvectors.html
46
46
  #
47
47
  def mtermvectors(arguments = {})
48
48
  headers = arguments.delete(:headers) || {}
@@ -60,13 +60,13 @@ module Elasticsearch
60
60
  Elasticsearch::API::HTTP_GET
61
61
  end
62
62
 
63
- path = if _index && _type
64
- "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_mtermvectors"
65
- elsif _index
66
- "#{Utils.__listify(_index)}/_mtermvectors"
67
- else
68
- "_mtermvectors"
69
- end
63
+ path = if _index && _type
64
+ "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_mtermvectors"
65
+ elsif _index
66
+ "#{Utils.__listify(_index)}/_mtermvectors"
67
+ else
68
+ "_mtermvectors"
69
+ end
70
70
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
71
71
 
72
72
  if ids
@@ -35,7 +35,7 @@ module Elasticsearch
35
35
  # Deprecated since version 7.0.0
36
36
  #
37
37
  #
38
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/cluster-nodes-hot-threads.html
38
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/cluster-nodes-hot-threads.html
39
39
  #
40
40
  def hot_threads(arguments = {})
41
41
  headers = arguments.delete(:headers) || {}
@@ -27,7 +27,7 @@ module Elasticsearch
27
27
  # @option arguments [Time] :timeout Explicit operation timeout
28
28
  # @option arguments [Hash] :headers Custom HTTP headers
29
29
  #
30
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/cluster-nodes-info.html
30
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/cluster-nodes-info.html
31
31
  #
32
32
  def info(arguments = {})
33
33
  headers = arguments.delete(:headers) || {}
@@ -26,7 +26,7 @@ module Elasticsearch
26
26
  # @option arguments [Hash] :headers Custom HTTP headers
27
27
  # @option arguments [Hash] :body An object containing the password for the elasticsearch keystore
28
28
  #
29
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/secure-settings.html#reloadable-secure-settings
29
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/secure-settings.html#reloadable-secure-settings
30
30
  #
31
31
  def reload_secure_settings(arguments = {})
32
32
  headers = arguments.delete(:headers) || {}
@@ -35,7 +35,7 @@ module Elasticsearch
35
35
  # @option arguments [Boolean] :include_unloaded_segments If set to true segment stats will include stats for segments that are not currently loaded into memory
36
36
  # @option arguments [Hash] :headers Custom HTTP headers
37
37
  #
38
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/cluster-nodes-stats.html
38
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/cluster-nodes-stats.html
39
39
  #
40
40
  def stats(arguments = {})
41
41
  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.13/cluster-nodes-usage.html
29
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/cluster-nodes-usage.html
30
30
  #
31
31
  def usage(arguments = {})
32
32
  headers = arguments.delete(:headers) || {}
@@ -28,7 +28,7 @@ module Elasticsearch
28
28
  # @option arguments [String] :keep_alive Specific the time to live for the point in time
29
29
  # @option arguments [Hash] :headers Custom HTTP headers
30
30
  #
31
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/point-in-time-api.html
31
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/point-in-time-api.html
32
32
  #
33
33
  def open_point_in_time(arguments = {})
34
34
  headers = arguments.delete(:headers) || {}
@@ -22,7 +22,7 @@ module Elasticsearch
22
22
  #
23
23
  # @option arguments [Hash] :headers Custom HTTP headers
24
24
  #
25
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/index.html
25
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/index.html
26
26
  #
27
27
  def ping(arguments = {})
28
28
  headers = arguments.delete(:headers) || {}
@@ -35,14 +35,14 @@ module Elasticsearch
35
35
 
36
36
  body = nil
37
37
  begin
38
- perform_request(method, path, params, body, headers).status == 200 ? true : false
38
+ perform_request(method, path, params, body, headers).status == 200 ? true : false
39
39
  rescue Exception => e
40
40
  if e.class.to_s =~ /NotFound|ConnectionFailed/ || e.message =~ /Not *Found|404|ConnectionFailed/i
41
41
  false
42
42
  else
43
43
  raise e
44
44
  end
45
- end
45
+ end
46
46
  end
47
47
  end
48
48
  end
@@ -27,7 +27,7 @@ module Elasticsearch
27
27
  # @option arguments [Hash] :headers Custom HTTP headers
28
28
  # @option arguments [Hash] :body The document (*Required*)
29
29
  #
30
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/modules-scripting.html
30
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/modules-scripting.html
31
31
  #
32
32
  def put_script(arguments = {})
33
33
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -32,7 +32,7 @@ module Elasticsearch
32
32
  # @option arguments [Hash] :headers Custom HTTP headers
33
33
  # @option arguments [Hash] :body The ranking evaluation search definition, including search requests, document ratings and ranking metric definition. (*Required*)
34
34
  #
35
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/search-rank-eval.html
35
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/search-rank-eval.html
36
36
  #
37
37
  def rank_eval(arguments = {})
38
38
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -33,7 +33,7 @@ module Elasticsearch
33
33
  # @option arguments [Hash] :headers Custom HTTP headers
34
34
  # @option arguments [Hash] :body The search definition using the Query DSL and the prototype for the index request. (*Required*)
35
35
  #
36
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/docs-reindex.html
36
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/docs-reindex.html
37
37
  #
38
38
  def reindex(arguments = {})
39
39
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -24,7 +24,7 @@ module Elasticsearch
24
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.13/docs-reindex.html
27
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/docs-reindex.html
28
28
  #
29
29
  def reindex_rethrottle(arguments = {})
30
30
  raise ArgumentError, "Required argument 'task_id' missing" unless arguments[:task_id]
@@ -24,7 +24,7 @@ module Elasticsearch
24
24
  # @option arguments [Hash] :headers Custom HTTP headers
25
25
  # @option arguments [Hash] :body The search definition template and its params
26
26
  #
27
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/search-template.html#_validating_templates
27
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/render-search-template-api.html
28
28
  #
29
29
  def render_search_template(arguments = {})
30
30
  headers = arguments.delete(:headers) || {}
@@ -39,11 +39,11 @@ module Elasticsearch
39
39
  Elasticsearch::API::HTTP_GET
40
40
  end
41
41
 
42
- path = if _id
43
- "_render/template/#{Utils.__listify(_id)}"
44
- else
45
- "_render/template"
46
- end
42
+ path = if _id
43
+ "_render/template/#{Utils.__listify(_id)}"
44
+ else
45
+ "_render/template"
46
+ end
47
47
  params = {}
48
48
 
49
49
  body = arguments[:body]
@@ -27,7 +27,7 @@ module Elasticsearch
27
27
  # @option arguments [Hash] :headers Custom HTTP headers
28
28
  # @option arguments [Hash] :body The script to execute
29
29
  #
30
- # @see https://www.elastic.co/guide/en/elasticsearch/painless/7.13/painless-execute-api.html
30
+ # @see https://www.elastic.co/guide/en/elasticsearch/painless/7.14/painless-execute-api.html
31
31
  #
32
32
  def scripts_painless_execute(arguments = {})
33
33
  headers = arguments.delete(:headers) || {}
@@ -40,7 +40,7 @@ module Elasticsearch
40
40
  Elasticsearch::API::HTTP_GET
41
41
  end
42
42
 
43
- path = "_scripts/painless/_execute"
43
+ path = "_scripts/painless/_execute"
44
44
  params = {}
45
45
 
46
46
  body = arguments[:body]
@@ -31,7 +31,7 @@ module Elasticsearch
31
31
  # Deprecated since version 7.0.0
32
32
  #
33
33
  #
34
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/search-request-body.html#request-body-search-scroll
34
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/search-request-body.html#request-body-search-scroll
35
35
  #
36
36
  def scroll(arguments = {})
37
37
  headers = arguments.delete(:headers) || {}
@@ -46,11 +46,11 @@ module Elasticsearch
46
46
  Elasticsearch::API::HTTP_GET
47
47
  end
48
48
 
49
- path = if _scroll_id
50
- "_search/scroll/#{Utils.__listify(_scroll_id)}"
51
- else
52
- "_search/scroll"
53
- end
49
+ path = if _scroll_id
50
+ "_search/scroll/#{Utils.__listify(_scroll_id)}"
51
+ else
52
+ "_search/scroll"
53
+ end
54
54
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
55
55
 
56
56
  body = arguments[:body]
@@ -73,7 +73,7 @@ module Elasticsearch
73
73
  # Deprecated since version 7.0.0
74
74
  #
75
75
  #
76
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/search-search.html
76
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/search-search.html
77
77
  #
78
78
  def search(arguments = {})
79
79
  headers = arguments.delete(:headers) || {}
@@ -91,13 +91,13 @@ module Elasticsearch
91
91
  Elasticsearch::API::HTTP_GET
92
92
  end
93
93
 
94
- path = if _index && _type
95
- "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_search"
96
- elsif _index
97
- "#{Utils.__listify(_index)}/_search"
98
- else
99
- "_search"
100
- end
94
+ path = if _index && _type
95
+ "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_search"
96
+ elsif _index
97
+ "#{Utils.__listify(_index)}/_search"
98
+ else
99
+ "_search"
100
+ end
101
101
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
102
102
 
103
103
  body = arguments[:body]
@@ -29,7 +29,7 @@ module Elasticsearch
29
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)
30
30
  # @option arguments [Hash] :headers Custom HTTP headers
31
31
  #
32
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/search-shards.html
32
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/search-shards.html
33
33
  #
34
34
  def search_shards(arguments = {})
35
35
  headers = arguments.delete(:headers) || {}
@@ -29,7 +29,7 @@ module Elasticsearch
29
29
  # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
30
30
  # @option arguments [List] :routing A comma-separated list of specific routing values
31
31
  # @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search
32
- # @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 [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch)
33
33
  # @option arguments [Boolean] :explain Specify whether to return detailed information about score computation as part of a hit
34
34
  # @option arguments [Boolean] :profile Specify whether to profile the query execution
35
35
  # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
@@ -43,7 +43,7 @@ module Elasticsearch
43
43
  # Deprecated since version 7.0.0
44
44
  #
45
45
  #
46
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/search-template.html
46
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/search-template.html
47
47
  #
48
48
  def search_template(arguments = {})
49
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.13/clean-up-snapshot-repo-api.html
29
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/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]
@@ -28,7 +28,7 @@ module Elasticsearch
28
28
  # @option arguments [Hash] :headers Custom HTTP headers
29
29
  # @option arguments [Hash] :body The snapshot clone definition (*Required*)
30
30
  #
31
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/modules-snapshots.html
31
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/modules-snapshots.html
32
32
  #
33
33
  def clone(arguments = {})
34
34
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -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.13/modules-snapshots.html
31
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/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.13/modules-snapshots.html
31
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/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.13/modules-snapshots.html
29
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/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.13/modules-snapshots.html
29
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/modules-snapshots.html
30
30
  #
31
31
  def delete_repository(arguments = {})
32
32
  raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
@@ -26,10 +26,11 @@ module Elasticsearch
26
26
  # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
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 [Boolean] :index_details Whether to include details of each index in the snapshot, if those details are available. Defaults to false.
29
+ # @option arguments [Boolean] :include_repository Whether to include the repository name in the snapshot info. Defaults to true.
29
30
  # @option arguments [Boolean] :verbose Whether to show verbose snapshot info or only show the basic info found in the repository index blob
30
31
  # @option arguments [Hash] :headers Custom HTTP headers
31
32
  #
32
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/modules-snapshots.html
33
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/modules-snapshots.html
33
34
  #
34
35
  def get(arguments = {})
35
36
  raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
@@ -62,6 +63,7 @@ module Elasticsearch
62
63
  :master_timeout,
63
64
  :ignore_unavailable,
64
65
  :index_details,
66
+ :include_repository,
65
67
  :verbose
66
68
  ].freeze)
67
69
  end
@@ -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.13/modules-snapshots.html
29
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/modules-snapshots.html
30
30
  #
31
31
  def get_repository(arguments = {})
32
32
  headers = arguments.delete(:headers) || {}
@@ -0,0 +1,76 @@
1
+ # Licensed to Elasticsearch B.V. under one or more contributor
2
+ # license agreements. See the NOTICE file distributed with
3
+ # this work for additional information regarding copyright
4
+ # ownership. Elasticsearch B.V. licenses this file to you under
5
+ # the Apache License, Version 2.0 (the "License"); you may
6
+ # not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing,
12
+ # software distributed under the License is distributed on an
13
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
+ # KIND, either express or implied. See the License for the
15
+ # specific language governing permissions and limitations
16
+ # under the License.
17
+
18
+ module Elasticsearch
19
+ module API
20
+ module Snapshot
21
+ module Actions
22
+ # Analyzes a repository for correctness and performance
23
+ #
24
+ # @option arguments [String] :repository A repository name
25
+ # @option arguments [Number] :blob_count Number of blobs to create during the test. Defaults to 100.
26
+ # @option arguments [Number] :concurrency Number of operations to run concurrently during the test. Defaults to 10.
27
+ # @option arguments [Number] :read_node_count Number of nodes on which to read a blob after writing. Defaults to 10.
28
+ # @option arguments [Number] :early_read_node_count Number of nodes on which to perform an early read on a blob, i.e. before writing has completed. Early reads are rare actions so the 'rare_action_probability' parameter is also relevant. Defaults to 2.
29
+ # @option arguments [Number] :seed Seed for the random number generator used to create the test workload. Defaults to a random value.
30
+ # @option arguments [Number] :rare_action_probability Probability of taking a rare action such as an early read or an overwrite. Defaults to 0.02.
31
+ # @option arguments [String] :max_blob_size Maximum size of a blob to create during the test, e.g '1gb' or '100mb'. Defaults to '10mb'.
32
+ # @option arguments [String] :max_total_data_size Maximum total size of all blobs to create during the test, e.g '1tb' or '100gb'. Defaults to '1gb'.
33
+ # @option arguments [Time] :timeout Explicit operation timeout. Defaults to '30s'.
34
+ # @option arguments [Boolean] :detailed Whether to return detailed results or a summary. Defaults to 'false' so that only the summary is returned.
35
+ # @option arguments [Boolean] :rarely_abort_writes Whether to rarely abort writes before they complete. Defaults to 'true'.
36
+ # @option arguments [Hash] :headers Custom HTTP headers
37
+ #
38
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/modules-snapshots.html
39
+ #
40
+ def repository_analyze(arguments = {})
41
+ raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
42
+
43
+ headers = arguments.delete(:headers) || {}
44
+
45
+ arguments = arguments.clone
46
+
47
+ _repository = arguments.delete(:repository)
48
+
49
+ method = Elasticsearch::API::HTTP_POST
50
+ path = "_snapshot/#{Utils.__listify(_repository)}/_analyze"
51
+ params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
52
+
53
+ body = nil
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(:repository_analyze, [
61
+ :blob_count,
62
+ :concurrency,
63
+ :read_node_count,
64
+ :early_read_node_count,
65
+ :seed,
66
+ :rare_action_probability,
67
+ :max_blob_size,
68
+ :max_total_data_size,
69
+ :timeout,
70
+ :detailed,
71
+ :rarely_abort_writes
72
+ ].freeze)
73
+ end
74
+ end
75
+ end
76
+ end