FieldAndFormat (java-client 8.5.0 API)

java.lang.Object

co.elastic.clients.elasticsearch._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

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 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)`
`java.lang.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(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)
- toString
  
  public java.lang.String toString()
  
  Overrides:
  
  toString in class java.lang.Object
- setupFieldAndFormatDeserializer
  
  protected static void setupFieldAndFormatDeserializer(ObjectDeserializer<FieldAndFormat.Builder> op)