Interface InstanceInfoOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
InstanceInfo, InstanceInfo.Builder
@Generated
public interface InstanceInfoOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionThe complete configuration of the instance including settings, accounts, and proxies.The complete configuration of the instance including settings, accounts, and proxies.The human-readable name of the instance.com.google.protobuf.ByteStringThe human-readable name of the instance.getIcon()The icon identifier for the instance (used for UI display).com.google.protobuf.ByteStringThe icon identifier for the instance (used for UI display).getInstancePermissions(int index) The permissions the current user has on this instance.intThe permissions the current user has on this instance.The permissions the current user has on this instance.getInstancePermissionsOrBuilder(int index) The permissions the current user has on this instance.List<? extends InstancePermissionStateOrBuilder> The permissions the current user has on this instance.getInstanceSettings(int index) Pages that group settings together for UI rendering.intPages that group settings together for UI rendering.Pages that group settings together for UI rendering.getInstanceSettingsOrBuilder(int index) Pages that group settings together for UI rendering.List<? extends SettingsPageOrBuilder> Pages that group settings together for UI rendering.com.google.protobuf.TimestampTimestamp of when the configuration was last modified.com.google.protobuf.TimestampOrBuilderTimestamp of when the configuration was last modified.getPlugins(int index) List of plugins registered with this instance.intList of plugins registered with this instance.List of plugins registered with this instance.getPluginsOrBuilder(int index) List of plugins registered with this instance.List<? extends ServerPluginOrBuilder> List of plugins registered with this instance.getSettingsDefinitions(int index) All available settings definitions that can be rendered by identifier.intAll available settings definitions that can be rendered by identifier.All available settings definitions that can be rendered by identifier.getSettingsDefinitionsOrBuilder(int index) All available settings definitions that can be rendered by identifier.List<? extends SettingsDefinitionOrBuilder> All available settings definitions that can be rendered by identifier.getState()The current lifecycle state of the instance.intThe current lifecycle state of the instance.booleanThe complete configuration of the instance including settings, accounts, and proxies.booleanTimestamp of when the configuration was last modified.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitializedMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getFriendlyName
String getFriendlyName()The human-readable name of the instance.
string friendly_name = 1;- Returns:
- The friendlyName.
-
getFriendlyNameBytes
com.google.protobuf.ByteString getFriendlyNameBytes()The human-readable name of the instance.
string friendly_name = 1;- Returns:
- The bytes for friendlyName.
-
getIcon
String getIcon()The icon identifier for the instance (used for UI display).
string icon = 5;- Returns:
- The icon.
-
getIconBytes
com.google.protobuf.ByteString getIconBytes()The icon identifier for the instance (used for UI display).
string icon = 5;- Returns:
- The bytes for icon.
-
hasConfig
boolean hasConfig()The complete configuration of the instance including settings, accounts, and proxies.
.soulfire.v1.InstanceConfig config = 2;- Returns:
- Whether the config field is set.
-
getConfig
InstanceConfig getConfig()The complete configuration of the instance including settings, accounts, and proxies.
.soulfire.v1.InstanceConfig config = 2;- Returns:
- The config.
-
getConfigOrBuilder
InstanceConfigOrBuilder getConfigOrBuilder()The complete configuration of the instance including settings, accounts, and proxies.
.soulfire.v1.InstanceConfig config = 2; -
getStateValue
int getStateValue()The current lifecycle state of the instance.
.soulfire.v1.InstanceState state = 3;- Returns:
- The enum numeric value on the wire for state.
-
getState
InstanceState getState()The current lifecycle state of the instance.
.soulfire.v1.InstanceState state = 3;- Returns:
- The state.
-
getInstancePermissionsList
List<InstancePermissionState> getInstancePermissionsList()The permissions the current user has on this instance.
repeated .soulfire.v1.InstancePermissionState instance_permissions = 4; -
getInstancePermissions
The permissions the current user has on this instance.
repeated .soulfire.v1.InstancePermissionState instance_permissions = 4; -
getInstancePermissionsCount
int getInstancePermissionsCount()The permissions the current user has on this instance.
repeated .soulfire.v1.InstancePermissionState instance_permissions = 4; -
getInstancePermissionsOrBuilderList
List<? extends InstancePermissionStateOrBuilder> getInstancePermissionsOrBuilderList()The permissions the current user has on this instance.
repeated .soulfire.v1.InstancePermissionState instance_permissions = 4; -
getInstancePermissionsOrBuilder
The permissions the current user has on this instance.
repeated .soulfire.v1.InstancePermissionState instance_permissions = 4; -
getSettingsDefinitionsList
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; -
getSettingsDefinitions
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; -
getSettingsDefinitionsCount
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; -
getSettingsDefinitionsOrBuilderList
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; -
getSettingsDefinitionsOrBuilder
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; -
getInstanceSettingsList
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; -
getInstanceSettings
Pages that group settings together for UI rendering. References settings by their identifiers from settings_definitions.
repeated .soulfire.v1.SettingsPage instance_settings = 6; -
getInstanceSettingsCount
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; -
getInstanceSettingsOrBuilderList
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; -
getInstanceSettingsOrBuilder
Pages that group settings together for UI rendering. References settings by their identifiers from settings_definitions.
repeated .soulfire.v1.SettingsPage instance_settings = 6; -
getPluginsList
List<ServerPlugin> getPluginsList()List of plugins registered with this instance.
repeated .soulfire.v1.ServerPlugin plugins = 7; -
getPlugins
List of plugins registered with this instance.
repeated .soulfire.v1.ServerPlugin plugins = 7; -
getPluginsCount
int getPluginsCount()List of plugins registered with this instance.
repeated .soulfire.v1.ServerPlugin plugins = 7; -
getPluginsOrBuilderList
List<? extends ServerPluginOrBuilder> getPluginsOrBuilderList()List of plugins registered with this instance.
repeated .soulfire.v1.ServerPlugin plugins = 7; -
getPluginsOrBuilder
List of plugins registered with this instance.
repeated .soulfire.v1.ServerPlugin plugins = 7; -
hasLastModified
boolean hasLastModified()Timestamp of when the configuration was last modified. Used for conditional requests via if_modified_since.
.google.protobuf.Timestamp last_modified = 9;- Returns:
- Whether the lastModified field is set.
-
getLastModified
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;- Returns:
- The lastModified.
-
getLastModifiedOrBuilder
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;
-