Package org.opensearch.index.reindex

Class AbstractBulkIndexByScrollRequest<Self extends AbstractBulkIndexByScrollRequest<Self>>

java.lang.Object

org.opensearch.transport.TransportMessage

org.opensearch.transport.TransportRequest

org.opensearch.action.ActionRequest

org.opensearch.index.reindex.AbstractBulkByScrollRequest<Self>

org.opensearch.index.reindex.AbstractBulkIndexByScrollRequest<Self>

All Implemented Interfaces:

Writeable, TaskAwareRequest

Direct Known Subclasses:

ReindexRequest, UpdateByQueryRequest

public abstract class AbstractBulkIndexByScrollRequest<Self extends AbstractBulkIndexByScrollRequest<Self>>
extends AbstractBulkByScrollRequest<Self>

Base request class for bulk indexing by scroll

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

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

Field Summary

Fields inherited from class org.opensearch.index.reindex.AbstractBulkByScrollRequest

AUTO_SLICES, AUTO_SLICES_VALUE, DEFAULT_SCROLL_SIZE, DEFAULT_SCROLL_TIMEOUT, MAX_DOCS_ALL_MATCHES, SIZE_ALL_MATCHES

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractBulkIndexByScrollRequest(SearchRequest searchRequest, boolean setDefaults)	Constructor for actual use.
	AbstractBulkIndexByScrollRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
protected Self	doForSlice(Self request, TaskId slicingTask, int totalSlices)	Setup a clone of this request with the information needed to process a slice of it.
Script	getScript()	Script to modify the documents before they are processed.
protected void	searchToString(StringBuilder b)	Append a short description of the search request to a StringBuilder.
Self	setScript(Script script)	Script to modify the documents before they are processed.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.opensearch.index.reindex.AbstractBulkByScrollRequest

createTask, forSlice, getDescription, getMaxDocs, getMaxRetries, getRequestsPerSecond, getRetryBackoffInitialTime, getScrollTime, getSearchRequest, getShouldStoreResult, getSize, getSlices, getTimeout, getWaitForActiveShards, isAbortOnVersionConflict, isRefresh, self, setAbortOnVersionConflict, setConflicts, setMaxDocs, setMaxRetries, setRefresh, setRequestsPerSecond, setRetryBackoffInitialTime, setScroll, setShouldStoreResult, setSize, setSlices, setTimeout, setTimeout, setWaitForActiveShards, setWaitForActiveShards, validate

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.tasks.TaskAwareRequest

setParentTask

Constructor Details

AbstractBulkIndexByScrollRequest

public AbstractBulkIndexByScrollRequest(StreamInput in)
                                 throws IOException

Throws:

IOException

AbstractBulkIndexByScrollRequest

protected AbstractBulkIndexByScrollRequest(SearchRequest searchRequest,
 boolean setDefaults)

Constructor for actual use.

Parameters:

searchRequest - the search request to execute to get the documents to process

setDefaults - should this request set the defaults on the search request? Usually set to true but leave it false to support request slicing

Method Details

getScript

public Script getScript()

Script to modify the documents before they are processed.

setScript

public Self setScript(@Nullable
 Script script)

Script to modify the documents before they are processed.

doForSlice

protected Self doForSlice(Self request,
 TaskId slicingTask,
 int totalSlices)

Description copied from class: AbstractBulkByScrollRequest

Setup a clone of this request with the information needed to process a slice of it.

Overrides:

doForSlice in class AbstractBulkByScrollRequest<Self extends AbstractBulkIndexByScrollRequest<Self>>

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class AbstractBulkByScrollRequest<Self extends AbstractBulkIndexByScrollRequest<Self>>

Throws:

IOException

searchToString

protected void searchToString(StringBuilder b)

Description copied from class: AbstractBulkByScrollRequest

Append a short description of the search request to a StringBuilder. Used to make toString.

Overrides:

searchToString in class AbstractBulkByScrollRequest<Self extends AbstractBulkIndexByScrollRequest<Self>>