Package org.opensearch.client.opensearch._types.query_dsl

Class FieldAndFormat

java.lang.Object

org.opensearch.client.opensearch._types.query_dsl.FieldAndFormat

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class FieldAndFormat
extends java.lang.Object
implements JsonpSerializable

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

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 JsonpDeserializer<FieldAndFormat>	_DESERIALIZER	Json deserializer for FieldAndFormat

Method Summary

Modifier and Type	Method	Description
java.lang.String	field()	Required - Wildcard pattern.
java.lang.String	format()	Format in which the values are returned.
java.lang.Boolean	includeUnmapped()	API name: include_unmapped
static FieldAndFormat	of(java.util.function.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)

Methods inherited from class java.lang.Object

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

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<FieldAndFormat> _DESERIALIZER

Json deserializer for FieldAndFormat

Method Detail

of

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

field

public final java.lang.String field()

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

API name: field

format

@Nullable
public final java.lang.String format()

Format in which the values are returned.

API name: format

includeUnmapped

@Nullable
public final java.lang.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)

setupFieldAndFormatDeserializer

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