Class ApiConfigHandler.Builder (2.23.0)

publicstaticfinalclass ApiConfigHandler.BuilderextendsGeneratedMessageV3.Builder<ApiConfigHandler.Builder>implementsApiConfigHandlerOrBuilder

Google Cloud Endpoints configuration for API handlers.

Protobuf type google.appengine.v1.ApiConfigHandler

Inherited Members

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

Static Methods

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

publicApiConfigHandler.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ApiConfigHandler.Builder
Overrides

build()

publicApiConfigHandlerbuild()
Returns
Type Description
ApiConfigHandler

buildPartial()

publicApiConfigHandlerbuildPartial()
Returns
Type Description
ApiConfigHandler

clear()

publicApiConfigHandler.Builderclear()
Returns
Type Description
ApiConfigHandler.Builder
Overrides

clearAuthFailAction()

publicApiConfigHandler.BuilderclearAuthFailAction()

Action to take when users access resources that require authentication. Defaults to redirect.

.google.appengine.v1.AuthFailAction auth_fail_action = 1;

Returns
Type Description
ApiConfigHandler.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

publicApiConfigHandler.BuilderclearField(Descriptors.FieldDescriptorfield)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ApiConfigHandler.Builder
Overrides

clearLogin()

publicApiConfigHandler.BuilderclearLogin()

Level of login required to access this resource. Defaults to optional.

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

Returns
Type Description
ApiConfigHandler.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

publicApiConfigHandler.BuilderclearOneof(Descriptors.OneofDescriptoroneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ApiConfigHandler.Builder
Overrides

clearScript()

publicApiConfigHandler.BuilderclearScript()

Path to the script from the application root directory.

string script = 3;

Returns
Type Description
ApiConfigHandler.Builder

This builder for chaining.

clearSecurityLevel()

publicApiConfigHandler.BuilderclearSecurityLevel()

Security (HTTPS) enforcement for this URL.

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

Returns
Type Description
ApiConfigHandler.Builder

This builder for chaining.

clearUrl()

publicApiConfigHandler.BuilderclearUrl()

URL to serve the endpoint at.

string url = 5;

Returns
Type Description
ApiConfigHandler.Builder

This builder for chaining.

clone()

publicApiConfigHandler.Builderclone()
Returns
Type Description
ApiConfigHandler.Builder
Overrides

getAuthFailAction()

publicAuthFailActiongetAuthFailAction()

Action to take when users access resources that require authentication. Defaults to redirect.

.google.appengine.v1.AuthFailAction auth_fail_action = 1;

Returns
Type Description
AuthFailAction

The authFailAction.

getAuthFailActionValue()

publicintgetAuthFailActionValue()

Action to take when users access resources that require authentication. Defaults to redirect.

.google.appengine.v1.AuthFailAction auth_fail_action = 1;

Returns
Type Description
int

The enum numeric value on the wire for authFailAction.

getDefaultInstanceForType()

publicApiConfigHandlergetDefaultInstanceForType()
Returns
Type Description
ApiConfigHandler

getDescriptorForType()

publicDescriptors.DescriptorgetDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getLogin()

publicLoginRequirementgetLogin()

Level of login required to access this resource. Defaults to optional.

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

Returns
Type Description
LoginRequirement

The login.

getLoginValue()

publicintgetLoginValue()

Level of login required to access this resource. Defaults to optional.

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

Returns
Type Description
int

The enum numeric value on the wire for login.

getScript()

publicStringgetScript()

Path to the script from the application root directory.

string script = 3;

Returns
Type Description
String

The script.

getScriptBytes()

publicByteStringgetScriptBytes()

Path to the script from the application root directory.

string script = 3;

Returns
Type Description
ByteString

The bytes for script.

getSecurityLevel()

publicSecurityLevelgetSecurityLevel()

Security (HTTPS) enforcement for this URL.

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

Returns
Type Description
SecurityLevel

The securityLevel.

getSecurityLevelValue()

publicintgetSecurityLevelValue()

Security (HTTPS) enforcement for this URL.

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

Returns
Type Description
int

The enum numeric value on the wire for securityLevel.

getUrl()

publicStringgetUrl()

URL to serve the endpoint at.

string url = 5;

Returns
Type Description
String

The url.

getUrlBytes()

publicByteStringgetUrlBytes()

URL to serve the endpoint at.

string url = 5;

Returns
Type Description
ByteString

The bytes for url.

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ApiConfigHandler other)

publicApiConfigHandler.BuildermergeFrom(ApiConfigHandlerother)
Parameter
Name Description
other ApiConfigHandler
Returns
Type Description
ApiConfigHandler.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicApiConfigHandler.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ApiConfigHandler.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

publicApiConfigHandler.BuildermergeFrom(Messageother)
Parameter
Name Description
other Message
Returns
Type Description
ApiConfigHandler.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

publicfinalApiConfigHandler.BuildermergeUnknownFields(UnknownFieldSetunknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ApiConfigHandler.Builder
Overrides

setAuthFailAction(AuthFailAction value)

publicApiConfigHandler.BuildersetAuthFailAction(AuthFailActionvalue)

Action to take when users access resources that require authentication. Defaults to redirect.

.google.appengine.v1.AuthFailAction auth_fail_action = 1;

Parameter
Name Description
value AuthFailAction

The authFailAction to set.

Returns
Type Description
ApiConfigHandler.Builder

This builder for chaining.

setAuthFailActionValue(int value)

publicApiConfigHandler.BuildersetAuthFailActionValue(intvalue)

Action to take when users access resources that require authentication. Defaults to redirect.

.google.appengine.v1.AuthFailAction auth_fail_action = 1;

Parameter
Name Description
value int

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

Returns
Type Description
ApiConfigHandler.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

publicApiConfigHandler.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ApiConfigHandler.Builder
Overrides

setLogin(LoginRequirement value)

publicApiConfigHandler.BuildersetLogin(LoginRequirementvalue)

Level of login required to access this resource. Defaults to optional.

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

Parameter
Name Description
value LoginRequirement

The login to set.

Returns
Type Description
ApiConfigHandler.Builder

This builder for chaining.

setLoginValue(int value)

publicApiConfigHandler.BuildersetLoginValue(intvalue)

Level of login required to access this resource. Defaults to optional.

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

Parameter
Name Description
value int

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

Returns
Type Description
ApiConfigHandler.Builder

This builder for chaining.

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

publicApiConfigHandler.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ApiConfigHandler.Builder
Overrides

setScript(String value)

publicApiConfigHandler.BuildersetScript(Stringvalue)

Path to the script from the application root directory.

string script = 3;

Parameter
Name Description
value String

The script to set.

Returns
Type Description
ApiConfigHandler.Builder

This builder for chaining.

setScriptBytes(ByteString value)

publicApiConfigHandler.BuildersetScriptBytes(ByteStringvalue)

Path to the script from the application root directory.

string script = 3;

Parameter
Name Description
value ByteString

The bytes for script to set.

Returns
Type Description
ApiConfigHandler.Builder

This builder for chaining.

setSecurityLevel(SecurityLevel value)

publicApiConfigHandler.BuildersetSecurityLevel(SecurityLevelvalue)

Security (HTTPS) enforcement for this URL.

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

Parameter
Name Description
value SecurityLevel

The securityLevel to set.

Returns
Type Description
ApiConfigHandler.Builder

This builder for chaining.

setSecurityLevelValue(int value)

publicApiConfigHandler.BuildersetSecurityLevelValue(intvalue)

Security (HTTPS) enforcement for this URL.

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

Parameter
Name Description
value int

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

Returns
Type Description
ApiConfigHandler.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

publicfinalApiConfigHandler.BuildersetUnknownFields(UnknownFieldSetunknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ApiConfigHandler.Builder
Overrides

setUrl(String value)

publicApiConfigHandler.BuildersetUrl(Stringvalue)

URL to serve the endpoint at.

string url = 5;

Parameter
Name Description
value String

The url to set.

Returns
Type Description
ApiConfigHandler.Builder

This builder for chaining.

setUrlBytes(ByteString value)

publicApiConfigHandler.BuildersetUrlBytes(ByteStringvalue)

URL to serve the endpoint at.

string url = 5;

Parameter
Name Description
value ByteString

The bytes for url to set.

Returns
Type Description
ApiConfigHandler.Builder

This builder for chaining.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.