Package co.elastic.clients.elasticsearch.ingest

Class DocumentSimulation

java.lang.Object

co.elastic.clients.elasticsearch.ingest.DocumentSimulation

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class DocumentSimulation
extends Object
implements JsonpSerializable

The simulated document, with optional metadata.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final String	id()	Required - Unique identifier for the document.
final String	index()	Required - Name of the index containing the document.
final Ingest	ingest()	Required - API name: _ingest
final Map<String,String>	metadata()	Additional metadata
static DocumentSimulation	of(Function<DocumentSimulation.Builder,ObjectBuilder<DocumentSimulation>> fn)
final String	routing()	Value used to send the document to a specific primary shard.
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	setupDocumentSimulationDeserializer(ObjectDeserializer<DocumentSimulation.Builder> op)
final Map<String,JsonData>	source()	Required - JSON body for the document.
String	toString()
final Long	version()	API name: _version
final VersionType	versionType()	API name: _version_type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_DESERIALIZER

public static final JsonpDeserializer<DocumentSimulation> _DESERIALIZER

Json deserializer for DocumentSimulation

Method Details

of

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

metadata

public final Map<String,String> metadata()

Additional metadata

id

public final String id()

Required - Unique identifier for the document. This ID must be unique within the _index.

API name: _id

index

public final String index()

Required - Name of the index containing the document.

API name: _index

ingest

public final Ingest ingest()

Required - API name: _ingest

routing

@Nullable
public final String routing()

Value used to send the document to a specific primary shard.

API name: _routing

source

public final Map<String,JsonData> source()

Required - JSON body for the document.

API name: _source

version

@Nullable
public final Long version()

API name: _version

versionType

@Nullable
public final VersionType versionType()

API name: _version_type

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

setupDocumentSimulationDeserializer

protected static void setupDocumentSimulationDeserializer(ObjectDeserializer<DocumentSimulation.Builder> op)