com.algolia.search.objects

Class GenericTask<T>

java.lang.Object

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

Direct Known Subclasses:

Task, TasksMultipleIndex

public abstract class GenericTask<T>
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected APIClient	apiClient
protected String	indexName

Constructor Summary

Constructors

Constructor and Description
GenericTask()

Method Summary

Modifier and Type	Method and Description
T	getTaskID()
abstract Long	getTaskIDToWaitFor()
GenericTask<T>	setAttributes(String indexName, APIClient apiClient)
GenericTask	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 java.lang.Object

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

Field Detail

apiClient

protected APIClient apiClient

indexName

protected String indexName

Constructor Detail

GenericTask

public GenericTask()

Method Detail

setAttributes

public GenericTask<T> setAttributes(String indexName,
                                    APIClient apiClient)

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

getTaskID

public T getTaskID()

setTaskID

public GenericTask setTaskID(T taskID)

getTaskIDToWaitFor

public abstract Long getTaskIDToWaitFor()