Package co.elastic.clients.elasticsearch.indices

Class PutDataStreamSettingsRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.indices.PutDataStreamSettingsRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class PutDataStreamSettingsRequest
extends RequestBase
implements JsonpSerializable

Update data stream settings.

This API can be used to override settings on specific data streams. These overrides will take precedence over what is specified in the template that the data stream matches. To prevent your data stream from getting into an invalid state, only certain settings are allowed. If possible, the setting change is applied to all backing indices. Otherwise, it will be applied when the data stream is next rolled over.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<PutDataStreamSettingsRequest>	_DESERIALIZER
static final Endpoint<PutDataStreamSettingsRequest,PutDataStreamSettingsResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.put_data_stream_settings".

Method Summary

Modifier and Type	Method	Description
protected static JsonpDeserializer<PutDataStreamSettingsRequest>	createPutDataStreamSettingsRequestDeserializer()
final Boolean	dryRun()	If true, the request does not actually change the settings on any data streams or indices.
final Time	masterTimeout()	The period to wait for a connection to the master node.
final List<String>	name()	Required - A comma-separated list of data streams or data stream patterns.
static PutDataStreamSettingsRequest	of(Function<PutDataStreamSettingsRequest.Builder,ObjectBuilder<PutDataStreamSettingsRequest>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this value to JSON.
final IndexSettings	settings()	Required - Request body.
final Time	timeout()	The 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<PutDataStreamSettingsRequest> _DESERIALIZER

_ENDPOINT

public static final Endpoint<PutDataStreamSettingsRequest,PutDataStreamSettingsResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.put_data_stream_settings".

Method Details

of

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

dryRun

@Nullable
public final Boolean dryRun()

If true, the request does not actually change the settings on any data streams or indices. Instead, it simulates changing the settings and reports back to the user what would have happened had these settings actually been applied.

API name: dry_run

masterTimeout

@Nullable
public final Time masterTimeout()

The 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 - A comma-separated list of data streams or data stream patterns.

API name: name

timeout

@Nullable
public final Time timeout()

The 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

settings

public final IndexSettings settings()

Required - Request body.

serialize

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

Serialize this value to JSON.

Specified by:

serialize in interface JsonpSerializable

createPutDataStreamSettingsRequestDeserializer

protected static JsonpDeserializer<PutDataStreamSettingsRequest> createPutDataStreamSettingsRequestDeserializer()