Package com.viam.robot.v1

Interface Robot.ModuleStatusOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
All Known Implementing Classes:
Robot.ModuleStatus, Robot.ModuleStatus.Builder
Enclosing class:
Robot
public static interface Robot.ModuleStatusOrBuilder extends com.google.protobuf.MessageLiteOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getConsecutiveFailures()
    number of times this module has entered the unhealthy state since the last time this module was in the ready state this will increment if the module is in a restart loop (state transitioning between pending and starting repeatedly) Resets to zero when the module enters the ready state or is reconfigured.
    String
    getError()
    when a module transitions to unhealthy, this field is populated with the error that caused the transition.
    com.google.protobuf.ByteString
    getErrorBytes()
    when a module transitions to unhealthy, this field is populated with the error that caused the transition.
    com.google.protobuf.Timestamp
    getLastUpdated()
    updated on every state transition
    String
    getModuleName()
    string module_name = 1 [json_name = "moduleName"];
    com.google.protobuf.ByteString
    getModuleNameBytes()
    string module_name = 1 [json_name = "moduleName"];
    Robot.ModuleStatus.State
    getState()
    .viam.robot.v1.ModuleStatus.State state = 2 [json_name = "state"];
    int
    getStateValue()
    .viam.robot.v1.ModuleStatus.State state = 2 [json_name = "state"];
    boolean
    hasLastUpdated()
    updated on every state transition

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • getModuleName

      String getModuleName()
      string module_name = 1 [json_name = "moduleName"];
      Returns:
      The moduleName.

    • getModuleNameBytes

      com.google.protobuf.ByteString getModuleNameBytes()
      string module_name = 1 [json_name = "moduleName"];
      Returns:
      The bytes for moduleName.

    • getStateValue

      int getStateValue()
      .viam.robot.v1.ModuleStatus.State state = 2 [json_name = "state"];
      Returns:
      The enum numeric value on the wire for state.

    • getState

      Robot.ModuleStatus.State getState()
      .viam.robot.v1.ModuleStatus.State state = 2 [json_name = "state"];
      Returns:
      The state.

    • hasLastUpdated

      boolean hasLastUpdated()
       updated on every state transition
      .google.protobuf.Timestamp last_updated = 3 [json_name = "lastUpdated"];
      Returns:
      Whether the lastUpdated field is set.

    • getLastUpdated

      com.google.protobuf.Timestamp getLastUpdated()
       updated on every state transition
      .google.protobuf.Timestamp last_updated = 3 [json_name = "lastUpdated"];
      Returns:
      The lastUpdated.

    • getError

      String getError()
       when a module transitions to unhealthy, this field is populated with the error that caused the transition.
 the error persists until the module reenters the Ready state, guaranteed to be nil in the Ready state
      string error = 4 [json_name = "error"];
      Returns:
      The error.

    • getErrorBytes

      com.google.protobuf.ByteString getErrorBytes()
       when a module transitions to unhealthy, this field is populated with the error that caused the transition.
 the error persists until the module reenters the Ready state, guaranteed to be nil in the Ready state
      string error = 4 [json_name = "error"];
      Returns:
      The bytes for error.

    • getConsecutiveFailures

      int getConsecutiveFailures()
       number of times this module has entered the unhealthy state since the last time this module was in the ready state
 this will increment if the module is in a restart loop (state transitioning between pending and starting repeatedly)
 Resets to zero when the module enters the ready state or is reconfigured.
 Useful for detecting modules stuck in a restart loop (like a python module with a syntax error)
      uint32 consecutive_failures = 5 [json_name = "consecutiveFailures"];
      Returns:
      The consecutiveFailures.