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.

About this method # A

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 # A

Has pending mappings#

Copy

1
$client->hasPendingMappings(true);

Parameters # A

Parameter	Description
`retrieveMappings` #	type: boolean default: false Optional When `true`, the API returns an object with all pending migrations for each cluster. The objects’ keys are the names of clusters with a pending status, the values are arrays of strings containing the mapping IDs that are currently pending.

Response # A

This section shows the JSON response returned by the API. Each API client encapsulates this response inside objects specific to the programming language, so that the actual response might be different. You can view the response by using the getLogs method. Don’t rely on the order of attributes in the response, as JSON doesn’t guarantee the ordering of keys in objects.

JSON format#

Copy

          {
  "pending": true,
  "clusters": {
    "cluster_1": [
      'user1',
      'user2',
      'user...',
      'user99999'
    ]
  }
}

        

Field	Description
`pending` #	boolean Whether there are any pending migrations on your cluster.
`clusters` #	object Only returned when the `retrieveMappings` parameter is set to `true`. The objects’ keys are the names of clusters with a pending status, the values are arrays of strings containing the mapping IDs that are currently pending.

Did you find this page helpful?

Has pending mappings

About this method # Found an issue? Edit this page A Edit this page

Examples # Found an issue? Edit this page A Edit this page

Has pending mappings#

Parameters # Found an issue? Edit this page A Edit this page

Response # Found an issue? Edit this page A Edit this page

JSON format#

On this page

About this method # A

Examples # A

Parameters # A

Response # A