Package com.viam.service.motion.v1

Class Motion.Plan.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite.Builder<Motion.Plan,Motion.Plan.Builder>
com.viam.service.motion.v1.Motion.Plan.Builder
All Implemented Interfaces:
com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, Motion.PlanOrBuilder, Cloneable
Enclosing class:
Motion.Plan
public static final class Motion.Plan.Builder extends com.google.protobuf.GeneratedMessageLite.Builder<Motion.Plan,Motion.Plan.Builder> implements Motion.PlanOrBuilder
 A plan describes a motion plan
Protobuf type viam.service.motion.v1.Plan

  • Method Details

    • getId

      public String getId()
       The plan's unique ID
      string id = 1 [json_name = "id"];
      Specified by:
      getId in interface Motion.PlanOrBuilder
      Returns:
      The id.

    • getIdBytes

      public com.google.protobuf.ByteString getIdBytes()
       The plan's unique ID
      string id = 1 [json_name = "id"];
      Specified by:
      getIdBytes in interface Motion.PlanOrBuilder
      Returns:
      The bytes for id.

    • setId

      public Motion.Plan.Builder setId(String value)
       The plan's unique ID
      string id = 1 [json_name = "id"];
      Parameters:
      value - The id to set.
      Returns:
      This builder for chaining.

    • clearId

      public Motion.Plan.Builder clearId()
       The plan's unique ID
      string id = 1 [json_name = "id"];
      Returns:
      This builder for chaining.

    • setIdBytes

      public Motion.Plan.Builder setIdBytes(com.google.protobuf.ByteString value)
       The plan's unique ID
      string id = 1 [json_name = "id"];
      Parameters:
      value - The bytes for id to set.
      Returns:
      This builder for chaining.

    • hasComponentNameDeprecated

      @Deprecated public boolean hasComponentNameDeprecated()
      Deprecated.
       Deprecated, use component_name field.
      .viam.common.v1.ResourceName component_name_deprecated = 2 [json_name = "componentNameDeprecated", deprecated = true];
      Specified by:
      hasComponentNameDeprecated in interface Motion.PlanOrBuilder
      Returns:
      Whether the componentNameDeprecated field is set.

    • getComponentNameDeprecated

      @Deprecated public Common.ResourceName getComponentNameDeprecated()
      Deprecated.
       Deprecated, use component_name field.
      .viam.common.v1.ResourceName component_name_deprecated = 2 [json_name = "componentNameDeprecated", deprecated = true];
      Specified by:
      getComponentNameDeprecated in interface Motion.PlanOrBuilder
      Returns:
      The componentNameDeprecated.

    • setComponentNameDeprecated

      @Deprecated public Motion.Plan.Builder setComponentNameDeprecated(Common.ResourceName value)
      Deprecated.
       Deprecated, use component_name field.
      .viam.common.v1.ResourceName component_name_deprecated = 2 [json_name = "componentNameDeprecated", deprecated = true];

    • setComponentNameDeprecated

      @Deprecated public Motion.Plan.Builder setComponentNameDeprecated(Common.ResourceName.Builder builderForValue)
      Deprecated.
       Deprecated, use component_name field.
      .viam.common.v1.ResourceName component_name_deprecated = 2 [json_name = "componentNameDeprecated", deprecated = true];

    • mergeComponentNameDeprecated

      @Deprecated public Motion.Plan.Builder mergeComponentNameDeprecated(Common.ResourceName value)
      Deprecated.
       Deprecated, use component_name field.
      .viam.common.v1.ResourceName component_name_deprecated = 2 [json_name = "componentNameDeprecated", deprecated = true];

    • clearComponentNameDeprecated

      @Deprecated public Motion.Plan.Builder clearComponentNameDeprecated()
      Deprecated.
       Deprecated, use component_name field.
      .viam.common.v1.ResourceName component_name_deprecated = 2 [json_name = "componentNameDeprecated", deprecated = true];

    • getExecutionId

      public String getExecutionId()
       The unique ID which identifies the 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.PlanOrBuilder
      Returns:
      The executionId.

    • getExecutionIdBytes

      public com.google.protobuf.ByteString getExecutionIdBytes()
       The unique ID which identifies the 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.PlanOrBuilder
      Returns:
      The bytes for executionId.

    • setExecutionId

      public Motion.Plan.Builder setExecutionId(String value)
       The unique ID which identifies the 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.Plan.Builder clearExecutionId()
       The unique ID which identifies the 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.Plan.Builder setExecutionIdBytes(com.google.protobuf.ByteString value)
       The unique ID which identifies the 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.

    • getStepsList

      public List<Motion.PlanStep> getStepsList()
       The steps of a plan is an ordered list of plan steps
      repeated .viam.service.motion.v1.PlanStep steps = 4 [json_name = "steps"];
      Specified by:
      getStepsList in interface Motion.PlanOrBuilder

    • getStepsCount

      public int getStepsCount()
       The steps of a plan is an ordered list of plan steps
      repeated .viam.service.motion.v1.PlanStep steps = 4 [json_name = "steps"];
      Specified by:
      getStepsCount in interface Motion.PlanOrBuilder

    • getSteps

      public Motion.PlanStep getSteps(int index)
       The steps of a plan is an ordered list of plan steps
      repeated .viam.service.motion.v1.PlanStep steps = 4 [json_name = "steps"];
      Specified by:
      getSteps in interface Motion.PlanOrBuilder

    • setSteps

      public Motion.Plan.Builder setSteps(int index, Motion.PlanStep value)
       The steps of a plan is an ordered list of plan steps
      repeated .viam.service.motion.v1.PlanStep steps = 4 [json_name = "steps"];

    • setSteps

      public Motion.Plan.Builder setSteps(int index, Motion.PlanStep.Builder builderForValue)
       The steps of a plan is an ordered list of plan steps
      repeated .viam.service.motion.v1.PlanStep steps = 4 [json_name = "steps"];

    • addSteps

      public Motion.Plan.Builder addSteps(Motion.PlanStep value)
       The steps of a plan is an ordered list of plan steps
      repeated .viam.service.motion.v1.PlanStep steps = 4 [json_name = "steps"];

    • addSteps

      public Motion.Plan.Builder addSteps(int index, Motion.PlanStep value)
       The steps of a plan is an ordered list of plan steps
      repeated .viam.service.motion.v1.PlanStep steps = 4 [json_name = "steps"];

    • addSteps

      public Motion.Plan.Builder addSteps(Motion.PlanStep.Builder builderForValue)
       The steps of a plan is an ordered list of plan steps
      repeated .viam.service.motion.v1.PlanStep steps = 4 [json_name = "steps"];

    • addSteps

      public Motion.Plan.Builder addSteps(int index, Motion.PlanStep.Builder builderForValue)
       The steps of a plan is an ordered list of plan steps
      repeated .viam.service.motion.v1.PlanStep steps = 4 [json_name = "steps"];

    • addAllSteps

      public Motion.Plan.Builder addAllSteps(Iterable<? extends Motion.PlanStep> values)
       The steps of a plan is an ordered list of plan steps
      repeated .viam.service.motion.v1.PlanStep steps = 4 [json_name = "steps"];

    • clearSteps

      public Motion.Plan.Builder clearSteps()
       The steps of a plan is an ordered list of plan steps
      repeated .viam.service.motion.v1.PlanStep steps = 4 [json_name = "steps"];

    • removeSteps

      public Motion.Plan.Builder removeSteps(int index)
       The steps of a plan is an ordered list of plan steps
      repeated .viam.service.motion.v1.PlanStep steps = 4 [json_name = "steps"];

    • getComponentName

      public String getComponentName()
       The component requested to be moved.
 Used for tracking & stopping.
 NOTE: A plan may move more components than just the
 root component.
      string component_name = 5 [json_name = "componentName"];
      Specified by:
      getComponentName in interface Motion.PlanOrBuilder
      Returns:
      The componentName.

    • getComponentNameBytes

      public com.google.protobuf.ByteString getComponentNameBytes()
       The component requested to be moved.
 Used for tracking & stopping.
 NOTE: A plan may move more components than just the
 root component.
      string component_name = 5 [json_name = "componentName"];
      Specified by:
      getComponentNameBytes in interface Motion.PlanOrBuilder
      Returns:
      The bytes for componentName.

    • setComponentName

      public Motion.Plan.Builder setComponentName(String value)
       The component requested to be moved.
 Used for tracking & stopping.
 NOTE: A plan may move more components than just the
 root component.
      string component_name = 5 [json_name = "componentName"];
      Parameters:
      value - The componentName to set.
      Returns:
      This builder for chaining.

    • clearComponentName

      public Motion.Plan.Builder clearComponentName()
       The component requested to be moved.
 Used for tracking & stopping.
 NOTE: A plan may move more components than just the
 root component.
      string component_name = 5 [json_name = "componentName"];
      Returns:
      This builder for chaining.

    • setComponentNameBytes

      public Motion.Plan.Builder setComponentNameBytes(com.google.protobuf.ByteString value)
       The component requested to be moved.
 Used for tracking & stopping.
 NOTE: A plan may move more components than just the
 root component.
      string component_name = 5 [json_name = "componentName"];
      Parameters:
      value - The bytes for componentName to set.
      Returns:
      This builder for chaining.