Get

Gets the latest state of a long-running operation

1 variables
11 variables

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service

Input

This building block consumes 1 input parameters

  = Parameter name
  = Format

name STRING Required

The name of the operation resource

Output

This building block provides 11 output parameters

  = Parameter name
  = Format

name STRING

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}

error OBJECT

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details.

You can find out more about this error model and how to work with it in the API Design Guide

error.details[] OBJECT

error.details[].customKey.value ANY

error.code INTEGER

The status code, which should be an enum value of google.rpc.Code

error.message STRING

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client

metadata OBJECT

This field will contain a DevicesLongRunningOperationMetadata object if the operation is created by claimAsync, unclaimAsync, or updateMetadataAsync

metadata.customKey.value ANY

This field will contain a DevicesLongRunningOperationMetadata object if the operation is created by claimAsync, unclaimAsync, or updateMetadataAsync

done BOOLEAN

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available

response OBJECT

This field will contain a DevicesLongRunningOperationResponse object if the operation is created by claimAsync, unclaimAsync, or updateMetadataAsync

response.customKey.value ANY

This field will contain a DevicesLongRunningOperationResponse object if the operation is created by claimAsync, unclaimAsync, or updateMetadataAsync