Class RegistryItem

from message viam.app.v1.RegistryItem

Hierarchy

Constructors

Properties

createdAt?: Timestamp

When the item was created

from field: google.protobuf.Timestamp created_at = 15;

description: string

A short description of the item that explains its purpose

from field: string description = 8;

itemId: string

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;

metadata:
    | { case: "moduleMetadata"; value: ModuleMetadata }
    | { case: "mlModelMetadata"; value: MLModelMetadata }
    | { case: "mlTrainingMetadata"; value: MLTrainingMetadata }
    | { case: undefined; value?: undefined }

Type-specific metadata

Type declaration

  • { case: "moduleMetadata"; value: ModuleMetadata }
    • case: "moduleMetadata"
    • value: ModuleMetadata

      from field: viam.app.v1.ModuleMetadata module_metadata = 11;

  • { case: "mlModelMetadata"; value: MLModelMetadata }
    • case: "mlModelMetadata"
    • value: MLModelMetadata

      from field: viam.app.v1.MLModelMetadata ml_model_metadata = 12;

  • { case: "mlTrainingMetadata"; value: MLTrainingMetadata }
    • case: "mlTrainingMetadata"
    • value: MLTrainingMetadata

      from field: viam.app.v1.MLTrainingMetadata ml_training_metadata = 18;

  • { case: undefined; value?: undefined }

from oneof viam.app.v1.RegistryItem.metadata

name: string

The name of the registry item

from field: string name = 4;

organizationId: string

The id of the organization that owns the item

from field: string organization_id = 2;

publicNamespace: string

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;

totalExternalOrganizationUsage: bigint

The total number of organizations using this item outside of the owning org

from field: int64 total_external_organization_usage = 14;

totalExternalRobotUsage: bigint

The total number of robots using this item outside of the owning org

from field: int64 total_external_robot_usage = 13;

totalOrganizationUsage: bigint

The total number of organizations using this item

from field: int64 total_organization_usage = 10;

totalRobotUsage: bigint

The total number of robots using this item

from field: int64 total_robot_usage = 9;

type: PackageType

The type of the item in the registry

from field: viam.app.packages.v1.PackageType type = 5;

updatedAt?: Timestamp

When the item was last updated, either through an update or upload.

from field: google.protobuf.Timestamp updated_at = 16;

url: string

The url to reference for documentation, code, etc.

from field: string url = 7;

visibility: Visibility

The visibility of the registry item

from field: viam.app.v1.Visibility visibility = 6;

fields: FieldList
runtime: ProtoRuntime
typeName: "viam.app.v1.RegistryItem"

Methods

  • 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.

    Parameters

    • bytes: Uint8Array
    • Optionaloptions: Partial<BinaryReadOptions>

    Returns this

  • Parse a message from a JSON value.

    Parameters

    • jsonValue: JsonValue
    • Optionaloptions: Partial<JsonReadOptions>

    Returns this

  • Parse a message from a JSON string.

    Parameters

    • jsonString: string
    • Optionaloptions: Partial<JsonReadOptions>

    Returns this

  • Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.

    Returns MessageType<RegistryItem>

  • Serialize the message to binary data.

    Parameters

    • Optionaloptions: Partial<BinaryWriteOptions>

    Returns Uint8Array

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optionaloptions: Partial<JsonWriteOptions>

    Returns JsonValue

  • Override 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.

    Returns JsonValue

  • Serialize the message to a JSON string.

    Parameters

    • Optionaloptions: Partial<JsonWriteStringOptions>

    Returns string

  • Parameters

    • bytes: Uint8Array
    • Optionaloptions: Partial<BinaryReadOptions>

    Returns RegistryItem

  • Parameters

    • jsonString: string
    • Optionaloptions: Partial<JsonReadOptions>

    Returns RegistryItem

MMNEPVFCICPMFPCPTTAAATR