Package com.google.appengine.v1

Class UrlMap

  • All Implemented Interfaces:
    UrlMapOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class UrlMap
extends com.google.protobuf.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

    • Field Detail

      • STATIC_FILES_FIELD_NUMBER

        public static final int STATIC_FILES_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

      • 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

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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;
        Specified by:
        getUrlRegex in interface UrlMapOrBuilder
        Returns:
        The urlRegex.

      • getUrlRegexBytes

        public com.google.protobuf.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
        Returns:
        The bytes for urlRegex.

      • 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
        Returns:
        Whether the staticFiles field is set.

      • 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
        Returns:
        The staticFiles.

      • 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;
        Specified by:
        hasScript in interface UrlMapOrBuilder
        Returns:
        Whether the script field is set.

      • 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;
        Specified by:
        getScript in interface UrlMapOrBuilder
        Returns:
        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;
        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
        Returns:
        Whether the apiEndpoint field is set.

      • getApiEndpoint

        public ApiEndpointHandler getApiEndpoint()
         Uses API Endpoints to handle requests.
        .google.appengine.v1.ApiEndpointHandler api_endpoint = 4;
        Specified by:
        getApiEndpoint in interface UrlMapOrBuilder
        Returns:
        The apiEndpoint.

      • getSecurityLevelValue

        public int getSecurityLevelValue()
         Security (HTTPS) enforcement for this URL.
        .google.appengine.v1.SecurityLevel security_level = 5;
        Specified by:
        getSecurityLevelValue in interface UrlMapOrBuilder
        Returns:
        The enum numeric value on the wire for securityLevel.

      • getSecurityLevel

        public SecurityLevel getSecurityLevel()
         Security (HTTPS) enforcement for this URL.
        .google.appengine.v1.SecurityLevel security_level = 5;
        Specified by:
        getSecurityLevel in interface UrlMapOrBuilder
        Returns:
        The securityLevel.

      • 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;
        Specified by:
        getLoginValue in interface UrlMapOrBuilder
        Returns:
        The enum numeric value on the wire for login.

      • 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;
        Specified by:
        getLogin in interface UrlMapOrBuilder
        Returns:
        The login.

      • 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
        Returns:
        The enum numeric value on the wire for authFailAction.

      • 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
        Returns:
        The authFailAction.

      • 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
        Returns:
        The enum numeric value on the wire for redirectHttpResponseCode.

      • 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
        Returns:
        The redirectHttpResponseCode.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static UrlMap parseFrom​(ByteBuffer data)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static UrlMap parseFrom​(ByteBuffer data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static UrlMap parseFrom​(com.google.protobuf.ByteString data)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static UrlMap parseFrom​(com.google.protobuf.ByteString data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static UrlMap parseFrom​(byte[] data)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static UrlMap parseFrom​(byte[] data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static UrlMap parseFrom​(com.google.protobuf.CodedInputStream input,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws IOException
        Throws:
        IOException

      • newBuilderForType

        public UrlMap.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public UrlMap.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected UrlMap.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static UrlMap getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<UrlMap> parser()

      • getParserForType

        public com.google.protobuf.Parser<UrlMap> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public UrlMap getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder