Package org.opensearch.client.opensearch._global

Class ExplainRequest.Builder

java.lang.Object

org.opensearch.client.opensearch._global.ExplainRequest.Builder

All Implemented Interfaces:

ObjectBuilder<ExplainRequest>

Enclosing class:

ExplainRequest

public static class ExplainRequest.Builder
extends java.lang.Object
implements ObjectBuilder<ExplainRequest>

Builder for ExplainRequest.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

ObjectBuilder.Constant<V>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ExplainRequest.Builder	addSourceExcludes(java.lang.String value)	Add a value to sourceExcludes(List), creating the list if needed.
ExplainRequest.Builder	addSourceIncludes(java.lang.String value)	Add a value to sourceIncludes(List), creating the list if needed.
ExplainRequest.Builder	addStoredFields(java.lang.String value)	Add a value to storedFields(List), creating the list if needed.
ExplainRequest.Builder	analyzer(java.lang.String value)	API name: analyzer
ExplainRequest.Builder	analyzeWildcard(java.lang.Boolean value)	API name: analyze_wildcard
ExplainRequest	build()	Builds a ExplainRequest.
ExplainRequest.Builder	defaultOperator(jakarta.json.JsonValue value)	API name: default_operator
ExplainRequest.Builder	df(java.lang.String value)	API name: df
ExplainRequest.Builder	id(java.lang.String value)	API name: id
ExplainRequest.Builder	index(java.lang.String value)	API name: index
ExplainRequest.Builder	lenient(java.lang.Boolean value)	API name: lenient
ExplainRequest.Builder	preference(java.lang.String value)	API name: preference
ExplainRequest.Builder	q(java.lang.String value)	API name: q
ExplainRequest.Builder	query(java.util.function.Function<QueryContainer.Builder,ObjectBuilder<QueryContainer>> fn)	API name: query
ExplainRequest.Builder	query(QueryContainer value)	API name: query
ExplainRequest.Builder	queryOnQueryString(java.lang.String value)	API name: query_on_query_string
ExplainRequest.Builder	routing(jakarta.json.JsonValue value)	API name: routing
ExplainRequest.Builder	source(jakarta.json.JsonValue value)	API name: _source
ExplainRequest.Builder	sourceExcludes(java.lang.String... value)	API name: _source_excludes
ExplainRequest.Builder	sourceExcludes(java.util.List<java.lang.String> value)	API name: _source_excludes
ExplainRequest.Builder	sourceIncludes(java.lang.String... value)	API name: _source_includes
ExplainRequest.Builder	sourceIncludes(java.util.List<java.lang.String> value)	API name: _source_includes
ExplainRequest.Builder	storedFields(java.lang.String... value)	API name: stored_fields
ExplainRequest.Builder	storedFields(java.util.List<java.lang.String> value)	API name: stored_fields
ExplainRequest.Builder	type(java.lang.String value)	API name: type

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

id

public ExplainRequest.Builder id(java.lang.String value)

API name: id

index

public ExplainRequest.Builder index(java.lang.String value)

API name: index

type

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

API name: type

analyzer

public ExplainRequest.Builder analyzer(@Nullable java.lang.String value)

API name: analyzer

analyzeWildcard

public ExplainRequest.Builder analyzeWildcard(@Nullable java.lang.Boolean value)

API name: analyze_wildcard

defaultOperator

public ExplainRequest.Builder defaultOperator(@Nullable jakarta.json.JsonValue value)

API name: default_operator

df

public ExplainRequest.Builder df(@Nullable java.lang.String value)

API name: df

lenient

public ExplainRequest.Builder lenient(@Nullable java.lang.Boolean value)

API name: lenient

preference

public ExplainRequest.Builder preference(@Nullable java.lang.String value)

API name: preference

queryOnQueryString

public ExplainRequest.Builder queryOnQueryString(@Nullable java.lang.String value)

API name: query_on_query_string

routing

public ExplainRequest.Builder routing(@Nullable jakarta.json.JsonValue value)

API name: routing

source

public ExplainRequest.Builder source(@Nullable jakarta.json.JsonValue value)

API name: _source

sourceExcludes

public ExplainRequest.Builder sourceExcludes(@Nullable java.util.List<java.lang.String> value)

API name: _source_excludes

sourceExcludes

public ExplainRequest.Builder sourceExcludes(java.lang.String... value)

API name: _source_excludes

addSourceExcludes

public ExplainRequest.Builder addSourceExcludes(java.lang.String value)

Add a value to sourceExcludes(List), creating the list if needed.

sourceIncludes

public ExplainRequest.Builder sourceIncludes(@Nullable java.util.List<java.lang.String> value)

API name: _source_includes

sourceIncludes

public ExplainRequest.Builder sourceIncludes(java.lang.String... value)

API name: _source_includes

addSourceIncludes

public ExplainRequest.Builder addSourceIncludes(java.lang.String value)

Add a value to sourceIncludes(List), creating the list if needed.

storedFields

public ExplainRequest.Builder storedFields(@Nullable java.util.List<java.lang.String> value)

API name: stored_fields

storedFields

public ExplainRequest.Builder storedFields(java.lang.String... value)

API name: stored_fields

addStoredFields

public ExplainRequest.Builder addStoredFields(java.lang.String value)

Add a value to storedFields(List), creating the list if needed.

q

public ExplainRequest.Builder q(@Nullable java.lang.String value)

API name: q

query

public ExplainRequest.Builder query(@Nullable QueryContainer value)

API name: query

query

public ExplainRequest.Builder query(java.util.function.Function<QueryContainer.Builder,ObjectBuilder<QueryContainer>> fn)

API name: query

build

public ExplainRequest build()

Builds a ExplainRequest.

Specified by:

build in interface ObjectBuilder<ExplainRequest>

Throws:

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