Class UrlMap (1.10.0rc0)

UrlMap(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

NameDescription
url_regex str
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 google.cloud.appengine_admin_v1.types.StaticFilesHandler
Returns the contents of a file, such as an image, as the response. This field is a member of oneof_ handler_type.
script google.cloud.appengine_admin_v1.types.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". This field is a member of oneof_ handler_type.
api_endpoint google.cloud.appengine_admin_v1.types.ApiEndpointHandler
Uses API Endpoints to handle requests. This field is a member of oneof_ handler_type.
security_level google.cloud.appengine_admin_v1.types.SecurityLevel
Security (HTTPS) enforcement for this URL.
login google.cloud.appengine_admin_v1.types.LoginRequirement
Level of login required to access this resource. Not supported for Node.js in the App Engine standard environment.
auth_fail_action google.cloud.appengine_admin_v1.types.AuthFailAction
Action to take when users access resources that require authentication. Defaults to redirect.
redirect_http_response_code google.cloud.appengine_admin_v1.types.UrlMap.RedirectHttpResponseCode
30x code to use when performing redirects for the secure field. Defaults to 302.

Classes

RedirectHttpResponseCode

RedirectHttpResponseCode(value)

Redirect codes.

Values: REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED (0): Not specified. 302 is assumed. REDIRECT_HTTP_RESPONSE_CODE_301 (1): 301 Moved Permanently code. REDIRECT_HTTP_RESPONSE_CODE_302 (2): 302 Moved Temporarily code. REDIRECT_HTTP_RESPONSE_CODE_303 (3): 303 See Other code. REDIRECT_HTTP_RESPONSE_CODE_307 (4): 307 Temporary Redirect code.