Package com.viam.robot.v1

Enum Class Robot.ModuleStatus.State

java.lang.Object
java.lang.Enum<Robot.ModuleStatus.State>
com.viam.robot.v1.Robot.ModuleStatus.State
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, Serializable, Comparable<Robot.ModuleStatus.State>, Constable
Enclosing class:
Robot.ModuleStatus
public static enum Robot.ModuleStatus.State extends Enum<Robot.ModuleStatus.State> implements com.google.protobuf.Internal.EnumLite
Protobuf enum viam.robot.v1.ModuleStatus.State

  • Enum Constant Details

    • STATE_UNSPECIFIED

      public static final Robot.ModuleStatus.State STATE_UNSPECIFIED
       state is unknown or has not been set yet
      STATE_UNSPECIFIED = 0;

    • STATE_PENDING

      public static final Robot.ModuleStatus.State STATE_PENDING
       module is configured but viam-server has not yet attempted to start it
 (because e.g. a required package is still downloading)
 transitions -> state_starting after pre-setup completes
      STATE_PENDING = 1;

    • STATE_STARTING

      public static final Robot.ModuleStatus.State STATE_STARTING
       module process has been spawned and viam-server is waiting for it
 to send a Ready response and register its models
 transitions -> state_ready on success
      STATE_STARTING = 2;

    • STATE_READY

      public static final Robot.ModuleStatus.State STATE_READY
       module has sent a Ready response, registered its models, and is running
 transitions -> state_unhealthy on bad exit
      STATE_READY = 3;

    • STATE_UNHEALTHY

      public static final Robot.ModuleStatus.State STATE_UNHEALTHY
       module failed to start, exited unexpectedly,
 or is being restarted after a crash. any failure in any other state goes to this state
      STATE_UNHEALTHY = 4;

    • STATE_CLOSING

      public static final Robot.ModuleStatus.State STATE_CLOSING
       module process is shutting down, either because the module is being
 removed from the machine or because it is restarting during a reconfigure.
 on removal the module's status stops being tracked once shutdown completes;
 on restart it transitions -> state_starting
      STATE_CLOSING = 5;

    • UNRECOGNIZED

      public static final Robot.ModuleStatus.State UNRECOGNIZED

  • Field Details

    • STATE_UNSPECIFIED_VALUE

      public static final int STATE_UNSPECIFIED_VALUE
       state is unknown or has not been set yet
      STATE_UNSPECIFIED = 0;
      See Also:

    • STATE_PENDING_VALUE

      public static final int STATE_PENDING_VALUE
       module is configured but viam-server has not yet attempted to start it
 (because e.g. a required package is still downloading)
 transitions -> state_starting after pre-setup completes
      STATE_PENDING = 1;
      See Also:

    • STATE_STARTING_VALUE

      public static final int STATE_STARTING_VALUE
       module process has been spawned and viam-server is waiting for it
 to send a Ready response and register its models
 transitions -> state_ready on success
      STATE_STARTING = 2;
      See Also:

    • STATE_READY_VALUE

      public static final int STATE_READY_VALUE
       module has sent a Ready response, registered its models, and is running
 transitions -> state_unhealthy on bad exit
      STATE_READY = 3;
      See Also:

    • STATE_UNHEALTHY_VALUE

      public static final int STATE_UNHEALTHY_VALUE
       module failed to start, exited unexpectedly,
 or is being restarted after a crash. any failure in any other state goes to this state
      STATE_UNHEALTHY = 4;
      See Also:

    • STATE_CLOSING_VALUE

      public static final int STATE_CLOSING_VALUE
       module process is shutting down, either because the module is being
 removed from the machine or because it is restarting during a reconfigure.
 on removal the module's status stops being tracked once shutdown completes;
 on restart it transitions -> state_starting
      STATE_CLOSING = 5;
      See Also:

  • Method Details

    • values

      public static Robot.ModuleStatus.State[] 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 Robot.ModuleStatus.State 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

    • valueOf

      @Deprecated public static Robot.ModuleStatus.State 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 Robot.ModuleStatus.State forNumber(int value)

    • internalGetValueMap

      public static com.google.protobuf.Internal.EnumLiteMap<Robot.ModuleStatus.State> internalGetValueMap()

    • internalGetVerifier

      public static com.google.protobuf.Internal.EnumVerifier internalGetVerifier()