Package org.opensearch.action.explain

Class ExplainRequest

java.lang.Object

org.opensearch.transport.TransportMessage

org.opensearch.transport.TransportRequest

org.opensearch.action.ActionRequest

org.opensearch.action.support.single.shard.SingleShardRequest<ExplainRequest>

org.opensearch.action.explain.ExplainRequest

All Implemented Interfaces:

IndicesRequest, Writeable, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentObject, TaskAwareRequest

public class ExplainRequest
extends SingleShardRequest<ExplainRequest>
implements org.opensearch.common.xcontent.ToXContentObject

Explain request encapsulating the explain query and document identifier to get an explanation for.

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.transport.TransportRequest

TransportRequest.Empty

Nested classes/interfaces inherited from interface org.opensearch.action.IndicesRequest

IndicesRequest.Replaceable

Nested classes/interfaces inherited from interface org.opensearch.common.xcontent.ToXContent

org.opensearch.common.xcontent.ToXContent.DelegatingMapParams, org.opensearch.common.xcontent.ToXContent.MapParams, org.opensearch.common.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.opensearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from class org.opensearch.action.support.single.shard.SingleShardRequest

index, INDICES_OPTIONS

Fields inherited from interface org.opensearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ExplainRequest()
ExplainRequest(java.lang.String index, java.lang.String id)
ExplainRequest(java.lang.String index, java.lang.String type, java.lang.String id)	Deprecated. Types are in the process of being removed.

Method Summary

Modifier and Type	Method	Description
FetchSourceContext	fetchSourceContext()
ExplainRequest	fetchSourceContext(FetchSourceContext context)	Allows setting the FetchSourceContext for this request, controlling if and how _source should be returned.
AliasFilter	filteringAlias()
ExplainRequest	filteringAlias(AliasFilter filteringAlias)
java.lang.String	id()
ExplainRequest	id(java.lang.String id)
ExplainRequest	parent(java.lang.String parent)	Simple sets the routing.
java.lang.String	preference()
ExplainRequest	preference(java.lang.String preference)
QueryBuilder	query()
ExplainRequest	query(QueryBuilder query)
java.lang.String	routing()
ExplainRequest	routing(java.lang.String routing)
java.lang.String[]	storedFields()
ExplainRequest	storedFields(java.lang.String[] fields)
org.opensearch.common.xcontent.XContentBuilder	toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)
java.lang.String	type()	Deprecated. Types are in the process of being removed.
ExplainRequest	type(java.lang.String type)	Deprecated. Types are in the process of being removed.
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.opensearch.action.support.single.shard.SingleShardRequest

index, index, indices, indicesOptions, validateNonNullIndex

Methods inherited from class org.opensearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.opensearch.transport.TransportRequest

getParentTask, setParentTask

Methods inherited from class org.opensearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.action.IndicesRequest

includeDataStreams

Methods inherited from interface org.opensearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Methods inherited from interface org.opensearch.common.xcontent.ToXContentObject

isFragment

Constructor Details

ExplainRequest

public ExplainRequest()

ExplainRequest

@Deprecated public ExplainRequest(java.lang.String index, java.lang.String type, java.lang.String id)

Deprecated.

Types are in the process of being removed. Use instead.

ExplainRequest

public ExplainRequest(java.lang.String index, java.lang.String id)

Method Details

type

@Deprecated public java.lang.String type()

Deprecated.

Types are in the process of being removed.

type

@Deprecated public ExplainRequest type(java.lang.String type)

Deprecated.

Types are in the process of being removed.

id

public java.lang.String id()

id

public ExplainRequest id(java.lang.String id)

routing

public java.lang.String routing()

routing

public ExplainRequest routing(java.lang.String routing)

parent

public ExplainRequest parent(java.lang.String parent)

Simple sets the routing. Since the parent is only used to get to the right shard.

preference

public java.lang.String preference()

preference

public ExplainRequest preference(java.lang.String preference)

query

public QueryBuilder query()

query

public ExplainRequest query(QueryBuilder query)

fetchSourceContext

public ExplainRequest fetchSourceContext(FetchSourceContext context)

Allows setting the FetchSourceContext for this request, controlling if and how _source should be returned.

fetchSourceContext

public FetchSourceContext fetchSourceContext()

storedFields

public java.lang.String[] storedFields()

storedFields

public ExplainRequest storedFields(java.lang.String[] fields)

filteringAlias

public AliasFilter filteringAlias()

filteringAlias

public ExplainRequest filteringAlias(AliasFilter filteringAlias)

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

writeTo

public void writeTo(StreamOutput out) throws java.io.IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class SingleShardRequest<ExplainRequest>

Throws:

java.io.IOException

toXContent

public org.opensearch.common.xcontent.XContentBuilder toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params) throws java.io.IOException

Specified by:

toXContent in interface org.opensearch.common.xcontent.ToXContent

Throws:

java.io.IOException