Skip to content

[DOCS] Document get data stream API's _meta prop #65221

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 19, 2020
Merged

[DOCS] Document get data stream API's _meta prop #65221

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c1124fc
[DOCS] Document get data stream API's `_meta` prop
jrodewig Nov 18, 2020
f8d2120
Less confusing meta value
jrodewig Nov 18, 2020
bd1adaf
More accurate wording
jrodewig Nov 18, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions docs/reference/indices/get-data-stream.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,9 @@ PUT /_index_template/my-index-template
"settings": {
"index.lifecycle.name": "my-lifecycle-policy"
}
},
"_meta": {
"my-meta-field": "foo"
}
}

Expand Down Expand Up @@ -136,6 +139,12 @@ Universally unique identifier (UUID) for the index.
Current <<data-streams-generation,generation>> for the data stream. This number
acts as a cumulative count of the stream's rollovers, starting at `1`.

`_meta`::
(object)
Custom metadata for the stream, copied from the `_meta` object of the
stream's matching <<create-a-data-stream-template,index template>>. If empty,
the response omits this property.

`status`::
(string)
<<cluster-health,Health status>> of the data stream.
Expand Down Expand Up @@ -207,6 +216,9 @@ The API returns the following response:
}
],
"generation": 2,
"_meta": {
"my-meta-field": "foo"
},
"status": "GREEN",
"template": "my-index-template",
"ilm_policy": "my-lifecycle-policy",
Expand All @@ -224,6 +236,9 @@ The API returns the following response:
}
],
"generation": 1,
"_meta": {
"my-meta-field": "foo"
},
"status": "YELLOW",
"template": "my-index-template",
"ilm_policy": "my-lifecycle-policy",
Expand Down