OperationsClient

Constructor.

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:

try {
    $options = [
        'serviceAddress' => 'my-service-address',
        'scopes' => ['my-service-scope'],
    ];
    $operationsClient = new OperationsClient($options);
    $name = "";
    $response = $operationsClient->getOperation($name);
} finally {
    if (isset($operationsClient)) {
        $operationsClient->close();
    }
}

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.

Sample code:

try {
    $options = [
        'serviceAddress' => 'my-service-address',
        'scopes' => ['my-service-scope'],
    ];
    $operationsClient = new OperationsClient($options);
    $name = "";
    $filter = "";
    // Iterate through all elements
    $pagedResponse = $operationsClient->listOperations($name, $filter);
    foreach ($pagedResponse->iterateAllElements() as $element) {
        // doSomethingWith($element);
    }

    // OR iterate over pages of elements, with the maximum page size set to 5
    $pagedResponse = $operationsClient->listOperations($name, $filter, ['pageSize' => 5]);
    foreach ($pagedResponse->iteratePages() as $page) {
        foreach ($page as $element) {
            // doSomethingWith($element);
        }
    }
} finally {
    if (isset($operationsClient)) {
        $operationsClient->close();
    }
}

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:

try {
    $options = [
        'serviceAddress' => 'my-service-address',
        'scopes' => ['my-service-scope'],
    ];
    $operationsClient = new OperationsClient($options);
    $name = "";
    $operationsClient->cancelOperation($name);
} finally {
    if (isset($operationsClient)) {
        $operationsClient->close();
    }
}

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:

try {
    $options = [
        'serviceAddress' => 'my-service-address',
        'scopes' => ['my-service-scope'],
    ];
    $operationsClient = new OperationsClient($options);
    $name = "";
    $operationsClient->deleteOperation($name);
} finally {
    if (isset($operationsClient)) {
        $operationsClient->close();
    }
}

Initiates an orderly shutdown in which preexisting calls continue but new calls are immediately cancelled.