Class UpdateRegistryItemRequest

from message viam.app.v1.UpdateRegistryItemRequest

Hierarchy

Constructors

Properties

description: string

from field: string description = 3;

itemId: string

from field: string item_id = 1;

markdownDescription?: string

from field: optional string markdown_description = 9;

metadata:
    | { case: "updateModuleMetadata"; value: UpdateModuleMetadata }
    | { case: "updateMlModelMetadata"; value: UpdateMLModelMetadata }
    | { case: "updateMlTrainingMetadata"; value: UpdateMLTrainingMetadata }
    | { case: undefined; value?: undefined }

Type declaration

  • { case: "updateModuleMetadata"; value: UpdateModuleMetadata }
    • case: "updateModuleMetadata"
    • value: UpdateModuleMetadata

      from field: viam.app.v1.UpdateModuleMetadata update_module_metadata = 6;

  • { case: "updateMlModelMetadata"; value: UpdateMLModelMetadata }
    • case: "updateMlModelMetadata"
    • value: UpdateMLModelMetadata

      from field: viam.app.v1.UpdateMLModelMetadata update_ml_model_metadata = 7;

  • { case: "updateMlTrainingMetadata"; value: UpdateMLTrainingMetadata }
    • case: "updateMlTrainingMetadata"
    • value: UpdateMLTrainingMetadata

      from field: viam.app.v1.UpdateMLTrainingMetadata update_ml_training_metadata = 8;

  • { case: undefined; value?: undefined }

from oneof viam.app.v1.UpdateRegistryItemRequest.metadata

type: PackageType

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

url?: string

from field: optional string url = 5;

visibility: Visibility

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

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

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<UpdateRegistryItemRequest>

  • 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

MMNEPVFCICPMFPCPTTAAATR