Package com.viam.service.motion.v1

Interface Motion.PlanStatusWithIDOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    Common.ResourceName
    getComponentName()
    The component to be moved.
    String
    getExecutionId()
    The unique ID which identifies the plan execution.
    com.google.protobuf.ByteString
    getExecutionIdBytes()
    The unique ID which identifies the plan execution.
    String
    getPlanId()
    The unique ID of the plan
    com.google.protobuf.ByteString
    getPlanIdBytes()
    The unique ID of the plan
    Motion.PlanStatus
    getStatus()
    .viam.service.motion.v1.PlanStatus status = 4 [json_name = "status"];
    boolean
    hasComponentName()
    The component to be moved.
    boolean
    hasStatus()
    .viam.service.motion.v1.PlanStatus status = 4 [json_name = "status"];

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • getPlanId

      String getPlanId()
       The unique ID of the plan
      string plan_id = 1 [json_name = "planId"];
      Returns:
      The planId.

    • getPlanIdBytes

      com.google.protobuf.ByteString getPlanIdBytes()
       The unique ID of the plan
      string plan_id = 1 [json_name = "planId"];
      Returns:
      The bytes for planId.

    • hasComponentName

      boolean hasComponentName()
       The component to be moved.
 Used for tracking & stopping.
 NOTE: A plan may move more components than just the
 component_name.
      .viam.common.v1.ResourceName component_name = 2 [json_name = "componentName"];
      Returns:
      Whether the componentName field is set.

    • getComponentName

      Common.ResourceName getComponentName()
       The component to be moved.
 Used for tracking & stopping.
 NOTE: A plan may move more components than just the
 component_name.
      .viam.common.v1.ResourceName component_name = 2 [json_name = "componentName"];
      Returns:
      The componentName.

    • getExecutionId

      String getExecutionId()
       The unique ID which identifies the plan execution.
 Multiple plans will share the same execution_id if they were
 generated due to replanning.
      string execution_id = 3 [json_name = "executionId"];
      Returns:
      The executionId.

    • getExecutionIdBytes

      com.google.protobuf.ByteString getExecutionIdBytes()
       The unique ID which identifies the plan execution.
 Multiple plans will share the same execution_id if they were
 generated due to replanning.
      string execution_id = 3 [json_name = "executionId"];
      Returns:
      The bytes for executionId.

    • hasStatus

      boolean hasStatus()
      .viam.service.motion.v1.PlanStatus status = 4 [json_name = "status"];
      Returns:
      Whether the status field is set.

    • getStatus

      Motion.PlanStatus getStatus()
      .viam.service.motion.v1.PlanStatus status = 4 [json_name = "status"];
      Returns:
      The status.