Package com.google.appengine.v1

Enum LoginRequirement

  • All Implemented Interfaces:
    com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<LoginRequirement>
    public enum LoginRequirement
extends Enum<LoginRequirement>
implements com.google.protobuf.ProtocolMessageEnum
     Methods to restrict access to a URL based on login status.
    Protobuf enum google.appengine.v1.LoginRequirement

    • 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;

    • 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​(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:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • getNumber

        public final int getNumber()
        Specified by:
        getNumber in interface com.google.protobuf.Internal.EnumLite
        Specified by:
        getNumber in interface com.google.protobuf.ProtocolMessageEnum

      • valueOf

        @Deprecated
public static LoginRequirement valueOf​(int value)
        Deprecated.
        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:
        value - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • forNumber

        public static LoginRequirement forNumber​(int value)
        Parameters:
        value - The numeric wire value of the corresponding enum entry.
        Returns:
        The enum associated with the given numeric wire value.

      • internalGetValueMap

        public static com.google.protobuf.Internal.EnumLiteMap<LoginRequirement> internalGetValueMap()

      • getValueDescriptor

        public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
        Specified by:
        getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

      • getDescriptorForType

        public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

      • getDescriptor

        public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

      • valueOf

        public static LoginRequirement valueOf​(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
        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:
        desc - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null