DevicesLongRunningOperationResponse
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Suit l'état d'une opération de longue durée pour revendiquer, retirer ou associer des métadonnées aux appareils. Pour en savoir plus, consultez la section Opérations par lot de longue durée.
Représentation JSON |
{
"successCount": integer,
"perDeviceStatus": [
{
object (OperationPerDevice )
}
]
} |
Champs |
successCount |
integer
Résumé du nombre d'éléments de l'opération traités avec succès par le serveur. Ces informations sont mises à jour au fur et à mesure de la progression de l'opération.
|
perDeviceStatus[] |
object (OperationPerDevice )
État de traitement de chaque appareil concerné par l'opération. Offre limitée à PerDeviceStatus par appareil. L'ordre de la liste correspond aux éléments de la requête d'origine.
|
OperationPerDevice
Une tâche pour chaque appareil concerné par l'opération Correspond à chaque modification d'appareil indiquée dans la requête.
Champs |
result |
object (PerDeviceStatusInBatch )
Résultat du traitement pour chaque appareil.
|
Champ d'union request . Contient la requête reçue par le serveur. request ne peut être qu'un des éléments suivants : |
claim |
object (PartnerClaim )
Une copie de la demande initiale de revendication de l'appareil reçue par le serveur.
|
unclaim |
object (PartnerUnclaim )
Une copie de la demande initiale de retrait de revendication de l'appareil reçue par le serveur.
|
updateMetadata |
object (UpdateMetadataArguments )
Copie de la requête de mise à jour des métadonnées d'origine reçue par le serveur.
|
PerDeviceStatusInBatch
Capture l'état de traitement de chaque appareil concerné par l'opération.
Représentation JSON |
{
"status": enum (PerDeviceStatus ),
"deviceId": string,
"errorMessage": string,
"errorIdentifier": string
} |
Champs |
status |
enum (PerDeviceStatus )
État du résultat de l'appareil après le traitement.
|
deviceId |
string (int64 format)
Si le traitement réussit, ID de l'appareil.
|
errorMessage |
string
En cas d'échec du traitement, message du développeur expliquant le problème
|
errorIdentifier |
string
Type d'erreur en cas d'échec du traitement.
|
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[null,null,["Dernière mise à jour le 2025/07/25 (UTC)."],[[["\u003cp\u003eThis document describes the structure for tracking the status of long-running operations related to claiming, unclaiming, or attaching metadata to devices.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003esuccessCount\u003c/code\u003e field provides a summary of the number of items successfully processed within the operation.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eperDeviceStatus\u003c/code\u003e field contains a list of \u003ccode\u003eOperationPerDevice\u003c/code\u003e objects, which detail the processing status for each individual device in the operation.\u003c/p\u003e\n"],["\u003cp\u003eEach \u003ccode\u003eOperationPerDevice\u003c/code\u003e includes a \u003ccode\u003eresult\u003c/code\u003e field that uses the \u003ccode\u003ePerDeviceStatusInBatch\u003c/code\u003e to define the outcome of each device's operation.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003ePerDeviceStatusInBatch\u003c/code\u003e includes fields like \u003ccode\u003estatus\u003c/code\u003e, \u003ccode\u003edeviceId\u003c/code\u003e, \u003ccode\u003eerrorMessage\u003c/code\u003e, and \u003ccode\u003eerrorIdentifier\u003c/code\u003e that will detail if an operation was successful, and if not, to give a description of the failure.\u003c/p\u003e\n"]]],["The provided content outlines the structure for tracking device operations, such as claiming, unclaiming, or updating metadata. Key information includes `successCount`, which reflects the number of successfully processed items. `OperationPerDevice` details individual device tasks with their corresponding request types (`claim`, `unclaim`, or `updateMetadata`). `PerDeviceStatusInBatch` captures each device's processing status, including `status`, `deviceId` (if successful), and `errorMessage` and `errorIdentifier` (if failed).\n"],null,["# DevicesLongRunningOperationResponse\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [OperationPerDevice](#OperationPerDevice)\n - [JSON representation](#OperationPerDevice.SCHEMA_REPRESENTATION)\n- [PerDeviceStatusInBatch](#PerDeviceStatusInBatch)\n - [JSON representation](#PerDeviceStatusInBatch.SCHEMA_REPRESENTATION)\n\nTracks the status of a long-running operation to claim, unclaim, or attach metadata to devices. To learn more, read [Long‑running batch operations](/zero-touch/guides/how-it-works#operations).\n\n| JSON representation ||\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"successCount\": integer, \"perDeviceStatus\": [ { object (/zero-touch/reference/reseller/rest/v1/DevicesLongRunningOperationResponse#OperationPerDevice) } ] } ``` |\n\n| Fields ||\n|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `successCount` | `integer` A summary of how many items in the operation the server processed successfully. Updated as the operation progresses. |\n| `perDeviceStatus[]` | `object (`[OperationPerDevice](/zero-touch/reference/reseller/rest/v1/DevicesLongRunningOperationResponse#OperationPerDevice)`)` The processing status for each device in the operation. One `PerDeviceStatus` per device. The list order matches the items in the original request. |\n\nOperationPerDevice\n------------------\n\nA task for each device in the operation. Corresponds to each device change in the request.\n\n| JSON representation ||\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"result\": { object (/zero-touch/reference/reseller/rest/v1/DevicesLongRunningOperationResponse#PerDeviceStatusInBatch) }, // Union field `request` can be only one of the following: \"claim\": { object (/zero-touch/reference/reseller/rest/v1/partners.devices/claimAsync#PartnerClaim) }, \"unclaim\": { object (/zero-touch/reference/reseller/rest/v1/partners.devices/unclaimAsync#PartnerUnclaim) }, \"updateMetadata\": { object (/zero-touch/reference/reseller/rest/v1/partners.devices/updateMetadataAsync#UpdateMetadataArguments) } // End of list of possible types for union field `request`. } ``` |\n\n| Fields ||\n|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| `result` | `object (`[PerDeviceStatusInBatch](/zero-touch/reference/reseller/rest/v1/DevicesLongRunningOperationResponse#PerDeviceStatusInBatch)`)` The processing result for each device. |\n| Union field `request`. Containing the request received by the server. `request` can be only one of the following: |||\n| `claim` | `object (`[PartnerClaim](/zero-touch/reference/reseller/rest/v1/partners.devices/claimAsync#PartnerClaim)`)` A copy of the original device-claim request received by the server. |\n| `unclaim` | `object (`[PartnerUnclaim](/zero-touch/reference/reseller/rest/v1/partners.devices/unclaimAsync#PartnerUnclaim)`)` A copy of the original device-unclaim request received by the server. |\n| `updateMetadata` | `object (`[UpdateMetadataArguments](/zero-touch/reference/reseller/rest/v1/partners.devices/updateMetadataAsync#UpdateMetadataArguments)`)` A copy of the original metadata-update request received by the server. |\n\nPerDeviceStatusInBatch\n----------------------\n\nCaptures the processing status for each device in the operation.\n\n| JSON representation ||\n|------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"status\": enum (/zero-touch/reference/reseller/rest/v1/PerDeviceStatus), \"deviceId\": string, \"errorMessage\": string, \"errorIdentifier\": string } ``` |\n\n| Fields ||\n|-------------------|------------------------------------------------------------------------------------------------------------------------------------------|\n| `status` | `enum (`[PerDeviceStatus](/zero-touch/reference/reseller/rest/v1/PerDeviceStatus)`)` The result status of the device after processing. |\n| `deviceId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` If processing succeeds, the device ID of the device. |\n| `errorMessage` | `string` If processing fails, a developer message explaining what went wrong. |\n| `errorIdentifier` | `string` If processing fails, the error type. |"]]