DevicesLongRunningOperationResponse

  • This document describes the structure for tracking the status of long-running operations related to claiming, unclaiming, or attaching metadata to devices.

  • The successCount field provides a summary of the number of items successfully processed within the operation.

  • The perDeviceStatus field contains a list of OperationPerDevice objects, which detail the processing status for each individual device in the operation.

  • Each OperationPerDevice includes a result field that uses the PerDeviceStatusInBatch to define the outcome of each device's operation.

  • PerDeviceStatusInBatch includes fields like status, deviceId, errorMessage, and errorIdentifier that will detail if an operation was successful, and if not, to give a description of the failure.

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.

JSON representation 
{
  "result": {
    object (PerDeviceStatusInBatch)
  },

  // Union field request can be only one of the following:
  "claim": {
    object (PartnerClaim)
  },
  "unclaim": {
    object (PartnerUnclaim)
  },
  "updateMetadata": {
    object (UpdateMetadataArguments)
  }
  // End of list of possible types for union field 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.