Package com.viam.service.motion.v1

Interface Motion.GetPlanRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
All Known Implementing Classes:
Motion.GetPlanRequest, Motion.GetPlanRequest.Builder
Enclosing class:
Motion
public static interface Motion.GetPlanRequestOrBuilder extends com.google.protobuf.MessageLiteOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    Common.ResourceName
    getComponentName()
    The name of the component which was requested to be moved.
    String
    getExecutionId()
    If you want to know about the plans of a previous execution
    com.google.protobuf.ByteString
    getExecutionIdBytes()
    If you want to know about the plans of a previous execution
    com.google.protobuf.Struct
    getExtra()
    Additional arguments to the method
    boolean
    getLastPlanOnly()
    If supplied, the response will only return the the last plan for the component / execution
    String
    getName()
    The name of the motion service
    com.google.protobuf.ByteString
    getNameBytes()
    The name of the motion service
    boolean
    hasComponentName()
    The name of the component which was requested to be moved.
    boolean
    hasExecutionId()
    If you want to know about the plans of a previous execution
    boolean
    hasExtra()
    Additional arguments to the method

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • getName

      String getName()
       The name of the motion service
      string name = 1 [json_name = "name"];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       The name of the motion service
      string name = 1 [json_name = "name"];
      Returns:
      The bytes for name.

    • hasComponentName

      boolean hasComponentName()
       The name of the component which was requested to be moved.
      .viam.common.v1.ResourceName component_name = 2 [json_name = "componentName"];
      Returns:
      Whether the componentName field is set.

    • getComponentName

      Common.ResourceName getComponentName()
       The name of the component which was requested to be moved.
      .viam.common.v1.ResourceName component_name = 2 [json_name = "componentName"];
      Returns:
      The componentName.

    • getLastPlanOnly

      boolean getLastPlanOnly()
       If supplied, the response will only return
 the the last plan for the component / execution
      bool last_plan_only = 3 [json_name = "lastPlanOnly"];
      Returns:
      The lastPlanOnly.

    • hasExecutionId

      boolean hasExecutionId()
       If you want to know about the plans of a previous execution
      optional string execution_id = 4 [json_name = "executionId"];
      Returns:
      Whether the executionId field is set.

    • getExecutionId

      String getExecutionId()
       If you want to know about the plans of a previous execution
      optional string execution_id = 4 [json_name = "executionId"];
      Returns:
      The executionId.

    • getExecutionIdBytes

      com.google.protobuf.ByteString getExecutionIdBytes()
       If you want to know about the plans of a previous execution
      optional string execution_id = 4 [json_name = "executionId"];
      Returns:
      The bytes for executionId.

    • hasExtra

      boolean hasExtra()
       Additional arguments to the method
      .google.protobuf.Struct extra = 99 [json_name = "extra"];
      Returns:
      Whether the extra field is set.

    • getExtra

      com.google.protobuf.Struct getExtra()
       Additional arguments to the method
      .google.protobuf.Struct extra = 99 [json_name = "extra"];
      Returns:
      The extra.