1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Compute
  7. \
  8. Resource
  9. \
  10. TargetPools

TargetPools

class TargetPools extends Resource (View source)

The "targetPools" collection of methods.

Typical usage is:

 $computeService = new Google\Service\Compute(...);
 $targetPools = $computeService->targetPools;

Methods

Operation
addHealthCheck(string $project, string $region, string $targetPool, TargetPoolsAddHealthCheckRequest $postBody, array $optParams = [])

Adds health check URLs to a target pool. (targetPools.addHealthCheck)

Operation
addInstance(string $project, string $region, string $targetPool, TargetPoolsAddInstanceRequest $postBody, array $optParams = [])

Adds an instance to a target pool. (targetPools.addInstance)

TargetPoolAggregatedList
aggregatedList(string $project, array $optParams = [])

Retrieves an aggregated list of target pools. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Operation
delete(string $project, string $region, string $targetPool, array $optParams = [])

Deletes the specified target pool. (targetPools.delete)

TargetPool
get(string $project, string $region, string $targetPool, array $optParams = [])

Returns the specified target pool. (targetPools.get)

TargetPoolInstanceHealth
getHealth(string $project, string $region, string $targetPool, InstanceReference $postBody, array $optParams = [])

Gets the most recent health check results for each IP for the instance that is referenced by the given target pool. (targetPools.getHealth)

Operation
insert(string $project, string $region, TargetPool $postBody, array $optParams = [])

Creates a target pool in the specified project and region using the data included in the request. (targetPools.insert)

TargetPoolList
listTargetPools(string $project, string $region, array $optParams = [])

Retrieves a list of target pools available to the specified project and region. (targetPools.listTargetPools)

Operation
removeHealthCheck(string $project, string $region, string $targetPool, TargetPoolsRemoveHealthCheckRequest $postBody, array $optParams = [])

Removes health check URL from a target pool. (targetPools.removeHealthCheck)

Operation
removeInstance(string $project, string $region, string $targetPool, TargetPoolsRemoveInstanceRequest $postBody, array $optParams = [])

Removes instance URL from a target pool. (targetPools.removeInstance)

Operation
setBackup(string $project, string $region, string $targetPool, TargetReference $postBody, array $optParams = [])

Changes a backup target pool's configurations. (targetPools.setBackup)

Operation
setSecurityPolicy(string $project, string $region, string $targetPool, SecurityPolicyReference $postBody, array $optParams = [])

Sets the Google Cloud Armor security policy for the specified target pool.

Details

at line 65
Operation addHealthCheck(string $project, string $region, string $targetPool, TargetPoolsAddHealthCheckRequest $postBody, array $optParams = [])

Adds health check URLs to a target pool. (targetPools.addHealthCheck)

Parameters

string $project

Project ID for this request.
string $region

Name of the region scoping this request.
string $targetPool

Name of the target pool to add a health check to.
TargetPoolsAddHealthCheckRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 94
Operation addInstance(string $project, string $region, string $targetPool, TargetPoolsAddInstanceRequest $postBody, array $optParams = [])

Adds an instance to a target pool. (targetPools.addInstance)

Parameters

string $project

Project ID for this request.
string $region

Name of the region scoping this request.
string $targetPool

Name of the TargetPool resource to add instances to.
TargetPoolsAddInstanceRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 174
TargetPoolAggregatedList aggregatedList(string $project, array $optParams = [])

Retrieves an aggregated list of target pools. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

(targetPools.aggregatedList)

Parameters

string $project

Project ID for this request.
array $optParams

Optional parameters.

Return Value

TargetPoolAggregatedList

Exceptions

Exception

at line 201
Operation delete(string $project, string $region, string $targetPool, array $optParams = [])

Deletes the specified target pool. (targetPools.delete)

Parameters

string $project

Project ID for this request.
string $region

Name of the region scoping this request.
string $targetPool

Name of the TargetPool resource to delete.
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 217
TargetPool get(string $project, string $region, string $targetPool, array $optParams = [])

Returns the specified target pool. (targetPools.get)

Parameters

string $project

Project ID for this request.
string $region

Name of the region scoping this request.
string $targetPool

Name of the TargetPool resource to return.
array $optParams

Optional parameters.

Return Value

TargetPool

Exceptions

Exception

at line 236
TargetPoolInstanceHealth getHealth(string $project, string $region, string $targetPool, InstanceReference $postBody, array $optParams = [])

Gets the most recent health check results for each IP for the instance that is referenced by the given target pool. (targetPools.getHealth)

Parameters

string $project

Project ID for this request.
string $region

Name of the region scoping this request.
string $targetPool

Name of the TargetPool resource to which the queried instance belongs.
InstanceReference $postBody
array $optParams

Optional parameters.

Return Value

TargetPoolInstanceHealth

Exceptions

Exception

at line 264
Operation insert(string $project, string $region, TargetPool $postBody, array $optParams = [])

Creates a target pool in the specified project and region using the data included in the request. (targetPools.insert)

Parameters

string $project

Project ID for this request.
string $region

Name of the region scoping this request.
TargetPool $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 334
TargetPoolList listTargetPools(string $project, string $region, array $optParams = [])

Retrieves a list of target pools available to the specified project and region. (targetPools.listTargetPools)

Parameters

string $project

Project ID for this request.
string $region

Name of the region scoping this request.
array $optParams

Optional parameters.

Return Value

TargetPoolList

Exceptions

Exception

at line 363
Operation removeHealthCheck(string $project, string $region, string $targetPool, TargetPoolsRemoveHealthCheckRequest $postBody, array $optParams = [])

Removes health check URL from a target pool. (targetPools.removeHealthCheck)

Parameters

string $project

Project ID for this request.
string $region

Name of the region for this request.
string $targetPool

Name of the target pool to remove health checks from.
TargetPoolsRemoveHealthCheckRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 392
Operation removeInstance(string $project, string $region, string $targetPool, TargetPoolsRemoveInstanceRequest $postBody, array $optParams = [])

Removes instance URL from a target pool. (targetPools.removeInstance)

Parameters

string $project

Project ID for this request.
string $region

Name of the region scoping this request.
string $targetPool

Name of the TargetPool resource to remove instances from.
TargetPoolsRemoveInstanceRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 422
Operation setBackup(string $project, string $region, string $targetPool, TargetReference $postBody, array $optParams = [])

Changes a backup target pool's configurations. (targetPools.setBackup)

Parameters

string $project

Project ID for this request.
string $region

Name of the region scoping this request.
string $targetPool

Name of the TargetPool resource to set a backup pool for.
TargetReference $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 453
Operation setSecurityPolicy(string $project, string $region, string $targetPool, SecurityPolicyReference $postBody, array $optParams = [])

Sets the Google Cloud Armor security policy for the specified target pool.

For more information, see Google Cloud Armor Overview (targetPools.setSecurityPolicy)

Parameters

string $project

Project ID for this request.
string $region

Name of the region scoping this request.
string $targetPool

Name of the TargetPool resource to which the security policy should be set. The name should conform to RFC1035.
SecurityPolicyReference $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception