elasticsearch-api 9.1.2 → 9.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (140) hide show
  1. checksums.yaml +4 -4
  2. data/lib/elasticsearch/api/actions/async_search/submit.rb +12 -4
  3. data/lib/elasticsearch/api/actions/cat/aliases.rb +9 -0
  4. data/lib/elasticsearch/api/actions/cat/allocation.rb +9 -1
  5. data/lib/elasticsearch/api/actions/cat/component_templates.rb +9 -0
  6. data/lib/elasticsearch/api/actions/cat/count.rb +17 -0
  7. data/lib/elasticsearch/api/actions/cat/fielddata.rb +9 -1
  8. data/lib/elasticsearch/api/actions/cat/health.rb +10 -2
  9. data/lib/elasticsearch/api/actions/cat/indices.rb +10 -3
  10. data/lib/elasticsearch/api/actions/cat/master.rb +10 -1
  11. data/lib/elasticsearch/api/actions/cat/ml_data_frame_analytics.rb +11 -3
  12. data/lib/elasticsearch/api/actions/cat/ml_datafeeds.rb +9 -1
  13. data/lib/elasticsearch/api/actions/cat/ml_jobs.rb +9 -2
  14. data/lib/elasticsearch/api/actions/cat/ml_trained_models.rb +11 -4
  15. data/lib/elasticsearch/api/actions/cat/nodeattrs.rb +10 -1
  16. data/lib/elasticsearch/api/actions/cat/nodes.rb +10 -3
  17. data/lib/elasticsearch/api/actions/cat/pending_tasks.rb +10 -2
  18. data/lib/elasticsearch/api/actions/cat/plugins.rb +10 -1
  19. data/lib/elasticsearch/api/actions/cat/recovery.rb +9 -2
  20. data/lib/elasticsearch/api/actions/cat/repositories.rb +9 -0
  21. data/lib/elasticsearch/api/actions/cat/segments.rb +9 -1
  22. data/lib/elasticsearch/api/actions/cat/shards.rb +9 -2
  23. data/lib/elasticsearch/api/actions/cat/snapshots.rb +9 -1
  24. data/lib/elasticsearch/api/actions/cat/tasks.rb +10 -2
  25. data/lib/elasticsearch/api/actions/cat/templates.rb +10 -1
  26. data/lib/elasticsearch/api/actions/cat/thread_pool.rb +9 -1
  27. data/lib/elasticsearch/api/actions/cat/transforms.rb +9 -1
  28. data/lib/elasticsearch/api/actions/close_point_in_time.rb +2 -0
  29. data/lib/elasticsearch/api/actions/cluster/allocation_explain.rb +5 -0
  30. data/lib/elasticsearch/api/actions/cluster/state.rb +1 -1
  31. data/lib/elasticsearch/api/actions/connector/delete.rb +1 -1
  32. data/lib/elasticsearch/api/actions/connector/list.rb +2 -2
  33. data/lib/elasticsearch/api/actions/connector/sync_job_list.rb +2 -2
  34. data/lib/elasticsearch/api/actions/count.rb +10 -2
  35. data/lib/elasticsearch/api/actions/cross_cluster_replication/follow.rb +1 -1
  36. data/lib/elasticsearch/api/actions/dangling_indices/delete_dangling_index.rb +1 -1
  37. data/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb +1 -1
  38. data/lib/elasticsearch/api/actions/delete_by_query.rb +2 -2
  39. data/lib/elasticsearch/api/actions/eql/get.rb +1 -1
  40. data/lib/elasticsearch/api/actions/eql/search.rb +8 -0
  41. data/lib/elasticsearch/api/actions/esql/async_query.rb +1 -1
  42. data/lib/elasticsearch/api/actions/esql/query.rb +1 -1
  43. data/lib/elasticsearch/api/actions/explain.rb +2 -2
  44. data/lib/elasticsearch/api/actions/field_caps.rb +8 -0
  45. data/lib/elasticsearch/api/actions/fleet/search.rb +2 -6
  46. data/lib/elasticsearch/api/actions/get.rb +1 -0
  47. data/lib/elasticsearch/api/actions/get_script.rb +1 -1
  48. data/lib/elasticsearch/api/actions/graph/explore.rb +2 -6
  49. data/lib/elasticsearch/api/actions/index_lifecycle_management/move_to_step.rb +1 -0
  50. data/lib/elasticsearch/api/actions/index_lifecycle_management/put_lifecycle.rb +1 -0
  51. data/lib/elasticsearch/api/actions/indices/analyze.rb +3 -6
  52. data/lib/elasticsearch/api/actions/indices/create_from.rb +0 -1
  53. data/lib/elasticsearch/api/actions/indices/delete_data_lifecycle.rb +1 -1
  54. data/lib/elasticsearch/api/actions/indices/delete_data_stream_options.rb +1 -1
  55. data/lib/elasticsearch/api/actions/indices/disk_usage.rb +1 -0
  56. data/lib/elasticsearch/api/actions/indices/explain_data_lifecycle.rb +1 -1
  57. data/lib/elasticsearch/api/actions/indices/forcemerge.rb +1 -1
  58. data/lib/elasticsearch/api/actions/indices/get_data_stream_mappings.rb +75 -0
  59. data/lib/elasticsearch/api/actions/indices/put_data_lifecycle.rb +1 -0
  60. data/lib/elasticsearch/api/actions/indices/put_data_stream_mappings.rb +84 -0
  61. data/lib/elasticsearch/api/actions/indices/put_data_stream_options.rb +1 -0
  62. data/lib/elasticsearch/api/actions/indices/put_index_template.rb +1 -1
  63. data/lib/elasticsearch/api/actions/indices/put_template.rb +1 -1
  64. data/lib/elasticsearch/api/actions/indices/refresh.rb +1 -0
  65. data/lib/elasticsearch/api/actions/indices/resolve_index.rb +9 -0
  66. data/lib/elasticsearch/api/actions/indices/rollover.rb +1 -1
  67. data/lib/elasticsearch/api/actions/indices/shrink.rb +1 -0
  68. data/lib/elasticsearch/api/actions/indices/simulate_index_template.rb +2 -1
  69. data/lib/elasticsearch/api/actions/indices/simulate_template.rb +1 -1
  70. data/lib/elasticsearch/api/actions/indices/split.rb +1 -0
  71. data/lib/elasticsearch/api/actions/indices/stats.rb +1 -1
  72. data/lib/elasticsearch/api/actions/indices/validate_query.rb +1 -1
  73. data/lib/elasticsearch/api/actions/inference/completion.rb +1 -0
  74. data/lib/elasticsearch/api/actions/inference/inference.rb +1 -0
  75. data/lib/elasticsearch/api/actions/inference/put.rb +2 -1
  76. data/lib/elasticsearch/api/actions/inference/put_ai21.rb +79 -0
  77. data/lib/elasticsearch/api/actions/inference/put_alibabacloud.rb +1 -0
  78. data/lib/elasticsearch/api/actions/inference/put_amazonbedrock.rb +1 -0
  79. data/lib/elasticsearch/api/actions/inference/put_amazonsagemaker.rb +1 -0
  80. data/lib/elasticsearch/api/actions/inference/put_anthropic.rb +1 -0
  81. data/lib/elasticsearch/api/actions/inference/put_azureaistudio.rb +1 -0
  82. data/lib/elasticsearch/api/actions/inference/put_azureopenai.rb +1 -0
  83. data/lib/elasticsearch/api/actions/inference/put_cohere.rb +1 -0
  84. data/lib/elasticsearch/api/actions/inference/put_contextualai.rb +84 -0
  85. data/lib/elasticsearch/api/actions/inference/put_custom.rb +1 -0
  86. data/lib/elasticsearch/api/actions/inference/put_deepseek.rb +1 -0
  87. data/lib/elasticsearch/api/actions/inference/put_elasticsearch.rb +1 -0
  88. data/lib/elasticsearch/api/actions/inference/put_elser.rb +1 -0
  89. data/lib/elasticsearch/api/actions/inference/put_googleaistudio.rb +1 -0
  90. data/lib/elasticsearch/api/actions/inference/put_googlevertexai.rb +1 -0
  91. data/lib/elasticsearch/api/actions/inference/put_hugging_face.rb +1 -0
  92. data/lib/elasticsearch/api/actions/inference/put_jinaai.rb +1 -0
  93. data/lib/elasticsearch/api/actions/inference/put_llama.rb +79 -0
  94. data/lib/elasticsearch/api/actions/inference/put_mistral.rb +1 -0
  95. data/lib/elasticsearch/api/actions/inference/put_openai.rb +1 -0
  96. data/lib/elasticsearch/api/actions/inference/put_voyageai.rb +1 -0
  97. data/lib/elasticsearch/api/actions/inference/put_watsonx.rb +1 -0
  98. data/lib/elasticsearch/api/actions/inference/rerank.rb +1 -0
  99. data/lib/elasticsearch/api/actions/inference/sparse_embedding.rb +1 -0
  100. data/lib/elasticsearch/api/actions/inference/stream_completion.rb +1 -0
  101. data/lib/elasticsearch/api/actions/inference/text_embedding.rb +1 -0
  102. data/lib/elasticsearch/api/actions/license/get.rb +3 -1
  103. data/lib/elasticsearch/api/actions/logstash/put_pipeline.rb +2 -1
  104. data/lib/elasticsearch/api/actions/machine_learning/get_overall_buckets.rb +1 -1
  105. data/lib/elasticsearch/api/actions/msearch.rb +7 -0
  106. data/lib/elasticsearch/api/actions/msearch_template.rb +8 -0
  107. data/lib/elasticsearch/api/actions/nodes/stats.rb +1 -1
  108. data/lib/elasticsearch/api/actions/open_point_in_time.rb +8 -0
  109. data/lib/elasticsearch/api/actions/project/tags.rb +65 -0
  110. data/lib/elasticsearch/api/actions/query_rules/list_rulesets.rb +1 -1
  111. data/lib/elasticsearch/api/actions/reindex.rb +1 -1
  112. data/lib/elasticsearch/api/actions/render_search_template.rb +3 -6
  113. data/lib/elasticsearch/api/actions/scripts_painless_execute.rb +3 -6
  114. data/lib/elasticsearch/api/actions/search.rb +11 -2
  115. data/lib/elasticsearch/api/actions/search_mvt.rb +9 -1
  116. data/lib/elasticsearch/api/actions/search_template.rb +8 -0
  117. data/lib/elasticsearch/api/actions/searchable_snapshots/stats.rb +1 -1
  118. data/lib/elasticsearch/api/actions/security/get_settings.rb +1 -1
  119. data/lib/elasticsearch/api/actions/security/get_stats.rb +62 -0
  120. data/lib/elasticsearch/api/actions/security/update_settings.rb +1 -1
  121. data/lib/elasticsearch/api/actions/simulate/ingest.rb +4 -0
  122. data/lib/elasticsearch/api/actions/snapshot/get_repository.rb +1 -1
  123. data/lib/elasticsearch/api/actions/snapshot/repository_analyze.rb +17 -10
  124. data/lib/elasticsearch/api/actions/snapshot/status.rb +5 -0
  125. data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/put_lifecycle.rb +1 -0
  126. data/lib/elasticsearch/api/actions/sql/get_async.rb +1 -1
  127. data/lib/elasticsearch/api/actions/sql/query.rb +8 -0
  128. data/lib/elasticsearch/api/actions/streams/logs_disable.rb +23 -3
  129. data/lib/elasticsearch/api/actions/streams/logs_enable.rb +26 -3
  130. data/lib/elasticsearch/api/actions/streams/status.rb +20 -3
  131. data/lib/elasticsearch/api/actions/tasks/list.rb +1 -1
  132. data/lib/elasticsearch/api/actions/terms_enum.rb +2 -6
  133. data/lib/elasticsearch/api/actions/transform/get_node_stats.rb +1 -1
  134. data/lib/elasticsearch/api/actions/update_by_query.rb +2 -2
  135. data/lib/elasticsearch/api/actions/watcher/get_settings.rb +1 -1
  136. data/lib/elasticsearch/api/actions/watcher/put_watch.rb +1 -0
  137. data/lib/elasticsearch/api/actions/watcher/update_settings.rb +1 -1
  138. data/lib/elasticsearch/api/version.rb +2 -2
  139. data/lib/elasticsearch/api.rb +1 -0
  140. metadata +9 -2
@@ -30,18 +30,25 @@ module Elasticsearch
30
30
  # @option arguments [String, Array] :index A comma-separated list of data streams, indices, and aliases used to limit the request.
31
31
  # Supports wildcards (`*`).
32
32
  # To target all data streams and indices, omit this parameter or use `*` or `_all`.
33
- # @option arguments [String] :bytes The unit used to display byte values.
34
33
  # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
35
34
  # @option arguments [String, Array<String>] :s A comma-separated list of column names or aliases that determines the sort order.
36
35
  # Sorting defaults to ascending and can be changed by setting `:asc`
37
36
  # or `:desc` as a suffix to the column name.
38
37
  # @option arguments [Time] :master_timeout The period to wait for a connection to the master node. Server default: 30s.
39
- # @option arguments [String] :time The unit used to display time values.
40
38
  # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
41
39
  # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
42
40
  # @option arguments [Boolean] :help When set to `true` will output available columns. This option
43
41
  # can't be combined with any other query string option.
44
42
  # @option arguments [Boolean] :v When set to `true` will enable verbose output.
43
+ # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value.
44
+ # Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.
45
+ # If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
46
+ # If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.
47
+ # Values that are not an exact multiple of the chosen unit are rounded down.
48
+ # @option arguments [String] :time Sets the units for columns that contain a time duration.
49
+ # If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
50
+ # If given, time duration values are rendered as an integer with no suffix.
51
+ # Values that are not an exact multiple of the chosen unit are rounded down.
45
52
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
46
53
  # when they occur.
47
54
  # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
@@ -38,12 +38,20 @@ module Elasticsearch
38
38
  # Sorting defaults to ascending and can be changed by setting `:asc`
39
39
  # or `:desc` as a suffix to the column name.
40
40
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
41
- # @option arguments [String] :time Unit used to display time values.
42
41
  # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
43
42
  # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
44
43
  # @option arguments [Boolean] :help When set to `true` will output available columns. This option
45
44
  # can't be combined with any other query string option.
46
45
  # @option arguments [Boolean] :v When set to `true` will enable verbose output.
46
+ # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value.
47
+ # Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.
48
+ # If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
49
+ # If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.
50
+ # Values that are not an exact multiple of the chosen unit are rounded down.
51
+ # @option arguments [String] :time Sets the units for columns that contain a time duration.
52
+ # If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
53
+ # If given, time duration values are rendered as an integer with no suffix.
54
+ # Values that are not an exact multiple of the chosen unit are rounded down.
47
55
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
48
56
  # when they occur.
49
57
  # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
@@ -34,11 +34,10 @@ module Elasticsearch
34
34
  # @option arguments [Boolean] :detailed If `true`, the response includes detailed information about shard recoveries.
35
35
  # @option arguments [Array<String>] :nodes Unique node identifiers, which are used to limit the response.
36
36
  # @option arguments [String] :parent_task_id The parent task identifier, which is used to limit the response.
37
- # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
37
+ # @option arguments [String, Array<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
38
38
  # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
39
39
  # Sorting defaults to ascending and can be changed by setting `:asc`
40
40
  # or `:desc` as a suffix to the column name.
41
- # @option arguments [String] :time Unit used to display time values.
42
41
  # @option arguments [Time] :timeout Period to wait for a response.
43
42
  # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
44
43
  # @option arguments [Boolean] :wait_for_completion If `true`, the request blocks until the task has completed.
@@ -47,6 +46,15 @@ module Elasticsearch
47
46
  # @option arguments [Boolean] :help When set to `true` will output available columns. This option
48
47
  # can't be combined with any other query string option.
49
48
  # @option arguments [Boolean] :v When set to `true` will enable verbose output.
49
+ # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value.
50
+ # Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.
51
+ # If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
52
+ # If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.
53
+ # Values that are not an exact multiple of the chosen unit are rounded down.
54
+ # @option arguments [String] :time Sets the units for columns that contain a time duration.
55
+ # If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
56
+ # If given, time duration values are rendered as an integer with no suffix.
57
+ # Values that are not an exact multiple of the chosen unit are rounded down.
50
58
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
51
59
  # when they occur.
52
60
  # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
@@ -29,7 +29,7 @@ module Elasticsearch
29
29
  #
30
30
  # @option arguments [String] :name The name of the template to return.
31
31
  # Accepts wildcard expressions. If omitted, all templates are returned.
32
- # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
32
+ # @option arguments [String, Array<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
33
33
  # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
34
34
  # Sorting defaults to ascending and can be changed by setting `:asc`
35
35
  # or `:desc` as a suffix to the column name.
@@ -43,6 +43,15 @@ module Elasticsearch
43
43
  # @option arguments [Boolean] :help When set to `true` will output available columns. This option
44
44
  # can't be combined with any other query string option.
45
45
  # @option arguments [Boolean] :v When set to `true` will enable verbose output.
46
+ # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value.
47
+ # Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.
48
+ # If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
49
+ # If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.
50
+ # Values that are not an exact multiple of the chosen unit are rounded down.
51
+ # @option arguments [String] :time Sets the units for columns that contain a time duration.
52
+ # If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
53
+ # If given, time duration values are rendered as an integer with no suffix.
54
+ # Values that are not an exact multiple of the chosen unit are rounded down.
46
55
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
47
56
  # when they occur.
48
57
  # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
@@ -33,7 +33,6 @@ module Elasticsearch
33
33
  # @option arguments [String, Array<String>] :s A comma-separated list of column names or aliases that determines the sort order.
34
34
  # Sorting defaults to ascending and can be changed by setting `:asc`
35
35
  # or `:desc` as a suffix to the column name.
36
- # @option arguments [String] :time The unit used to display time values.
37
36
  # @option arguments [Boolean] :local If `true`, the request computes the list of selected nodes from the
38
37
  # local cluster state. If `false` the list of selected nodes are computed
39
38
  # from the cluster state of the master node. In both cases the coordinating
@@ -44,6 +43,15 @@ module Elasticsearch
44
43
  # @option arguments [Boolean] :help When set to `true` will output available columns. This option
45
44
  # can't be combined with any other query string option.
46
45
  # @option arguments [Boolean] :v When set to `true` will enable verbose output.
46
+ # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value.
47
+ # Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.
48
+ # If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
49
+ # If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.
50
+ # Values that are not an exact multiple of the chosen unit are rounded down.
51
+ # @option arguments [String] :time Sets the units for columns that contain a time duration.
52
+ # If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
53
+ # If given, time duration values are rendered as an integer with no suffix.
54
+ # Values that are not an exact multiple of the chosen unit are rounded down.
47
55
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
48
56
  # when they occur.
49
57
  # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
@@ -36,13 +36,21 @@ module Elasticsearch
36
36
  # @option arguments [Integer] :from Skips the specified number of transforms. Server default: 0.
37
37
  # @option arguments [String, Array<String>] :h Comma-separated list of column names to display. Server default: changes_last_detection_time,checkpoint,checkpoint_progress,documents_processed,id,last_search_time,state.
38
38
  # @option arguments [String, Array<String>] :s Comma-separated list of column names or column aliases used to sort the response.
39
- # @option arguments [String] :time The unit used to display time values.
40
39
  # @option arguments [Integer] :size The maximum number of transforms to obtain. Server default: 100.
41
40
  # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
42
41
  # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
43
42
  # @option arguments [Boolean] :help When set to `true` will output available columns. This option
44
43
  # can't be combined with any other query string option.
45
44
  # @option arguments [Boolean] :v When set to `true` will enable verbose output.
45
+ # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value.
46
+ # Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.
47
+ # If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
48
+ # If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.
49
+ # Values that are not an exact multiple of the chosen unit are rounded down.
50
+ # @option arguments [String] :time Sets the units for columns that contain a time duration.
51
+ # If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
52
+ # If given, time duration values are rendered as an integer with no suffix.
53
+ # Values that are not an exact multiple of the chosen unit are rounded down.
46
54
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
47
55
  # when they occur.
48
56
  # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
@@ -46,6 +46,8 @@ module Elasticsearch
46
46
  def close_point_in_time(arguments = {})
47
47
  request_opts = { endpoint: arguments[:endpoint] || 'close_point_in_time' }
48
48
 
49
+ raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
50
+
49
51
  arguments = arguments.clone
50
52
  headers = arguments.delete(:headers) || {}
51
53
 
@@ -24,11 +24,16 @@ module Elasticsearch
24
24
  module Actions
25
25
  # Explain the shard allocations.
26
26
  # Get explanations for shard allocations in the cluster.
27
+ # This API accepts the current_node, index, primary and shard parameters in the request body or in query parameters, but not in both at the same time.
27
28
  # For unassigned shards, it provides an explanation for why the shard is unassigned.
28
29
  # For assigned shards, it provides an explanation for why the shard is remaining on its current node and has not moved or rebalanced to another node.
29
30
  # This API can be very useful when attempting to diagnose why a shard is unassigned or why a shard continues to remain on its current node when you might expect otherwise.
30
31
  # Refer to the linked documentation for examples of how to troubleshoot allocation issues using this API.
31
32
  #
33
+ # @option arguments [String] :index The name of the index that you would like an explanation for.
34
+ # @option arguments [Integer] :shard An identifier for the shard that you would like an explanation for.
35
+ # @option arguments [Boolean] :primary If true, returns an explanation for the primary shard for the specified shard ID.
36
+ # @option arguments [String] :current_node Explain a shard only if it is currently located on the specified node name or node ID.
32
37
  # @option arguments [Boolean] :include_disk_info If true, returns information about disk usage and shard sizes.
33
38
  # @option arguments [Boolean] :include_yes_decisions If true, returns YES decisions in explanation.
34
39
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
@@ -44,7 +44,7 @@ module Elasticsearch
44
44
  # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
45
45
  # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
46
46
  # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
47
- # @option arguments [Time] :master_timeout Specify timeout for connection to master Server default: 30s.
47
+ # @option arguments [Time] :master_timeout Timeout for waiting for new cluster state in case it is blocked Server default: 30s.
48
48
  # @option arguments [Integer] :wait_for_metadata_version Wait for the metadata version to be equal or greater than the specified metadata version
49
49
  # @option arguments [Time] :wait_for_timeout The maximum time to wait for wait_for_metadata_version before timing out
50
50
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
@@ -33,7 +33,7 @@ module Elasticsearch
33
33
  # SLA of official GA features.
34
34
  #
35
35
  # @option arguments [String] :connector_id The unique identifier of the connector to be deleted (*Required*)
36
- # @option arguments [Boolean] :delete_sync_jobs A flag indicating if associated sync jobs should be also removed. Defaults to false.
36
+ # @option arguments [Boolean] :delete_sync_jobs A flag indicating if associated sync jobs should be also removed.
37
37
  # @option arguments [Boolean] :hard A flag indicating if the connector should be hard deleted.
38
38
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
39
39
  # when they occur.
@@ -29,8 +29,8 @@ module Elasticsearch
29
29
  # as-is with no warranties. Beta features are not subject to the support
30
30
  # SLA of official GA features.
31
31
  #
32
- # @option arguments [Integer] :from Starting offset (default: 0)
33
- # @option arguments [Integer] :size Specifies a max number of results to get
32
+ # @option arguments [Integer] :from Starting offset Server default: 0.
33
+ # @option arguments [Integer] :size Specifies a max number of results to get Server default: 100.
34
34
  # @option arguments [String, Array] :index_name A comma-separated list of connector index names to fetch connector documents for
35
35
  # @option arguments [String, Array<String>] :connector_name A comma-separated list of connector names to fetch connector documents for
36
36
  # @option arguments [String, Array<String>] :service_type A comma-separated list of connector service types to fetch connector documents for
@@ -29,8 +29,8 @@ module Elasticsearch
29
29
  # as-is with no warranties. Beta features are not subject to the support
30
30
  # SLA of official GA features.
31
31
  #
32
- # @option arguments [Integer] :from Starting offset (default: 0)
33
- # @option arguments [Integer] :size Specifies a max number of results to get
32
+ # @option arguments [Integer] :from Starting offset Server default: 0.
33
+ # @option arguments [Integer] :size Specifies a max number of results to get Server default: 100.
34
34
  # @option arguments [String] :status A sync job status to fetch connector sync jobs for
35
35
  # @option arguments [String] :connector_id A connector id to fetch connector sync jobs for
36
36
  # @option arguments [String, Array<String>] :job_type A comma-separated list of job types to fetch the sync jobs for
@@ -40,8 +40,8 @@ module Elasticsearch
40
40
  # This parameter can be used only when the `q` query string parameter is specified.
41
41
  # @option arguments [Boolean] :analyze_wildcard If `true`, wildcard and prefix queries are analyzed.
42
42
  # This parameter can be used only when the `q` query string parameter is specified.
43
- # @option arguments [String] :default_operator The default operator for query string query: `AND` or `OR`.
44
- # This parameter can be used only when the `q` query string parameter is specified. Server default: OR.
43
+ # @option arguments [String] :default_operator The default operator for query string query: `and` or `or`.
44
+ # This parameter can be used only when the `q` query string parameter is specified. Server default: or.
45
45
  # @option arguments [String] :df The field to use as a default when no field prefix is given in the query string.
46
46
  # This parameter can be used only when the `q` query string parameter is specified.
47
47
  # @option arguments [String, Array<String>] :expand_wildcards The type of index that wildcard patterns can match.
@@ -54,6 +54,14 @@ module Elasticsearch
54
54
  # @option arguments [Float] :min_score The minimum `_score` value that documents must have to be included in the result.
55
55
  # @option arguments [String] :preference The node or shard the operation should be performed on.
56
56
  # By default, it is random.
57
+ # @option arguments [String] :project_routing Specifies a subset of projects to target for the search using project
58
+ # metadata tags in a subset of Lucene query syntax.
59
+ # Allowed Lucene queries: the _alias tag and a single value (possibly wildcarded).
60
+ # Examples:
61
+ # _alias:my-project
62
+ # _alias:_origin
63
+ # _alias:*pr*
64
+ # Supported in serverless only.
57
65
  # @option arguments [String] :routing A custom value used to route operations to a specific shard.
58
66
  # @option arguments [Integer] :terminate_after The maximum number of documents to collect for each shard.
59
67
  # If a query reaches this limit, Elasticsearch terminates the query early.
@@ -31,7 +31,7 @@ module Elasticsearch
31
31
  # @option arguments [Integer, String] :wait_for_active_shards Specifies the number of shards to wait on being active before responding. This defaults to waiting on none of the shards to be
32
32
  # active.
33
33
  # A shard must be restored from the leader index before being active. Restoring a follower shard requires transferring all the
34
- # remote Lucene segment files to the follower index.
34
+ # remote Lucene segment files to the follower index. Server default: 0.
35
35
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
36
36
  # when they occur.
37
37
  # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
@@ -28,7 +28,7 @@ module Elasticsearch
28
28
  #
29
29
  # @option arguments [String] :index_uuid The UUID of the index to delete. Use the get dangling indices API to find the UUID. (*Required*)
30
30
  # @option arguments [Boolean] :accept_data_loss This parameter must be set to true to acknowledge that it will no longer be possible to recove data from the dangling index. (*Required*)
31
- # @option arguments [Time] :master_timeout Specify timeout for connection to master
31
+ # @option arguments [Time] :master_timeout Specify timeout for connection to master Server default: 30s.
32
32
  # @option arguments [Time] :timeout Explicit operation timeout
33
33
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
34
34
  # when they occur.
@@ -29,7 +29,7 @@ module Elasticsearch
29
29
  # @option arguments [String] :index_uuid The UUID of the index to import. Use the get dangling indices API to locate the UUID. (*Required*)
30
30
  # @option arguments [Boolean] :accept_data_loss This parameter must be set to true to import a dangling index.
31
31
  # Because Elasticsearch cannot know where the dangling index data came from or determine which shard copies are fresh and which are stale, it cannot guarantee that the imported data represents the latest state of the index when it was last in the cluster. (*Required*)
32
- # @option arguments [Time] :master_timeout Specify timeout for connection to master
32
+ # @option arguments [Time] :master_timeout Specify timeout for connection to master Server default: 30s.
33
33
  # @option arguments [Time] :timeout Explicit operation timeout
34
34
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
35
35
  # when they occur.
@@ -93,8 +93,8 @@ module Elasticsearch
93
93
  # @option arguments [Boolean] :analyze_wildcard If `true`, wildcard and prefix queries are analyzed.
94
94
  # This parameter can be used only when the `q` query string parameter is specified.
95
95
  # @option arguments [String] :conflicts What to do if delete by query hits version conflicts: `abort` or `proceed`. Server default: abort.
96
- # @option arguments [String] :default_operator The default operator for query string query: `AND` or `OR`.
97
- # This parameter can be used only when the `q` query string parameter is specified. Server default: OR.
96
+ # @option arguments [String] :default_operator The default operator for query string query: `and` or `or`.
97
+ # This parameter can be used only when the `q` query string parameter is specified. Server default: or.
98
98
  # @option arguments [String] :df The field to use as default where no field prefix is given in the query string.
99
99
  # This parameter can be used only when the `q` query string parameter is specified.
100
100
  # @option arguments [String, Array<String>] :expand_wildcards The type of index that wildcard patterns can match.
@@ -27,7 +27,7 @@ module Elasticsearch
27
27
  #
28
28
  # @option arguments [String] :id Identifier for the search. (*Required*)
29
29
  # @option arguments [Time] :keep_alive Period for which the search and its results are stored on the cluster.
30
- # Defaults to the keep_alive value set by the search’s EQL search API request.
30
+ # Defaults to the keep_alive value set by the search’s EQL search API request. Server default: 5d.
31
31
  # @option arguments [Time] :wait_for_completion_timeout Timeout duration to wait for the request to finish.
32
32
  # Defaults to no timeout, meaning the request waits for complete search results.
33
33
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
@@ -36,6 +36,14 @@ module Elasticsearch
36
36
  # @option arguments [Boolean] :ignore_unavailable If true, missing or closed indices are not included in the response. Server default: true.
37
37
  # @option arguments [Time] :keep_alive Period for which the search and its results are stored on the cluster. Server default: 5d.
38
38
  # @option arguments [Boolean] :keep_on_completion If true, the search and its results are stored on the cluster.
39
+ # @option arguments [String] :project_routing Specifies a subset of projects to target for the search using project
40
+ # metadata tags in a subset of Lucene query syntax.
41
+ # Allowed Lucene queries: the _alias tag and a single value (possibly wildcarded).
42
+ # Examples:
43
+ # _alias:my-project
44
+ # _alias:_origin
45
+ # _alias:*pr*
46
+ # Supported in serverless only.
39
47
  # @option arguments [Time] :wait_for_completion_timeout Timeout duration to wait for the request to finish. Defaults to no timeout, meaning the request waits for complete search results.
40
48
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
41
49
  # when they occur.
@@ -29,7 +29,7 @@ module Elasticsearch
29
29
  # @option arguments [Boolean] :allow_partial_results If `true`, partial results will be returned if there are shard failures, but the query can continue to execute on other clusters and shards.
30
30
  # If `false`, the query will fail if there are any failures.To override the default behavior, you can set the `esql.query.allow_partial_results` cluster setting to `false`. Server default: true.
31
31
  # @option arguments [String] :delimiter The character to use between values within a CSV row.
32
- # It is valid only for the CSV format.
32
+ # It is valid only for the CSV format. Server default: ,.
33
33
  # @option arguments [Boolean] :drop_null_columns Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results.
34
34
  # If `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns.
35
35
  # @option arguments [String] :format A short version of the Accept header, e.g. json, yaml.`csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response.For async requests, nothing will be returned if the async query doesn't finish within the timeout.
@@ -29,7 +29,7 @@ module Elasticsearch
29
29
  # library is upgraded.
30
30
  #
31
31
  # @option arguments [String] :format A short version of the Accept header, e.g. json, yaml.`csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response.
32
- # @option arguments [String] :delimiter The character to use between values within a CSV row. Only valid for the CSV format.
32
+ # @option arguments [String] :delimiter The character to use between values within a CSV row. Only valid for the CSV format. Server default: ,.
33
33
  # @option arguments [Boolean] :drop_null_columns Should columns that are entirely `null` be removed from the `columns` and `values` portion of the results?
34
34
  # Defaults to `false`. If `true` then the response will include an extra section under the name `all_columns` which has the name of all columns.
35
35
  # @option arguments [Boolean] :allow_partial_results If `true`, partial results will be returned if there are shard failures, but the query can continue to execute on other clusters and shards.
@@ -32,8 +32,8 @@ module Elasticsearch
32
32
  # This parameter can be used only when the `q` query string parameter is specified.
33
33
  # @option arguments [Boolean] :analyze_wildcard If `true`, wildcard and prefix queries are analyzed.
34
34
  # This parameter can be used only when the `q` query string parameter is specified.
35
- # @option arguments [String] :default_operator The default operator for query string query: `AND` or `OR`.
36
- # This parameter can be used only when the `q` query string parameter is specified. Server default: OR.
35
+ # @option arguments [String] :default_operator The default operator for query string query: `and` or `or`.
36
+ # This parameter can be used only when the `q` query string parameter is specified. Server default: or.
37
37
  # @option arguments [String] :df The field to use as default where no field prefix is given in the query string.
38
38
  # This parameter can be used only when the `q` query string parameter is specified.
39
39
  # @option arguments [Boolean] :lenient If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.
@@ -40,6 +40,14 @@ module Elasticsearch
40
40
  # Any fields that do not match one of these types will be excluded from the results.
41
41
  # It defaults to empty, meaning that all field types are returned.
42
42
  # @option arguments [Boolean] :include_empty_fields If false, empty fields are not included in the response. Server default: true.
43
+ # @option arguments [String] :project_routing Specifies a subset of projects to target for the field-caps query using project
44
+ # metadata tags in a subset of Lucene query syntax.
45
+ # Allowed Lucene queries: the _alias tag and a single value (possibly wildcarded).
46
+ # Examples:
47
+ # _alias:my-project
48
+ # _alias:_origin
49
+ # _alias:*pr*
50
+ # Supported in serverless only.
43
51
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
44
52
  # when they occur.
45
53
  # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
@@ -102,6 +102,7 @@ module Elasticsearch
102
102
  end
103
103
  request_opts[:defined_params] = defined_params unless defined_params.empty?
104
104
 
105
+ raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
105
106
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
106
107
 
107
108
  arguments = arguments.clone
@@ -111,12 +112,7 @@ module Elasticsearch
111
112
 
112
113
  _index = arguments.delete(:index)
113
114
 
114
- method = if body
115
- Elasticsearch::API::HTTP_POST
116
- else
117
- Elasticsearch::API::HTTP_GET
118
- end
119
-
115
+ method = Elasticsearch::API::HTTP_POST
120
116
  path = "#{Utils.listify(_index)}/_fleet/_fleet_search"
121
117
  params = Utils.process_params(arguments)
122
118
 
@@ -88,6 +88,7 @@ module Elasticsearch
88
88
  # @option arguments [String, Array<String>] :_source_excludes A comma-separated list of source fields to exclude from the response.
89
89
  # You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.
90
90
  # If the `_source` parameter is `false`, this parameter is ignored.
91
+ # @option arguments [Boolean] :_source_exclude_vectors Whether vectors should be excluded from _source
91
92
  # @option arguments [String, Array<String>] :_source_includes A comma-separated list of source fields to include in the response.
92
93
  # If this parameter is specified, only these source fields are returned.
93
94
  # You can exclude fields from this subset using the `_source_excludes` query parameter.
@@ -27,7 +27,7 @@ module Elasticsearch
27
27
  # @option arguments [String] :id The identifier for the stored script or search template. (*Required*)
28
28
  # @option arguments [Time] :master_timeout The period to wait for the master node.
29
29
  # If the master node is not available before the timeout expires, the request fails and returns an error.
30
- # It can also be set to `-1` to indicate that the request should never timeout. Server default: .
30
+ # It can also be set to `-1` to indicate that the request should never timeout. Server default: 30s.
31
31
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
32
32
  # when they occur.
33
33
  # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
@@ -58,6 +58,7 @@ module Elasticsearch
58
58
  end
59
59
  request_opts[:defined_params] = defined_params unless defined_params.empty?
60
60
 
61
+ raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
61
62
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
62
63
 
63
64
  arguments = arguments.clone
@@ -67,12 +68,7 @@ module Elasticsearch
67
68
 
68
69
  _index = arguments.delete(:index)
69
70
 
70
- method = if body
71
- Elasticsearch::API::HTTP_POST
72
- else
73
- Elasticsearch::API::HTTP_GET
74
- end
75
-
71
+ method = Elasticsearch::API::HTTP_POST
76
72
  path = "#{Utils.listify(_index)}/_graph/explore"
77
73
  params = Utils.process_params(arguments)
78
74
 
@@ -59,6 +59,7 @@ module Elasticsearch
59
59
  end
60
60
  request_opts[:defined_params] = defined_params unless defined_params.empty?
61
61
 
62
+ raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
62
63
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
63
64
 
64
65
  arguments = arguments.clone
@@ -53,6 +53,7 @@ module Elasticsearch
53
53
  end
54
54
  request_opts[:defined_params] = defined_params unless defined_params.empty?
55
55
 
56
+ raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
56
57
  raise ArgumentError, "Required argument 'policy' missing" unless arguments[:policy]
57
58
 
58
59
  arguments = arguments.clone
@@ -56,6 +56,8 @@ module Elasticsearch
56
56
  end
57
57
  request_opts[:defined_params] = defined_params unless defined_params.empty?
58
58
 
59
+ raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
60
+
59
61
  arguments = arguments.clone
60
62
  headers = arguments.delete(:headers) || {}
61
63
 
@@ -63,12 +65,7 @@ module Elasticsearch
63
65
 
64
66
  _index = arguments.delete(:index)
65
67
 
66
- method = if body
67
- Elasticsearch::API::HTTP_POST
68
- else
69
- Elasticsearch::API::HTTP_GET
70
- end
71
-
68
+ method = Elasticsearch::API::HTTP_POST
72
69
  path = if _index
73
70
  "#{Utils.listify(_index)}/_analyze"
74
71
  else
@@ -55,7 +55,6 @@ module Elasticsearch
55
55
  end
56
56
  request_opts[:defined_params] = defined_params unless defined_params.empty?
57
57
 
58
- raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
59
58
  raise ArgumentError, "Required argument 'source' missing" unless arguments[:source]
60
59
  raise ArgumentError, "Required argument 'dest' missing" unless arguments[:dest]
61
60
 
@@ -27,7 +27,7 @@ module Elasticsearch
27
27
  #
28
28
  # @option arguments [String, Array<String>] :name A comma-separated list of data streams of which the data stream lifecycle will be deleted; use `*` to get all data streams (*Required*)
29
29
  # @option arguments [String, Array<String>] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open)
30
- # @option arguments [Time] :master_timeout Specify timeout for connection to master
30
+ # @option arguments [Time] :master_timeout Specify timeout for connection to master Server default: 30s.
31
31
  # @option arguments [Time] :timeout Explicit timestamp for the document
32
32
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
33
33
  # when they occur.
@@ -27,7 +27,7 @@ module Elasticsearch
27
27
  #
28
28
  # @option arguments [String, Array<String>] :name A comma-separated list of data streams of which the data stream options will be deleted; use `*` to get all data streams (*Required*)
29
29
  # @option arguments [String, Array<String>] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open)
30
- # @option arguments [Time] :master_timeout Specify timeout for connection to master
30
+ # @option arguments [Time] :master_timeout Specify timeout for connection to master Server default: 30s.
31
31
  # @option arguments [Time] :timeout Explicit timestamp for the document
32
32
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
33
33
  # when they occur.
@@ -29,6 +29,7 @@ module Elasticsearch
29
29
  # NOTE: The total size of fields of the analyzed shards of the index in the response is usually smaller than the index `store_size` value because some small metadata files are ignored and some parts of data files might not be scanned by the API.
30
30
  # Since stored fields are stored together in a compressed format, the sizes of stored fields are also estimates and can be inaccurate.
31
31
  # The stored size of the `_id` field is likely underestimated while the `_source` field is overestimated.
32
+ # For usage examples see the External documentation or refer to {https://www.elastic.co/docs/reference/elasticsearch/rest-apis/index-disk-usage Analyze the index disk usage example} for an example.
32
33
  # This functionality is Experimental and may be changed or removed
33
34
  # completely in a future release. Elastic will take a best effort approach
34
35
  # to fix any issues, but experimental features are not subject to the
@@ -27,7 +27,7 @@ module Elasticsearch
27
27
  #
28
28
  # @option arguments [String, Array] :index The name of the index to explain (*Required*)
29
29
  # @option arguments [Boolean] :include_defaults indicates if the API should return the default values the system uses for the index's lifecycle
30
- # @option arguments [Time] :master_timeout Specify timeout for connection to master
30
+ # @option arguments [Time] :master_timeout Specify timeout for connection to master Server default: 30s.
31
31
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
32
32
  # when they occur.
33
33
  # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
@@ -70,7 +70,7 @@ module Elasticsearch
70
70
  # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
71
71
  # @option arguments [Integer] :max_num_segments The number of segments the index should be merged into (default: dynamic)
72
72
  # @option arguments [Boolean] :only_expunge_deletes Specify whether the operation should only expunge deleted documents
73
- # @option arguments [Boolean] :wait_for_completion Should the request wait until the force merge is completed.
73
+ # @option arguments [Boolean] :wait_for_completion Should the request wait until the force merge is completed. Server default: true.
74
74
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
75
75
  # when they occur.
76
76
  # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response