Package co.elastic.clients.elasticsearch.core.search

Class HighlightField.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<HighlightField.Builder>

co.elastic.clients.elasticsearch.core.search.HighlightField.Builder

All Implemented Interfaces:

WithJson<HighlightField.Builder>, ObjectBuilder<HighlightField>

Enclosing class:

HighlightField

public static class HighlightField.Builder
extends WithJsonObjectBuilderBase<HighlightField.Builder>
implements ObjectBuilder<HighlightField>

Builder for HighlightField.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
HighlightField.Builder	boundaryChars(java.lang.String value)	API name: boundary_chars
HighlightField.Builder	boundaryMaxScan(java.lang.Integer value)	API name: boundary_max_scan
HighlightField.Builder	boundaryScanner(BoundaryScanner value)	API name: boundary_scanner
HighlightField.Builder	boundaryScannerLocale(java.lang.String value)	API name: boundary_scanner_locale
HighlightField	build()	Builds a HighlightField.
HighlightField.Builder	field(java.lang.String value)	API name: field
HighlightField.Builder	forceSource(java.lang.Boolean value)	API name: force_source
HighlightField.Builder	fragmenter(HighlighterFragmenter value)	API name: fragmenter
HighlightField.Builder	fragmentOffset(java.lang.Integer value)	API name: fragment_offset
HighlightField.Builder	fragmentSize(java.lang.Integer value)	API name: fragment_size
HighlightField.Builder	highlightQuery(Query value)	API name: highlight_query
HighlightField.Builder	highlightQuery(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)	API name: highlight_query
HighlightField.Builder	matchedFields(java.lang.String value, java.lang.String... values)	API name: matched_fields
HighlightField.Builder	matchedFields(java.util.List<java.lang.String> list)	API name: matched_fields
HighlightField.Builder	maxFragmentLength(java.lang.Integer value)	API name: max_fragment_length
HighlightField.Builder	noMatchSize(java.lang.Integer value)	API name: no_match_size
HighlightField.Builder	numberOfFragments(java.lang.Integer value)	API name: number_of_fragments
HighlightField.Builder	order(HighlighterOrder value)	API name: order
HighlightField.Builder	phraseLimit(java.lang.Integer value)	API name: phrase_limit
HighlightField.Builder	postTags(java.lang.String value, java.lang.String... values)	API name: post_tags
HighlightField.Builder	postTags(java.util.List<java.lang.String> list)	API name: post_tags
HighlightField.Builder	preTags(java.lang.String value, java.lang.String... values)	API name: pre_tags
HighlightField.Builder	preTags(java.util.List<java.lang.String> list)	API name: pre_tags
HighlightField.Builder	requireFieldMatch(java.lang.Boolean value)	API name: require_field_match
protected HighlightField.Builder	self()
HighlightField.Builder	tagsSchema(HighlighterTagsSchema value)	API name: tags_schema
HighlightField.Builder	type(HighlighterType value)	API name: type
HighlightField.Builder	type(java.lang.String value)	API name: type

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

boundaryChars

public final HighlightField.Builder boundaryChars(@Nullable
java.lang.String value)

API name: boundary_chars

boundaryMaxScan

public final HighlightField.Builder boundaryMaxScan(@Nullable
java.lang.Integer value)

API name: boundary_max_scan

boundaryScanner

public final HighlightField.Builder boundaryScanner(@Nullable
BoundaryScanner value)

API name: boundary_scanner

boundaryScannerLocale

public final HighlightField.Builder boundaryScannerLocale(@Nullable
java.lang.String value)

API name: boundary_scanner_locale

field

public final HighlightField.Builder field(@Nullable
java.lang.String value)

API name: field

forceSource

public final HighlightField.Builder forceSource(@Nullable
java.lang.Boolean value)

API name: force_source

fragmenter

public final HighlightField.Builder fragmenter(@Nullable
HighlighterFragmenter value)

API name: fragmenter

fragmentOffset

public final HighlightField.Builder fragmentOffset(@Nullable
java.lang.Integer value)

API name: fragment_offset

fragmentSize

public final HighlightField.Builder fragmentSize(@Nullable
java.lang.Integer value)

API name: fragment_size

highlightQuery

public final HighlightField.Builder highlightQuery(@Nullable
Query value)

API name: highlight_query

highlightQuery

public final HighlightField.Builder highlightQuery(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)

API name: highlight_query

matchedFields

public final HighlightField.Builder matchedFields(java.util.List<java.lang.String> list)

API name: matched_fields

Adds all elements of list to matchedFields.

matchedFields

public final HighlightField.Builder matchedFields(java.lang.String value,
java.lang.String... values)

API name: matched_fields

Adds one or more values to matchedFields.

maxFragmentLength

public final HighlightField.Builder maxFragmentLength(@Nullable
java.lang.Integer value)

API name: max_fragment_length

noMatchSize

public final HighlightField.Builder noMatchSize(@Nullable
java.lang.Integer value)

API name: no_match_size

numberOfFragments

public final HighlightField.Builder numberOfFragments(@Nullable
java.lang.Integer value)

API name: number_of_fragments

order

public final HighlightField.Builder order(@Nullable
HighlighterOrder value)

API name: order

phraseLimit

public final HighlightField.Builder phraseLimit(@Nullable
java.lang.Integer value)

API name: phrase_limit

postTags

public final HighlightField.Builder postTags(java.util.List<java.lang.String> list)

API name: post_tags

Adds all elements of list to postTags.

postTags

public final HighlightField.Builder postTags(java.lang.String value,
java.lang.String... values)

API name: post_tags

Adds one or more values to postTags.

preTags

public final HighlightField.Builder preTags(java.util.List<java.lang.String> list)

API name: pre_tags

Adds all elements of list to preTags.

preTags

public final HighlightField.Builder preTags(java.lang.String value,
java.lang.String... values)

API name: pre_tags

Adds one or more values to preTags.

requireFieldMatch

public final HighlightField.Builder requireFieldMatch(@Nullable
java.lang.Boolean value)

API name: require_field_match

tagsSchema

public final HighlightField.Builder tagsSchema(@Nullable
HighlighterTagsSchema value)

API name: tags_schema

type

public final HighlightField.Builder type(@Nullable
java.lang.String value)

API name: type

type

public final HighlightField.Builder type(@Nullable
HighlighterType value)

API name: type

self

protected HighlightField.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<HighlightField.Builder>

build

public HighlightField build()

Builds a HighlightField.

Specified by:

build in interface ObjectBuilder<HighlightField>

Throws:

java.lang.NullPointerException - if some of the required fields are null.