Compute V1 Client - Class TargetPoolsClient (1.18.1)

Version 1.18.1

• 1.21.0 (latest)
• 1.20.0
• 1.19.0
• 1.18.1
• 1.17.0
• 1.16.2
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.1
• 1.10.1
• 1.9.1
• 1.8.3
• 1.7.1
• 1.6.1
• 1.5.0

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 \ Client

Methods

__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 false.
↳ clientConfig	string|array Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
↳ transport	string|TransportInterface The transport used for executing network requests. At the moment, supports only rest. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ transportConfig	array Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'rest' => [...], ]; See the Google\ApiCore\Transport\RestTransport::build() method for the supported options.
↳ clientCertSource	callable A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

addHealthCheck

Adds health check URLs to a target pool.

The async variant is Google\Cloud\Compute\V1\Client\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

addInstance

Adds an instance to a target pool.

The async variant is Google\Cloud\Compute\V1\Client\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

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 Google\Cloud\Compute\V1\Client\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

delete

Deletes the specified target pool.

The async variant is Google\Cloud\Compute\V1\Client\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

get

Returns the specified target pool.

The async variant is Google\Cloud\Compute\V1\Client\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

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 Google\Cloud\Compute\V1\Client\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

insert

Creates a target pool in the specified project and region using the data included in the request.

The async variant is Google\Cloud\Compute\V1\Client\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

list

Retrieves a list of target pools available to the specified project and region.

The async variant is Google\Cloud\Compute\V1\Client\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

removeHealthCheck

Removes health check URL from a target pool.

The async variant is Google\Cloud\Compute\V1\Client\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

removeInstance

Removes instance URL from a target pool.

The async variant is Google\Cloud\Compute\V1\Client\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

setBackup

Changes a backup target pool's configurations.

The async variant is Google\Cloud\Compute\V1\Client\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

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 Google\Cloud\Compute\V1\Client\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

addHealthCheckAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\AddHealthCheckTargetPoolRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

addInstanceAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\AddInstanceTargetPoolRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

aggregatedListAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\AggregatedListTargetPoolsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\DeleteTargetPoolRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\GetTargetPoolRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getHealthAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\GetHealthTargetPoolRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

insertAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\InsertTargetPoolRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\ListTargetPoolsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

removeHealthCheckAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\RemoveHealthCheckTargetPoolRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

removeInstanceAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\RemoveInstanceTargetPoolRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

setBackupAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\SetBackupTargetPoolRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

setSecurityPolicyAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\SetSecurityPolicyTargetPoolRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

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