Reference documentation and code samples for the Compute V1 Client class RegionInstancesClient.
Service Description: The RegionInstances API.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
$regionInstancesClient = new RegionInstancesClient();
try {
$bulkInsertInstanceResourceResource = new BulkInsertInstanceResource();
$project = 'project';
$region = 'region';
$operationResponse = $regionInstancesClient->bulkInsert($bulkInsertInstanceResourceResource, $project, $region);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
// if creating/modifying, retrieve the target resource
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $regionInstancesClient->bulkInsert($bulkInsertInstanceResourceResource, $project, $region);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $regionInstancesClient->resumeOperation($operationName, 'bulkInsert');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
// if creating/modifying, retrieve the target resource
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$regionInstancesClient->close();
}
Methods
getOperationsClient
Return an RegionOperationsClient object with the same endpoint as $this.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\RegionOperationsClient | |
resumeOperation
Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.
| Parameters | |
|---|---|
| Name | Description |
operationName |
string
The name of the long running operation |
methodName |
string
The name of the method used to start the operation |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
__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. |
bulkInsert
Creates multiple instances in a given region. Count specifies the number of instances to create.
| Parameters | |
|---|---|
| Name | Description |
bulkInsertInstanceResourceResource |
Google\Cloud\Compute\V1\BulkInsertInstanceResource
The body resource for this request |
project |
string
Project ID for this request. |
region |
string
The name of the region for this request. |
optionalArgs |
array
Optional. |
↳ requestId |
string
An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). |
↳ 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\OperationResponse | |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\BulkInsertInstanceResource;
use Google\Cloud\Compute\V1\RegionInstancesClient;
use Google\Rpc\Status;
/**
* @param string $project Project ID for this request.
* @param string $region The name of the region for this request.
*/
function bulk_insert_sample(string $project, string $region): void
{
// Create a client.
$regionInstancesClient = new RegionInstancesClient();
// Prepare any non-scalar elements to be passed along with the request.
$bulkInsertInstanceResourceResource = new BulkInsertInstanceResource();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $regionInstancesClient->bulkInsert(
$bulkInsertInstanceResourceResource,
$project,
$region
);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
printf('Operation completed successfully.' . PHP_EOL);
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* 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]';
bulk_insert_sample($project, $region);
}
Constants
SERVICE_NAME
Value: 'google.cloud.compute.v1.RegionInstances'The name of the service.
SERVICE_ADDRESS
Value: 'compute.googleapis.com'The default address of the service.
DEFAULT_SERVICE_PORT
Value: 443The default port of the service.
CODEGEN_NAME
Value: 'gapic'The name of the code generator, to be included in the agent header.