Class UrlMap (2.3.4)

Stay organized with collections Save and categorize content based on your preferences.
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

Implements

UrlMapOrBuilder

Static Fields

API_ENDPOINT_FIELD_NUMBER

public static final int API_ENDPOINT_FIELD_NUMBER
Field Value
TypeDescription
int

AUTH_FAIL_ACTION_FIELD_NUMBER

public static final int AUTH_FAIL_ACTION_FIELD_NUMBER
Field Value
TypeDescription
int

LOGIN_FIELD_NUMBER

public static final int LOGIN_FIELD_NUMBER
Field Value
TypeDescription
int

REDIRECT_HTTP_RESPONSE_CODE_FIELD_NUMBER

public static final int REDIRECT_HTTP_RESPONSE_CODE_FIELD_NUMBER
Field Value
TypeDescription
int

SCRIPT_FIELD_NUMBER

public static final int SCRIPT_FIELD_NUMBER
Field Value
TypeDescription
int

SECURITY_LEVEL_FIELD_NUMBER

public static final int SECURITY_LEVEL_FIELD_NUMBER
Field Value
TypeDescription
int

STATIC_FILES_FIELD_NUMBER

public static final int STATIC_FILES_FIELD_NUMBER
Field Value
TypeDescription
int

URL_REGEX_FIELD_NUMBER

public static final int URL_REGEX_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static UrlMap getDefaultInstance()
Returns
TypeDescription
UrlMap

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static UrlMap.Builder newBuilder()
Returns
TypeDescription
UrlMap.Builder

newBuilder(UrlMap prototype)

public static UrlMap.Builder newBuilder(UrlMap prototype)
Parameter
NameDescription
prototypeUrlMap
Returns
TypeDescription
UrlMap.Builder

parseDelimitedFrom(InputStream input)

public static UrlMap parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
UrlMap
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UrlMap parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UrlMap
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static UrlMap parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
UrlMap
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static UrlMap parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UrlMap
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static UrlMap parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
UrlMap
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static UrlMap parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UrlMap
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static UrlMap parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
UrlMap
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static UrlMap parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UrlMap
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static UrlMap parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
UrlMap
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UrlMap parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UrlMap
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static UrlMap parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
UrlMap
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static UrlMap parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UrlMap
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<UrlMap> parser()
Returns
TypeDescription
Parser<UrlMap>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getApiEndpoint()

public ApiEndpointHandler getApiEndpoint()

Uses API Endpoints to handle requests.

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

Returns
TypeDescription
ApiEndpointHandler

The apiEndpoint.

getApiEndpointOrBuilder()

public ApiEndpointHandlerOrBuilder getApiEndpointOrBuilder()

Uses API Endpoints to handle requests.

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

Returns
TypeDescription
ApiEndpointHandlerOrBuilder

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;

Returns
TypeDescription
AuthFailAction

The authFailAction.

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;

Returns
TypeDescription
int

The enum numeric value on the wire for authFailAction.

getDefaultInstanceForType()

public UrlMap getDefaultInstanceForType()
Returns
TypeDescription
UrlMap

getHandlerTypeCase()

public UrlMap.HandlerTypeCase getHandlerTypeCase()
Returns
TypeDescription
UrlMap.HandlerTypeCase

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;

Returns
TypeDescription
LoginRequirement

The login.

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;

Returns
TypeDescription
int

The enum numeric value on the wire for login.

getParserForType()

public Parser<UrlMap> getParserForType()
Returns
TypeDescription
Parser<UrlMap>
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;

Returns
TypeDescription
UrlMap.RedirectHttpResponseCode

The redirectHttpResponseCode.

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;

Returns
TypeDescription
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;

Returns
TypeDescription
ScriptHandler

The script.

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;

Returns
TypeDescription
ScriptHandlerOrBuilder

getSecurityLevel()

public SecurityLevel getSecurityLevel()

Security (HTTPS) enforcement for this URL.

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

Returns
TypeDescription
SecurityLevel

The securityLevel.

getSecurityLevelValue()

public int getSecurityLevelValue()

Security (HTTPS) enforcement for this URL.

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

Returns
TypeDescription
int

The enum numeric value on the wire for securityLevel.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
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;

Returns
TypeDescription
StaticFilesHandler

The staticFiles.

getStaticFilesOrBuilder()

public StaticFilesHandlerOrBuilder getStaticFilesOrBuilder()

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

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

Returns
TypeDescription
StaticFilesHandlerOrBuilder

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
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;

Returns
TypeDescription
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;

Returns
TypeDescription
ByteString

The bytes for urlRegex.

hasApiEndpoint()

public boolean hasApiEndpoint()

Uses API Endpoints to handle requests.

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

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
boolean

Whether the staticFiles field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public UrlMap.Builder newBuilderForType()
Returns
TypeDescription
UrlMap.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected UrlMap.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
UrlMap.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public UrlMap.Builder toBuilder()
Returns
TypeDescription
UrlMap.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException