AbstractBulkByScrollRequest (core 5.4.3 API)

java.lang.Object
- org.elasticsearch.transport.TransportMessage
- - org.elasticsearch.transport.TransportRequest
  - - org.elasticsearch.action.ActionRequest
    - - org.elasticsearch.action.bulk.byscroll.AbstractBulkByScrollRequest<Self>

All Implemented Interfaces:: Streamable, TaskAwareRequest

Direct Known Subclasses:: DeleteByQueryRequest

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

Nested Class Summary
- Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest
  TransportRequest.Empty

Field Summary

Fields
Modifier and Type Field and Description

static int SIZE_ALL_MATCHES

Fields
Modifier and Type	Field and Description
`static int`	`SIZE_ALL_MATCHES`

Constructor Summary

Constructors
Constructor and Description
`AbstractBulkByScrollRequest()` Constructor for deserialization.
`AbstractBulkByScrollRequest(SearchRequest searchRequest, boolean setDefaults)` Constructor for actual use.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`Task`	`createTask(long id, java.lang.String type, java.lang.String action, TaskId parentTaskId)` Returns the task object that should be used to keep track of the processing of the request.
`protected Self`	`doForSlice(Self request, TaskId slicingTask)` Setup a clone of this request with the information needed to process a slice of it.
`protected abstract Self`	`forSlice(TaskId slicingTask, SearchRequest slice)` Build a new request for a slice of the parent request.
`java.lang.String`	`getDescription()` Returns optional description of the request to be displayed by the task manager
`int`	`getMaxRetries()` Total number of retries attempted for rejections.
`float`	`getRequestsPerSecond()` The throttle for this request in sub-requests per second.
`TimeValue`	`getRetryBackoffInitialTime()` Initial delay after a rejection before retrying request.
`SearchRequest`	`getSearchRequest()` The search request that matches the documents to process.
`boolean`	`getShouldStoreResult()` Should this task store its result after it has finished?
`int`	`getSize()` Maximum number of processed documents.
`int`	`getSlices()` The number of slices this task should be divided into.
`TimeValue`	`getTimeout()` Timeout to wait for the shards on to be available for each bulk request?
`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(StreamInput in)` Set this object's fields from a StreamInput.
`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(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`	`setSlices(int slices)` The number of slices this task should be divided into.
`Self`	`setTimeout(TimeValue timeout)` Timeout to wait for the shards on to be available for each bulk request?
`Self`	`setWaitForActiveShards(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.
`ActionRequestValidationException`	`validate()`
`void`	`writeTo(StreamOutput out)` Write this object's fields to a StreamOutput.

Methods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, 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

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
setParentTask

- Field Detail
  - SIZE_ALL_MATCHES
```
public static final int SIZE_ALL_MATCHES
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AbstractBulkByScrollRequest
```
public AbstractBulkByScrollRequest()
```
    Constructor for deserialization.
  - AbstractBulkByScrollRequest
```
public AbstractBulkByScrollRequest(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 Detail
  - self
```
protected abstract Self self()
```
    `this` cast to Self. Used for building fluent methods without cast warnings.
  - validate
```
public ActionRequestValidationException validate()
```
    Specified by:
    
    validate in class ActionRequest
  - 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 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 TimeValue getTimeout()
```
    Timeout to wait for the shards on to be available for each bulk request?
  - setTimeout
```
public Self setTimeout(TimeValue timeout)
```
    Timeout to wait for the shards on to be available for each bulk request?
  - getWaitForActiveShards
```
public ActiveShardCount getWaitForActiveShards()
```
    The number of shard copies that must be active before proceeding with the write.
  - setWaitForActiveShards
```
public Self setWaitForActiveShards(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 TimeValue getRetryBackoffInitialTime()
```
    Initial delay after a rejection before retrying request.
  - setRetryBackoffInitialTime
```
public Self setRetryBackoffInitialTime(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()
```
    Description copied from class: ActionRequest
    
    Should this task store its result after it has finished?
    
    Overrides:
    
    getShouldStoreResult in class ActionRequest
  - setSlices
```
public Self setSlices(int slices)
```
    The number of slices this task should be divided into. Defaults to 1 meaning the task isn't sliced into subtasks.
  - getSlices
```
public int getSlices()
```
    The number of slices this task should be divided into. Defaults to 1 meaning the task isn't sliced into subtasks.
  - forSlice
```
protected abstract Self forSlice(TaskId slicingTask,
                                 SearchRequest slice)
```
    Build a new request for a slice of the parent request.
  - doForSlice
```
protected Self doForSlice(Self request,
                          TaskId slicingTask)
```
    Setup a clone of this request with the information needed to process a slice of it.
  - createTask
```
public Task createTask(long id,
                       java.lang.String type,
                       java.lang.String action,
                       TaskId parentTaskId)
```
    Description copied from interface: TaskAwareRequest
    
    Returns the task object that should be used to keep track of the processing of the request. A request can override this method and return null to avoid being tracked by the task manager.
  - readFrom
```
public void readFrom(StreamInput in)
              throws java.io.IOException
```
    Description copied from interface: Streamable
    
    Set this object's fields from a StreamInput.
    
    Specified by:
    
    readFrom in interface Streamable
    
    Overrides:
    
    readFrom in class ActionRequest
    
    Throws:
    
    java.io.IOException
  - writeTo
```
public void writeTo(StreamOutput out)
             throws java.io.IOException
```
    Description copied from interface: Streamable
    
    Write this object's fields to a StreamOutput.
    
    Specified by:
    
    writeTo in interface Streamable
    
    Overrides:
    
    writeTo in class ActionRequest
    
    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.
  - getDescription
```
public java.lang.String getDescription()
```
    Description copied from interface: TaskAwareRequest
    
    Returns optional description of the request to be displayed by the task manager

Class AbstractBulkByScrollRequest<Self extends AbstractBulkByScrollRequest<Self>>

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.elasticsearch.transport.TransportRequest

Methods inherited from class org.elasticsearch.transport.TransportMessage

Methods inherited from class java.lang.Object

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

Field Detail

SIZE_ALL_MATCHES

Constructor Detail

AbstractBulkByScrollRequest

AbstractBulkByScrollRequest

Method Detail

self

validate

getSize

setSize

isAbortOnVersionConflict

setAbortOnVersionConflict

setConflicts

getSearchRequest

isRefresh

setRefresh

getTimeout

setTimeout

getWaitForActiveShards

setWaitForActiveShards

setWaitForActiveShards

getRetryBackoffInitialTime

setRetryBackoffInitialTime

getMaxRetries

setMaxRetries

getRequestsPerSecond

setRequestsPerSecond

setShouldStoreResult

getShouldStoreResult

setSlices

getSlices

forSlice

doForSlice

createTask

readFrom

writeTo

searchToString

getDescription