Skip to content

Commit dc07ea5

Browse files
authored
[DOCS] Document get data stream API's _meta prop (#65221) (#65265)
1 parent 7c5997d commit dc07ea5

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

docs/reference/indices/get-data-stream.asciidoc

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,9 @@ PUT /_index_template/my-index-template
4040
"settings": {
4141
"index.lifecycle.name": "my-lifecycle-policy"
4242
}
43+
},
44+
"_meta": {
45+
"my-meta-field": "foo"
4346
}
4447
}
4548
@@ -136,6 +139,12 @@ Universally unique identifier (UUID) for the index.
136139
Current <<data-streams-generation,generation>> for the data stream. This number
137140
acts as a cumulative count of the stream's rollovers, starting at `1`.
138141
142+
`_meta`::
143+
(object)
144+
Custom metadata for the stream, copied from the `_meta` object of the
145+
stream's matching <<create-a-data-stream-template,index template>>. If empty,
146+
the response omits this property.
147+
139148
`status`::
140149
(string)
141150
<<cluster-health,Health status>> of the data stream.
@@ -207,6 +216,9 @@ The API returns the following response:
207216
}
208217
],
209218
"generation": 2,
219+
"_meta": {
220+
"my-meta-field": "foo"
221+
},
210222
"status": "GREEN",
211223
"template": "my-index-template",
212224
"ilm_policy": "my-lifecycle-policy",
@@ -224,6 +236,9 @@ The API returns the following response:
224236
}
225237
],
226238
"generation": 1,
239+
"_meta": {
240+
"my-meta-field": "foo"
241+
},
227242
"status": "YELLOW",
228243
"template": "my-index-template",
229244
"ilm_policy": "my-lifecycle-policy",

0 commit comments

Comments
 (0)