Class Motion.PlanStatus.Builder

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

public static final class Motion.PlanStatus.Builder extends com.google.protobuf.GeneratedMessageLite.Builder<Motion.PlanStatus,Motion.PlanStatus.Builder> implements Motion.PlanStatusOrBuilder
 Plan status describes the state of a given plan at a
 point in time
 
Protobuf type viam.service.motion.v1.PlanStatus
  • Method Details

    • getStateValue

      public int getStateValue()
       The state of the plan execution
       
      .viam.service.motion.v1.PlanState state = 1 [json_name = "state"];
      Specified by:
      getStateValue in interface Motion.PlanStatusOrBuilder
      Returns:
      The enum numeric value on the wire for state.
    • setStateValue

      public Motion.PlanStatus.Builder setStateValue(int value)
       The state of the plan execution
       
      .viam.service.motion.v1.PlanState state = 1 [json_name = "state"];
      Parameters:
      value - The state to set.
      Returns:
      This builder for chaining.
    • getState

      public Motion.PlanState getState()
       The state of the plan execution
       
      .viam.service.motion.v1.PlanState state = 1 [json_name = "state"];
      Specified by:
      getState in interface Motion.PlanStatusOrBuilder
      Returns:
      The state.
    • setState

       The state of the plan execution
       
      .viam.service.motion.v1.PlanState state = 1 [json_name = "state"];
      Parameters:
      value - The enum numeric value on the wire for state to set.
      Returns:
      This builder for chaining.
    • clearState

      public Motion.PlanStatus.Builder clearState()
       The state of the plan execution
       
      .viam.service.motion.v1.PlanState state = 1 [json_name = "state"];
      Returns:
      This builder for chaining.
    • hasTimestamp

      public boolean hasTimestamp()
       The time the executing plan transtioned to the state
       
      .google.protobuf.Timestamp timestamp = 2 [json_name = "timestamp"];
      Specified by:
      hasTimestamp in interface Motion.PlanStatusOrBuilder
      Returns:
      Whether the timestamp field is set.
    • getTimestamp

      public com.google.protobuf.Timestamp getTimestamp()
       The time the executing plan transtioned to the state
       
      .google.protobuf.Timestamp timestamp = 2 [json_name = "timestamp"];
      Specified by:
      getTimestamp in interface Motion.PlanStatusOrBuilder
      Returns:
      The timestamp.
    • setTimestamp

      public Motion.PlanStatus.Builder setTimestamp(com.google.protobuf.Timestamp value)
       The time the executing plan transtioned to the state
       
      .google.protobuf.Timestamp timestamp = 2 [json_name = "timestamp"];
    • setTimestamp

      public Motion.PlanStatus.Builder setTimestamp(com.google.protobuf.Timestamp.Builder builderForValue)
       The time the executing plan transtioned to the state
       
      .google.protobuf.Timestamp timestamp = 2 [json_name = "timestamp"];
    • mergeTimestamp

      public Motion.PlanStatus.Builder mergeTimestamp(com.google.protobuf.Timestamp value)
       The time the executing plan transtioned to the state
       
      .google.protobuf.Timestamp timestamp = 2 [json_name = "timestamp"];
    • clearTimestamp

      public Motion.PlanStatus.Builder clearTimestamp()
       The time the executing plan transtioned to the state
       
      .google.protobuf.Timestamp timestamp = 2 [json_name = "timestamp"];
    • hasReason

      public boolean hasReason()
       The reason for the state change. If motion plan failed
       this will return the error message.
       If motion needed to re-plan, this will return
       the re-plan reason.
       
      optional string reason = 3 [json_name = "reason"];
      Specified by:
      hasReason in interface Motion.PlanStatusOrBuilder
      Returns:
      Whether the reason field is set.
    • getReason

      public String getReason()
       The reason for the state change. If motion plan failed
       this will return the error message.
       If motion needed to re-plan, this will return
       the re-plan reason.
       
      optional string reason = 3 [json_name = "reason"];
      Specified by:
      getReason in interface Motion.PlanStatusOrBuilder
      Returns:
      The reason.
    • getReasonBytes

      public com.google.protobuf.ByteString getReasonBytes()
       The reason for the state change. If motion plan failed
       this will return the error message.
       If motion needed to re-plan, this will return
       the re-plan reason.
       
      optional string reason = 3 [json_name = "reason"];
      Specified by:
      getReasonBytes in interface Motion.PlanStatusOrBuilder
      Returns:
      The bytes for reason.
    • setReason

      public Motion.PlanStatus.Builder setReason(String value)
       The reason for the state change. If motion plan failed
       this will return the error message.
       If motion needed to re-plan, this will return
       the re-plan reason.
       
      optional string reason = 3 [json_name = "reason"];
      Parameters:
      value - The reason to set.
      Returns:
      This builder for chaining.
    • clearReason

      public Motion.PlanStatus.Builder clearReason()
       The reason for the state change. If motion plan failed
       this will return the error message.
       If motion needed to re-plan, this will return
       the re-plan reason.
       
      optional string reason = 3 [json_name = "reason"];
      Returns:
      This builder for chaining.
    • setReasonBytes

      public Motion.PlanStatus.Builder setReasonBytes(com.google.protobuf.ByteString value)
       The reason for the state change. If motion plan failed
       this will return the error message.
       If motion needed to re-plan, this will return
       the re-plan reason.
       
      optional string reason = 3 [json_name = "reason"];
      Parameters:
      value - The bytes for reason to set.
      Returns:
      This builder for chaining.