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
Modifier and TypeClassDescriptionstatic final class
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
Modifier and TypeFieldDescriptionstatic final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
Fields inherited from class com.google.protobuf.GeneratedMessageLite
unknownFields
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Method Summary
Modifier and TypeMethodDescriptionboolean
containsEnv
(String key) additional environment variables passed to the module processprotected final Object
dynamicMethod
(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1) static Robot.ModuleConfig
getEnv()
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 modulestatic Robot.ModuleConfig.Builder
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
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
PATH_FIELD_NUMBER
public static final int PATH_FIELD_NUMBER- See Also:
-
LOG_LEVEL_FIELD_NUMBER
public static final int LOG_LEVEL_FIELD_NUMBER- See Also:
-
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER- See Also:
-
MODULE_ID_FIELD_NUMBER
public static final int MODULE_ID_FIELD_NUMBER- See Also:
-
ENV_FIELD_NUMBER
public static final int ENV_FIELD_NUMBER- See Also:
-
STATUS_FIELD_NUMBER
public static final int STATUS_FIELD_NUMBER- See Also:
-
FIRST_RUN_TIMEOUT_FIELD_NUMBER
public static final int FIRST_RUN_TIMEOUT_FIELD_NUMBER- See Also:
-
-
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.
-
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.
-
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.
-
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.
-
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.
-
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
-
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
-
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.
-
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.
-
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
- Throws:
IOException
-
parseFrom
public static Robot.ModuleConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- 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
-
newBuilder
-
dynamicMethod
protected final Object dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1) - Specified by:
dynamicMethod
in classcom.google.protobuf.GeneratedMessageLite<Robot.ModuleConfig,
Robot.ModuleConfig.Builder>
-
getDefaultInstance
-
parser
-