Wait for API key operation

Wait for an API key operation to complete.

When you add, update, or delete an API key, the changes might not be immediately visible. This helper method lets you wait until the operation is fully processed.

Usage

The Dart API client has three separate functions, one for each operation.

Wait until an API key is created:

C#

var response = await client.WaitForApiKeyAsync(
  "api-key-add-operation-test-csharp",
  Enum.Parse<ApiKeyOperation>("Add")
);

Wait until an API key is updated:

C#

var response = await client.WaitForApiKeyAsync(
  "api-key-update-operation-test-csharp",
  Enum.Parse<ApiKeyOperation>("Update"),
  new ApiKey
  {
    Description = "my updated api key",
    Acl = new List<Acl>
    {
      Enum.Parse<Acl>("Search"),
      Enum.Parse<Acl>("AddObject"),
      Enum.Parse<Acl>("DeleteObject"),
    },
    Indexes = new List<string> { "Movies", "Books" },
    Referers = new List<string> { "*google.com", "*algolia.com" },
    Validity = 305,
    MaxQueriesPerIPPerHour = 95,
    MaxHitsPerQuery = 20,
  }
);

Wait until an API key is deleted:

C#

var response = await client.WaitForApiKeyAsync(
  "api-key-delete-operation-test-csharp",
  Enum.Parse<ApiKeyOperation>("Delete")
);

Parameters

C#

key · string · required

API key to wait for.

operation · ApiKeyOperation · required

Operation type to wait for. One of: ApiKeyOperation.Add, ApiKeyOperation.Update, or ApiKeyOperation.Delete.

apiKey · ApiKey

API key object. Required for Update operations. For details about the API key properties, see Update API key.

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

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

Dart

key · string · required

API key to wait for.

apiKey · ApiKey

API key object with expected properties. Required for the waitKeyUpdate method. For details about the API key properties, see Update API key.

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

key · string · required

API key to wait for.

operation · ApiKeyOperation · required

Operation type to wait for. One of: search.API_KEY_OPERATION_ADD, search.API_KEY_OPERATION_UPDATE, or search.API_KEY_OPERATION_DELETE.

opts... · WaitForApiKeyOption

Functional options to provide extra arguments.

Show available functions

search.WithApiKey · function

Signature: func(apiKey ApiKey) waitForApiKeyOption

API key object. Required for update operations. For details about the API key properties, see Update API key.

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

key · String · required

API key to wait for.

operation · ApiKeyOperation · required

Operation type to wait for. One of: ApiKeyOperation.ADD, ApiKeyOperation.UPDATE, or ApiKeyOperation.DELETE.

apiKey · ApiKey

API key object. Required for UPDATE operations. For details about the API key properties, see Update API key.

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

key · string · required

API key to wait for.

operation · string · required

Operation type to wait for. One of: add, update, or delete.

apiKey · object

API key object. Required for update operations. For details about the API key properties, see Update API key.

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

key · String · required

API key to wait for.

operation · ApiKeyOperation · required

Operation type to wait for. Can be ApiKeyOperation.Add, ApiKeyOperation.Update, or ApiKeyOperation.Delete.

apiKey · ApiKey

API key object. Required for update operations. For details about the API key properties, see Update API key.

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

key · string · required

API key to wait for.

operation · string · required

Operation type to wait for. One of: add, update, or delete.

apiKey · array

API key object. Required for update operations. For details about the API key properties, see Update API key.

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

key · str · required

API key to wait for.

operation · str · required

Operation type to wait for. One of: add, update, or delete.

api_key · dict | ApiKey

API key object. Required for update operations. For details about the API key properties, see Update API key.

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

key · String · required

API key to wait for.

operation · String · required

Operation type to wait for. One of: add, update, or delete.

api_key · ApiKey

API key object. Required for update operations. For details about the API key properties, see Update API key.

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

key · String · required

API key to wait for.

operation · ApiKeyOperation · required

Operation type to wait for. One of: ApiKeyOperation.Add, ApiKeyOperation.Update, or ApiKeyOperation.Delete.

apiKey · Option[ApiKey]

API key object. Required for update operations. For details about the API key properties, see Update API key.

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

key · String · required

API key to wait for.

operation · ApiKeyOperation · required

Operation type to wait for. One of: ApiKeyOperation.add, ApiKeyOperation.update, or ApiKeyOperation.delete.

apiKey · ApiKey

API key object. Required for update operations. For details about the API key properties, see Update API key.

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.