com.google.appengine.v1

Class UrlMap

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.appengine.v1.UrlMap

All Implemented Interfaces:

UrlMapOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, java.io.Serializable

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UrlMap.Builder URL pattern and description of how the URL should be handled.
static class	UrlMap.HandlerTypeCase
static class	UrlMap.RedirectHttpResponseCode Redirect codes.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	API_ENDPOINT_FIELD_NUMBER
static int	AUTH_FAIL_ACTION_FIELD_NUMBER
static int	LOGIN_FIELD_NUMBER
static int	REDIRECT_HTTP_RESPONSE_CODE_FIELD_NUMBER
static int	SCRIPT_FIELD_NUMBER
static int	SECURITY_LEVEL_FIELD_NUMBER
static int	STATIC_FILES_FIELD_NUMBER
static int	URL_REGEX_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
ApiEndpointHandler	getApiEndpoint() Uses API Endpoints to handle requests.
ApiEndpointHandlerOrBuilder	getApiEndpointOrBuilder() Uses API Endpoints to handle requests.
AuthFailAction	getAuthFailAction() Action to take when users access resources that require authentication.
int	getAuthFailActionValue() Action to take when users access resources that require authentication.
static UrlMap	getDefaultInstance()
UrlMap	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
UrlMap.HandlerTypeCase	getHandlerTypeCase()
LoginRequirement	getLogin() Level of login required to access this resource.
int	getLoginValue() Level of login required to access this resource.
Parser<UrlMap>	getParserForType()
UrlMap.RedirectHttpResponseCode	getRedirectHttpResponseCode() `30x` code to use when performing redirects for the `secure` field.
int	getRedirectHttpResponseCodeValue() `30x` code to use when performing redirects for the `secure` field.
ScriptHandler	getScript() Executes a script to handle the request that matches this URL pattern.
ScriptHandlerOrBuilder	getScriptOrBuilder() Executes a script to handle the request that matches this URL pattern.
SecurityLevel	getSecurityLevel() Security (HTTPS) enforcement for this URL.
int	getSecurityLevelValue() Security (HTTPS) enforcement for this URL.
int	getSerializedSize()
StaticFilesHandler	getStaticFiles() Returns the contents of a file, such as an image, as the response.
StaticFilesHandlerOrBuilder	getStaticFilesOrBuilder() Returns the contents of a file, such as an image, as the response.
UnknownFieldSet	getUnknownFields()
java.lang.String	getUrlRegex() URL prefix.
ByteString	getUrlRegexBytes() URL prefix.
boolean	hasApiEndpoint() Uses API Endpoints to handle requests.
int	hashCode()
boolean	hasScript() Executes a script to handle the request that matches this URL pattern.
boolean	hasStaticFiles() Returns the contents of a file, such as an image, as the response.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static UrlMap.Builder	newBuilder()
static UrlMap.Builder	newBuilder(UrlMap prototype)
UrlMap.Builder	newBuilderForType()
protected UrlMap.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
static UrlMap	parseDelimitedFrom(java.io.InputStream input)
static UrlMap	parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static UrlMap	parseFrom(byte[] data)
static UrlMap	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static UrlMap	parseFrom(java.nio.ByteBuffer data)
static UrlMap	parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static UrlMap	parseFrom(ByteString data)
static UrlMap	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static UrlMap	parseFrom(CodedInputStream input)
static UrlMap	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static UrlMap	parseFrom(java.io.InputStream input)
static UrlMap	parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<UrlMap>	parser()
UrlMap.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

URL_REGEX_FIELD_NUMBER

public static final int URL_REGEX_FIELD_NUMBER

See Also:

Constant Field Values

STATIC_FILES_FIELD_NUMBER

public static final int STATIC_FILES_FIELD_NUMBER

See Also:

Constant Field Values

SCRIPT_FIELD_NUMBER

public static final int SCRIPT_FIELD_NUMBER

See Also:

Constant Field Values

API_ENDPOINT_FIELD_NUMBER

public static final int API_ENDPOINT_FIELD_NUMBER

See Also:

Constant Field Values

SECURITY_LEVEL_FIELD_NUMBER

public static final int SECURITY_LEVEL_FIELD_NUMBER

See Also:

Constant Field Values

LOGIN_FIELD_NUMBER

public static final int LOGIN_FIELD_NUMBER

See Also:

Constant Field Values

AUTH_FAIL_ACTION_FIELD_NUMBER

public static final int AUTH_FAIL_ACTION_FIELD_NUMBER

See Also:

Constant Field Values

REDIRECT_HTTP_RESPONSE_CODE_FIELD_NUMBER

public static final int REDIRECT_HTTP_RESPONSE_CODE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getHandlerTypeCase

public UrlMap.HandlerTypeCase getHandlerTypeCase()

Specified by:

getHandlerTypeCase in interface UrlMapOrBuilder

getUrlRegex

public java.lang.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;

Specified by:

getUrlRegex in interface UrlMapOrBuilder

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;

Specified by:

getUrlRegexBytes in interface UrlMapOrBuilder

hasStaticFiles

public boolean hasStaticFiles()

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

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

Specified by:

hasStaticFiles in interface UrlMapOrBuilder

getStaticFiles

public StaticFilesHandler getStaticFiles()

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

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

Specified by:

getStaticFiles in interface UrlMapOrBuilder

getStaticFilesOrBuilder

public StaticFilesHandlerOrBuilder getStaticFilesOrBuilder()

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

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

Specified by:

getStaticFilesOrBuilder in interface UrlMapOrBuilder

hasScript

public boolean hasScript()

 Executes a script to handle the request that matches this URL
 pattern.
 

.google.appengine.v1.ScriptHandler script = 3;

Specified by:

hasScript in interface UrlMapOrBuilder

getScript

public ScriptHandler getScript()

 Executes a script to handle the request that matches this URL
 pattern.
 

.google.appengine.v1.ScriptHandler script = 3;

Specified by:

getScript in interface UrlMapOrBuilder

getScriptOrBuilder

public ScriptHandlerOrBuilder getScriptOrBuilder()

 Executes a script to handle the request that matches this URL
 pattern.
 

.google.appengine.v1.ScriptHandler script = 3;

Specified by:

getScriptOrBuilder in interface UrlMapOrBuilder

hasApiEndpoint

public boolean hasApiEndpoint()

 Uses API Endpoints to handle requests.
 

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

Specified by:

hasApiEndpoint in interface UrlMapOrBuilder

getApiEndpoint

public ApiEndpointHandler getApiEndpoint()

 Uses API Endpoints to handle requests.
 

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

Specified by:

getApiEndpoint in interface UrlMapOrBuilder

getApiEndpointOrBuilder

public ApiEndpointHandlerOrBuilder getApiEndpointOrBuilder()

 Uses API Endpoints to handle requests.
 

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

Specified by:

getApiEndpointOrBuilder in interface UrlMapOrBuilder

getSecurityLevelValue

public int getSecurityLevelValue()

 Security (HTTPS) enforcement for this URL.
 

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

Specified by:

getSecurityLevelValue in interface UrlMapOrBuilder

getSecurityLevel

public SecurityLevel getSecurityLevel()

 Security (HTTPS) enforcement for this URL.
 

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

Specified by:

getSecurityLevel in interface UrlMapOrBuilder

getLoginValue

public int getLoginValue()

 Level of login required to access this resource.
 

.google.appengine.v1.LoginRequirement login = 6;

Specified by:

getLoginValue in interface UrlMapOrBuilder

getLogin

public LoginRequirement getLogin()

 Level of login required to access this resource.
 

.google.appengine.v1.LoginRequirement login = 6;

Specified by:

getLogin in interface UrlMapOrBuilder

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;

Specified by:

getAuthFailActionValue in interface UrlMapOrBuilder

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;

Specified by:

getAuthFailAction in interface UrlMapOrBuilder

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;

Specified by:

getRedirectHttpResponseCodeValue in interface UrlMapOrBuilder

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;

Specified by:

getRedirectHttpResponseCode in interface UrlMapOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static UrlMap parseFrom(java.nio.ByteBuffer data)
                        throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static UrlMap parseFrom(java.nio.ByteBuffer data,
                               ExtensionRegistryLite extensionRegistry)
                        throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static UrlMap parseFrom(ByteString data)
                        throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static UrlMap parseFrom(ByteString data,
                               ExtensionRegistryLite extensionRegistry)
                        throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static UrlMap parseFrom(byte[] data)
                        throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

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

Throws:

InvalidProtocolBufferException

parseFrom

public static UrlMap parseFrom(java.io.InputStream input)
                        throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static UrlMap parseFrom(java.io.InputStream input,
                               ExtensionRegistryLite extensionRegistry)
                        throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static UrlMap parseDelimitedFrom(java.io.InputStream input)
                                 throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static UrlMap parseDelimitedFrom(java.io.InputStream input,
                                        ExtensionRegistryLite extensionRegistry)
                                 throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static UrlMap parseFrom(CodedInputStream input)
                        throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static UrlMap parseFrom(CodedInputStream input,
                               ExtensionRegistryLite extensionRegistry)
                        throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public UrlMap.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static UrlMap.Builder newBuilder()

newBuilder

public static UrlMap.Builder newBuilder(UrlMap prototype)

toBuilder

public UrlMap.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected UrlMap.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static UrlMap getDefaultInstance()

parser

public static Parser<UrlMap> parser()

getParserForType

public Parser<UrlMap> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public UrlMap getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder