Package co.elastic.clients.elasticsearch.indices.put_data_stream_mappings

Class UpdatedDataStreamMappings

java.lang.Object

co.elastic.clients.elasticsearch.indices.put_data_stream_mappings.UpdatedDataStreamMappings

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class UpdatedDataStreamMappings
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<UpdatedDataStreamMappings>	_DESERIALIZER	Json deserializer for UpdatedDataStreamMappings

Method Summary

Modifier and Type	Method	Description
final boolean	appliedToDataStream()	Required - If the mappings were successfully applied to the data stream (or would have been, if running in dry_run mode), it is true.
final TypeMapping	effectiveMappings()	The mappings that are effective on this data stream, taking into account the mappings from the matching index template and the mappings specific to this data stream.
final String	error()	A message explaining why the mappings could not be applied to the data stream.
final TypeMapping	mappings()	The mappings that are specfic to this data stream that will override any mappings from the matching index template.
final String	name()	Required - The data stream name.
static UpdatedDataStreamMappings	of(Function<UpdatedDataStreamMappings.Builder,ObjectBuilder<UpdatedDataStreamMappings>> 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	setupUpdatedDataStreamMappingsDeserializer(ObjectDeserializer<UpdatedDataStreamMappings.Builder> op)
String	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<UpdatedDataStreamMappings> _DESERIALIZER

Json deserializer for UpdatedDataStreamMappings

Method Details

of

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

name

public final String name()

Required - The data stream name.

API name: name

appliedToDataStream

public final boolean appliedToDataStream()

Required - If the mappings were successfully applied to the data stream (or would have been, if running in dry_run mode), it is true. If an error occurred, it is false.

API name: applied_to_data_stream

error

@Nullable
public final String error()

A message explaining why the mappings could not be applied to the data stream.

API name: error

mappings

@Nullable
public final TypeMapping mappings()

The mappings that are specfic to this data stream that will override any mappings from the matching index template.

API name: mappings

effectiveMappings

@Nullable
public final TypeMapping effectiveMappings()

The mappings that are effective on this data stream, taking into account the mappings from the matching index template and the mappings specific to this data stream.

API name: effective_mappings

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)

toString

public String toString()

Overrides:

toString in class Object

setupUpdatedDataStreamMappingsDeserializer

protected static void setupUpdatedDataStreamMappingsDeserializer(ObjectDeserializer<UpdatedDataStreamMappings.Builder> op)