operations
Creates, updates, deletes, gets or lists a operations resource.
Overview
| Name | operations |
| Type | Resource |
| Id | google.apim.operations |
Fields
| Name | Datatype | Description |
|---|---|---|
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}. |
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. |
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. |
metadata | object | 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. |
response | object | The normal, successful response of the operation. 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. |
Methods
| Name | Accessible by | Required Params | Description |
|---|---|---|---|
get | SELECT | locationsId, operationsId, projectsId | 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. |
list | SELECT | locationsId, projectsId | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. |
delete | DELETE | locationsId, operationsId, projectsId | Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. |
cancel | EXEC | locationsId, operationsId, projectsId | Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED. |
SELECT examples
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.
SELECT
name,
done,
error,
metadata,
response
FROM google.apim.operations
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';
DELETE example
Deletes the specified operations resource.
/*+ delete */
DELETE FROM google.apim.operations
WHERE locationsId = '{{ locationsId }}'
AND operationsId = '{{ operationsId }}'
AND projectsId = '{{ projectsId }}';