Viam SDK
    Preparing search index...

    Class GetPlanRequest

    from message viam.service.motion.v1.GetPlanRequest

    Hierarchy

    Index

    Constructors

    Properties

    componentName: string

    The name of the component which was requested to be moved.

    from field: string component_name = 5;

    componentNameDeprecated?: commonApi.ResourceName

    Deprecated, use component_name field.

    from field: viam.common.v1.ResourceName component_name_deprecated = 2 [deprecated = true];

    executionId?: string

    If you want to know about the plans of a previous execution

    from field: optional string execution_id = 4;

    extra?: Struct

    Additional arguments to the method

    from field: google.protobuf.Struct extra = 99;

    lastPlanOnly: boolean

    If supplied, the response will only return the the last plan for the component / execution

    from field: bool last_plan_only = 3;

    name: string

    The name of the motion service

    from field: string name = 1;

    fields: FieldList
    runtime: ProtoRuntime
    typeName: "viam.service.motion.v1.GetPlanRequest"

    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<GetPlanRequest>

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

    • Parameters

      • jsonString: string
      • Optionaloptions: Partial<JsonReadOptions>

      Returns GetPlanRequest