Viam SDK
    Preparing search index...

    Class Fragment

    from message viam.app.v1.Fragment

    Hierarchy

    Index

    Constructors

    constructor

    Properties

    createdOn? fragment? id lastUpdated? name onlyUsedByOwner organizationCount organizationName organizationOwner public revision robotPartCount visibility fields runtime typeName

    Methods

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

    Constructors

    Properties

    createdOn?: Timestamp

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

    fragment?: Struct

    from field: google.protobuf.Struct fragment = 3;

    id: string

    from field: string id = 1;

    lastUpdated?: Timestamp

    latest timestamp when fragment was updated

    from field: google.protobuf.Timestamp last_updated = 13;

    name: string

    from field: string name = 2;

    onlyUsedByOwner: boolean

    whether the organization(s) using this fragment is the same as the fragment org

    from field: bool only_used_by_owner = 11;

    organizationCount: number

    number of organizations using this fragment

    from field: int32 organization_count = 10;

    organizationName: string

    from field: string organization_name = 7;

    organizationOwner: string

    from field: string organization_owner = 4;

    public: boolean

    from field: bool public = 5;

    revision: string

    from field: string revision = 14;

    robotPartCount: number

    number of robot parts using this fragment

    from field: int32 robot_part_count = 9;

    visibility: FragmentVisibility

    the visibility of a fragment; public, private or unlisted

    from field: viam.app.v1.FragmentVisibility visibility = 12;

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

    Methods

    • Create a deep copy.

      Returns Fragment

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

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

    • Parameters

      • jsonString: string
      • Optionaloptions: Partial<JsonReadOptions>

      Returns Fragment

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods