Reference documentation and code samples for the Compute V1 Client class RegionInstanceGroupManagersClient.
Service Description: The RegionInstanceGroupManagers 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:
$regionInstanceGroupManagersClient = new RegionInstanceGroupManagersClient();
try {
$instanceGroupManager = 'instance_group_manager';
$project = 'project';
$region = 'region';
$regionInstanceGroupManagersAbandonInstancesRequestResource = new RegionInstanceGroupManagersAbandonInstancesRequest();
$operationResponse = $regionInstanceGroupManagersClient->abandonInstances($instanceGroupManager, $project, $region, $regionInstanceGroupManagersAbandonInstancesRequestResource);
$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 = $regionInstanceGroupManagersClient->abandonInstances($instanceGroupManager, $project, $region, $regionInstanceGroupManagersAbandonInstancesRequestResource);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $regionInstanceGroupManagersClient->resumeOperation($operationName, 'abandonInstances');
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 {
$regionInstanceGroupManagersClient->close();
}
This service has a new (beta) implementation. See Google\Cloud\Compute\V1\Client\RegionInstanceGroupManagersClient to use the new surface.
Namespace
Google \ Cloud \ Compute \ V1Methods
__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. |
abandonInstances
Flags the specified instances to be immediately removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.
| Parameters | |
|---|---|
| Name | Description |
instanceGroupManager |
string
Name of the managed instance group. |
project |
string
Project ID for this request. |
region |
string
Name of the region scoping this request. |
regionInstanceGroupManagersAbandonInstancesRequestResource |
Google\Cloud\Compute\V1\RegionInstanceGroupManagersAbandonInstancesRequest
The body resource 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\RegionInstanceGroupManagersAbandonInstancesRequest;
use Google\Cloud\Compute\V1\RegionInstanceGroupManagersClient;
use Google\Rpc\Status;
/**
* @param string $instanceGroupManager Name of the managed instance group.
* @param string $project Project ID for this request.
* @param string $region Name of the region scoping this request.
*/
function abandon_instances_sample(
string $instanceGroupManager,
string $project,
string $region
): void {
// Create a client.
$regionInstanceGroupManagersClient = new RegionInstanceGroupManagersClient();
// Prepare any non-scalar elements to be passed along with the request.
$regionInstanceGroupManagersAbandonInstancesRequestResource = new RegionInstanceGroupManagersAbandonInstancesRequest();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $regionInstanceGroupManagersClient->abandonInstances(
$instanceGroupManager,
$project,
$region,
$regionInstanceGroupManagersAbandonInstancesRequestResource
);
$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());
}
}
/**
* 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
{
$instanceGroupManager = '[INSTANCE_GROUP_MANAGER]';
$project = '[PROJECT]';
$region = '[REGION]';
abandon_instances_sample($instanceGroupManager, $project, $region);
}
applyUpdatesToInstances
Apply updates to selected instances the managed instance group.
| Parameters | |
|---|---|
| Name | Description |
instanceGroupManager |
string
The name of the managed instance group, should conform to RFC1035. |
project |
string
Project ID for this request. |
region |
string
Name of the region scoping this request, should conform to RFC1035. |
regionInstanceGroupManagersApplyUpdatesRequestResource |
Google\Cloud\Compute\V1\RegionInstanceGroupManagersApplyUpdatesRequest
The body resource for this request |
optionalArgs |
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\OperationResponse | |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\RegionInstanceGroupManagersApplyUpdatesRequest;
use Google\Cloud\Compute\V1\RegionInstanceGroupManagersClient;
use Google\Rpc\Status;
/**
* @param string $instanceGroupManager The name of the managed instance group, should conform to RFC1035.
* @param string $project Project ID for this request.
* @param string $region Name of the region scoping this request, should conform to RFC1035.
*/
function apply_updates_to_instances_sample(
string $instanceGroupManager,
string $project,
string $region
): void {
// Create a client.
$regionInstanceGroupManagersClient = new RegionInstanceGroupManagersClient();
// Prepare any non-scalar elements to be passed along with the request.
$regionInstanceGroupManagersApplyUpdatesRequestResource = new RegionInstanceGroupManagersApplyUpdatesRequest();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $regionInstanceGroupManagersClient->applyUpdatesToInstances(
$instanceGroupManager,
$project,
$region,
$regionInstanceGroupManagersApplyUpdatesRequestResource
);
$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());
}
}
/**
* 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
{
$instanceGroupManager = '[INSTANCE_GROUP_MANAGER]';
$project = '[PROJECT]';
$region = '[REGION]';
apply_updates_to_instances_sample($instanceGroupManager, $project, $region);
}
createInstances
Creates instances with per-instance configurations in this regional managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method.
| Parameters | |
|---|---|
| Name | Description |
instanceGroupManager |
string
The name of the managed instance group. It should conform to RFC1035. |
project |
string
Project ID for this request. |
region |
string
The name of the region where the managed instance group is located. It should conform to RFC1035. |
regionInstanceGroupManagersCreateInstancesRequestResource |
Google\Cloud\Compute\V1\RegionInstanceGroupManagersCreateInstancesRequest
The body resource 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. 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\RegionInstanceGroupManagersClient;
use Google\Cloud\Compute\V1\RegionInstanceGroupManagersCreateInstancesRequest;
use Google\Rpc\Status;
/**
* @param string $instanceGroupManager The name of the managed instance group. It should conform to RFC1035.
* @param string $project Project ID for this request.
* @param string $region The name of the region where the managed instance group is located. It should conform to RFC1035.
*/
function create_instances_sample(
string $instanceGroupManager,
string $project,
string $region
): void {
// Create a client.
$regionInstanceGroupManagersClient = new RegionInstanceGroupManagersClient();
// Prepare any non-scalar elements to be passed along with the request.
$regionInstanceGroupManagersCreateInstancesRequestResource = new RegionInstanceGroupManagersCreateInstancesRequest();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $regionInstanceGroupManagersClient->createInstances(
$instanceGroupManager,
$project,
$region,
$regionInstanceGroupManagersCreateInstancesRequestResource
);
$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());
}
}
/**
* 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
{
$instanceGroupManager = '[INSTANCE_GROUP_MANAGER]';
$project = '[PROJECT]';
$region = '[REGION]';
create_instances_sample($instanceGroupManager, $project, $region);
}
delete
Deletes the specified managed instance group and all of the instances in that group.
| Parameters | |
|---|---|
| Name | Description |
instanceGroupManager |
string
Name of the managed instance group to delete. |
project |
string
Project ID for this request. |
region |
string
Name of the region scoping 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\RegionInstanceGroupManagersClient;
use Google\Rpc\Status;
/**
* @param string $instanceGroupManager Name of the managed instance group to delete.
* @param string $project Project ID for this request.
* @param string $region Name of the region scoping this request.
*/
function delete_sample(string $instanceGroupManager, string $project, string $region): void
{
// Create a client.
$regionInstanceGroupManagersClient = new RegionInstanceGroupManagersClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $regionInstanceGroupManagersClient->delete($instanceGroupManager, $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());
}
}
/**
* 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
{
$instanceGroupManager = '[INSTANCE_GROUP_MANAGER]';
$project = '[PROJECT]';
$region = '[REGION]';
delete_sample($instanceGroupManager, $project, $region);
}
deleteInstances
Flags the specified instances in the managed instance group to be immediately deleted. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.
| Parameters | |
|---|---|
| Name | Description |
instanceGroupManager |
string
Name of the managed instance group. |
project |
string
Project ID for this request. |
region |
string
Name of the region scoping this request. |
regionInstanceGroupManagersDeleteInstancesRequestResource |
Google\Cloud\Compute\V1\RegionInstanceGroupManagersDeleteInstancesRequest
The body resource 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\RegionInstanceGroupManagersClient;
use Google\Cloud\Compute\V1\RegionInstanceGroupManagersDeleteInstancesRequest;
use Google\Rpc\Status;
/**
* @param string $instanceGroupManager Name of the managed instance group.
* @param string $project Project ID for this request.
* @param string $region Name of the region scoping this request.
*/
function delete_instances_sample(
string $instanceGroupManager,
string $project,
string $region
): void {
// Create a client.
$regionInstanceGroupManagersClient = new RegionInstanceGroupManagersClient();
// Prepare any non-scalar elements to be passed along with the request.
$regionInstanceGroupManagersDeleteInstancesRequestResource = new RegionInstanceGroupManagersDeleteInstancesRequest();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $regionInstanceGroupManagersClient->deleteInstances(
$instanceGroupManager,
$project,
$region,
$regionInstanceGroupManagersDeleteInstancesRequestResource
);
$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());
}
}
/**
* 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
{
$instanceGroupManager = '[INSTANCE_GROUP_MANAGER]';
$project = '[PROJECT]';
$region = '[REGION]';
delete_instances_sample($instanceGroupManager, $project, $region);
}
deletePerInstanceConfigs
Deletes selected per-instance configurations for the managed instance group.
| Parameters | |
|---|---|
| Name | Description |
instanceGroupManager |
string
The name of the managed instance group. It should conform to RFC1035. |
project |
string
Project ID for this request. |
region |
string
Name of the region scoping this request, should conform to RFC1035. |
regionInstanceGroupManagerDeleteInstanceConfigReqResource |
Google\Cloud\Compute\V1\RegionInstanceGroupManagerDeleteInstanceConfigReq
The body resource for this request |
optionalArgs |
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\OperationResponse | |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\RegionInstanceGroupManagerDeleteInstanceConfigReq;
use Google\Cloud\Compute\V1\RegionInstanceGroupManagersClient;
use Google\Rpc\Status;
/**
* @param string $instanceGroupManager The name of the managed instance group. It should conform to RFC1035.
* @param string $project Project ID for this request.
* @param string $region Name of the region scoping this request, should conform to RFC1035.
*/
function delete_per_instance_configs_sample(
string $instanceGroupManager,
string $project,
string $region
): void {
// Create a client.
$regionInstanceGroupManagersClient = new RegionInstanceGroupManagersClient();
// Prepare any non-scalar elements to be passed along with the request.
$regionInstanceGroupManagerDeleteInstanceConfigReqResource = new RegionInstanceGroupManagerDeleteInstanceConfigReq();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $regionInstanceGroupManagersClient->deletePerInstanceConfigs(
$instanceGroupManager,
$project,
$region,
$regionInstanceGroupManagerDeleteInstanceConfigReqResource
);
$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());
}
}
/**
* 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
{
$instanceGroupManager = '[INSTANCE_GROUP_MANAGER]';
$project = '[PROJECT]';
$region = '[REGION]';
delete_per_instance_configs_sample($instanceGroupManager, $project, $region);
}
get
Returns all of the details about the specified managed instance group.
| Parameters | |
|---|---|
| Name | Description |
instanceGroupManager |
string
Name of the managed instance group to return. |
project |
string
Project ID for this request. |
region |
string
Name of the region scoping this request. |
optionalArgs |
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\InstanceGroupManager | |
use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\InstanceGroupManager;
use Google\Cloud\Compute\V1\RegionInstanceGroupManagersClient;
/**
* @param string $instanceGroupManager Name of the managed instance group to return.
* @param string $project Project ID for this request.
* @param string $region Name of the region scoping this request.
*/
function get_sample(string $instanceGroupManager, string $project, string $region): void
{
// Create a client.
$regionInstanceGroupManagersClient = new RegionInstanceGroupManagersClient();
// Call the API and handle any network failures.
try {
/** @var InstanceGroupManager $response */
$response = $regionInstanceGroupManagersClient->get($instanceGroupManager, $project, $region);
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
{
$instanceGroupManager = '[INSTANCE_GROUP_MANAGER]';
$project = '[PROJECT]';
$region = '[REGION]';
get_sample($instanceGroupManager, $project, $region);
}
insert
Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A regional managed instance group can contain up to 2000 instances.
| Parameters | |
|---|---|
| Name | Description |
instanceGroupManagerResource |
Google\Cloud\Compute\V1\InstanceGroupManager
The body resource for this request |
project |
string
Project ID for this request. |
region |
string
Name of the region scoping 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\InstanceGroupManager;
use Google\Cloud\Compute\V1\RegionInstanceGroupManagersClient;
use Google\Rpc\Status;
/**
* @param string $project Project ID for this request.
* @param string $region Name of the region scoping this request.
*/
function insert_sample(string $project, string $region): void
{
// Create a client.
$regionInstanceGroupManagersClient = new RegionInstanceGroupManagersClient();
// Prepare any non-scalar elements to be passed along with the request.
$instanceGroupManagerResource = new InstanceGroupManager();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $regionInstanceGroupManagersClient->insert(
$instanceGroupManagerResource,
$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());
}
}
/**
* 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]';
insert_sample($project, $region);
}
list
Retrieves the list of managed instance groups that are contained within the specified region.
| Parameters | |
|---|---|
| Name | Description |
project |
string
Project ID for this request. |
region |
string
Name of the region scoping this request. |
optionalArgs |
array
Optional. |
↳ filter |
string
A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either |
↳ maxResults |
int
The maximum number of results per page that should be returned. If the number of available results is larger than |
↳ orderBy |
string
Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ returnPartialSuccess |
bool
Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. |
↳ 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\RegionInstanceGroupManagersClient;
/**
* @param string $project Project ID for this request.
* @param string $region Name of the region scoping this request.
*/
function list_sample(string $project, string $region): void
{
// Create a client.
$regionInstanceGroupManagersClient = new RegionInstanceGroupManagersClient();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $regionInstanceGroupManagersClient->list($project, $region);
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);
}
listErrors
Lists all errors thrown by actions on instances for a given regional managed instance group. The filter and orderBy query parameters are not supported.
| Parameters | |
|---|---|
| Name | Description |
instanceGroupManager |
string
The name of the managed instance group. It must be a string that meets the requirements in RFC1035, or an unsigned long integer: must match regexp pattern: (?:a-z?)|1-9{0,19}. |
project |
string
Project ID for this request. |
region |
string
Name of the region scoping this request. This should conform to RFC1035. |
optionalArgs |
array
Optional. |
↳ filter |
string
A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either |
↳ maxResults |
int
The maximum number of results per page that should be returned. If the number of available results is larger than |
↳ orderBy |
string
Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ returnPartialSuccess |
bool
Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. |
↳ 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\RegionInstanceGroupManagersClient;
/**
* @param string $instanceGroupManager The name of the managed instance group. It must be a string that meets the requirements in RFC1035, or an unsigned long integer: must match regexp pattern: (?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)|1-9{0,19}.
* @param string $project Project ID for this request.
* @param string $region Name of the region scoping this request. This should conform to RFC1035.
*/
function list_errors_sample(string $instanceGroupManager, string $project, string $region): void
{
// Create a client.
$regionInstanceGroupManagersClient = new RegionInstanceGroupManagersClient();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $regionInstanceGroupManagersClient->listErrors(
$instanceGroupManager,
$project,
$region
);
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
{
$instanceGroupManager = '[INSTANCE_GROUP_MANAGER]';
$project = '[PROJECT]';
$region = '[REGION]';
list_errors_sample($instanceGroupManager, $project, $region);
}
listManagedInstances
Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. The orderBy query parameter is not supported. The pageToken query parameter is supported only in the alpha and beta API and only if the group's listManagedInstancesResults field is set to PAGINATED.
| Parameters | |
|---|---|
| Name | Description |
instanceGroupManager |
string
The name of the managed instance group. |
project |
string
Project ID for this request. |
region |
string
Name of the region scoping this request. |
optionalArgs |
array
Optional. |
↳ filter |
string
A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either |
↳ maxResults |
int
The maximum number of results per page that should be returned. If the number of available results is larger than |
↳ orderBy |
string
Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ returnPartialSuccess |
bool
Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. |
↳ 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\RegionInstanceGroupManagersClient;
/**
* @param string $instanceGroupManager The name of the managed instance group.
* @param string $project Project ID for this request.
* @param string $region Name of the region scoping this request.
*/
function list_managed_instances_sample(
string $instanceGroupManager,
string $project,
string $region
): void {
// Create a client.
$regionInstanceGroupManagersClient = new RegionInstanceGroupManagersClient();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $regionInstanceGroupManagersClient->listManagedInstances(
$instanceGroupManager,
$project,
$region
);
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
{
$instanceGroupManager = '[INSTANCE_GROUP_MANAGER]';
$project = '[PROJECT]';
$region = '[REGION]';
list_managed_instances_sample($instanceGroupManager, $project, $region);
}
listPerInstanceConfigs
Lists all of the per-instance configurations defined for the managed instance group. The orderBy query parameter is not supported.
| Parameters | |
|---|---|
| Name | Description |
instanceGroupManager |
string
The name of the managed instance group. It should conform to RFC1035. |
project |
string
Project ID for this request. |
region |
string
Name of the region scoping this request, should conform to RFC1035. |
optionalArgs |
array
Optional. |
↳ filter |
string
A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either |
↳ maxResults |
int
The maximum number of results per page that should be returned. If the number of available results is larger than |
↳ orderBy |
string
Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ returnPartialSuccess |
bool
Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. |
↳ 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\RegionInstanceGroupManagersClient;
/**
* @param string $instanceGroupManager The name of the managed instance group. It should conform to RFC1035.
* @param string $project Project ID for this request.
* @param string $region Name of the region scoping this request, should conform to RFC1035.
*/
function list_per_instance_configs_sample(
string $instanceGroupManager,
string $project,
string $region
): void {
// Create a client.
$regionInstanceGroupManagersClient = new RegionInstanceGroupManagersClient();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $regionInstanceGroupManagersClient->listPerInstanceConfigs(
$instanceGroupManager,
$project,
$region
);
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
{
$instanceGroupManager = '[INSTANCE_GROUP_MANAGER]';
$project = '[PROJECT]';
$region = '[REGION]';
list_per_instance_configs_sample($instanceGroupManager, $project, $region);
}
patch
Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG.
| Parameters | |
|---|---|
| Name | Description |
instanceGroupManager |
string
The name of the instance group manager. |
instanceGroupManagerResource |
Google\Cloud\Compute\V1\InstanceGroupManager
The body resource for this request |
project |
string
Project ID for this request. |
region |
string
Name of the region scoping 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\InstanceGroupManager;
use Google\Cloud\Compute\V1\RegionInstanceGroupManagersClient;
use Google\Rpc\Status;
/**
* @param string $instanceGroupManager The name of the instance group manager.
* @param string $project Project ID for this request.
* @param string $region Name of the region scoping this request.
*/
function patch_sample(string $instanceGroupManager, string $project, string $region): void
{
// Create a client.
$regionInstanceGroupManagersClient = new RegionInstanceGroupManagersClient();
// Prepare any non-scalar elements to be passed along with the request.
$instanceGroupManagerResource = new InstanceGroupManager();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $regionInstanceGroupManagersClient->patch(
$instanceGroupManager,
$instanceGroupManagerResource,
$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());
}
}
/**
* 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
{
$instanceGroupManager = '[INSTANCE_GROUP_MANAGER]';
$project = '[PROJECT]';
$region = '[REGION]';
patch_sample($instanceGroupManager, $project, $region);
}
patchPerInstanceConfigs
Inserts or patches per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.
| Parameters | |
|---|---|
| Name | Description |
instanceGroupManager |
string
The name of the managed instance group. It should conform to RFC1035. |
project |
string
Project ID for this request. |
region |
string
Name of the region scoping this request, should conform to RFC1035. |
regionInstanceGroupManagerPatchInstanceConfigReqResource |
Google\Cloud\Compute\V1\RegionInstanceGroupManagerPatchInstanceConfigReq
The body resource 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\RegionInstanceGroupManagerPatchInstanceConfigReq;
use Google\Cloud\Compute\V1\RegionInstanceGroupManagersClient;
use Google\Rpc\Status;
/**
* @param string $instanceGroupManager The name of the managed instance group. It should conform to RFC1035.
* @param string $project Project ID for this request.
* @param string $region Name of the region scoping this request, should conform to RFC1035.
*/
function patch_per_instance_configs_sample(
string $instanceGroupManager,
string $project,
string $region
): void {
// Create a client.
$regionInstanceGroupManagersClient = new RegionInstanceGroupManagersClient();
// Prepare any non-scalar elements to be passed along with the request.
$regionInstanceGroupManagerPatchInstanceConfigReqResource = new RegionInstanceGroupManagerPatchInstanceConfigReq();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $regionInstanceGroupManagersClient->patchPerInstanceConfigs(
$instanceGroupManager,
$project,
$region,
$regionInstanceGroupManagerPatchInstanceConfigReqResource
);
$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());
}
}
/**
* 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
{
$instanceGroupManager = '[INSTANCE_GROUP_MANAGER]';
$project = '[PROJECT]';
$region = '[REGION]';
patch_per_instance_configs_sample($instanceGroupManager, $project, $region);
}
recreateInstances
Flags the specified VM instances in the managed instance group to be immediately recreated. Each instance is recreated using the group's current configuration. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of each instance by checking its currentAction field; for more information, see Checking the status of managed instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.
| Parameters | |
|---|---|
| Name | Description |
instanceGroupManager |
string
Name of the managed instance group. |
project |
string
Project ID for this request. |
region |
string
Name of the region scoping this request. |
regionInstanceGroupManagersRecreateRequestResource |
Google\Cloud\Compute\V1\RegionInstanceGroupManagersRecreateRequest
The body resource 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\RegionInstanceGroupManagersClient;
use Google\Cloud\Compute\V1\RegionInstanceGroupManagersRecreateRequest;
use Google\Rpc\Status;
/**
* @param string $instanceGroupManager Name of the managed instance group.
* @param string $project Project ID for this request.
* @param string $region Name of the region scoping this request.
*/
function recreate_instances_sample(
string $instanceGroupManager,
string $project,
string $region
): void {
// Create a client.
$regionInstanceGroupManagersClient = new RegionInstanceGroupManagersClient();
// Prepare any non-scalar elements to be passed along with the request.
$regionInstanceGroupManagersRecreateRequestResource = new RegionInstanceGroupManagersRecreateRequest();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $regionInstanceGroupManagersClient->recreateInstances(
$instanceGroupManager,
$project,
$region,
$regionInstanceGroupManagersRecreateRequestResource
);
$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());
}
}
/**
* 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
{
$instanceGroupManager = '[INSTANCE_GROUP_MANAGER]';
$project = '[PROJECT]';
$region = '[REGION]';
recreate_instances_sample($instanceGroupManager, $project, $region);
}
resize
Changes the intended size of the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.
| Parameters | |
|---|---|
| Name | Description |
instanceGroupManager |
string
Name of the managed instance group. |
project |
string
Project ID for this request. |
region |
string
Name of the region scoping this request. |
size |
int
Number of instances that should exist in this instance group manager. |
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\RegionInstanceGroupManagersClient;
use Google\Rpc\Status;
/**
* @param string $instanceGroupManager Name of the managed instance group.
* @param string $project Project ID for this request.
* @param string $region Name of the region scoping this request.
* @param int $size Number of instances that should exist in this instance group manager.
*/
function resize_sample(
string $instanceGroupManager,
string $project,
string $region,
int $size
): void {
// Create a client.
$regionInstanceGroupManagersClient = new RegionInstanceGroupManagersClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $regionInstanceGroupManagersClient->resize(
$instanceGroupManager,
$project,
$region,
$size
);
$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());
}
}
/**
* 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
{
$instanceGroupManager = '[INSTANCE_GROUP_MANAGER]';
$project = '[PROJECT]';
$region = '[REGION]';
$size = 0;
resize_sample($instanceGroupManager, $project, $region, $size);
}
setInstanceTemplate
Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.
| Parameters | |
|---|---|
| Name | Description |
instanceGroupManager |
string
The name of the managed instance group. |
project |
string
Project ID for this request. |
region |
string
Name of the region scoping this request. |
regionInstanceGroupManagersSetTemplateRequestResource |
Google\Cloud\Compute\V1\RegionInstanceGroupManagersSetTemplateRequest
The body resource 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\RegionInstanceGroupManagersClient;
use Google\Cloud\Compute\V1\RegionInstanceGroupManagersSetTemplateRequest;
use Google\Rpc\Status;
/**
* @param string $instanceGroupManager The name of the managed instance group.
* @param string $project Project ID for this request.
* @param string $region Name of the region scoping this request.
*/
function set_instance_template_sample(
string $instanceGroupManager,
string $project,
string $region
): void {
// Create a client.
$regionInstanceGroupManagersClient = new RegionInstanceGroupManagersClient();
// Prepare any non-scalar elements to be passed along with the request.
$regionInstanceGroupManagersSetTemplateRequestResource = new RegionInstanceGroupManagersSetTemplateRequest();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $regionInstanceGroupManagersClient->setInstanceTemplate(
$instanceGroupManager,
$project,
$region,
$regionInstanceGroupManagersSetTemplateRequestResource
);
$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());
}
}
/**
* 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
{
$instanceGroupManager = '[INSTANCE_GROUP_MANAGER]';
$project = '[PROJECT]';
$region = '[REGION]';
set_instance_template_sample($instanceGroupManager, $project, $region);
}
setTargetPools
Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.
| Parameters | |
|---|---|
| Name | Description |
instanceGroupManager |
string
Name of the managed instance group. |
project |
string
Project ID for this request. |
region |
string
Name of the region scoping this request. |
regionInstanceGroupManagersSetTargetPoolsRequestResource |
Google\Cloud\Compute\V1\RegionInstanceGroupManagersSetTargetPoolsRequest
The body resource 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\RegionInstanceGroupManagersClient;
use Google\Cloud\Compute\V1\RegionInstanceGroupManagersSetTargetPoolsRequest;
use Google\Rpc\Status;
/**
* @param string $instanceGroupManager Name of the managed instance group.
* @param string $project Project ID for this request.
* @param string $region Name of the region scoping this request.
*/
function set_target_pools_sample(
string $instanceGroupManager,
string $project,
string $region
): void {
// Create a client.
$regionInstanceGroupManagersClient = new RegionInstanceGroupManagersClient();
// Prepare any non-scalar elements to be passed along with the request.
$regionInstanceGroupManagersSetTargetPoolsRequestResource = new RegionInstanceGroupManagersSetTargetPoolsRequest();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $regionInstanceGroupManagersClient->setTargetPools(
$instanceGroupManager,
$project,
$region,
$regionInstanceGroupManagersSetTargetPoolsRequestResource
);
$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());
}
}
/**
* 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
{
$instanceGroupManager = '[INSTANCE_GROUP_MANAGER]';
$project = '[PROJECT]';
$region = '[REGION]';
set_target_pools_sample($instanceGroupManager, $project, $region);
}
updatePerInstanceConfigs
Inserts or updates per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.
| Parameters | |
|---|---|
| Name | Description |
instanceGroupManager |
string
The name of the managed instance group. It should conform to RFC1035. |
project |
string
Project ID for this request. |
region |
string
Name of the region scoping this request, should conform to RFC1035. |
regionInstanceGroupManagerUpdateInstanceConfigReqResource |
Google\Cloud\Compute\V1\RegionInstanceGroupManagerUpdateInstanceConfigReq
The body resource 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\RegionInstanceGroupManagerUpdateInstanceConfigReq;
use Google\Cloud\Compute\V1\RegionInstanceGroupManagersClient;
use Google\Rpc\Status;
/**
* @param string $instanceGroupManager The name of the managed instance group. It should conform to RFC1035.
* @param string $project Project ID for this request.
* @param string $region Name of the region scoping this request, should conform to RFC1035.
*/
function update_per_instance_configs_sample(
string $instanceGroupManager,
string $project,
string $region
): void {
// Create a client.
$regionInstanceGroupManagersClient = new RegionInstanceGroupManagersClient();
// Prepare any non-scalar elements to be passed along with the request.
$regionInstanceGroupManagerUpdateInstanceConfigReqResource = new RegionInstanceGroupManagerUpdateInstanceConfigReq();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $regionInstanceGroupManagersClient->updatePerInstanceConfigs(
$instanceGroupManager,
$project,
$region,
$regionInstanceGroupManagerUpdateInstanceConfigReqResource
);
$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());
}
}
/**
* 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
{
$instanceGroupManager = '[INSTANCE_GROUP_MANAGER]';
$project = '[PROJECT]';
$region = '[REGION]';
update_per_instance_configs_sample($instanceGroupManager, $project, $region);
}
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 | |
Constants
SERVICE_NAME
Value: 'google.cloud.compute.v1.RegionInstanceGroupManagers'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.