Package co.elastic.clients.elasticsearch.indices

Class GetDataStreamOptionsRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.indices.GetDataStreamOptionsRequest

public class GetDataStreamOptionsRequest
extends RequestBase

Get data stream options.

Get the data stream options configuration of one or more data streams.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<GetDataStreamOptionsRequest,GetDataStreamOptionsResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.get_data_stream_options".

Method Summary

Modifier and Type	Method	Description
final List<ExpandWildcard>	expandWildcards()	Type of data stream that wildcard patterns can match.
final Time	masterTimeout()	Period to wait for a connection to the master node.
final List<String>	name()	Required - Comma-separated list of data streams to limit the request.
static GetDataStreamOptionsRequest	of(Function<GetDataStreamOptionsRequest.Builder,ObjectBuilder<GetDataStreamOptionsRequest>> fn)

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<GetDataStreamOptionsRequest,GetDataStreamOptionsResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.get_data_stream_options".

Method Details

of

public static GetDataStreamOptionsRequest of(Function<GetDataStreamOptionsRequest.Builder,ObjectBuilder<GetDataStreamOptionsRequest>> 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

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()

Required - Comma-separated list of data streams to limit the request. Supports wildcards (*). To target all data streams, omit this parameter or use * or _all.

API name: name