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. Sample code to get started:
$targetPoolsClient = new TargetPoolsClient();
try {
$project = 'project';
$region = 'region';
$targetPool = 'target_pool';
$targetPoolsAddHealthCheckRequestResource = new TargetPoolsAddHealthCheckRequest();
$operationResponse = $targetPoolsClient->addHealthCheck($project, $region, $targetPool, $targetPoolsAddHealthCheckRequestResource);
$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 = $targetPoolsClient->addHealthCheck($project, $region, $targetPool, $targetPoolsAddHealthCheckRequestResource);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $targetPoolsClient->resumeOperation($operationName, 'addHealthCheck');
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 {
$targetPoolsClient->close();
}
This service has a new (beta) implementation. See Google\Cloud\Compute\V1\Client\TargetPoolsClient 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. |
addHealthCheck
Adds health check URLs to a target pool.
Parameters | |
---|---|
Name | Description |
project |
string
Project ID for this request. |
region |
string
Name of the region scoping this request. |
targetPool |
string
Name of the target pool to add a health check to. |
targetPoolsAddHealthCheckRequestResource |
Google\Cloud\Compute\V1\TargetPoolsAddHealthCheckRequest
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\TargetPoolsAddHealthCheckRequest;
use Google\Cloud\Compute\V1\TargetPoolsClient;
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 any non-scalar elements to be passed along with the request.
$targetPoolsAddHealthCheckRequestResource = new TargetPoolsAddHealthCheckRequest();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $targetPoolsClient->addHealthCheck(
$project,
$region,
$targetPool,
$targetPoolsAddHealthCheckRequestResource
);
$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.
Parameters | |
---|---|
Name | Description |
project |
string
Project ID for this request. |
region |
string
Name of the region scoping this request. |
targetPool |
string
Name of the TargetPool resource to add instances to. |
targetPoolsAddInstanceRequestResource |
Google\Cloud\Compute\V1\TargetPoolsAddInstanceRequest
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\TargetPoolsAddInstanceRequest;
use Google\Cloud\Compute\V1\TargetPoolsClient;
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 any non-scalar elements to be passed along with the request.
$targetPoolsAddInstanceRequestResource = new TargetPoolsAddInstanceRequest();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $targetPoolsClient->addInstance(
$project,
$region,
$targetPool,
$targetPoolsAddInstanceRequestResource
);
$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.
Parameters | |
---|---|
Name | Description |
project |
string
Project ID for 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. 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 |
↳ includeAllScopes |
bool
Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. |
↳ 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\TargetPoolsClient;
/**
* @param string $project Project ID for this request.
*/
function aggregated_list_sample(string $project): void
{
// Create a client.
$targetPoolsClient = new TargetPoolsClient();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $targetPoolsClient->aggregatedList($project);
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.
Parameters | |
---|---|
Name | Description |
project |
string
Project ID for this request. |
region |
string
Name of the region scoping this request. |
targetPool |
string
Name of the TargetPool resource to delete. |
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\TargetPoolsClient;
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();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $targetPoolsClient->delete($project, $region, $targetPool);
$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.
Parameters | |
---|---|
Name | Description |
project |
string
Project ID for this request. |
region |
string
Name of the region scoping this request. |
targetPool |
string
Name of the TargetPool resource to return. |
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\TargetPool |
use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\TargetPool;
use Google\Cloud\Compute\V1\TargetPoolsClient;
/**
* @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();
// Call the API and handle any network failures.
try {
/** @var TargetPool $response */
$response = $targetPoolsClient->get($project, $region, $targetPool);
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.
Parameters | |
---|---|
Name | Description |
instanceReferenceResource |
Google\Cloud\Compute\V1\InstanceReference
The body resource for this request |
project |
string
Project ID for this request. |
region |
string
Name of the region scoping this request. |
targetPool |
string
Name of the TargetPool resource to which the queried instance belongs. |
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\TargetPoolInstanceHealth |
use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\InstanceReference;
use Google\Cloud\Compute\V1\TargetPoolInstanceHealth;
use Google\Cloud\Compute\V1\TargetPoolsClient;
/**
* @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 any non-scalar elements to be passed along with the request.
$instanceReferenceResource = new InstanceReference();
// Call the API and handle any network failures.
try {
/** @var TargetPoolInstanceHealth $response */
$response = $targetPoolsClient->getHealth(
$instanceReferenceResource,
$project,
$region,
$targetPool
);
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.
Parameters | |
---|---|
Name | Description |
project |
string
Project ID for this request. |
region |
string
Name of the region scoping this request. |
targetPoolResource |
Google\Cloud\Compute\V1\TargetPool
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\TargetPool;
use Google\Cloud\Compute\V1\TargetPoolsClient;
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 any non-scalar elements to be passed along with the request.
$targetPoolResource = new TargetPool();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $targetPoolsClient->insert($project, $region, $targetPoolResource);
$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.
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. 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\TargetPoolsClient;
/**
* @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();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $targetPoolsClient->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);
}
removeHealthCheck
Removes health check URL from a target pool.
Parameters | |
---|---|
Name | Description |
project |
string
Project ID for this request. |
region |
string
Name of the region for this request. |
targetPool |
string
Name of the target pool to remove health checks from. |
targetPoolsRemoveHealthCheckRequestResource |
Google\Cloud\Compute\V1\TargetPoolsRemoveHealthCheckRequest
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\TargetPoolsClient;
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 any non-scalar elements to be passed along with the request.
$targetPoolsRemoveHealthCheckRequestResource = new TargetPoolsRemoveHealthCheckRequest();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $targetPoolsClient->removeHealthCheck(
$project,
$region,
$targetPool,
$targetPoolsRemoveHealthCheckRequestResource
);
$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.
Parameters | |
---|---|
Name | Description |
project |
string
Project ID for this request. |
region |
string
Name of the region scoping this request. |
targetPool |
string
Name of the TargetPool resource to remove instances from. |
targetPoolsRemoveInstanceRequestResource |
Google\Cloud\Compute\V1\TargetPoolsRemoveInstanceRequest
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\TargetPoolsClient;
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 any non-scalar elements to be passed along with the request.
$targetPoolsRemoveInstanceRequestResource = new TargetPoolsRemoveInstanceRequest();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $targetPoolsClient->removeInstance(
$project,
$region,
$targetPool,
$targetPoolsRemoveInstanceRequestResource
);
$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.
Parameters | |
---|---|
Name | Description |
project |
string
Project ID for this request. |
region |
string
Name of the region scoping this request. |
targetPool |
string
Name of the TargetPool resource to set a backup pool for. |
targetReferenceResource |
Google\Cloud\Compute\V1\TargetReference
The body resource for this request |
optionalArgs |
array
Optional. |
↳ failoverRatio |
float
New failoverRatio value for the target pool. |
↳ 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\TargetPoolsClient;
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 any non-scalar elements to be passed along with the request.
$targetReferenceResource = new TargetReference();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $targetPoolsClient->setBackup($project, $region, $targetPool, $targetReferenceResource);
$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);
}
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.TargetPools'
The name of the service.
SERVICE_ADDRESS
Value: 'compute.googleapis.com'
The default address of the service.
DEFAULT_SERVICE_PORT
Value: 443
The default port of the service.
CODEGEN_NAME
Value: 'gapic'
The name of the code generator, to be included in the agent header.