Package org.elasticsearch.index.reindex

Class AbstractBulkByScrollRequest<Self extends AbstractBulkByScrollRequest<Self>>

    • Field Detail

      • SIZE_ALL_MATCHES

        @Deprecated
public static final int SIZE_ALL_MATCHES
        Deprecated.
        please use MAX_DOCS_ALL_MATCHES instead.
        See Also:
        Constant Field Values

      • DEFAULT_SCROLL_TIMEOUT

        public static final TimeValue DEFAULT_SCROLL_TIMEOUT

      • AUTO_SLICES_VALUE

        public static final java.lang.String AUTO_SLICES_VALUE
        See Also:
        Constant Field Values

    • Constructor Detail

      • AbstractBulkByScrollRequest

        public AbstractBulkByScrollRequest​(StreamInput in)
                            throws java.io.IOException
        Throws:
        java.io.IOException

      • 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.

      • getSize

        @Deprecated
public int getSize()
        Deprecated.
        please use getMaxDocs() instead.
        Maximum number of processed documents. Defaults to -1 meaning process all documents.

      • setSize

        @Deprecated
public Self setSize​(int size)
        Deprecated.
        please use setMaxDocs(int) instead.
        Maximum number of processed documents. Defaults to -1 meaning process all documents.

      • getMaxDocs

        public int getMaxDocs()
        Maximum number of processed documents. Defaults to -1 meaning process all documents.

      • setMaxDocs

        public Self setMaxDocs​(int maxDocs)
        Maximum number of processed documents. Defaults to -1 meaning process all documents.

      • isAbortOnVersionConflict

        public boolean isAbortOnVersionConflict()
        Whether or not version conflicts cause the action to abort.

      • setAbortOnVersionConflict

        public Self setAbortOnVersionConflict​(boolean abortOnVersionConflict)
        Set whether or not version conflicts cause the action to abort.

      • 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?

      • setTimeout

        public Self setTimeout​(java.lang.String 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.

      • 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?

      • getScrollTime

        public TimeValue getScrollTime()
        Get scroll timeout

      • 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

        public abstract Self forSlice​(TaskId slicingTask,
                              SearchRequest slice,
                              int totalSlices)
        Build a new request for a slice of the parent request.

      • doForSlice

        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.

      • createTask

        public Task createTask​(long id,
                       java.lang.String type,
                       java.lang.String action,
                       TaskId parentTaskId,
                       java.util.Map<java.lang.String,​java.lang.String> headers)
        Description copied from interface: TaskAwareRequest
        Returns the task object that should be used to keep track of the processing of the request.

      • 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