Package co.elastic.clients.elasticsearch.indices

Class PutDataStreamMappingsRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.indices.PutDataStreamMappingsRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class PutDataStreamMappingsRequest
extends RequestBase
implements JsonpSerializable

Update data stream mappings.

This API can be used to override mappings on specific data streams. These overrides will take precedence over what is specified in the template that the data stream matches. The mapping change is only applied to new write indices that are created during rollover after this API is called. No indices are changed by this API.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<PutDataStreamMappingsRequest>	_DESERIALIZER
static final Endpoint<PutDataStreamMappingsRequest,PutDataStreamMappingsResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.put_data_stream_mappings".

Method Summary

Modifier and Type	Method	Description
protected static JsonpDeserializer<PutDataStreamMappingsRequest>	createPutDataStreamMappingsRequestDeserializer()
final Boolean	dryRun()	If true, the request does not actually change the mappings on any data streams.
final TypeMapping	mappings()	Required - Request body.
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 PutDataStreamMappingsRequest	of(Function<PutDataStreamMappingsRequest.Builder,ObjectBuilder<PutDataStreamMappingsRequest>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this value to JSON.
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<PutDataStreamMappingsRequest> _DESERIALIZER

_ENDPOINT

public static final Endpoint<PutDataStreamMappingsRequest,PutDataStreamMappingsResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.put_data_stream_mappings".

Method Details

of

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

dryRun

@Nullable
public final Boolean dryRun()

If true, the request does not actually change the mappings on any data streams. 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

mappings

public final TypeMapping mappings()

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

createPutDataStreamMappingsRequestDeserializer

protected static JsonpDeserializer<PutDataStreamMappingsRequest> createPutDataStreamMappingsRequestDeserializer()