Viam SDK
    Preparing search index...

    Class PackageStatus

    from message viam.robot.v1.PackageStatus

    Hierarchy

    Index
    bytesDownloaded: bigint

    number of bytes of the package tarball downloaded so far. Only populated while state == STATE_DOWNLOADING; equals total_bytes once the download completes.

    from field: uint64 bytes_downloaded = 7;

    error: string

    human-readable error detail when state == STATE_FAILED

    from field: string error = 4;

    lastUpdated?: Timestamp

    when this status was last updated

    from field: google.protobuf.Timestamp last_updated = 5;

    name: string

    the package name as declared in the robot config (PackageConfig.Name)

    from field: string name = 1;

    current lifecycle state

    from field: viam.robot.v1.PackageStatus.State state = 3;

    totalBytes: bigint

    total size of the package tarball in bytes. Zero if the size is unknown.

    from field: uint64 total_bytes = 8;

    type: PackageType

    the package type (module, ml_model, slam_map, etc.)

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

    version: string

    the version string from PackageConfig

    from field: string version = 6;

    fields: FieldList
    runtime: ProtoRuntime
    typeName: "viam.robot.v1.PackageStatus"
    • 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<robotApi.PackageStatus>

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

    • Parameters

      • jsonString: string
      • Optionaloptions: Partial<JsonReadOptions>

      Returns robotApi.PackageStatus