Class ServerInfoResponse

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.soulfiremc.grpc.generated.ServerInfoResponse
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ServerInfoResponseOrBuilder, Serializable
@Generated public final class ServerInfoResponse extends com.google.protobuf.GeneratedMessage implements ServerInfoResponseOrBuilder
Response message for GetServerInfo RPC containing comprehensive server information.
This response provides everything needed to render a settings UI, including:
- Current configuration values
- All available setting definitions with their types and constraints
- Page layouts for organizing settings in the UI
- Information about registered plugins
Protobuf type soulfire.v1.ServerInfoResponse
See Also:

  • Field Details

    • CONFIG_FIELD_NUMBER

      public static final int CONFIG_FIELD_NUMBER
      See Also:

    • SETTINGS_DEFINITIONS_FIELD_NUMBER

      public static final int SETTINGS_DEFINITIONS_FIELD_NUMBER
      See Also:

    • SERVER_SETTINGS_FIELD_NUMBER

      public static final int SERVER_SETTINGS_FIELD_NUMBER
      See Also:

    • PLUGINS_FIELD_NUMBER

      public static final int PLUGINS_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

    • hasConfig

      public boolean hasConfig()
      The current server configuration containing all persisted settings values.
If no configuration has been saved yet, this will contain default/empty values.
      .soulfire.v1.ServerConfig config = 1;
      Specified by:
      hasConfig in interface ServerInfoResponseOrBuilder
      Returns:
      Whether the config field is set.

    • getConfig

      public ServerConfig getConfig()
      The current server configuration containing all persisted settings values.
If no configuration has been saved yet, this will contain default/empty values.
      .soulfire.v1.ServerConfig config = 1;
      Specified by:
      getConfig in interface ServerInfoResponseOrBuilder
      Returns:
      The config.

    • getConfigOrBuilder

      public ServerConfigOrBuilder getConfigOrBuilder()
      The current server configuration containing all persisted settings values.
If no configuration has been saved yet, this will contain default/empty values.
      .soulfire.v1.ServerConfig config = 1;
      Specified by:
      getConfigOrBuilder in interface ServerInfoResponseOrBuilder

    • getSettingsDefinitionsList

      public List<SettingsDefinition> getSettingsDefinitionsList()
      All available settings definitions that can be rendered by identifier.
Each definition includes the setting's type (string, int, bool, etc.),
UI metadata (display name, description), constraints (min/max, patterns),
and scope (SERVER, INSTANCE, or BOT level).
These definitions are referenced by their identifier (namespace + key).
      repeated .soulfire.v1.SettingsDefinition settings_definitions = 4;
      Specified by:
      getSettingsDefinitionsList in interface ServerInfoResponseOrBuilder

    • getSettingsDefinitionsOrBuilderList

      public List<? extends SettingsDefinitionOrBuilder> getSettingsDefinitionsOrBuilderList()
      All available settings definitions that can be rendered by identifier.
Each definition includes the setting's type (string, int, bool, etc.),
UI metadata (display name, description), constraints (min/max, patterns),
and scope (SERVER, INSTANCE, or BOT level).
These definitions are referenced by their identifier (namespace + key).
      repeated .soulfire.v1.SettingsDefinition settings_definitions = 4;
      Specified by:
      getSettingsDefinitionsOrBuilderList in interface ServerInfoResponseOrBuilder

    • getSettingsDefinitionsCount

      public int getSettingsDefinitionsCount()
      All available settings definitions that can be rendered by identifier.
Each definition includes the setting's type (string, int, bool, etc.),
UI metadata (display name, description), constraints (min/max, patterns),
and scope (SERVER, INSTANCE, or BOT level).
These definitions are referenced by their identifier (namespace + key).
      repeated .soulfire.v1.SettingsDefinition settings_definitions = 4;
      Specified by:
      getSettingsDefinitionsCount in interface ServerInfoResponseOrBuilder

    • getSettingsDefinitions

      public SettingsDefinition getSettingsDefinitions(int index)
      All available settings definitions that can be rendered by identifier.
Each definition includes the setting's type (string, int, bool, etc.),
UI metadata (display name, description), constraints (min/max, patterns),
and scope (SERVER, INSTANCE, or BOT level).
These definitions are referenced by their identifier (namespace + key).
      repeated .soulfire.v1.SettingsDefinition settings_definitions = 4;
      Specified by:
      getSettingsDefinitions in interface ServerInfoResponseOrBuilder

    • getSettingsDefinitionsOrBuilder

      public SettingsDefinitionOrBuilder getSettingsDefinitionsOrBuilder(int index)
      All available settings definitions that can be rendered by identifier.
Each definition includes the setting's type (string, int, bool, etc.),
UI metadata (display name, description), constraints (min/max, patterns),
and scope (SERVER, INSTANCE, or BOT level).
These definitions are referenced by their identifier (namespace + key).
      repeated .soulfire.v1.SettingsDefinition settings_definitions = 4;
      Specified by:
      getSettingsDefinitionsOrBuilder in interface ServerInfoResponseOrBuilder

    • getServerSettingsList

      public List<SettingsPage> getServerSettingsList()
      Pages that group settings together for UI organization.
Each page has an ID, display name, icon, and references settings by their identifiers.
Pages may be associated with plugins and can have an "enabled" toggle setting.
      repeated .soulfire.v1.SettingsPage server_settings = 2;
      Specified by:
      getServerSettingsList in interface ServerInfoResponseOrBuilder

    • getServerSettingsOrBuilderList

      public List<? extends SettingsPageOrBuilder> getServerSettingsOrBuilderList()
      Pages that group settings together for UI organization.
Each page has an ID, display name, icon, and references settings by their identifiers.
Pages may be associated with plugins and can have an "enabled" toggle setting.
      repeated .soulfire.v1.SettingsPage server_settings = 2;
      Specified by:
      getServerSettingsOrBuilderList in interface ServerInfoResponseOrBuilder

    • getServerSettingsCount

      public int getServerSettingsCount()
      Pages that group settings together for UI organization.
Each page has an ID, display name, icon, and references settings by their identifiers.
Pages may be associated with plugins and can have an "enabled" toggle setting.
      repeated .soulfire.v1.SettingsPage server_settings = 2;
      Specified by:
      getServerSettingsCount in interface ServerInfoResponseOrBuilder

    • getServerSettings

      public SettingsPage getServerSettings(int index)
      Pages that group settings together for UI organization.
Each page has an ID, display name, icon, and references settings by their identifiers.
Pages may be associated with plugins and can have an "enabled" toggle setting.
      repeated .soulfire.v1.SettingsPage server_settings = 2;
      Specified by:
      getServerSettings in interface ServerInfoResponseOrBuilder

    • getServerSettingsOrBuilder

      public SettingsPageOrBuilder getServerSettingsOrBuilder(int index)
      Pages that group settings together for UI organization.
Each page has an ID, display name, icon, and references settings by their identifiers.
Pages may be associated with plugins and can have an "enabled" toggle setting.
      repeated .soulfire.v1.SettingsPage server_settings = 2;
      Specified by:
      getServerSettingsOrBuilder in interface ServerInfoResponseOrBuilder

    • getPluginsList

      public List<ServerPlugin> getPluginsList()
      List of registered plugins on the server.
Each plugin includes metadata such as ID, version, description, author,
license, and website URL. Plugins may own settings pages.
      repeated .soulfire.v1.ServerPlugin plugins = 3;
      Specified by:
      getPluginsList in interface ServerInfoResponseOrBuilder

    • getPluginsOrBuilderList

      public List<? extends ServerPluginOrBuilder> getPluginsOrBuilderList()
      List of registered plugins on the server.
Each plugin includes metadata such as ID, version, description, author,
license, and website URL. Plugins may own settings pages.
      repeated .soulfire.v1.ServerPlugin plugins = 3;
      Specified by:
      getPluginsOrBuilderList in interface ServerInfoResponseOrBuilder

    • getPluginsCount

      public int getPluginsCount()
      List of registered plugins on the server.
Each plugin includes metadata such as ID, version, description, author,
license, and website URL. Plugins may own settings pages.
      repeated .soulfire.v1.ServerPlugin plugins = 3;
      Specified by:
      getPluginsCount in interface ServerInfoResponseOrBuilder

    • getPlugins

      public ServerPlugin getPlugins(int index)
      List of registered plugins on the server.
Each plugin includes metadata such as ID, version, description, author,
license, and website URL. Plugins may own settings pages.
      repeated .soulfire.v1.ServerPlugin plugins = 3;
      Specified by:
      getPlugins in interface ServerInfoResponseOrBuilder

    • getPluginsOrBuilder

      public ServerPluginOrBuilder getPluginsOrBuilder(int index)
      List of registered plugins on the server.
Each plugin includes metadata such as ID, version, description, author,
license, and website URL. Plugins may own settings pages.
      repeated .soulfire.v1.ServerPlugin plugins = 3;
      Specified by:
      getPluginsOrBuilder in interface ServerInfoResponseOrBuilder

    • 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 ServerInfoResponse parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ServerInfoResponse.Builder newBuilder()

    • newBuilder

      public static ServerInfoResponse.Builder newBuilder(ServerInfoResponse prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static ServerInfoResponse getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<ServerInfoResponse> 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 ServerInfoResponse getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder