buildgrid.server.operations.service module

OperationsService

class buildgrid.server.operations.service.OperationsService

FULL_NAME: ClassVar[str] = 'google.longrunning.Operations': The full name of the servicer, used to match instances to the servicer and configure reflection. This value should be declared on the class of any Servicer implementations.

GetOperation(request: GetOperationRequest, context: ServicerContext) → 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.

ListOperations(request: ListOperationsRequest, context: ServicerContext) → ListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn’t support this method, it returns UNIMPLEMENTED.

NOTE: the name binding below allows API services to override the binding to use different resource name schemes, such as users/*/operations.

DeleteOperation(request: DeleteOperationRequest, context: ServicerContext) → Empty: 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.

CancelOperation(request: CancelOperationRequest, context: ServicerContext) → Empty: 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][google.longrunning.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][google.longrunning.Operation.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to Code.CANCELLED.

get_instance(instance_name: str) → OperationsInstance

Provides a wrapper to access the instance, throwing a InvalidArgumentError if the instance requested does not exist.

This method may be overriden if you wish to create a custom error message.