com.algolia.search.objects

Class Task

java.lang.Object

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

com.algolia.search.objects.Task

Direct Known Subclasses:

TaskIndexing, TaskSingleIndex

public class Task
extends GenericTask<Long>

Field Summary

Fields inherited from class com.algolia.search.objects.GenericTask

apiClient, indexName

Constructor Summary

Constructors

Constructor and Description
Task()

Method Summary

Modifier and Type	Method and Description
Long	getTaskIDToWaitFor()
Task	setAttributes(String indexName, APIClient apiClient)
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.GenericTask

getTaskID, setTaskID

Methods inherited from class java.lang.Object

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

Constructor Detail

Task

public Task()

Method Detail

setAttributes

public Task setAttributes(String indexName,
                          APIClient apiClient)

Overrides:

setAttributes 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

getTaskIDToWaitFor

public Long getTaskIDToWaitFor()

Specified by:

getTaskIDToWaitFor in class GenericTask<Long>