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.Params
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Field Summary
Modifier and TypeFieldDescriptionfinal String
The name of the field.static final ParseField
final String
The format of the field, ornull
if defaults should be used.static final ParseField
static final ParseField
final Boolean
Whether to include unmapped fields or not.Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
ConstructorDescriptionFieldAndFormat
(String field, String format) FieldAndFormat
(String field, String format, Boolean includeUnmapped) Serialization constructor. -
Method Summary
Modifier and TypeMethodDescriptionboolean
static FieldAndFormat
fromXContent
(XContentParser parser) Parse aFieldAndFormat
from someXContent
.int
hashCode()
toXContent
(XContentBuilder builder, ToXContent.Params params) void
writeTo
(StreamOutput out) Write this into the StreamOutput.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
Methods 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, ornull
if 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 aFieldAndFormat
from someXContent
.- Throws:
IOException
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
toXContent
in interfaceToXContent
- Throws:
IOException
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Throws:
IOException
-
hashCode
public int hashCode() -
equals
-