TargetHttpProxiesClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.compute_v1.services.target_http_proxies.transports.base.TargetHttpProxiesTransport]] = 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 TargetHttpProxies API.
Properties
transport
Returns the transport used by the client instance.
Returns | |
---|---|
Type | Description |
TargetHttpProxiesTransport | The transport used by the client instance. |
Methods
TargetHttpProxiesClient
TargetHttpProxiesClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.compute_v1.services.target_http_proxies.transports.base.TargetHttpProxiesTransport]] = 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 http 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, TargetHttpProxiesTransport]
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. 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 |
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.
aggregated_list
aggregated_list(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.AggregatedListTargetHttpProxiesRequest,
dict,
]
] = None,
*,
project: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.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_http_proxies.pagers.AggregatedListPager
Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.AggregatedListTargetHttpProxiesRequest, dict]
The request object. A request message for TargetHttpProxies.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. |
Returns | |
---|---|
Type | Description |
google.cloud.compute_v1.services.target_http_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) -> 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.DeleteTargetHttpProxyRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
target_http_proxy: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.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 TargetHttpProxy resource.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.DeleteTargetHttpProxyRequest, dict]
The request object. A request message for TargetHttpProxies.Delete. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
target_http_proxy |
str
Name of the TargetHttpProxy 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. |
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.DeleteTargetHttpProxyRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
target_http_proxy: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.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 TargetHttpProxy resource.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.DeleteTargetHttpProxyRequest, dict]
The request object. A request message for TargetHttpProxies.Delete. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
target_http_proxy |
str
Name of the TargetHttpProxy 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. |
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 |
TargetHttpProxiesClient | 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 |
TargetHttpProxiesClient | 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 |
TargetHttpProxiesClient | The constructed client. |
get
get(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.GetTargetHttpProxyRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
target_http_proxy: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.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.TargetHttpProxy
Returns the specified TargetHttpProxy resource.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.GetTargetHttpProxyRequest, dict]
The request object. A request message for TargetHttpProxies.Get. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
target_http_proxy |
str
Name of the TargetHttpProxy 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. |
Returns | |
---|---|
Type | Description |
google.cloud.compute_v1.types.TargetHttpProxy | Represents a Target HTTP Proxy resource. Google Compute Engine has two Target HTTP Proxy resources: \* [Global](/compute/docs/reference/rest/v1/targetHttpProxies) \* [Regional](/compute/docs/reference/rest/v1/regionTargetHttpProxies) A target HTTP proxy is a component of GCP HTTP load balancers. \* targetHttpProxies are used by external HTTP load balancers and Traffic Director. \* regionTargetHttpProxies are used by internal HTTP load balancers. Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
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 |
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.InsertTargetHttpProxyRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
target_http_proxy_resource: typing.Optional[
google.cloud.compute_v1.types.compute.TargetHttpProxy
] = None,
retry: typing.Union[
google.api_core.retry.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 TargetHttpProxy resource in the specified project using the data included in the request.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.InsertTargetHttpProxyRequest, dict]
The request object. A request message for TargetHttpProxies.Insert. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
target_http_proxy_resource |
google.cloud.compute_v1.types.TargetHttpProxy
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. |
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.InsertTargetHttpProxyRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
target_http_proxy_resource: typing.Optional[
google.cloud.compute_v1.types.compute.TargetHttpProxy
] = None,
retry: typing.Union[
google.api_core.retry.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 TargetHttpProxy resource in the specified project using the data included in the request.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.InsertTargetHttpProxyRequest, dict]
The request object. A request message for TargetHttpProxies.Insert. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
target_http_proxy_resource |
google.cloud.compute_v1.types.TargetHttpProxy
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. |
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.ListTargetHttpProxiesRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.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_http_proxies.pagers.ListPager
Retrieves the list of TargetHttpProxy resources available to the specified project.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.ListTargetHttpProxiesRequest, dict]
The request object. A request message for TargetHttpProxies.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. |
Returns | |
---|---|
Type | Description |
google.cloud.compute_v1.services.target_http_proxies.pagers.ListPager | A list of TargetHttpProxy 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.
patch
patch(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.PatchTargetHttpProxyRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
target_http_proxy: typing.Optional[str] = None,
target_http_proxy_resource: typing.Optional[
google.cloud.compute_v1.types.compute.TargetHttpProxy
] = None,
retry: typing.Union[
google.api_core.retry.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
Patches the specified TargetHttpProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.PatchTargetHttpProxyRequest, dict]
The request object. A request message for TargetHttpProxies.Patch. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
target_http_proxy |
str
Name of the TargetHttpProxy resource to patch. This corresponds to the |
target_http_proxy_resource |
google.cloud.compute_v1.types.TargetHttpProxy
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. |
Returns | |
---|---|
Type | Description |
google.api_core.extended_operation.ExtendedOperation | An object representing a extended long-running operation. |
patch_unary
patch_unary(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.PatchTargetHttpProxyRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
target_http_proxy: typing.Optional[str] = None,
target_http_proxy_resource: typing.Optional[
google.cloud.compute_v1.types.compute.TargetHttpProxy
] = None,
retry: typing.Union[
google.api_core.retry.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
Patches the specified TargetHttpProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.PatchTargetHttpProxyRequest, dict]
The request object. A request message for TargetHttpProxies.Patch. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
target_http_proxy |
str
Name of the TargetHttpProxy resource to patch. This corresponds to the |
target_http_proxy_resource |
google.cloud.compute_v1.types.TargetHttpProxy
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. |
Returns | |
---|---|
Type | Description |
google.api_core.extended_operation.ExtendedOperation | An object representing a extended long-running operation. |
set_url_map
set_url_map(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.SetUrlMapTargetHttpProxyRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
target_http_proxy: typing.Optional[str] = None,
url_map_reference_resource: typing.Optional[
google.cloud.compute_v1.types.compute.UrlMapReference
] = None,
retry: typing.Union[
google.api_core.retry.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 URL map for TargetHttpProxy.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.SetUrlMapTargetHttpProxyRequest, dict]
The request object. A request message for TargetHttpProxies.SetUrlMap. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
target_http_proxy |
str
Name of the TargetHttpProxy to set a URL map for. 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. |
Returns | |
---|---|
Type | Description |
google.api_core.extended_operation.ExtendedOperation | An object representing a extended long-running operation. |
set_url_map_unary
set_url_map_unary(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.SetUrlMapTargetHttpProxyRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
target_http_proxy: typing.Optional[str] = None,
url_map_reference_resource: typing.Optional[
google.cloud.compute_v1.types.compute.UrlMapReference
] = None,
retry: typing.Union[
google.api_core.retry.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 URL map for TargetHttpProxy.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.SetUrlMapTargetHttpProxyRequest, dict]
The request object. A request message for TargetHttpProxies.SetUrlMap. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
target_http_proxy |
str
Name of the TargetHttpProxy to set a URL map for. 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. |
Returns | |
---|---|
Type | Description |
google.api_core.extended_operation.ExtendedOperation | An object representing a extended long-running operation. |