Package com.viam.robot.v1

Class Robot.ModuleStatus.Builder

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

  • Field Summary

    Fields inherited from class com.google.protobuf.GeneratedMessageLite.Builder

    instance

  • Method Summary

    Modifier and Type
    Method
    Description
    Robot.ModuleStatus.Builder
    clearConsecutiveFailures()
    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.
    Robot.ModuleStatus.Builder
    clearError()
    when a module transitions to unhealthy, this field is populated with the error that caused the transition.
    Robot.ModuleStatus.Builder
    clearLastUpdated()
    updated on every state transition
    Robot.ModuleStatus.Builder
    clearModuleName()
    string module_name = 1 [json_name = "moduleName"];
    Robot.ModuleStatus.Builder
    clearState()
    .viam.robot.v1.ModuleStatus.State state = 2 [json_name = "state"];
    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
    Robot.ModuleStatus.Builder
    mergeLastUpdated(com.google.protobuf.Timestamp value)
    updated on every state transition
    Robot.ModuleStatus.Builder
    setConsecutiveFailures(int value)
    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.
    Robot.ModuleStatus.Builder
    setError(String value)
    when a module transitions to unhealthy, this field is populated with the error that caused the transition.
    Robot.ModuleStatus.Builder
    setErrorBytes(com.google.protobuf.ByteString value)
    when a module transitions to unhealthy, this field is populated with the error that caused the transition.
    Robot.ModuleStatus.Builder
    setLastUpdated(com.google.protobuf.Timestamp value)
    updated on every state transition
    Robot.ModuleStatus.Builder
    setLastUpdated(com.google.protobuf.Timestamp.Builder builderForValue)
    updated on every state transition
    Robot.ModuleStatus.Builder
    setModuleName(String value)
    string module_name = 1 [json_name = "moduleName"];
    Robot.ModuleStatus.Builder
    setModuleNameBytes(com.google.protobuf.ByteString value)
    string module_name = 1 [json_name = "moduleName"];
    Robot.ModuleStatus.Builder
    setState(Robot.ModuleStatus.State value)
    .viam.robot.v1.ModuleStatus.State state = 2 [json_name = "state"];
    Robot.ModuleStatus.Builder
    setStateValue(int value)
    .viam.robot.v1.ModuleStatus.State state = 2 [json_name = "state"];

    Methods inherited from class com.google.protobuf.GeneratedMessageLite.Builder

    build, buildPartial, clear, clone, copyOnWrite, copyOnWriteInternal, getDefaultInstanceForType, internalMergeFrom, isInitialized, mergeFrom, mergeFrom, mergeFrom, mergeFrom

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • 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.

    • setModuleName

      public Robot.ModuleStatus.Builder setModuleName(String value)
      string module_name = 1 [json_name = "moduleName"];
      Parameters:
      value - The moduleName to set.
      Returns:
      This builder for chaining.

    • clearModuleName

      public Robot.ModuleStatus.Builder clearModuleName()
      string module_name = 1 [json_name = "moduleName"];
      Returns:
      This builder for chaining.

    • setModuleNameBytes

      public Robot.ModuleStatus.Builder setModuleNameBytes(com.google.protobuf.ByteString value)
      string module_name = 1 [json_name = "moduleName"];
      Parameters:
      value - The bytes for moduleName to set.
      Returns:
      This builder for chaining.

    • 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.

    • setStateValue

      public Robot.ModuleStatus.Builder setStateValue(int value)
      .viam.robot.v1.ModuleStatus.State state = 2 [json_name = "state"];
      Parameters:
      value - The state to set.
      Returns:
      This builder for chaining.

    • 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.

    • setState

      public Robot.ModuleStatus.Builder setState(Robot.ModuleStatus.State value)
      .viam.robot.v1.ModuleStatus.State state = 2 [json_name = "state"];
      Parameters:
      value - The enum numeric value on the wire for state to set.
      Returns:
      This builder for chaining.
      Throws:
      IllegalArgumentException - if UNRECOGNIZED is provided.

    • clearState

      public Robot.ModuleStatus.Builder clearState()
      .viam.robot.v1.ModuleStatus.State state = 2 [json_name = "state"];
      Returns:
      This builder for chaining.

    • 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.

    • setLastUpdated

      public Robot.ModuleStatus.Builder setLastUpdated(com.google.protobuf.Timestamp value)
       updated on every state transition
      .google.protobuf.Timestamp last_updated = 3 [json_name = "lastUpdated"];

    • setLastUpdated

      public Robot.ModuleStatus.Builder setLastUpdated(com.google.protobuf.Timestamp.Builder builderForValue)
       updated on every state transition
      .google.protobuf.Timestamp last_updated = 3 [json_name = "lastUpdated"];

    • mergeLastUpdated

      public Robot.ModuleStatus.Builder mergeLastUpdated(com.google.protobuf.Timestamp value)
       updated on every state transition
      .google.protobuf.Timestamp last_updated = 3 [json_name = "lastUpdated"];

    • clearLastUpdated

      public Robot.ModuleStatus.Builder clearLastUpdated()
       updated on every state transition
      .google.protobuf.Timestamp last_updated = 3 [json_name = "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.

    • setError

      public Robot.ModuleStatus.Builder setError(String value)
       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"];
      Parameters:
      value - The error to set.
      Returns:
      This builder for chaining.

    • clearError

      public Robot.ModuleStatus.Builder clearError()
       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:
      This builder for chaining.

    • setErrorBytes

      public Robot.ModuleStatus.Builder setErrorBytes(com.google.protobuf.ByteString value)
       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"];
      Parameters:
      value - The bytes for error to set.
      Returns:
      This builder for chaining.

    • 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.

    • setConsecutiveFailures

      public Robot.ModuleStatus.Builder setConsecutiveFailures(int value)
       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"];
      Parameters:
      value - The consecutiveFailures to set.
      Returns:
      This builder for chaining.

    • clearConsecutiveFailures

      public Robot.ModuleStatus.Builder clearConsecutiveFailures()
       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:
      This builder for chaining.