Class TargetPoolsClient (0.6.0)

TargetPoolsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.compute_v1.services.target_pools.transports.base.TargetPoolsTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

The TargetPools API.

Properties

transport

Returns the transport used by the client instance.

Returns

Type	Description
`TargetPoolsTransport`	The transport used by the client instance.

Methods

TargetPoolsClient

TargetPoolsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.compute_v1.services.target_pools.transports.base.TargetPoolsTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the target pools client.

Parameters

Name	Description
`credentials`	`Optional[google.auth.credentials.Credentials]` The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
`transport`	`Union[str, TargetPoolsTransport]` The transport to use. If set to None, a transport is chosen automatically.
`client_options`	`google.api_core.client_options.ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.
`client_info`	`google.api_core.gapic_v1.client_info.ClientInfo` The client info used to send a user-agent string along with API requests. If `None`, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions

Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If mutual TLS transport creation failed for any reason.

add_health_check

add_health_check(request: Optional[google.cloud.compute_v1.types.compute.AddHealthCheckTargetPoolRequest] = None, *, project: Optional[str] = None, region: Optional[str] = None, target_pool: Optional[str] = None, target_pools_add_health_check_request_resource: Optional[google.cloud.compute_v1.types.compute.TargetPoolsAddHealthCheckRequest] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Adds health check URLs to a target pool.

Parameters

Name	Description
`request`	`google.cloud.compute_v1.types.AddHealthCheckTargetPoolRequest` The request object. A request message for TargetPools.AddHealthCheck. See the method description for details.
`project`	`str` Project ID for this request. This corresponds to the `project` field on the `request` instance; if `request` is provided, this should not be set.
`region`	`str` Name of the region scoping this request. This corresponds to the `region` field on the `request` instance; if `request` is provided, this should not be set.
`target_pool`	`str` Name of the target pool to add a health check to. This corresponds to the `target_pool` field on the `request` instance; if `request` is provided, this should not be set.
`target_pools_add_health_check_request_resource`	`google.cloud.compute_v1.types.TargetPoolsAddHealthCheckRequest` The body resource for this request This corresponds to the `target_pools_add_health_check_request_resource` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description

google.cloud.compute_v1.types.Operation Represents an Operation resource. Google Compute Engine has three Operation resources: - [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) \* [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) \* [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zonalOperations resource. For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

add_instance

add_instance(request: Optional[google.cloud.compute_v1.types.compute.AddInstanceTargetPoolRequest] = None, *, project: Optional[str] = None, region: Optional[str] = None, target_pool: Optional[str] = None, target_pools_add_instance_request_resource: Optional[google.cloud.compute_v1.types.compute.TargetPoolsAddInstanceRequest] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Adds an instance to a target pool.

Parameters

Name	Description
`request`	`google.cloud.compute_v1.types.AddInstanceTargetPoolRequest` The request object. A request message for TargetPools.AddInstance. See the method description for details.
`project`	`str` Project ID for this request. This corresponds to the `project` field on the `request` instance; if `request` is provided, this should not be set.
`region`	`str` Name of the region scoping this request. This corresponds to the `region` field on the `request` instance; if `request` is provided, this should not be set.
`target_pool`	`str` Name of the TargetPool resource to add instances to. This corresponds to the `target_pool` field on the `request` instance; if `request` is provided, this should not be set.
`target_pools_add_instance_request_resource`	`google.cloud.compute_v1.types.TargetPoolsAddInstanceRequest` The body resource for this request This corresponds to the `target_pools_add_instance_request_resource` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description

aggregated_list

aggregated_list(request: Optional[google.cloud.compute_v1.types.compute.AggregatedListTargetPoolsRequest] = None, *, project: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Retrieves an aggregated list of target pools.

Parameters

Name	Description
`request`	`google.cloud.compute_v1.types.AggregatedListTargetPoolsRequest` The request object. A request message for TargetPools.AggregatedList. See the method description for details.
`project`	`str` Project ID for this request. This corresponds to the `project` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.cloud.compute_v1.services.target_pools.pagers.AggregatedListPager`	Iterating over this object will yield results and resolve additional pages automatically.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

delete

delete(request: Optional[google.cloud.compute_v1.types.compute.DeleteTargetPoolRequest] = None, *, project: Optional[str] = None, region: Optional[str] = None, target_pool: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes the specified target pool.

Parameters

Name	Description
`request`	`google.cloud.compute_v1.types.DeleteTargetPoolRequest` The request object. A request message for TargetPools.Delete. See the method description for details.
`project`	`str` Project ID for this request. This corresponds to the `project` field on the `request` instance; if `request` is provided, this should not be set.
`region`	`str` Name of the region scoping this request. This corresponds to the `region` field on the `request` instance; if `request` is provided, this should not be set.
`target_pool`	`str` Name of the TargetPool resource to delete. This corresponds to the `target_pool` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter

Name	Description
`filename`	`str` The path to the service account private key json file.

Returns

Type	Description
`TargetPoolsClient`	The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter

Name	Description
`info`	`dict` The service account private key info.

Returns

Type	Description
`TargetPoolsClient`	The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter

Name	Description
`filename`	`str` The path to the service account private key json file.

Returns

Type	Description
`TargetPoolsClient`	The constructed client.

get

get(request: Optional[google.cloud.compute_v1.types.compute.GetTargetPoolRequest] = None, *, project: Optional[str] = None, region: Optional[str] = None, target_pool: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns the specified target pool. Gets a list of available target pools by making a list() request.

Parameters

Name	Description
`request`	`google.cloud.compute_v1.types.GetTargetPoolRequest` The request object. A request message for TargetPools.Get. See the method description for details.
`project`	`str` Project ID for this request. This corresponds to the `project` field on the `request` instance; if `request` is provided, this should not be set.
`region`	`str` Name of the region scoping this request. This corresponds to the `region` field on the `request` instance; if `request` is provided, this should not be set.
`target_pool`	`str` Name of the TargetPool resource to return. This corresponds to the `target_pool` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.cloud.compute_v1.types.TargetPool`	Represents a Target Pool resource. Target pools are used for network TCP/UDP load balancing. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, read Using target pools. (== resource_for {$api_version}.targetPools ==)

get_health

get_health(request: Optional[google.cloud.compute_v1.types.compute.GetHealthTargetPoolRequest] = None, *, project: Optional[str] = None, region: Optional[str] = None, target_pool: Optional[str] = None, instance_reference_resource: Optional[google.cloud.compute_v1.types.compute.InstanceReference] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters

Name	Description
`request`	`google.cloud.compute_v1.types.GetHealthTargetPoolRequest` The request object. A request message for TargetPools.GetHealth. See the method description for details.
`project`	`str` Project ID for this request. This corresponds to the `project` field on the `request` instance; if `request` is provided, this should not be set.
`region`	`str` Name of the region scoping this request. This corresponds to the `region` field on the `request` instance; if `request` is provided, this should not be set.
`target_pool`	`str` Name of the TargetPool resource to which the queried instance belongs. This corresponds to the `target_pool` field on the `request` instance; if `request` is provided, this should not be set.
`instance_reference_resource`	`google.cloud.compute_v1.types.InstanceReference` The body resource for this request This corresponds to the `instance_reference_resource` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

insert

insert(request: Optional[google.cloud.compute_v1.types.compute.InsertTargetPoolRequest] = None, *, project: Optional[str] = None, region: Optional[str] = None, target_pool_resource: Optional[google.cloud.compute_v1.types.compute.TargetPool] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters

Name	Description
`request`	`google.cloud.compute_v1.types.InsertTargetPoolRequest` The request object. A request message for TargetPools.Insert. See the method description for details.
`project`	`str` Project ID for this request. This corresponds to the `project` field on the `request` instance; if `request` is provided, this should not be set.
`region`	`str` Name of the region scoping this request. This corresponds to the `region` field on the `request` instance; if `request` is provided, this should not be set.
`target_pool_resource`	`google.cloud.compute_v1.types.TargetPool` The body resource for this request This corresponds to the `target_pool_resource` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description

list

list(request: Optional[google.cloud.compute_v1.types.compute.ListTargetPoolsRequest] = None, *, project: Optional[str] = None, region: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters

Name	Description
`request`	`google.cloud.compute_v1.types.ListTargetPoolsRequest` The request object. A request message for TargetPools.List. See the method description for details.
`project`	`str` Project ID for this request. This corresponds to the `project` field on the `request` instance; if `request` is provided, this should not be set.
`region`	`str` Name of the region scoping this request. This corresponds to the `region` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.cloud.compute_v1.services.target_pools.pagers.ListPager`	Contains a list of TargetPool resources. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

remove_health_check

remove_health_check(request: Optional[google.cloud.compute_v1.types.compute.RemoveHealthCheckTargetPoolRequest] = None, *, project: Optional[str] = None, region: Optional[str] = None, target_pool: Optional[str] = None, target_pools_remove_health_check_request_resource: Optional[google.cloud.compute_v1.types.compute.TargetPoolsRemoveHealthCheckRequest] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Removes health check URL from a target pool.

Parameters

Name	Description
`request`	`google.cloud.compute_v1.types.RemoveHealthCheckTargetPoolRequest` The request object. A request message for TargetPools.RemoveHealthCheck. See the method description for details.
`project`	`str` Project ID for this request. This corresponds to the `project` field on the `request` instance; if `request` is provided, this should not be set.
`region`	`str` Name of the region for this request. This corresponds to the `region` field on the `request` instance; if `request` is provided, this should not be set.
`target_pool`	`str` Name of the target pool to remove health checks from. This corresponds to the `target_pool` field on the `request` instance; if `request` is provided, this should not be set.
`target_pools_remove_health_check_request_resource`	`google.cloud.compute_v1.types.TargetPoolsRemoveHealthCheckRequest` The body resource for this request This corresponds to the `target_pools_remove_health_check_request_resource` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description

remove_instance

remove_instance(request: Optional[google.cloud.compute_v1.types.compute.RemoveInstanceTargetPoolRequest] = None, *, project: Optional[str] = None, region: Optional[str] = None, target_pool: Optional[str] = None, target_pools_remove_instance_request_resource: Optional[google.cloud.compute_v1.types.compute.TargetPoolsRemoveInstanceRequest] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Removes instance URL from a target pool.

Parameters

Name	Description
`request`	`google.cloud.compute_v1.types.RemoveInstanceTargetPoolRequest` The request object. A request message for TargetPools.RemoveInstance. See the method description for details.
`project`	`str` Project ID for this request. This corresponds to the `project` field on the `request` instance; if `request` is provided, this should not be set.
`region`	`str` Name of the region scoping this request. This corresponds to the `region` field on the `request` instance; if `request` is provided, this should not be set.
`target_pool`	`str` Name of the TargetPool resource to remove instances from. This corresponds to the `target_pool` field on the `request` instance; if `request` is provided, this should not be set.
`target_pools_remove_instance_request_resource`	`google.cloud.compute_v1.types.TargetPoolsRemoveInstanceRequest` The body resource for this request This corresponds to the `target_pools_remove_instance_request_resource` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description

set_backup

set_backup(request: Optional[google.cloud.compute_v1.types.compute.SetBackupTargetPoolRequest] = None, *, project: Optional[str] = None, region: Optional[str] = None, target_pool: Optional[str] = None, target_reference_resource: Optional[google.cloud.compute_v1.types.compute.TargetReference] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Changes a backup target pool's configurations.

Parameters

Name	Description
`request`	`google.cloud.compute_v1.types.SetBackupTargetPoolRequest` The request object. A request message for TargetPools.SetBackup. See the method description for details.
`project`	`str` Project ID for this request. This corresponds to the `project` field on the `request` instance; if `request` is provided, this should not be set.
`region`	`str` Name of the region scoping this request. This corresponds to the `region` field on the `request` instance; if `request` is provided, this should not be set.
`target_pool`	`str` Name of the TargetPool resource to set a backup pool for. This corresponds to the `target_pool` field on the `request` instance; if `request` is provided, this should not be set.
`target_reference_resource`	`google.cloud.compute_v1.types.TargetReference` The body resource for this request This corresponds to the `target_reference_resource` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description