Reference documentation and code samples for the Google Cloud Appengine Admin V1 Client 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.
Generated from protobuf message google.appengine.v1.UrlMap
Namespace
Google \ Cloud \ AppEngine \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ url_regex
string
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.
↳ static_files
↳ script
ScriptHandler
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 "script": "auto"
.
↳ api_endpoint
↳ security_level
int
Security (HTTPS) enforcement for this URL.
↳ login
int
Level of login required to access this resource. Not supported for Node.js in the App Engine standard environment.
↳ auth_fail_action
int
Action to take when users access resources that require authentication. Defaults to redirect
.
↳ redirect_http_response_code
int
30x
code to use when performing redirects for the secure
field. Defaults to 302
.
getUrlRegex
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.
string
setUrlRegex
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.
var
string
$this
getStaticFiles
Returns the contents of a file, such as an image, as the response.
hasStaticFiles
setStaticFiles
Returns the contents of a file, such as an image, as the response.
$this
getScript
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 "script": "auto"
.
hasScript
setScript
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 "script": "auto"
.
$this
getApiEndpoint
Uses API Endpoints to handle requests.
hasApiEndpoint
setApiEndpoint
Uses API Endpoints to handle requests.
$this
getSecurityLevel
Security (HTTPS) enforcement for this URL.
int
setSecurityLevel
Security (HTTPS) enforcement for this URL.
var
int
$this
getLogin
Level of login required to access this resource. Not supported for Node.js in the App Engine standard environment.
int
setLogin
Level of login required to access this resource. Not supported for Node.js in the App Engine standard environment.
var
int
$this
getAuthFailAction
Action to take when users access resources that require
authentication. Defaults to redirect
.
int
setAuthFailAction
Action to take when users access resources that require
authentication. Defaults to redirect
.
var
int
$this
getRedirectHttpResponseCode
30x
code to use when performing redirects for the secure
field.
Defaults to 302
.
int
setRedirectHttpResponseCode
30x
code to use when performing redirects for the secure
field.
Defaults to 302
.
var
int
$this
getHandlerType
string