UrlMap class

Represents a URL Map resource.

Google Compute Engine has two URL Map resources:

A URL map resource is a component of certain types of GCP 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 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 host names 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.

Constructors

UrlMap()
UrlMap.fromJson(Map _json)

Properties

creationTimestamp String
Output Only Creation timestamp in RFC3339 text format.
read / write
defaultRouteAction HttpRouteAction
defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to 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. UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
read / write
defaultService String
The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to 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 target gRPC proxy that has validateForProxyless field set to true.
read / write
defaultUrlRedirect 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 target gRPC proxy.
read / write
description String
An optional description of this resource. Provide this property when you create the resource.
read / write
fingerprint String
Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be 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. [...]
read / write
fingerprintAsBytes List<int>
read / write
hashCode int
The hash code for this object. [...]
read-only, inherited
headerAction 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. Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
read / write
hostRules List<HostRule>
The list of HostRules to use against the URL.
read / write
id String
Output Only The unique identifier for the resource. This identifier is defined by the server.
read / write
kind String
Output Only Type of the resource. Always compute#urlMaps for url maps.
read / write
name String
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.
read / write
pathMatchers List<PathMatcher>
The list of named PathMatchers to use against the URL.
read / write
region String
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.
read / write
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
Output Only Server-defined URL for the resource.
read / write
tests List<UrlMapTest>
The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
read / write

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
toJson() Map<String, Object>
toString() String
Returns a string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator. [...]
inherited