Class InstanceInfo

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.soulfiremc.grpc.generated.InstanceInfo
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, InstanceInfoOrBuilder, Serializable
@Generated public final class InstanceInfo extends com.google.protobuf.GeneratedMessage implements InstanceInfoOrBuilder
Contains comprehensive information about an instance including its
configuration, state, permissions, and available settings.
Protobuf type soulfire.v1.InstanceInfo
See Also:

  • Field Details

    • FRIENDLY_NAME_FIELD_NUMBER

      public static final int FRIENDLY_NAME_FIELD_NUMBER
      See Also:

    • ICON_FIELD_NUMBER

      public static final int ICON_FIELD_NUMBER
      See Also:

    • CONFIG_FIELD_NUMBER

      public static final int CONFIG_FIELD_NUMBER
      See Also:

    • STATE_FIELD_NUMBER

      public static final int STATE_FIELD_NUMBER
      See Also:

    • INSTANCE_PERMISSIONS_FIELD_NUMBER

      public static final int INSTANCE_PERMISSIONS_FIELD_NUMBER
      See Also:

    • SETTINGS_DEFINITIONS_FIELD_NUMBER

      public static final int SETTINGS_DEFINITIONS_FIELD_NUMBER
      See Also:

    • INSTANCE_SETTINGS_FIELD_NUMBER

      public static final int INSTANCE_SETTINGS_FIELD_NUMBER
      See Also:

    • PLUGINS_FIELD_NUMBER

      public static final int PLUGINS_FIELD_NUMBER
      See Also:

    • LAST_MODIFIED_FIELD_NUMBER

      public static final int LAST_MODIFIED_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getFriendlyName

      public String getFriendlyName()
      The human-readable name of the instance.
      string friendly_name = 1;
      Specified by:
      getFriendlyName in interface InstanceInfoOrBuilder
      Returns:
      The friendlyName.

    • getFriendlyNameBytes

      public com.google.protobuf.ByteString getFriendlyNameBytes()
      The human-readable name of the instance.
      string friendly_name = 1;
      Specified by:
      getFriendlyNameBytes in interface InstanceInfoOrBuilder
      Returns:
      The bytes for friendlyName.

    • getIcon

      public String getIcon()
      The icon identifier for the instance (used for UI display).
      string icon = 5;
      Specified by:
      getIcon in interface InstanceInfoOrBuilder
      Returns:
      The icon.

    • getIconBytes

      public com.google.protobuf.ByteString getIconBytes()
      The icon identifier for the instance (used for UI display).
      string icon = 5;
      Specified by:
      getIconBytes in interface InstanceInfoOrBuilder
      Returns:
      The bytes for icon.

    • hasConfig

      public boolean hasConfig()
      The complete configuration of the instance including settings,
accounts, and proxies.
      .soulfire.v1.InstanceConfig config = 2;
      Specified by:
      hasConfig in interface InstanceInfoOrBuilder
      Returns:
      Whether the config field is set.

    • getConfig

      public InstanceConfig getConfig()
      The complete configuration of the instance including settings,
accounts, and proxies.
      .soulfire.v1.InstanceConfig config = 2;
      Specified by:
      getConfig in interface InstanceInfoOrBuilder
      Returns:
      The config.

    • getConfigOrBuilder

      public InstanceConfigOrBuilder getConfigOrBuilder()
      The complete configuration of the instance including settings,
accounts, and proxies.
      .soulfire.v1.InstanceConfig config = 2;
      Specified by:
      getConfigOrBuilder in interface InstanceInfoOrBuilder

    • getStateValue

      public int getStateValue()
      The current lifecycle state of the instance.
      .soulfire.v1.InstanceState state = 3;
      Specified by:
      getStateValue in interface InstanceInfoOrBuilder
      Returns:
      The enum numeric value on the wire for state.

    • getState

      public InstanceState getState()
      The current lifecycle state of the instance.
      .soulfire.v1.InstanceState state = 3;
      Specified by:
      getState in interface InstanceInfoOrBuilder
      Returns:
      The state.

    • getInstancePermissionsList

      public List<InstancePermissionState> getInstancePermissionsList()
      The permissions the current user has on this instance.
      repeated .soulfire.v1.InstancePermissionState instance_permissions = 4;
      Specified by:
      getInstancePermissionsList in interface InstanceInfoOrBuilder

    • getInstancePermissionsOrBuilderList

      public List<? extends InstancePermissionStateOrBuilder> getInstancePermissionsOrBuilderList()
      The permissions the current user has on this instance.
      repeated .soulfire.v1.InstancePermissionState instance_permissions = 4;
      Specified by:
      getInstancePermissionsOrBuilderList in interface InstanceInfoOrBuilder

    • getInstancePermissionsCount

      public int getInstancePermissionsCount()
      The permissions the current user has on this instance.
      repeated .soulfire.v1.InstancePermissionState instance_permissions = 4;
      Specified by:
      getInstancePermissionsCount in interface InstanceInfoOrBuilder

    • getInstancePermissions

      public InstancePermissionState getInstancePermissions(int index)
      The permissions the current user has on this instance.
      repeated .soulfire.v1.InstancePermissionState instance_permissions = 4;
      Specified by:
      getInstancePermissions in interface InstanceInfoOrBuilder

    • getInstancePermissionsOrBuilder

      public InstancePermissionStateOrBuilder getInstancePermissionsOrBuilder(int index)
      The permissions the current user has on this instance.
      repeated .soulfire.v1.InstancePermissionState instance_permissions = 4;
      Specified by:
      getInstancePermissionsOrBuilder in interface InstanceInfoOrBuilder

    • getSettingsDefinitionsList

      public List<SettingsDefinition> getSettingsDefinitionsList()
      All available settings definitions that can be rendered by identifier.
These define the schema and UI configuration for each setting.
      repeated .soulfire.v1.SettingsDefinition settings_definitions = 8;
      Specified by:
      getSettingsDefinitionsList in interface InstanceInfoOrBuilder

    • getSettingsDefinitionsOrBuilderList

      public List<? extends SettingsDefinitionOrBuilder> getSettingsDefinitionsOrBuilderList()
      All available settings definitions that can be rendered by identifier.
These define the schema and UI configuration for each setting.
      repeated .soulfire.v1.SettingsDefinition settings_definitions = 8;
      Specified by:
      getSettingsDefinitionsOrBuilderList in interface InstanceInfoOrBuilder

    • getSettingsDefinitionsCount

      public int getSettingsDefinitionsCount()
      All available settings definitions that can be rendered by identifier.
These define the schema and UI configuration for each setting.
      repeated .soulfire.v1.SettingsDefinition settings_definitions = 8;
      Specified by:
      getSettingsDefinitionsCount in interface InstanceInfoOrBuilder

    • getSettingsDefinitions

      public SettingsDefinition getSettingsDefinitions(int index)
      All available settings definitions that can be rendered by identifier.
These define the schema and UI configuration for each setting.
      repeated .soulfire.v1.SettingsDefinition settings_definitions = 8;
      Specified by:
      getSettingsDefinitions in interface InstanceInfoOrBuilder

    • getSettingsDefinitionsOrBuilder

      public SettingsDefinitionOrBuilder getSettingsDefinitionsOrBuilder(int index)
      All available settings definitions that can be rendered by identifier.
These define the schema and UI configuration for each setting.
      repeated .soulfire.v1.SettingsDefinition settings_definitions = 8;
      Specified by:
      getSettingsDefinitionsOrBuilder in interface InstanceInfoOrBuilder

    • getInstanceSettingsList

      public List<SettingsPage> getInstanceSettingsList()
      Pages that group settings together for UI rendering.
References settings by their identifiers from settings_definitions.
      repeated .soulfire.v1.SettingsPage instance_settings = 6;
      Specified by:
      getInstanceSettingsList in interface InstanceInfoOrBuilder

    • getInstanceSettingsOrBuilderList

      public List<? extends SettingsPageOrBuilder> getInstanceSettingsOrBuilderList()
      Pages that group settings together for UI rendering.
References settings by their identifiers from settings_definitions.
      repeated .soulfire.v1.SettingsPage instance_settings = 6;
      Specified by:
      getInstanceSettingsOrBuilderList in interface InstanceInfoOrBuilder

    • getInstanceSettingsCount

      public int getInstanceSettingsCount()
      Pages that group settings together for UI rendering.
References settings by their identifiers from settings_definitions.
      repeated .soulfire.v1.SettingsPage instance_settings = 6;
      Specified by:
      getInstanceSettingsCount in interface InstanceInfoOrBuilder

    • getInstanceSettings

      public SettingsPage getInstanceSettings(int index)
      Pages that group settings together for UI rendering.
References settings by their identifiers from settings_definitions.
      repeated .soulfire.v1.SettingsPage instance_settings = 6;
      Specified by:
      getInstanceSettings in interface InstanceInfoOrBuilder

    • getInstanceSettingsOrBuilder

      public SettingsPageOrBuilder getInstanceSettingsOrBuilder(int index)
      Pages that group settings together for UI rendering.
References settings by their identifiers from settings_definitions.
      repeated .soulfire.v1.SettingsPage instance_settings = 6;
      Specified by:
      getInstanceSettingsOrBuilder in interface InstanceInfoOrBuilder

    • getPluginsList

      public List<ServerPlugin> getPluginsList()
      List of plugins registered with this instance.
      repeated .soulfire.v1.ServerPlugin plugins = 7;
      Specified by:
      getPluginsList in interface InstanceInfoOrBuilder

    • getPluginsOrBuilderList

      public List<? extends ServerPluginOrBuilder> getPluginsOrBuilderList()
      List of plugins registered with this instance.
      repeated .soulfire.v1.ServerPlugin plugins = 7;
      Specified by:
      getPluginsOrBuilderList in interface InstanceInfoOrBuilder

    • getPluginsCount

      public int getPluginsCount()
      List of plugins registered with this instance.
      repeated .soulfire.v1.ServerPlugin plugins = 7;
      Specified by:
      getPluginsCount in interface InstanceInfoOrBuilder

    • getPlugins

      public ServerPlugin getPlugins(int index)
      List of plugins registered with this instance.
      repeated .soulfire.v1.ServerPlugin plugins = 7;
      Specified by:
      getPlugins in interface InstanceInfoOrBuilder

    • getPluginsOrBuilder

      public ServerPluginOrBuilder getPluginsOrBuilder(int index)
      List of plugins registered with this instance.
      repeated .soulfire.v1.ServerPlugin plugins = 7;
      Specified by:
      getPluginsOrBuilder in interface InstanceInfoOrBuilder

    • hasLastModified

      public boolean hasLastModified()
      Timestamp of when the configuration was last modified.
Used for conditional requests via if_modified_since.
      .google.protobuf.Timestamp last_modified = 9;
      Specified by:
      hasLastModified in interface InstanceInfoOrBuilder
      Returns:
      Whether the lastModified field is set.

    • getLastModified

      public com.google.protobuf.Timestamp getLastModified()
      Timestamp of when the configuration was last modified.
Used for conditional requests via if_modified_since.
      .google.protobuf.Timestamp last_modified = 9;
      Specified by:
      getLastModified in interface InstanceInfoOrBuilder
      Returns:
      The lastModified.

    • getLastModifiedOrBuilder

      public com.google.protobuf.TimestampOrBuilder getLastModifiedOrBuilder()
      Timestamp of when the configuration was last modified.
Used for conditional requests via if_modified_since.
      .google.protobuf.Timestamp last_modified = 9;
      Specified by:
      getLastModifiedOrBuilder in interface InstanceInfoOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static InstanceInfo parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static InstanceInfo parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static InstanceInfo parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static InstanceInfo parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static InstanceInfo parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static InstanceInfo parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static InstanceInfo parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static InstanceInfo parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static InstanceInfo parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static InstanceInfo parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static InstanceInfo parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static InstanceInfo parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public InstanceInfo.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static InstanceInfo.Builder newBuilder()

    • newBuilder

      public static InstanceInfo.Builder newBuilder(InstanceInfo prototype)

    • toBuilder

      public InstanceInfo.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected InstanceInfo.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static InstanceInfo getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<InstanceInfo> parser()

    • getParserForType

      public com.google.protobuf.Parser<InstanceInfo> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public InstanceInfo getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder