Package viam.app.v1
Class Robot.ModuleConfig.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite.Builder<Robot.ModuleConfig,Robot.ModuleConfig.Builder>
viam.app.v1.Robot.ModuleConfig.Builder
- All Implemented Interfaces:
com.google.protobuf.MessageLite.Builder
,com.google.protobuf.MessageLiteOrBuilder
,Cloneable
,Robot.ModuleConfigOrBuilder
- Enclosing class:
- Robot.ModuleConfig
public static final class Robot.ModuleConfig.Builder
extends com.google.protobuf.GeneratedMessageLite.Builder<Robot.ModuleConfig,Robot.ModuleConfig.Builder>
implements Robot.ModuleConfigOrBuilder
ModuleConfig is the configuration for a module.Protobuf type
viam.app.v1.ModuleConfig
-
Field Summary
Fields inherited from class com.google.protobuf.GeneratedMessageLite.Builder
instance
-
Method Summary
Modifier and TypeMethodDescriptionclearEnv()
timeout for first_run scriptlog level for modulethe id of the module if it is a registry modulestring name = 1 [json_name = "name"];
path to the executableinfo about the validity of the moduletype of the module ("local" or "registry")boolean
containsEnv
(String key) additional environment variables passed to the module processgetEnv()
Deprecated.int
additional environment variables passed to the module processadditional environment variables passed to the module processgetEnvOrDefault
(String key, String defaultValue) additional environment variables passed to the module processgetEnvOrThrow
(String key) additional environment variables passed to the module processcom.google.protobuf.Duration
timeout for first_run scriptlog level for modulecom.google.protobuf.ByteString
log level for modulethe id of the module if it is a registry modulecom.google.protobuf.ByteString
the id of the module if it is a registry modulegetName()
string name = 1 [json_name = "name"];
com.google.protobuf.ByteString
string name = 1 [json_name = "name"];
getPath()
path to the executablecom.google.protobuf.ByteString
path to the executableinfo about the validity of the modulegetType()
type of the module ("local" or "registry")com.google.protobuf.ByteString
type of the module ("local" or "registry")boolean
timeout for first_run scriptboolean
info about the validity of the modulemergeFirstRunTimeout
(com.google.protobuf.Duration value) timeout for first_run scriptinfo about the validity of the moduleadditional environment variables passed to the module processadditional environment variables passed to the module processadditional environment variables passed to the module processsetFirstRunTimeout
(com.google.protobuf.Duration value) timeout for first_run scriptsetFirstRunTimeout
(com.google.protobuf.Duration.Builder builderForValue) timeout for first_run scriptsetLogLevel
(String value) log level for modulesetLogLevelBytes
(com.google.protobuf.ByteString value) log level for modulesetModuleId
(String value) the id of the module if it is a registry modulesetModuleIdBytes
(com.google.protobuf.ByteString value) the id of the module if it is a registry modulestring name = 1 [json_name = "name"];
setNameBytes
(com.google.protobuf.ByteString value) string name = 1 [json_name = "name"];
path to the executablesetPathBytes
(com.google.protobuf.ByteString value) path to the executableinfo about the validity of the modulesetStatus
(Robot.AppValidationStatus.Builder builderForValue) info about the validity of the moduletype of the module ("local" or "registry")setTypeBytes
(com.google.protobuf.ByteString value) type of the module ("local" or "registry")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
-
getName
string name = 1 [json_name = "name"];
- Specified by:
getName
in interfaceRobot.ModuleConfigOrBuilder
- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.ByteString getNameBytes()string name = 1 [json_name = "name"];
- Specified by:
getNameBytes
in interfaceRobot.ModuleConfigOrBuilder
- Returns:
- The bytes for name.
-
setName
string name = 1 [json_name = "name"];
- Parameters:
value
- The name to set.- Returns:
- This builder for chaining.
-
clearName
string name = 1 [json_name = "name"];
- Returns:
- This builder for chaining.
-
setNameBytes
string name = 1 [json_name = "name"];
- Parameters:
value
- The bytes for name to set.- Returns:
- This builder for chaining.
-
getPath
path to the executable
string path = 2 [json_name = "path"];
- Specified by:
getPath
in interfaceRobot.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 interfaceRobot.ModuleConfigOrBuilder
- Returns:
- The bytes for path.
-
setPath
path to the executable
string path = 2 [json_name = "path"];
- Parameters:
value
- The path to set.- Returns:
- This builder for chaining.
-
clearPath
path to the executable
string path = 2 [json_name = "path"];
- Returns:
- This builder for chaining.
-
setPathBytes
path to the executable
string path = 2 [json_name = "path"];
- Parameters:
value
- The bytes for path to set.- Returns:
- This builder for chaining.
-
getLogLevel
log level for module
string log_level = 3 [json_name = "logLevel"];
- Specified by:
getLogLevel
in interfaceRobot.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 interfaceRobot.ModuleConfigOrBuilder
- Returns:
- The bytes for logLevel.
-
setLogLevel
log level for module
string log_level = 3 [json_name = "logLevel"];
- Parameters:
value
- The logLevel to set.- Returns:
- This builder for chaining.
-
clearLogLevel
log level for module
string log_level = 3 [json_name = "logLevel"];
- Returns:
- This builder for chaining.
-
setLogLevelBytes
log level for module
string log_level = 3 [json_name = "logLevel"];
- Parameters:
value
- The bytes for logLevel to set.- Returns:
- This builder for chaining.
-
getType
type of the module ("local" or "registry")
string type = 4 [json_name = "type"];
- Specified by:
getType
in interfaceRobot.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 interfaceRobot.ModuleConfigOrBuilder
- Returns:
- The bytes for type.
-
setType
type of the module ("local" or "registry")
string type = 4 [json_name = "type"];
- Parameters:
value
- The type to set.- Returns:
- This builder for chaining.
-
clearType
type of the module ("local" or "registry")
string type = 4 [json_name = "type"];
- Returns:
- This builder for chaining.
-
setTypeBytes
type of the module ("local" or "registry")
string type = 4 [json_name = "type"];
- Parameters:
value
- The bytes for type to set.- Returns:
- This builder for chaining.
-
getModuleId
the id of the module if it is a registry module
string module_id = 5 [json_name = "moduleId"];
- Specified by:
getModuleId
in interfaceRobot.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 interfaceRobot.ModuleConfigOrBuilder
- Returns:
- The bytes for moduleId.
-
setModuleId
the id of the module if it is a registry module
string module_id = 5 [json_name = "moduleId"];
- Parameters:
value
- The moduleId to set.- Returns:
- This builder for chaining.
-
clearModuleId
the id of the module if it is a registry module
string module_id = 5 [json_name = "moduleId"];
- Returns:
- This builder for chaining.
-
setModuleIdBytes
the id of the module if it is a registry module
string module_id = 5 [json_name = "moduleId"];
- Parameters:
value
- The bytes for moduleId to set.- Returns:
- This builder for chaining.
-
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 interfaceRobot.ModuleConfigOrBuilder
-
containsEnv
additional environment variables passed to the module process
map<string, string> env = 6 [json_name = "env"];
- Specified by:
containsEnv
in interfaceRobot.ModuleConfigOrBuilder
-
clearEnv
-
removeEnv
additional environment variables passed to the module process
map<string, string> env = 6 [json_name = "env"];
-
getEnv
Deprecated.UsegetEnvMap()
instead.- Specified by:
getEnv
in interfaceRobot.ModuleConfigOrBuilder
-
getEnvMap
additional environment variables passed to the module process
map<string, string> env = 6 [json_name = "env"];
- Specified by:
getEnvMap
in interfaceRobot.ModuleConfigOrBuilder
-
getEnvOrDefault
additional environment variables passed to the module process
map<string, string> env = 6 [json_name = "env"];
- Specified by:
getEnvOrDefault
in interfaceRobot.ModuleConfigOrBuilder
-
getEnvOrThrow
additional environment variables passed to the module process
map<string, string> env = 6 [json_name = "env"];
- Specified by:
getEnvOrThrow
in interfaceRobot.ModuleConfigOrBuilder
-
putEnv
additional environment variables passed to the module process
map<string, string> env = 6 [json_name = "env"];
-
putAllEnv
additional environment variables passed to the module process
map<string, string> env = 6 [json_name = "env"];
-
hasStatus
public boolean hasStatus()info about the validity of the module
.viam.app.v1.AppValidationStatus status = 7 [json_name = "status"];
- Specified by:
hasStatus
in interfaceRobot.ModuleConfigOrBuilder
- Returns:
- Whether the status field is set.
-
getStatus
info about the validity of the module
.viam.app.v1.AppValidationStatus status = 7 [json_name = "status"];
- Specified by:
getStatus
in interfaceRobot.ModuleConfigOrBuilder
- Returns:
- The status.
-
setStatus
info about the validity of the module
.viam.app.v1.AppValidationStatus status = 7 [json_name = "status"];
-
setStatus
info about the validity of the module
.viam.app.v1.AppValidationStatus status = 7 [json_name = "status"];
-
mergeStatus
info about the validity of the module
.viam.app.v1.AppValidationStatus status = 7 [json_name = "status"];
-
clearStatus
info about the validity of the module
.viam.app.v1.AppValidationStatus status = 7 [json_name = "status"];
-
hasFirstRunTimeout
public boolean hasFirstRunTimeout()timeout for first_run script
.google.protobuf.Duration first_run_timeout = 8 [json_name = "firstRunTimeout"];
- Specified by:
hasFirstRunTimeout
in interfaceRobot.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 interfaceRobot.ModuleConfigOrBuilder
- Returns:
- The firstRunTimeout.
-
setFirstRunTimeout
timeout for first_run script
.google.protobuf.Duration first_run_timeout = 8 [json_name = "firstRunTimeout"];
-
setFirstRunTimeout
public Robot.ModuleConfig.Builder setFirstRunTimeout(com.google.protobuf.Duration.Builder builderForValue) timeout for first_run script
.google.protobuf.Duration first_run_timeout = 8 [json_name = "firstRunTimeout"];
-
mergeFirstRunTimeout
timeout for first_run script
.google.protobuf.Duration first_run_timeout = 8 [json_name = "firstRunTimeout"];
-
clearFirstRunTimeout
timeout for first_run script
.google.protobuf.Duration first_run_timeout = 8 [json_name = "firstRunTimeout"];
-