PHPFUI/InstaDoc
 
Copied!

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.

CloneableInstantiable
Methods
public __construct( $hostname, $opts, $channel = NULL)
 
  • param string $hostname hostname
  • param array $opts channel options
  • param \Grpc\Channel $channel (optional) re-use channel object
public CancelOperation(Google\LongRunning\CancelOperationRequest $argument, $metadata = [], $options = [])
 

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.

  • param \Google\LongRunning\CancelOperationRequest $argument input argument
  • param array $metadata metadata
  • param array $options call options
  • return \Grpc\UnaryCall
public Grpc\BaseStub::close()
 

Close the communication channel associated with this stub.

public DeleteOperation(Google\LongRunning\DeleteOperationRequest $argument, $metadata = [], $options = [])
 

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.

  • param \Google\LongRunning\DeleteOperationRequest $argument input argument
  • param array $metadata metadata
  • param array $options call options
  • return \Grpc\UnaryCall
public Grpc\BaseStub::getConnectivityState( $try_to_connect = false)
 
  • param bool $try_to_connect (optional)
  • return int The grpc connectivity state
public static Grpc\BaseStub::getDefaultChannel( $hostname, array $opts)
 

Creates and returns the default Channel

  • param array $opts Channel constructor options
  • return \Channel The channel
public GetOperation(Google\LongRunning\GetOperationRequest $argument, $metadata = [], $options = [])
 

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.

  • param \Google\LongRunning\GetOperationRequest $argument input argument
  • param array $metadata metadata
  • param array $options call options
  • return \Grpc\UnaryCall
public Grpc\BaseStub::getTarget()
 
  • return string The URI of the endpoint
public ListOperations(Google\LongRunning\ListOperationsRequest $argument, $metadata = [], $options = [])
 

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 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.

  • param \Google\LongRunning\ListOperationsRequest $argument input argument
  • param array $metadata metadata
  • param array $options call options
  • return \Grpc\UnaryCall
public Grpc\BaseStub::waitForReady( $timeout)
 
  • param int $timeout in microseconds
  • return bool true if channel is ready
  • throws \Exception if channel is in FATAL_ERROR state
public WaitOperation(Google\LongRunning\WaitOperationRequest $argument, $metadata = [], $options = [])
 

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.

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.

  • param \Google\LongRunning\WaitOperationRequest $argument input argument
  • param array $metadata metadata
  • param array $options call options
  • return \Grpc\UnaryCall
Methods
protected Grpc\BaseStub::_bidiRequest( $method, $deserialize, array $metadata = [], array $options = [])
 

Call a remote method with messages streaming in both directions.

  • param string $method The name of the method to call
  • param callable $deserialize A function that deserializes the responses
  • param array $metadata A metadata map to send to the server (optional)
  • param array $options An array of options (optional)
  • return \BidiStreamingCall The active call object
protected Grpc\BaseStub::_clientStreamRequest( $method, $deserialize, array $metadata = [], array $options = [])
 

Call a remote method that takes a stream of arguments and has a single output.

  • param string $method The name of the method to call
  • param callable $deserialize A function that deserializes the response
  • param array $metadata A metadata map to send to the server (optional)
  • param array $options An array of options (optional)
  • return \ClientStreamingCall The active call object
protected Grpc\BaseStub::_serverStreamRequest( $method, $argument, $deserialize, array $metadata = [], array $options = [])
 

Call a remote method that takes a single argument and returns a stream of responses.

  • param string $method The name of the method to call
  • param mixed $argument The argument to the method
  • param callable $deserialize A function that deserializes the responses
  • param array $metadata A metadata map to send to the server (optional)
  • param array $options An array of options (optional)
  • return \ServerStreamingCall The active call object
protected Grpc\BaseStub::_simpleRequest( $method, $argument, $deserialize, array $metadata = [], array $options = [])
 

Call a remote method that takes a single argument and has a single output.

  • param string $method The name of the method to call
  • param mixed $argument The argument to the method
  • param callable $deserialize A function that deserializes the response
  • param array $metadata A metadata map to send to the server (optional)
  • param array $options An array of options (optional)
  • return \UnaryCall The active call object
Methods
public static Grpc\BaseStub::getDefaultChannel( $hostname, array $opts)
 

Creates and returns the default Channel

  • param array $opts Channel constructor options
  • return \Channel The channel
© 2025 Bruce Wells
Search Namespaces \ Classes
Configuration