DevicesLongRunningOperationResponse
Stay organized with collections
Save and categorize content based on your preferences.
Tracks the status of a long-running operation to claim, unclaim, or attach metadata to devices. To learn more, read Long‑running batch operations.
| JSON representation |
{
"successCount": integer,
"perDeviceStatus": [
{
object (OperationPerDevice)
}
]
} |
| Fields |
successCount |
integer
A summary of how many items in the operation the server processed successfully. Updated as the operation progresses.
|
perDeviceStatus[] |
object (OperationPerDevice)
The processing status for each device in the operation. One PerDeviceStatus per device. The list order matches the items in the original request.
|
OperationPerDevice
A task for each device in the operation. Corresponds to each device change in the request.
| Fields |
result |
object (PerDeviceStatusInBatch)
The processing result for each device.
|
Union field request. Containing the request received by the server. request can be only one of the following: |
claim |
object (PartnerClaim)
A copy of the original device-claim request received by the server.
|
unclaim |
object (PartnerUnclaim)
A copy of the original device-unclaim request received by the server.
|
updateMetadata |
object (UpdateMetadataArguments)
A copy of the original metadata-update request received by the server.
|
PerDeviceStatusInBatch
Captures the processing status for each device in the operation.
| JSON representation |
{
"status": enum (PerDeviceStatus),
"deviceId": string,
"errorMessage": string,
"errorIdentifier": string
} |
| Fields |
status |
enum (PerDeviceStatus)
The result status of the device after processing.
|
deviceId |
string (int64 format)
If processing succeeds, the device ID of the device.
|
errorMessage |
string
If processing fails, a developer message explaining what went wrong.
|
errorIdentifier |
string
If processing fails, the error type.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-08-07 UTC.
[null,null,["Last updated 2024-08-07 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. |"]]