| Constants |
public Google\LongRunning\Gapic\OperationsGapicClient::CODEGEN_NAME = 'gapic' The name of the code generator, to be included in the agent header. |
public Google\LongRunning\Gapic\OperationsGapicClient::DEFAULT_SERVICE_PORT = 443 The default port of the service. |
public Google\LongRunning\Gapic\OperationsGapicClient::SERVICE_ADDRESS = 'longrunning.googleapis.com' The default address of the service. - deprecated SERVICE_ADDRESS_TEMPLATE should be used instead.
|
| public Google\LongRunning\Gapic\OperationsGapicClient::SERVICE_NAME = 'google.longrunning.Operations' |
| Properties |
public static Google\LongRunning\Gapic\OperationsGapicClient::$serviceScopes = [] The default scopes required by the service. |
| Methods |
public Google\LongRunning\Gapic\OperationsGapicClient::__construct(array $options = []) - param array $options {
Optional. Options for configuring the service API wrapper.
@type string $apiEndpoint
The address of the API remote host. May optionally include the port, formatted
as "<uri>:<port>". Default 'longrunning.googleapis.com:443'.
@type string|array|FetchAuthTokenInterface|CredentialsWrapper $credentials
The credentials to be used by the client to authorize API calls. This option
accepts either a path to a credentials file, or a decoded credentials file as a
PHP array.
*Advanced usage*: In addition, this option can also accept a pre-constructed
{@see \Google\Auth\FetchAuthTokenInterface} object or
{@see \Google\ApiCore\CredentialsWrapper} object. Note that when one of these
objects are provided, any settings in $credentialsConfig will be ignored.
@type array $credentialsConfig
Options used to configure credentials, including auth token caching, for the
client. For a full list of supporting configuration options, see
{@see \Google\ApiCore\CredentialsWrapper::build()} .
@type bool $disableRetries
Determines whether or not retries defined by the client configuration should be
disabled. Defaults to `false`.
@type string|array $clientConfig
Client method configuration, including retry settings. This option can be either
a path to a JSON file, or a PHP array containing the decoded JSON data. By
default this settings points to the default client config file, which is
provided in the resources folder.
@type string|TransportInterface $transport
The transport used for executing network requests. May be either the string
`rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system.
*Advanced usage*: Additionally, it is possible to pass in an already
instantiated {@see \Google\ApiCore\Transport\TransportInterface} object. Note
that when this object is provided, any settings in $transportConfig, and any
$apiEndpoint setting, will be ignored.
@type array $transportConfig
Configuration options that will be used to construct the transport. Options for
each supported transport type should be passed in a key for that transport. For
example:
$transportConfig = [
'grpc' => [...],
'rest' => [...],
];
See the {@see \Google\ApiCore\Transport\GrpcTransport::build()} and
{@see \Google\ApiCore\Transport\RestTransport::build()} methods for the
supported options.
@type callable $clientCertSource
A callable which returns the client cert as a string. This can be used to
provide a certificate and private key to the transport layer for mTLS.
}
- throws \ValidationException
|
public Google\LongRunning\Gapic\OperationsGapicClient::addMiddleware(callable $middlewareCallable) : void Add a middleware to the call stack by providing a callable which will be
invoked at the start of each call, and will return an instance of
{@see MiddlewareInterface} when invoked. The callable must have the following method signature:
callable(MiddlewareInterface): MiddlewareInterface
An implementation may look something like this:
$client->addMiddleware(function (MiddlewareInterface $handler) {
return new class ($handler) implements MiddlewareInterface {
public function __construct(private MiddlewareInterface $handler) {
}
public function __invoke(Call $call, array $options) {
// modify call and options (pre-request)
$response = ($this->handler)($call, $options);
// modify the response (post-request)
return $response;
}
};
});
- param callable $middlewareCallable A callable which returns an instance
of {@see \MiddlewareInterface} when invoked with a
MiddlewareInterface instance as its first argument.
- return void
|
public Google\LongRunning\Gapic\OperationsGapicClient::cancelOperation( $name, array $optionalArgs = []) 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.
Sample code:
$operationsClient = new OperationsClient();
try {
$name = 'name';
$operationsClient->cancelOperation($name);
} finally {
$operationsClient->close();
}
- param string $name The name of the operation resource to be cancelled.
- param array $optionalArgs {
Optional.
@type RetrySettings|array $retrySettings
Retry settings to use for this call. Can be a {@see \RetrySettings} object, or an
associative array of retry settings parameters. See the documentation on
{@see \RetrySettings} for example usage.
}
- throws \ApiException if the remote call fails
|
public Google\LongRunning\Gapic\OperationsGapicClient::close() Initiates an orderly shutdown in which preexisting calls continue but new
calls are immediately cancelled. |
public Google\LongRunning\Gapic\OperationsGapicClient::deleteOperation( $name, array $optionalArgs = []) 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.
Sample code:
$operationsClient = new OperationsClient();
try {
$name = 'name';
$operationsClient->deleteOperation($name);
} finally {
$operationsClient->close();
}
- param string $name The name of the operation resource to be deleted.
- param array $optionalArgs {
Optional.
@type RetrySettings|array $retrySettings
Retry settings to use for this call. Can be a {@see \RetrySettings} object, or an
associative array of retry settings parameters. See the documentation on
{@see \RetrySettings} for example usage.
}
- throws \ApiException if the remote call fails
|
public Google\LongRunning\Gapic\OperationsGapicClient::getOperation( $name, array $optionalArgs = []) 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. Sample code:
$operationsClient = new OperationsClient();
try {
$name = 'name';
$response = $operationsClient->getOperation($name);
} finally {
$operationsClient->close();
}
- param string $name The name of the operation resource.
- param array $optionalArgs {
Optional.
@type RetrySettings|array $retrySettings
Retry settings to use for this call. Can be a {@see \RetrySettings} object, or an
associative array of retry settings parameters. See the documentation on
{@see \RetrySettings} for example usage.
}
- return \Google\LongRunning\Operation
- throws \ApiException if the remote call fails
|
public Google\LongRunning\Gapic\OperationsGapicClient::listOperations( $name, $filter, array $optionalArgs = []) Lists operations that match the specified filter in the request. If the
server doesn't support this method, it returns UNIMPLEMENTED.
Sample code:
$operationsClient = new OperationsClient();
try {
$name = 'name';
$filter = 'filter';
// Iterate over pages of elements
$pagedResponse = $operationsClient->listOperations($name, $filter);
foreach ($pagedResponse->iteratePages() as $page) {
foreach ($page as $element) {
// doSomethingWith($element);
}
}
// Alternatively:
// Iterate through all elements
$pagedResponse = $operationsClient->listOperations($name, $filter);
foreach ($pagedResponse->iterateAllElements() as $element) {
// doSomethingWith($element);
}
} finally {
$operationsClient->close();
}
- param string $name The name of the operation's parent resource.
- param string $filter The standard list filter.
- param array $optionalArgs {
Optional.
@type int $pageSize
The maximum number of resources contained in the underlying API
response. The API may return fewer values in a page, even if
there are additional values to be retrieved.
@type string $pageToken
A page token is used to specify a page of values to be returned.
If no page token is specified (the default), the first page
of values will be returned. Any page token used here must have
been generated by a previous call to the API.
@type RetrySettings|array $retrySettings
Retry settings to use for this call. Can be a {@see \RetrySettings} object, or an
associative array of retry settings parameters. See the documentation on
{@see \RetrySettings} for example usage.
}
- return \Google\ApiCore\PagedListResponse
- throws \ApiException if the remote call fails
|
public static Google\LongRunning\Gapic\OperationsGapicClient::traitValidate(array $arr, array $requiredKeys) - param array $arr Associative array
- param array $requiredKeys List of keys to check for in $arr
- return array Returns $arr for fluent use
|
public static Google\LongRunning\Gapic\OperationsGapicClient::validate(array $arr, array $requiredKeys) - param array $arr Associative array
- param array $requiredKeys List of keys to check for in $arr
- return array Returns $arr for fluent use
|
public static Google\LongRunning\Gapic\OperationsGapicClient::validateNotNull(array $arr, array $requiredKeys) - param array $arr Associative array
- param array $requiredKeys List of keys to check for in $arr
- return array Returns $arr for fluent use
|
public Google\LongRunning\Gapic\OperationsGapicClient::waitOperation(array $optionalArgs = []) 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.
Sample code:
$operationsClient = new OperationsClient();
try {
$response = $operationsClient->waitOperation();
} finally {
$operationsClient->close();
}
- param array $optionalArgs {
Optional.
@type string $name
The name of the operation resource to wait on.
@type Duration $timeout
The maximum duration to wait before timing out. If left blank, the wait
will be at most the time permitted by the underlying HTTP/RPC protocol.
If RPC context deadline is also specified, the shorter one will be used.
@type RetrySettings|array $retrySettings
Retry settings to use for this call. Can be a {@see \RetrySettings} object, or an
associative array of retry settings parameters. See the documentation on
{@see \RetrySettings} for example usage.
}
- return \Google\LongRunning\Operation
- throws \ApiException if the remote call fails
|