App Engine v1 API - Class UrlMap (2.1.0)

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

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

URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.

Inheritance

Object > UrlMap

Namespace

Google.Cloud.AppEngine.V1

Assembly

Google.Cloud.AppEngine.V1.dll

Constructors

UrlMap()

public UrlMap()

UrlMap(UrlMap)

public UrlMap(UrlMap other)
Parameter
NameDescription
otherUrlMap

Properties

ApiEndpoint

public ApiEndpointHandler ApiEndpoint { get; set; }

Uses API Endpoints to handle requests.

Property Value
TypeDescription
ApiEndpointHandler

AuthFailAction

public AuthFailAction AuthFailAction { get; set; }

Action to take when users access resources that require authentication. Defaults to redirect.

Property Value
TypeDescription
AuthFailAction

HandlerTypeCase

public UrlMap.HandlerTypeOneofCase HandlerTypeCase { get; }
Property Value
TypeDescription
UrlMap.HandlerTypeOneofCase

Login

public LoginRequirement Login { get; set; }

Level of login required to access this resource. Not supported for Node.js in the App Engine standard environment.

Property Value
TypeDescription
LoginRequirement

RedirectHttpResponseCode

public UrlMap.Types.RedirectHttpResponseCode RedirectHttpResponseCode { get; set; }

30x code to use when performing redirects for the secure field. Defaults to 302.

Property Value
TypeDescription
UrlMap.Types.RedirectHttpResponseCode

Script

public ScriptHandler Script { get; set; }

Executes a script to handle the requests that match this URL pattern. Only the auto value is supported for Node.js in the App Engine standard environment, for example &quot;script&quot;: &quot;auto&quot;.

Property Value
TypeDescription
ScriptHandler

SecurityLevel

public SecurityLevel SecurityLevel { get; set; }

Security (HTTPS) enforcement for this URL.

Property Value
TypeDescription
SecurityLevel

StaticFiles

public StaticFilesHandler StaticFiles { get; set; }

Returns the contents of a file, such as an image, as the response.

Property Value
TypeDescription
StaticFilesHandler

UrlRegex

public string UrlRegex { get; set; }

URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.

Property Value
TypeDescription
String