Google Cloud PHP shared dependency, providing functionality useful to all components. Client - Class LongRunningOperation (1.52.11)

Reference documentation and code samples for the Google Cloud PHP shared dependency, providing functionality useful to all components. Client class LongRunningOperation.

Represent and interact with a Long Running Operation.

Return the Operation name.

Example:

$name = $operation->name();

Check if the Operation is done.

If the Operation state is not available, a service request may be executed by this method.

Example:

if ($operation->done()) {
    echo "The operation is done!";
}

Get the state of the Operation.

Return value will be one of LongRunningOperation::STATE_IN_PROGRESS, LongRunningOperation::STATE_SUCCESS or LongRunningOperation::STATE_ERROR.

If the Operation state is not available, a service request may be executed by this method.

Example:

switch ($operation->state()) {
    case LongRunningOperation::STATE_IN_PROGRESS:
        echo "Operation is in progress";
        break;

    case LongRunningOperation::STATE_SUCCESS:
        echo "Operation succeeded";
        break;

    case LongRunningOperation::STATE_ERROR:
        echo "Operation failed";
        break;
}

Get the Operation result.

The return type of this method is dictated by the type of Operation.

Returns null if the Operation is not yet complete, or if an error occurred.

If the Operation state is not available, a service request may be executed by this method.

Example:

$result = $operation->result();

Get the Operation error.

Returns null if the Operation is not yet complete, or if no error occurred.

If the Operation state is not available, a service request may be executed by this method.

Example:

$error = $operation->error();

Get the Operation info.

If the Operation state is not available, a service request may be executed by this method.

Example:

$info = $operation->info();

Reload the Operation to check its status.

Example:

$result = $operation->reload();

Reload the operation until it is complete.

The return type of this method is dictated by the type of Operation. If $options.maxPollingDurationSeconds is set, and the poll exceeds the limit, the return will be null.

Example:

$result = $operation->pollUntilComplete();

Cancel a Long Running Operation.

Example:

$operation->cancel();

Delete a Long Running Operation.

Example:

$operation->delete();