@@ -24,15 +24,17 @@ import { Duration } from '@_types/Time'
24
24
25
25
/**
26
26
* Update data stream settings.
27
+ *
27
28
* This API can be used to override settings on specific data streams. These overrides will take precedence over what
28
- * is specified in the template that the data stream matches. To prevent users from getting into an invalid state,
29
- * only certain settings are allowed. If the can reasonably be applied to all backing indices, it is applied to all
30
- * backing indices. Otherwise, it will be applied only whenever the data stream is next rolled over.
29
+ * is specified in the template that the data stream matches. To prevent your data stream from getting into an invalid state,
30
+ * only certain settings are allowed. If possible, the setting change is applied to all
31
+ * backing indices. Otherwise, it will be applied when the data stream is next rolled over.
31
32
* @rest_spec_name indices.put_data_stream_settings
32
33
* @availability stack stability=stable visibility=feature_flag feature_flag=logs_stream
33
34
* @availability serverless stability=stable visibility=feature_flag feature_flag=logs_stream
34
35
* @index_privileges manage
35
36
* @doc_id indices-put-data-stream-settings
37
+ * @doc_tag data stream
36
38
*/
37
39
export interface Request extends RequestBase {
38
40
urls : [
@@ -43,7 +45,7 @@ export interface Request extends RequestBase {
43
45
]
44
46
path_parts : {
45
47
/**
46
- * Comma -separated list of data streams or data stream patterns
48
+ * A comma -separated list of data streams or data stream patterns.
47
49
*/
48
50
name : Indices
49
51
}
@@ -56,14 +58,14 @@ export interface Request extends RequestBase {
56
58
*/
57
59
dry_run ?: boolean
58
60
/**
59
- * Period to wait for a connection to the master node. If no response is
61
+ * The period to wait for a connection to the master node. If no response is
60
62
* received before the timeout expires, the request fails and returns an
61
63
* error.
62
64
* @server_default 30s
63
65
*/
64
66
master_timeout ?: Duration
65
67
/**
66
- * Period to wait for a response. If no response is received before the
68
+ * The period to wait for a response. If no response is received before the
67
69
* timeout expires, the request fails and returns an error.
68
70
* @server_default 30s
69
71
*/
0 commit comments