Package com.google.appengine.v1

Class UrlMap.Builder

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

    • Method Detail

      • 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.Builder<UrlMap.Builder>

      • clear

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

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<UrlMap.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

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

      • setField

        public UrlMap.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                               Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<UrlMap.Builder>

      • clearField

        public UrlMap.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<UrlMap.Builder>

      • clearOneof

        public UrlMap.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<UrlMap.Builder>

      • setRepeatedField

        public UrlMap.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                       int index,
                                       Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<UrlMap.Builder>

      • addRepeatedField

        public UrlMap.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                       Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<UrlMap.Builder>

      • mergeFrom

        public UrlMap.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<UrlMap.Builder>

      • isInitialized

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

      • mergeFrom

        public UrlMap.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<UrlMap.Builder>
        Throws:
        IOException

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

      • setUrlRegex

        public UrlMap.Builder setUrlRegex​(String value)
         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;
        Parameters:
        value - The urlRegex to set.
        Returns:
        This builder for chaining.

      • clearUrlRegex

        public UrlMap.Builder clearUrlRegex()
         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:
        This builder for chaining.

      • setUrlRegexBytes

        public UrlMap.Builder setUrlRegexBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for urlRegex to set.
        Returns:
        This builder for chaining.

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

      • setStaticFiles

        public UrlMap.Builder setStaticFiles​(StaticFilesHandler value)
         Returns the contents of a file, such as an image, as the response.
        .google.appengine.v1.StaticFilesHandler static_files = 2;

      • setStaticFiles

        public UrlMap.Builder setStaticFiles​(StaticFilesHandler.Builder builderForValue)
         Returns the contents of a file, such as an image, as the response.
        .google.appengine.v1.StaticFilesHandler static_files = 2;

      • mergeStaticFiles

        public UrlMap.Builder mergeStaticFiles​(StaticFilesHandler value)
         Returns the contents of a file, such as an image, as the response.
        .google.appengine.v1.StaticFilesHandler static_files = 2;

      • clearStaticFiles

        public UrlMap.Builder clearStaticFiles()
         Returns the contents of a file, such as an image, as the response.
        .google.appengine.v1.StaticFilesHandler static_files = 2;

      • getStaticFilesBuilder

        public StaticFilesHandler.Builder getStaticFilesBuilder()
         Returns the contents of a file, such as an image, as the response.
        .google.appengine.v1.StaticFilesHandler static_files = 2;

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

      • setScript

        public UrlMap.Builder setScript​(ScriptHandler value)
         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;

      • setScript

        public UrlMap.Builder setScript​(ScriptHandler.Builder builderForValue)
         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;

      • mergeScript

        public UrlMap.Builder mergeScript​(ScriptHandler value)
         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;

      • clearScript

        public UrlMap.Builder clearScript()
         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;

      • getScriptBuilder

        public ScriptHandler.Builder getScriptBuilder()
         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;

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

      • setApiEndpoint

        public UrlMap.Builder setApiEndpoint​(ApiEndpointHandler value)
         Uses API Endpoints to handle requests.
        .google.appengine.v1.ApiEndpointHandler api_endpoint = 4;

      • setApiEndpoint

        public UrlMap.Builder setApiEndpoint​(ApiEndpointHandler.Builder builderForValue)
         Uses API Endpoints to handle requests.
        .google.appengine.v1.ApiEndpointHandler api_endpoint = 4;

      • mergeApiEndpoint

        public UrlMap.Builder mergeApiEndpoint​(ApiEndpointHandler value)
         Uses API Endpoints to handle requests.
        .google.appengine.v1.ApiEndpointHandler api_endpoint = 4;

      • clearApiEndpoint

        public UrlMap.Builder clearApiEndpoint()
         Uses API Endpoints to handle requests.
        .google.appengine.v1.ApiEndpointHandler api_endpoint = 4;

      • getApiEndpointBuilder

        public ApiEndpointHandler.Builder getApiEndpointBuilder()
         Uses API Endpoints to handle requests.
        .google.appengine.v1.ApiEndpointHandler api_endpoint = 4;

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

      • setSecurityLevelValue

        public UrlMap.Builder setSecurityLevelValue​(int value)
         Security (HTTPS) enforcement for this URL.
        .google.appengine.v1.SecurityLevel security_level = 5;
        Parameters:
        value - The enum numeric value on the wire for securityLevel to set.
        Returns:
        This builder for chaining.

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

      • setSecurityLevel

        public UrlMap.Builder setSecurityLevel​(SecurityLevel value)
         Security (HTTPS) enforcement for this URL.
        .google.appengine.v1.SecurityLevel security_level = 5;
        Parameters:
        value - The securityLevel to set.
        Returns:
        This builder for chaining.

      • clearSecurityLevel

        public UrlMap.Builder clearSecurityLevel()
         Security (HTTPS) enforcement for this URL.
        .google.appengine.v1.SecurityLevel security_level = 5;
        Returns:
        This builder for chaining.

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

      • setLoginValue

        public UrlMap.Builder setLoginValue​(int value)
         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;
        Parameters:
        value - The enum numeric value on the wire for login to set.
        Returns:
        This builder for chaining.

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

      • setLogin

        public UrlMap.Builder setLogin​(LoginRequirement value)
         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;
        Parameters:
        value - The login to set.
        Returns:
        This builder for chaining.

      • clearLogin

        public UrlMap.Builder clearLogin()
         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:
        This builder for chaining.

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

      • setAuthFailActionValue

        public UrlMap.Builder setAuthFailActionValue​(int value)
         Action to take when users access resources that require
 authentication. Defaults to `redirect`.
        .google.appengine.v1.AuthFailAction auth_fail_action = 7;
        Parameters:
        value - The enum numeric value on the wire for authFailAction to set.
        Returns:
        This builder for chaining.

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

      • setAuthFailAction

        public UrlMap.Builder setAuthFailAction​(AuthFailAction value)
         Action to take when users access resources that require
 authentication. Defaults to `redirect`.
        .google.appengine.v1.AuthFailAction auth_fail_action = 7;
        Parameters:
        value - The authFailAction to set.
        Returns:
        This builder for chaining.

      • clearAuthFailAction

        public UrlMap.Builder clearAuthFailAction()
         Action to take when users access resources that require
 authentication. Defaults to `redirect`.
        .google.appengine.v1.AuthFailAction auth_fail_action = 7;
        Returns:
        This builder for chaining.

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

      • setRedirectHttpResponseCodeValue

        public UrlMap.Builder setRedirectHttpResponseCodeValue​(int value)
         `30x` code to use when performing redirects for the `secure` field.
 Defaults to `302`.
        .google.appengine.v1.UrlMap.RedirectHttpResponseCode redirect_http_response_code = 8;
        Parameters:
        value - The enum numeric value on the wire for redirectHttpResponseCode to set.
        Returns:
        This builder for chaining.

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

      • setRedirectHttpResponseCode

        public UrlMap.Builder setRedirectHttpResponseCode​(UrlMap.RedirectHttpResponseCode value)
         `30x` code to use when performing redirects for the `secure` field.
 Defaults to `302`.
        .google.appengine.v1.UrlMap.RedirectHttpResponseCode redirect_http_response_code = 8;
        Parameters:
        value - The redirectHttpResponseCode to set.
        Returns:
        This builder for chaining.

      • clearRedirectHttpResponseCode

        public UrlMap.Builder clearRedirectHttpResponseCode()
         `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:
        This builder for chaining.

      • setUnknownFields

        public final UrlMap.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<UrlMap.Builder>

      • mergeUnknownFields

        public final UrlMap.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<UrlMap.Builder>