OperationsClient
extends BaseStub
in package
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.
Table of Contents
Methods
- __construct() : mixed
- CancelOperation() : UnaryCall
- 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`.
- DeleteOperation() : UnaryCall
- 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`.
- GetOperation() : UnaryCall
- 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() : UnaryCall
- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
- WaitOperation() : UnaryCall
- Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
Methods
__construct()
public
__construct(string $hostname, array<string|int, mixed> $opts[, Channel $channel = null ]) : mixed
Parameters
- $hostname : string
-
hostname
- $opts : array<string|int, mixed>
-
channel options
- $channel : Channel = null
-
(optional) re-use channel object
CancelOperation()
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`.
public
CancelOperation(CancelOperationRequest $argument[, array<string|int, mixed> $metadata = [] ][, array<string|int, mixed> $options = [] ]) : UnaryCall
Parameters
- $argument : CancelOperationRequest
-
input argument
- $metadata : array<string|int, mixed> = []
-
metadata
- $options : array<string|int, mixed> = []
-
call options
Return values
UnaryCallDeleteOperation()
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`.
public
DeleteOperation(DeleteOperationRequest $argument[, array<string|int, mixed> $metadata = [] ][, array<string|int, mixed> $options = [] ]) : UnaryCall
Parameters
- $argument : DeleteOperationRequest
-
input argument
- $metadata : array<string|int, mixed> = []
-
metadata
- $options : array<string|int, mixed> = []
-
call options
Return values
UnaryCallGetOperation()
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.
public
GetOperation(GetOperationRequest $argument[, array<string|int, mixed> $metadata = [] ][, array<string|int, mixed> $options = [] ]) : UnaryCall
Parameters
- $argument : GetOperationRequest
-
input argument
- $metadata : array<string|int, mixed> = []
-
metadata
- $options : array<string|int, mixed> = []
-
call options
Return values
UnaryCallListOperations()
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
public
ListOperations(ListOperationsRequest $argument[, array<string|int, mixed> $metadata = [] ][, array<string|int, mixed> $options = [] ]) : UnaryCall
NOTE: the name binding allows API services to override the binding
to use different resource name schemes, such as users/*/operations. To
override the binding, API services can add a binding such as
"/v1/{name=users/*}/operations" to their service configuration.
For backwards compatibility, the default name includes the operations
collection id, however overriding users must ensure the name binding
is the parent resource, without the operations collection id.
Parameters
- $argument : ListOperationsRequest
-
input argument
- $metadata : array<string|int, mixed> = []
-
metadata
- $options : array<string|int, mixed> = []
-
call options
Return values
UnaryCallWaitOperation()
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
public
WaitOperation(WaitOperationRequest $argument[, array<string|int, mixed> $metadata = [] ][, array<string|int, mixed> $options = [] ]) : UnaryCall
Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
Parameters
- $argument : WaitOperationRequest
-
input argument
- $metadata : array<string|int, mixed> = []
-
metadata
- $options : array<string|int, mixed> = []
-
call options