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/cloudfunctions
• https://www.googleapis.com/auth/cloud-platform

For more information, see theAuthentication Overview.

rpc ListOperations(ListOperationsRequest) returns (ListOperationsResponse)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returnsUNIMPLEMENTED.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see theAuthentication Overview.

rpc WaitOperation(WaitOperationRequest) returns (Operation)

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returnsgoogle.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see theAuthentication Overview.

string

The name of the operation resource.

string

v1:

This field shouldn't be set for v1 operations.

v2:

The name of the operation's parent resource.

string

v1:

Required. A filter for matching the requested operations.

The supported formats offilter are:
To query for a specific function:

project:*,location:*,function:*

To query for all of the latest operations for a project:

project:*,latest:true

v2:

The standard list filter.

int32

v1:

The maximum number of records that should be returned.
Requested page size cannot exceed 100. If not set, the default page size is 100.

Pagination is only supported when querying for a specific function.

v2:

The standard list page size.

string

v1:

Token identifying which result to start with, which is returned by a previous list call.

Pagination is only supported when querying for a specific function.

v2:

The standard list page token.

Operation

A list of operations that matches the specified filter in the request.

string

The standard List next-page token.

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}.

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.

bool

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

Status

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

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.

string

The name of the operation resource to wait on.

Duration

The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.