elasticsearch-api 9.1.3 → 9.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (170) hide show
  1. checksums.yaml +4 -4
  2. data/lib/elasticsearch/api/actions/async_search/submit.rb +20 -9
  3. data/lib/elasticsearch/api/actions/bulk.rb +1 -0
  4. data/lib/elasticsearch/api/actions/cat/aliases.rb +1 -1
  5. data/lib/elasticsearch/api/actions/cat/count.rb +8 -0
  6. data/lib/elasticsearch/api/actions/cat/indices.rb +3 -1
  7. data/lib/elasticsearch/api/actions/cat/nodes.rb +1 -1
  8. data/lib/elasticsearch/api/actions/cat/tasks.rb +3 -4
  9. data/lib/elasticsearch/api/actions/close_point_in_time.rb +2 -0
  10. data/lib/elasticsearch/api/actions/cluster/allocation_explain.rb +5 -0
  11. data/lib/elasticsearch/api/actions/cluster/get_component_template.rb +2 -3
  12. data/lib/elasticsearch/api/actions/cluster/health.rb +25 -12
  13. data/lib/elasticsearch/api/actions/cluster/put_settings.rb +3 -3
  14. data/lib/elasticsearch/api/actions/cluster/state.rb +7 -6
  15. data/lib/elasticsearch/api/actions/connector/check_in.rb +3 -4
  16. data/lib/elasticsearch/api/actions/connector/sync_job_check_in.rb +3 -4
  17. data/lib/elasticsearch/api/actions/connector/sync_job_claim.rb +3 -5
  18. data/lib/elasticsearch/api/actions/connector/sync_job_error.rb +3 -5
  19. data/lib/elasticsearch/api/actions/connector/sync_job_update_stats.rb +3 -5
  20. data/lib/elasticsearch/api/actions/connector/update_active_filtering.rb +3 -4
  21. data/lib/elasticsearch/api/actions/connector/update_error.rb +3 -4
  22. data/lib/elasticsearch/api/actions/connector/update_features.rb +3 -4
  23. data/lib/elasticsearch/api/actions/connector/update_filtering_validation.rb +3 -4
  24. data/lib/elasticsearch/api/actions/connector/update_status.rb +3 -4
  25. data/lib/elasticsearch/api/actions/count.rb +10 -2
  26. data/lib/elasticsearch/api/actions/cross_cluster_replication/forget_follower.rb +1 -1
  27. data/lib/elasticsearch/api/actions/cross_cluster_replication/resume_follow.rb +1 -1
  28. data/lib/elasticsearch/api/actions/dangling_indices/delete_dangling_index.rb +3 -3
  29. data/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb +3 -3
  30. data/lib/elasticsearch/api/actions/delete_by_query.rb +2 -2
  31. data/lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb +1 -1
  32. data/lib/elasticsearch/api/actions/eql/search.rb +11 -2
  33. data/lib/elasticsearch/api/actions/esql/get_query.rb +3 -4
  34. data/lib/elasticsearch/api/actions/esql/list_queries.rb +3 -4
  35. data/lib/elasticsearch/api/actions/explain.rb +2 -2
  36. data/lib/elasticsearch/api/actions/features/reset_features.rb +3 -4
  37. data/lib/elasticsearch/api/actions/field_caps.rb +8 -0
  38. data/lib/elasticsearch/api/actions/fleet/msearch.rb +3 -4
  39. data/lib/elasticsearch/api/actions/fleet/search.rb +5 -10
  40. data/lib/elasticsearch/api/actions/get.rb +1 -0
  41. data/lib/elasticsearch/api/actions/graph/explore.rb +2 -6
  42. data/lib/elasticsearch/api/actions/index.rb +3 -0
  43. data/lib/elasticsearch/api/actions/index_lifecycle_management/move_to_step.rb +1 -0
  44. data/lib/elasticsearch/api/actions/index_lifecycle_management/put_lifecycle.rb +1 -0
  45. data/lib/elasticsearch/api/actions/indices/analyze.rb +3 -6
  46. data/lib/elasticsearch/api/actions/indices/cancel_migrate_reindex.rb +0 -4
  47. data/lib/elasticsearch/api/actions/indices/create_from.rb +0 -4
  48. data/lib/elasticsearch/api/actions/indices/data_streams_stats.rb +1 -1
  49. data/lib/elasticsearch/api/actions/indices/delete.rb +1 -1
  50. data/lib/elasticsearch/api/actions/indices/delete_data_lifecycle.rb +5 -4
  51. data/lib/elasticsearch/api/actions/indices/delete_data_stream_options.rb +5 -4
  52. data/lib/elasticsearch/api/actions/indices/disk_usage.rb +4 -4
  53. data/lib/elasticsearch/api/actions/indices/downsample.rb +3 -4
  54. data/lib/elasticsearch/api/actions/indices/exists_alias.rb +1 -1
  55. data/lib/elasticsearch/api/actions/indices/explain_data_lifecycle.rb +3 -3
  56. data/lib/elasticsearch/api/actions/indices/field_usage_stats.rb +4 -5
  57. data/lib/elasticsearch/api/actions/indices/forcemerge.rb +5 -4
  58. data/lib/elasticsearch/api/actions/indices/get_alias.rb +1 -1
  59. data/lib/elasticsearch/api/actions/indices/get_data_stream_mappings.rb +75 -0
  60. data/lib/elasticsearch/api/actions/indices/get_index_template.rb +1 -1
  61. data/lib/elasticsearch/api/actions/indices/get_migrate_reindex_status.rb +0 -4
  62. data/lib/elasticsearch/api/actions/indices/migrate_reindex.rb +0 -4
  63. data/lib/elasticsearch/api/actions/indices/open.rb +1 -1
  64. data/lib/elasticsearch/api/actions/indices/promote_data_stream.rb +1 -1
  65. data/lib/elasticsearch/api/actions/indices/put_data_lifecycle.rb +1 -0
  66. data/lib/elasticsearch/api/actions/indices/put_data_stream_mappings.rb +84 -0
  67. data/lib/elasticsearch/api/actions/indices/put_data_stream_options.rb +1 -0
  68. data/lib/elasticsearch/api/actions/indices/put_index_template.rb +1 -1
  69. data/lib/elasticsearch/api/actions/indices/put_mapping.rb +2 -1
  70. data/lib/elasticsearch/api/actions/indices/put_template.rb +1 -1
  71. data/lib/elasticsearch/api/actions/indices/reload_search_analyzers.rb +3 -2
  72. data/lib/elasticsearch/api/actions/indices/resolve_index.rb +9 -0
  73. data/lib/elasticsearch/api/actions/indices/rollover.rb +1 -1
  74. data/lib/elasticsearch/api/actions/indices/shrink.rb +2 -0
  75. data/lib/elasticsearch/api/actions/indices/split.rb +1 -0
  76. data/lib/elasticsearch/api/actions/indices/stats.rb +2 -2
  77. data/lib/elasticsearch/api/actions/indices/validate_query.rb +1 -1
  78. data/lib/elasticsearch/api/actions/inference/chat_completion_unified.rb +3 -3
  79. data/lib/elasticsearch/api/actions/inference/completion.rb +6 -1
  80. data/lib/elasticsearch/api/actions/inference/delete.rb +3 -2
  81. data/lib/elasticsearch/api/actions/inference/get.rb +7 -3
  82. data/lib/elasticsearch/api/actions/inference/inference.rb +1 -0
  83. data/lib/elasticsearch/api/actions/inference/put.rb +3 -2
  84. data/lib/elasticsearch/api/actions/inference/put_ai21.rb +79 -0
  85. data/lib/elasticsearch/api/actions/inference/put_alibabacloud.rb +1 -1
  86. data/lib/elasticsearch/api/actions/inference/put_amazonbedrock.rb +1 -1
  87. data/lib/elasticsearch/api/actions/inference/put_amazonsagemaker.rb +1 -1
  88. data/lib/elasticsearch/api/actions/inference/put_anthropic.rb +1 -1
  89. data/lib/elasticsearch/api/actions/inference/put_azureaistudio.rb +1 -1
  90. data/lib/elasticsearch/api/actions/inference/put_azureopenai.rb +1 -1
  91. data/lib/elasticsearch/api/actions/inference/put_cohere.rb +1 -1
  92. data/lib/elasticsearch/api/actions/inference/put_contextualai.rb +83 -0
  93. data/lib/elasticsearch/api/actions/inference/put_custom.rb +1 -1
  94. data/lib/elasticsearch/api/actions/inference/put_deepseek.rb +1 -1
  95. data/lib/elasticsearch/api/actions/inference/put_elasticsearch.rb +1 -1
  96. data/lib/elasticsearch/api/actions/inference/put_elser.rb +1 -0
  97. data/lib/elasticsearch/api/actions/inference/put_googleaistudio.rb +1 -1
  98. data/lib/elasticsearch/api/actions/inference/put_googlevertexai.rb +1 -1
  99. data/lib/elasticsearch/api/actions/inference/put_hugging_face.rb +1 -1
  100. data/lib/elasticsearch/api/actions/inference/put_jinaai.rb +1 -1
  101. data/lib/elasticsearch/api/actions/inference/put_llama.rb +79 -0
  102. data/lib/elasticsearch/api/actions/inference/put_mistral.rb +1 -1
  103. data/lib/elasticsearch/api/actions/inference/put_openai.rb +1 -1
  104. data/lib/elasticsearch/api/actions/inference/put_voyageai.rb +1 -1
  105. data/lib/elasticsearch/api/actions/inference/put_watsonx.rb +1 -1
  106. data/lib/elasticsearch/api/actions/inference/rerank.rb +2 -1
  107. data/lib/elasticsearch/api/actions/inference/sparse_embedding.rb +2 -1
  108. data/lib/elasticsearch/api/actions/inference/stream_completion.rb +2 -1
  109. data/lib/elasticsearch/api/actions/inference/text_embedding.rb +2 -1
  110. data/lib/elasticsearch/api/actions/ingest/get_pipeline.rb +1 -1
  111. data/lib/elasticsearch/api/actions/license/get.rb +3 -1
  112. data/lib/elasticsearch/api/actions/license/post_start_basic.rb +1 -1
  113. data/lib/elasticsearch/api/actions/license/post_start_trial.rb +2 -2
  114. data/lib/elasticsearch/api/actions/machine_learning/get_overall_buckets.rb +1 -1
  115. data/lib/elasticsearch/api/actions/machine_learning/start_data_frame_analytics.rb +2 -1
  116. data/lib/elasticsearch/api/actions/machine_learning/start_trained_model_deployment.rb +1 -1
  117. data/lib/elasticsearch/api/actions/machine_learning/stop_data_frame_analytics.rb +2 -1
  118. data/lib/elasticsearch/api/actions/machine_learning/stop_trained_model_deployment.rb +2 -1
  119. data/lib/elasticsearch/api/actions/migration/deprecations.rb +6 -3
  120. data/lib/elasticsearch/api/actions/msearch.rb +8 -1
  121. data/lib/elasticsearch/api/actions/msearch_template.rb +8 -0
  122. data/lib/elasticsearch/api/actions/nodes/clear_repositories_metering_archive.rb +3 -5
  123. data/lib/elasticsearch/api/actions/nodes/get_repositories_metering_info.rb +3 -4
  124. data/lib/elasticsearch/api/actions/nodes/hot_threads.rb +1 -1
  125. data/lib/elasticsearch/api/actions/nodes/stats.rb +1 -1
  126. data/lib/elasticsearch/api/actions/nodes/usage.rb +2 -1
  127. data/lib/elasticsearch/api/actions/open_point_in_time.rb +8 -0
  128. data/lib/elasticsearch/api/actions/project/tags.rb +68 -0
  129. data/lib/elasticsearch/api/actions/rank_eval.rb +1 -1
  130. data/lib/elasticsearch/api/actions/reindex_rethrottle.rb +1 -1
  131. data/lib/elasticsearch/api/actions/render_search_template.rb +3 -6
  132. data/lib/elasticsearch/api/actions/scripts_painless_execute.rb +6 -10
  133. data/lib/elasticsearch/api/actions/search.rb +11 -2
  134. data/lib/elasticsearch/api/actions/search_application/delete_behavioral_analytics.rb +3 -4
  135. data/lib/elasticsearch/api/actions/search_application/get_behavioral_analytics.rb +3 -4
  136. data/lib/elasticsearch/api/actions/search_application/post_behavioral_analytics_event.rb +3 -4
  137. data/lib/elasticsearch/api/actions/search_application/put_behavioral_analytics.rb +3 -4
  138. data/lib/elasticsearch/api/actions/search_application/render_query.rb +3 -4
  139. data/lib/elasticsearch/api/actions/search_mvt.rb +20 -5
  140. data/lib/elasticsearch/api/actions/search_template.rb +10 -2
  141. data/lib/elasticsearch/api/actions/searchable_snapshots/cache_stats.rb +3 -5
  142. data/lib/elasticsearch/api/actions/searchable_snapshots/clear_cache.rb +6 -6
  143. data/lib/elasticsearch/api/actions/security/create_service_token.rb +1 -1
  144. data/lib/elasticsearch/api/actions/security/delete_service_token.rb +1 -1
  145. data/lib/elasticsearch/api/actions/security/get_stats.rb +62 -0
  146. data/lib/elasticsearch/api/actions/simulate/ingest.rb +7 -4
  147. data/lib/elasticsearch/api/actions/snapshot/get.rb +1 -1
  148. data/lib/elasticsearch/api/actions/snapshot/repository_analyze.rb +17 -10
  149. data/lib/elasticsearch/api/actions/snapshot/repository_verify_integrity.rb +3 -4
  150. data/lib/elasticsearch/api/actions/snapshot/status.rb +5 -0
  151. data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_lifecycle.rb +1 -1
  152. data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/put_lifecycle.rb +1 -0
  153. data/lib/elasticsearch/api/actions/sql/query.rb +8 -0
  154. data/lib/elasticsearch/api/actions/streams/logs_disable.rb +6 -4
  155. data/lib/elasticsearch/api/actions/streams/logs_enable.rb +6 -4
  156. data/lib/elasticsearch/api/actions/streams/status.rb +7 -5
  157. data/lib/elasticsearch/api/actions/synonyms/put_synonym.rb +0 -1
  158. data/lib/elasticsearch/api/actions/tasks/cancel.rb +3 -4
  159. data/lib/elasticsearch/api/actions/tasks/get.rb +3 -4
  160. data/lib/elasticsearch/api/actions/tasks/list.rb +3 -4
  161. data/lib/elasticsearch/api/actions/terms_enum.rb +2 -6
  162. data/lib/elasticsearch/api/actions/transform/get_node_stats.rb +15 -3
  163. data/lib/elasticsearch/api/actions/transform/get_transform_stats.rb +1 -1
  164. data/lib/elasticsearch/api/actions/update_by_query.rb +4 -4
  165. data/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb +1 -1
  166. data/lib/elasticsearch/api/actions/watcher/put_watch.rb +2 -2
  167. data/lib/elasticsearch/api/actions/xpack/info.rb +1 -1
  168. data/lib/elasticsearch/api/version.rb +2 -2
  169. data/lib/elasticsearch/api.rb +2 -0
  170. metadata +9 -2
@@ -26,8 +26,9 @@ module Elasticsearch
26
26
  # Returns search results for an Event Query Language (EQL) query.
27
27
  # EQL assumes each document in a data stream or index corresponds to an event.
28
28
  #
29
- # @option arguments [String, Array] :index The name of the index to scope the operation (*Required*)
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) Server default: true.
29
+ # @option arguments [String, Array] :index Comma-separated list of index names to scope the operation (*Required*)
30
+ # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices.
31
+ # (This includes `_all` string or when no indices have been specified) Server default: true.
31
32
  # @option arguments [Boolean] :allow_partial_search_results If true, returns partial results if there are shard failures. If false, returns an error with no partial results. Server default: true.
32
33
  # @option arguments [Boolean] :allow_partial_sequence_results If true, sequence queries will return partial results in case of shard failures. If false, they will return no results at all.
33
34
  # This flag has effect only if allow_partial_search_results is true.
@@ -36,6 +37,14 @@ module Elasticsearch
36
37
  # @option arguments [Boolean] :ignore_unavailable If true, missing or closed indices are not included in the response. Server default: true.
37
38
  # @option arguments [Time] :keep_alive Period for which the search and its results are stored on the cluster. Server default: 5d.
38
39
  # @option arguments [Boolean] :keep_on_completion If true, the search and its results are stored on the cluster.
40
+ # @option arguments [String] :project_routing Specifies a subset of projects to target for the search using project
41
+ # metadata tags in a subset of Lucene query syntax.
42
+ # Allowed Lucene queries: the _alias tag and a single value (possibly wildcarded).
43
+ # Examples:
44
+ # _alias:my-project
45
+ # _alias:_origin
46
+ # _alias:*pr*
47
+ # Supported in serverless only.
39
48
  # @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
49
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
41
50
  # when they occur.
@@ -24,10 +24,9 @@ module Elasticsearch
24
24
  module Actions
25
25
  # Get a specific running ES|QL query information.
26
26
  # Returns an object extended information about a running ES|QL query.
27
- # This functionality is Experimental and may be changed or removed
28
- # completely in a future release. Elastic will take a best effort approach
29
- # to fix any issues, but experimental features are not subject to the
30
- # support SLA of official GA features.
27
+ # This functionality is in technical preview and may be changed or removed in a future
28
+ # release. Elastic will apply best effort to fix any issues, but features in technical
29
+ # preview are not subject to the support SLA of official GA features.
31
30
  #
32
31
  # @option arguments [String] :id The query ID (*Required*)
33
32
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
@@ -24,10 +24,9 @@ module Elasticsearch
24
24
  module Actions
25
25
  # Get running ES|QL queries information.
26
26
  # Returns an object containing IDs and other information about the running ES|QL queries.
27
- # This functionality is Experimental and may be changed or removed
28
- # completely in a future release. Elastic will take a best effort approach
29
- # to fix any issues, but experimental features are not subject to the
30
- # support SLA of official GA features.
27
+ # This functionality is in technical preview and may be changed or removed in a future
28
+ # release. Elastic will apply best effort to fix any issues, but features in technical
29
+ # preview are not subject to the support SLA of official GA features.
31
30
  #
32
31
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
33
32
  # when they occur.
@@ -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.
@@ -33,10 +33,9 @@ module Elasticsearch
33
33
  # Using this API resets all features, both those that are built-in and implemented as plugins.
34
34
  # To list the features that will be affected, use the get features API.
35
35
  # IMPORTANT: The features installed on the node you submit this request to are the features that will be reset. Run on the master node if you have any doubts about which plugins are installed on individual nodes.
36
- # This functionality is Experimental and may be changed or removed
37
- # completely in a future release. Elastic will take a best effort approach
38
- # to fix any issues, but experimental features are not subject to the
39
- # support SLA of official GA features.
36
+ # This functionality is in technical preview and may be changed or removed in a future
37
+ # release. Elastic will apply best effort to fix any issues, but features in technical
38
+ # preview are not subject to the support SLA of official GA features.
40
39
  #
41
40
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
42
41
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
@@ -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
@@ -26,10 +26,9 @@ module Elasticsearch
26
26
  # Run several Fleet searches with a single API request.
27
27
  # The API follows the same structure as the multi search API.
28
28
  # However, similar to the Fleet search API, it supports the `wait_for_checkpoints` parameter.
29
- # This functionality is Experimental and may be changed or removed
30
- # completely in a future release. Elastic will take a best effort approach
31
- # to fix any issues, but experimental features are not subject to the
32
- # support SLA of official GA features.
29
+ # This functionality is in technical preview and may be changed or removed in a future
30
+ # release. Elastic will apply best effort to fix any issues, but features in technical
31
+ # preview are not subject to the support SLA of official GA features.
33
32
  #
34
33
  # @option arguments [String] :index A single target to search. If the target is an index alias, it must resolve to a single index.
35
34
  # @option arguments [Boolean] :allow_no_indices If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.
@@ -25,10 +25,9 @@ module Elasticsearch
25
25
  # Run a Fleet search.
26
26
  # The purpose of the Fleet search API is to provide an API where the search will be run only
27
27
  # after the provided checkpoint has been processed and is visible for searches inside of Elasticsearch.
28
- # This functionality is Experimental and may be changed or removed
29
- # completely in a future release. Elastic will take a best effort approach
30
- # to fix any issues, but experimental features are not subject to the
31
- # support SLA of official GA features.
28
+ # This functionality is in technical preview and may be changed or removed in a future
29
+ # release. Elastic will apply best effort to fix any issues, but features in technical
30
+ # preview are not subject to the support SLA of official GA features.
32
31
  #
33
32
  # @option arguments [String] :index A single target to search. If the target is an index alias, it must resolve to a single index. (*Required*)
34
33
  # @option arguments [Boolean] :allow_no_indices [TODO]
@@ -102,6 +101,7 @@ module Elasticsearch
102
101
  end
103
102
  request_opts[:defined_params] = defined_params unless defined_params.empty?
104
103
 
104
+ raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
105
105
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
106
106
 
107
107
  arguments = arguments.clone
@@ -111,12 +111,7 @@ module Elasticsearch
111
111
 
112
112
  _index = arguments.delete(:index)
113
113
 
114
- method = if body
115
- Elasticsearch::API::HTTP_POST
116
- else
117
- Elasticsearch::API::HTTP_GET
118
- end
119
-
114
+ method = Elasticsearch::API::HTTP_POST
120
115
  path = "#{Utils.listify(_index)}/_fleet/_fleet_search"
121
116
  params = Utils.process_params(arguments)
122
117
 
@@ -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.
@@ -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
 
@@ -93,6 +93,7 @@ module Elasticsearch
93
93
  # When using the external version type, the system checks to see if the version number passed to the index request is greater than the version of the currently stored document.
94
94
  # If true, the document will be indexed and the new version number used.
95
95
  # If the value provided is less than or equal to the stored document's version number, a version conflict will occur and the index operation will fail. For example:
96
+ #
96
97
  # ```
97
98
  # PUT my-index-000001/_doc/1?version=2&version_type=external
98
99
  # {
@@ -100,6 +101,8 @@ module Elasticsearch
100
101
  # "id": "elkbee"
101
102
  # }
102
103
  # }
104
+ # ```
105
+ #
103
106
  # In this example, the operation will succeed since the supplied version of 2 is higher than the current document version of 1.
104
107
  # If the document was already updated and its version was set to 2 or higher, the indexing command will fail and result in a conflict (409 HTTP status code).
105
108
  # A nice side effect is that there is no need to maintain strict ordering of async indexing operations run as a result of changes to a source database, as long as version numbers from the source database are used.
@@ -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
@@ -24,10 +24,6 @@ module Elasticsearch
24
24
  module Actions
25
25
  # Cancel a migration reindex operation.
26
26
  # Cancel a migration reindex attempt for a data stream or index.
27
- # This functionality is Experimental and may be changed or removed
28
- # completely in a future release. Elastic will take a best effort approach
29
- # to fix any issues, but experimental features are not subject to the
30
- # support SLA of official GA features.
31
27
  #
32
28
  # @option arguments [String, Array] :index The index or data stream name (*Required*)
33
29
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
@@ -24,10 +24,6 @@ module Elasticsearch
24
24
  module Actions
25
25
  # Create an index from a source index.
26
26
  # Copy the mappings and settings from the source index to a destination index while allowing request settings and mappings to override the source values.
27
- # This functionality is Experimental and may be changed or removed
28
- # completely in a future release. Elastic will take a best effort approach
29
- # to fix any issues, but experimental features are not subject to the
30
- # support SLA of official GA features.
31
27
  #
32
28
  # @option arguments [String] :source The source index or data stream name (*Required*)
33
29
  # @option arguments [String] :dest The destination index or data stream name (*Required*)
@@ -29,7 +29,7 @@ module Elasticsearch
29
29
  # Wildcard expressions (`*`) are supported.
30
30
  # To target all data streams in a cluster, omit this parameter or use `*`.
31
31
  # @option arguments [String, Array<String>] :expand_wildcards Type of data stream that wildcard patterns can match.
32
- # Supports comma-separated values, such as `open,hidden`. Server default: open.
32
+ # Supports comma-separated values, such as `open,hidden`. Server default: open,closed.
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.
35
35
  # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
@@ -37,7 +37,7 @@ module Elasticsearch
37
37
  # This behavior applies even if the request targets other open indices. Server default: true.
38
38
  # @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match.
39
39
  # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
40
- # Supports comma-separated values, such as `open,hidden`. Server default: open.
40
+ # Supports comma-separated values, such as `open,hidden`. Server default: open,closed.
41
41
  # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index.
42
42
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node.
43
43
  # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
@@ -25,10 +25,11 @@ module Elasticsearch
25
25
  # Delete data stream lifecycles.
26
26
  # Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle.
27
27
  #
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
- # @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 Server default: 30s.
31
- # @option arguments [Time] :timeout Explicit timestamp for the document
28
+ # @option arguments [String, Array<String>] :name A comma-separated list of data streams of which the data stream lifecycle will be deleted.
29
+ # Use `*` to get all data streams (*Required*)
30
+ # @option arguments [String, Array<String>] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) Server default: open.
31
+ # @option arguments [Time] :master_timeout The period to wait for a connection to the master node. Server default: 30s.
32
+ # @option arguments [Time] :timeout The period to wait for a response. Server default: 30s.
32
33
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
33
34
  # when they occur.
34
35
  # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
@@ -25,10 +25,11 @@ module Elasticsearch
25
25
  # Delete data stream options.
26
26
  # Removes the data stream options from a data stream.
27
27
  #
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
- # @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 Server default: 30s.
31
- # @option arguments [Time] :timeout Explicit timestamp for the document
28
+ # @option arguments [String, Array<String>] :name A comma-separated list of data streams of which the data stream options will be deleted.
29
+ # Use `*` to get all data streams (*Required*)
30
+ # @option arguments [String, Array<String>] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices Server default: open.
31
+ # @option arguments [Time] :master_timeout The period to wait for a connection to the master node. Server default: 30s.
32
+ # @option arguments [Time] :timeout The period to wait for a response. Server default: 30s.
32
33
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
33
34
  # when they occur.
34
35
  # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
@@ -29,10 +29,10 @@ 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
- # This functionality is Experimental and may be changed or removed
33
- # completely in a future release. Elastic will take a best effort approach
34
- # to fix any issues, but experimental features are not subject to the
35
- # support SLA of official GA features.
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.
33
+ # This functionality is in technical preview and may be changed or removed in a future
34
+ # release. Elastic will apply best effort to fix any issues, but features in technical
35
+ # preview are not subject to the support SLA of official GA features.
36
36
  #
37
37
  # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases used to limit the request.
38
38
  # It’s recommended to execute this API with a single index (or the latest backing index of a data stream) as the API consumes resources significantly. (*Required*)
@@ -29,10 +29,9 @@ module Elasticsearch
29
29
  # NOTE: Only indices in a time series data stream are supported.
30
30
  # Neither field nor document level security can be defined on the source index.
31
31
  # The source index must be read only (`index.blocks.write: true`).
32
- # This functionality is Experimental and may be changed or removed
33
- # completely in a future release. Elastic will take a best effort approach
34
- # to fix any issues, but experimental features are not subject to the
35
- # support SLA of official GA features.
32
+ # This functionality is in technical preview and may be changed or removed in a future
33
+ # release. Elastic will apply best effort to fix any issues, but features in technical
34
+ # preview are not subject to the support SLA of official GA features.
36
35
  #
37
36
  # @option arguments [String] :index Name of the time series index to downsample. (*Required*)
38
37
  # @option arguments [String] :target_index Name of the index to create. (*Required*)
@@ -32,7 +32,7 @@ module Elasticsearch
32
32
  # This behavior applies even if the request targets other open indices. Server default: true.
33
33
  # @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match.
34
34
  # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
35
- # Supports comma-separated values, such as `open,hidden`. Server default: open.
35
+ # Supports comma-separated values, such as `open,hidden`. Server default: all.
36
36
  # @option arguments [Boolean] :ignore_unavailable If `false`, requests that include a missing data stream or index in the target indices or data streams return an error.
37
37
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node.
38
38
  # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
@@ -25,9 +25,9 @@ module Elasticsearch
25
25
  # Get the status for a data stream lifecycle.
26
26
  # Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution.
27
27
  #
28
- # @option arguments [String, Array] :index The name of the index to explain (*Required*)
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 Server default: 30s.
28
+ # @option arguments [String, Array] :index Comma-separated list of index names to explain (*Required*)
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 The period to wait for a connection to the master node. 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
@@ -28,10 +28,9 @@ module Elasticsearch
28
28
  # A shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use.
29
29
  # The response body reports the per-shard usage count of the data structures that back the fields in the index.
30
30
  # A given request will increment each count by a maximum value of 1, even if the request accesses the same field multiple times.
31
- # This functionality is Experimental and may be changed or removed
32
- # completely in a future release. Elastic will take a best effort approach
33
- # to fix any issues, but experimental features are not subject to the
34
- # support SLA of official GA features.
31
+ # This functionality is in technical preview and may be changed or removed in a future
32
+ # release. Elastic will apply best effort to fix any issues, but features in technical
33
+ # preview are not subject to the support SLA of official GA features.
35
34
  #
36
35
  # @option arguments [String, Array] :index Comma-separated list or wildcard expression of index names used to limit the request. (*Required*)
37
36
  # @option arguments [Boolean] :allow_no_indices If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
@@ -39,7 +38,7 @@ module Elasticsearch
39
38
  # For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`.
40
39
  # @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match.
41
40
  # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
42
- # Supports comma-separated values, such as `open,hidden`.
41
+ # Supports comma-separated values, such as `open,hidden`. Server default: open.
43
42
  # @option arguments [Boolean] :ignore_unavailable If `true`, missing or closed indices are not included in the response.
44
43
  # @option arguments [String, Array<String>] :fields Comma-separated list or wildcard expressions of fields to include in the statistics.
45
44
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
@@ -64,13 +64,14 @@ module Elasticsearch
64
64
  # ```
65
65
  #
66
66
  # @option arguments [String, Array] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
67
- # @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)
68
- # @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
69
- # @option arguments [Boolean] :flush Specify whether the index should be flushed after performing the operation (default: true)
67
+ # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices.
68
+ # (This includes `_all` string or when no indices have been specified)
69
+ # @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. Server default: open.
70
+ # @option arguments [Boolean] :flush Specify whether the index should be flushed after performing the operation Server default: true.
70
71
  # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
71
72
  # @option arguments [Integer] :max_num_segments The number of segments the index should be merged into (default: dynamic)
72
73
  # @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. Server default: true.
74
+ # @option arguments [Boolean] :wait_for_completion Should the request wait until the force merge is completed Server default: true.
74
75
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
75
76
  # when they occur.
76
77
  # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
@@ -35,7 +35,7 @@ module Elasticsearch
35
35
  # This behavior applies even if the request targets other open indices. Server default: true.
36
36
  # @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match.
37
37
  # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
38
- # Supports comma-separated values, such as `open,hidden`. Server default: open.
38
+ # Supports comma-separated values, such as `open,hidden`. Server default: all.
39
39
  # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index.
40
40
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node.
41
41
  # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
@@ -0,0 +1,75 @@
1
+ # Licensed to Elasticsearch B.V. under one or more contributor
2
+ # license agreements. See the NOTICE file distributed with
3
+ # this work for additional information regarding copyright
4
+ # ownership. Elasticsearch B.V. licenses this file to you under
5
+ # the Apache License, Version 2.0 (the "License"); you may
6
+ # not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing,
12
+ # software distributed under the License is distributed on an
13
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
+ # KIND, either express or implied. See the License for the
15
+ # specific language governing permissions and limitations
16
+ # under the License.
17
+ #
18
+ # This code was automatically generated from the Elasticsearch Specification
19
+ # See https://github.com/elastic/elasticsearch-specification
20
+ # See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
21
+ module Elasticsearch
22
+ module API
23
+ module Indices
24
+ module Actions
25
+ # Get data stream mappings.
26
+ # Get mapping information for one or more data streams.
27
+ #
28
+ # @option arguments [String, Array] :name A comma-separated list of data streams or data stream patterns. Supports wildcards (`*`). (*Required*)
29
+ # @option arguments [Time] :master_timeout The period to wait for a connection to the master node. If no response is
30
+ # received before the timeout expires, the request fails and returns an
31
+ # error. Server default: 30s.
32
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
33
+ # when they occur.
34
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
35
+ # returned by Elasticsearch.
36
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
37
+ # For example `"exists_time": "1h"` for humans and
38
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
39
+ # readable values will be omitted. This makes sense for responses being consumed
40
+ # only by machines.
41
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
42
+ # this option for debugging only.
43
+ # @option arguments [Hash] :headers Custom HTTP headers
44
+ #
45
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-stream-mappings
46
+ #
47
+ def get_data_stream_mappings(arguments = {})
48
+ request_opts = { endpoint: arguments[:endpoint] || 'indices.get_data_stream_mappings' }
49
+
50
+ defined_params = [:name].each_with_object({}) do |variable, set_variables|
51
+ set_variables[variable] = arguments[variable] if arguments.key?(variable)
52
+ end
53
+ request_opts[:defined_params] = defined_params unless defined_params.empty?
54
+
55
+ raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
56
+
57
+ arguments = arguments.clone
58
+ headers = arguments.delete(:headers) || {}
59
+
60
+ body = nil
61
+
62
+ _name = arguments.delete(:name)
63
+
64
+ method = Elasticsearch::API::HTTP_GET
65
+ path = "_data_stream/#{Utils.listify(_name)}/_mappings"
66
+ params = Utils.process_params(arguments)
67
+
68
+ Elasticsearch::API::Response.new(
69
+ perform_request(method, path, params, body, headers, request_opts)
70
+ )
71
+ end
72
+ end
73
+ end
74
+ end
75
+ end
@@ -25,7 +25,7 @@ module Elasticsearch
25
25
  # Get index templates.
26
26
  # Get information about one or more index templates.
27
27
  #
28
- # @option arguments [String] :name Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported.
28
+ # @option arguments [String] :name Name of index template to retrieve. Wildcard (*) expressions are supported.
29
29
  # @option arguments [Boolean] :local If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.
30
30
  # @option arguments [Boolean] :flat_settings If true, returns settings in flat format.
31
31
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
@@ -24,10 +24,6 @@ module Elasticsearch
24
24
  module Actions
25
25
  # Get the migration reindexing status.
26
26
  # Get the status of a migration reindex attempt for a data stream or index.
27
- # This functionality is Experimental and may be changed or removed
28
- # completely in a future release. Elastic will take a best effort approach
29
- # to fix any issues, but experimental features are not subject to the
30
- # support SLA of official GA features.
31
27
  #
32
28
  # @option arguments [String, Array] :index The index or data stream name. (*Required*)
33
29
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
@@ -26,10 +26,6 @@ module Elasticsearch
26
26
  # Reindex all legacy backing indices for a data stream.
27
27
  # This operation occurs in a persistent task.
28
28
  # The persistent task ID is returned immediately and the reindexing work is completed in that task.
29
- # This functionality is Experimental and may be changed or removed
30
- # completely in a future release. Elastic will take a best effort approach
31
- # to fix any issues, but experimental features are not subject to the
32
- # support SLA of official GA features.
33
29
  #
34
30
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
35
31
  # when they occur.
@@ -49,7 +49,7 @@ module Elasticsearch
49
49
  # This behavior applies even if the request targets other open indices. Server default: true.
50
50
  # @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match.
51
51
  # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
52
- # Supports comma-separated values, such as `open,hidden`. Server default: open.
52
+ # Supports comma-separated values, such as `open,hidden`. Server default: closed.
53
53
  # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index.
54
54
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node.
55
55
  # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
@@ -32,7 +32,7 @@ module Elasticsearch
32
32
  # If this is missing, the data stream will not be able to roll over until a matching index template is created.
33
33
  # This will affect the lifecycle management of the data stream and interfere with the data stream size and retention.
34
34
  #
35
- # @option arguments [String] :name The name of the data stream (*Required*)
35
+ # @option arguments [String] :name The name of the data stream to promote (*Required*)
36
36
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
37
37
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
38
38
  # when they occur.
@@ -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 'name' missing" unless arguments[:name]
63
64
 
64
65
  arguments = arguments.clone