Has pending mappings

Required API Key: Admin

Method signature

$client->hasPendingMappings([
    // All the following parameters are optional
    'retrieveMappings' => bool,
]);

client.pending_mappings?(Hash opts = {
    Boolean retrieveMappings: false,
})

client.hasPendingMappings({
  // All the following parameters are optional
  retrieveMappings: bool,
})

client.has_pending_mappings({
    // All the following parameters are optional
    'retrieveMappings': bool,
})

client.hasPendingMappings(
  // All the following parameters are optional
  retrieveMappings: Bool = false,
  requestOptions: RequestOptions? = nil,
  completion: Result<HasPendingMappingResponse> -> Void
)

suspend fun hasPendingMapping(
    // All the following parameters are optional
    retrieveMappings: Boolean = false,
): ResponseHasPendingMapping

client.HasPendingMappings(
  // All the following parameters are optional
  retrieveMappings: bool,
)

client.hasPendingMappings(
  // All the following parameters are optional
  retrieveMappings: bool,
)

client.HasPendingMappings(
  // All the following parameters are optional
  opt.RetrieveMappings(retrieveMappings: bool),
)

client.execute {
  // All the following parameters are optional
  has pendingMappings(retrieveMappings: bool)
}

See code examples

We released a new version of the PHP API client in public beta. Read the beta documentation for more information.

We released a new version of the JavaScript API client in public beta. Read the beta documentation for more information.

We released a new version of the Java API client in public beta. Read the beta documentation for more information.

You’re currently reading the JavaScript API client v4 documentation. Check the migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.

You’re currently reading the Ruby API client v2 documentation. Check the migration guide to learn how to upgrade from v1 to v2. You can still access the v1 documentation.

About this method

Get the status of your clusters’ migrations or user creations.

Creating a large batch of users or migrating your multi-cluster may take quite some time. This method lets you retrieve the status of the migration, so you can know when it’s done.

Examples

Read the Algolia CLI documentation for more information.