google_api_app_engine v0.3.0 GoogleApi.AppEngine.V1.Model.UrlMap View Source

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.

Attributes

  • apiEndpoint (ApiEndpointHandler): Uses API Endpoints to handle requests. Defaults to: null.
  • authFailAction (String.t): Action to take when users access resources that require authentication. Defaults to redirect. Defaults to: null.

    • Enum - one of [AUTH_FAIL_ACTION_UNSPECIFIED, AUTH_FAIL_ACTION_REDIRECT, AUTH_FAIL_ACTION_UNAUTHORIZED]
  • login (String.t): Level of login required to access this resource. Not supported for Node.js in the App Engine standard environment. Defaults to: null.

    • Enum - one of [LOGIN_UNSPECIFIED, LOGIN_OPTIONAL, LOGIN_ADMIN, LOGIN_REQUIRED]
  • redirectHttpResponseCode (String.t): 30x code to use when performing redirects for the secure field. Defaults to 302. Defaults to: null.

    • Enum - one of [REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED, REDIRECT_HTTP_RESPONSE_CODE_301, REDIRECT_HTTP_RESPONSE_CODE_302, REDIRECT_HTTP_RESPONSE_CODE_303, REDIRECT_HTTP_RESPONSE_CODE_307]
  • 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". Defaults to: null.
  • securityLevel (String.t): Security (HTTPS) enforcement for this URL. Defaults to: null.

    • Enum - one of [SECURE_UNSPECIFIED, SECURE_DEFAULT, SECURE_NEVER, SECURE_OPTIONAL, SECURE_ALWAYS]
  • staticFiles (StaticFilesHandler): Returns the contents of a file, such as an image, as the response. Defaults to: null.
  • urlRegex (String.t): 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. Defaults to: null.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields

Link to this section Types

Link to this type

t() View Source
t() :: %GoogleApi.AppEngine.V1.Model.UrlMap{
  apiEndpoint: GoogleApi.AppEngine.V1.Model.ApiEndpointHandler.t(),
  authFailAction: any(),
  login: any(),
  redirectHttpResponseCode: any(),
  script: GoogleApi.AppEngine.V1.Model.ScriptHandler.t(),
  securityLevel: any(),
  staticFiles: GoogleApi.AppEngine.V1.Model.StaticFilesHandler.t(),
  urlRegex: any()
}

Link to this section Functions

Link to this function

decode(value, options) View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.