Enum Class InstancePermission

java.lang.Object
java.lang.Enum<InstancePermission>
com.soulfiremc.grpc.generated.InstancePermission
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<InstancePermission>, Constable
@Generated public enum InstancePermission extends Enum<InstancePermission> implements com.google.protobuf.ProtocolMessageEnum
Permissions that apply to a specific instance.
These permissions are scoped to individual instances and control what operations
a user can perform on that instance. Checked via PermissionContext.instance() method.
Permission grants are stored per-user per-instance in the database.
Protobuf enum soulfire.v1.InstancePermission

  • Enum Constant Details

    • INSTANCE_COMMAND_EXECUTION

      public static final InstancePermission INSTANCE_COMMAND_EXECUTION
      Permission to execute commands within this instance.
Required by CommandService for instance-level command execution.
      INSTANCE_COMMAND_EXECUTION = 0;

    • READ_INSTANCE

      public static final InstancePermission READ_INSTANCE
      Permission to read instance information and configuration.
Required by InstanceService.GetInstanceInfo RPC.
Also required to see the instance in InstanceService.ListInstances.
      READ_INSTANCE = 2;

    • UPDATE_INSTANCE_META

      public static final InstancePermission UPDATE_INSTANCE_META
      Permission to update instance metadata (friendly name, icon).
Required by InstanceService.UpdateInstanceMeta RPC.
      UPDATE_INSTANCE_META = 3;

    • UPDATE_INSTANCE_CONFIG

      public static final InstancePermission UPDATE_INSTANCE_CONFIG
      Permission to update instance configuration (settings, accounts, proxies).
Required by InstanceService.UpdateInstanceConfig, UpdateInstanceConfigEntry,
and all account/proxy add/remove/update RPCs.
      UPDATE_INSTANCE_CONFIG = 14;

    • DELETE_INSTANCE

      public static final InstancePermission DELETE_INSTANCE
      Permission to delete this instance entirely.
Required by InstanceService.DeleteInstance RPC.
This is a destructive operation that cannot be undone.
      DELETE_INSTANCE = 4;

    • CHANGE_INSTANCE_STATE

      public static final InstancePermission CHANGE_INSTANCE_STATE
      Permission to change the instance state (start, stop, pause, resume).
Required by InstanceService.ChangeInstanceState RPC.
Controls the bot session lifecycle.
      CHANGE_INSTANCE_STATE = 5;

    • AUTHENTICATE_MC_ACCOUNT

      public static final InstancePermission AUTHENTICATE_MC_ACCOUNT
      Permission to authenticate Minecraft accounts for this instance.
Required by MCAuthService RPCs (LoginCredentials, LoginDeviceCode, Refresh).
Allows adding new accounts or refreshing existing account tokens.
      AUTHENTICATE_MC_ACCOUNT = 6;

    • CHECK_PROXY

      public static final InstancePermission CHECK_PROXY
      Permission to check proxy connectivity and latency for this instance.
Required by ProxyCheckService.Check RPC.
      CHECK_PROXY = 7;

    • DOWNLOAD_URL

      public static final InstancePermission DOWNLOAD_URL
      Permission to download files from URLs through the server.
Required by DownloadService.Download RPC.
Used for fetching remote resources through instance proxies.
      DOWNLOAD_URL = 8;

    • ACCESS_OBJECT_STORAGE

      public static final InstancePermission ACCESS_OBJECT_STORAGE
      Permission to access WebDAV object storage for this instance.
Required to read/write files in the instance's storage area via WebDAV.
      ACCESS_OBJECT_STORAGE = 9;

    • INSTANCE_SUBSCRIBE_LOGS

      public static final InstancePermission INSTANCE_SUBSCRIBE_LOGS
      Permission to subscribe to log streams for this instance.
Required by LogService for instance-specific log streaming.
      INSTANCE_SUBSCRIBE_LOGS = 13;

    • READ_INSTANCE_AUDIT_LOGS

      public static final InstancePermission READ_INSTANCE_AUDIT_LOGS
      Permission to read the audit log for this instance.
Required by InstanceService.GetAuditLog RPC.
Shows command executions and state changes with user attribution.
      READ_INSTANCE_AUDIT_LOGS = 15;

    • READ_BOT_INFO

      public static final InstancePermission READ_BOT_INFO
      Permission to read information about individual bots in this instance.
Required by BotService RPCs for reading bot state and live data.
Also required by InstanceService.GetAccountMetadata RPC.
      READ_BOT_INFO = 10;

    • UPDATE_BOT_CONFIG

      public static final InstancePermission UPDATE_BOT_CONFIG
      Permission to update configuration for individual bots.
Required by BotService RPCs for modifying bot settings.
Also required for SetAccountMetadataEntry and DeleteAccountMetadataEntry.
      UPDATE_BOT_CONFIG = 11;

    • UNRECOGNIZED

      public static final InstancePermission UNRECOGNIZED

  • Field Details

    • INSTANCE_COMMAND_EXECUTION_VALUE

      public static final int INSTANCE_COMMAND_EXECUTION_VALUE
      Permission to execute commands within this instance.
Required by CommandService for instance-level command execution.
      INSTANCE_COMMAND_EXECUTION = 0;
      See Also:

    • READ_INSTANCE_VALUE

      public static final int READ_INSTANCE_VALUE
      Permission to read instance information and configuration.
Required by InstanceService.GetInstanceInfo RPC.
Also required to see the instance in InstanceService.ListInstances.
      READ_INSTANCE = 2;
      See Also:

    • UPDATE_INSTANCE_META_VALUE

      public static final int UPDATE_INSTANCE_META_VALUE
      Permission to update instance metadata (friendly name, icon).
Required by InstanceService.UpdateInstanceMeta RPC.
      UPDATE_INSTANCE_META = 3;
      See Also:

    • UPDATE_INSTANCE_CONFIG_VALUE

      public static final int UPDATE_INSTANCE_CONFIG_VALUE
      Permission to update instance configuration (settings, accounts, proxies).
Required by InstanceService.UpdateInstanceConfig, UpdateInstanceConfigEntry,
and all account/proxy add/remove/update RPCs.
      UPDATE_INSTANCE_CONFIG = 14;
      See Also:

    • DELETE_INSTANCE_VALUE

      public static final int DELETE_INSTANCE_VALUE
      Permission to delete this instance entirely.
Required by InstanceService.DeleteInstance RPC.
This is a destructive operation that cannot be undone.
      DELETE_INSTANCE = 4;
      See Also:

    • CHANGE_INSTANCE_STATE_VALUE

      public static final int CHANGE_INSTANCE_STATE_VALUE
      Permission to change the instance state (start, stop, pause, resume).
Required by InstanceService.ChangeInstanceState RPC.
Controls the bot session lifecycle.
      CHANGE_INSTANCE_STATE = 5;
      See Also:

    • AUTHENTICATE_MC_ACCOUNT_VALUE

      public static final int AUTHENTICATE_MC_ACCOUNT_VALUE
      Permission to authenticate Minecraft accounts for this instance.
Required by MCAuthService RPCs (LoginCredentials, LoginDeviceCode, Refresh).
Allows adding new accounts or refreshing existing account tokens.
      AUTHENTICATE_MC_ACCOUNT = 6;
      See Also:

    • CHECK_PROXY_VALUE

      public static final int CHECK_PROXY_VALUE
      Permission to check proxy connectivity and latency for this instance.
Required by ProxyCheckService.Check RPC.
      CHECK_PROXY = 7;
      See Also:

    • DOWNLOAD_URL_VALUE

      public static final int DOWNLOAD_URL_VALUE
      Permission to download files from URLs through the server.
Required by DownloadService.Download RPC.
Used for fetching remote resources through instance proxies.
      DOWNLOAD_URL = 8;
      See Also:

    • ACCESS_OBJECT_STORAGE_VALUE

      public static final int ACCESS_OBJECT_STORAGE_VALUE
      Permission to access WebDAV object storage for this instance.
Required to read/write files in the instance's storage area via WebDAV.
      ACCESS_OBJECT_STORAGE = 9;
      See Also:

    • INSTANCE_SUBSCRIBE_LOGS_VALUE

      public static final int INSTANCE_SUBSCRIBE_LOGS_VALUE
      Permission to subscribe to log streams for this instance.
Required by LogService for instance-specific log streaming.
      INSTANCE_SUBSCRIBE_LOGS = 13;
      See Also:

    • READ_INSTANCE_AUDIT_LOGS_VALUE

      public static final int READ_INSTANCE_AUDIT_LOGS_VALUE
      Permission to read the audit log for this instance.
Required by InstanceService.GetAuditLog RPC.
Shows command executions and state changes with user attribution.
      READ_INSTANCE_AUDIT_LOGS = 15;
      See Also:

    • READ_BOT_INFO_VALUE

      public static final int READ_BOT_INFO_VALUE
      Permission to read information about individual bots in this instance.
Required by BotService RPCs for reading bot state and live data.
Also required by InstanceService.GetAccountMetadata RPC.
      READ_BOT_INFO = 10;
      See Also:

    • UPDATE_BOT_CONFIG_VALUE

      public static final int UPDATE_BOT_CONFIG_VALUE
      Permission to update configuration for individual bots.
Required by BotService RPCs for modifying bot settings.
Also required for SetAccountMetadataEntry and DeleteAccountMetadataEntry.
      UPDATE_BOT_CONFIG = 11;
      See Also:

  • Method Details

    • values

      public static InstancePermission[] 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 InstancePermission 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 InstancePermission 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 InstancePermission 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<InstancePermission> 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 com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

    • valueOf

      public static InstancePermission 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