com.google.appengine.v1

Enum LoginRequirement

java.lang.Object

java.lang.Enum<LoginRequirement>

com.google.appengine.v1.LoginRequirement

All Implemented Interfaces:

Internal.EnumLite, ProtocolMessageEnum, java.io.Serializable, java.lang.Comparable<LoginRequirement>

public enum LoginRequirement
extends java.lang.Enum<LoginRequirement>
implements ProtocolMessageEnum

 Methods to restrict access to a URL based on login status.
 

Protobuf enum google.appengine.v1.LoginRequirement

Enum Constant Summary

Enum Constants

Enum Constant and Description
LOGIN_ADMIN If the user is not signed in, the `auth_fail_action` is taken.
LOGIN_OPTIONAL Does not require that the user is signed in.
LOGIN_REQUIRED If the user has signed in, the handler proceeds normally.
LOGIN_UNSPECIFIED Not specified.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field and Description
static int	LOGIN_ADMIN_VALUE If the user is not signed in, the `auth_fail_action` is taken.
static int	LOGIN_OPTIONAL_VALUE Does not require that the user is signed in.
static int	LOGIN_REQUIRED_VALUE If the user has signed in, the handler proceeds normally.
static int	LOGIN_UNSPECIFIED_VALUE Not specified.

Method Summary

Modifier and Type	Method and Description
static LoginRequirement	forNumber(int value)
static Descriptors.EnumDescriptor	getDescriptor()
Descriptors.EnumDescriptor	getDescriptorForType()
int	getNumber()
Descriptors.EnumValueDescriptor	getValueDescriptor()
static Internal.EnumLiteMap<LoginRequirement>	internalGetValueMap()
static LoginRequirement	valueOf(Descriptors.EnumValueDescriptor desc)
static LoginRequirement	valueOf(int value) Deprecated. Use forNumber(int) instead.
static LoginRequirement	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static LoginRequirement[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LOGIN_UNSPECIFIED

public static final LoginRequirement LOGIN_UNSPECIFIED

 Not specified. `LOGIN_OPTIONAL` is assumed.
 

LOGIN_UNSPECIFIED = 0;

LOGIN_OPTIONAL

public static final LoginRequirement LOGIN_OPTIONAL

 Does not require that the user is signed in.
 

LOGIN_OPTIONAL = 1;

LOGIN_ADMIN

public static final LoginRequirement LOGIN_ADMIN

 If the user is not signed in, the `auth_fail_action` is taken.
 In addition, if the user is not an administrator for the
 application, they are given an error message regardless of
 `auth_fail_action`. If the user is an administrator, the handler
 proceeds.
 

LOGIN_ADMIN = 2;

LOGIN_REQUIRED

public static final LoginRequirement LOGIN_REQUIRED

 If the user has signed in, the handler proceeds normally. Otherwise, the
 auth_fail_action is taken.
 

LOGIN_REQUIRED = 3;

UNRECOGNIZED

public static final LoginRequirement UNRECOGNIZED

Field Detail

LOGIN_UNSPECIFIED_VALUE

public static final int LOGIN_UNSPECIFIED_VALUE

 Not specified. `LOGIN_OPTIONAL` is assumed.
 

LOGIN_UNSPECIFIED = 0;

See Also:

Constant Field Values

LOGIN_OPTIONAL_VALUE

public static final int LOGIN_OPTIONAL_VALUE

 Does not require that the user is signed in.
 

LOGIN_OPTIONAL = 1;

See Also:

Constant Field Values

LOGIN_ADMIN_VALUE

public static final int LOGIN_ADMIN_VALUE

 If the user is not signed in, the `auth_fail_action` is taken.
 In addition, if the user is not an administrator for the
 application, they are given an error message regardless of
 `auth_fail_action`. If the user is an administrator, the handler
 proceeds.
 

LOGIN_ADMIN = 2;

See Also:

Constant Field Values

LOGIN_REQUIRED_VALUE

public static final int LOGIN_REQUIRED_VALUE

 If the user has signed in, the handler proceeds normally. Otherwise, the
 auth_fail_action is taken.
 

LOGIN_REQUIRED = 3;

See Also:

Constant Field Values

Method Detail

values

public static LoginRequirement[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (LoginRequirement c : LoginRequirement.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static LoginRequirement valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getNumber

public final int getNumber()

Specified by:

getNumber in interface Internal.EnumLite

Specified by:

getNumber in interface ProtocolMessageEnum

valueOf

@Deprecated
public static LoginRequirement valueOf(int value)

Deprecated. Use forNumber(int) instead.

forNumber

public static LoginRequirement forNumber(int value)

internalGetValueMap

public static Internal.EnumLiteMap<LoginRequirement> internalGetValueMap()

getValueDescriptor

public final Descriptors.EnumValueDescriptor getValueDescriptor()

Specified by:

getValueDescriptor in interface ProtocolMessageEnum

getDescriptorForType

public final Descriptors.EnumDescriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface ProtocolMessageEnum

getDescriptor

public static final Descriptors.EnumDescriptor getDescriptor()

valueOf

public static LoginRequirement valueOf(Descriptors.EnumValueDescriptor desc)