A list of applications associated with the module
OptionaldeprecatedDeprecated status of an individual module
A short description of the module that explains its purpose
The executable to run to start the module program
OptionalfirstThe path to a setup script that is run before a newly downloaded module starts.
OptionalmarkdownLonger documentation provided in markdown format
A list of models that are available in the module
The id of the module (formatted as prefix:name where prefix is the module owner's orgid or namespace)
The name of the module
The id of the organization that owns the module
The public namespace of the organization that owns the module This is empty if no public namespace is set
The total number of organizations using this module
The total number of robots using this module
The url to reference for documentation, code, etc.
The versions of the module that are available When this is returned from the backend, the versions are sorted in ascending order by the semver version
The visibility of the module
Static ReadonlyfieldsStatic ReadonlyruntimeStatic ReadonlytypeCreate a deep copy.
Compare with a message of the same type. Note that this function disregards extensions and unknown fields.
Parse from binary data, merging fields.
Repeated fields are appended. Map entries are added, overwriting existing keys.
If a message field is already present, it will be merged with the new data.
Optionaloptions: Partial<BinaryReadOptions>Parse a message from a JSON value.
Optionaloptions: Partial<JsonReadOptions>Parse a message from a JSON string.
Optionaloptions: Partial<JsonReadOptions>Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.
Serialize the message to binary data.
Optionaloptions: Partial<BinaryWriteOptions>Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().
Optionaloptions: Partial<JsonWriteOptions>ProtectedtoOverride for serialization behavior. This will be invoked when calling JSON.stringify on this message (i.e. JSON.stringify(msg)).
Note that this will not serialize google.protobuf.Any with a packed message because the protobuf JSON format specifies that it needs to be unpacked, and this is only possible with a type registry to look up the message type. As a result, attempting to serialize a message with this type will throw an Error.
This method is protected because you should not need to invoke it directly -- instead use JSON.stringify or toJsonString for stringified JSON. Alternatively, if actual JSON is desired, you should use toJson.
Serialize the message to a JSON string.
Optionaloptions: Partial<JsonWriteStringOptions>StaticequalsStaticfromOptionaloptions: Partial<BinaryReadOptions>StaticfromStaticfromOptionaloptions: Partial<JsonReadOptions>
Generated
from message viam.app.v1.Module