Class HighlightField
java.lang.Object
co.elastic.clients.elasticsearch.core.search.HighlightField
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class HighlightField extends java.lang.Object implements JsonpSerializable
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
HighlightField.Builder
Builder forHighlightField
. -
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<HighlightField>
_DESERIALIZER
Json deserializer forHighlightField
-
Method Summary
Modifier and Type Method Description java.lang.String
boundaryChars()
API name:boundary_chars
java.lang.Integer
boundaryMaxScan()
API name:boundary_max_scan
BoundaryScanner
boundaryScanner()
API name:boundary_scanner
java.lang.String
boundaryScannerLocale()
API name:boundary_scanner_locale
java.lang.String
field()
API name:field
java.lang.Boolean
forceSource()
API name:force_source
HighlighterFragmenter
fragmenter()
API name:fragmenter
java.lang.Integer
fragmentOffset()
API name:fragment_offset
java.lang.Integer
fragmentSize()
API name:fragment_size
Query
highlightQuery()
API name:highlight_query
java.util.List<java.lang.String>
matchedFields()
API name:matched_fields
java.lang.Integer
maxFragmentLength()
API name:max_fragment_length
java.lang.Integer
noMatchSize()
API name:no_match_size
java.lang.Integer
numberOfFragments()
API name:number_of_fragments
static HighlightField
of(java.util.function.Function<HighlightField.Builder,ObjectBuilder<HighlightField>> fn)
HighlighterOrder
order()
API name:order
java.lang.Integer
phraseLimit()
API name:phrase_limit
java.util.List<java.lang.String>
postTags()
API name:post_tags
java.util.List<java.lang.String>
preTags()
API name:pre_tags
java.lang.Boolean
requireFieldMatch()
API name:require_field_match
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
setupHighlightFieldDeserializer(ObjectDeserializer<HighlightField.Builder> op)
HighlighterTagsSchema
tagsSchema()
API name:tags_schema
HighlighterType
type()
API name:type
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
_DESERIALIZER
Json deserializer forHighlightField
-
-
Method Details
-
of
public static HighlightField of(java.util.function.Function<HighlightField.Builder,ObjectBuilder<HighlightField>> fn) -
boundaryChars
@Nullable public final java.lang.String boundaryChars()API name:boundary_chars
-
boundaryMaxScan
@Nullable public final java.lang.Integer boundaryMaxScan()API name:boundary_max_scan
-
boundaryScanner
API name:boundary_scanner
-
boundaryScannerLocale
@Nullable public final java.lang.String boundaryScannerLocale()API name:boundary_scanner_locale
-
field
@Nullable public final java.lang.String field()API name:field
-
forceSource
@Nullable public final java.lang.Boolean forceSource()API name:force_source
-
fragmenter
API name:fragmenter
-
fragmentOffset
@Nullable public final java.lang.Integer fragmentOffset()API name:fragment_offset
-
fragmentSize
@Nullable public final java.lang.Integer fragmentSize()API name:fragment_size
-
highlightQuery
API name:highlight_query
-
matchedFields
public final java.util.List<java.lang.String> matchedFields()API name:matched_fields
-
maxFragmentLength
@Nullable public final java.lang.Integer maxFragmentLength()API name:max_fragment_length
-
noMatchSize
@Nullable public final java.lang.Integer noMatchSize()API name:no_match_size
-
numberOfFragments
@Nullable public final java.lang.Integer numberOfFragments()API name:number_of_fragments
-
order
API name:order
-
phraseLimit
@Nullable public final java.lang.Integer phraseLimit()API name:phrase_limit
-
postTags
public final java.util.List<java.lang.String> postTags()API name:post_tags
-
preTags
public final java.util.List<java.lang.String> preTags()API name:pre_tags
-
requireFieldMatch
@Nullable public final java.lang.Boolean requireFieldMatch()API name:require_field_match
-
tagsSchema
API name:tags_schema
-
type
API name:type
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupHighlightFieldDeserializer
protected static void setupHighlightFieldDeserializer(ObjectDeserializer<HighlightField.Builder> op)
-