operations

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

Overview

Name	operations
Type	Resource
Id	gemini.models.operations

Fields

The following fields are returned by SELECT queries:

get

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 error result of the operation in case of failure or cancellation.
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`.

list

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 error result of the operation in case of failure or cancellation.
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

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	modelsId, 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.
list	select	modelsId	returnPartialSuccess, filter	Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

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
modelsId	string
operationsId	string
filter	string	The standard list filter.
returnPartialSuccess	boolean	When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be true when reading across collections. For example, when parent is set to "projects/example/locations/-". This field is not supported by default and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.

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.

SELECT
name,
done,
error,
metadata,
response
FROM gemini.models.operations
WHERE modelsId = '{{ modelsId }}' -- required
AND operationsId = '{{ operationsId }}' -- required
;

list

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 gemini.models.operations
WHERE modelsId = '{{ modelsId }}' -- required
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
AND filter = '{{ filter }}'
;