Reference documentation and code samples for the Compute V1 Client class GlobalOperationsClient.
Service Description: The GlobalOperations API.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods.
Namespace
Google \ Cloud \ Compute \ V1 \ ClientMethods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
options |
array
Optional. Options for configuring the service API wrapper. |
↳ apiEndpoint |
string
The address of the API remote host. May optionally include the port, formatted as "
|
↳ credentials |
string|array|FetchAuthTokenInterface|CredentialsWrapper
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 Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. |
↳ credentialsConfig |
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() . |
↳ disableRetries |
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to |
↳ clientConfig |
string|array
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. |
↳ transport |
string|TransportInterface
The transport used for executing network requests. At the moment, supports only |
↳ transportConfig |
array
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 = [ 'rest' => [...], ]; See the Google\ApiCore\Transport\RestTransport::build() method for the supported options. |
↳ clientCertSource |
callable
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. |
↳ logger |
false|LoggerInterface
A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag |
aggregatedList
Retrieves an aggregated list of all operations. To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
.
The async variant is GlobalOperationsClient::aggregatedListAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\AggregatedListGlobalOperationsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Compute\V1\AggregatedListGlobalOperationsRequest;
use Google\Cloud\Compute\V1\Client\GlobalOperationsClient;
/**
* @param string $project Project ID for this request.
*/
function aggregated_list_sample(string $project): void
{
// Create a client.
$globalOperationsClient = new GlobalOperationsClient();
// Prepare the request message.
$request = (new AggregatedListGlobalOperationsRequest())
->setProject($project);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $globalOperationsClient->aggregatedList($request);
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$project = '[PROJECT]';
aggregated_list_sample($project);
}
delete
Deletes the specified Operations resource.
The async variant is GlobalOperationsClient::deleteAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\DeleteGlobalOperationRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Compute\V1\DeleteGlobalOperationResponse |
use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\Client\GlobalOperationsClient;
use Google\Cloud\Compute\V1\DeleteGlobalOperationRequest;
use Google\Cloud\Compute\V1\DeleteGlobalOperationResponse;
/**
* @param string $operation Name of the Operations resource to delete, or its unique numeric identifier.
* @param string $project Project ID for this request.
*/
function delete_sample(string $operation, string $project): void
{
// Create a client.
$globalOperationsClient = new GlobalOperationsClient();
// Prepare the request message.
$request = (new DeleteGlobalOperationRequest())
->setOperation($operation)
->setProject($project);
// Call the API and handle any network failures.
try {
/** @var DeleteGlobalOperationResponse $response */
$response = $globalOperationsClient->delete($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$operation = '[OPERATION]';
$project = '[PROJECT]';
delete_sample($operation, $project);
}
get
Retrieves the specified Operations resource.
The async variant is GlobalOperationsClient::getAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\GetGlobalOperationRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Compute\V1\Operation |
use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\Client\GlobalOperationsClient;
use Google\Cloud\Compute\V1\GetGlobalOperationRequest;
use Google\Cloud\Compute\V1\Operation;
/**
* @param string $operation Name of the Operations resource to return, or its unique numeric identifier.
* @param string $project Project ID for this request.
*/
function get_sample(string $operation, string $project): void
{
// Create a client.
$globalOperationsClient = new GlobalOperationsClient();
// Prepare the request message.
$request = (new GetGlobalOperationRequest())
->setOperation($operation)
->setProject($project);
// Call the API and handle any network failures.
try {
/** @var Operation $response */
$response = $globalOperationsClient->get($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$operation = '[OPERATION]';
$project = '[PROJECT]';
get_sample($operation, $project);
}
list
Retrieves a list of Operation resources contained within the specified project.
The async variant is GlobalOperationsClient::listAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\ListGlobalOperationsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Compute\V1\Client\GlobalOperationsClient;
use Google\Cloud\Compute\V1\ListGlobalOperationsRequest;
/**
* @param string $project Project ID for this request.
*/
function list_sample(string $project): void
{
// Create a client.
$globalOperationsClient = new GlobalOperationsClient();
// Prepare the request message.
$request = (new ListGlobalOperationsRequest())
->setProject($project);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $globalOperationsClient->list($request);
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$project = '[PROJECT]';
list_sample($project);
}
wait
Waits for the specified Operation resource to return as DONE
or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the GET
method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be DONE
or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not DONE
.
The async variant is GlobalOperationsClient::waitAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\WaitGlobalOperationRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Compute\V1\Operation |
use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\Client\GlobalOperationsClient;
use Google\Cloud\Compute\V1\Operation;
use Google\Cloud\Compute\V1\WaitGlobalOperationRequest;
/**
* @param string $operation Name of the Operations resource to return, or its unique numeric identifier.
* @param string $project Project ID for this request.
*/
function wait_sample(string $operation, string $project): void
{
// Create a client.
$globalOperationsClient = new GlobalOperationsClient();
// Prepare the request message.
$request = (new WaitGlobalOperationRequest())
->setOperation($operation)
->setProject($project);
// Call the API and handle any network failures.
try {
/** @var Operation $response */
$response = $globalOperationsClient->wait($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$operation = '[OPERATION]';
$project = '[PROJECT]';
wait_sample($operation, $project);
}
aggregatedListAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\AggregatedListGlobalOperationsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
deleteAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\DeleteGlobalOperationRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Compute\V1\DeleteGlobalOperationResponse> |
getAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\GetGlobalOperationRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Compute\V1\Operation> |
listAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\ListGlobalOperationsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
waitAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\WaitGlobalOperationRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Compute\V1\Operation> |