Viam SDK
    Preparing search index...

    Class CloudConfig

    from message viam.app.v1.CloudConfig

    Hierarchy

    Index

    Constructors

    constructor

    Properties

    fqdn id localFqdn locationId locationSecret locationSecrets machineId managedBy primaryOrgId secret signalingAddress signalingInsecure fields runtime typeName

    Methods

    clone equals fromBinary fromJson fromJsonString getType toBinary toJson toJSON toJsonString equals fromBinary fromJson fromJsonString

    Constructors

    Properties

    fqdn: string

    from field: string fqdn = 2;

    id: string

    Robot part id.

    from field: string id = 1;

    localFqdn: string

    from field: string local_fqdn = 3;

    locationId: string

    from field: string location_id = 11;

    locationSecret: string

    Deprecated use location_secrets

    from field: string location_secret = 7 [deprecated = true];

    locationSecrets: LocationSecret[]

    All valid location secrets.

    from field: repeated viam.app.v1.LocationSecret location_secrets = 9;

    machineId: string

    from field: string machine_id = 12;

    managedBy: string

    from field: string managed_by = 4;

    primaryOrgId: string

    from field: string primary_org_id = 10;

    secret: string

    Robot part secret

    from field: string secret = 8;

    signalingAddress: string

    from field: string signaling_address = 5;

    signalingInsecure: boolean

    from field: bool signaling_insecure = 6;

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

    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<appRobotApi.CloudConfig>

    • 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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods