Package viam.app.v1

Class Robot.ModuleConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite<Robot.ModuleConfig,Robot.ModuleConfig.Builder>
viam.app.v1.Robot.ModuleConfig
All Implemented Interfaces:
com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, Robot.ModuleConfigOrBuilder
Enclosing class:
Robot
public static final class Robot.ModuleConfig extends com.google.protobuf.GeneratedMessageLite<Robot.ModuleConfig,Robot.ModuleConfig.Builder> implements Robot.ModuleConfigOrBuilder
 ModuleConfig is the configuration for a module.
Protobuf type viam.app.v1.ModuleConfig

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Robot.ModuleConfig.Builder
    ModuleConfig is the configuration for a module.

    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 extends Object>, 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
    ENV_FIELD_NUMBER
     
    static final int
    FIRST_RUN_TIMEOUT_FIELD_NUMBER
     
    static final int
    LOG_LEVEL_FIELD_NUMBER
     
    static final int
    MODULE_ID_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    PATH_FIELD_NUMBER
     
    static final int
    STATUS_FIELD_NUMBER
     
    static final int
    TCP_MODE_FIELD_NUMBER
     
    static final int
    TYPE_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
    boolean
    containsEnv(String key)
    additional environment variables passed to the module process
    protected final Object
    dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
     
    static Robot.ModuleConfig
    getDefaultInstance()
     
    Map<String,String>
    getEnv()
    Deprecated.
    int
    getEnvCount()
    additional environment variables passed to the module process
    Map<String,String>
    getEnvMap()
    additional environment variables passed to the module process
    String
    getEnvOrDefault(String key, String defaultValue)
    additional environment variables passed to the module process
    String
    getEnvOrThrow(String key)
    additional environment variables passed to the module process
    com.google.protobuf.Duration
    getFirstRunTimeout()
    timeout for first_run script
    String
    getLogLevel()
    log level for module
    com.google.protobuf.ByteString
    getLogLevelBytes()
    log level for module
    String
    getModuleId()
    the id of the module if it is a registry module
    com.google.protobuf.ByteString
    getModuleIdBytes()
    the id of the module if it is a registry module
    String
    getName()
    string name = 1 [json_name = "name"];
    com.google.protobuf.ByteString
    getNameBytes()
    string name = 1 [json_name = "name"];
    String
    getPath()
    path to the executable
    com.google.protobuf.ByteString
    getPathBytes()
    path to the executable
    Robot.AppValidationStatus
    getStatus()
    info about the validity of the module
    boolean
    getTcpMode()
    whether we are starting a module in TCP mode
    String
    getType()
    type of the module ("local" or "registry")
    com.google.protobuf.ByteString
    getTypeBytes()
    type of the module ("local" or "registry")
    boolean
    hasFirstRunTimeout()
    timeout for first_run script
    boolean
    hasStatus()
    info about the validity of the module
    static Robot.ModuleConfig.Builder
    newBuilder()
     
    static Robot.ModuleConfig.Builder
    newBuilder(Robot.ModuleConfig prototype)
     
    static Robot.ModuleConfig
    parseDelimitedFrom(InputStream input)
     
    static Robot.ModuleConfig
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Robot.ModuleConfig
    parseFrom(byte[] data)
     
    static Robot.ModuleConfig
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Robot.ModuleConfig
    parseFrom(com.google.protobuf.ByteString data)
     
    static Robot.ModuleConfig
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Robot.ModuleConfig
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Robot.ModuleConfig
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Robot.ModuleConfig
    parseFrom(InputStream input)
     
    static Robot.ModuleConfig
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Robot.ModuleConfig
    parseFrom(ByteBuffer data)
     
    static Robot.ModuleConfig
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Robot.ModuleConfig>
    parser()
     

    Methods inherited from class com.google.protobuf.GeneratedMessageLite

    createBuilder, createBuilder, dynamicMethod, dynamicMethod, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstanceForType, getParserForType, getSerializedSize, hashCode, isInitialized, 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

  • Method Details

    • getName

      public String getName()
      string name = 1 [json_name = "name"];
      Specified by:
      getName in interface Robot.ModuleConfigOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
      string name = 1 [json_name = "name"];
      Specified by:
      getNameBytes in interface Robot.ModuleConfigOrBuilder
      Returns:
      The bytes for name.

    • getPath

      public String getPath()
       path to the executable
      string path = 2 [json_name = "path"];
      Specified by:
      getPath in interface Robot.ModuleConfigOrBuilder
      Returns:
      The path.

    • getPathBytes

      public com.google.protobuf.ByteString getPathBytes()
       path to the executable
      string path = 2 [json_name = "path"];
      Specified by:
      getPathBytes in interface Robot.ModuleConfigOrBuilder
      Returns:
      The bytes for path.

    • getLogLevel

      public String getLogLevel()
       log level for module
      string log_level = 3 [json_name = "logLevel"];
      Specified by:
      getLogLevel in interface Robot.ModuleConfigOrBuilder
      Returns:
      The logLevel.

    • getLogLevelBytes

      public com.google.protobuf.ByteString getLogLevelBytes()
       log level for module
      string log_level = 3 [json_name = "logLevel"];
      Specified by:
      getLogLevelBytes in interface Robot.ModuleConfigOrBuilder
      Returns:
      The bytes for logLevel.

    • getType

      public String getType()
       type of the module ("local" or "registry")
      string type = 4 [json_name = "type"];
      Specified by:
      getType in interface Robot.ModuleConfigOrBuilder
      Returns:
      The type.

    • getTypeBytes

      public com.google.protobuf.ByteString getTypeBytes()
       type of the module ("local" or "registry")
      string type = 4 [json_name = "type"];
      Specified by:
      getTypeBytes in interface Robot.ModuleConfigOrBuilder
      Returns:
      The bytes for type.

    • getModuleId

      public String getModuleId()
       the id of the module if it is a registry module
      string module_id = 5 [json_name = "moduleId"];
      Specified by:
      getModuleId in interface Robot.ModuleConfigOrBuilder
      Returns:
      The moduleId.

    • getModuleIdBytes

      public com.google.protobuf.ByteString getModuleIdBytes()
       the id of the module if it is a registry module
      string module_id = 5 [json_name = "moduleId"];
      Specified by:
      getModuleIdBytes in interface Robot.ModuleConfigOrBuilder
      Returns:
      The bytes for moduleId.

    • getEnvCount

      public int getEnvCount()
      Description copied from interface: Robot.ModuleConfigOrBuilder
       additional environment variables passed to the module process
      map<string, string> env = 6 [json_name = "env"];
      Specified by:
      getEnvCount in interface Robot.ModuleConfigOrBuilder

    • containsEnv

      public boolean containsEnv(String key)
       additional environment variables passed to the module process
      map<string, string> env = 6 [json_name = "env"];
      Specified by:
      containsEnv in interface Robot.ModuleConfigOrBuilder

    • getEnv

      @Deprecated public Map<String,String> getEnv()
      Deprecated.
      Use getEnvMap() instead.
      Specified by:
      getEnv in interface Robot.ModuleConfigOrBuilder

    • getEnvMap

      public Map<String,String> getEnvMap()
       additional environment variables passed to the module process
      map<string, string> env = 6 [json_name = "env"];
      Specified by:
      getEnvMap in interface Robot.ModuleConfigOrBuilder

    • getEnvOrDefault

      public String getEnvOrDefault(String key, String defaultValue)
       additional environment variables passed to the module process
      map<string, string> env = 6 [json_name = "env"];
      Specified by:
      getEnvOrDefault in interface Robot.ModuleConfigOrBuilder

    • getEnvOrThrow

      public String getEnvOrThrow(String key)
       additional environment variables passed to the module process
      map<string, string> env = 6 [json_name = "env"];
      Specified by:
      getEnvOrThrow in interface Robot.ModuleConfigOrBuilder

    • hasStatus

      public boolean hasStatus()
       info about the validity of the module
      .viam.app.v1.AppValidationStatus status = 7 [json_name = "status"];
      Specified by:
      hasStatus in interface Robot.ModuleConfigOrBuilder
      Returns:
      Whether the status field is set.

    • getStatus

      public Robot.AppValidationStatus getStatus()
       info about the validity of the module
      .viam.app.v1.AppValidationStatus status = 7 [json_name = "status"];
      Specified by:
      getStatus in interface Robot.ModuleConfigOrBuilder
      Returns:
      The status.

    • hasFirstRunTimeout

      public boolean hasFirstRunTimeout()
       timeout for first_run script
      .google.protobuf.Duration first_run_timeout = 8 [json_name = "firstRunTimeout"];
      Specified by:
      hasFirstRunTimeout in interface Robot.ModuleConfigOrBuilder
      Returns:
      Whether the firstRunTimeout field is set.

    • getFirstRunTimeout

      public com.google.protobuf.Duration getFirstRunTimeout()
       timeout for first_run script
      .google.protobuf.Duration first_run_timeout = 8 [json_name = "firstRunTimeout"];
      Specified by:
      getFirstRunTimeout in interface Robot.ModuleConfigOrBuilder
      Returns:
      The firstRunTimeout.

    • getTcpMode

      public boolean getTcpMode()
       whether we are starting a module in TCP mode
      bool tcp_mode = 9 [json_name = "tcpMode"];
      Specified by:
      getTcpMode in interface Robot.ModuleConfigOrBuilder
      Returns:
      The tcpMode.

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static Robot.ModuleConfig 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.ModuleConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilder

      public static Robot.ModuleConfig.Builder newBuilder()

    • newBuilder

      public static Robot.ModuleConfig.Builder newBuilder(Robot.ModuleConfig 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.ModuleConfig,Robot.ModuleConfig.Builder>

    • getDefaultInstance

      public static Robot.ModuleConfig getDefaultInstance()

    • parser

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