Compute Engine v1 API - Class UrlMap (2.7.0) 

public sealed class UrlMap : IMessage<UrlMap>, IEquatable<UrlMap>, IDeepCloneable<UrlMap>, IBufferMessage, IMessage

Reference documentation and code samples for the Compute Engine v1 API class UrlMap.

Represents a URL Map resource. Compute Engine has two URL Map resources: * Global * Regional 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.

Inheritance

object > UrlMap

Namespace

GoogleCloudGoogle.Cloud.ComputeV1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

UrlMap()

public UrlMap()

UrlMap(UrlMap)

public UrlMap(UrlMap other)
Parameter
NameDescription
otherUrlMap

Properties

CreationTimestamp

public string CreationTimestamp { get; set; }

[Output Only] Creation timestamp in RFC3339 text format.

Property Value
TypeDescription
string

DefaultRouteAction

public HttpRouteAction DefaultRouteAction { get; set; }

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.

Property Value
TypeDescription
HttpRouteAction

DefaultService

public string DefaultService { get; set; }

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.

Property Value
TypeDescription
string

DefaultUrlRedirect

public HttpRedirectAction DefaultUrlRedirect { get; set; }

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.

Property Value
TypeDescription
HttpRedirectAction

Description

public string Description { get; set; }

An optional description of this resource. Provide this property when you create the resource.

Property Value
TypeDescription
string

Fingerprint

public string Fingerprint { get; set; }

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.

Property Value
TypeDescription
string

HasCreationTimestamp

public bool HasCreationTimestamp { get; }

Gets whether the "creation_timestamp" field is set

Property Value
TypeDescription
bool

HasDefaultService

public bool HasDefaultService { get; }

Gets whether the "default_service" field is set

Property Value
TypeDescription
bool

HasDescription

public bool HasDescription { get; }

Gets whether the "description" field is set

Property Value
TypeDescription
bool

HasFingerprint

public bool HasFingerprint { get; }

Gets whether the "fingerprint" field is set

Property Value
TypeDescription
bool

HasId

public bool HasId { get; }

Gets whether the "id" field is set

Property Value
TypeDescription
bool

HasKind

public bool HasKind { get; }

Gets whether the "kind" field is set

Property Value
TypeDescription
bool

HasName

public bool HasName { get; }

Gets whether the "name" field is set

Property Value
TypeDescription
bool

HasRegion

public bool HasRegion { get; }

Gets whether the "region" field is set

Property Value
TypeDescription
bool
public bool HasSelfLink { get; }

Gets whether the "self_link" field is set

Property Value
TypeDescription
bool

HeaderAction

public HttpHeaderAction HeaderAction { get; set; }

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.

Property Value
TypeDescription
HttpHeaderAction

HostRules

public RepeatedField<HostRule> HostRules { get; }

The list of host rules to use against the URL.

Property Value
TypeDescription
RepeatedFieldHostRule

Id

public ulong Id { get; set; }

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Property Value
TypeDescription
ulong

Kind

public string Kind { get; set; }

[Output Only] Type of the resource. Always compute#urlMaps for url maps.

Property Value
TypeDescription
string

Name

public string Name { get; set; }

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.

Property Value
TypeDescription
string

PathMatchers

public RepeatedField<PathMatcher> PathMatchers { get; }

The list of named PathMatchers to use against the URL.

Property Value
TypeDescription
RepeatedFieldPathMatcher

Region

public string Region { get; set; }

[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.

Property Value
TypeDescription
string
public string SelfLink { get; set; }

[Output Only] Server-defined URL for the resource.

Property Value
TypeDescription
string

Tests

public RepeatedField<UrlMapTest> Tests { get; }

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.

Property Value
TypeDescription
RepeatedFieldUrlMapTest