Google.LongRunning
A long-running operation with an associated client, and which knows the expected response type.
For simplicity, no methods on this type modify the proto message. Instead, to get up-to-date
information you can use Refresh to obtain a new instance.
If the operation was created with a different major version of the service API than expected,
the metadata and response values may not be of the expected type. There are three approaches to handling this:
-
To fail with an exception if an unexpected type of value is present, use the
and properties.
-
To receive a null reference if an unexpected type of value is present, use the
and methods. You can then check the returned value and ignore nulls.
-
To handle multiple types, use the property and its and
properties, of type . You can then use to determine the type of the value to unpack, or
with each type you support.
The response message type.
The metata message type.
The poll settings to use if the neither the OperationsClient nor the caller provides anything.
The protobuf message associated with the long-running operation, containing the name (for
further retrieval) and any error/result already computed. This should not be mutated.
The client to use when making RPCs.
Constructs a new instance from the given RPC message.
The RPC message describing the operation. Must not be null.
The client to use for further calls. Must not be null.
Returns the name of the operation, which can be persisted and used to poll for the latest
results at a later time or in a different program.
Only the in-memory representation of the operation (this object) is consulted for its state.
Whether the operation has completed, where "complete" can include "failed".
Only the in-memory representation of the operation (this object) is consulted for its state.
Whether the operation has completed with a failure.
The error associated with the operation, as an , or null
if the operation is not in an error state (either because it completed successfully, or because it
has not yet completed).
Only the in-memory representation of the operation (this object) is consulted for its state.
Retrieves the metadata associated with this operation, or null if there is no
metadata in the underlying response message.
Only the in-memory representation of the operation (this object) is consulted for its state.
See the documentation for information about dealing with different metadata type versions.
Metadata is present, but is not of the expected type.
Retrieves the metadata associated with this operation, or null if either there is no
metadata in the underlying response message, or it does not have the expected type.
Only the in-memory representation of the operation (this object) is consulted for its state.
See the documentation for information about dealing with different metadata type versions.
The metadata of the operation if possible, or null otherwise.
Retrieves the result of the operation, throwing an exception if the operation failed, hasn't completed,
or has an unexpected result type. Unlike , this does not block.
If the operation has completed but the result is not present (for example due to being excluded by
a field mask) this returns null.
Only the in-memory representation of the operation (this object) is consulted for its state.
See the documentation for information about dealing with different response type versions.
The operation completed with an error.
The operation has not completed yet, or the result is present but
not of the expected result type.
Retrieves the result of the operation, or null if the operation failed, hasn't completed, has an
unexpected result type, or didn't contain a result at all.
Only the in-memory representation of the operation (this object) is consulted for its state.
See the documentation for information about dealing with different response type versions.
The result of the operation if possible, or null otherwise.
Polls the operation until it is complete, returning the completed operation.
If this object already represents a completed operation, it is returned with no further RPCs.
If is non-null, the callback will be called with any metadata
present before the result is returned.
Each callback is performed synchronously: this method waits for the callback to complete before the operation is next polled.
This guarantees that for a single call, metadata callbacks will never occur in parallel.
The settings to use for repeated polling, or null
to use the default poll settings (poll once every 10 seconds, forever).
The call settings to apply on each call, or null for default settings.
The callback to invoke with the metadata from each poll operation, even if the metadata is null.
The completed operation, which can then be checked for errors or a result.
Asynchronously polls the operation until it is complete, returning the completed operation.
If this object already represents a completed operation, it is returned with no further RPCs.
If is non-null, the callback will be called with any metadata
present before the result is returned.
No guarantee is made as to which thread is used for metadata callbacks. However, each callback is
performed synchronously: this method waits for the callback to complete before the operation is next polled.
This guarantees that for a single call, metadata callbacks will never occur in parallel.
The settings to use for repeated polling, or null
to use the default poll settings (poll once every 10 seconds, forever).
The call settings to apply on each call, or null for default settings.
The callback to invoke with the metadata from each poll operation, even if the metadata is null.
The completed operation, which can then be checked for errors or a result.
Returns a new instance reflecting the most recent state of the operation.
Any overriding call settings to apply to the RPC.
The most recent state of the operation, or a reference to the same
object if the operation has already completed.
Asynchronously returns a new instance reflecting the most recent state of the operation.
Any overriding call settings to apply to the RPC.
A task representing the asynchronous poll operation. The result of the task is
the most recent state of the operation, or a reference to the same
object if the operation has already completed.
Asynchronously returns a new instance reflecting the most recent state of the operation.
A cancellation token for the poll operation.
A task representing the asynchronous poll operation. The result of the task is
the most recent state of the operation, or a reference to the same
object if the operation has already completed.
Attempts to cancel the long-running operation.
Any overriding call settings to apply to the RPC.
Asynchronously attempts to cancel the long-running operation.
Any overriding call settings to apply to the RPC.
A task representing the asynchronous cancel operation.
Asynchronously attempts to cancel the long-running operation.
A cancellation token for the cancel RPC.
Note that this is not a cancellation token for the long-running operation itself.
A task representing the asynchronous cancel operation.
Deletes the long-running operation. This does not cancel it; it
only indicates that the client is no longer interested in the result.
Any overriding call settings to apply to the RPC.
Asynchronously deletes the long-running operation. This does not cancel it; it
only indicates that the client is no longer interested in the result.
Any overriding call settings to apply to the RPC.
A task representing the asynchronous deletion operation.
Asynchronously deletes the long-running operation. This does not cancel it; it
only indicates that the client is no longer interested in the result.
A cancellation token for the cancel RPC.
Note that this is not a cancellation token for the long-running operation itself.
A task representing the asynchronous deletion operation.
Creates a new instance reflecting the most recent state of the operation with the specified name.
The name of the operation, as returned when it was created. Must not be null.
The client to make the RPC call.
Any overriding call settings to apply to the RPC. May be null, in which case
the default settings are used.
The current state of the operation identified by .
Asynchronously creates a new instance reflecting the most recent state of the operation with the specified name.
The name of the operation, as returned when it was created. Must not be null.
The client to make the RPC call.
Any overriding call settings to apply to the RPC. May be null, in which case
the default settings are used.
A task representing the asynchronous "fetch" operation. The result of the task is
the current state of the operation identified by .
Asynchronously creates a new instance reflecting the most recent state of the operation with the specified name.
The name of the operation, as returned when it was created. Must not be null.
The client to make the RPC call.
A cancellation token for the "fetch" operation.
A task representing the asynchronous "fetch" operation. The result of the task is
the current state of the operation identified by .
An exception to indicate that a long-running operation failed.
The operation message containing the original error.
The status message within the operation's error field.
Constructs an exception based on a protobuf message representing a failed operation.
The failed operation. Must not be null, and must have an error.
Holder for reflection information generated from google/longrunning/operations.proto
File descriptor for google/longrunning/operations.proto
This resource represents a long-running operation that is the result of a
network API call.
Field number for the "name" field.
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 have the format of `operations/some/unique/name`.
Field number for the "metadata" field.
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.
Field number for the "done" field.
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.
Field number for the "error" field.
The error result of the operation in case of failure or cancellation.
Field number for the "response" field.
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`.
Enum of possible cases for the "result" oneof.
The request message for [Operations.GetOperation][google.longrunning.Operations.GetOperation].
Field number for the "name" field.
The name of the operation resource.
The request message for [Operations.ListOperations][google.longrunning.Operations.ListOperations].
Field number for the "name" field.
The name of the operation collection.
Field number for the "filter" field.
The standard list filter.
Field number for the "page_size" field.
The standard list page size.
Field number for the "page_token" field.
The standard list page token.
The response message for [Operations.ListOperations][google.longrunning.Operations.ListOperations].
Field number for the "operations" field.
A list of operations that matches the specified filter in the request.
Field number for the "next_page_token" field.
The standard List next-page token.
Returns an enumerator that iterates through the resources in this response.
The request message for [Operations.CancelOperation][google.longrunning.Operations.CancelOperation].
Field number for the "name" field.
The name of the operation resource to be cancelled.
The request message for [Operations.DeleteOperation][google.longrunning.Operations.DeleteOperation].
Field number for the "name" field.
The name of the operation resource to be deleted.
Settings for a .
Get a new instance of the default .
A new instance of the default .
Constructs a new object with default settings.
The filter specifying which RPC s are eligible for retry
for "Idempotent" RPC methods.
The eligible RPC s for retry for "Idempotent" RPC methods are:
The filter specifying which RPC s are eligible for retry
for "NonIdempotent" RPC methods.
There are no RPC s eligible for retry for "NonIdempotent" RPC methods.
"Default" retry backoff for RPC methods.
The "Default" retry backoff for RPC methods.
The "Default" retry backoff for RPC methods is defined as:
- Initial delay: 100 milliseconds
- Maximum delay: 60000 milliseconds
- Delay multiplier: 1.3
"Default" timeout backoff for RPC methods.
The "Default" timeout backoff for RPC methods.
The "Default" timeout backoff for RPC methods is defined as:
- Initial timeout: 90000 milliseconds
- Timeout multiplier: 1.0
- Maximum timeout: 90000 milliseconds
for synchronous and asynchronous calls to
OperationsClient.GetOperation and OperationsClient.GetOperationAsync.
The default OperationsClient.GetOperation and
OperationsClient.GetOperationAsync are:
- Initial retry delay: 100 milliseconds
- Retry delay multiplier: 1.3
- Retry maximum delay: 60000 milliseconds
- Initial timeout: 90000 milliseconds
- Timeout multiplier: 1.0
- Timeout maximum delay: 90000 milliseconds
Retry will be attempted on the following response status codes:
Default RPC expiration is 600000 milliseconds.
for synchronous and asynchronous calls to
OperationsClient.ListOperations and OperationsClient.ListOperationsAsync.
The default OperationsClient.ListOperations and
OperationsClient.ListOperationsAsync are:
- Initial retry delay: 100 milliseconds
- Retry delay multiplier: 1.3
- Retry maximum delay: 60000 milliseconds
- Initial timeout: 90000 milliseconds
- Timeout multiplier: 1.0
- Timeout maximum delay: 90000 milliseconds
Retry will be attempted on the following response status codes:
Default RPC expiration is 600000 milliseconds.
for synchronous and asynchronous calls to
OperationsClient.CancelOperation and OperationsClient.CancelOperationAsync.
The default OperationsClient.CancelOperation and
OperationsClient.CancelOperationAsync are:
- Initial retry delay: 100 milliseconds
- Retry delay multiplier: 1.3
- Retry maximum delay: 60000 milliseconds
- Initial timeout: 90000 milliseconds
- Timeout multiplier: 1.0
- Timeout maximum delay: 90000 milliseconds
Retry will be attempted on the following response status codes:
Default RPC expiration is 600000 milliseconds.
for synchronous and asynchronous calls to
OperationsClient.DeleteOperation and OperationsClient.DeleteOperationAsync.
The default OperationsClient.DeleteOperation and
OperationsClient.DeleteOperationAsync are:
- Initial retry delay: 100 milliseconds
- Retry delay multiplier: 1.3
- Retry maximum delay: 60000 milliseconds
- Initial timeout: 90000 milliseconds
- Timeout multiplier: 1.0
- Timeout maximum delay: 90000 milliseconds
Retry will be attempted on the following response status codes:
Default RPC expiration is 600000 milliseconds.
Creates a deep clone of this object, with all the same property values.
A deep clone of this object.
The poll settings used by default for repeated polling operations.
Operations client wrapper, for convenient use.
The default endpoint for the Operations service, which is a host of "longrunning.googleapis.com" and a port of 443.
The default Operations scopes.
The default Operations scopes are:
Asynchronously creates a , applying defaults for all unspecified settings,
and creating a channel connecting to the given endpoint with application default credentials where
necessary.
Optional .
Optional .
The task representing the created .
Synchronously creates a , applying defaults for all unspecified settings,
and creating a channel connecting to the given endpoint with application default credentials where
necessary.
Optional .
Optional .
The created .
Creates a which uses the specified channel for remote operations.
The for remote operations. Must not be null.
Optional .
The created .
Shuts down any channels automatically created by
and . Channels which weren't automatically
created are not affected.
After calling this method, further calls to
and will create new channels, which could
in turn be shut down by another call to this method.
A task representing the asynchronous shutdown operation.
The underlying gRPC Operations client.
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.
The name of the operation resource.
If not null, applies overrides to this RPC call.
A Task containing the RPC response.
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.
The name of the operation resource.
A to use for this RPC.
A Task containing the RPC response.
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.
The name of the operation resource.
If not null, applies overrides to this RPC call.
The RPC response.
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.
The request object containing all of the parameters for the API call.
If not null, applies overrides to this RPC call.
A Task containing the RPC response.
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.
The request object containing all of the parameters for the API call.
If not null, applies overrides to this RPC call.
The RPC response.
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`.
The name of the operation collection.
The standard list filter.
The token returned from the previous request.
A value of null or an empty string retrieves the first page.
The size of page to request. The response will not be larger than this, but may be smaller.
A value of null or 0 uses a server-defined page size.
If not null, applies overrides to this RPC call.
A pageable asynchronous sequence of resources.
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`.
The name of the operation collection.
The standard list filter.
The token returned from the previous request.
A value of null or an empty string retrieves the first page.
The size of page to request. The response will not be larger than this, but may be smaller.
A value of null or 0 uses a server-defined page size.
If not null, applies overrides to this RPC call.
A pageable sequence of resources.
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`.
The request object containing all of the parameters for the API call.
If not null, applies overrides to this RPC call.
A pageable asynchronous sequence of resources.
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`.
The request object containing all of the parameters for the API call.
If not null, applies overrides to this RPC call.
A pageable sequence of resources.
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`.
The name of the operation resource to be cancelled.
If not null, applies overrides to this RPC call.
A Task containing the RPC response.
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`.
The name of the operation resource to be cancelled.
A to use for this RPC.
A Task containing the RPC response.
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`.
The name of the operation resource to be cancelled.
If not null, applies overrides to this RPC call.
The RPC response.
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`.
The request object containing all of the parameters for the API call.
If not null, applies overrides to this RPC call.
A Task containing the RPC response.
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`.
The request object containing all of the parameters for the API call.
If not null, applies overrides to this RPC call.
The RPC response.
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`.
The name of the operation resource to be deleted.
If not null, applies overrides to this RPC call.
A Task containing the RPC response.
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`.
The name of the operation resource to be deleted.
A to use for this RPC.
A Task containing the RPC response.
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`.
The name of the operation resource to be deleted.
If not null, applies overrides to this RPC call.
The RPC response.
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`.
The request object containing all of the parameters for the API call.
If not null, applies overrides to this RPC call.
A Task containing the RPC response.
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`.
The request object containing all of the parameters for the API call.
If not null, applies overrides to this RPC call.
The RPC response.
The clock used for timeouts, retries and polling.
The scheduler used for timeouts, retries and polling.
The poll settings used by default for repeated polling operations.
May be null if no defaults have been set.
Return the that would be used by a call to
, using the base
settings of this client and the specified per-call overrides.
This method is used when polling, to determine the appropriate timeout and cancellation
token to use for each call.
The per-call override, if any.
The effective call settings for a GetOperation RPC.
Operations client wrapper implementation, for convenient use.
Constructs a client wrapper for the Operations service, with the specified gRPC client and settings.
The underlying gRPC client.
The base used within this client
The underlying gRPC Operations client.
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.
The request object containing all of the parameters for the API call.
If not null, applies overrides to this RPC call.
A Task containing the RPC response.
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.
The request object containing all of the parameters for the API call.
If not null, applies overrides to this RPC call.
The RPC response.
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`.
The request object containing all of the parameters for the API call.
If not null, applies overrides to this RPC call.
A pageable asynchronous sequence of resources.
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`.
The request object containing all of the parameters for the API call.
If not null, applies overrides to this RPC call.
A pageable sequence of resources.
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`.
The request object containing all of the parameters for the API call.
If not null, applies overrides to this RPC call.
A Task containing the RPC response.
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`.
The request object containing all of the parameters for the API call.
If not null, applies overrides to this RPC call.
The RPC response.
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`.
The request object containing all of the parameters for the API call.
If not null, applies overrides to this RPC call.
A Task containing the RPC response.
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`.
The request object containing all of the parameters for the API call.
If not null, applies overrides to this RPC call.
The RPC response.
Manages long-running operations with an API service.
When an API method normally takes long time to complete, it can be designed
to return [Operation][google.longrunning.Operation] to the client, and the client can use this
interface to receive the real response asynchronously by polling the
operation resource, or pass the operation resource to another API (such as
Google Cloud Pub/Sub API) to receive the response. Any API service that
returns long-running operations should implement the `Operations` interface
so developers can have a consistent client experience.
Service descriptor
Base class for server-side implementations of Operations
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`.
The request received from the client.
The context of the server-side call handler being invoked.
The response to send back to the client (wrapped by a task).
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.
The request received from the client.
The context of the server-side call handler being invoked.
The response to send back to the client (wrapped by a task).
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`.
The request received from the client.
The context of the server-side call handler being invoked.
The response to send back to the client (wrapped by a task).
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`.
The request received from the client.
The context of the server-side call handler being invoked.
The response to send back to the client (wrapped by a task).
Client for Operations
Creates a new client for Operations
The channel to use to make remote calls.
Creates a new client for Operations that uses a custom CallInvoker.
The callInvoker to use to make remote calls.
Protected parameterless constructor to allow creation of test doubles.
Protected constructor to allow creation of configured clients.
The client configuration.
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`.
The request to send to the server.
The initial metadata to send with the call. This parameter is optional.
An optional deadline for the call. The call will be cancelled if deadline is hit.
An optional token for canceling the call.
The response received from the server.
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`.
The request to send to the server.
The options for the call.
The response received from the server.
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`.
The request to send to the server.
The initial metadata to send with the call. This parameter is optional.
An optional deadline for the call. The call will be cancelled if deadline is hit.
An optional token for canceling the call.
The call object.
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`.
The request to send to the server.
The options for the call.
The call object.
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.
The request to send to the server.
The initial metadata to send with the call. This parameter is optional.
An optional deadline for the call. The call will be cancelled if deadline is hit.
An optional token for canceling the call.
The response received from the server.
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.
The request to send to the server.
The options for the call.
The response received from the server.
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.
The request to send to the server.
The initial metadata to send with the call. This parameter is optional.
An optional deadline for the call. The call will be cancelled if deadline is hit.
An optional token for canceling the call.
The call object.
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.
The request to send to the server.
The options for the call.
The call object.
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`.
The request to send to the server.
The initial metadata to send with the call. This parameter is optional.
An optional deadline for the call. The call will be cancelled if deadline is hit.
An optional token for canceling the call.
The response received from the server.
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`.
The request to send to the server.
The options for the call.
The response received from the server.
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`.
The request to send to the server.
The initial metadata to send with the call. This parameter is optional.
An optional deadline for the call. The call will be cancelled if deadline is hit.
An optional token for canceling the call.
The call object.
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`.
The request to send to the server.
The options for the call.
The call object.
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`.
The request to send to the server.
The initial metadata to send with the call. This parameter is optional.
An optional deadline for the call. The call will be cancelled if deadline is hit.
An optional token for canceling the call.
The response received from the server.
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`.
The request to send to the server.
The options for the call.
The response received from the server.
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`.
The request to send to the server.
The initial metadata to send with the call. This parameter is optional.
An optional deadline for the call. The call will be cancelled if deadline is hit.
An optional token for canceling the call.
The call object.
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`.
The request to send to the server.
The options for the call.
The call object.
Creates a new instance of client from given ClientBaseConfiguration.
Creates service definition that can be registered with a server
An object implementing the server-side handling logic.