Package com.viam.service.navigation.v1

Interface Navigation.GoalStatusOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
All Known Implementing Classes:
Navigation.GoalStatus, Navigation.GoalStatus.Builder
Enclosing class:
Navigation
public static interface Navigation.GoalStatusOrBuilder extends com.google.protobuf.MessageLiteOrBuilder

  • Method Details

    • getStateValue

      int getStateValue()
      .viam.service.navigation.v1.GoalState state = 1 [json_name = "state"];
      Returns:
      The enum numeric value on the wire for state.

    • getState

      Navigation.GoalState getState()
      .viam.service.navigation.v1.GoalState state = 1 [json_name = "state"];
      Returns:
      The state.

    • getModeValue

      int getModeValue()
      .viam.service.navigation.v1.NavMode mode = 2 [json_name = "mode"];
      Returns:
      The enum numeric value on the wire for mode.

    • getMode

      Navigation.NavMode getMode()
      .viam.service.navigation.v1.NavMode mode = 2 [json_name = "mode"];
      Returns:
      The mode.

    • hasTarget

      boolean hasTarget()
       For a route, the current waypoint
      .viam.service.navigation.v1.Position target = 3 [json_name = "target"];
      Returns:
      Whether the target field is set.

    • getTarget

      Navigation.Position getTarget()
       For a route, the current waypoint
      .viam.service.navigation.v1.Position target = 3 [json_name = "target"];
      Returns:
      The target.

    • hasLocation

      boolean hasLocation()
       Set when the target is a saved location
      optional string location = 4 [json_name = "location"];
      Returns:
      Whether the location field is set.

    • getLocation

      String getLocation()
       Set when the target is a saved location
      optional string location = 4 [json_name = "location"];
      Returns:
      The location.

    • getLocationBytes

      com.google.protobuf.ByteString getLocationBytes()
       Set when the target is a saved location
      optional string location = 4 [json_name = "location"];
      Returns:
      The bytes for location.

    • hasProgress

      boolean hasProgress()
       While ACTIVE
      optional .viam.service.navigation.v1.Progress progress = 5 [json_name = "progress"];
      Returns:
      Whether the progress field is set.

    • getProgress

      Navigation.Progress getProgress()
       While ACTIVE
      optional .viam.service.navigation.v1.Progress progress = 5 [json_name = "progress"];
      Returns:
      The progress.

    • hasRoute

      boolean hasRoute()
       When mode == NAV_MODE_ROUTE
      optional .viam.service.navigation.v1.RouteProgress route = 6 [json_name = "route"];
      Returns:
      Whether the route field is set.

    • getRoute

      Navigation.RouteProgress getRoute()
       When mode == NAV_MODE_ROUTE
      optional .viam.service.navigation.v1.RouteProgress route = 6 [json_name = "route"];
      Returns:
      The route.

    • hasSuspendReason

      boolean hasSuspendReason()
       When SUSPENDED
      optional string suspend_reason = 7 [json_name = "suspendReason"];
      Returns:
      Whether the suspendReason field is set.

    • getSuspendReason

      String getSuspendReason()
       When SUSPENDED
      optional string suspend_reason = 7 [json_name = "suspendReason"];
      Returns:
      The suspendReason.

    • getSuspendReasonBytes

      com.google.protobuf.ByteString getSuspendReasonBytes()
       When SUSPENDED
      optional string suspend_reason = 7 [json_name = "suspendReason"];
      Returns:
      The bytes for suspendReason.

    • hasError

      boolean hasError()
       When FAILED
      optional .viam.service.navigation.v1.NavError error = 8 [json_name = "error"];
      Returns:
      Whether the error field is set.

    • getError

      Navigation.NavError getError()
       When FAILED
      optional .viam.service.navigation.v1.NavError error = 8 [json_name = "error"];
      Returns:
      The error.

    • hasStartedAt

      boolean hasStartedAt()
      .google.protobuf.Timestamp started_at = 9 [json_name = "startedAt"];
      Returns:
      Whether the startedAt field is set.

    • getStartedAt

      com.google.protobuf.Timestamp getStartedAt()
      .google.protobuf.Timestamp started_at = 9 [json_name = "startedAt"];
      Returns:
      The startedAt.

    • hasFinishedAt

      boolean hasFinishedAt()
       Set once terminal
      optional .google.protobuf.Timestamp finished_at = 10 [json_name = "finishedAt"];
      Returns:
      Whether the finishedAt field is set.

    • getFinishedAt

      com.google.protobuf.Timestamp getFinishedAt()
       Set once terminal
      optional .google.protobuf.Timestamp finished_at = 10 [json_name = "finishedAt"];
      Returns:
      The finishedAt.