Reference documentation and code samples for the Compute V1 Client class TargetPoolsClient.
Service Description: The TargetPools API.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods.
Namespace
Google \ Cloud \ Compute \ V1 \ ClientMethods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
options |
array
Optional. Options for configuring the service API wrapper. |
↳ apiEndpoint |
string
The address of the API remote host. May optionally include the port, formatted as "
|
↳ credentials |
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. 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 |
↳ clientConfig |
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder. |
↳ transport |
string|TransportInterface
The transport used for executing network requests. At the moment, supports only |
↳ transportConfig |
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'rest' => [...], ]; See the Google\ApiCore\Transport\RestTransport::build() method for the supported options. |
↳ clientCertSource |
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS. |
↳ logger |
false|LoggerInterface
A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag |
addHealthCheck
Adds health check URLs to a target pool.
The async variant is TargetPoolsClient::addHealthCheckAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\AddHealthCheckTargetPoolRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\AddHealthCheckTargetPoolRequest;
use Google\Cloud\Compute\V1\Client\TargetPoolsClient;
use Google\Cloud\Compute\V1\TargetPoolsAddHealthCheckRequest;
use Google\Rpc\Status;
/**
* @param string $project Project ID for this request.
* @param string $region Name of the region scoping this request.
* @param string $targetPool Name of the target pool to add a health check to.
*/
function add_health_check_sample(string $project, string $region, string $targetPool): void
{
// Create a client.
$targetPoolsClient = new TargetPoolsClient();
// Prepare the request message.
$targetPoolsAddHealthCheckRequestResource = new TargetPoolsAddHealthCheckRequest();
$request = (new AddHealthCheckTargetPoolRequest())
->setProject($project)
->setRegion($region)
->setTargetPool($targetPool)
->setTargetPoolsAddHealthCheckRequestResource($targetPoolsAddHealthCheckRequestResource);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $targetPoolsClient->addHealthCheck($request);
$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]';
$targetPool = '[TARGET_POOL]';
add_health_check_sample($project, $region, $targetPool);
}
addInstance
Adds an instance to a target pool.
The async variant is TargetPoolsClient::addInstanceAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\AddInstanceTargetPoolRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\AddInstanceTargetPoolRequest;
use Google\Cloud\Compute\V1\Client\TargetPoolsClient;
use Google\Cloud\Compute\V1\TargetPoolsAddInstanceRequest;
use Google\Rpc\Status;
/**
* @param string $project Project ID for this request.
* @param string $region Name of the region scoping this request.
* @param string $targetPool Name of the TargetPool resource to add instances to.
*/
function add_instance_sample(string $project, string $region, string $targetPool): void
{
// Create a client.
$targetPoolsClient = new TargetPoolsClient();
// Prepare the request message.
$targetPoolsAddInstanceRequestResource = new TargetPoolsAddInstanceRequest();
$request = (new AddInstanceTargetPoolRequest())
->setProject($project)
->setRegion($region)
->setTargetPool($targetPool)
->setTargetPoolsAddInstanceRequestResource($targetPoolsAddInstanceRequestResource);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $targetPoolsClient->addInstance($request);
$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]';
$targetPool = '[TARGET_POOL]';
add_instance_sample($project, $region, $targetPool);
}
aggregatedList
Retrieves an aggregated list of target pools. To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
.
The async variant is TargetPoolsClient::aggregatedListAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\AggregatedListTargetPoolsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Compute\V1\AggregatedListTargetPoolsRequest;
use Google\Cloud\Compute\V1\Client\TargetPoolsClient;
/**
* @param string $project Project ID for this request.
*/
function aggregated_list_sample(string $project): void
{
// Create a client.
$targetPoolsClient = new TargetPoolsClient();
// Prepare the request message.
$request = (new AggregatedListTargetPoolsRequest())
->setProject($project);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $targetPoolsClient->aggregatedList($request);
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$project = '[PROJECT]';
aggregated_list_sample($project);
}
delete
Deletes the specified target pool.
The async variant is TargetPoolsClient::deleteAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\DeleteTargetPoolRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\TargetPoolsClient;
use Google\Cloud\Compute\V1\DeleteTargetPoolRequest;
use Google\Rpc\Status;
/**
* @param string $project Project ID for this request.
* @param string $region Name of the region scoping this request.
* @param string $targetPool Name of the TargetPool resource to delete.
*/
function delete_sample(string $project, string $region, string $targetPool): void
{
// Create a client.
$targetPoolsClient = new TargetPoolsClient();
// Prepare the request message.
$request = (new DeleteTargetPoolRequest())
->setProject($project)
->setRegion($region)
->setTargetPool($targetPool);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $targetPoolsClient->delete($request);
$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]';
$targetPool = '[TARGET_POOL]';
delete_sample($project, $region, $targetPool);
}
get
Returns the specified target pool.
The async variant is TargetPoolsClient::getAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\GetTargetPoolRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Compute\V1\TargetPool |
use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\Client\TargetPoolsClient;
use Google\Cloud\Compute\V1\GetTargetPoolRequest;
use Google\Cloud\Compute\V1\TargetPool;
/**
* @param string $project Project ID for this request.
* @param string $region Name of the region scoping this request.
* @param string $targetPool Name of the TargetPool resource to return.
*/
function get_sample(string $project, string $region, string $targetPool): void
{
// Create a client.
$targetPoolsClient = new TargetPoolsClient();
// Prepare the request message.
$request = (new GetTargetPoolRequest())
->setProject($project)
->setRegion($region)
->setTargetPool($targetPool);
// Call the API and handle any network failures.
try {
/** @var TargetPool $response */
$response = $targetPoolsClient->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
{
$project = '[PROJECT]';
$region = '[REGION]';
$targetPool = '[TARGET_POOL]';
get_sample($project, $region, $targetPool);
}
getHealth
Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.
The async variant is TargetPoolsClient::getHealthAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\GetHealthTargetPoolRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Compute\V1\TargetPoolInstanceHealth |
use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\Client\TargetPoolsClient;
use Google\Cloud\Compute\V1\GetHealthTargetPoolRequest;
use Google\Cloud\Compute\V1\InstanceReference;
use Google\Cloud\Compute\V1\TargetPoolInstanceHealth;
/**
* @param string $project Project ID for this request.
* @param string $region Name of the region scoping this request.
* @param string $targetPool Name of the TargetPool resource to which the queried instance belongs.
*/
function get_health_sample(string $project, string $region, string $targetPool): void
{
// Create a client.
$targetPoolsClient = new TargetPoolsClient();
// Prepare the request message.
$instanceReferenceResource = new InstanceReference();
$request = (new GetHealthTargetPoolRequest())
->setInstanceReferenceResource($instanceReferenceResource)
->setProject($project)
->setRegion($region)
->setTargetPool($targetPool);
// Call the API and handle any network failures.
try {
/** @var TargetPoolInstanceHealth $response */
$response = $targetPoolsClient->getHealth($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
{
$project = '[PROJECT]';
$region = '[REGION]';
$targetPool = '[TARGET_POOL]';
get_health_sample($project, $region, $targetPool);
}
insert
Creates a target pool in the specified project and region using the data included in the request.
The async variant is TargetPoolsClient::insertAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\InsertTargetPoolRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\TargetPoolsClient;
use Google\Cloud\Compute\V1\InsertTargetPoolRequest;
use Google\Cloud\Compute\V1\TargetPool;
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.
$targetPoolsClient = new TargetPoolsClient();
// Prepare the request message.
$targetPoolResource = new TargetPool();
$request = (new InsertTargetPoolRequest())
->setProject($project)
->setRegion($region)
->setTargetPoolResource($targetPoolResource);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $targetPoolsClient->insert($request);
$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 a list of target pools available to the specified project and region.
The async variant is TargetPoolsClient::listAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\ListTargetPoolsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Compute\V1\Client\TargetPoolsClient;
use Google\Cloud\Compute\V1\ListTargetPoolsRequest;
/**
* @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.
$targetPoolsClient = new TargetPoolsClient();
// Prepare the request message.
$request = (new ListTargetPoolsRequest())
->setProject($project)
->setRegion($region);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $targetPoolsClient->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);
}
removeHealthCheck
Removes health check URL from a target pool.
The async variant is TargetPoolsClient::removeHealthCheckAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\RemoveHealthCheckTargetPoolRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\TargetPoolsClient;
use Google\Cloud\Compute\V1\RemoveHealthCheckTargetPoolRequest;
use Google\Cloud\Compute\V1\TargetPoolsRemoveHealthCheckRequest;
use Google\Rpc\Status;
/**
* @param string $project Project ID for this request.
* @param string $region Name of the region for this request.
* @param string $targetPool Name of the target pool to remove health checks from.
*/
function remove_health_check_sample(string $project, string $region, string $targetPool): void
{
// Create a client.
$targetPoolsClient = new TargetPoolsClient();
// Prepare the request message.
$targetPoolsRemoveHealthCheckRequestResource = new TargetPoolsRemoveHealthCheckRequest();
$request = (new RemoveHealthCheckTargetPoolRequest())
->setProject($project)
->setRegion($region)
->setTargetPool($targetPool)
->setTargetPoolsRemoveHealthCheckRequestResource($targetPoolsRemoveHealthCheckRequestResource);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $targetPoolsClient->removeHealthCheck($request);
$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]';
$targetPool = '[TARGET_POOL]';
remove_health_check_sample($project, $region, $targetPool);
}
removeInstance
Removes instance URL from a target pool.
The async variant is TargetPoolsClient::removeInstanceAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\RemoveInstanceTargetPoolRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\TargetPoolsClient;
use Google\Cloud\Compute\V1\RemoveInstanceTargetPoolRequest;
use Google\Cloud\Compute\V1\TargetPoolsRemoveInstanceRequest;
use Google\Rpc\Status;
/**
* @param string $project Project ID for this request.
* @param string $region Name of the region scoping this request.
* @param string $targetPool Name of the TargetPool resource to remove instances from.
*/
function remove_instance_sample(string $project, string $region, string $targetPool): void
{
// Create a client.
$targetPoolsClient = new TargetPoolsClient();
// Prepare the request message.
$targetPoolsRemoveInstanceRequestResource = new TargetPoolsRemoveInstanceRequest();
$request = (new RemoveInstanceTargetPoolRequest())
->setProject($project)
->setRegion($region)
->setTargetPool($targetPool)
->setTargetPoolsRemoveInstanceRequestResource($targetPoolsRemoveInstanceRequestResource);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $targetPoolsClient->removeInstance($request);
$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]';
$targetPool = '[TARGET_POOL]';
remove_instance_sample($project, $region, $targetPool);
}
setBackup
Changes a backup target pool's configurations.
The async variant is TargetPoolsClient::setBackupAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\SetBackupTargetPoolRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\TargetPoolsClient;
use Google\Cloud\Compute\V1\SetBackupTargetPoolRequest;
use Google\Cloud\Compute\V1\TargetReference;
use Google\Rpc\Status;
/**
* @param string $project Project ID for this request.
* @param string $region Name of the region scoping this request.
* @param string $targetPool Name of the TargetPool resource to set a backup pool for.
*/
function set_backup_sample(string $project, string $region, string $targetPool): void
{
// Create a client.
$targetPoolsClient = new TargetPoolsClient();
// Prepare the request message.
$targetReferenceResource = new TargetReference();
$request = (new SetBackupTargetPoolRequest())
->setProject($project)
->setRegion($region)
->setTargetPool($targetPool)
->setTargetReferenceResource($targetReferenceResource);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $targetPoolsClient->setBackup($request);
$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]';
$targetPool = '[TARGET_POOL]';
set_backup_sample($project, $region, $targetPool);
}
setSecurityPolicy
Sets the Google Cloud Armor security policy for the specified target pool. For more information, see Google Cloud Armor Overview
The async variant is TargetPoolsClient::setSecurityPolicyAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\SetSecurityPolicyTargetPoolRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\TargetPoolsClient;
use Google\Cloud\Compute\V1\SecurityPolicyReference;
use Google\Cloud\Compute\V1\SetSecurityPolicyTargetPoolRequest;
use Google\Rpc\Status;
/**
* @param string $project Project ID for this request.
* @param string $region Name of the region scoping this request.
* @param string $targetPool Name of the TargetPool resource to which the security policy should be set. The name should conform to RFC1035.
*/
function set_security_policy_sample(string $project, string $region, string $targetPool): void
{
// Create a client.
$targetPoolsClient = new TargetPoolsClient();
// Prepare the request message.
$securityPolicyReferenceResource = new SecurityPolicyReference();
$request = (new SetSecurityPolicyTargetPoolRequest())
->setProject($project)
->setRegion($region)
->setSecurityPolicyReferenceResource($securityPolicyReferenceResource)
->setTargetPool($targetPool);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $targetPoolsClient->setSecurityPolicy($request);
$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]';
$targetPool = '[TARGET_POOL]';
set_security_policy_sample($project, $region, $targetPool);
}
addHealthCheckAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\AddHealthCheckTargetPoolRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
addInstanceAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\AddInstanceTargetPoolRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
aggregatedListAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\AggregatedListTargetPoolsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
deleteAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\DeleteTargetPoolRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
getAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\GetTargetPoolRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Compute\V1\TargetPool> |
getHealthAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\GetHealthTargetPoolRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Compute\V1\TargetPoolInstanceHealth> |
insertAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\InsertTargetPoolRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
listAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\ListTargetPoolsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
removeHealthCheckAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\RemoveHealthCheckTargetPoolRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
removeInstanceAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\RemoveInstanceTargetPoolRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
setBackupAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\SetBackupTargetPoolRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
setSecurityPolicyAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\SetSecurityPolicyTargetPoolRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
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 |