Package com.buildless.api

Enum Class PermissionLevel

java.lang.Object
java.lang.Enum<PermissionLevel>
com.buildless.api.PermissionLevel
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<PermissionLevel>, Constable
public enum PermissionLevel extends Enum<PermissionLevel> implements com.google.protobuf.ProtocolMessageEnum
 ## Permission Level

 Describes generic permission levels which map to effective well-known roles. If a user has a role matching one of
 these levels for a given API execution, the request is allowed to proceed.
Protobuf enum buildless.api.PermissionLevel

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ADMIN
    **Administrative permission:** valid credentials are required, and the invoking principal `MUST` be authorized with at least admin-level permissions for the applicable account scope in which the operation is taking place.
    DELETE
    **Delete permission:** valid credentials are required, and the invoking principal `MUST` be authorized with at least delete/destruct permissions for the applicable account scope in which the operation is taking place.
    OWNER
    **Owner permission:** valid credentials are required, and the invoking principal `MUST` be authorized with at least owner-level permissions for the applicable account scope in which the operation is taking place.
    PERMISSION_LEVEL_DEFAULT
    **Default permission level:** valid credentials are required, but no additional authorization checks are applied.
    READ
    **Read-only permission:** valid credentials are required, and the invoking principal `MUST` be authorized with at least read-only permissions for the applicable account scope in which the operation is taking place.
    READ_WRITE
    **Read-write permission:** valid credentials are required, and the invoking principal `MUST` be authorized with at least write/edit permissions for the applicable account scope in which the operation is taking place.
    UNRECOGNIZED
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ADMIN_VALUE
    **Administrative permission:** valid credentials are required, and the invoking principal `MUST` be authorized with at least admin-level permissions for the applicable account scope in which the operation is taking place.
    static final int
    DELETE_VALUE
    **Delete permission:** valid credentials are required, and the invoking principal `MUST` be authorized with at least delete/destruct permissions for the applicable account scope in which the operation is taking place.
    static final int
    OWNER_VALUE
    **Owner permission:** valid credentials are required, and the invoking principal `MUST` be authorized with at least owner-level permissions for the applicable account scope in which the operation is taking place.
    static final int
    PERMISSION_LEVEL_DEFAULT_VALUE
    **Default permission level:** valid credentials are required, but no additional authorization checks are applied.
    static final int
    READ_VALUE
    **Read-only permission:** valid credentials are required, and the invoking principal `MUST` be authorized with at least read-only permissions for the applicable account scope in which the operation is taking place.
    static final int
    READ_WRITE_VALUE
    **Read-write permission:** valid credentials are required, and the invoking principal `MUST` be authorized with at least write/edit permissions for the applicable account scope in which the operation is taking place.

  • Method Summary

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

    Methods inherited from class java.lang.Enum

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

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • PERMISSION_LEVEL_DEFAULT

      public static final PermissionLevel PERMISSION_LEVEL_DEFAULT
       **Default permission level:** valid credentials are required, but no additional authorization checks are applied.
      PERMISSION_LEVEL_DEFAULT = 0;

    • READ

      public static final PermissionLevel READ
       **Read-only permission:** valid credentials are required, and the invoking principal `MUST` be authorized with at
 least read-only permissions for the applicable account scope in which the operation is taking place.
      READ = 1;

    • READ_WRITE

      public static final PermissionLevel READ_WRITE
       **Read-write permission:** valid credentials are required, and the invoking principal `MUST` be authorized with at
 least write/edit permissions for the applicable account scope in which the operation is taking place.
      READ_WRITE = 2;

    • DELETE

      public static final PermissionLevel DELETE
       **Delete permission:** valid credentials are required, and the invoking principal `MUST` be authorized with at
 least delete/destruct permissions for the applicable account scope in which the operation is taking place.
      DELETE = 3;

    • ADMIN

      public static final PermissionLevel ADMIN
       **Administrative permission:** valid credentials are required, and the invoking principal `MUST` be authorized with
 at least admin-level permissions for the applicable account scope in which the operation is taking place. Some org
 roles enable specific administrative permissions, like IT or billing access.
      ADMIN = 4;

    • OWNER

      public static final PermissionLevel OWNER
       **Owner permission:** valid credentials are required, and the invoking principal `MUST` be authorized with at least
 owner-level permissions for the applicable account scope in which the operation is taking place. This is the
 highest possible permission level.
      OWNER = 5;

    • UNRECOGNIZED

      public static final PermissionLevel UNRECOGNIZED

  • Field Details

    • PERMISSION_LEVEL_DEFAULT_VALUE

      public static final int PERMISSION_LEVEL_DEFAULT_VALUE
       **Default permission level:** valid credentials are required, but no additional authorization checks are applied.
      PERMISSION_LEVEL_DEFAULT = 0;
      See Also:

    • READ_VALUE

      public static final int READ_VALUE
       **Read-only permission:** valid credentials are required, and the invoking principal `MUST` be authorized with at
 least read-only permissions for the applicable account scope in which the operation is taking place.
      READ = 1;
      See Also:

    • READ_WRITE_VALUE

      public static final int READ_WRITE_VALUE
       **Read-write permission:** valid credentials are required, and the invoking principal `MUST` be authorized with at
 least write/edit permissions for the applicable account scope in which the operation is taking place.
      READ_WRITE = 2;
      See Also:

    • DELETE_VALUE

      public static final int DELETE_VALUE
       **Delete permission:** valid credentials are required, and the invoking principal `MUST` be authorized with at
 least delete/destruct permissions for the applicable account scope in which the operation is taking place.
      DELETE = 3;
      See Also:

    • ADMIN_VALUE

      public static final int ADMIN_VALUE
       **Administrative permission:** valid credentials are required, and the invoking principal `MUST` be authorized with
 at least admin-level permissions for the applicable account scope in which the operation is taking place. Some org
 roles enable specific administrative permissions, like IT or billing access.
      ADMIN = 4;
      See Also:

    • OWNER_VALUE

      public static final int OWNER_VALUE
       **Owner permission:** valid credentials are required, and the invoking principal `MUST` be authorized with at least
 owner-level permissions for the applicable account scope in which the operation is taking place. This is the
 highest possible permission level.
      OWNER = 5;
      See Also:

  • Method Details

    • values

      public static PermissionLevel[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static PermissionLevel valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class 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 PermissionLevel valueOf(int value)
      Deprecated.
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null

    • forNumber

      public static PermissionLevel 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<PermissionLevel> 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 PermissionLevel valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null