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
Modifier and Type | Method and Description |
---|---|
UrlMap.Builder |
addRepeatedField(Descriptors.FieldDescriptor field,
java.lang.Object value) |
UrlMap |
build() |
UrlMap |
buildPartial() |
UrlMap.Builder |
clear() |
UrlMap.Builder |
clearApiEndpoint()
Uses API Endpoints to handle requests.
|
UrlMap.Builder |
clearAuthFailAction()
Action to take when users access resources that require
authentication.
|
UrlMap.Builder |
clearField(Descriptors.FieldDescriptor field) |
UrlMap.Builder |
clearHandlerType() |
UrlMap.Builder |
clearLogin()
Level of login required to access this resource.
|
UrlMap.Builder |
clearOneof(Descriptors.OneofDescriptor oneof) |
UrlMap.Builder |
clearRedirectHttpResponseCode()
`30x` code to use when performing redirects for the `secure` field.
|
UrlMap.Builder |
clearScript()
Executes a script to handle the request that matches this URL
pattern.
|
UrlMap.Builder |
clearSecurityLevel()
Security (HTTPS) enforcement for this URL.
|
UrlMap.Builder |
clearStaticFiles()
Returns the contents of a file, such as an image, as the response.
|
UrlMap.Builder |
clearUrlRegex()
URL prefix.
|
UrlMap.Builder |
clone() |
ApiEndpointHandler |
getApiEndpoint()
Uses API Endpoints to handle requests.
|
ApiEndpointHandler.Builder |
getApiEndpointBuilder()
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.
|
UrlMap |
getDefaultInstanceForType() |
static Descriptors.Descriptor |
getDescriptor() |
Descriptors.Descriptor |
getDescriptorForType() |
UrlMap.HandlerTypeCase |
getHandlerTypeCase() |
LoginRequirement |
getLogin()
Level of login required to access this resource.
|
int |
getLoginValue()
Level of login required to access this resource.
|
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.
|
ScriptHandler.Builder |
getScriptBuilder()
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.
|
StaticFilesHandler |
getStaticFiles()
Returns the contents of a file, such as an image, as the response.
|
StaticFilesHandler.Builder |
getStaticFilesBuilder()
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.
|
java.lang.String |
getUrlRegex()
URL prefix.
|
ByteString |
getUrlRegexBytes()
URL prefix.
|
boolean |
hasApiEndpoint()
Uses API Endpoints to handle requests.
|
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() |
UrlMap.Builder |
mergeApiEndpoint(ApiEndpointHandler value)
Uses API Endpoints to handle requests.
|
UrlMap.Builder |
mergeFrom(CodedInputStream input,
ExtensionRegistryLite extensionRegistry) |
UrlMap.Builder |
mergeFrom(Message other) |
UrlMap.Builder |
mergeFrom(UrlMap other) |
UrlMap.Builder |
mergeScript(ScriptHandler value)
Executes a script to handle the request that matches this URL
pattern.
|
UrlMap.Builder |
mergeStaticFiles(StaticFilesHandler value)
Returns the contents of a file, such as an image, as the response.
|
UrlMap.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields) |
UrlMap.Builder |
setApiEndpoint(ApiEndpointHandler.Builder builderForValue)
Uses API Endpoints to handle requests.
|
UrlMap.Builder |
setApiEndpoint(ApiEndpointHandler value)
Uses API Endpoints to handle requests.
|
UrlMap.Builder |
setAuthFailAction(AuthFailAction value)
Action to take when users access resources that require
authentication.
|
UrlMap.Builder |
setAuthFailActionValue(int value)
Action to take when users access resources that require
authentication.
|
UrlMap.Builder |
setField(Descriptors.FieldDescriptor field,
java.lang.Object value) |
UrlMap.Builder |
setLogin(LoginRequirement value)
Level of login required to access this resource.
|
UrlMap.Builder |
setLoginValue(int value)
Level of login required to access this resource.
|
UrlMap.Builder |
setRedirectHttpResponseCode(UrlMap.RedirectHttpResponseCode value)
`30x` code to use when performing redirects for the `secure` field.
|
UrlMap.Builder |
setRedirectHttpResponseCodeValue(int value)
`30x` code to use when performing redirects for the `secure` field.
|
UrlMap.Builder |
setRepeatedField(Descriptors.FieldDescriptor field,
int index,
java.lang.Object value) |
UrlMap.Builder |
setScript(ScriptHandler.Builder builderForValue)
Executes a script to handle the request that matches this URL
pattern.
|
UrlMap.Builder |
setScript(ScriptHandler value)
Executes a script to handle the request that matches this URL
pattern.
|
UrlMap.Builder |
setSecurityLevel(SecurityLevel value)
Security (HTTPS) enforcement for this URL.
|
UrlMap.Builder |
setSecurityLevelValue(int value)
Security (HTTPS) enforcement for this URL.
|
UrlMap.Builder |
setStaticFiles(StaticFilesHandler.Builder builderForValue)
Returns the contents of a file, such as an image, as the response.
|
UrlMap.Builder |
setStaticFiles(StaticFilesHandler value)
Returns the contents of a file, such as an image, as the response.
|
UrlMap.Builder |
setUnknownFields(UnknownFieldSet unknownFields) |
UrlMap.Builder |
setUrlRegex(java.lang.String value)
URL prefix.
|
UrlMap.Builder |
setUrlRegexBytes(ByteString value)
URL prefix.
|
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
addAll, addAll, mergeFrom, newUninitializedMessageException
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
mergeFrom
public static final Descriptors.Descriptor getDescriptor()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class GeneratedMessageV3.Builder<UrlMap.Builder>
public UrlMap.Builder clear()
clear
in interface Message.Builder
clear
in interface MessageLite.Builder
clear
in class GeneratedMessageV3.Builder<UrlMap.Builder>
public Descriptors.Descriptor getDescriptorForType()
getDescriptorForType
in interface Message.Builder
getDescriptorForType
in interface MessageOrBuilder
getDescriptorForType
in class GeneratedMessageV3.Builder<UrlMap.Builder>
public UrlMap getDefaultInstanceForType()
getDefaultInstanceForType
in interface MessageLiteOrBuilder
getDefaultInstanceForType
in interface MessageOrBuilder
public UrlMap build()
build
in interface Message.Builder
build
in interface MessageLite.Builder
public UrlMap buildPartial()
buildPartial
in interface Message.Builder
buildPartial
in interface MessageLite.Builder
public UrlMap.Builder clone()
clone
in interface Message.Builder
clone
in interface MessageLite.Builder
clone
in class GeneratedMessageV3.Builder<UrlMap.Builder>
public UrlMap.Builder setField(Descriptors.FieldDescriptor field, java.lang.Object value)
setField
in interface Message.Builder
setField
in class GeneratedMessageV3.Builder<UrlMap.Builder>
public UrlMap.Builder clearField(Descriptors.FieldDescriptor field)
clearField
in interface Message.Builder
clearField
in class GeneratedMessageV3.Builder<UrlMap.Builder>
public UrlMap.Builder clearOneof(Descriptors.OneofDescriptor oneof)
clearOneof
in interface Message.Builder
clearOneof
in class GeneratedMessageV3.Builder<UrlMap.Builder>
public UrlMap.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)
setRepeatedField
in interface Message.Builder
setRepeatedField
in class GeneratedMessageV3.Builder<UrlMap.Builder>
public UrlMap.Builder addRepeatedField(Descriptors.FieldDescriptor field, java.lang.Object value)
addRepeatedField
in interface Message.Builder
addRepeatedField
in class GeneratedMessageV3.Builder<UrlMap.Builder>
public UrlMap.Builder mergeFrom(Message other)
mergeFrom
in interface Message.Builder
mergeFrom
in class AbstractMessage.Builder<UrlMap.Builder>
public UrlMap.Builder mergeFrom(UrlMap other)
public final boolean isInitialized()
isInitialized
in interface MessageLiteOrBuilder
isInitialized
in class GeneratedMessageV3.Builder<UrlMap.Builder>
public UrlMap.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
mergeFrom
in interface Message.Builder
mergeFrom
in interface MessageLite.Builder
mergeFrom
in class AbstractMessage.Builder<UrlMap.Builder>
java.io.IOException
public UrlMap.HandlerTypeCase getHandlerTypeCase()
getHandlerTypeCase
in interface UrlMapOrBuilder
public UrlMap.Builder clearHandlerType()
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;
getUrlRegex
in interface UrlMapOrBuilder
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;
getUrlRegexBytes
in interface UrlMapOrBuilder
public UrlMap.Builder setUrlRegex(java.lang.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;
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;
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;
public boolean hasStaticFiles()
Returns the contents of a file, such as an image, as the response.
.google.appengine.v1.StaticFilesHandler static_files = 2;
hasStaticFiles
in interface UrlMapOrBuilder
public StaticFilesHandler getStaticFiles()
Returns the contents of a file, such as an image, as the response.
.google.appengine.v1.StaticFilesHandler static_files = 2;
getStaticFiles
in interface UrlMapOrBuilder
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;
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;
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;
public UrlMap.Builder clearStaticFiles()
Returns the contents of a file, such as an image, as the response.
.google.appengine.v1.StaticFilesHandler static_files = 2;
public StaticFilesHandler.Builder getStaticFilesBuilder()
Returns the contents of a file, such as an image, as the response.
.google.appengine.v1.StaticFilesHandler static_files = 2;
public StaticFilesHandlerOrBuilder getStaticFilesOrBuilder()
Returns the contents of a file, such as an image, as the response.
.google.appengine.v1.StaticFilesHandler static_files = 2;
getStaticFilesOrBuilder
in interface UrlMapOrBuilder
public boolean hasScript()
Executes a script to handle the request that matches this URL pattern.
.google.appengine.v1.ScriptHandler script = 3;
hasScript
in interface UrlMapOrBuilder
public ScriptHandler getScript()
Executes a script to handle the request that matches this URL pattern.
.google.appengine.v1.ScriptHandler script = 3;
getScript
in interface UrlMapOrBuilder
public UrlMap.Builder setScript(ScriptHandler value)
Executes a script to handle the request that matches this URL pattern.
.google.appengine.v1.ScriptHandler script = 3;
public UrlMap.Builder setScript(ScriptHandler.Builder builderForValue)
Executes a script to handle the request that matches this URL pattern.
.google.appengine.v1.ScriptHandler script = 3;
public UrlMap.Builder mergeScript(ScriptHandler value)
Executes a script to handle the request that matches this URL pattern.
.google.appengine.v1.ScriptHandler script = 3;
public UrlMap.Builder clearScript()
Executes a script to handle the request that matches this URL pattern.
.google.appengine.v1.ScriptHandler script = 3;
public ScriptHandler.Builder getScriptBuilder()
Executes a script to handle the request that matches this URL pattern.
.google.appengine.v1.ScriptHandler script = 3;
public ScriptHandlerOrBuilder getScriptOrBuilder()
Executes a script to handle the request that matches this URL pattern.
.google.appengine.v1.ScriptHandler script = 3;
getScriptOrBuilder
in interface UrlMapOrBuilder
public boolean hasApiEndpoint()
Uses API Endpoints to handle requests.
.google.appengine.v1.ApiEndpointHandler api_endpoint = 4;
hasApiEndpoint
in interface UrlMapOrBuilder
public ApiEndpointHandler getApiEndpoint()
Uses API Endpoints to handle requests.
.google.appengine.v1.ApiEndpointHandler api_endpoint = 4;
getApiEndpoint
in interface UrlMapOrBuilder
public UrlMap.Builder setApiEndpoint(ApiEndpointHandler value)
Uses API Endpoints to handle requests.
.google.appengine.v1.ApiEndpointHandler api_endpoint = 4;
public UrlMap.Builder setApiEndpoint(ApiEndpointHandler.Builder builderForValue)
Uses API Endpoints to handle requests.
.google.appengine.v1.ApiEndpointHandler api_endpoint = 4;
public UrlMap.Builder mergeApiEndpoint(ApiEndpointHandler value)
Uses API Endpoints to handle requests.
.google.appengine.v1.ApiEndpointHandler api_endpoint = 4;
public UrlMap.Builder clearApiEndpoint()
Uses API Endpoints to handle requests.
.google.appengine.v1.ApiEndpointHandler api_endpoint = 4;
public ApiEndpointHandler.Builder getApiEndpointBuilder()
Uses API Endpoints to handle requests.
.google.appengine.v1.ApiEndpointHandler api_endpoint = 4;
public ApiEndpointHandlerOrBuilder getApiEndpointOrBuilder()
Uses API Endpoints to handle requests.
.google.appengine.v1.ApiEndpointHandler api_endpoint = 4;
getApiEndpointOrBuilder
in interface UrlMapOrBuilder
public int getSecurityLevelValue()
Security (HTTPS) enforcement for this URL.
.google.appengine.v1.SecurityLevel security_level = 5;
getSecurityLevelValue
in interface UrlMapOrBuilder
public UrlMap.Builder setSecurityLevelValue(int value)
Security (HTTPS) enforcement for this URL.
.google.appengine.v1.SecurityLevel security_level = 5;
public SecurityLevel getSecurityLevel()
Security (HTTPS) enforcement for this URL.
.google.appengine.v1.SecurityLevel security_level = 5;
getSecurityLevel
in interface UrlMapOrBuilder
public UrlMap.Builder setSecurityLevel(SecurityLevel value)
Security (HTTPS) enforcement for this URL.
.google.appengine.v1.SecurityLevel security_level = 5;
public UrlMap.Builder clearSecurityLevel()
Security (HTTPS) enforcement for this URL.
.google.appengine.v1.SecurityLevel security_level = 5;
public int getLoginValue()
Level of login required to access this resource.
.google.appengine.v1.LoginRequirement login = 6;
getLoginValue
in interface UrlMapOrBuilder
public UrlMap.Builder setLoginValue(int value)
Level of login required to access this resource.
.google.appengine.v1.LoginRequirement login = 6;
public LoginRequirement getLogin()
Level of login required to access this resource.
.google.appengine.v1.LoginRequirement login = 6;
getLogin
in interface UrlMapOrBuilder
public UrlMap.Builder setLogin(LoginRequirement value)
Level of login required to access this resource.
.google.appengine.v1.LoginRequirement login = 6;
public UrlMap.Builder clearLogin()
Level of login required to access this resource.
.google.appengine.v1.LoginRequirement login = 6;
public int getAuthFailActionValue()
Action to take when users access resources that require authentication. Defaults to `redirect`.
.google.appengine.v1.AuthFailAction auth_fail_action = 7;
getAuthFailActionValue
in interface UrlMapOrBuilder
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;
public AuthFailAction getAuthFailAction()
Action to take when users access resources that require authentication. Defaults to `redirect`.
.google.appengine.v1.AuthFailAction auth_fail_action = 7;
getAuthFailAction
in interface UrlMapOrBuilder
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;
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;
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;
getRedirectHttpResponseCodeValue
in interface UrlMapOrBuilder
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;
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;
getRedirectHttpResponseCode
in interface UrlMapOrBuilder
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;
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;
public final UrlMap.Builder setUnknownFields(UnknownFieldSet unknownFields)
setUnknownFields
in interface Message.Builder
setUnknownFields
in class GeneratedMessageV3.Builder<UrlMap.Builder>
public final UrlMap.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
mergeUnknownFields
in interface Message.Builder
mergeUnknownFields
in class GeneratedMessageV3.Builder<UrlMap.Builder>