public final class UrlMap extends GeneratedMessageV3 implements UrlMapOrBuilder
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.
Protobuf type google.appengine.v1.UrlMap
Static Fields
API_ENDPOINT_FIELD_NUMBER
public static final int API_ENDPOINT_FIELD_NUMBER
Field Value
AUTH_FAIL_ACTION_FIELD_NUMBER
public static final int AUTH_FAIL_ACTION_FIELD_NUMBER
Field Value
LOGIN_FIELD_NUMBER
public static final int LOGIN_FIELD_NUMBER
Field Value
REDIRECT_HTTP_RESPONSE_CODE_FIELD_NUMBER
public static final int REDIRECT_HTTP_RESPONSE_CODE_FIELD_NUMBER
Field Value
SCRIPT_FIELD_NUMBER
public static final int SCRIPT_FIELD_NUMBER
Field Value
SECURITY_LEVEL_FIELD_NUMBER
public static final int SECURITY_LEVEL_FIELD_NUMBER
Field Value
STATIC_FILES_FIELD_NUMBER
public static final int STATIC_FILES_FIELD_NUMBER
Field Value
URL_REGEX_FIELD_NUMBER
public static final int URL_REGEX_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static UrlMap getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static UrlMap.Builder newBuilder()
Returns
newBuilder(UrlMap prototype)
public static UrlMap.Builder newBuilder(UrlMap prototype)
Parameter
| Name | Description |
| prototype | UrlMap
|
Returns
public static UrlMap parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static UrlMap parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static UrlMap parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static UrlMap parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static UrlMap parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static UrlMap parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static UrlMap parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static UrlMap parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static UrlMap parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static UrlMap parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static UrlMap parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static UrlMap parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<UrlMap> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getApiEndpoint()
public ApiEndpointHandler getApiEndpoint()
Uses API Endpoints to handle requests.
.google.appengine.v1.ApiEndpointHandler api_endpoint = 4;
getApiEndpointOrBuilder()
public ApiEndpointHandlerOrBuilder getApiEndpointOrBuilder()
Uses API Endpoints to handle requests.
.google.appengine.v1.ApiEndpointHandler api_endpoint = 4;
getAuthFailAction()
public AuthFailAction getAuthFailAction()
Action to take when users access resources that require
authentication. Defaults to redirect.
.google.appengine.v1.AuthFailAction auth_fail_action = 7;
getAuthFailActionValue()
public int getAuthFailActionValue()
Action to take when users access resources that require
authentication. Defaults to redirect.
.google.appengine.v1.AuthFailAction auth_fail_action = 7;
| Type | Description |
| int | The enum numeric value on the wire for authFailAction.
|
getDefaultInstanceForType()
public UrlMap getDefaultInstanceForType()
Returns
getHandlerTypeCase()
public UrlMap.HandlerTypeCase getHandlerTypeCase()
Returns
getLogin()
public 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;
getLoginValue()
public 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;
| Type | Description |
| int | The enum numeric value on the wire for login.
|
getParserForType()
public Parser<UrlMap> getParserForType()
Returns
Overrides
getRedirectHttpResponseCode()
public 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;
getRedirectHttpResponseCodeValue()
public 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;
| Type | Description |
| int | The enum numeric value on the wire for redirectHttpResponseCode.
|
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".
.google.appengine.v1.ScriptHandler script = 3;
getScriptOrBuilder()
public 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;
getSecurityLevel()
public SecurityLevel getSecurityLevel()
Security (HTTPS) enforcement for this URL.
.google.appengine.v1.SecurityLevel security_level = 5;
getSecurityLevelValue()
public int getSecurityLevelValue()
Security (HTTPS) enforcement for this URL.
.google.appengine.v1.SecurityLevel security_level = 5;
| Type | Description |
| int | The enum numeric value on the wire for securityLevel.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getStaticFiles()
public StaticFilesHandler getStaticFiles()
Returns the contents of a file, such as an image, as the response.
.google.appengine.v1.StaticFilesHandler static_files = 2;
getStaticFilesOrBuilder()
public StaticFilesHandlerOrBuilder getStaticFilesOrBuilder()
Returns the contents of a file, such as an image, as the response.
.google.appengine.v1.StaticFilesHandler static_files = 2;
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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.
string url_regex = 1;
| Type | Description |
| String | The urlRegex.
|
getUrlRegexBytes()
public 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;
hasApiEndpoint()
public boolean hasApiEndpoint()
Uses API Endpoints to handle requests.
.google.appengine.v1.ApiEndpointHandler api_endpoint = 4;
| Type | Description |
| boolean | Whether the apiEndpoint field is set.
|
hasScript()
public 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;
| Type | Description |
| boolean | Whether the script field is set.
|
hasStaticFiles()
public boolean hasStaticFiles()
Returns the contents of a file, such as an image, as the response.
.google.appengine.v1.StaticFilesHandler static_files = 2;
| Type | Description |
| boolean | Whether the staticFiles field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public UrlMap.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected UrlMap.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public UrlMap.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
