Files
elasticsearch-js/docs/reference-indices-get_data_stream.asciidoc
2024-12-05 14:46:46 -06:00

67 lines
4.1 KiB
Plaintext

[[reference-indices-get_data_stream]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
[discrete]
=== client.indices.getDataStream
Get data streams. Retrieves information about one or more data streams.
{ref}/data-streams.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(IndicesGetDataStreamRequest, options?): Promise<IndicesGetDataStreamResponse>
----
[discrete]
===== `IndicesGetDataStreamRequest`
[source,ts]
----
interface IndicesGetDataStreamRequest extends <<shared-type-request-base, RequestBase>> {
name?: <<shared-type-data-stream-names, DataStreamNames>>
expand_wildcards?: <<shared-type-expand-wildcards, ExpandWildcards>>
include_defaults?: boolean
master_timeout?: <<shared-type-duration, Duration>>
verbose?: boolean
}
----
[discrete]
===== `IndicesGetDataStreamResponse`
[source,ts]
----
interface IndicesGetDataStreamResponse {
data_streams: IndicesDataStream[]
}
----