Viam SDK
    Preparing search index...

    Class UpdateModuleRequest

    from message viam.app.v1.UpdateModuleRequest

    Hierarchy

    Index

    Constructors

    Properties

    apps: App[]

    A list of applications associated with the module

    from field: repeated viam.app.v1.App apps = 8;

    description: string

    A short description of the module that explains its purpose

    from field: string description = 4;

    entrypoint: string

    The executable to run to start the module program

    from field: string entrypoint = 6;

    firstRun?: string

    The path to a setup script that is run before a newly downloaded module starts.

    from field: optional string first_run = 7;

    markdownDescription?: string

    longer documentation provided in markdown format

    from field: optional string markdown_description = 9;

    models: Model[]

    A list of models that are available in the module

    from field: repeated viam.app.v1.Model models = 5;

    moduleId: string

    The id of the module (formatted as prefix:name where prefix is the module owner's orgid or namespace)

    from field: string module_id = 1;

    url: string

    The url to reference for documentation, code, etc.

    from field: string url = 3;

    visibility: Visibility

    The visibility that should be set for the module

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

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

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

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

    • Parameters

      • jsonString: string
      • Optionaloptions: Partial<JsonReadOptions>

      Returns UpdateModuleRequest