com.algolia.search.objects.tasks.sync

Class GenericTask<T>

java.lang.Object

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

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

Direct Known Subclasses:

Task, TasksMultipleIndex

public abstract class GenericTask<T>
extends AbstractTask<T>

Field Summary

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

indexName, taskID

Constructor Summary

Constructors

Constructor and Description
GenericTask()

Method Summary

Modifier and Type	Method and Description
GenericTask<T>	setAPIClient(APIClient apiClient)
GenericTask<T>	setIndex(String indexName)
GenericTask<T>	setTaskID(T taskID)
void	waitForCompletion() Wait for the completion of this task
void	waitForCompletion(long timeToWait) Wait for the completion of this task

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

getIndexName, getTaskID, getTaskIDToWaitFor

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericTask

public GenericTask()

Method Detail

setAPIClient

public GenericTask<T> setAPIClient(APIClient apiClient)

setIndex

public GenericTask<T> setIndex(String indexName)

Overrides:

setIndex in class AbstractTask<T>

waitForCompletion

public void waitForCompletion()
                       throws AlgoliaException

Wait for the completion of this task

Throws:

AlgoliaException

waitForCompletion

public void waitForCompletion(long timeToWait)
                       throws AlgoliaException

Wait for the completion of this task

Parameters:

timeToWait - the time to wait in milliseconds

Throws:

AlgoliaException

setTaskID

public GenericTask<T> setTaskID(T taskID)

Overrides:

setTaskID in class AbstractTask<T>