Package com.viam.service.motion.v1

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.

    • 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.PlanStatusWithIDOrBuilder
      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.PlanStatusWithIDOrBuilder
      Returns:
      The componentNameDeprecated.

    • setComponentNameDeprecated

      @Deprecated public Motion.PlanStatusWithID.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.PlanStatusWithID.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.PlanStatusWithID.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.PlanStatusWithID.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 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

      public Motion.PlanStatusWithID.Builder setStatus(Motion.PlanStatus value)
      .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

      public Motion.PlanStatusWithID.Builder mergeStatus(Motion.PlanStatus value)
      .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"];

    • getComponentName

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

    • getComponentNameBytes

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

    • setComponentName

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

    • 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.
      string component_name = 5 [json_name = "componentName"];
      Returns:
      This builder for chaining.

    • setComponentNameBytes

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