Reference documentation and code samples for the Compute V1 Client class RegionOperationsClient.
Service Description: The RegionOperations 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.
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. Important : If you accept a credential configuration (credential JSON/File/Stream) from an external source for authentication to Google Cloud Platform, you must validate it before providing it to any Google API or library. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. For more information https://cloud.google.com/docs/authentication/external/externally-sourced-credentials
↳ 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 false
.
↳ 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 rest
. Advanced usage
: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface
object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ 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
delete
Deletes the specified region-specific Operations resource.
The async variant is RegionOperationsClient::deleteAsync() .
request
Google\Cloud\Compute\V1\DeleteRegionOperationRequest
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.
use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\Client\RegionOperationsClient;
use Google\Cloud\Compute\V1\DeleteRegionOperationRequest;
use Google\Cloud\Compute\V1\DeleteRegionOperationResponse;
/**
* @param string $operation Name of the Operations resource to delete, or its unique numeric identifier.
* @param string $project Project ID for this request.
* @param string $region Name of the region for this request.
*/
function delete_sample(string $operation, string $project, string $region): void
{
// Create a client.
$regionOperationsClient = new RegionOperationsClient();
// Prepare the request message.
$request = (new DeleteRegionOperationRequest())
->setOperation($operation)
->setProject($project)
->setRegion($region);
// Call the API and handle any network failures.
try {
/** @var DeleteRegionOperationResponse $response */
$response = $regionOperationsClient->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]';
$region = '[REGION]';
delete_sample($operation, $project, $region);
}
get
Retrieves the specified region-specific Operations resource.
The async variant is RegionOperationsClient::getAsync() .
request
Google\Cloud\Compute\V1\GetRegionOperationRequest
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.
use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\Client\RegionOperationsClient;
use Google\Cloud\Compute\V1\GetRegionOperationRequest;
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.
* @param string $region Name of the region for this request.
*/
function get_sample(string $operation, string $project, string $region): void
{
// Create a client.
$regionOperationsClient = new RegionOperationsClient();
// Prepare the request message.
$request = (new GetRegionOperationRequest())
->setOperation($operation)
->setProject($project)
->setRegion($region);
// Call the API and handle any network failures.
try {
/** @var Operation $response */
$response = $regionOperationsClient->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]';
$region = '[REGION]';
get_sample($operation, $project, $region);
}
list
Retrieves a list of Operation resources contained within the specified region.
The async variant is RegionOperationsClient::listAsync() .
request
Google\Cloud\Compute\V1\ListRegionOperationsRequest
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.
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Compute\V1\Client\RegionOperationsClient;
use Google\Cloud\Compute\V1\ListRegionOperationsRequest;
/**
* @param string $project Project ID for this request.
* @param string $region Name of the region for this request.
*/
function list_sample(string $project, string $region): void
{
// Create a client.
$regionOperationsClient = new RegionOperationsClient();
// Prepare the request message.
$request = (new ListRegionOperationsRequest())
->setProject($project)
->setRegion($region);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $regionOperationsClient->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]';
$region = '[REGION]';
list_sample($project, $region);
}
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 RegionOperationsClient::waitAsync() .
request
Google\Cloud\Compute\V1\WaitRegionOperationRequest
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.
use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\Client\RegionOperationsClient;
use Google\Cloud\Compute\V1\Operation;
use Google\Cloud\Compute\V1\WaitRegionOperationRequest;
/**
* @param string $operation Name of the Operations resource to return, or its unique numeric identifier.
* @param string $project Project ID for this request.
* @param string $region Name of the region for this request.
*/
function wait_sample(string $operation, string $project, string $region): void
{
// Create a client.
$regionOperationsClient = new RegionOperationsClient();
// Prepare the request message.
$request = (new WaitRegionOperationRequest())
->setOperation($operation)
->setProject($project)
->setRegion($region);
// Call the API and handle any network failures.
try {
/** @var Operation $response */
$response = $regionOperationsClient->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]';
$region = '[REGION]';
wait_sample($operation, $project, $region);
}
deleteAsync
optionalArgs
array
getAsync
optionalArgs
array
listAsync
optionalArgs
array
waitAsync
optionalArgs
array
