UrlMapsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.compute_v1.services.url_maps.transports.base.UrlMapsTransport]] = None, client_options: Optional[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 UrlMaps API.
Properties
transport
Returns the transport used by the client instance.
Type | Description |
UrlMapsTransport | The transport used by the client instance. |
Methods
UrlMapsClient
UrlMapsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.compute_v1.services.url_maps.transports.base.UrlMapsTransport]] = None, client_options: Optional[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 url maps client.
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, UrlMapsTransport]
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 |
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: Optional[Union[google.cloud.compute_v1.types.compute.AggregatedListUrlMapsRequest, dict]] = None, *, project: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Retrieves the list of all UrlMap resources, regional and global, available to the specified project.
Name | Description |
request |
Union[google.cloud.compute_v1.types.AggregatedListUrlMapsRequest, dict]
The request object. A request message for UrlMaps.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.url_maps.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[Union[google.cloud.compute_v1.types.compute.DeleteUrlMapRequest, dict]] = None, *, project: Optional[str] = None, url_map: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Deletes the specified UrlMap resource.
Name | Description |
request |
Union[google.cloud.compute_v1.types.DeleteUrlMapRequest, dict]
The request object. A request message for UrlMaps.Delete. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
url_map |
str
Name of the UrlMap 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.api_core.extended_operation.ExtendedOperation | An object representing a extended long-running operation. |
delete_unary
delete_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.DeleteUrlMapRequest, dict]] = None, *, project: Optional[str] = None, url_map: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Deletes the specified UrlMap resource.
Name | Description |
request |
Union[google.cloud.compute_v1.types.DeleteUrlMapRequest, dict]
The request object. A request message for UrlMaps.Delete. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
url_map |
str
Name of the UrlMap 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.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.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
UrlMapsClient | 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 |
UrlMapsClient | 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 |
UrlMapsClient | The constructed client. |
get
get(request: Optional[Union[google.cloud.compute_v1.types.compute.GetUrlMapRequest, dict]] = None, *, project: Optional[str] = None, url_map: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request.
Name | Description |
request |
Union[google.cloud.compute_v1.types.GetUrlMapRequest, dict]
The request object. A request message for UrlMaps.Get. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
url_map |
str
Name of the UrlMap 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.UrlMap | Represents a URL Map resource. Compute Engine has two URL Map resources: \* [Global](/compute/docs/reference/rest/v1/urlMaps) \* [Regional](/compute/docs/reference/rest/v1/regionUrlMaps) A URL map resource is a component of certain types of cloud load balancers and Traffic Director: \* urlMaps are used by external HTTP(S) load balancers and Traffic Director. \* regionUrlMaps are used by internal HTTP(S) load balancers. For a list of supported URL map features by the load balancer type, see the Load balancing features: Routing and traffic management table. For a list of supported URL map features for Traffic Director, see the Traffic Director features: Routing and traffic management table. This resource defines mappings from hostnames and URL paths to either a backend service or a backend bucket. To use the global urlMaps resource, the backend service must have a loadBalancingScheme of either EXTERNAL or INTERNAL_SELF_MANAGED. To use the regionUrlMaps resource, the backend service must have a loadBalancingScheme of INTERNAL_MANAGED. For more information, read URL Map Concepts. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: 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.
Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
insert
insert(request: Optional[Union[google.cloud.compute_v1.types.compute.InsertUrlMapRequest, dict]] = None, *, project: Optional[str] = None, url_map_resource: Optional[google.cloud.compute_v1.types.compute.UrlMap] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Creates a UrlMap resource in the specified project using the data included in the request.
Name | Description |
request |
Union[google.cloud.compute_v1.types.InsertUrlMapRequest, dict]
The request object. A request message for UrlMaps.Insert. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
url_map_resource |
google.cloud.compute_v1.types.UrlMap
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.api_core.extended_operation.ExtendedOperation | An object representing a extended long-running operation. |
insert_unary
insert_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.InsertUrlMapRequest, dict]] = None, *, project: Optional[str] = None, url_map_resource: Optional[google.cloud.compute_v1.types.compute.UrlMap] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Creates a UrlMap resource in the specified project using the data included in the request.
Name | Description |
request |
Union[google.cloud.compute_v1.types.InsertUrlMapRequest, dict]
The request object. A request message for UrlMaps.Insert. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
url_map_resource |
google.cloud.compute_v1.types.UrlMap
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.api_core.extended_operation.ExtendedOperation | An object representing a extended long-running operation. |
invalidate_cache
invalidate_cache(request: Optional[Union[google.cloud.compute_v1.types.compute.InvalidateCacheUrlMapRequest, dict]] = None, *, project: Optional[str] = None, url_map: Optional[str] = None, cache_invalidation_rule_resource: Optional[google.cloud.compute_v1.types.compute.CacheInvalidationRule] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Initiates a cache invalidation operation, invalidating the
specified path, scoped to the specified UrlMap. For more
information, see Invalidating cached
content </cdn/docs/invalidating-cached-content>
__.
Name | Description |
request |
Union[google.cloud.compute_v1.types.InvalidateCacheUrlMapRequest, dict]
The request object. A request message for UrlMaps.InvalidateCache. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
url_map |
str
Name of the UrlMap scoping this request. This corresponds to the |
cache_invalidation_rule_resource |
google.cloud.compute_v1.types.CacheInvalidationRule
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.api_core.extended_operation.ExtendedOperation | An object representing a extended long-running operation. |
invalidate_cache_unary
invalidate_cache_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.InvalidateCacheUrlMapRequest, dict]] = None, *, project: Optional[str] = None, url_map: Optional[str] = None, cache_invalidation_rule_resource: Optional[google.cloud.compute_v1.types.compute.CacheInvalidationRule] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Initiates a cache invalidation operation, invalidating the
specified path, scoped to the specified UrlMap. For more
information, see Invalidating cached
content </cdn/docs/invalidating-cached-content>
__.
Name | Description |
request |
Union[google.cloud.compute_v1.types.InvalidateCacheUrlMapRequest, dict]
The request object. A request message for UrlMaps.InvalidateCache. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
url_map |
str
Name of the UrlMap scoping this request. This corresponds to the |
cache_invalidation_rule_resource |
google.cloud.compute_v1.types.CacheInvalidationRule
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.api_core.extended_operation.ExtendedOperation | An object representing a extended long-running operation. |
list
list(request: Optional[Union[google.cloud.compute_v1.types.compute.ListUrlMapsRequest, dict]] = None, *, project: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Retrieves the list of UrlMap resources available to the specified project.
Name | Description |
request |
Union[google.cloud.compute_v1.types.ListUrlMapsRequest, dict]
The request object. A request message for UrlMaps.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.url_maps.pagers.ListPager | Contains a list of UrlMap 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[Union[google.cloud.compute_v1.types.compute.PatchUrlMapRequest, dict]] = None, *, project: Optional[str] = None, url_map: Optional[str] = None, url_map_resource: Optional[google.cloud.compute_v1.types.compute.UrlMap] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
Name | Description |
request |
Union[google.cloud.compute_v1.types.PatchUrlMapRequest, dict]
The request object. A request message for UrlMaps.Patch. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
url_map |
str
Name of the UrlMap resource to patch. This corresponds to the |
url_map_resource |
google.cloud.compute_v1.types.UrlMap
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.api_core.extended_operation.ExtendedOperation | An object representing a extended long-running operation. |
patch_unary
patch_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.PatchUrlMapRequest, dict]] = None, *, project: Optional[str] = None, url_map: Optional[str] = None, url_map_resource: Optional[google.cloud.compute_v1.types.compute.UrlMap] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
Name | Description |
request |
Union[google.cloud.compute_v1.types.PatchUrlMapRequest, dict]
The request object. A request message for UrlMaps.Patch. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
url_map |
str
Name of the UrlMap resource to patch. This corresponds to the |
url_map_resource |
google.cloud.compute_v1.types.UrlMap
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.api_core.extended_operation.ExtendedOperation | An object representing a extended long-running operation. |
update
update(request: Optional[Union[google.cloud.compute_v1.types.compute.UpdateUrlMapRequest, dict]] = None, *, project: Optional[str] = None, url_map: Optional[str] = None, url_map_resource: Optional[google.cloud.compute_v1.types.compute.UrlMap] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Updates the specified UrlMap resource with the data included in the request.
Name | Description |
request |
Union[google.cloud.compute_v1.types.UpdateUrlMapRequest, dict]
The request object. A request message for UrlMaps.Update. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
url_map |
str
Name of the UrlMap resource to update. This corresponds to the |
url_map_resource |
google.cloud.compute_v1.types.UrlMap
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.api_core.extended_operation.ExtendedOperation | An object representing a extended long-running operation. |
update_unary
update_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.UpdateUrlMapRequest, dict]] = None, *, project: Optional[str] = None, url_map: Optional[str] = None, url_map_resource: Optional[google.cloud.compute_v1.types.compute.UrlMap] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Updates the specified UrlMap resource with the data included in the request.
Name | Description |
request |
Union[google.cloud.compute_v1.types.UpdateUrlMapRequest, dict]
The request object. A request message for UrlMaps.Update. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
url_map |
str
Name of the UrlMap resource to update. This corresponds to the |
url_map_resource |
google.cloud.compute_v1.types.UrlMap
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.api_core.extended_operation.ExtendedOperation | An object representing a extended long-running operation. |
validate
validate(request: Optional[Union[google.cloud.compute_v1.types.compute.ValidateUrlMapRequest, dict]] = None, *, project: Optional[str] = None, url_map: Optional[str] = None, url_maps_validate_request_resource: Optional[google.cloud.compute_v1.types.compute.UrlMapsValidateRequest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.
Name | Description |
request |
Union[google.cloud.compute_v1.types.ValidateUrlMapRequest, dict]
The request object. A request message for UrlMaps.Validate. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
url_map |
str
Name of the UrlMap resource to be validated as. This corresponds to the |
url_maps_validate_request_resource |
google.cloud.compute_v1.types.UrlMapsValidateRequest
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. |