Optional
data: PartialMessage<RegistryItem>Optional
createdWhen the item was created
from field: google.protobuf.Timestamp created_at = 15;
A short description of the item that explains its purpose
from field: string description = 8;
The id of the item, containing either: namespace:item_name when a namespace exists on the org. org_id:item_name when a namespace does not exist.
from field: string item_id = 1;
Type-specific metadata
from field: viam.app.v1.ModuleMetadata module_metadata = 11;
from field: viam.app.v1.MLModelMetadata ml_model_metadata = 12;
from field: viam.app.v1.MLTrainingMetadata ml_training_metadata = 18;
Optional
value?: undefinedfrom oneof viam.app.v1.RegistryItem.metadata
The name of the registry item
from field: string name = 4;
The id of the organization that owns the item
from field: string organization_id = 2;
The public namespace of the organization that owns the module This is empty if no public namespace is set
from field: string public_namespace = 3;
The total number of organizations using this item outside of the owning org
from field: int64 total_external_organization_usage = 14;
The total number of robots using this item outside of the owning org
from field: int64 total_external_robot_usage = 13;
The total number of organizations using this item
from field: int64 total_organization_usage = 10;
The total number of robots using this item
from field: int64 total_robot_usage = 9;
The type of the item in the registry
from field: viam.app.packages.v1.PackageType type = 5;
Optional
updatedWhen the item was last updated, either through an update or upload.
from field: google.protobuf.Timestamp updated_at = 16;
The url to reference for documentation, code, etc.
from field: string url = 7;
The visibility of the registry item
from field: viam.app.v1.Visibility visibility = 6;
Static
Readonly
fieldsStatic
Readonly
runtimeStatic
Readonly
typeCreate 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.
Optional
options: Partial<BinaryReadOptions>Parse a message from a JSON value.
Optional
options: Partial<JsonReadOptions>Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.
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
fromOptional
options: Partial<BinaryReadOptions>Static
fromOptional
options: Partial<JsonReadOptions>Static
fromOptional
options: Partial<JsonReadOptions>
Generated
from message viam.app.v1.RegistryItem