Class TargetSslProxiesClient (0.2.1)

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

The TargetSslProxies API.

Properties

transport

Return the transport used by the client instance.

Returns
TypeDescription
TargetSslProxiesTransportThe transport used by the client instance.

Methods

TargetSslProxiesClient

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

Instantiate the target ssl proxies client.

Parameters
NameDescription
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.

client_options google.api_core.client_options.ClientOptions

Custom options for the client. It won't take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.

client_info google.api_core.gapic_v1.client_info.ClientInfo

The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions
TypeDescription
google.auth.exceptions.MutualTLSChannelErrorIf mutual TLS transport creation failed for any reason.

common_billing_account_path

common_billing_account_path(billing_account: str)

Return a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Return a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Return a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Return a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Return a fully-qualified project string.

delete

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

Deletes the specified TargetSslProxy resource.

Parameters
NameDescription
request google.cloud.compute_v1.types.DeleteTargetSslProxyRequest

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

from_service_account_file

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

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

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
TargetSslProxiesClientThe 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
NameDescription
info dict

The service account private key info.

Returns
TypeDescription
TargetSslProxiesClientThe 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
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
TargetSslProxiesClientThe constructed client.

get

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

Returns the specified TargetSslProxy resource. Gets a list of available target SSL proxies by making a list() request.

Parameters
NameDescription
request google.cloud.compute_v1.types.GetTargetSslProxyRequest

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
TypeDescription
google.cloud.compute_v1.types.TargetSslProxyRepresents a Target SSL Proxy resource. A target SSL proxy is a component of a SSL Proxy load balancer. Global forwarding rules reference a target SSL proxy, and the target proxy then references an external backend service. For more information, read Using Target Proxies. (== resource_for {$api_version}.targetSslProxies ==)

insert

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

Creates a TargetSslProxy resource in the specified project using the data included in the request.

Parameters
NameDescription
request google.cloud.compute_v1.types.InsertTargetSslProxyRequest

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

list

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

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

Parameters
NameDescription
request google.cloud.compute_v1.types.ListTargetSslProxiesRequest

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
TypeDescription
google.cloud.compute_v1.services.target_ssl_proxies.pagers.ListPagerContains 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)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

set_backend_service

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

Changes the BackendService for TargetSslProxy.

Parameters
NameDescription
request google.cloud.compute_v1.types.SetBackendServiceTargetSslProxyRequest

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

set_proxy_header

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

Changes the ProxyHeaderType for TargetSslProxy.

Parameters
NameDescription
request google.cloud.compute_v1.types.SetProxyHeaderTargetSslProxyRequest

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

set_ssl_certificates

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

Changes SslCertificates for TargetSslProxy.

Parameters
NameDescription
request google.cloud.compute_v1.types.SetSslCertificatesTargetSslProxyRequest

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

set_ssl_policy

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

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

Parameters
NameDescription
request google.cloud.compute_v1.types.SetSslPolicyTargetSslProxyRequest

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