elasticsearch-api 7.8.0 → 7.8.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (87) hide show
  1. checksums.yaml +4 -4
  2. data/lib/elasticsearch/api/actions/bulk.rb +0 -1
  3. data/lib/elasticsearch/api/actions/cat/aliases.rb +0 -1
  4. data/lib/elasticsearch/api/actions/cat/allocation.rb +0 -1
  5. data/lib/elasticsearch/api/actions/cat/fielddata.rb +0 -1
  6. data/lib/elasticsearch/api/actions/cat/health.rb +0 -1
  7. data/lib/elasticsearch/api/actions/cat/indices.rb +0 -4
  8. data/lib/elasticsearch/api/actions/cat/nodes.rb +0 -2
  9. data/lib/elasticsearch/api/actions/cat/pending_tasks.rb +0 -1
  10. data/lib/elasticsearch/api/actions/cat/recovery.rb +0 -2
  11. data/lib/elasticsearch/api/actions/cat/segments.rb +0 -1
  12. data/lib/elasticsearch/api/actions/cat/shards.rb +0 -2
  13. data/lib/elasticsearch/api/actions/cat/snapshots.rb +0 -1
  14. data/lib/elasticsearch/api/actions/cat/tasks.rb +0 -1
  15. data/lib/elasticsearch/api/actions/cat/thread_pool.rb +0 -1
  16. data/lib/elasticsearch/api/actions/cluster/delete_component_template.rb +4 -0
  17. data/lib/elasticsearch/api/actions/cluster/exists_component_template.rb +4 -0
  18. data/lib/elasticsearch/api/actions/cluster/get_component_template.rb +4 -0
  19. data/lib/elasticsearch/api/actions/cluster/health.rb +0 -4
  20. data/lib/elasticsearch/api/actions/cluster/put_component_template.rb +4 -0
  21. data/lib/elasticsearch/api/actions/cluster/reroute.rb +0 -1
  22. data/lib/elasticsearch/api/actions/cluster/state.rb +0 -2
  23. data/lib/elasticsearch/api/actions/count.rb +0 -2
  24. data/lib/elasticsearch/api/actions/create.rb +0 -2
  25. data/lib/elasticsearch/api/actions/delete.rb +0 -2
  26. data/lib/elasticsearch/api/actions/delete_by_query.rb +0 -4
  27. data/lib/elasticsearch/api/actions/exists.rb +0 -1
  28. data/lib/elasticsearch/api/actions/exists_source.rb +0 -1
  29. data/lib/elasticsearch/api/actions/explain.rb +0 -1
  30. data/lib/elasticsearch/api/actions/field_caps.rb +0 -1
  31. data/lib/elasticsearch/api/actions/get.rb +0 -1
  32. data/lib/elasticsearch/api/actions/get_script_context.rb +4 -0
  33. data/lib/elasticsearch/api/actions/get_script_languages.rb +4 -0
  34. data/lib/elasticsearch/api/actions/get_source.rb +0 -1
  35. data/lib/elasticsearch/api/actions/index.rb +0 -3
  36. data/lib/elasticsearch/api/actions/indices/clear_cache.rb +0 -1
  37. data/lib/elasticsearch/api/actions/indices/close.rb +0 -1
  38. data/lib/elasticsearch/api/actions/indices/create_data_stream.rb +4 -0
  39. data/lib/elasticsearch/api/actions/indices/delete.rb +0 -1
  40. data/lib/elasticsearch/api/actions/indices/delete_data_stream.rb +4 -0
  41. data/lib/elasticsearch/api/actions/indices/delete_index_template.rb +4 -0
  42. data/lib/elasticsearch/api/actions/indices/exists.rb +0 -1
  43. data/lib/elasticsearch/api/actions/indices/exists_alias.rb +0 -1
  44. data/lib/elasticsearch/api/actions/indices/exists_index_template.rb +4 -0
  45. data/lib/elasticsearch/api/actions/indices/exists_type.rb +0 -1
  46. data/lib/elasticsearch/api/actions/indices/flush.rb +0 -1
  47. data/lib/elasticsearch/api/actions/indices/flush_synced.rb +0 -1
  48. data/lib/elasticsearch/api/actions/indices/forcemerge.rb +0 -1
  49. data/lib/elasticsearch/api/actions/indices/get.rb +0 -1
  50. data/lib/elasticsearch/api/actions/indices/get_alias.rb +0 -1
  51. data/lib/elasticsearch/api/actions/indices/get_data_streams.rb +4 -0
  52. data/lib/elasticsearch/api/actions/indices/get_field_mapping.rb +0 -1
  53. data/lib/elasticsearch/api/actions/indices/get_index_template.rb +4 -0
  54. data/lib/elasticsearch/api/actions/indices/get_mapping.rb +0 -1
  55. data/lib/elasticsearch/api/actions/indices/get_settings.rb +0 -1
  56. data/lib/elasticsearch/api/actions/indices/get_upgrade.rb +0 -1
  57. data/lib/elasticsearch/api/actions/indices/open.rb +0 -1
  58. data/lib/elasticsearch/api/actions/indices/put_index_template.rb +4 -0
  59. data/lib/elasticsearch/api/actions/indices/put_mapping.rb +0 -1
  60. data/lib/elasticsearch/api/actions/indices/put_settings.rb +0 -1
  61. data/lib/elasticsearch/api/actions/indices/refresh.rb +0 -1
  62. data/lib/elasticsearch/api/actions/indices/segments.rb +0 -1
  63. data/lib/elasticsearch/api/actions/indices/shard_stores.rb +0 -2
  64. data/lib/elasticsearch/api/actions/indices/simulate_index_template.rb +4 -0
  65. data/lib/elasticsearch/api/actions/indices/stats.rb +0 -3
  66. data/lib/elasticsearch/api/actions/indices/upgrade.rb +0 -1
  67. data/lib/elasticsearch/api/actions/indices/validate_query.rb +0 -2
  68. data/lib/elasticsearch/api/actions/msearch.rb +0 -1
  69. data/lib/elasticsearch/api/actions/msearch_template.rb +0 -1
  70. data/lib/elasticsearch/api/actions/mtermvectors.rb +0 -1
  71. data/lib/elasticsearch/api/actions/nodes/hot_threads.rb +0 -1
  72. data/lib/elasticsearch/api/actions/nodes/info.rb +0 -1
  73. data/lib/elasticsearch/api/actions/nodes/stats.rb +0 -3
  74. data/lib/elasticsearch/api/actions/nodes/usage.rb +0 -1
  75. data/lib/elasticsearch/api/actions/rank_eval.rb +4 -2
  76. data/lib/elasticsearch/api/actions/scripts_painless_execute.rb +4 -0
  77. data/lib/elasticsearch/api/actions/search.rb +0 -4
  78. data/lib/elasticsearch/api/actions/search_shards.rb +0 -1
  79. data/lib/elasticsearch/api/actions/search_template.rb +0 -2
  80. data/lib/elasticsearch/api/actions/tasks/list.rb +0 -1
  81. data/lib/elasticsearch/api/actions/termvectors.rb +0 -1
  82. data/lib/elasticsearch/api/actions/update.rb +0 -1
  83. data/lib/elasticsearch/api/actions/update_by_query.rb +0 -4
  84. data/lib/elasticsearch/api/version.rb +1 -1
  85. data/utils/thor/generate_source.rb +27 -1
  86. data/utils/thor/templates/_documentation_top.erb +1 -0
  87. metadata +3 -3
@@ -28,7 +28,6 @@ module Elasticsearch
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
29
  # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
30
30
  # (options: open,closed,hidden,none,all)
31
-
32
31
  # @option arguments [String] :wait_for_active_shards Sets the number of active shards to wait for before the operation returns.
33
32
  # @option arguments [Hash] :headers Custom HTTP headers
34
33
  #
@@ -20,6 +20,10 @@ module Elasticsearch
20
20
  module Indices
21
21
  module Actions
22
22
  # Creates or updates a data stream
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] :name The name of the data stream
25
29
  # @option arguments [Hash] :headers Custom HTTP headers
@@ -28,7 +28,6 @@ module Elasticsearch
28
28
  # @option arguments [Boolean] :allow_no_indices Ignore if a wildcard expression resolves to no concrete indices (default: false)
29
29
  # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open)
30
30
  # (options: open,closed,hidden,none,all)
31
-
32
31
  # @option arguments [Hash] :headers Custom HTTP headers
33
32
  #
34
33
  # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/indices-delete-index.html
@@ -20,6 +20,10 @@ module Elasticsearch
20
20
  module Indices
21
21
  module Actions
22
22
  # Deletes a data stream.
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] :name The name of the data stream
25
29
  # @option arguments [Hash] :headers Custom HTTP headers
@@ -20,6 +20,10 @@ module Elasticsearch
20
20
  module Indices
21
21
  module Actions
22
22
  # Deletes an index template.
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] :name The name of the template
25
29
  # @option arguments [Time] :timeout Explicit operation timeout
@@ -27,7 +27,6 @@ module Elasticsearch
27
27
  # @option arguments [Boolean] :allow_no_indices Ignore if a wildcard expression resolves to no concrete indices (default: false)
28
28
  # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open)
29
29
  # (options: open,closed,hidden,none,all)
30
-
31
30
  # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
32
31
  # @option arguments [Boolean] :include_defaults Whether to return all default setting for each of the indices.
33
32
  # @option arguments [Hash] :headers Custom HTTP headers
@@ -27,7 +27,6 @@ module Elasticsearch
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
28
  # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
29
29
  # (options: open,closed,hidden,none,all)
30
-
31
30
  # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
32
31
  # @option arguments [Hash] :headers Custom HTTP headers
33
32
  #
@@ -20,6 +20,10 @@ module Elasticsearch
20
20
  module Indices
21
21
  module Actions
22
22
  # Returns information about whether a particular index template exists.
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] :name The name of the template
25
29
  # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
@@ -27,7 +27,6 @@ module Elasticsearch
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
28
  # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
29
29
  # (options: open,closed,hidden,none,all)
30
-
31
30
  # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
32
31
  # @option arguments [Hash] :headers Custom HTTP headers
33
32
  #
@@ -28,7 +28,6 @@ module Elasticsearch
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
29
  # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
30
30
  # (options: open,closed,hidden,none,all)
31
-
32
31
  # @option arguments [Hash] :headers Custom HTTP headers
33
32
  #
34
33
  # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/indices-flush.html
@@ -26,7 +26,6 @@ module Elasticsearch
26
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
27
  # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
28
28
  # (options: open,closed,none,all)
29
-
30
29
  # @option arguments [Hash] :headers Custom HTTP headers
31
30
  #
32
31
  # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/indices-synced-flush-api.html
@@ -27,7 +27,6 @@ module Elasticsearch
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
28
  # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
29
29
  # (options: open,closed,hidden,none,all)
30
-
31
30
  # @option arguments [Number] :max_num_segments The number of segments the index should be merged into (default: dynamic)
32
31
  # @option arguments [Boolean] :only_expunge_deletes Specify whether the operation should only expunge deleted documents
33
32
  # @option arguments [Hash] :headers Custom HTTP headers
@@ -28,7 +28,6 @@ module Elasticsearch
28
28
  # @option arguments [Boolean] :allow_no_indices Ignore if a wildcard expression resolves to no concrete indices (default: false)
29
29
  # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open)
30
30
  # (options: open,closed,hidden,none,all)
31
-
32
31
  # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
33
32
  # @option arguments [Boolean] :include_defaults Whether to return all default setting for each of the indices.
34
33
  # @option arguments [Time] :master_timeout Specify timeout for connection to master
@@ -27,7 +27,6 @@ module Elasticsearch
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
28
  # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
29
29
  # (options: open,closed,hidden,none,all)
30
-
31
30
  # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
32
31
  # @option arguments [Hash] :headers Custom HTTP headers
33
32
  #
@@ -20,6 +20,10 @@ module Elasticsearch
20
20
  module Indices
21
21
  module Actions
22
22
  # Returns data streams.
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] :name The name or wildcard expression of the requested data streams
25
29
  # @option arguments [Hash] :headers Custom HTTP headers
@@ -30,7 +30,6 @@ module Elasticsearch
30
30
  # @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)
31
31
  # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
32
32
  # (options: open,closed,hidden,none,all)
33
-
34
33
  # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
35
34
  # @option arguments [Hash] :headers Custom HTTP headers
36
35
  #
@@ -20,6 +20,10 @@ module Elasticsearch
20
20
  module Indices
21
21
  module Actions
22
22
  # Returns an index template.
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] :name The comma separated names of the index templates
25
29
  # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
@@ -28,7 +28,6 @@ module Elasticsearch
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
29
  # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
30
30
  # (options: open,closed,hidden,none,all)
31
-
32
31
  # @option arguments [Time] :master_timeout Specify timeout for connection to master
33
32
  # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
34
33
  # @option arguments [Hash] :headers Custom HTTP headers
@@ -28,7 +28,6 @@ module Elasticsearch
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
29
  # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
30
30
  # (options: open,closed,hidden,none,all)
31
-
32
31
  # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
33
32
  # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
34
33
  # @option arguments [Boolean] :include_defaults Whether to return all default setting for each of the indices.
@@ -26,7 +26,6 @@ module Elasticsearch
26
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
27
  # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
28
28
  # (options: open,closed,hidden,none,all)
29
-
30
29
  # @option arguments [Hash] :headers Custom HTTP headers
31
30
  #
32
31
  # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/indices-upgrade.html
@@ -28,7 +28,6 @@ module Elasticsearch
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
29
  # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
30
30
  # (options: open,closed,hidden,none,all)
31
-
32
31
  # @option arguments [String] :wait_for_active_shards Sets the number of active shards to wait for before the operation returns.
33
32
  # @option arguments [Hash] :headers Custom HTTP headers
34
33
  #
@@ -20,6 +20,10 @@ module Elasticsearch
20
20
  module Indices
21
21
  module Actions
22
22
  # Creates or updates an index template.
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] :name The name of the template
25
29
  # @option arguments [Boolean] :create Whether the index template should only be added if new or can also replace an existing one
@@ -30,7 +30,6 @@ module Elasticsearch
30
30
  # @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)
31
31
  # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
32
32
  # (options: open,closed,hidden,none,all)
33
-
34
33
  # @option arguments [Hash] :headers Custom HTTP headers
35
34
  # @option arguments [Hash] :body The mapping definition (*Required*)
36
35
  #
@@ -29,7 +29,6 @@ module Elasticsearch
29
29
  # @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)
30
30
  # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
31
31
  # (options: open,closed,hidden,none,all)
32
-
33
32
  # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
34
33
  # @option arguments [Hash] :headers Custom HTTP headers
35
34
  # @option arguments [Hash] :body The index settings to be updated (*Required*)
@@ -26,7 +26,6 @@ module Elasticsearch
26
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
27
  # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
28
28
  # (options: open,closed,hidden,none,all)
29
-
30
29
  # @option arguments [Hash] :headers Custom HTTP headers
31
30
  #
32
31
  # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/indices-refresh.html
@@ -26,7 +26,6 @@ module Elasticsearch
26
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
27
  # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
28
28
  # (options: open,closed,hidden,none,all)
29
-
30
29
  # @option arguments [Boolean] :verbose Includes detailed memory usage by Lucene.
31
30
  # @option arguments [Hash] :headers Custom HTTP headers
32
31
  #
@@ -24,12 +24,10 @@ module Elasticsearch
24
24
  # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
25
25
  # @option arguments [List] :status A comma-separated list of statuses used to filter on shards to get store information for
26
26
  # (options: green,yellow,red,all)
27
-
28
27
  # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
29
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)
30
29
  # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
31
30
  # (options: open,closed,hidden,none,all)
32
-
33
31
  # @option arguments [Hash] :headers Custom HTTP headers
34
32
  #
35
33
  # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/indices-shards-stores.html
@@ -20,6 +20,10 @@ module Elasticsearch
20
20
  module Indices
21
21
  module Actions
22
22
  # Simulate matching the given index name against the index templates in the system
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] :name The name of the index (it must be a concrete index name)
25
29
  # @option arguments [Boolean] :create Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one
@@ -23,7 +23,6 @@ module Elasticsearch
23
23
  #
24
24
  # @option arguments [List] :metric Limit the information returned the specific metrics.
25
25
  # (options: _all,completion,docs,fielddata,query_cache,flush,get,indexing,merge,request_cache,refresh,search,segments,store,warmer,suggest)
26
-
27
26
  # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
28
27
  # @option arguments [List] :completion_fields A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)
29
28
  # @option arguments [List] :fielddata_fields A comma-separated list of fields for `fielddata` index metric (supports wildcards)
@@ -31,13 +30,11 @@ module Elasticsearch
31
30
  # @option arguments [List] :groups A comma-separated list of search groups for `search` index metric
32
31
  # @option arguments [String] :level Return stats aggregated at cluster, index or shard level
33
32
  # (options: cluster,indices,shards)
34
-
35
33
  # @option arguments [List] :types A comma-separated list of document types for the `indexing` index metric
36
34
  # @option arguments [Boolean] :include_segment_file_sizes Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested)
37
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
38
36
  # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
39
37
  # (options: open,closed,hidden,none,all)
40
-
41
38
  # @option arguments [Boolean] :forbid_closed_indices If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices
42
39
  # @option arguments [Hash] :headers Custom HTTP headers
43
40
  #
@@ -25,7 +25,6 @@ module Elasticsearch
25
25
  # @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)
26
26
  # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
27
27
  # (options: open,closed,hidden,none,all)
28
-
29
28
  # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
30
29
  # @option arguments [Boolean] :wait_for_completion Specify whether the request should block until the all segments are upgraded (default: false)
31
30
  # @option arguments [Boolean] :only_ancient_segments If true, only ancient (an older Lucene major release) segments will be upgraded
@@ -28,13 +28,11 @@ module Elasticsearch
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
29
  # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
30
30
  # (options: open,closed,hidden,none,all)
31
-
32
31
  # @option arguments [String] :q Query in the Lucene query string syntax
33
32
  # @option arguments [String] :analyzer The analyzer to use for the query string
34
33
  # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false)
35
34
  # @option arguments [String] :default_operator The default operator for query string query (AND or OR)
36
35
  # (options: AND,OR)
37
-
38
36
  # @option arguments [String] :df The field to use as default where no field prefix is given in the query string
39
37
  # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
40
38
  # @option arguments [Boolean] :rewrite Provide a more detailed explanation showing the actual Lucene query that will be executed.
@@ -24,7 +24,6 @@ module Elasticsearch
24
24
  # @option arguments [List] :type A comma-separated list of document types to use as default
25
25
  # @option arguments [String] :search_type Search operation type
26
26
  # (options: query_then_fetch,query_and_fetch,dfs_query_then_fetch,dfs_query_and_fetch)
27
-
28
27
  # @option arguments [Number] :max_concurrent_searches Controls the maximum number of concurrent searches the multi search api will execute
29
28
  # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
30
29
  # @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.
@@ -24,7 +24,6 @@ module Elasticsearch
24
24
  # @option arguments [List] :type A comma-separated list of document types to use as default
25
25
  # @option arguments [String] :search_type Search operation type
26
26
  # (options: query_then_fetch,query_and_fetch,dfs_query_then_fetch,dfs_query_and_fetch)
27
-
28
27
  # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
29
28
  # @option arguments [Number] :max_concurrent_searches Controls the maximum number of concurrent searches the multi search api will execute
30
29
  # @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,6 @@ module Elasticsearch
35
35
  # @option arguments [Number] :version Explicit version number for concurrency control
36
36
  # @option arguments [String] :version_type Specific version type
37
37
  # (options: internal,external,external_gte,force)
38
-
39
38
  # @option arguments [Hash] :headers Custom HTTP headers
40
39
  # @option arguments [Hash] :body Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation.
41
40
  #
@@ -28,7 +28,6 @@ module Elasticsearch
28
28
  # @option arguments [Boolean] :ignore_idle_threads Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue (default: true)
29
29
  # @option arguments [String] :type The type to sample (default: cpu)
30
30
  # (options: cpu,wait,block)
31
-
32
31
  # @option arguments [Time] :timeout Explicit operation timeout
33
32
  # @option arguments [Hash] :headers Custom HTTP headers
34
33
  #
@@ -24,7 +24,6 @@ module Elasticsearch
24
24
  # @option arguments [List] :node_id 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
25
  # @option arguments [List] :metric A comma-separated list of metrics you wish returned. Leave empty to return all.
26
26
  # (options: settings,os,process,jvm,thread_pool,transport,http,plugins,ingest)
27
-
28
27
  # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
29
28
  # @option arguments [Time] :timeout Explicit operation timeout
30
29
  # @option arguments [Hash] :headers Custom HTTP headers
@@ -24,17 +24,14 @@ module Elasticsearch
24
24
  # @option arguments [List] :node_id 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
25
  # @option arguments [List] :metric Limit the information returned to the specified metrics
26
26
  # (options: _all,breaker,fs,http,indices,jvm,os,process,thread_pool,transport,discovery)
27
-
28
27
  # @option arguments [List] :index_metric Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified.
29
28
  # (options: _all,completion,docs,fielddata,query_cache,flush,get,indexing,merge,request_cache,refresh,search,segments,store,warmer,suggest)
30
-
31
29
  # @option arguments [List] :completion_fields A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)
32
30
  # @option arguments [List] :fielddata_fields A comma-separated list of fields for `fielddata` index metric (supports wildcards)
33
31
  # @option arguments [List] :fields A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)
34
32
  # @option arguments [Boolean] :groups A comma-separated list of search groups for `search` index metric
35
33
  # @option arguments [String] :level Return indices stats aggregated at index, node or shard level
36
34
  # (options: indices,node,shards)
37
-
38
35
  # @option arguments [List] :types A comma-separated list of document types for the `indexing` index metric
39
36
  # @option arguments [Time] :timeout Explicit operation timeout
40
37
  # @option arguments [Boolean] :include_segment_file_sizes Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested)
@@ -24,7 +24,6 @@ module Elasticsearch
24
24
  # @option arguments [List] :node_id 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
25
  # @option arguments [List] :metric Limit the information returned to the specified metrics
26
26
  # (options: _all,rest_actions)
27
-
28
27
  # @option arguments [Time] :timeout Explicit operation timeout
29
28
  # @option arguments [Hash] :headers Custom HTTP headers
30
29
  #
@@ -19,16 +19,18 @@ module Elasticsearch
19
19
  module API
20
20
  module Actions
21
21
  # Allows to evaluate the quality of ranked search results over a set of typical search queries
22
+ # This functionality is Experimental and may be changed or removed
23
+ # completely in a future release. Elastic will take a best effort approach
24
+ # to fix any issues, but experimental features are not subject to the
25
+ # support SLA of official GA features.
22
26
  #
23
27
  # @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
28
  # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
25
29
  # @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)
26
30
  # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
27
31
  # (options: open,closed,hidden,none,all)
28
-
29
32
  # @option arguments [String] :search_type Search operation type
30
33
  # (options: query_then_fetch,dfs_query_then_fetch)
31
-
32
34
  # @option arguments [Hash] :headers Custom HTTP headers
33
35
  # @option arguments [Hash] :body The ranking evaluation search definition, including search requests, document ratings and ranking metric definition. (*Required*)
34
36
  #
@@ -19,6 +19,10 @@ module Elasticsearch
19
19
  module API
20
20
  module Actions
21
21
  # Allows an arbitrary script to be executed and a result to be returned
22
+ # This functionality is Experimental and may be changed or removed
23
+ # completely in a future release. Elastic will take a best effort approach
24
+ # to fix any issues, but experimental features are not subject to the
25
+ # support SLA of official GA features.
22
26
  #
23
27
  # @option arguments [Hash] :headers Custom HTTP headers
24
28
  # @option arguments [Hash] :body The script to execute
@@ -27,7 +27,6 @@ module Elasticsearch
27
27
  # @option arguments [Boolean] :ccs_minimize_roundtrips Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution
28
28
  # @option arguments [String] :default_operator The default operator for query string query (AND or OR)
29
29
  # (options: AND,OR)
30
-
31
30
  # @option arguments [String] :df The field to use as default where no field prefix is given in the query string
32
31
  # @option arguments [Boolean] :explain Specify whether to return detailed information about score computation as part of a hit
33
32
  # @option arguments [List] :stored_fields A comma-separated list of stored fields to return as part of a hit
@@ -38,7 +37,6 @@ module Elasticsearch
38
37
  # @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)
39
38
  # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
40
39
  # (options: open,closed,hidden,none,all)
41
-
42
40
  # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
43
41
  # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
44
42
  # @option arguments [String] :q Query in the Lucene query string syntax
@@ -46,7 +44,6 @@ module Elasticsearch
46
44
  # @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search
47
45
  # @option arguments [String] :search_type Search operation type
48
46
  # (options: query_then_fetch,dfs_query_then_fetch)
49
-
50
47
  # @option arguments [Number] :size Number of hits to return (default: 10)
51
48
  # @option arguments [List] :sort A comma-separated list of <field>:<direction> pairs
52
49
  # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return
@@ -57,7 +54,6 @@ module Elasticsearch
57
54
  # @option arguments [String] :suggest_field Specify which field to use for suggestions
58
55
  # @option arguments [String] :suggest_mode Specify suggest mode
59
56
  # (options: missing,popular,always)
60
-
61
57
  # @option arguments [Number] :suggest_size How many suggestions to return in response
62
58
  # @option arguments [String] :suggest_text The source text for which the suggestions should be returned
63
59
  # @option arguments [Time] :timeout Explicit operation timeout