Package co.elastic.clients.elasticsearch.esql

Class IdPath

java.lang.Object

co.elastic.clients.elasticsearch.esql.IdPath

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class IdPath
extends Object
implements JsonpSerializable

The _id meta-field of a dataset mapping.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static IdPath	of(Function<IdPath.Builder,ObjectBuilder<IdPath>> fn)
final String	path()	Required - The name of the column that provides the document identity.
IdPath.Builder	rebuild()
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	setupIdPathDeserializer(ObjectDeserializer<IdPath.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<IdPath> _DESERIALIZER

Json deserializer for IdPath

Method Details

of

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

path

public final String path()

Required - The name of the column that provides the document identity.

API name: path

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

rebuild

public IdPath.Builder rebuild()

Returns:

New IdPath.Builder initialized with field values of this instance

setupIdPathDeserializer

protected static void setupIdPathDeserializer(ObjectDeserializer<IdPath.Builder> op)