TargetHttpsProxiesClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.compute_v1.services.target_https_proxies.transports.base.TargetHttpsProxiesTransport]] = 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 TargetHttpsProxies API.
Properties
transport
Returns the transport used by the client instance.
Type | Description |
TargetHttpsProxiesTransport | The transport used by the client instance. |
Methods
TargetHttpsProxiesClient
TargetHttpsProxiesClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.compute_v1.services.target_https_proxies.transports.base.TargetHttpsProxiesTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Instantiates the target https proxies client.
Name | Description |
credentials |
Optional[google.
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, TargetHttpsProxiesTransport]
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 |
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 |
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
aggregated_list
aggregated_list(request: Optional[google.cloud.compute_v1.types.compute.AggregatedListTargetHttpsProxiesRequest] = 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 all TargetHttpsProxy resources, regional and global, available to the specified project.
Name | Description |
request |
google.cloud.compute_v1.types.AggregatedListTargetHttpsProxiesRequest
The request object. A request message for TargetHttpsProxies.AggregatedList. See the method description for details. |
project |
str
Name of the project scoping this request. This corresponds to the |
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. |
Type | Description |
google.cloud.compute_v1.services.target_https_proxies.pagers.AggregatedListPager | Iterating over this object will yield results and resolve additional pages automatically. |
common_billing_account_path
common_billing_account_path(billing_account: str)
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Returns a fully-qualified project string.
delete
delete(request: Optional[google.cloud.compute_v1.types.compute.DeleteTargetHttpsProxyRequest] = None, *, project: Optional[str] = None, target_https_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 TargetHttpsProxy resource.
Name | Description |
request |
google.cloud.compute_v1.types.DeleteTargetHttpsProxyRequest
The request object. A request message for TargetHttpsProxies.Delete. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
target_https_proxy |
str
Name of the TargetHttpsProxy resource to delete. This corresponds to the |
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. |
Type | Description |
google.cloud.compute_v1.types.Operation | Represents an Operation resource. Google Compute Engine has three Operation resources: - [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) \* [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) \* [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zonalOperations resource. For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
TargetHttpsProxiesClient | 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.
Name | Description |
info |
dict
The service account private key info. |
Type | Description |
TargetHttpsProxiesClient | 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.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
TargetHttpsProxiesClient | The constructed client. |
get
get(request: Optional[google.cloud.compute_v1.types.compute.GetTargetHttpsProxyRequest] = None, *, project: Optional[str] = None, target_https_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 TargetHttpsProxy resource. Gets a list of available target HTTPS proxies by making a list() request.
Name | Description |
request |
google.cloud.compute_v1.types.GetTargetHttpsProxyRequest
The request object. A request message for TargetHttpsProxies.Get. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
target_https_proxy |
str
Name of the TargetHttpsProxy resource to return. This corresponds to the |
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. |
Type | Description |
google.cloud.compute_v1.types.TargetHttpsProxy | Represents a Target HTTPS Proxy resource. Google Compute Engine has two Target HTTPS Proxy resources: - [Global](/compute/docs/reference/rest/{$api_version}/targetHttpsProxies) \* [Regional](/compute/docs/reference/rest/{$api_version}/regionTargetHttpsProxies) A target HTTPS proxy is a component of GCP HTTPS load balancers. - targetHttpsProxies are used by external HTTPS load balancers. \* regionTargetHttpsProxies are used by internal HTTPS load balancers. Forwarding rules reference a target HTTPS proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. (== resource_for {$api_version}.targetHttpsProxies ==) (== resource_for {$api_version}.regionTargetHttpsProxies ==) |
insert
insert(request: Optional[google.cloud.compute_v1.types.compute.InsertTargetHttpsProxyRequest] = None, *, project: Optional[str] = None, target_https_proxy_resource: Optional[google.cloud.compute_v1.types.compute.TargetHttpsProxy] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates a TargetHttpsProxy resource in the specified project using the data included in the request.
Name | Description |
request |
google.cloud.compute_v1.types.InsertTargetHttpsProxyRequest
The request object. A request message for TargetHttpsProxies.Insert. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
target_https_proxy_resource |
google.cloud.compute_v1.types.TargetHttpsProxy
The body resource for this request This corresponds to the |
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. |
Type | Description |
google.cloud.compute_v1.types.Operation | Represents an Operation resource. Google Compute Engine has three Operation resources: - [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) \* [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) \* [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zonalOperations resource. For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |
list
list(request: Optional[google.cloud.compute_v1.types.compute.ListTargetHttpsProxiesRequest] = 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 TargetHttpsProxy resources available to the specified project.
Name | Description |
request |
google.cloud.compute_v1.types.ListTargetHttpsProxiesRequest
The request object. A request message for TargetHttpsProxies.List. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
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. |
Type | Description |
google.cloud.compute_v1.services.target_https_proxies.pagers.ListPager | Contains a list of TargetHttpsProxy 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.
patch
patch(request: Optional[google.cloud.compute_v1.types.compute.PatchTargetHttpsProxyRequest] = None, *, project: Optional[str] = None, target_https_proxy: Optional[str] = None, target_https_proxy_resource: Optional[google.cloud.compute_v1.types.compute.TargetHttpsProxy] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Patches the specified TargetHttpsProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==)
Name | Description |
request |
google.cloud.compute_v1.types.PatchTargetHttpsProxyRequest
The request object. A request message for TargetHttpsProxies.Patch. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
target_https_proxy |
str
Name of the TargetHttpsProxy resource to patch. This corresponds to the |
target_https_proxy_resource |
google.cloud.compute_v1.types.TargetHttpsProxy
The body resource for this request This corresponds to the |
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. |
Type | Description |
google.cloud.compute_v1.types.Operation | Represents an Operation resource. Google Compute Engine has three Operation resources: - [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) \* [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) \* [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zonalOperations resource. For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |
set_quic_override
set_quic_override(request: Optional[google.cloud.compute_v1.types.compute.SetQuicOverrideTargetHttpsProxyRequest] = None, *, project: Optional[str] = None, target_https_proxy: Optional[str] = None, target_https_proxies_set_quic_override_request_resource: Optional[google.cloud.compute_v1.types.compute.TargetHttpsProxiesSetQuicOverrideRequest] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Sets the QUIC override policy for TargetHttpsProxy.
Name | Description |
request |
google.cloud.compute_v1.types.SetQuicOverrideTargetHttpsProxyRequest
The request object. A request message for TargetHttpsProxies.SetQuicOverride. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
target_https_proxy |
str
Name of the TargetHttpsProxy resource to set the QUIC override policy for. The name should conform to RFC1035. This corresponds to the |
target_https_proxies_set_quic_override_request_resource |
google.cloud.compute_v1.types.TargetHttpsProxiesSetQuicOverrideRequest
The body resource for this request This corresponds to the |
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. |
Type | Description |
google.cloud.compute_v1.types.Operation | Represents an Operation resource. Google Compute Engine has three Operation resources: - [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) \* [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) \* [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zonalOperations resource. For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |
set_ssl_certificates
set_ssl_certificates(request: Optional[google.cloud.compute_v1.types.compute.SetSslCertificatesTargetHttpsProxyRequest] = None, *, project: Optional[str] = None, target_https_proxy: Optional[str] = None, target_https_proxies_set_ssl_certificates_request_resource: Optional[google.cloud.compute_v1.types.compute.TargetHttpsProxiesSetSslCertificatesRequest] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Replaces SslCertificates for TargetHttpsProxy.
Name | Description |
request |
google.cloud.compute_v1.types.SetSslCertificatesTargetHttpsProxyRequest
The request object. A request message for TargetHttpsProxies.SetSslCertificates. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
target_https_proxy |
str
Name of the TargetHttpsProxy resource to set an SslCertificates resource for. This corresponds to the |
target_https_proxies_set_ssl_certificates_request_resource |
google.cloud.compute_v1.types.TargetHttpsProxiesSetSslCertificatesRequest
The body resource for this request This corresponds to the |
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. |
Type | Description |
google.cloud.compute_v1.types.Operation | Represents an Operation resource. Google Compute Engine has three Operation resources: - [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) \* [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) \* [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zonalOperations resource. For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |
set_ssl_policy
set_ssl_policy(request: Optional[google.cloud.compute_v1.types.compute.SetSslPolicyTargetHttpsProxyRequest] = None, *, project: Optional[str] = None, target_https_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 TargetHttpsProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the HTTPS proxy load balancer. They do not affect the connection between the load balancer and the backends.
Name | Description |
request |
google.cloud.compute_v1.types.SetSslPolicyTargetHttpsProxyRequest
The request object. A request message for TargetHttpsProxies.SetSslPolicy. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
target_https_proxy |
str
Name of the TargetHttpsProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035. This corresponds to the |
ssl_policy_reference_resource |
google.cloud.compute_v1.types.SslPolicyReference
The body resource for this request This corresponds to the |
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. |
Type | Description |
google.cloud.compute_v1.types.Operation | Represents an Operation resource. Google Compute Engine has three Operation resources: - [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) \* [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) \* [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zonalOperations resource. For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |
set_url_map
set_url_map(request: Optional[google.cloud.compute_v1.types.compute.SetUrlMapTargetHttpsProxyRequest] = None, *, project: Optional[str] = None, target_https_proxy: Optional[str] = None, url_map_reference_resource: Optional[google.cloud.compute_v1.types.compute.UrlMapReference] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Changes the URL map for TargetHttpsProxy.
Name | Description |
request |
google.cloud.compute_v1.types.SetUrlMapTargetHttpsProxyRequest
The request object. A request message for TargetHttpsProxies.SetUrlMap. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
target_https_proxy |
str
Name of the TargetHttpsProxy resource whose URL map is to be set. This corresponds to the |
url_map_reference_resource |
google.cloud.compute_v1.types.UrlMapReference
The body resource for this request This corresponds to the |
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. |
Type | Description |
google.cloud.compute_v1.types.Operation | Represents an Operation resource. Google Compute Engine has three Operation resources: - [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) \* [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) \* [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zonalOperations resource. For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |