Class Motion.PlanStatusWithID.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite.Builder<Motion.PlanStatusWithID,Motion.PlanStatusWithID.Builder>
com.viam.service.motion.v1.Motion.PlanStatusWithID.Builder
All Implemented Interfaces:
com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, Motion.PlanStatusWithIDOrBuilder, Cloneable
Enclosing class:
Motion.PlanStatusWithID

public static final class Motion.PlanStatusWithID.Builder extends com.google.protobuf.GeneratedMessageLite.Builder<Motion.PlanStatusWithID,Motion.PlanStatusWithID.Builder> implements Motion.PlanStatusWithIDOrBuilder
 PlanStatusWithID describes the state of a given plan at a
 point in time plus the plan_id, component_name and execution_id
 the status is associated with
 
Protobuf type viam.service.motion.v1.PlanStatusWithID
  • Method Details

    • getPlanId

      public String getPlanId()
       The unique ID of the plan
       
      string plan_id = 1 [json_name = "planId"];
      Specified by:
      getPlanId in interface Motion.PlanStatusWithIDOrBuilder
      Returns:
      The planId.
    • getPlanIdBytes

      public com.google.protobuf.ByteString getPlanIdBytes()
       The unique ID of the plan
       
      string plan_id = 1 [json_name = "planId"];
      Specified by:
      getPlanIdBytes in interface Motion.PlanStatusWithIDOrBuilder
      Returns:
      The bytes for planId.
    • setPlanId

      public Motion.PlanStatusWithID.Builder setPlanId(String value)
       The unique ID of the plan
       
      string plan_id = 1 [json_name = "planId"];
      Parameters:
      value - The planId to set.
      Returns:
      This builder for chaining.
    • clearPlanId

      public Motion.PlanStatusWithID.Builder clearPlanId()
       The unique ID of the plan
       
      string plan_id = 1 [json_name = "planId"];
      Returns:
      This builder for chaining.
    • setPlanIdBytes

      public Motion.PlanStatusWithID.Builder setPlanIdBytes(com.google.protobuf.ByteString value)
       The unique ID of the plan
       
      string plan_id = 1 [json_name = "planId"];
      Parameters:
      value - The bytes for planId to set.
      Returns:
      This builder for chaining.
    • hasComponentName

      public 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"];
      Specified by:
      hasComponentName in interface Motion.PlanStatusWithIDOrBuilder
      Returns:
      Whether the componentName field is set.
    • getComponentName

      public 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"];
      Specified by:
      getComponentName in interface Motion.PlanStatusWithIDOrBuilder
      Returns:
      The componentName.
    • setComponentName

      public Motion.PlanStatusWithID.Builder setComponentName(Common.ResourceName value)
       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"];
    • setComponentName

      public Motion.PlanStatusWithID.Builder setComponentName(Common.ResourceName.Builder builderForValue)
       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"];
    • mergeComponentName

      public Motion.PlanStatusWithID.Builder mergeComponentName(Common.ResourceName value)
       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"];
    • clearComponentName

      public Motion.PlanStatusWithID.Builder clearComponentName()
       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"];
    • getExecutionId

      public 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"];
      Specified by:
      getExecutionId in interface Motion.PlanStatusWithIDOrBuilder
      Returns:
      The executionId.
    • getExecutionIdBytes

      public 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"];
      Specified by:
      getExecutionIdBytes in interface Motion.PlanStatusWithIDOrBuilder
      Returns:
      The bytes for executionId.
    • setExecutionId

      public Motion.PlanStatusWithID.Builder setExecutionId(String value)
       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"];
      Parameters:
      value - The executionId to set.
      Returns:
      This builder for chaining.
    • clearExecutionId

      public Motion.PlanStatusWithID.Builder clearExecutionId()
       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:
      This builder for chaining.
    • setExecutionIdBytes

      public Motion.PlanStatusWithID.Builder setExecutionIdBytes(com.google.protobuf.ByteString value)
       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"];
      Parameters:
      value - The bytes for executionId to set.
      Returns:
      This builder for chaining.
    • hasStatus

      public boolean hasStatus()
      .viam.service.motion.v1.PlanStatus status = 4 [json_name = "status"];
      Specified by:
      hasStatus in interface Motion.PlanStatusWithIDOrBuilder
      Returns:
      Whether the status field is set.
    • getStatus

      public Motion.PlanStatus getStatus()
      .viam.service.motion.v1.PlanStatus status = 4 [json_name = "status"];
      Specified by:
      getStatus in interface Motion.PlanStatusWithIDOrBuilder
      Returns:
      The status.
    • setStatus

      .viam.service.motion.v1.PlanStatus status = 4 [json_name = "status"];
    • setStatus

      public Motion.PlanStatusWithID.Builder setStatus(Motion.PlanStatus.Builder builderForValue)
      .viam.service.motion.v1.PlanStatus status = 4 [json_name = "status"];
    • mergeStatus

      .viam.service.motion.v1.PlanStatus status = 4 [json_name = "status"];
    • clearStatus

      public Motion.PlanStatusWithID.Builder clearStatus()
      .viam.service.motion.v1.PlanStatus status = 4 [json_name = "status"];