Package co.elastic.clients.elasticsearch.core

Class ExplainRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<ExplainRequest.Builder>

co.elastic.clients.elasticsearch.core.ExplainRequest.Builder

All Implemented Interfaces:

WithJson<ExplainRequest.Builder>, ObjectBuilder<ExplainRequest>

Enclosing class:

ExplainRequest

public static class ExplainRequest.Builder
extends RequestBase.AbstractBuilder<ExplainRequest.Builder>
implements ObjectBuilder<ExplainRequest>

Builder for ExplainRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final ExplainRequest.Builder	analyzer(String value)	Analyzer to use for the query string.
final ExplainRequest.Builder	analyzeWildcard(Boolean value)	If true, wildcard and prefix queries are analyzed.
ExplainRequest	build()	Builds a ExplainRequest.
final ExplainRequest.Builder	defaultOperator(Operator value)	The default operator for query string query: AND or OR.
final ExplainRequest.Builder	df(String value)	Field to use as default where no field prefix is given in the query string.
final ExplainRequest.Builder	id(String value)	Required - Defines the document ID.
final ExplainRequest.Builder	index(String value)	Required - Index names used to limit the request.
final ExplainRequest.Builder	lenient(Boolean value)	If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.
final ExplainRequest.Builder	preference(String value)	Specifies the node or shard the operation should be performed on.
final ExplainRequest.Builder	q(String value)	Query in the Lucene query string syntax.
final ExplainRequest.Builder	query(Query value)	Defines the search definition using the Query DSL.
final ExplainRequest.Builder	query(Function<Query.Builder,ObjectBuilder<Query>> fn)	Defines the search definition using the Query DSL.
final ExplainRequest.Builder	routing(String value)	Custom value used to route operations to a specific shard.
protected ExplainRequest.Builder	self()
final ExplainRequest.Builder	source(SourceConfigParam value)	True or false to return the _source field or not, or a list of fields to return.
final ExplainRequest.Builder	source(Function<SourceConfigParam.Builder,ObjectBuilder<SourceConfigParam>> fn)	True or false to return the _source field or not, or a list of fields to return.
final ExplainRequest.Builder	sourceExcludes(String value, String... values)	A comma-separated list of source fields to exclude from the response.
final ExplainRequest.Builder	sourceExcludes(List<String> list)	A comma-separated list of source fields to exclude from the response.
final ExplainRequest.Builder	sourceIncludes(String value, String... values)	A comma-separated list of source fields to include in the response.
final ExplainRequest.Builder	sourceIncludes(List<String> list)	A comma-separated list of source fields to include in the response.
final ExplainRequest.Builder	storedFields(String value, String... values)	A comma-separated list of stored fields to return in the response.
final ExplainRequest.Builder	storedFields(List<String> list)	A comma-separated list of stored fields to return in the response.

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

source

public final ExplainRequest.Builder source(@Nullable
 SourceConfigParam value)

True or false to return the _source field or not, or a list of fields to return.

API name: _source

source

public final ExplainRequest.Builder source(Function<SourceConfigParam.Builder,ObjectBuilder<SourceConfigParam>> fn)

True or false to return the _source field or not, or a list of fields to return.

API name: _source

sourceExcludes

public final ExplainRequest.Builder sourceExcludes(List<String> list)

A comma-separated list of source fields to exclude from the response.

API name: _source_excludes

Adds all elements of list to sourceExcludes.

sourceExcludes

public final ExplainRequest.Builder sourceExcludes(String value,
 String... values)

A comma-separated list of source fields to exclude from the response.

API name: _source_excludes

Adds one or more values to sourceExcludes.

sourceIncludes

public final ExplainRequest.Builder sourceIncludes(List<String> list)

A comma-separated list of source fields to include in the response.

API name: _source_includes

Adds all elements of list to sourceIncludes.

sourceIncludes

public final ExplainRequest.Builder sourceIncludes(String value,
 String... values)

A comma-separated list of source fields to include in the response.

API name: _source_includes

Adds one or more values to sourceIncludes.

analyzeWildcard

public final ExplainRequest.Builder analyzeWildcard(@Nullable
 Boolean value)

If true, wildcard and prefix queries are analyzed.

API name: analyze_wildcard

analyzer

public final ExplainRequest.Builder analyzer(@Nullable
 String value)

Analyzer to use for the query string. This parameter can only be used when the q query string parameter is specified.

API name: analyzer

defaultOperator

public final ExplainRequest.Builder defaultOperator(@Nullable
 Operator value)

The default operator for query string query: AND or OR.

API name: default_operator

df

public final ExplainRequest.Builder df(@Nullable
 String value)

Field to use as default where no field prefix is given in the query string.

API name: df

id

public final ExplainRequest.Builder id(String value)

Required - Defines the document ID.

API name: id

index

public final ExplainRequest.Builder index(String value)

Required - Index names used to limit the request. Only a single index name can be provided to this parameter.

API name: index

lenient

public final ExplainRequest.Builder lenient(@Nullable
 Boolean value)

If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.

API name: lenient

preference

public final ExplainRequest.Builder preference(@Nullable
 String value)

Specifies the node or shard the operation should be performed on. Random by default.

API name: preference

q

public final ExplainRequest.Builder q(@Nullable
 String value)

Query in the Lucene query string syntax.

API name: q

query

public final ExplainRequest.Builder query(@Nullable
 Query value)

Defines the search definition using the Query DSL.

API name: query

query

public final ExplainRequest.Builder query(Function<Query.Builder,ObjectBuilder<Query>> fn)

Defines the search definition using the Query DSL.

API name: query

routing

public final ExplainRequest.Builder routing(@Nullable
 String value)

Custom value used to route operations to a specific shard.

API name: routing

storedFields

public final ExplainRequest.Builder storedFields(List<String> list)

A comma-separated list of stored fields to return in the response.

API name: stored_fields

Adds all elements of list to storedFields.

storedFields

public final ExplainRequest.Builder storedFields(String value,
 String... values)

A comma-separated list of stored fields to return in the response.

API name: stored_fields

Adds one or more values to storedFields.

self

protected ExplainRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<ExplainRequest.Builder>

build

public ExplainRequest build()

Builds a ExplainRequest.

Specified by:

build in interface ObjectBuilder<ExplainRequest>

Throws:

NullPointerException - if some of the required fields are null.