Package org.opensearch.client.opensearch.core

Class ExplainRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.ExplainRequest.Builder

All Implemented Interfaces:

ObjectBuilder<ExplainRequest>

Enclosing class:

ExplainRequest

public static class ExplainRequest.Builder
extends ObjectBuilderBase
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)	The analyzer for the query string query
final ExplainRequest.Builder	analyzeWildcard(Boolean value)	Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)
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)	The default field for query string query (default: _all)
final ExplainRequest.Builder	id(String value)	Required - The document ID
final ExplainRequest.Builder	index(String value)	Required - The name of the index
final ExplainRequest.Builder	lenient(Boolean value)	Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
final ExplainRequest.Builder	preference(String value)	Specify the node or shard the operation should be performed on (default: random)
final ExplainRequest.Builder	q(String value)	Query in the Lucene query string syntax
final ExplainRequest.Builder	query(Function<Query.Builder,ObjectBuilder<Query>> fn)	API name: query
final ExplainRequest.Builder	query(Query value)	API name: query
final ExplainRequest.Builder	routing(String value)	Specific routing value
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	source(SourceConfigParam value)	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 list of fields to exclude from the returned _source field
final ExplainRequest.Builder	sourceExcludes(List<String> list)	A list of fields to exclude from the returned _source field
final ExplainRequest.Builder	sourceIncludes(String value, String... values)	A list of fields to extract and return from the _source field
final ExplainRequest.Builder	sourceIncludes(List<String> list)	A list of fields to extract and return from the _source field
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 org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

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 list of fields to exclude from the returned _source field

API name: _source_excludes

Adds all elements of list to sourceExcludes.

sourceExcludes

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

A list of fields to exclude from the returned _source field

API name: _source_excludes

Adds one or more values to sourceExcludes.

sourceIncludes

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

A list of fields to extract and return from the _source field

API name: _source_includes

Adds all elements of list to sourceIncludes.

sourceIncludes

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

A list of fields to extract and return from the _source field

API name: _source_includes

Adds one or more values to sourceIncludes.

analyzeWildcard

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

Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)

API name: analyze_wildcard

analyzer

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

The analyzer for the query string query

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)

The default field for query string query (default: _all)

API name: df

id

public final ExplainRequest.Builder id(String value)

Required - The document ID

API name: id

index

public final ExplainRequest.Builder index(String value)

Required - The name of the index

API name: index

lenient

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

Specify whether format-based query failures (such as providing text to a numeric field) should be ignored

API name: lenient

preference

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

Specify the node or shard the operation should be performed on (default: random)

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)

API name: query

query

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

API name: query

routing

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

Specific routing value

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.

build

public ExplainRequest build()

Builds a ExplainRequest.

Specified by:

build in interface ObjectBuilder<ExplainRequest>

Throws:

NullPointerException - if some of the required fields are null.