Package com.viam.service.navigation.v1

Interface Navigation.NavigateRouteRequestOrBuilder

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

  • Method Details

    • getName

      String getName()
       Name of the navigation service
      string name = 1 [json_name = "name"];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Name of the navigation service
      string name = 1 [json_name = "name"];
      Returns:
      The bytes for name.

    • getRouteName

      String getRouteName()
       Optional; a saved route
      string route_name = 2 [json_name = "routeName"];
      Returns:
      The routeName.

    • getRouteNameBytes

      com.google.protobuf.ByteString getRouteNameBytes()
       Optional; a saved route
      string route_name = 2 [json_name = "routeName"];
      Returns:
      The bytes for routeName.

    • getWaypointsList

      List<Navigation.Waypoint> getWaypointsList()
       Optional; inline waypoints
      repeated .viam.service.navigation.v1.Waypoint waypoints = 3 [json_name = "waypoints"];

    • getWaypoints

      Navigation.Waypoint getWaypoints(int index)
       Optional; inline waypoints
      repeated .viam.service.navigation.v1.Waypoint waypoints = 3 [json_name = "waypoints"];

    • getWaypointsCount

      int getWaypointsCount()
       Optional; inline waypoints
      repeated .viam.service.navigation.v1.Waypoint waypoints = 3 [json_name = "waypoints"];

    • getStartIndex

      int getStartIndex()
       Optional; default 0
      uint32 start_index = 4 [json_name = "startIndex"];
      Returns:
      The startIndex.

    • getStartNearest

      boolean getStartNearest()
       Optional; overrides start_index
      bool start_nearest = 5 [json_name = "startNearest"];
      Returns:
      The startNearest.

    • getLoop

      boolean getLoop()
       Optional; default false
      bool loop = 6 [json_name = "loop"];
      Returns:
      The loop.

    • getWait

      boolean getWait()
       Optional; default false. With loop, only returns when stopped
      bool wait = 7 [json_name = "wait"];
      Returns:
      The wait.

    • hasExtra

      boolean hasExtra()
      .google.protobuf.Struct extra = 99 [json_name = "extra"];
      Returns:
      Whether the extra field is set.

    • getExtra

      com.google.protobuf.Struct getExtra()
      .google.protobuf.Struct extra = 99 [json_name = "extra"];
      Returns:
      The extra.