API Reference / API Methods / MultiClusters / Has pending mappings

Nov. 12, 2020

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

This method is not yet available in the Android API client.

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

About this method

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

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

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