publicfinalclass UrlMapextendsGeneratedMessageV3implementsUrlMapOrBuilder
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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
API_ENDPOINT_FIELD_NUMBER
publicstaticfinalintAPI_ENDPOINT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
AUTH_FAIL_ACTION_FIELD_NUMBER
publicstaticfinalintAUTH_FAIL_ACTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
LOGIN_FIELD_NUMBER
publicstaticfinalintLOGIN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
REDIRECT_HTTP_RESPONSE_CODE_FIELD_NUMBER
publicstaticfinalintREDIRECT_HTTP_RESPONSE_CODE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
SCRIPT_FIELD_NUMBER
publicstaticfinalintSCRIPT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
SECURITY_LEVEL_FIELD_NUMBER
publicstaticfinalintSECURITY_LEVEL_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
STATIC_FILES_FIELD_NUMBER
publicstaticfinalintSTATIC_FILES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
URL_REGEX_FIELD_NUMBER
publicstaticfinalintURL_REGEX_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
Static Methods
getDefaultInstance()
publicstaticUrlMapgetDefaultInstance()
| Returns |
| Type |
Description |
UrlMap |
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()
newBuilder()
publicstaticUrlMap.BuildernewBuilder()
newBuilder(UrlMap prototype)
publicstaticUrlMap.BuildernewBuilder(UrlMapprototype)
| Parameter |
| Name |
Description |
prototype |
UrlMap
|
publicstaticUrlMapparseDelimitedFrom(InputStreaminput)
| Returns |
| Type |
Description |
UrlMap |
publicstaticUrlMapparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
| Returns |
| Type |
Description |
UrlMap |
parseFrom(byte[] data)
publicstaticUrlMapparseFrom(byte[]data)
| Parameter |
| Name |
Description |
data |
byte[]
|
| Returns |
| Type |
Description |
UrlMap |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
publicstaticUrlMapparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
| Returns |
| Type |
Description |
UrlMap |
parseFrom(ByteString data)
publicstaticUrlMapparseFrom(ByteStringdata)
| Returns |
| Type |
Description |
UrlMap |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
publicstaticUrlMapparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
| Returns |
| Type |
Description |
UrlMap |
publicstaticUrlMapparseFrom(CodedInputStreaminput)
| Returns |
| Type |
Description |
UrlMap |
publicstaticUrlMapparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
| Returns |
| Type |
Description |
UrlMap |
publicstaticUrlMapparseFrom(InputStreaminput)
| Returns |
| Type |
Description |
UrlMap |
publicstaticUrlMapparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
| Returns |
| Type |
Description |
UrlMap |
parseFrom(ByteBuffer data)
publicstaticUrlMapparseFrom(ByteBufferdata)
| Returns |
| Type |
Description |
UrlMap |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
publicstaticUrlMapparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
| Returns |
| Type |
Description |
UrlMap |
parser()
publicstaticParser<UrlMap>parser()
Methods
equals(Object obj)
publicbooleanequals(Objectobj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getApiEndpoint()
publicApiEndpointHandlergetApiEndpoint()
Uses API Endpoints to handle requests.
.google.appengine.v1.ApiEndpointHandler api_endpoint = 4;
getApiEndpointOrBuilder()
publicApiEndpointHandlerOrBuildergetApiEndpointOrBuilder()
Uses API Endpoints to handle requests.
.google.appengine.v1.ApiEndpointHandler api_endpoint = 4;
getAuthFailAction()
publicAuthFailActiongetAuthFailAction()
Action to take when users access resources that require
authentication. Defaults to redirect.
.google.appengine.v1.AuthFailAction auth_fail_action = 7;
getAuthFailActionValue()
publicintgetAuthFailActionValue()
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.
|
getDefaultInstanceForType()
publicUrlMapgetDefaultInstanceForType()
| Returns |
| Type |
Description |
UrlMap |
getHandlerTypeCase()
publicUrlMap.HandlerTypeCasegetHandlerTypeCase()
getLogin()
publicLoginRequirementgetLogin()
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()
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.
|
getParserForType()
publicParser<UrlMap>getParserForType()
Overrides
getRedirectHttpResponseCode()
publicUrlMap.RedirectHttpResponseCodegetRedirectHttpResponseCode()
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()
publicintgetRedirectHttpResponseCodeValue()
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()
publicScriptHandlergetScript()
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()
publicScriptHandlerOrBuildergetScriptOrBuilder()
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()
publicSecurityLevelgetSecurityLevel()
Security (HTTPS) enforcement for this URL.
.google.appengine.v1.SecurityLevel security_level = 5;
getSecurityLevelValue()
publicintgetSecurityLevelValue()
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.
|
getSerializedSize()
publicintgetSerializedSize()
| Returns |
| Type |
Description |
int |
Overrides
getStaticFiles()
publicStaticFilesHandlergetStaticFiles()
Returns the contents of a file, such as an image, as the response.
.google.appengine.v1.StaticFilesHandler static_files = 2;
getStaticFilesOrBuilder()
publicStaticFilesHandlerOrBuildergetStaticFilesOrBuilder()
Returns the contents of a file, such as an image, as the response.
.google.appengine.v1.StaticFilesHandler static_files = 2;
getUrlRegex()
publicStringgetUrlRegex()
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()
publicByteStringgetUrlRegexBytes()
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()
publicbooleanhasApiEndpoint()
Uses API Endpoints to handle requests.
.google.appengine.v1.ApiEndpointHandler api_endpoint = 4;
| Returns |
| Type |
Description |
boolean |
Whether the apiEndpoint field is set.
|
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()
publicbooleanhasStaticFiles()
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
Overrides
internalGetFieldAccessorTable()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Overrides
isInitialized()
publicfinalbooleanisInitialized()
Overrides
newBuilderForType()
publicUrlMap.BuildernewBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protectedUrlMap.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
| Returns |
| Type |
Description |
Object |
Overrides
toBuilder()
publicUrlMap.BuildertoBuilder()
writeTo(CodedOutputStream output)
publicvoidwriteTo(CodedOutputStreamoutput)
Overrides