Package org.opensearch.search.fetch

Class ShardFetchSearchRequest

java.lang.Object

org.opensearch.core.transport.TransportMessage

org.opensearch.transport.TransportRequest

org.opensearch.search.fetch.ShardFetchRequest

org.opensearch.search.fetch.ShardFetchSearchRequest

All Implemented Interfaces:

IndicesRequest, org.opensearch.core.common.io.stream.Writeable, TaskAwareRequest

public class ShardFetchSearchRequest
extends ShardFetchRequest
implements IndicesRequest

Shard level fetch request used with search. Holds indices taken from the original search request and implements IndicesRequest.

Opensearch.internal:

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.core.common.io.stream.Writeable

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Constructor Summary

Constructors

Constructor	Description
ShardFetchSearchRequest(OriginalIndices originalIndices, ShardSearchContextId id, ShardSearchRequest shardSearchRequest, List<Integer> list, org.apache.lucene.search.ScoreDoc lastEmittedDoc, RescoreDocIds rescoreDocIds, AggregatedDfs aggregatedDfs)
ShardFetchSearchRequest(org.opensearch.core.common.io.stream.StreamInput in)

Method Summary

Modifier and Type	Method	Description
AggregatedDfs	getAggregatedDfs()
RescoreDocIds	getRescoreDocIds()
ShardSearchRequest	getShardSearchRequest()
String[]	indices()	Returns the array of indices that the action relates to
IndicesOptions	indicesOptions()	Returns the indices options used to resolve indices.
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class org.opensearch.search.fetch.ShardFetchRequest

contextId, createTask, docIds, docIdsSize, getDescription, lastEmittedDoc

Methods inherited from class org.opensearch.transport.TransportRequest

getParentTask, setParentTask

Methods inherited from class org.opensearch.core.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

setParentTask

Constructor Details

ShardFetchSearchRequest

public ShardFetchSearchRequest(OriginalIndices originalIndices,
 ShardSearchContextId id,
 ShardSearchRequest shardSearchRequest,
 List<Integer> list,
 org.apache.lucene.search.ScoreDoc lastEmittedDoc,
 RescoreDocIds rescoreDocIds,
 AggregatedDfs aggregatedDfs)

ShardFetchSearchRequest

public ShardFetchSearchRequest(org.opensearch.core.common.io.stream.StreamInput in)
                        throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
             throws IOException

Specified by:

writeTo in interface org.opensearch.core.common.io.stream.Writeable

Overrides:

writeTo in class ShardFetchRequest

Throws:

IOException

indices

public String[] indices()

Description copied from interface: IndicesRequest

Returns the array of indices that the action relates to

Specified by:

indices in interface IndicesRequest

indicesOptions

public IndicesOptions indicesOptions()

Description copied from interface: IndicesRequest

Returns the indices options used to resolve indices. They tell for instance whether a single index is accepted, whether an empty array will be converted to _all, and how wildcards will be expanded if needed.

Specified by:

indicesOptions in interface IndicesRequest

getShardSearchRequest

public ShardSearchRequest getShardSearchRequest()

Overrides:

getShardSearchRequest in class ShardFetchRequest

getRescoreDocIds

public RescoreDocIds getRescoreDocIds()

Overrides:

getRescoreDocIds in class ShardFetchRequest

getAggregatedDfs

public AggregatedDfs getAggregatedDfs()

Overrides:

getAggregatedDfs in class ShardFetchRequest