Wait for task

Wait for an index-level task to complete.

Indexing operations are asynchronous. When you send a request to add or update records, Algolia queues the operation and returns a taskID in the response. The task runs separately, depending on the server load.

This helper method polls the Check task status API and stops if the task’s status is published.

Usage

C#

var response = await client.WaitForTaskAsync("INDEX_NAME", 123L);

response, err := client.WaitForTask(
  "INDEX_NAME", 123)
if err != nil {
  // handle the eventual error
  panic(err)
}

GetTaskResponse response = client.waitForTask("INDEX_NAME", 123L);

const response = await client.waitForTask({ indexName: 'wait-task-javascript', taskID: 123 });

var response = client.waitForTask(indexName = "INDEX_NAME", taskID = 123L)

$response = $client->waitForTask(
    'INDEX_NAME',
    123,
);

response = client.wait_for_task(
    index_name="INDEX_NAME",
    task_id=123,
)

response = client.wait_for_task("INDEX_NAME", 123)

val response = Await.result(
  client.waitForTask(
    indexName = "INDEX_NAME",
    taskID = 123L
  ),
  Duration(100, "sec")
)

let response = try await client.waitForTask(indexName: "INDEX_NAME", taskID: Int64(123))

Parameters

C#

indexName · string · required

Index name where the task was executed.

taskId · long · required

Task ID to wait for.

maxRetries · int · default: 50

Maximum number of retries for checking the status.

timeout · Func<int,int>

Returns a timeout based on the current number of iterations.

requestOptions · RequestOptions

Additional request options.

cancellationToken · CancellationToken · default: "default"

Parameter that can be used as a signal to cancel this request.

Dart

indexName · string · required

Index name where the task was executed.

taskID · int · required

Task ID to wait for.

params · WaitParams

Hide child attributes

maxRetries · int · default: 50

Maximum number of retries for checking the status.

timeout · Duration

Timeout in milliseconds after which an exception is thrown.

initialDelay · Duration · default: "200 ms"

Initial delay after which to check for the status for the first time.

maxDelay · Duration · default: "5 s"

Maximum delay between status checks.

requestOptions · RequestOptions

Additional request options.

Go

indexName · string · required

Index name where the task was executed.

taskID · int64 · required

Task ID to wait for.

opts... · IterableOption

Functional options to provide extra arguments.

Show available functions

search.WithMaxRetries · function

Signature: func(maxRetries int) iterableOption

Sets the maximum number of retries for this method.

search.WithTimeout · function

Signature: func(count int) time.Duration

Returns a timeout based on the current number of iterations.

search.WithHeaderParam · function

Signature: func(key string, value string) requestOption

Sets extra header parameters for this request. To learn more, see request options.

search.WithQueryParam · function

Signature: func(key string, value string) requestOption

Sets extra query parameters for this request. To learn more, see request options.

Java

indexName · String · required

Index name where the task was executed.

taskID · long · required

Task ID to wait for.

maxRetries · int · default: 50

Maximum number of retries for checking the status.

timeout · function

Default: (int retries) -> Math.min(retries * 200, 5000)

Returns the time between status checks based on the current number of iterations. By default, the initial delay is 200 milliseconds. With every iteration, the delay increases by 200 milliseconds, until a maximum of 5 seconds is reached.

requestOptions · RequestOptions

Additional request options.

JavaScript

indexName · string · required

Index name where the task was executed.

taskID · number · required

Task ID to wait for.

maxRetries · number · default: 50

Maximum number of retries for checking the status.

timeout · function

Default: (retryCount: number) -> Math.min(retryCount * 200, 5000)

Returns the time between status checks based on the current number of iterations. By default, the initial delay is 200 milliseconds. With every iteration, the delay increases by 200 milliseconds, until a maximum of 5 seconds is reached.

requestOptions · RequestOptions

Additional request options.

Kotlin

indexName · String · required

Index name where the task was executed.

taskID · Long · required

Task ID to wait for.

maxRetries · int · default: 50

Maximum number of retries for checking the status.

initialDelay · Duration · default: "200 ms"

Time after which the status is checked for the first time. This time is doubled after every check until it reaches the value set by maxDelay.

maxDelay · Duration · default: "5 seconds"

Maximum time to wait between status checks.

requestOptions · RequestOptions

Additional request options.

PHP

indexName · string · required

Index name where the task was executed.

taskId · int · required

Task ID to wait for.

maxRetries · int · default: 50

Maximum number of retries for checking the status.

timeout · int · default: 5000

Number of milliseconds between status checks.

requestOptions · array

Additional request options.

Python

index_name · str · required

Index name where the task was executed.

task_id · int · required

Task ID to wait for.

max_retries · int · default: 50

Maximum number of retries for checking the status.

timeout · Callable[[int], int]

Default: min(retry_count*0.2, 5)

Returns the time between status checks based on the current number of iterations. By default, the initial delay is 200 milliseconds. With every iteration, the delay increases by 200 milliseconds, until a maximum of 5 seconds is reached.

request_options · dict | RequestOptions

Additional request options.

Ruby

index_name · String · required

Index name where the task was executed.

task_id · Integer · required

Task ID to wait for.

max_retries · Integer · default: 50

Maximum number of retries for checking the status.

timeout · function

Default: [retry_count * 200, 5000].min

Returns the time between status checks based on the current number of iterations. By default, the initial delay is 200 milliseconds. With every iteration, the delay increases by 200 milliseconds, until a maximum of 5 seconds is reached.

request_options · Hash

Additional request options.

Scala

indexName · String · required

Index name where the task was executed.

taskID · Long · required

Task ID to wait for.

maxRetries · int · default: 50

Maximum number of retries for checking the status.

delay · Long => Long

Default: (retries: Long) => Math.min(retries * 200, 5000)

Returns the time between status checks based on the current number of iterations. By default, the initial delay is 200 milliseconds. With every iteration, the delay increases by 200 milliseconds, until a maximum of 5 seconds is reached.

requestOptions · RequestOptions

Additional request options.

Swift

indexName · String · required

Index name where the task was executed.

taskID · Int64 · required

Task ID to wait for.

maxRetries · int · default: 50

Maximum number of retries for checking the status.

timeout · (int) -> TimeInterval

Default: (retryCount) -> min(TimeInterval(retryCount) * 0.2, 5)

Returns the time between status checks based on the current number of iterations. By default, the initial delay is 200 milliseconds. With every iteration, the delay increases by 200 milliseconds, until a maximum of 5 seconds is reached.

requestOptions · RequestOptions

Additional request options.