Class ApiConfigHandler (2.3.4)

Stay organized with collections Save and categorize content based on your preferences.
public final class ApiConfigHandler extends GeneratedMessageV3 implements ApiConfigHandlerOrBuilder

Google Cloud Endpoints configuration for API handlers.

Protobuf type google.appengine.v1.ApiConfigHandler

Static Fields

AUTH_FAIL_ACTION_FIELD_NUMBER

public static final int AUTH_FAIL_ACTION_FIELD_NUMBER
Field Value
TypeDescription
int

LOGIN_FIELD_NUMBER

public static final int LOGIN_FIELD_NUMBER
Field Value
TypeDescription
int

SCRIPT_FIELD_NUMBER

public static final int SCRIPT_FIELD_NUMBER
Field Value
TypeDescription
int

SECURITY_LEVEL_FIELD_NUMBER

public static final int SECURITY_LEVEL_FIELD_NUMBER
Field Value
TypeDescription
int

URL_FIELD_NUMBER

public static final int URL_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ApiConfigHandler getDefaultInstance()
Returns
TypeDescription
ApiConfigHandler

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ApiConfigHandler.Builder newBuilder()
Returns
TypeDescription
ApiConfigHandler.Builder

newBuilder(ApiConfigHandler prototype)

public static ApiConfigHandler.Builder newBuilder(ApiConfigHandler prototype)
Parameter
NameDescription
prototypeApiConfigHandler
Returns
TypeDescription
ApiConfigHandler.Builder

parseDelimitedFrom(InputStream input)

public static ApiConfigHandler parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ApiConfigHandler
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ApiConfigHandler parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ApiConfigHandler
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ApiConfigHandler parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ApiConfigHandler
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ApiConfigHandler parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ApiConfigHandler
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ApiConfigHandler parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ApiConfigHandler
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ApiConfigHandler parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ApiConfigHandler
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ApiConfigHandler parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ApiConfigHandler
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ApiConfigHandler parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ApiConfigHandler
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ApiConfigHandler parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ApiConfigHandler
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ApiConfigHandler parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ApiConfigHandler
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ApiConfigHandler parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ApiConfigHandler
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ApiConfigHandler parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ApiConfigHandler
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ApiConfigHandler> parser()
Returns
TypeDescription
Parser<ApiConfigHandler>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAuthFailAction()

public AuthFailAction getAuthFailAction()

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

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

Returns
TypeDescription
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 = 1;

Returns
TypeDescription
int

The enum numeric value on the wire for authFailAction.

getDefaultInstanceForType()

public ApiConfigHandler getDefaultInstanceForType()
Returns
TypeDescription
ApiConfigHandler

getLogin()

public LoginRequirement getLogin()

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

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

Returns
TypeDescription
LoginRequirement

The login.

getLoginValue()

public int getLoginValue()

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

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

Returns
TypeDescription
int

The enum numeric value on the wire for login.

getParserForType()

public Parser<ApiConfigHandler> getParserForType()
Returns
TypeDescription
Parser<ApiConfigHandler>
Overrides

getScript()

public String getScript()

Path to the script from the application root directory.

string script = 3;

Returns
TypeDescription
String

The script.

getScriptBytes()

public ByteString getScriptBytes()

Path to the script from the application root directory.

string script = 3;

Returns
TypeDescription
ByteString

The bytes for script.

getSecurityLevel()

public SecurityLevel getSecurityLevel()

Security (HTTPS) enforcement for this URL.

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

Returns
TypeDescription
SecurityLevel

The securityLevel.

getSecurityLevelValue()

public int getSecurityLevelValue()

Security (HTTPS) enforcement for this URL.

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

Returns
TypeDescription
int

The enum numeric value on the wire for securityLevel.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

getUrl()

public String getUrl()

URL to serve the endpoint at.

string url = 5;

Returns
TypeDescription
String

The url.

getUrlBytes()

public ByteString getUrlBytes()

URL to serve the endpoint at.

string url = 5;

Returns
TypeDescription
ByteString

The bytes for url.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ApiConfigHandler.Builder newBuilderForType()
Returns
TypeDescription
ApiConfigHandler.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ApiConfigHandler.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ApiConfigHandler.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ApiConfigHandler.Builder toBuilder()
Returns
TypeDescription
ApiConfigHandler.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException