Package co.elastic.clients.elasticsearch._types.query_dsl

Class FieldAndFormat

java.lang.Object

co.elastic.clients.elasticsearch._types.query_dsl.FieldAndFormat

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class FieldAndFormat
extends Object
implements JsonpSerializable

A reference to a field with formatting instructions on how to return the value

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final String	field()	Required - Wildcard pattern.
final String	format()	Format in which the values are returned.
final Boolean	includeUnmapped()	API name: include_unmapped
static FieldAndFormat	of(Function<FieldAndFormat.Builder,ObjectBuilder<FieldAndFormat>> 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	setupFieldAndFormatDeserializer(ObjectDeserializer<FieldAndFormat.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<FieldAndFormat> _DESERIALIZER

Json deserializer for FieldAndFormat

Method Details

of

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

field

public final String field()

Required - Wildcard pattern. The request returns values for field names matching this pattern.

API name: field

format

@Nullable
public final String format()

Format in which the values are returned.

API name: format

includeUnmapped

@Nullable
public final Boolean includeUnmapped()

API name: include_unmapped

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

setupFieldAndFormatDeserializer

protected static void setupFieldAndFormatDeserializer(ObjectDeserializer<FieldAndFormat.Builder> op)