Class ApiConfigHandler (2.73.0)

publicfinalclass ApiConfigHandlerextendsGeneratedMessageV3implementsApiConfigHandlerOrBuilder

Google Cloud Endpoints configuration for API handlers.

Protobuf type google.appengine.v1.ApiConfigHandler

Inherited Members

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

Static Fields

AUTH_FAIL_ACTION_FIELD_NUMBER

publicstaticfinalintAUTH_FAIL_ACTION_FIELD_NUMBER
Field Value
Type Description
int

LOGIN_FIELD_NUMBER

publicstaticfinalintLOGIN_FIELD_NUMBER
Field Value
Type Description
int

SCRIPT_FIELD_NUMBER

publicstaticfinalintSCRIPT_FIELD_NUMBER
Field Value
Type Description
int

SECURITY_LEVEL_FIELD_NUMBER

publicstaticfinalintSECURITY_LEVEL_FIELD_NUMBER
Field Value
Type Description
int

URL_FIELD_NUMBER

publicstaticfinalintURL_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

publicstaticApiConfigHandlergetDefaultInstance()
Returns
Type Description
ApiConfigHandler

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

newBuilder()

publicstaticApiConfigHandler.BuildernewBuilder()
Returns
Type Description
ApiConfigHandler.Builder

newBuilder(ApiConfigHandler prototype)

publicstaticApiConfigHandler.BuildernewBuilder(ApiConfigHandlerprototype)
Parameter
Name Description
prototype ApiConfigHandler
Returns
Type Description
ApiConfigHandler.Builder

parseDelimitedFrom(InputStream input)

publicstaticApiConfigHandlerparseDelimitedFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
ApiConfigHandler
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticApiConfigHandlerparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ApiConfigHandler
Exceptions
Type Description
IOException

parseFrom(byte[] data)

publicstaticApiConfigHandlerparseFrom(byte[]data)
Parameter
Name Description
data byte[]
Returns
Type Description
ApiConfigHandler
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticApiConfigHandlerparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ApiConfigHandler
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticApiConfigHandlerparseFrom(ByteStringdata)
Parameter
Name Description
data ByteString
Returns
Type Description
ApiConfigHandler
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticApiConfigHandlerparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ApiConfigHandler
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticApiConfigHandlerparseFrom(CodedInputStreaminput)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ApiConfigHandler
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticApiConfigHandlerparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ApiConfigHandler
Exceptions
Type Description
IOException

parseFrom(InputStream input)

publicstaticApiConfigHandlerparseFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
ApiConfigHandler
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticApiConfigHandlerparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ApiConfigHandler
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

publicstaticApiConfigHandlerparseFrom(ByteBufferdata)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ApiConfigHandler
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticApiConfigHandlerparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ApiConfigHandler
Exceptions
Type Description
InvalidProtocolBufferException

parser()

publicstaticParser<ApiConfigHandler>parser()
Returns
Type Description
Parser<ApiConfigHandler>

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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

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.

getParserForType()

publicParser<ApiConfigHandler>getParserForType()
Returns
Type Description
Parser<ApiConfigHandler>
Overrides

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.

getSerializedSize()

publicintgetSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

publicinthashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

publicApiConfigHandler.BuildernewBuilderForType()
Returns
Type Description
ApiConfigHandler.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedApiConfigHandler.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ApiConfigHandler.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

publicApiConfigHandler.BuildertoBuilder()
Returns
Type Description
ApiConfigHandler.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException

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.