Interface InstanceStateChangeRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
InstanceStateChangeRequest, InstanceStateChangeRequest.Builder
@Generated public interface InstanceStateChangeRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getId()
    The unique identifier (UUID) of the instance.
    com.google.protobuf.ByteString
    getIdBytes()
    The unique identifier (UUID) of the instance.
    InstanceState
    getState()
    The target state for the instance.
    int
    getStateValue()
    The target state for the instance.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getId

      String getId()
      The unique identifier (UUID) of the instance.
      string id = 1;
      Returns:
      The id.

    • getIdBytes

      com.google.protobuf.ByteString getIdBytes()
      The unique identifier (UUID) of the instance.
      string id = 1;
      Returns:
      The bytes for id.

    • getStateValue

      int getStateValue()
      The target state for the instance. Valid transitions:
- STOPPED -> RUNNING: Starts the instance
- RUNNING -> PAUSED: Pauses bot ticking
- PAUSED -> RUNNING: Resumes bot ticking
- RUNNING/PAUSED -> STOPPED: Stops the instance
The server will handle intermediate states (STARTING, STOPPING) automatically.
      .soulfire.v1.InstanceState state = 2;
      Returns:
      The enum numeric value on the wire for state.

    • getState

      InstanceState getState()
      The target state for the instance. Valid transitions:
- STOPPED -> RUNNING: Starts the instance
- RUNNING -> PAUSED: Pauses bot ticking
- PAUSED -> RUNNING: Resumes bot ticking
- RUNNING/PAUSED -> STOPPED: Stops the instance
The server will handle intermediate states (STARTING, STOPPING) automatically.
      .soulfire.v1.InstanceState state = 2;
      Returns:
      The state.