com.google.api.services.appengine.v1.model

Class UrlMap

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.appengine.v1.model.UrlMap

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class UrlMap
extends com.google.api.client.json.GenericJson

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 is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the App Engine Admin API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
UrlMap()

Method Summary

Modifier and Type	Method and Description
UrlMap	clone()
ApiEndpointHandler	getApiEndpoint() Uses API Endpoints to handle requests.
String	getAuthFailAction() Action to take when users access resources that require authentication.
String	getLogin() Level of login required to access this resource.
String	getRedirectHttpResponseCode() 30x code to use when performing redirects for the secure field.
ScriptHandler	getScript() Executes a script to handle the requests that match this URL pattern.
String	getSecurityLevel() Security (HTTPS) enforcement for this URL.
StaticFilesHandler	getStaticFiles() Returns the contents of a file, such as an image, as the response.
String	getUrlRegex() URL prefix.
UrlMap	set(String fieldName, Object value)
UrlMap	setApiEndpoint(ApiEndpointHandler apiEndpoint) Uses API Endpoints to handle requests.
UrlMap	setAuthFailAction(String authFailAction) Action to take when users access resources that require authentication.
UrlMap	setLogin(String login) Level of login required to access this resource.
UrlMap	setRedirectHttpResponseCode(String redirectHttpResponseCode) 30x code to use when performing redirects for the secure field.
UrlMap	setScript(ScriptHandler script) Executes a script to handle the requests that match this URL pattern.
UrlMap	setSecurityLevel(String securityLevel) Security (HTTPS) enforcement for this URL.
UrlMap	setStaticFiles(StaticFilesHandler staticFiles) Returns the contents of a file, such as an image, as the response.
UrlMap	setUrlRegex(String urlRegex) URL prefix.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

UrlMap

public UrlMap()

Method Detail

getApiEndpoint

public ApiEndpointHandler getApiEndpoint()

Uses API Endpoints to handle requests.

Returns:

value or null for none

setApiEndpoint

public UrlMap setApiEndpoint(ApiEndpointHandler apiEndpoint)

Uses API Endpoints to handle requests.

Parameters:

apiEndpoint - apiEndpoint or null for none

getAuthFailAction

public String getAuthFailAction()

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

Returns:

value or null for none

setAuthFailAction

public UrlMap setAuthFailAction(String authFailAction)

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

Parameters:

authFailAction - authFailAction or null for none

getLogin

public String getLogin()

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

Returns:

value or null for none

setLogin

public UrlMap setLogin(String login)

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

Parameters:

login - login or null for none

getRedirectHttpResponseCode

public String getRedirectHttpResponseCode()

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

Returns:

value or null for none

setRedirectHttpResponseCode

public UrlMap setRedirectHttpResponseCode(String redirectHttpResponseCode)

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

Parameters:

redirectHttpResponseCode - redirectHttpResponseCode or null for none

getScript

public ScriptHandler 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".

Returns:

value or null for none

setScript

public UrlMap setScript(ScriptHandler script)

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

Parameters:

script - script or null for none

getSecurityLevel

public String getSecurityLevel()

Security (HTTPS) enforcement for this URL.

Returns:

value or null for none

setSecurityLevel

public UrlMap setSecurityLevel(String securityLevel)

Security (HTTPS) enforcement for this URL.

Parameters:

securityLevel - securityLevel or null for none

getStaticFiles

public StaticFilesHandler getStaticFiles()

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

Returns:

value or null for none

setStaticFiles

public UrlMap setStaticFiles(StaticFilesHandler staticFiles)

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

Parameters:

staticFiles - staticFiles or null for none

getUrlRegex

public String 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.

Returns:

value or null for none

setUrlRegex

public UrlMap setUrlRegex(String urlRegex)

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.

Parameters:

urlRegex - urlRegex or null for none

set

public UrlMap set(String fieldName,
                  Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public UrlMap clone()

Overrides:

clone in class com.google.api.client.json.GenericJson