UrlMap(mapping=None, *, ignore_unknown_fields=False, **kwargs)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.
Attributes
| Name | Description |
| creation_timestamp |
str
[Output Only] Creation timestamp in RFC3339 text format. This field is a member of `oneof`_ ``_creation_timestamp``. |
| default_route_action |
google.cloud.compute_v1.types.HttpRouteAction
defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for Classic external HTTP(S) load balancers only support the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. This field is a member of `oneof`_ ``_default_route_action``. |
| default_service |
str
The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. This field is a member of `oneof`_ ``_default_service``. |
| default_url_redirect |
google.cloud.compute_v1.types.HttpRedirectAction
When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. This field is a member of `oneof`_ ``_default_url_redirect``. |
| description |
str
An optional description of this resource. Provide this property when you create the resource. This field is a member of `oneof`_ ``_description``. |
| fingerprint |
str
Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field is ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a UrlMap. This field is a member of `oneof`_ ``_fingerprint``. |
| header_action |
google.cloud.compute_v1.types.HttpHeaderAction
Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here take effect after headerAction specified under pathMatcher. headerAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true. This field is a member of `oneof`_ ``_header_action``. |
| host_rules |
Sequence[google.cloud.compute_v1.types.HostRule]
The list of host rules to use against the URL. |
| id |
int
[Output Only] The unique identifier for the resource. This identifier is defined by the server. This field is a member of `oneof`_ ``_id``. |
| kind |
str
[Output Only] Type of the resource. Always compute#urlMaps for url maps. This field is a member of `oneof`_ ``_kind``. |
| name |
str
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression ``[a-z]([-a-z0-9]*[a-z0-9])?`` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. This field is a member of `oneof`_ ``_name``. |
| path_matchers |
Sequence[google.cloud.compute_v1.types.PathMatcher]
The list of named PathMatchers to use against the URL. |
| region |
str
[Output Only] URL of the region where the regional URL map resides. This field is not applicable to global URL maps. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. This field is a member of `oneof`_ ``_region``. |
| self_link |
str
[Output Only] Server-defined URL for the resource. This field is a member of `oneof`_ ``_self_link``. |
| tests |
Sequence[google.cloud.compute_v1.types.UrlMapTest]
The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true. |