Class UrlMap (2.78.0)

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

Implements

UrlMapOrBuilder

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()
Returns
Type Description
Descriptor

newBuilder()

publicstaticUrlMap.BuildernewBuilder()
Returns
Type Description
UrlMap.Builder

newBuilder(UrlMap prototype)

publicstaticUrlMap.BuildernewBuilder(UrlMapprototype)
Parameter
Name Description
prototype UrlMap
Returns
Type Description
UrlMap.Builder

parseDelimitedFrom(InputStream input)

publicstaticUrlMapparseDelimitedFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
UrlMap
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticUrlMapparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UrlMap
Exceptions
Type Description
IOException

parseFrom(byte[] data)

publicstaticUrlMapparseFrom(byte[]data)
Parameter
Name Description
data byte[]
Returns
Type Description
UrlMap
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticUrlMapparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UrlMap
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticUrlMapparseFrom(ByteStringdata)
Parameter
Name Description
data ByteString
Returns
Type Description
UrlMap
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticUrlMapparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UrlMap
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticUrlMapparseFrom(CodedInputStreaminput)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
UrlMap
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticUrlMapparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UrlMap
Exceptions
Type Description
IOException

parseFrom(InputStream input)

publicstaticUrlMapparseFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
UrlMap
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticUrlMapparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UrlMap
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

publicstaticUrlMapparseFrom(ByteBufferdata)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
UrlMap
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticUrlMapparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UrlMap
Exceptions
Type Description
InvalidProtocolBufferException

parser()

publicstaticParser<UrlMap>parser()
Returns
Type Description
Parser<UrlMap>

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getApiEndpoint()

publicApiEndpointHandlergetApiEndpoint()

Uses API Endpoints to handle requests.

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

Returns
Type Description
ApiEndpointHandler

The apiEndpoint.

getApiEndpointOrBuilder()

publicApiEndpointHandlerOrBuildergetApiEndpointOrBuilder()

Uses API Endpoints to handle requests.

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

Returns
Type Description
ApiEndpointHandlerOrBuilder

getAuthFailAction()

publicAuthFailActiongetAuthFailAction()

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()

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()
Returns
Type Description
UrlMap.HandlerTypeCase

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;

Returns
Type Description
LoginRequirement

The login.

getLoginValue()

publicintgetLoginValue()

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()
Returns
Type Description
Parser<UrlMap>
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;

Returns
Type Description
UrlMap.RedirectHttpResponseCode

The redirectHttpResponseCode.

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;

Returns
Type Description
ScriptHandler

The script.

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;

Returns
Type Description
ScriptHandlerOrBuilder

getSecurityLevel()

publicSecurityLevelgetSecurityLevel()

Security (HTTPS) enforcement for this URL.

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

Returns
Type Description
SecurityLevel

The securityLevel.

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;

Returns
Type Description
StaticFilesHandler

The staticFiles.

getStaticFilesOrBuilder()

publicStaticFilesHandlerOrBuildergetStaticFilesOrBuilder()

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()

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()

publicbooleanhasScript()

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()

publicinthashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

publicUrlMap.BuildernewBuilderForType()
Returns
Type Description
UrlMap.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedUrlMap.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
UrlMap.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

publicUrlMap.BuildertoBuilder()
Returns
Type Description
UrlMap.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.