Class UrlMap.Builder (2.45.0)

public static final class UrlMap.Builder extends 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

Implements

UrlMapOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public UrlMap.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UrlMap.Builder
Overrides

build()

public UrlMap build()
Returns
Type Description
UrlMap

buildPartial()

public UrlMap buildPartial()
Returns
Type Description
UrlMap

clear()

public UrlMap.Builder clear()
Returns
Type Description
UrlMap.Builder
Overrides

clearApiEndpoint()

public UrlMap.Builder clearApiEndpoint()

Uses API Endpoints to handle requests.

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

Returns
Type Description
UrlMap.Builder

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
Type Description
UrlMap.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public UrlMap.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
UrlMap.Builder
Overrides

clearHandlerType()

public UrlMap.Builder clearHandlerType()
Returns
Type Description
UrlMap.Builder

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
Type Description
UrlMap.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public UrlMap.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
UrlMap.Builder
Overrides

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
Type Description
UrlMap.Builder

This builder for chaining.

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;

Returns
Type Description
UrlMap.Builder

clearSecurityLevel()

public UrlMap.Builder clearSecurityLevel()

Security (HTTPS) enforcement for this URL.

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

Returns
Type Description
UrlMap.Builder

This builder for chaining.

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;

Returns
Type Description
UrlMap.Builder

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
Type Description
UrlMap.Builder

This builder for chaining.

clone()

public UrlMap.Builder clone()
Returns
Type Description
UrlMap.Builder
Overrides

getApiEndpoint()

public ApiEndpointHandler getApiEndpoint()

Uses API Endpoints to handle requests.

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

Returns
Type Description
ApiEndpointHandler

The apiEndpoint.

getApiEndpointBuilder()

public ApiEndpointHandler.Builder getApiEndpointBuilder()

Uses API Endpoints to handle requests.

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

Returns
Type Description
ApiEndpointHandler.Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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.

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;

Returns
Type Description
ScriptHandler.Builder

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.

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.

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;

Returns
Type Description
StaticFilesHandler.Builder

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()

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeApiEndpoint(ApiEndpointHandler value)

public UrlMap.Builder mergeApiEndpoint(ApiEndpointHandler value)

Uses API Endpoints to handle requests.

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

Parameter
Name Description
value ApiEndpointHandler
Returns
Type Description
UrlMap.Builder

mergeFrom(UrlMap other)

public UrlMap.Builder mergeFrom(UrlMap other)
Parameter
Name Description
other UrlMap
Returns
Type Description
UrlMap.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public UrlMap.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UrlMap.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public UrlMap.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
UrlMap.Builder
Overrides

mergeScript(ScriptHandler value)

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;

Parameter
Name Description
value ScriptHandler
Returns
Type Description
UrlMap.Builder

mergeStaticFiles(StaticFilesHandler value)

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;

Parameter
Name Description
value StaticFilesHandler
Returns
Type Description
UrlMap.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final UrlMap.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
UrlMap.Builder
Overrides

setApiEndpoint(ApiEndpointHandler value)

public UrlMap.Builder setApiEndpoint(ApiEndpointHandler value)

Uses API Endpoints to handle requests.

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

Parameter
Name Description
value ApiEndpointHandler
Returns
Type Description
UrlMap.Builder

setApiEndpoint(ApiEndpointHandler.Builder builderForValue)

public UrlMap.Builder setApiEndpoint(ApiEndpointHandler.Builder builderForValue)

Uses API Endpoints to handle requests.

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

Parameter
Name Description
builderForValue ApiEndpointHandler.Builder
Returns
Type Description
UrlMap.Builder

setAuthFailAction(AuthFailAction value)

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;

Parameter
Name Description
value AuthFailAction

The authFailAction to set.

Returns
Type Description
UrlMap.Builder

This builder for chaining.

setAuthFailActionValue(int value)

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;

Parameter
Name Description
value int

The enum numeric value on the wire for authFailAction to set.

Returns
Type Description
UrlMap.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public UrlMap.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UrlMap.Builder
Overrides

setLogin(LoginRequirement value)

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;

Parameter
Name Description
value LoginRequirement

The login to set.

Returns
Type Description
UrlMap.Builder

This builder for chaining.

setLoginValue(int value)

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;

Parameter
Name Description
value int

The enum numeric value on the wire for login to set.

Returns
Type Description
UrlMap.Builder

This builder for chaining.

setRedirectHttpResponseCode(UrlMap.RedirectHttpResponseCode value)

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;

Parameter
Name Description
value UrlMap.RedirectHttpResponseCode

The redirectHttpResponseCode to set.

Returns
Type Description
UrlMap.Builder

This builder for chaining.

setRedirectHttpResponseCodeValue(int value)

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;

Parameter
Name Description
value int

The enum numeric value on the wire for redirectHttpResponseCode to set.

Returns
Type Description
UrlMap.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public UrlMap.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
UrlMap.Builder
Overrides

setScript(ScriptHandler value)

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;

Parameter
Name Description
value ScriptHandler
Returns
Type Description
UrlMap.Builder

setScript(ScriptHandler.Builder builderForValue)

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;

Parameter
Name Description
builderForValue ScriptHandler.Builder
Returns
Type Description
UrlMap.Builder

setSecurityLevel(SecurityLevel value)

public UrlMap.Builder setSecurityLevel(SecurityLevel value)

Security (HTTPS) enforcement for this URL.

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

Parameter
Name Description
value SecurityLevel

The securityLevel to set.

Returns
Type Description
UrlMap.Builder

This builder for chaining.

setSecurityLevelValue(int value)

public UrlMap.Builder setSecurityLevelValue(int value)

Security (HTTPS) enforcement for this URL.

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

Parameter
Name Description
value int

The enum numeric value on the wire for securityLevel to set.

Returns
Type Description
UrlMap.Builder

This builder for chaining.

setStaticFiles(StaticFilesHandler value)

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;

Parameter
Name Description
value StaticFilesHandler
Returns
Type Description
UrlMap.Builder

setStaticFiles(StaticFilesHandler.Builder builderForValue)

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;

Parameter
Name Description
builderForValue StaticFilesHandler.Builder
Returns
Type Description
UrlMap.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final UrlMap.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
UrlMap.Builder
Overrides

setUrlRegex(String value)

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;

Parameter
Name Description
value String

The urlRegex to set.

Returns
Type Description
UrlMap.Builder

This builder for chaining.

setUrlRegexBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for urlRegex to set.

Returns
Type Description
UrlMap.Builder

This builder for chaining.