Viam SDK
    Preparing search index...

    Class Location

    from message viam.app.v1.Location

    Hierarchy

    Index

    Constructors

    constructor

    Properties

    auth? config? createdOn? id name organizations parentLocationId primaryOrgIdentity? robotCount fields runtime typeName

    Methods

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

    Constructors

    Properties

    auth?: LocationAuth

    Location authentication secrets.

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

    config?: StorageConfig

    Config for how data in this location is stored.

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

    createdOn?: Timestamp

    Location creation timestamp.

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

    id: string

    Location ID.

    from field: string id = 1;

    name: string

    Location name.

    from field: string name = 2;

    organizations: LocationOrganization[]

    Organizations that the location is shared with.

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

    parentLocationId: string

    Location ID of the parent location.

    from field: string parent_location_id = 4;

    primaryOrgIdentity?: OrganizationIdentity

    The organization that is the primary owner of the location.

    from field: optional viam.app.v1.OrganizationIdentity primary_org_identity = 9;

    robotCount: number

    from field: int32 robot_count = 7;

    fields: FieldList
    runtime: ProtoRuntime
    typeName: "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
      • 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<Location>

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

    • Parameters

      • jsonString: string
      • Optionaloptions: Partial<JsonReadOptions>

      Returns Location

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods