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, PlainJsonSerializable, ToCopyableBuilder<FieldAndFormat.Builder,FieldAndFormat>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class FieldAndFormat
extends Object
implements PlainJsonSerializable, ToCopyableBuilder<FieldAndFormat.Builder,FieldAndFormat>

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
static FieldAndFormat.Builder	builder()
boolean	equals(Object o)
final String	field()	Required - API name: field
final String	format()	Format in which the values are returned.
int	hashCode()
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)
FieldAndFormat.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

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

@Nonnull
public final String field()

Required - 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)

toBuilder

@Nonnull
public FieldAndFormat.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<FieldAndFormat.Builder,FieldAndFormat>

Returns:

a new builder instance.

builder

@Nonnull
public static FieldAndFormat.Builder builder()

setupFieldAndFormatDeserializer

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object