Generated

from message viam.app.v1.Location

Hierarchy

Constructors

  • Parameters

    Returns Location

Properties

Location authentication secrets.

Generated

from field: viam.app.v1.LocationAuth auth = 5;

config?: StorageConfig

Config for how data in this location is stored.

Generated

from field: viam.app.v1.StorageConfig config = 8;

createdOn?: Timestamp

Location creation timestamp.

Generated

from field: google.protobuf.Timestamp created_on = 3;

id: string

Location ID.

Generated

from field: string id = 1;

name: string

Location name.

Generated

from field: string name = 2;

organizations: LocationOrganization[]

Organizations that the location is shared with.

Generated

from field: repeated viam.app.v1.LocationOrganization organizations = 6;

parentLocationId: string

Location ID of the parent location.

Generated

from field: string parent_location_id = 4;

robotCount: number

Generated

from field: int32 robot_count = 7;

fields: FieldList
runtime: ProtoRuntime
typeName: "viam.app.v1.Location" = "viam.app.v1.Location"

Methods

  • Create a deep copy.

    Returns Location

  • Compare with a message of the same type. Note that this function disregards extensions and unknown fields.

    Parameters

    Returns boolean

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

  • 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

  • Parameters

    • bytes: Uint8Array
    • Optional options: Partial<BinaryReadOptions>

    Returns Location

  • Parameters

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

    Returns Location

  • Parameters

    • jsonString: string
    • Optional options: Partial<JsonReadOptions>

    Returns Location