Package com.viam.service.motion.v1
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 timeProtobuf type
viam.service.motion.v1.PlanStatus
-
Field Summary
Fields inherited from class com.google.protobuf.GeneratedMessageLite.Builder
instance
-
Method Summary
Modifier and TypeMethodDescriptionThe reason for the state change.The state of the plan executionThe time the executing plan transtioned to the stateThe reason for the state change.com.google.protobuf.ByteString
The reason for the state change.getState()
The state of the plan executionint
The state of the plan executioncom.google.protobuf.Timestamp
The time the executing plan transtioned to the stateboolean
The reason for the state change.boolean
The time the executing plan transtioned to the statemergeTimestamp
(com.google.protobuf.Timestamp value) The time the executing plan transtioned to the stateThe reason for the state change.setReasonBytes
(com.google.protobuf.ByteString value) The reason for the state change.setState
(Motion.PlanState value) The state of the plan executionsetStateValue
(int value) The state of the plan executionsetTimestamp
(com.google.protobuf.Timestamp value) The time the executing plan transtioned to the statesetTimestamp
(com.google.protobuf.Timestamp.Builder builderForValue) The time the executing plan transtioned to the stateMethods inherited from class com.google.protobuf.GeneratedMessageLite.Builder
build, buildPartial, clear, clone, copyOnWrite, copyOnWriteInternal, getDefaultInstanceForType, internalMergeFrom, isInitialized, mergeFrom, mergeFrom, mergeFrom, mergeFrom
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType, isInitialized
-
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 interfaceMotion.PlanStatusOrBuilder
- Returns:
- The enum numeric value on the wire for state.
-
setStateValue
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
The state of the plan execution
.viam.service.motion.v1.PlanState state = 1 [json_name = "state"];
- Specified by:
getState
in interfaceMotion.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
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 interfaceMotion.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 interfaceMotion.PlanStatusOrBuilder
- Returns:
- The timestamp.
-
setTimestamp
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
The time the executing plan transtioned to the state
.google.protobuf.Timestamp timestamp = 2 [json_name = "timestamp"];
-
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 interfaceMotion.PlanStatusOrBuilder
- Returns:
- Whether the reason field is set.
-
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 interfaceMotion.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 interfaceMotion.PlanStatusOrBuilder
- Returns:
- The bytes for reason.
-
setReason
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
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
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.
-