Package google.longrunning

AI-generated Key Takeaways

• The Operation resource represents a long-running operation initiated by a network API call, containing details about its progress and outcome.

• Operations are identified by a unique name and can include service-specific metadata for progress tracking.

• The done field indicates operation completion status, with error or response providing details upon completion.

• The operation's outcome is represented by either an error object for failures or a response object for successes, depending on the original method's expected return type.

Index

• Operation (message)

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, the name should be a resource name ending with operations/{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 is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
Union field result. The operation result, which can be either an error or a valid response. If done == false, neither error nor response is set. If done == true, exactly one of error or response is set. 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 response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.