Package viam.app.v1

Interface Robot.ModuleConfigOrBuilder

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

  • Method Details

    • getName

      String getName()
      string name = 1 [json_name = "name"];
      Returns:
      The name.

    • getNameBytes

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

    • getPath

      String getPath()
       path to the executable
      string path = 2 [json_name = "path"];
      Returns:
      The path.

    • getPathBytes

      com.google.protobuf.ByteString getPathBytes()
       path to the executable
      string path = 2 [json_name = "path"];
      Returns:
      The bytes for path.

    • getLogLevel

      String getLogLevel()
       log level for module
      string log_level = 3 [json_name = "logLevel"];
      Returns:
      The logLevel.

    • getLogLevelBytes

      com.google.protobuf.ByteString getLogLevelBytes()
       log level for module
      string log_level = 3 [json_name = "logLevel"];
      Returns:
      The bytes for logLevel.

    • getType

      String getType()
       type of the module ("local" or "registry")
      string type = 4 [json_name = "type"];
      Returns:
      The type.

    • getTypeBytes

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

    • getModuleId

      String getModuleId()
       the id of the module if it is a registry module
      string module_id = 5 [json_name = "moduleId"];
      Returns:
      The moduleId.

    • getModuleIdBytes

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

    • getEnvCount

      int getEnvCount()
       additional environment variables passed to the module process
      map<string, string> env = 6 [json_name = "env"];

    • containsEnv

      boolean containsEnv(String key)
       additional environment variables passed to the module process
      map<string, string> env = 6 [json_name = "env"];

    • getEnv

      @Deprecated Map<String,String> getEnv()
      Deprecated.
      Use getEnvMap() instead.

    • getEnvMap

      Map<String,String> getEnvMap()
       additional environment variables passed to the module process
      map<string, string> env = 6 [json_name = "env"];

    • getEnvOrDefault

      String getEnvOrDefault(String key, String defaultValue)
       additional environment variables passed to the module process
      map<string, string> env = 6 [json_name = "env"];

    • getEnvOrThrow

      String getEnvOrThrow(String key)
       additional environment variables passed to the module process
      map<string, string> env = 6 [json_name = "env"];

    • hasStatus

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

    • getStatus

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

    • hasFirstRunTimeout

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

    • getFirstRunTimeout

      com.google.protobuf.Duration getFirstRunTimeout()
       timeout for first_run script
      .google.protobuf.Duration first_run_timeout = 8 [json_name = "firstRunTimeout"];
      Returns:
      The firstRunTimeout.