Module org.elasticsearch.server
Class FieldAndFormat
java.lang.Object
org.elasticsearch.search.fetch.subphase.FieldAndFormat
- All Implemented Interfaces:
Writeable,ToXContent,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.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.ParamsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsModifier and TypeFieldDescriptionfinal StringThe name of the field.static final ParseFieldfinal StringThe format of the field, ornullif defaults should be used.static final ParseFieldstatic final ParseFieldfinal BooleanWhether to include unmapped fields or not.Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
ConstructorsConstructorDescriptionFieldAndFormat(String field, String format) FieldAndFormat(String field, String format, Boolean includeUnmapped) Serialization constructor. -
Method Summary
Modifier and TypeMethodDescriptionbooleanstatic FieldAndFormatfromXContent(XContentParser parser) Parse aFieldAndFormatfrom someXContent.inthashCode()toXContent(XContentBuilder builder, ToXContent.Params params) voidwriteTo(StreamOutput out) Write this into the StreamOutput.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
-
Field Details
-
FIELD_FIELD
-
FORMAT_FIELD
-
INCLUDE_UNMAPPED_FIELD
-
field
The name of the field. -
format
The format of the field, ornullif defaults should be used. -
includeUnmapped
Whether to include unmapped fields or not.
-
-
Constructor Details
-
FieldAndFormat
-
FieldAndFormat
-
FieldAndFormat
Serialization constructor.- Throws:
IOException
-
-
Method Details
-
fromXContent
Parse aFieldAndFormatfrom someXContent.- Throws:
IOException
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
toXContentin interfaceToXContent- Throws:
IOException
-
writeTo
Description copied from interface:WriteableWrite this into the StreamOutput.- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
hashCode
public int hashCode() -
equals
-