org.elasticsearch.index.reindex

Class AbstractBulkByScrollRequest<Self extends AbstractBulkByScrollRequest<Self>>

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<Self>

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

All Implemented Interfaces:

org.elasticsearch.common.io.stream.Streamable

Direct Known Subclasses:

AbstractBulkIndexByScrollRequest, DeleteByQueryRequest

public abstract class AbstractBulkByScrollRequest<Self extends AbstractBulkByScrollRequest<Self>>
extends org.elasticsearch.action.ActionRequest<Self>

Nested Class Summary

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

org.elasticsearch.transport.TransportRequest.Empty

Field Summary

Fields

Modifier and Type	Field and Description
static int	SIZE_ALL_MATCHES

Constructor Summary

Constructors

Constructor and Description
AbstractBulkByScrollRequest()
AbstractBulkByScrollRequest(org.elasticsearch.action.search.SearchRequest source)

Method Summary

Modifier and Type	Method and Description
org.elasticsearch.tasks.Task	createTask(long id, java.lang.String type, java.lang.String action, org.elasticsearch.tasks.TaskId parentTaskId)
int	getMaxRetries() Total number of retries attempted for rejections.
float	getRequestsPerSecond() The throttle for this request in sub-requests per second.
org.elasticsearch.common.unit.TimeValue	getRetryBackoffInitialTime() Initial delay after a rejection before retrying request.
org.elasticsearch.action.search.SearchRequest	getSearchRequest() The search request that matches the documents to process.
boolean	getShouldStoreResult()
int	getSize() Maximum number of processed documents.
org.elasticsearch.common.unit.TimeValue	getTimeout() Timeout to wait for the shards on to be available for each bulk request?
org.elasticsearch.action.support.ActiveShardCount	getWaitForActiveShards() The number of shard copies that must be active before proceeding with the write.
boolean	isAbortOnVersionConflict() Should version conflicts cause aborts? Defaults to false.
boolean	isRefresh() Call refresh on the indexes we've written to after the request ends?
void	readFrom(org.elasticsearch.common.io.stream.StreamInput in)
protected void	searchToString(java.lang.StringBuilder b) Append a short description of the search request to a StringBuilder.
protected abstract Self	self() `this` cast to Self.
Self	setAbortOnVersionConflict(boolean abortOnVersionConflict) Should version conflicts cause aborts? Defaults to false.
void	setConflicts(java.lang.String conflicts) Sets abortOnVersionConflict based on REST-friendly names.
Self	setMaxRetries(int maxRetries) Set the total number of retries attempted for rejections.
Self	setRefresh(boolean refresh) Call refresh on the indexes we've written to after the request ends?
Self	setRequestsPerSecond(float requestsPerSecond) Set the throttle for this request in sub-requests per second.
Self	setRetryBackoffInitialTime(org.elasticsearch.common.unit.TimeValue retryBackoffInitialTime) Set the initial delay after a rejection before retrying request.
Self	setShouldStoreResult(boolean shouldStoreResult) Should this task store its result after it has finished?
Self	setSize(int size) Maximum number of processed documents.
Self	setTimeout(org.elasticsearch.common.unit.TimeValue timeout) Timeout to wait for the shards on to be available for each bulk request?
Self	setWaitForActiveShards(org.elasticsearch.action.support.ActiveShardCount activeShardCount) Sets the number of shard copies that must be active before proceeding with the write.
Self	setWaitForActiveShards(int waitForActiveShards) A shortcut for setWaitForActiveShards(ActiveShardCount) where the numerical shard count is passed in, instead of having to first call ActiveShardCount.from(int) to get the ActiveShardCount.
org.elasticsearch.action.ActionRequestValidationException	validate()
void	writeTo(org.elasticsearch.common.io.stream.StreamOutput out)

Methods inherited from class org.elasticsearch.transport.TransportRequest

getDescription, getParentTask, setParentTask, setParentTask

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

Field Detail

SIZE_ALL_MATCHES

public static final int SIZE_ALL_MATCHES

See Also:

Constant Field Values

Constructor Detail

AbstractBulkByScrollRequest

public AbstractBulkByScrollRequest()

AbstractBulkByScrollRequest

public AbstractBulkByScrollRequest(org.elasticsearch.action.search.SearchRequest source)

Method Detail

self

protected abstract Self self()

`this` cast to Self. Used for building fluent methods without cast warnings.

validate

public org.elasticsearch.action.ActionRequestValidationException validate()

Specified by:

validate in class org.elasticsearch.action.ActionRequest<Self extends AbstractBulkByScrollRequest<Self>>

getSize

public int getSize()

Maximum number of processed documents. Defaults to -1 meaning process all documents.

setSize

public Self setSize(int size)

Maximum number of processed documents. Defaults to -1 meaning process all documents.

isAbortOnVersionConflict

public boolean isAbortOnVersionConflict()

Should version conflicts cause aborts? Defaults to false.

setAbortOnVersionConflict

public Self setAbortOnVersionConflict(boolean abortOnVersionConflict)

Should version conflicts cause aborts? Defaults to false.

setConflicts

public void setConflicts(java.lang.String conflicts)

Sets abortOnVersionConflict based on REST-friendly names.

getSearchRequest

public org.elasticsearch.action.search.SearchRequest getSearchRequest()

The search request that matches the documents to process.

isRefresh

public boolean isRefresh()

Call refresh on the indexes we've written to after the request ends?

setRefresh

public Self setRefresh(boolean refresh)

Call refresh on the indexes we've written to after the request ends?

getTimeout

public org.elasticsearch.common.unit.TimeValue getTimeout()

Timeout to wait for the shards on to be available for each bulk request?

setTimeout

public Self setTimeout(org.elasticsearch.common.unit.TimeValue timeout)

Timeout to wait for the shards on to be available for each bulk request?

getWaitForActiveShards

public org.elasticsearch.action.support.ActiveShardCount getWaitForActiveShards()

The number of shard copies that must be active before proceeding with the write.

setWaitForActiveShards

public Self setWaitForActiveShards(org.elasticsearch.action.support.ActiveShardCount activeShardCount)

Sets the number of shard copies that must be active before proceeding with the write. See ReplicationRequest.waitForActiveShards(ActiveShardCount) for details.

setWaitForActiveShards

public Self setWaitForActiveShards(int waitForActiveShards)

A shortcut for setWaitForActiveShards(ActiveShardCount) where the numerical shard count is passed in, instead of having to first call ActiveShardCount.from(int) to get the ActiveShardCount.

getRetryBackoffInitialTime

public org.elasticsearch.common.unit.TimeValue getRetryBackoffInitialTime()

Initial delay after a rejection before retrying request.

setRetryBackoffInitialTime

public Self setRetryBackoffInitialTime(org.elasticsearch.common.unit.TimeValue retryBackoffInitialTime)

Set the initial delay after a rejection before retrying request.

getMaxRetries

public int getMaxRetries()

Total number of retries attempted for rejections.

setMaxRetries

public Self setMaxRetries(int maxRetries)

Set the total number of retries attempted for rejections. There is no way to ask for unlimited retries.

getRequestsPerSecond

public float getRequestsPerSecond()

The throttle for this request in sub-requests per second. Float.POSITIVE_INFINITY means set no throttle and that is the default. Throttling is done between batches, as we start the next scroll requests. That way we can increase the scroll's timeout to make sure that it contains any time that we might wait.

setRequestsPerSecond

public Self setRequestsPerSecond(float requestsPerSecond)

Set the throttle for this request in sub-requests per second. Float.POSITIVE_INFINITY means set no throttle and that is the default. Throttling is done between batches, as we start the next scroll requests. That way we can increase the scroll's timeout to make sure that it contains any time that we might wait.

setShouldStoreResult

public Self setShouldStoreResult(boolean shouldStoreResult)

Should this task store its result after it has finished?

getShouldStoreResult

public boolean getShouldStoreResult()

Overrides:

getShouldStoreResult in class org.elasticsearch.action.ActionRequest<Self extends AbstractBulkByScrollRequest<Self>>

createTask

public org.elasticsearch.tasks.Task createTask(long id,
                                               java.lang.String type,
                                               java.lang.String action,
                                               org.elasticsearch.tasks.TaskId parentTaskId)

Overrides:

createTask in class org.elasticsearch.transport.TransportRequest

readFrom

public void readFrom(org.elasticsearch.common.io.stream.StreamInput in)
              throws java.io.IOException

Specified by:

readFrom in interface org.elasticsearch.common.io.stream.Streamable

Overrides:

readFrom in class org.elasticsearch.action.ActionRequest<Self extends AbstractBulkByScrollRequest<Self>>

Throws:

java.io.IOException

writeTo

public void writeTo(org.elasticsearch.common.io.stream.StreamOutput out)
             throws java.io.IOException

Specified by:

writeTo in interface org.elasticsearch.common.io.stream.Streamable

Overrides:

writeTo in class org.elasticsearch.action.ActionRequest<Self extends AbstractBulkByScrollRequest<Self>>

Throws:

java.io.IOException

searchToString

protected void searchToString(java.lang.StringBuilder b)

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