Interface UrlMapOrBuilder (2.4.0)

Version 2.4.0

• 2.53.0 (latest)
• 2.52.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.4
• 2.2.0
• 2.1.10
• 0.2.0

public interface UrlMapOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getApiEndpoint()

public abstract ApiEndpointHandler getApiEndpoint()

Uses API Endpoints to handle requests.

.google.appengine.v1.ApiEndpointHandler api_endpoint = 4;

Returns

Type	Description
ApiEndpointHandler	The apiEndpoint.

getApiEndpointOrBuilder()

public abstract ApiEndpointHandlerOrBuilder getApiEndpointOrBuilder()

Uses API Endpoints to handle requests.

.google.appengine.v1.ApiEndpointHandler api_endpoint = 4;

Returns

Type	Description
ApiEndpointHandlerOrBuilder

getAuthFailAction()

public abstract AuthFailAction getAuthFailAction()

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

.google.appengine.v1.AuthFailAction auth_fail_action = 7;

Returns

Type	Description
AuthFailAction	The authFailAction.

getAuthFailActionValue()

public abstract int getAuthFailActionValue()

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

.google.appengine.v1.AuthFailAction auth_fail_action = 7;

Returns

Type	Description
int	The enum numeric value on the wire for authFailAction.

getHandlerTypeCase()

public abstract UrlMap.HandlerTypeCase getHandlerTypeCase()

Returns

Type	Description
UrlMap.HandlerTypeCase

getLogin()

public abstract LoginRequirement getLogin()

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

.google.appengine.v1.LoginRequirement login = 6;

Returns

Type	Description
LoginRequirement	The login.

getLoginValue()

public abstract int getLoginValue()

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

.google.appengine.v1.LoginRequirement login = 6;

Returns

Type	Description
int	The enum numeric value on the wire for login.

getRedirectHttpResponseCode()

public abstract UrlMap.RedirectHttpResponseCode getRedirectHttpResponseCode()

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

.google.appengine.v1.UrlMap.RedirectHttpResponseCode redirect_http_response_code = 8;

Returns

Type	Description
UrlMap.RedirectHttpResponseCode	The redirectHttpResponseCode.

getRedirectHttpResponseCodeValue()

public abstract int getRedirectHttpResponseCodeValue()

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

.google.appengine.v1.UrlMap.RedirectHttpResponseCode redirect_http_response_code = 8;

Returns

Type	Description
int	The enum numeric value on the wire for redirectHttpResponseCode.

getScript()

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

.google.appengine.v1.ScriptHandler script = 3;

Returns

Type	Description
ScriptHandler	The script.

getScriptOrBuilder()

public abstract ScriptHandlerOrBuilder getScriptOrBuilder()

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

.google.appengine.v1.ScriptHandler script = 3;

Returns

Type	Description
ScriptHandlerOrBuilder

getSecurityLevel()

public abstract SecurityLevel getSecurityLevel()

Security (HTTPS) enforcement for this URL.

.google.appengine.v1.SecurityLevel security_level = 5;

Returns

Type	Description
SecurityLevel	The securityLevel.

getSecurityLevelValue()

public abstract int getSecurityLevelValue()

Security (HTTPS) enforcement for this URL.

.google.appengine.v1.SecurityLevel security_level = 5;

Returns

Type	Description
int	The enum numeric value on the wire for securityLevel.

getStaticFiles()

public abstract StaticFilesHandler getStaticFiles()

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

.google.appengine.v1.StaticFilesHandler static_files = 2;

Returns

Type	Description
StaticFilesHandler	The staticFiles.

getStaticFilesOrBuilder()

public abstract StaticFilesHandlerOrBuilder getStaticFilesOrBuilder()

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

.google.appengine.v1.StaticFilesHandler static_files = 2;

Returns

Type	Description
StaticFilesHandlerOrBuilder

getUrlRegex()

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

string url_regex = 1;

Returns

Type	Description
String	The urlRegex.

getUrlRegexBytes()

public abstract ByteString getUrlRegexBytes()

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 url_regex = 1;

Returns

Type	Description
ByteString	The bytes for urlRegex.

hasApiEndpoint()

public abstract boolean hasApiEndpoint()

Uses API Endpoints to handle requests.

.google.appengine.v1.ApiEndpointHandler api_endpoint = 4;

Returns

Type	Description
boolean	Whether the apiEndpoint field is set.

hasScript()

public abstract boolean hasScript()

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

.google.appengine.v1.ScriptHandler script = 3;

Returns

Type	Description
boolean	Whether the script field is set.

hasStaticFiles()

public abstract boolean hasStaticFiles()

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

.google.appengine.v1.StaticFilesHandler static_files = 2;

Returns

Type	Description
boolean	Whether the staticFiles field is set.