Package co.elastic.clients.elasticsearch.indices

Class GetDataStreamRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.indices.GetDataStreamRequest

public class GetDataStreamRequest
extends RequestBase

Get data streams.

Get information about one or more data streams.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetDataStreamRequest.Builder	Builder for GetDataStreamRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<GetDataStreamRequest,GetDataStreamResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.get_data_stream".

Method Summary

Modifier and Type	Method	Description
final List<ExpandWildcard>	expandWildcards()	Type of data stream that wildcard patterns can match.
final Boolean	includeDefaults()	If true, returns all relevant default configurations for the index template.
final Time	masterTimeout()	Period to wait for a connection to the master node.
final List<String>	name()	Comma-separated list of data stream names used to limit the request.
static GetDataStreamRequest	of(Function<GetDataStreamRequest.Builder,ObjectBuilder<GetDataStreamRequest>> fn)
final Boolean	verbose()	Whether the maximum timestamp for each data stream should be calculated and returned.

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_ENDPOINT

public static final Endpoint<GetDataStreamRequest,GetDataStreamResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.get_data_stream".

Method Details

of

public static GetDataStreamRequest of(Function<GetDataStreamRequest.Builder,ObjectBuilder<GetDataStreamRequest>> fn)

expandWildcards

public final List<ExpandWildcard> expandWildcards()

Type of data stream that wildcard patterns can match. Supports comma-separated values, such as open,hidden.

API name: expand_wildcards

includeDefaults

@Nullable
public final Boolean includeDefaults()

If true, returns all relevant default configurations for the index template.

API name: include_defaults

masterTimeout

@Nullable
public final Time masterTimeout()

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.

API name: master_timeout

name

public final List<String> name()

Comma-separated list of data stream names used to limit the request. Wildcard (*) expressions are supported. If omitted, all data streams are returned.

API name: name

verbose

@Nullable
public final Boolean verbose()

Whether the maximum timestamp for each data stream should be calculated and returned.

API name: verbose