Package com.algolia.search.objects.tasks.sync

Class Task

java.lang.Object

com.algolia.search.objects.tasks.AbstractTask<T>

com.algolia.search.objects.tasks.sync.GenericTask<Long>

com.algolia.search.objects.tasks.sync.Task

Direct Known Subclasses:

TaskIndexing, TaskSingleIndex

public class Task
extends GenericTask<Long>

Field Summary

Fields inherited from class com.algolia.search.objects.tasks.AbstractTask

indexName, taskID

Constructor Summary

Constructors

Constructor	Description
Task()

Method Summary

Modifier and Type	Method	Description
Long	getTaskIDToWaitFor()
Task	setAPIClient(APIClient apiClient)
Task	setIndex(String indexName)
String	toString()
void	waitForCompletion()	Wait for the completion of this task
void	waitForCompletion(long timeToWait)	Wait for the completion of this task
void	waitForCompletion(long timeToWait, RequestOptions requestOptions)	Wait for the completion of this task
void	waitForCompletion(RequestOptions requestOptions)	Wait for the completion of this task

Methods inherited from class com.algolia.search.objects.tasks.AbstractTask

getIndexName, getTaskID

Methods inherited from class com.algolia.search.objects.tasks.sync.GenericTask

setTaskID

Methods inherited from class java.lang.Object

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

Constructor Detail

Task

public Task()

Method Detail

setAPIClient

public Task setAPIClient(APIClient apiClient)

Overrides:

setAPIClient in class GenericTask<Long>

waitForCompletion

public void waitForCompletion()
                       throws AlgoliaException

Wait for the completion of this task

Overrides:

waitForCompletion in class GenericTask<Long>

Throws:

AlgoliaException

waitForCompletion

public void waitForCompletion(long timeToWait)
                       throws AlgoliaException

Wait for the completion of this task

Overrides:

waitForCompletion in class GenericTask<Long>

Parameters:

timeToWait - the time to wait in milliseconds

Throws:

AlgoliaException

waitForCompletion

public void waitForCompletion(@Nonnull
                              RequestOptions requestOptions)
                       throws AlgoliaException

Wait for the completion of this task

Parameters:

requestOptions - Options to pass to this request

Throws:

AlgoliaException

waitForCompletion

public void waitForCompletion(long timeToWait,
                              @Nonnull
                              RequestOptions requestOptions)
                       throws AlgoliaException

Wait for the completion of this task

Parameters:

timeToWait - the time to wait in milliseconds

requestOptions - Options to pass to this request

Throws:

AlgoliaException

getTaskIDToWaitFor

public Long getTaskIDToWaitFor()

Specified by:

getTaskIDToWaitFor in class AbstractTask<Long>

setIndex

public Task setIndex(String indexName)

Overrides:

setIndex in class GenericTask<Long>

toString

public String toString()

Overrides:

toString in class Object