operations

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

Overview

Name	operations
Type	Resource
Id	google.lifesciences.operations

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	The server-assigned name for the operation. This may be passed to the other operation methods to retrieve information about the operation's status.
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: Status)
metadata	object	An Metadata object. This will always be returned with the Operation.
response	object	An Empty object.

list

Successful response

Name	Datatype	Description
name	string	The server-assigned name for the operation. This may be passed to the other operation methods to retrieve information about the operation's status.
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: Status)
metadata	object	An Metadata object. This will always be returned with the Operation.
response	object	An Empty object.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, operationsId		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 requires the following Google IAM permission: * lifesciences.operations.get
list	select	projectsId, locationsId	filter, pageSize, pageToken	Lists operations that match the specified filter in the request. Authorization requires the following Google IAM permission: * lifesciences.operations.list
cancel	exec	projectsId, locationsId, operationsId		Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation. Authorization requires the following Google IAM permission: * lifesciences.operations.cancel

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
locationsId	string
operationsId	string
projectsId	string
filter	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

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 requires the following Google IAM permission: * lifesciences.operations.get

SELECT
name,
done,
error,
metadata,
response
FROM google.lifesciences.operations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND operationsId = '{{ operationsId }}' -- required;

list

Lists operations that match the specified filter in the request. Authorization requires the following Google IAM permission: * lifesciences.operations.list

SELECT
name,
done,
error,
metadata,
response
FROM google.lifesciences.operations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- 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. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation. Authorization requires the following Google IAM permission: * lifesciences.operations.cancel

EXEC google.lifesciences.operations.cancel 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@operationsId='{{ operationsId }}' --required;