As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

TargetPools

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

The TargetPools API.

Instantiates the target pools client.

Parameters

  • 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 (Optional[Union[str,TargetPoolsTransport,Callable[..., TargetPoolsTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the TargetPoolsTransport constructor. If set to None, a transport is chosen automatically. NOTE: “rest” transport functionality is currently in a beta state (preview). We welcome your feedback via an issue in this library’s source repository.

  • client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –

    Custom options for the client.

    1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “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).

    2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS 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.

    3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.

  • 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.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]

Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

add_health_check(request: Optional[Union[google.cloud.compute_v1.types.compute.AddHealthCheckTargetPoolRequest, dict]] = 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.extended_operation.ExtendedOperation[source]

Adds health check URLs to a target pool.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_add_health_check():
    # Create a client
    client = compute_v1.TargetPoolsClient()

    # Initialize request argument(s)
    request = compute_v1.AddHealthCheckTargetPoolRequest(
        project="project_value",
        region="region_value",
        target_pool="target_pool_value",
    )

    # Make the request
    response = client.add_health_check(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.compute_v1.types.AddHealthCheckTargetPoolRequest, dict]) – 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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

add_health_check_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.AddHealthCheckTargetPoolRequest, dict]] = 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.Operation[source]

Adds health check URLs to a target pool.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_add_health_check():
    # Create a client
    client = compute_v1.TargetPoolsClient()

    # Initialize request argument(s)
    request = compute_v1.AddHealthCheckTargetPoolRequest(
        project="project_value",
        region="region_value",
        target_pool="target_pool_value",
    )

    # Make the request
    response = client.add_health_check(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.compute_v1.types.AddHealthCheckTargetPoolRequest, dict]) – 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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

add_instance(request: Optional[Union[google.cloud.compute_v1.types.compute.AddInstanceTargetPoolRequest, dict]] = 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.extended_operation.ExtendedOperation[source]

Adds an instance to a target pool.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_add_instance():
    # Create a client
    client = compute_v1.TargetPoolsClient()

    # Initialize request argument(s)
    request = compute_v1.AddInstanceTargetPoolRequest(
        project="project_value",
        region="region_value",
        target_pool="target_pool_value",
    )

    # Make the request
    response = client.add_instance(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.compute_v1.types.AddInstanceTargetPoolRequest, dict]) – 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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

add_instance_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.AddInstanceTargetPoolRequest, dict]] = 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.Operation[source]

Adds an instance to a target pool.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_add_instance():
    # Create a client
    client = compute_v1.TargetPoolsClient()

    # Initialize request argument(s)
    request = compute_v1.AddInstanceTargetPoolRequest(
        project="project_value",
        region="region_value",
        target_pool="target_pool_value",
    )

    # Make the request
    response = client.add_instance(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.compute_v1.types.AddInstanceTargetPoolRequest, dict]) – 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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

aggregated_list(request: Optional[Union[google.cloud.compute_v1.types.compute.AggregatedListTargetPoolsRequest, dict]] = None, *, project: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.services.target_pools.pagers.AggregatedListPager[source]

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

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_aggregated_list():
    # Create a client
    client = compute_v1.TargetPoolsClient()

    # Initialize request argument(s)
    request = compute_v1.AggregatedListTargetPoolsRequest(
        project="project_value",
    )

    # Make the request
    page_result = client.aggregated_list(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters

  • request (Union[google.cloud.compute_v1.types.AggregatedListTargetPoolsRequest, dict]) – 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

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.compute_v1.services.target_pools.pagers.AggregatedListPager

property api_endpoint

Return the API endpoint used by the client instance.

Returns

The API endpoint used by the client instance.

Return type

str

static common_billing_account_path(billing_account: str) → str[source]

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str[source]

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str[source]

Returns a fully-qualified location string.

static common_organization_path(organization: str) → str[source]

Returns a fully-qualified organization string.

static common_project_path(project: str) → str[source]

Returns a fully-qualified project string.

delete(request: Optional[Union[google.cloud.compute_v1.types.compute.DeleteTargetPoolRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, target_pool: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.extended_operation.ExtendedOperation[source]

Deletes the specified target pool.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_delete():
    # Create a client
    client = compute_v1.TargetPoolsClient()

    # Initialize request argument(s)
    request = compute_v1.DeleteTargetPoolRequest(
        project="project_value",
        region="region_value",
        target_pool="target_pool_value",
    )

    # Make the request
    response = client.delete(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.compute_v1.types.DeleteTargetPoolRequest, dict]) – 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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

delete_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.DeleteTargetPoolRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, target_pool: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.Operation[source]

Deletes the specified target pool.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_delete():
    # Create a client
    client = compute_v1.TargetPoolsClient()

    # Initialize request argument(s)
    request = compute_v1.DeleteTargetPoolRequest(
        project="project_value",
        region="region_value",
        target_pool="target_pool_value",
    )

    # Make the request
    response = client.delete(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.compute_v1.types.DeleteTargetPoolRequest, dict]) – 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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters

  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

TargetPoolsClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters

  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

TargetPoolsClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters

  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

TargetPoolsClient

get(request: Optional[Union[google.cloud.compute_v1.types.compute.GetTargetPoolRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, target_pool: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.TargetPool[source]

Returns the specified target pool.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_get():
    # Create a client
    client = compute_v1.TargetPoolsClient()

    # Initialize request argument(s)
    request = compute_v1.GetTargetPoolRequest(
        project="project_value",
        region="region_value",
        target_pool="target_pool_value",
    )

    # Make the request
    response = client.get(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.compute_v1.types.GetTargetPoolRequest, dict]) – 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

Represents a Target Pool resource. Target pools are used with external passthrough Network Load Balancers. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, read Using target pools.

Return type

google.cloud.compute_v1.types.TargetPool

get_health(request: Optional[Union[google.cloud.compute_v1.types.compute.GetHealthTargetPoolRequest, dict]] = 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.TargetPoolInstanceHealth[source]

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

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_get_health():
    # Create a client
    client = compute_v1.TargetPoolsClient()

    # Initialize request argument(s)
    request = compute_v1.GetHealthTargetPoolRequest(
        project="project_value",
        region="region_value",
        target_pool="target_pool_value",
    )

    # Make the request
    response = client.get_health(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.compute_v1.types.GetHealthTargetPoolRequest, dict]) – 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.

Return type

google.cloud.compute_v1.types.TargetPoolInstanceHealth

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]

Deprecated. Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not “true”, the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “always”, use the default mTLS endpoint; if the environment variable is “never”, use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the

client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

insert(request: Optional[Union[google.cloud.compute_v1.types.compute.InsertTargetPoolRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, target_pool_resource: Optional[google.cloud.compute_v1.types.compute.TargetPool] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.extended_operation.ExtendedOperation[source]

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

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_insert():
    # Create a client
    client = compute_v1.TargetPoolsClient()

    # Initialize request argument(s)
    request = compute_v1.InsertTargetPoolRequest(
        project="project_value",
        region="region_value",
    )

    # Make the request
    response = client.insert(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.compute_v1.types.InsertTargetPoolRequest, dict]) – 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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

insert_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.InsertTargetPoolRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, target_pool_resource: Optional[google.cloud.compute_v1.types.compute.TargetPool] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.Operation[source]

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

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_insert():
    # Create a client
    client = compute_v1.TargetPoolsClient()

    # Initialize request argument(s)
    request = compute_v1.InsertTargetPoolRequest(
        project="project_value",
        region="region_value",
    )

    # Make the request
    response = client.insert(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.compute_v1.types.InsertTargetPoolRequest, dict]) – 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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

list(request: Optional[Union[google.cloud.compute_v1.types.compute.ListTargetPoolsRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.services.target_pools.pagers.ListPager[source]

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

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_list():
    # Create a client
    client = compute_v1.TargetPoolsClient()

    # Initialize request argument(s)
    request = compute_v1.ListTargetPoolsRequest(
        project="project_value",
        region="region_value",
    )

    # Make the request
    page_result = client.list(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters

  • request (Union[google.cloud.compute_v1.types.ListTargetPoolsRequest, dict]) – 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

Contains a list of TargetPool resources. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.compute_v1.services.target_pools.pagers.ListPager

static parse_common_billing_account_path(path: str) → Dict[str, str][source]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str][source]

Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str][source]

Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str][source]

Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str][source]

Parse a project path into its component segments.

remove_health_check(request: Optional[Union[google.cloud.compute_v1.types.compute.RemoveHealthCheckTargetPoolRequest, dict]] = 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.extended_operation.ExtendedOperation[source]

Removes health check URL from a target pool.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_remove_health_check():
    # Create a client
    client = compute_v1.TargetPoolsClient()

    # Initialize request argument(s)
    request = compute_v1.RemoveHealthCheckTargetPoolRequest(
        project="project_value",
        region="region_value",
        target_pool="target_pool_value",
    )

    # Make the request
    response = client.remove_health_check(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.compute_v1.types.RemoveHealthCheckTargetPoolRequest, dict]) – 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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

remove_health_check_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.RemoveHealthCheckTargetPoolRequest, dict]] = 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.Operation[source]

Removes health check URL from a target pool.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_remove_health_check():
    # Create a client
    client = compute_v1.TargetPoolsClient()

    # Initialize request argument(s)
    request = compute_v1.RemoveHealthCheckTargetPoolRequest(
        project="project_value",
        region="region_value",
        target_pool="target_pool_value",
    )

    # Make the request
    response = client.remove_health_check(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.compute_v1.types.RemoveHealthCheckTargetPoolRequest, dict]) – 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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

remove_instance(request: Optional[Union[google.cloud.compute_v1.types.compute.RemoveInstanceTargetPoolRequest, dict]] = 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.extended_operation.ExtendedOperation[source]

Removes instance URL from a target pool.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_remove_instance():
    # Create a client
    client = compute_v1.TargetPoolsClient()

    # Initialize request argument(s)
    request = compute_v1.RemoveInstanceTargetPoolRequest(
        project="project_value",
        region="region_value",
        target_pool="target_pool_value",
    )

    # Make the request
    response = client.remove_instance(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.compute_v1.types.RemoveInstanceTargetPoolRequest, dict]) – 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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

remove_instance_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.RemoveInstanceTargetPoolRequest, dict]] = 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.Operation[source]

Removes instance URL from a target pool.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_remove_instance():
    # Create a client
    client = compute_v1.TargetPoolsClient()

    # Initialize request argument(s)
    request = compute_v1.RemoveInstanceTargetPoolRequest(
        project="project_value",
        region="region_value",
        target_pool="target_pool_value",
    )

    # Make the request
    response = client.remove_instance(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.compute_v1.types.RemoveInstanceTargetPoolRequest, dict]) – 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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

set_backup(request: Optional[Union[google.cloud.compute_v1.types.compute.SetBackupTargetPoolRequest, dict]] = 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.extended_operation.ExtendedOperation[source]

Changes a backup target pool’s configurations.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_set_backup():
    # Create a client
    client = compute_v1.TargetPoolsClient()

    # Initialize request argument(s)
    request = compute_v1.SetBackupTargetPoolRequest(
        project="project_value",
        region="region_value",
        target_pool="target_pool_value",
    )

    # Make the request
    response = client.set_backup(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.compute_v1.types.SetBackupTargetPoolRequest, dict]) – 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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

set_backup_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.SetBackupTargetPoolRequest, dict]] = 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.Operation[source]

Changes a backup target pool’s configurations.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_set_backup():
    # Create a client
    client = compute_v1.TargetPoolsClient()

    # Initialize request argument(s)
    request = compute_v1.SetBackupTargetPoolRequest(
        project="project_value",
        region="region_value",
        target_pool="target_pool_value",
    )

    # Make the request
    response = client.set_backup(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.compute_v1.types.SetBackupTargetPoolRequest, dict]) – 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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

set_security_policy(request: Optional[Union[google.cloud.compute_v1.types.compute.SetSecurityPolicyTargetPoolRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, target_pool: Optional[str] = None, security_policy_reference_resource: Optional[google.cloud.compute_v1.types.compute.SecurityPolicyReference] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.extended_operation.ExtendedOperation[source]

Sets the Google Cloud Armor security policy for the specified target pool. For more information, see Google Cloud Armor Overview

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_set_security_policy():
    # Create a client
    client = compute_v1.TargetPoolsClient()

    # Initialize request argument(s)
    request = compute_v1.SetSecurityPolicyTargetPoolRequest(
        project="project_value",
        region="region_value",
        target_pool="target_pool_value",
    )

    # Make the request
    response = client.set_security_policy(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.compute_v1.types.SetSecurityPolicyTargetPoolRequest, dict]) – The request object. A request message for TargetPools.SetSecurityPolicy. 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 security policy should be set. The name should conform to RFC1035.

    This corresponds to the target_pool field on the request instance; if request is provided, this should not be set.

  • security_policy_reference_resource (google.cloud.compute_v1.types.SecurityPolicyReference) – The body resource for this request This corresponds to the security_policy_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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

set_security_policy_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.SetSecurityPolicyTargetPoolRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, target_pool: Optional[str] = None, security_policy_reference_resource: Optional[google.cloud.compute_v1.types.compute.SecurityPolicyReference] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.Operation[source]

Sets the Google Cloud Armor security policy for the specified target pool. For more information, see Google Cloud Armor Overview

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_set_security_policy():
    # Create a client
    client = compute_v1.TargetPoolsClient()

    # Initialize request argument(s)
    request = compute_v1.SetSecurityPolicyTargetPoolRequest(
        project="project_value",
        region="region_value",
        target_pool="target_pool_value",
    )

    # Make the request
    response = client.set_security_policy(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.compute_v1.types.SetSecurityPolicyTargetPoolRequest, dict]) – The request object. A request message for TargetPools.SetSecurityPolicy. 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 security policy should be set. The name should conform to RFC1035.

    This corresponds to the target_pool field on the request instance; if request is provided, this should not be set.

  • security_policy_reference_resource (google.cloud.compute_v1.types.SecurityPolicyReference) – The body resource for this request This corresponds to the security_policy_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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

property transport: google.cloud.compute_v1.services.target_pools.transports.base.TargetPoolsTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

TargetPoolsTransport

property universe_domain: str

Return the universe domain used by the client instance.

Returns

The universe domain used by the client instance.

Return type

str

class google.cloud.compute_v1.services.target_pools.pagers.AggregatedListPager(method: Callable[[...], google.cloud.compute_v1.types.compute.TargetPoolAggregatedList], request: google.cloud.compute_v1.types.compute.AggregatedListTargetPoolsRequest, response: google.cloud.compute_v1.types.compute.TargetPoolAggregatedList, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through aggregated_list requests.

This class thinly wraps an initial google.cloud.compute_v1.types.TargetPoolAggregatedList object, and provides an __iter__ method to iterate through its items field.

If there are more pages, the __iter__ method will make additional AggregatedList requests and continue to iterate through the items field on the corresponding responses.

All the usual google.cloud.compute_v1.types.TargetPoolAggregatedList attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters
class google.cloud.compute_v1.services.target_pools.pagers.ListPager(method: Callable[[...], google.cloud.compute_v1.types.compute.TargetPoolList], request: google.cloud.compute_v1.types.compute.ListTargetPoolsRequest, response: google.cloud.compute_v1.types.compute.TargetPoolList, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list requests.

This class thinly wraps an initial google.cloud.compute_v1.types.TargetPoolList object, and provides an __iter__ method to iterate through its items field.

If there are more pages, the __iter__ method will make additional List requests and continue to iterate through the items field on the corresponding responses.

All the usual google.cloud.compute_v1.types.TargetPoolList attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters