Class UrlMap (2.54.0)

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > UrlMap

Implements

UrlMapOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

API_ENDPOINT_FIELD_NUMBER

public static final int API_ENDPOINT_FIELD_NUMBER

Field Value
Type	Description
`int`

AUTH_FAIL_ACTION_FIELD_NUMBER

public static final int AUTH_FAIL_ACTION_FIELD_NUMBER

Field Value
Type	Description
`int`

LOGIN_FIELD_NUMBER

public static final int LOGIN_FIELD_NUMBER

Field Value
Type	Description
`int`

REDIRECT_HTTP_RESPONSE_CODE_FIELD_NUMBER

public static final int REDIRECT_HTTP_RESPONSE_CODE_FIELD_NUMBER

Field Value
Type	Description
`int`

SCRIPT_FIELD_NUMBER

public static final int SCRIPT_FIELD_NUMBER

Field Value
Type	Description
`int`

SECURITY_LEVEL_FIELD_NUMBER

public static final int SECURITY_LEVEL_FIELD_NUMBER

Field Value
Type	Description
`int`

STATIC_FILES_FIELD_NUMBER

public static final int STATIC_FILES_FIELD_NUMBER

Field Value
Type	Description
`int`

URL_REGEX_FIELD_NUMBER

public static final int URL_REGEX_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static UrlMap getDefaultInstance()

Returns
Type	Description
`UrlMap`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static UrlMap.Builder newBuilder()

Returns
Type	Description
`UrlMap.Builder`

newBuilder(UrlMap prototype)

public static UrlMap.Builder newBuilder(UrlMap prototype)

Parameter
Name	Description
`prototype`	`UrlMap`

Returns
Type	Description
`UrlMap.Builder`

parseDelimitedFrom(InputStream input)

public static UrlMap parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`UrlMap`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UrlMap parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`UrlMap`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static UrlMap parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`UrlMap`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static UrlMap parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`UrlMap`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static UrlMap parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`UrlMap`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static UrlMap parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`UrlMap`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static UrlMap parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`UrlMap`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static UrlMap parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`UrlMap`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static UrlMap parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`UrlMap`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UrlMap parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`UrlMap`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static UrlMap parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`UrlMap`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static UrlMap parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`UrlMap`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<UrlMap> parser()

Returns
Type	Description
`Parser<UrlMap>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getApiEndpoint()

public ApiEndpointHandler getApiEndpoint()

Uses API Endpoints to handle requests.

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

Returns
Type	Description
`ApiEndpointHandler`	The apiEndpoint.

getApiEndpointOrBuilder()

public ApiEndpointHandlerOrBuilder getApiEndpointOrBuilder()

Uses API Endpoints to handle requests.

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

Returns
Type	Description
`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
Type	Description
`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
Type	Description
`int`	The enum numeric value on the wire for authFailAction.

getDefaultInstanceForType()

public UrlMap getDefaultInstanceForType()

Returns
Type	Description
`UrlMap`

getHandlerTypeCase()

public UrlMap.HandlerTypeCase getHandlerTypeCase()

Returns
Type	Description
`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
Type	Description
`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
Type	Description
`int`	The enum numeric value on the wire for login.

getParserForType()

public Parser<UrlMap> getParserForType()

Returns
Type	Description
`Parser<UrlMap>`

Overrides

GeneratedMessageV3.getParserForType()

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
Type	Description
`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
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;

Returns
Type	Description
`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
Type	Description
`ScriptHandlerOrBuilder`

getSecurityLevel()

public SecurityLevel getSecurityLevel()

Security (HTTPS) enforcement for this URL.

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

Returns
Type	Description
`SecurityLevel`	The securityLevel.

getSecurityLevelValue()

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

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

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
Type	Description
`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
Type	Description
`StaticFilesHandlerOrBuilder`

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
Type	Description
`String`	The urlRegex.

getUrlRegexBytes()

public ByteString getUrlRegexBytes()

string url_regex = 1;

Returns
Type	Description
`ByteString`	The bytes for urlRegex.

hasApiEndpoint()

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

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public UrlMap.Builder newBuilderForType()

Returns
Type	Description
`UrlMap.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected UrlMap.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`UrlMap.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public UrlMap.Builder toBuilder()

Returns
Type	Description
`UrlMap.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`