Class FieldAndFormat
org.elasticsearch.search.fetch.subphase.FieldAndFormat
- All Implemented Interfaces:
Writeable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentObject
public final class FieldAndFormat
extends
implements Writeable, org.elasticsearch.common.xcontent.ToXContentObject
Wrapper around a field name and the format that should be used to
display values of this field.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Field Summary
Modifier and TypeFieldDescriptionThe name of the field.The format of the field, ornull
if defaults should be used.Whether to include unmapped fields or not.Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
ConstructorDescriptionfield, format)
field, format, includeUnmapped)
Serialization constructor. -
Method Summary
Modifier and TypeMethodDescriptionboolean
o)
static FieldAndFormat
fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
Parse aFieldAndFormat
from someXContent
.int
hashCode()
org.elasticsearch.common.xcontent.XContentBuilder
toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
void
writeTo(StreamOutput out)
Write this into the StreamOutput.Methods inherited from class java.lang.
, , , , , , , ,
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject
isFragment
-
Field Details
-
field
public final fieldThe name of the field. -
format
public final formatThe format of the field, ornull
if defaults should be used. -
includeUnmapped
public final includeUnmappedWhether to include unmapped fields or not.
-
-
Constructor Details
-
FieldAndFormat
public FieldAndFormat( field, @Nullable format) -
FieldAndFormat
public FieldAndFormat( field, @Nullable format, @Nullable includeUnmapped) -
FieldAndFormat
Serialization constructor.- Throws:
-
-
Method Details
-
fromXContent
public static FieldAndFormat fromXContent(org.elasticsearch.common.xcontent.XContentParser parser) throwsParse aFieldAndFormat
from someXContent
.- Throws:
-
toXContent
public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws- Specified by:
toXContent
in interfaceorg.elasticsearch.common.xcontent.ToXContent
- Throws:
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput. -
equals
public boolean equals( o)- Overrides:
in class
-
hashCode
public int hashCode()- Overrides:
in class
-