Package com.viam.robot.v1

Class Robot.ModuleStatus

java.lang.Object
com.google.protobuf.AbstractMessageLite<Robot.ModuleStatus,Robot.ModuleStatus.Builder>
com.google.protobuf.GeneratedMessageLite<Robot.ModuleStatus,Robot.ModuleStatus.Builder>
com.viam.robot.v1.Robot.ModuleStatus
All Implemented Interfaces:
com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, Robot.ModuleStatusOrBuilder
Enclosing class:
Robot
public static final class Robot.ModuleStatus extends com.google.protobuf.GeneratedMessageLite<Robot.ModuleStatus,Robot.ModuleStatus.Builder> implements Robot.ModuleStatusOrBuilder
Protobuf type viam.robot.v1.ModuleStatus

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Robot.ModuleStatus.Builder
    Protobuf type viam.robot.v1.ModuleStatus
    static enum 
    Robot.ModuleStatus.State
    Protobuf enum viam.robot.v1.ModuleStatus.State

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageLite

    com.google.protobuf.GeneratedMessageLite.DefaultInstanceBasedParser<T extends com.google.protobuf.GeneratedMessageLite<T,?>>, com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.GeneratedExtension<ContainingType extends com.google.protobuf.MessageLite,Type>, com.google.protobuf.GeneratedMessageLite.MethodToInvoke, com.google.protobuf.GeneratedMessageLite.SerializedForm

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CONSECUTIVE_FAILURES_FIELD_NUMBER
     
    static final int
    ERROR_FIELD_NUMBER
     
    static final int
    LAST_UPDATED_FIELD_NUMBER
     
    static final int
    MODULE_NAME_FIELD_NUMBER
     
    static final int
    STATE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageLite

    unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    protected final Object
    dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
     
    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.
    static Robot.ModuleStatus
    getDefaultInstance()
     
    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
    static Robot.ModuleStatus.Builder
    newBuilder()
     
    static Robot.ModuleStatus.Builder
    newBuilder(Robot.ModuleStatus prototype)
     
    static Robot.ModuleStatus
    parseDelimitedFrom(InputStream input)
     
    static Robot.ModuleStatus
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Robot.ModuleStatus
    parseFrom(byte[] data)
     
    static Robot.ModuleStatus
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Robot.ModuleStatus
    parseFrom(com.google.protobuf.ByteString data)
     
    static Robot.ModuleStatus
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Robot.ModuleStatus
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Robot.ModuleStatus
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Robot.ModuleStatus
    parseFrom(InputStream input)
     
    static Robot.ModuleStatus
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Robot.ModuleStatus
    parseFrom(ByteBuffer data)
     
    static Robot.ModuleStatus
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Robot.ModuleStatus>
    parser()
     

    Methods inherited from class com.google.protobuf.GeneratedMessageLite

    createBuilder, createBuilder, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstanceForType, getParserForType, getSerializedSize, hashCode, isInitialized, makeImmutable, mergeLengthDelimitedField, mergeUnknownFields, mergeVarintField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType, newMessageInfo, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseDelimitedFrom, parseDelimitedFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parsePartialFrom, parseUnknownField, registerDefaultInstance, toBuilder, toString, writeTo

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Field Details

    • MODULE_NAME_FIELD_NUMBER

      public static final int MODULE_NAME_FIELD_NUMBER
      See Also:

    • STATE_FIELD_NUMBER

      public static final int STATE_FIELD_NUMBER
      See Also:

    • LAST_UPDATED_FIELD_NUMBER

      public static final int LAST_UPDATED_FIELD_NUMBER
      See Also:

    • ERROR_FIELD_NUMBER

      public static final int ERROR_FIELD_NUMBER
      See Also:

    • CONSECUTIVE_FAILURES_FIELD_NUMBER

      public static final int CONSECUTIVE_FAILURES_FIELD_NUMBER
      See Also:

  • Method Details

    • getModuleName

      public String getModuleName()
      string module_name = 1 [json_name = "moduleName"];
      Specified by:
      getModuleName in interface Robot.ModuleStatusOrBuilder
      Returns:
      The moduleName.

    • getModuleNameBytes

      public com.google.protobuf.ByteString getModuleNameBytes()
      string module_name = 1 [json_name = "moduleName"];
      Specified by:
      getModuleNameBytes in interface Robot.ModuleStatusOrBuilder
      Returns:
      The bytes for moduleName.

    • getStateValue

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

    • getState

      public Robot.ModuleStatus.State getState()
      .viam.robot.v1.ModuleStatus.State state = 2 [json_name = "state"];
      Specified by:
      getState in interface Robot.ModuleStatusOrBuilder
      Returns:
      The state.

    • hasLastUpdated

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

    • getLastUpdated

      public com.google.protobuf.Timestamp getLastUpdated()
       updated on every state transition
      .google.protobuf.Timestamp last_updated = 3 [json_name = "lastUpdated"];
      Specified by:
      getLastUpdated in interface Robot.ModuleStatusOrBuilder
      Returns:
      The lastUpdated.

    • getError

      public 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"];
      Specified by:
      getError in interface Robot.ModuleStatusOrBuilder
      Returns:
      The error.

    • getErrorBytes

      public 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"];
      Specified by:
      getErrorBytes in interface Robot.ModuleStatusOrBuilder
      Returns:
      The bytes for error.

    • getConsecutiveFailures

      public 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"];
      Specified by:
      getConsecutiveFailures in interface Robot.ModuleStatusOrBuilder
      Returns:
      The consecutiveFailures.

    • parseFrom

      public static Robot.ModuleStatus parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static Robot.ModuleStatus parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static Robot.ModuleStatus parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilder

      public static Robot.ModuleStatus.Builder newBuilder()

    • newBuilder

      public static Robot.ModuleStatus.Builder newBuilder(Robot.ModuleStatus prototype)

    • dynamicMethod

      protected final Object dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
      Specified by:
      dynamicMethod in class com.google.protobuf.GeneratedMessageLite<Robot.ModuleStatus,Robot.ModuleStatus.Builder>

    • getDefaultInstance

      public static Robot.ModuleStatus getDefaultInstance()

    • parser

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