Class CloudConfig

Generated

from message viam.app.v1.CloudConfig

Hierarchy

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

constructor

Properties

fqdn

fqdn: string

Generated

from field: string fqdn = 2;

id

id: string

Robot part id.

Generated

from field: string id = 1;

localFqdn

localFqdn: string

Generated

from field: string local_fqdn = 3;

locationId

locationId: string

Generated

from field: string location_id = 11;

locationSecret

locationSecret: string

Deprecated use location_secrets

Generated

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

Deprecated

locationSecrets

locationSecrets: LocationSecret[]

All valid location secrets.

Generated

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

machineId

machineId: string

Generated

from field: string machine_id = 12;

managedBy

managedBy: string

Generated

from field: string managed_by = 4;

primaryOrgId

primaryOrgId: string

Generated

from field: string primary_org_id = 10;

secret

secret: string

Robot part secret

Generated

from field: string secret = 8;

signalingAddress

signalingAddress: string

Generated

from field: string signaling_address = 5;

signalingInsecure

signalingInsecure: boolean

Generated

from field: bool signaling_insecure = 6;

Static Readonlyfields

fields: FieldList

Static Readonlyruntime

runtime: ProtoRuntime

Static ReadonlytypeName

typeName: "viam.app.v1.CloudConfig"

Methods

clone

equals

fromBinary

  • fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): this

    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

fromJson

  • fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): this

    Parse a message from a JSON value.

    Parameters

    • jsonValue: JsonValue
    • Optionaloptions: Partial<JsonReadOptions>

    Returns this

fromJsonString

  • fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): this

    Parse a message from a JSON string.

    Parameters

    • jsonString: string
    • Optionaloptions: Partial<JsonReadOptions>

    Returns this

getType

  • getType(): MessageType<appRobotApi.CloudConfig>

    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>

toBinary

  • toBinary(options?: Partial<BinaryWriteOptions>): Uint8Array

    Serialize the message to binary data.

    Parameters

    • Optionaloptions: Partial<BinaryWriteOptions>

    Returns Uint8Array

toJson

  • toJson(options?: Partial<JsonWriteOptions>): JsonValue

    Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optionaloptions: Partial<JsonWriteOptions>

    Returns JsonValue

ProtectedtoJSON

  • toJSON(): 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

toJsonString

  • toJsonString(options?: Partial<JsonWriteStringOptions>): string

    Serialize the message to a JSON string.

    Parameters

    • Optionaloptions: Partial<JsonWriteStringOptions>

    Returns string

Staticequals

StaticfromBinary

StaticfromJson

StaticfromJsonString

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
MMNEPVFCICPMFPCPTTAAATR