Class TargetSslProxiesClient (1.18.0) 

TargetSslProxiesClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.compute_v1.services.target_ssl_proxies.transports.base.TargetSslProxiesTransport]] = 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>)

The TargetSslProxies API.

Properties

api_endpoint

Return the API endpoint used by the client instance.

Returns
Type Description
str The API endpoint used by the client instance.

transport

Returns the transport used by the client instance.

Returns
Type Description
TargetSslProxiesTransport The transport used by the client instance.

universe_domain

Return the universe domain used by the client instance.

Returns
Type Description
str The universe domain used by the client instance.

Methods

TargetSslProxiesClient

TargetSslProxiesClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.compute_v1.services.target_ssl_proxies.transports.base.TargetSslProxiesTransport]] = 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>)

Instantiates the target ssl proxies 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, TargetSslProxiesTransport]

The transport to use. 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.
Exceptions
Type Description
google.auth.exceptions.MutualTLSChannelError If mutual TLS transport creation failed for any reason.

__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

delete

delete(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.DeleteTargetSslProxyRequest, dict
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    target_ssl_proxy: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.extended_operation.ExtendedOperation

Deletes the specified TargetSslProxy resource.

# 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.TargetSslProxiesClient()

    # Initialize request argument(s)
    request = compute_v1.DeleteTargetSslProxyRequest(
        project="project_value",
        target_ssl_proxy="target_ssl_proxy_value",
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.compute_v1.types.DeleteTargetSslProxyRequest, dict]

The request object. A request message for TargetSslProxies.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.
target_ssl_proxy str

Name of the TargetSslProxy resource to delete. This corresponds to the target_ssl_proxy 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.api_core.extended_operation.ExtendedOperation An object representing a extended long-running operation.

delete_unary

delete_unary(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.DeleteTargetSslProxyRequest, dict
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    target_ssl_proxy: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.Operation

Deletes the specified TargetSslProxy resource.

# 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.TargetSslProxiesClient()

    # Initialize request argument(s)
    request = compute_v1.DeleteTargetSslProxyRequest(
        project="project_value",
        target_ssl_proxy="target_ssl_proxy_value",
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.compute_v1.types.DeleteTargetSslProxyRequest, dict]

The request object. A request message for TargetSslProxies.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.
target_ssl_proxy str

Name of the TargetSslProxy resource to delete. This corresponds to the target_ssl_proxy 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.api_core.extended_operation.ExtendedOperation An object representing a extended long-running operation.

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
TargetSslProxiesClient 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
TargetSslProxiesClient 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
TargetSslProxiesClient The constructed client.

get

get(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.GetTargetSslProxyRequest, dict
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    target_ssl_proxy: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.TargetSslProxy

Returns the specified TargetSslProxy resource.

# 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.TargetSslProxiesClient()

    # Initialize request argument(s)
    request = compute_v1.GetTargetSslProxyRequest(
        project="project_value",
        target_ssl_proxy="target_ssl_proxy_value",
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.compute_v1.types.GetTargetSslProxyRequest, dict]

The request object. A request message for TargetSslProxies.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.
target_ssl_proxy str

Name of the TargetSslProxy resource to return. This corresponds to the target_ssl_proxy 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.TargetSslProxy Represents a Target SSL Proxy resource. A target SSL proxy is a component of a Proxy Network Load Balancer. The forwarding rule references the target SSL proxy, and the target proxy then references a backend service. For more information, read Proxy Network Load Balancer overview.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

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.

Parameter
Name Description
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.
Exceptions
Type Description
google.auth.exceptions.MutualTLSChannelError If any errors happen.
Returns
Type Description
Tuple[str, Callable[[], Tuple[bytes, bytes]]] returns the API endpoint and the client cert source to use.

insert

insert(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.InsertTargetSslProxyRequest, dict
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    target_ssl_proxy_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.TargetSslProxy
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.extended_operation.ExtendedOperation

Creates a TargetSslProxy resource in the specified project 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.TargetSslProxiesClient()

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

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.compute_v1.types.InsertTargetSslProxyRequest, dict]

The request object. A request message for TargetSslProxies.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.
target_ssl_proxy_resource google.cloud.compute_v1.types.TargetSslProxy

The body resource for this request This corresponds to the target_ssl_proxy_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.api_core.extended_operation.ExtendedOperation An object representing a extended long-running operation.

insert_unary

insert_unary(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.InsertTargetSslProxyRequest, dict
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    target_ssl_proxy_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.TargetSslProxy
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.Operation

Creates a TargetSslProxy resource in the specified project 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.TargetSslProxiesClient()

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

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.compute_v1.types.InsertTargetSslProxyRequest, dict]

The request object. A request message for TargetSslProxies.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.
target_ssl_proxy_resource google.cloud.compute_v1.types.TargetSslProxy

The body resource for this request This corresponds to the target_ssl_proxy_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.api_core.extended_operation.ExtendedOperation An object representing a extended long-running operation.

list

list(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.ListTargetSslProxiesRequest, dict
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.services.target_ssl_proxies.pagers.ListPager

Retrieves the list of TargetSslProxy resources available to the specified project.

# 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.TargetSslProxiesClient()

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

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

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.compute_v1.types.ListTargetSslProxiesRequest, dict]

The request object. A request message for TargetSslProxies.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.
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_ssl_proxies.pagers.ListPager Contains a list of TargetSslProxy 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) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

set_backend_service

set_backend_service(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.SetBackendServiceTargetSslProxyRequest,
            dict,
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    target_ssl_proxy: typing.Optional[str] = None,
    target_ssl_proxies_set_backend_service_request_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.TargetSslProxiesSetBackendServiceRequest
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.extended_operation.ExtendedOperation

Changes the BackendService for TargetSslProxy.

# 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_backend_service():
    # Create a client
    client = compute_v1.TargetSslProxiesClient()

    # Initialize request argument(s)
    request = compute_v1.SetBackendServiceTargetSslProxyRequest(
        project="project_value",
        target_ssl_proxy="target_ssl_proxy_value",
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.compute_v1.types.SetBackendServiceTargetSslProxyRequest, dict]

The request object. A request message for TargetSslProxies.SetBackendService. 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.
target_ssl_proxy str

Name of the TargetSslProxy resource whose BackendService resource is to be set. This corresponds to the target_ssl_proxy field on the request instance; if request is provided, this should not be set.
target_ssl_proxies_set_backend_service_request_resource google.cloud.compute_v1.types.TargetSslProxiesSetBackendServiceRequest

The body resource for this request This corresponds to the target_ssl_proxies_set_backend_service_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.api_core.extended_operation.ExtendedOperation An object representing a extended long-running operation.

set_backend_service_unary

set_backend_service_unary(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.SetBackendServiceTargetSslProxyRequest,
            dict,
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    target_ssl_proxy: typing.Optional[str] = None,
    target_ssl_proxies_set_backend_service_request_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.TargetSslProxiesSetBackendServiceRequest
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.Operation

Changes the BackendService for TargetSslProxy.

# 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_backend_service():
    # Create a client
    client = compute_v1.TargetSslProxiesClient()

    # Initialize request argument(s)
    request = compute_v1.SetBackendServiceTargetSslProxyRequest(
        project="project_value",
        target_ssl_proxy="target_ssl_proxy_value",
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.compute_v1.types.SetBackendServiceTargetSslProxyRequest, dict]

The request object. A request message for TargetSslProxies.SetBackendService. 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.
target_ssl_proxy str

Name of the TargetSslProxy resource whose BackendService resource is to be set. This corresponds to the target_ssl_proxy field on the request instance; if request is provided, this should not be set.
target_ssl_proxies_set_backend_service_request_resource google.cloud.compute_v1.types.TargetSslProxiesSetBackendServiceRequest

The body resource for this request This corresponds to the target_ssl_proxies_set_backend_service_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.api_core.extended_operation.ExtendedOperation An object representing a extended long-running operation.

set_certificate_map

set_certificate_map(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.SetCertificateMapTargetSslProxyRequest,
            dict,
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    target_ssl_proxy: typing.Optional[str] = None,
    target_ssl_proxies_set_certificate_map_request_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.TargetSslProxiesSetCertificateMapRequest
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.extended_operation.ExtendedOperation

Changes the Certificate Map for TargetSslProxy.

# 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_certificate_map():
    # Create a client
    client = compute_v1.TargetSslProxiesClient()

    # Initialize request argument(s)
    request = compute_v1.SetCertificateMapTargetSslProxyRequest(
        project="project_value",
        target_ssl_proxy="target_ssl_proxy_value",
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.compute_v1.types.SetCertificateMapTargetSslProxyRequest, dict]

The request object. A request message for TargetSslProxies.SetCertificateMap. 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.
target_ssl_proxy str

Name of the TargetSslProxy resource whose CertificateMap is to be set. The name must be 1-63 characters long, and comply with RFC1035. This corresponds to the target_ssl_proxy field on the request instance; if request is provided, this should not be set.
target_ssl_proxies_set_certificate_map_request_resource google.cloud.compute_v1.types.TargetSslProxiesSetCertificateMapRequest

The body resource for this request This corresponds to the target_ssl_proxies_set_certificate_map_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.api_core.extended_operation.ExtendedOperation An object representing a extended long-running operation.

set_certificate_map_unary

set_certificate_map_unary(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.SetCertificateMapTargetSslProxyRequest,
            dict,
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    target_ssl_proxy: typing.Optional[str] = None,
    target_ssl_proxies_set_certificate_map_request_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.TargetSslProxiesSetCertificateMapRequest
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.Operation

Changes the Certificate Map for TargetSslProxy.

# 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_certificate_map():
    # Create a client
    client = compute_v1.TargetSslProxiesClient()

    # Initialize request argument(s)
    request = compute_v1.SetCertificateMapTargetSslProxyRequest(
        project="project_value",
        target_ssl_proxy="target_ssl_proxy_value",
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.compute_v1.types.SetCertificateMapTargetSslProxyRequest, dict]

The request object. A request message for TargetSslProxies.SetCertificateMap. 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.
target_ssl_proxy str

Name of the TargetSslProxy resource whose CertificateMap is to be set. The name must be 1-63 characters long, and comply with RFC1035. This corresponds to the target_ssl_proxy field on the request instance; if request is provided, this should not be set.
target_ssl_proxies_set_certificate_map_request_resource google.cloud.compute_v1.types.TargetSslProxiesSetCertificateMapRequest

The body resource for this request This corresponds to the target_ssl_proxies_set_certificate_map_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.api_core.extended_operation.ExtendedOperation An object representing a extended long-running operation.

set_proxy_header

set_proxy_header(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.SetProxyHeaderTargetSslProxyRequest,
            dict,
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    target_ssl_proxy: typing.Optional[str] = None,
    target_ssl_proxies_set_proxy_header_request_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.TargetSslProxiesSetProxyHeaderRequest
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.extended_operation.ExtendedOperation

Changes the ProxyHeaderType for TargetSslProxy.

# 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_proxy_header():
    # Create a client
    client = compute_v1.TargetSslProxiesClient()

    # Initialize request argument(s)
    request = compute_v1.SetProxyHeaderTargetSslProxyRequest(
        project="project_value",
        target_ssl_proxy="target_ssl_proxy_value",
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.compute_v1.types.SetProxyHeaderTargetSslProxyRequest, dict]

The request object. A request message for TargetSslProxies.SetProxyHeader. 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.
target_ssl_proxy str

Name of the TargetSslProxy resource whose ProxyHeader is to be set. This corresponds to the target_ssl_proxy field on the request instance; if request is provided, this should not be set.
target_ssl_proxies_set_proxy_header_request_resource google.cloud.compute_v1.types.TargetSslProxiesSetProxyHeaderRequest

The body resource for this request This corresponds to the target_ssl_proxies_set_proxy_header_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.api_core.extended_operation.ExtendedOperation An object representing a extended long-running operation.

set_proxy_header_unary

set_proxy_header_unary(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.SetProxyHeaderTargetSslProxyRequest,
            dict,
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    target_ssl_proxy: typing.Optional[str] = None,
    target_ssl_proxies_set_proxy_header_request_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.TargetSslProxiesSetProxyHeaderRequest
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.Operation

Changes the ProxyHeaderType for TargetSslProxy.

# 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_proxy_header():
    # Create a client
    client = compute_v1.TargetSslProxiesClient()

    # Initialize request argument(s)
    request = compute_v1.SetProxyHeaderTargetSslProxyRequest(
        project="project_value",
        target_ssl_proxy="target_ssl_proxy_value",
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.compute_v1.types.SetProxyHeaderTargetSslProxyRequest, dict]

The request object. A request message for TargetSslProxies.SetProxyHeader. 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.
target_ssl_proxy str

Name of the TargetSslProxy resource whose ProxyHeader is to be set. This corresponds to the target_ssl_proxy field on the request instance; if request is provided, this should not be set.
target_ssl_proxies_set_proxy_header_request_resource google.cloud.compute_v1.types.TargetSslProxiesSetProxyHeaderRequest

The body resource for this request This corresponds to the target_ssl_proxies_set_proxy_header_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.api_core.extended_operation.ExtendedOperation An object representing a extended long-running operation.

set_ssl_certificates

set_ssl_certificates(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.SetSslCertificatesTargetSslProxyRequest,
            dict,
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    target_ssl_proxy: typing.Optional[str] = None,
    target_ssl_proxies_set_ssl_certificates_request_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.TargetSslProxiesSetSslCertificatesRequest
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.extended_operation.ExtendedOperation

Changes SslCertificates for TargetSslProxy.

# 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_ssl_certificates():
    # Create a client
    client = compute_v1.TargetSslProxiesClient()

    # Initialize request argument(s)
    request = compute_v1.SetSslCertificatesTargetSslProxyRequest(
        project="project_value",
        target_ssl_proxy="target_ssl_proxy_value",
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.compute_v1.types.SetSslCertificatesTargetSslProxyRequest, dict]

The request object. A request message for TargetSslProxies.SetSslCertificates. 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.
target_ssl_proxy str

Name of the TargetSslProxy resource whose SslCertificate resource is to be set. This corresponds to the target_ssl_proxy field on the request instance; if request is provided, this should not be set.
target_ssl_proxies_set_ssl_certificates_request_resource google.cloud.compute_v1.types.TargetSslProxiesSetSslCertificatesRequest

The body resource for this request This corresponds to the target_ssl_proxies_set_ssl_certificates_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.api_core.extended_operation.ExtendedOperation An object representing a extended long-running operation.

set_ssl_certificates_unary

set_ssl_certificates_unary(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.SetSslCertificatesTargetSslProxyRequest,
            dict,
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    target_ssl_proxy: typing.Optional[str] = None,
    target_ssl_proxies_set_ssl_certificates_request_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.TargetSslProxiesSetSslCertificatesRequest
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.Operation

Changes SslCertificates for TargetSslProxy.

# 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_ssl_certificates():
    # Create a client
    client = compute_v1.TargetSslProxiesClient()

    # Initialize request argument(s)
    request = compute_v1.SetSslCertificatesTargetSslProxyRequest(
        project="project_value",
        target_ssl_proxy="target_ssl_proxy_value",
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.compute_v1.types.SetSslCertificatesTargetSslProxyRequest, dict]

The request object. A request message for TargetSslProxies.SetSslCertificates. 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.
target_ssl_proxy str

Name of the TargetSslProxy resource whose SslCertificate resource is to be set. This corresponds to the target_ssl_proxy field on the request instance; if request is provided, this should not be set.
target_ssl_proxies_set_ssl_certificates_request_resource google.cloud.compute_v1.types.TargetSslProxiesSetSslCertificatesRequest

The body resource for this request This corresponds to the target_ssl_proxies_set_ssl_certificates_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.api_core.extended_operation.ExtendedOperation An object representing a extended long-running operation.

set_ssl_policy

set_ssl_policy(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.SetSslPolicyTargetSslProxyRequest,
            dict,
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    target_ssl_proxy: typing.Optional[str] = None,
    ssl_policy_reference_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.SslPolicyReference
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.extended_operation.ExtendedOperation

Sets the SSL policy for TargetSslProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the load balancer. They do not affect the connection between the load balancer and the backends.

# 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_ssl_policy():
    # Create a client
    client = compute_v1.TargetSslProxiesClient()

    # Initialize request argument(s)
    request = compute_v1.SetSslPolicyTargetSslProxyRequest(
        project="project_value",
        target_ssl_proxy="target_ssl_proxy_value",
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.compute_v1.types.SetSslPolicyTargetSslProxyRequest, dict]

The request object. A request message for TargetSslProxies.SetSslPolicy. 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.
target_ssl_proxy str

Name of the TargetSslProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035. This corresponds to the target_ssl_proxy field on the request instance; if request is provided, this should not be set.
ssl_policy_reference_resource google.cloud.compute_v1.types.SslPolicyReference

The body resource for this request This corresponds to the ssl_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
Type Description
google.api_core.extended_operation.ExtendedOperation An object representing a extended long-running operation.

set_ssl_policy_unary

set_ssl_policy_unary(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.SetSslPolicyTargetSslProxyRequest,
            dict,
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    target_ssl_proxy: typing.Optional[str] = None,
    ssl_policy_reference_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.SslPolicyReference
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.Operation

Sets the SSL policy for TargetSslProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the load balancer. They do not affect the connection between the load balancer and the backends.

# 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_ssl_policy():
    # Create a client
    client = compute_v1.TargetSslProxiesClient()

    # Initialize request argument(s)
    request = compute_v1.SetSslPolicyTargetSslProxyRequest(
        project="project_value",
        target_ssl_proxy="target_ssl_proxy_value",
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.compute_v1.types.SetSslPolicyTargetSslProxyRequest, dict]

The request object. A request message for TargetSslProxies.SetSslPolicy. 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.
target_ssl_proxy str

Name of the TargetSslProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035. This corresponds to the target_ssl_proxy field on the request instance; if request is provided, this should not be set.
ssl_policy_reference_resource google.cloud.compute_v1.types.SslPolicyReference

The body resource for this request This corresponds to the ssl_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
Type Description
google.api_core.extended_operation.ExtendedOperation An object representing a extended long-running operation.