operations

Creates, updates, deletes, gets or lists an operations resource.

Overview

Name	operations
Type	Resource
Id	google.storage.operations

Fields

The following fields are returned by SELECT queries:

get

Successful response

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/{operationId}".
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 error result of the operation in case of failure or cancellation. (id: GoogleRpcStatus)
kind	string	The kind of item this is. For operations, this is always storage#operation. (default: storage#operation)
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 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".
selfLink	string	The link to this long running operation.

list

Successful response

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/{operationId}".
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 error result of the operation in case of failure or cancellation. (id: GoogleRpcStatus)
kind	string	The kind of item this is. For operations, this is always storage#operation. (default: storage#operation)
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 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".
selfLink	string	The link to this long running operation.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	bucket, operationId		Gets the latest state of a long-running operation.
list	select	bucket	filter, pageSize, pageToken	Lists operations that match the specified filter in the request.
cancel	exec	bucket, operationId		Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed.
advance_relocate_bucket	exec	bucket, operationId		Starts asynchronous advancement of the relocate bucket operation in the case of required write downtime, to allow it to lock the bucket at the source location, and proceed with the bucket location swap. The server makes a best effort to advance the relocate bucket operation, but success is not guaranteed.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
bucket	string
operationId	string
filter	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Gets the latest state of a long-running operation.

SELECT
name,
done,
error,
kind,
metadata,
response,
selfLink
FROM google.storage.operations
WHERE bucket = '{{ bucket }}' -- required
AND operationId = '{{ operationId }}' -- required;

list

Lists operations that match the specified filter in the request.

SELECT
name,
done,
error,
kind,
metadata,
response,
selfLink
FROM google.storage.operations
WHERE bucket = '{{ bucket }}' -- required
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

Lifecycle Methods

cancel

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed.

EXEC google.storage.operations.cancel 
@bucket='{{ bucket }}' --required, 
@operationId='{{ operationId }}' --required;

advance_relocate_bucket

Starts asynchronous advancement of the relocate bucket operation in the case of required write downtime, to allow it to lock the bucket at the source location, and proceed with the bucket location swap. The server makes a best effort to advance the relocate bucket operation, but success is not guaranteed.

EXEC google.storage.operations.advance_relocate_bucket 
@bucket='{{ bucket }}' --required, 
@operationId='{{ operationId }}' --required 
@@json=
'{
"ttl": "{{ ttl }}", 
"expireTime": "{{ expireTime }}"
}';