Package google.longrunning

Index

Operations

Manages long-running operations with an API service.

When an API method normally takes long time to complete, it can be designed to returnOperation to the client, and the client can use this interface to receive the real response asynchronously by polling the operation resource, or pass the operation resource to another API (such as Pub/Sub API) to receive the response. Any API service that returns long-running operations should implement theOperations interface so developers can have a consistent client experience.

GetOperation

rpc GetOperation(GetOperationRequest) returns (Operation)

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.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloudkms
  • https://www.googleapis.com/auth/cloud-platform

For more information, see theAuthentication Overview.

IAM Permissions

Requires the followingIAM permission on thename resource:

  • cloudkms.operations.get

For more information, see theIAM documentation.

GetOperationRequest

The request message forOperations.GetOperation.

Fields
name

string

The name of the operation resource.

Operation

This resource represents a long-running operation that is the result of a network API call.

Fields
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, thename should be a resource name ending withoperations/{unique_id}.

metadata

Any

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

done

bool

If the value isfalse, it means the operation is still in progress. Iftrue, the operation is completed, and eithererror orresponse is available.

Union fieldresult. The operation result, which can be either anerror or a validresponse. Ifdone ==false, neithererror norresponse is set. Ifdone ==true, exactly one oferror orresponse can be set. Some services might not provide the result.result can be only one of the following:
error

Status

The error result of the operation in case of failure or cancellation.

response

Any

The normal, successful response of the operation. If the original method returns no data on success, such asDelete, the response isgoogle.protobuf.Empty. If the original method is standardGet/Create/Update, the response should be the resource. For other methods, the response should have the typeXxxResponse, whereXxx is the original method name. For example, if the original method name isTakeSnapshot(), the inferred response type isTakeSnapshotResponse.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-24 UTC.