Class UpdateRegistryItemRequest

Generated

from message viam.app.v1.UpdateRegistryItemRequest

Hierarchy

Constructors

Properties

description: string

Generated

from field: string description = 3;

itemId: string

Generated

from field: string item_id = 1;

metadata: {
    case: "moduleUpdateMetadata";
    value: UpdateModuleMetadata;
} | {
    case: "mlModelUpdateMetadata";
    value: UpdateMLModelMetadata;
} | {
    case: "mlTrainingUpdateMetadata";
    value: UpdateMLTrainingMetadata;
} | {
    case: undefined;
    value?: undefined;
}

Type declaration

  • case: "moduleUpdateMetadata"
  • value: UpdateModuleMetadata

    Generated

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

Type declaration

  • case: "mlModelUpdateMetadata"
  • value: UpdateMLModelMetadata

    Generated

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

Type declaration

  • case: "mlTrainingUpdateMetadata"
  • value: UpdateMLTrainingMetadata

    Generated

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

Type declaration

  • case: undefined
  • Optional value?: undefined

Generated

from oneof viam.app.v1.UpdateRegistryItemRequest.metadata

type: PackageType

Generated

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

url?: string

Generated

from field: optional string url = 5;

visibility: Visibility

Generated

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

fields: FieldList
runtime: ProtoRuntime
typeName: "viam.app.v1.UpdateRegistryItemRequest" = "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
    • Optional options: Partial<BinaryReadOptions>

    Returns this

  • Parse a message from a JSON value.

    Parameters

    • jsonValue: JsonValue
    • Optional options: Partial<JsonReadOptions>

    Returns this

  • Parse a message from a JSON string.

    Parameters

    • jsonString: string
    • Optional options: 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

    • Optional options: Partial<BinaryWriteOptions>

    Returns Uint8Array

  • 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 value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

  • Serialize the message to a JSON string.

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string