A short description of the module that explains its purpose
from field: string description = 6;
The executable to run to start the module program
from field: string entrypoint = 11;
Optional firstThe path to a setup script that is run before a newly downloaded module starts.
from field: optional string first_run = 13;
A list of models that are available in the module
from field: repeated viam.app.v1.Model models = 7;
The id of the module (formatted as prefix:name where prefix is the module owner's orgid or namespace)
from field: string module_id = 1;
The name of the module
from field: string name = 2;
The id of the organization that owns the module
from field: string organization_id = 10;
The public namespace of the organization that owns the module This is empty if no public namespace is set
from field: string public_namespace = 12;
The total number of organizations using this module
from field: int64 total_organization_usage = 9;
The total number of robots using this module
from field: int64 total_robot_usage = 8;
The url to reference for documentation, code, etc.
from field: string url = 5;
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
from field: repeated viam.app.v1.VersionHistory versions = 4;
The visibility of the module
from field: viam.app.v1.Visibility visibility = 3;
Static Readonly fieldsStatic Readonly runtimeStatic Readonly typeCompare 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.
Optional options: Partial<BinaryReadOptions>Parse a message from a JSON value.
Optional options: Partial<JsonReadOptions>Protected toJSONOverride 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.
Static equalsStatic fromStatic fromStatic fromGenerated using TypeDoc
Generated
from message viam.app.v1.Module