Package co.elastic.clients.elasticsearch.indices

Class PutDataStreamOptionsRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.indices.PutDataStreamOptionsRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class PutDataStreamOptionsRequest
extends RequestBase
implements JsonpSerializable

Update data stream options. Update the data stream options of the specified data streams.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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 JsonpDeserializer<PutDataStreamOptionsRequest>	_DESERIALIZER	Json deserializer for PutDataStreamOptionsRequest
static final Endpoint<PutDataStreamOptionsRequest,PutDataStreamOptionsResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.put_data_stream_options".

Method Summary

Modifier and Type	Method	Description
final List<ExpandWildcard>	expandWildcards()	Type of data stream that wildcard patterns can match.
final DataStreamFailureStore	failureStore()	If defined, it will update the failure store configuration of every data stream resolved by the name expression.
final Time	masterTimeout()	Period to wait for a connection to the master node.
final List<String>	name()	Required - Comma-separated list of data streams used to limit the request.
static PutDataStreamOptionsRequest	of(Function<PutDataStreamOptionsRequest.Builder,ObjectBuilder<PutDataStreamOptionsRequest>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupPutDataStreamOptionsRequestDeserializer(ObjectDeserializer<PutDataStreamOptionsRequest.Builder> op)
final Time	timeout()	Period to wait for a response.

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

_DESERIALIZER

public static final JsonpDeserializer<PutDataStreamOptionsRequest> _DESERIALIZER

Json deserializer for PutDataStreamOptionsRequest

_ENDPOINT

public static final Endpoint<PutDataStreamOptionsRequest,PutDataStreamOptionsResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.put_data_stream_options".

Method Details

of

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

failureStore

@Nullable
public final DataStreamFailureStore failureStore()

If defined, it will update the failure store configuration of every data stream resolved by the name expression.

API name: failure_store

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 used to limit the request. Supports wildcards (*). To target all data streams use * or _all.

API name: name

timeout

@Nullable
public final Time timeout()

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

API name: timeout

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

setupPutDataStreamOptionsRequestDeserializer

protected static void setupPutDataStreamOptionsRequestDeserializer(ObjectDeserializer<PutDataStreamOptionsRequest.Builder> op)