You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Adds available parameters to experimental stream namespace APIs:
* [Time] :master_timeout The period to wait for a connection to the master node.
* [Time] :timeout The period to wait for a response.
* [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors when they occur.
* [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
* [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
* [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging.
Copy file name to clipboardExpand all lines: elasticsearch-api/lib/elasticsearch/api/actions/streams/status.rb
+20-3Lines changed: 20 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -22,11 +22,28 @@ module Elasticsearch
22
22
moduleAPI
23
23
moduleStreams
24
24
moduleActions
25
-
# Return the current status of the streams feature for each streams type
25
+
# Get the status of streams
26
+
# Gets the current status of all stream types
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.
26
31
#
32
+
# @option arguments [String] :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.
33
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
34
+
# when they occur.
35
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
36
+
# returned by Elasticsearch.
37
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
38
+
# For example `"exists_time": "1h"` for humans and
39
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
40
+
# readable values will be omitted. This makes sense for responses being consumed
41
+
# only by machines.
42
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
0 commit comments