The "targetPools" collection of methods. More...

Inheritance diagram for Google_Service_Compute_TargetPools_Resource:

Public Member Functions
	addHealthCheck ($project, $region, $targetPool, Google_Service_Compute_TargetPoolsAddHealthCheckRequest $postBody, $optParams=array())
	Adds health check URL to targetPool.

	addInstance ($project, $region, $targetPool, Google_Service_Compute_TargetPoolsAddInstanceRequest $postBody, $optParams=array())
	Adds instance url to targetPool.

	aggregatedList ($project, $optParams=array())
	Retrieves the list of target pools grouped by scope.

	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.

	delete ($project, $region, $targetPool, $optParams=array())
	Deletes the specified TargetPool resource.

	get ($project, $region, $targetPool, $optParams=array())
	Returns the specified TargetPool resource.

	getHealth ($project, $region, $targetPool, Google_Service_Compute_InstanceReference $postBody, $optParams=array())
	Gets the most recent health check results for each IP for the given instance that is referenced by given TargetPool.

	insert ($project, $region, Google_Service_Compute_TargetPool $postBody, $optParams=array())
	Creates a TargetPool resource in the specified project and region using the data included in the request.

	listTargetPools ($project, $region, $optParams=array())
	Retrieves the list of TargetPool resources available to the specified project and region.

	removeHealthCheck ($project, $region, $targetPool, Google_Service_Compute_TargetPoolsRemoveHealthCheckRequest $postBody, $optParams=array())
	Removes health check URL from targetPool.

	removeInstance ($project, $region, $targetPool, Google_Service_Compute_TargetPoolsRemoveInstanceRequest $postBody, $optParams=array())
	Removes instance URL from targetPool.

	setBackup ($project, $region, $targetPool, Google_Service_Compute_TargetReference $postBody, $optParams=array())
	Changes backup pool configurations.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "targetPools" collection of methods.

Typical usage is: $computeService = new Google_Service_Compute(...); $targetPools = $computeService->targetPools;

Member Function Documentation

◆ addHealthCheck()

Google_Service_Compute_TargetPools_Resource::addHealthCheck	(		$project,
			$region,
			$targetPool,
		Google_Service_Compute_TargetPoolsAddHealthCheckRequest	$postBody,
			$optParams = array() )

Adds health check URL to targetPool.

(targetPools.addHealthCheck)

Parameters

string	$project
string	$region	Name of the region scoping this request.
string	$targetPool	Name of the TargetPool resource to which health_check_url is to be added.
Google_TargetPoolsAddHealthCheckRequest	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Compute_Operation

◆ addInstance()

Google_Service_Compute_TargetPools_Resource::addInstance	(		$project,
			$region,
			$targetPool,
		Google_Service_Compute_TargetPoolsAddInstanceRequest	$postBody,
			$optParams = array() )

Adds instance url to targetPool.

(targetPools.addInstance)

Parameters

string	$project
string	$region	Name of the region scoping this request.
string	$targetPool	Name of the TargetPool resource to which instance_url is to be added.
Google_TargetPoolsAddInstanceRequest	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Compute_Operation

◆ aggregatedList()

Google_Service_Compute_TargetPools_Resource::aggregatedList	(		$project,
			$optParams = array() )

Retrieves the list of target pools grouped by scope.

(targetPools.aggregatedList)

Parameters

string	$project	Name of the project scoping this request.
array	$optParams	Optional parameters.

@opt_param string filter Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.

The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, filter=name ne example-instance. @opt_param string pageToken Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request. @opt_param string maxResults Maximum count of results to be returned.

Return values

Google_Service_Compute_TargetPoolAggregatedList

◆ call()

Google_Service_Resource::call	(	$name,
		$arguments,
		$expected_class = null )

inherited

TODO: This function needs simplifying.

Parameters

$name
$arguments
$expected_class	- optional, the expected class name

Return values

Google_Http_Request|expected_class

Exceptions

Google_Exception

◆ delete()

Google_Service_Compute_TargetPools_Resource::delete	(	$project,
		$region,
		$targetPool,
		$optParams = array() )

Deletes the specified TargetPool resource.

(targetPools.delete)

Parameters

string	$project	Name of the project scoping 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 values

Google_Service_Compute_Operation

◆ get()

Google_Service_Compute_TargetPools_Resource::get	(	$project,
		$region,
		$targetPool,
		$optParams = array() )

Returns the specified TargetPool resource.

(targetPools.get)

Parameters

string	$project	Name of the project scoping 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 values

Google_Service_Compute_TargetPool

◆ getHealth()

Google_Service_Compute_TargetPools_Resource::getHealth	(		$project,
			$region,
			$targetPool,
		Google_Service_Compute_InstanceReference	$postBody,
			$optParams = array() )

Gets the most recent health check results for each IP for the given instance that is referenced by given TargetPool.

(targetPools.getHealth)

Parameters

string	$project
string	$region	Name of the region scoping this request.
string	$targetPool	Name of the TargetPool resource to which the queried instance belongs.
Google_InstanceReference	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Compute_TargetPoolInstanceHealth

◆ insert()

Google_Service_Compute_TargetPools_Resource::insert	(		$project,
			$region,
		Google_Service_Compute_TargetPool	$postBody,
			$optParams = array() )

Creates a TargetPool resource in the specified project and region using the data included in the request.

(targetPools.insert)

Parameters

string	$project	Name of the project scoping this request.
string	$region	Name of the region scoping this request.
Google_TargetPool	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Compute_Operation

◆ listTargetPools()

Google_Service_Compute_TargetPools_Resource::listTargetPools	(	$project,
		$region,
		$optParams = array() )

Retrieves the list of TargetPool resources available to the specified project and region.

(targetPools.listTargetPools)

Parameters

string	$project	Name of the project scoping this request.
string	$region	Name of the region scoping this request.
array	$optParams	Optional parameters.

@opt_param string filter Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.

The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, filter=name ne example-instance. @opt_param string pageToken Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request. @opt_param string maxResults Maximum count of results to be returned.

Return values

Google_Service_Compute_TargetPoolList

◆ removeHealthCheck()

Google_Service_Compute_TargetPools_Resource::removeHealthCheck	(		$project,
			$region,
			$targetPool,
		Google_Service_Compute_TargetPoolsRemoveHealthCheckRequest	$postBody,
			$optParams = array() )

Removes health check URL from targetPool.

(targetPools.removeHealthCheck)

Parameters

string	$project
string	$region	Name of the region scoping this request.
string	$targetPool	Name of the TargetPool resource to which health_check_url is to be removed.
Google_TargetPoolsRemoveHealthCheckRequest	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Compute_Operation

◆ removeInstance()

Google_Service_Compute_TargetPools_Resource::removeInstance	(		$project,
			$region,
			$targetPool,
		Google_Service_Compute_TargetPoolsRemoveInstanceRequest	$postBody,
			$optParams = array() )

Removes instance URL from targetPool.

(targetPools.removeInstance)

Parameters

string	$project
string	$region	Name of the region scoping this request.
string	$targetPool	Name of the TargetPool resource to which instance_url is to be removed.
Google_TargetPoolsRemoveInstanceRequest	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Compute_Operation

◆ setBackup()

Google_Service_Compute_TargetPools_Resource::setBackup	(		$project,
			$region,
			$targetPool,
		Google_Service_Compute_TargetReference	$postBody,
			$optParams = array() )

Changes backup pool configurations.

(targetPools.setBackup)

Parameters

string	$project	Name of the project scoping this request.
string	$region	Name of the region scoping this request.
string	$targetPool	Name of the TargetPool resource for which the backup is to be set.
Google_TargetReference	$postBody
array	$optParams	Optional parameters.

@opt_param float failoverRatio New failoverRatio value for the containing target pool.

Return values

Google_Service_Compute_Operation

The documentation for this class was generated from the following file:

lib/google/src/Google/Service/Compute.php

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ addHealthCheck()

◆ addInstance()

◆ aggregatedList()

◆ call()

◆ delete()

◆ get()

◆ getHealth()

◆ insert()

◆ listTargetPools()

◆ removeHealthCheck()

◆ removeInstance()

◆ setBackup()