Package com.google.maps.routing.v2

Interface WaypointOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Waypoint, Waypoint.Builder
    public interface WaypointOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getAddress()
      Human readable address or a plus code.
      com.google.protobuf.ByteString getAddressBytes()
      Human readable address or a plus code.
      Location getLocation()
      A point specified using geographic coordinates, including an optional heading.
      LocationOrBuilder getLocationOrBuilder()
      A point specified using geographic coordinates, including an optional heading.
      Waypoint.LocationTypeCase getLocationTypeCase()  
      String getPlaceId()
      The POI Place ID associated with the waypoint.
      com.google.protobuf.ByteString getPlaceIdBytes()
      The POI Place ID associated with the waypoint.
      boolean getSideOfRoad()
      Indicates that the location of this waypoint is meant to have a preference for the vehicle to stop at a particular side of road.
      boolean getVehicleStopover()
      Indicates that the waypoint is meant for vehicles to stop at, where the intention is to either pickup or drop-off.
      boolean getVia()
      Marks this waypoint as a milestone rather a stopping point.
      boolean hasAddress()
      Human readable address or a plus code.
      boolean hasLocation()
      A point specified using geographic coordinates, including an optional heading.
      boolean hasPlaceId()
      The POI Place ID associated with the waypoint.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • hasLocation

        boolean hasLocation()
         A point specified using geographic coordinates, including an optional
 heading.
        .google.maps.routing.v2.Location location = 1;
        Returns:
        Whether the location field is set.

      • getLocation

        Location getLocation()
         A point specified using geographic coordinates, including an optional
 heading.
        .google.maps.routing.v2.Location location = 1;
        Returns:
        The location.

      • getLocationOrBuilder

        LocationOrBuilder getLocationOrBuilder()
         A point specified using geographic coordinates, including an optional
 heading.
        .google.maps.routing.v2.Location location = 1;

      • hasPlaceId

        boolean hasPlaceId()
         The POI Place ID associated with the waypoint.
        string place_id = 2;
        Returns:
        Whether the placeId field is set.

      • getPlaceId

        String getPlaceId()
         The POI Place ID associated with the waypoint.
        string place_id = 2;
        Returns:
        The placeId.

      • getPlaceIdBytes

        com.google.protobuf.ByteString getPlaceIdBytes()
         The POI Place ID associated with the waypoint.
        string place_id = 2;
        Returns:
        The bytes for placeId.

      • hasAddress

        boolean hasAddress()
         Human readable address or a plus code.
 See https://plus.codes for details.
        string address = 7;
        Returns:
        Whether the address field is set.

      • getAddress

        String getAddress()
         Human readable address or a plus code.
 See https://plus.codes for details.
        string address = 7;
        Returns:
        The address.

      • getAddressBytes

        com.google.protobuf.ByteString getAddressBytes()
         Human readable address or a plus code.
 See https://plus.codes for details.
        string address = 7;
        Returns:
        The bytes for address.

      • getVia

        boolean getVia()
         Marks this waypoint as a milestone rather a stopping point. For
 each non-via waypoint in the request, the response appends an entry to the
 [legs][google.maps.routing.v2.Route.legs]
 array to provide the details for stopovers on that leg of the trip. Set
 this value to true when you want the route to pass through this waypoint
 without stopping over. Via waypoints don't cause an entry to be added to
 the `legs` array, but they do route the journey through the waypoint. You
 can only set this value on waypoints that are intermediates. The request
 fails if you set this field on terminal waypoints. If
 `ComputeRoutesRequest.optimize_waypoint_order` is set to true then this
 field cannot be set to true; otherwise, the request fails.
        bool via = 3;
        Returns:
        The via.

      • getVehicleStopover

        boolean getVehicleStopover()
         Indicates that the waypoint is meant for vehicles to stop at, where the
 intention is to either pickup or drop-off. When you set this value, the
 calculated route won't include non-`via` waypoints on roads that are
 unsuitable for pickup and drop-off. This option works only for `DRIVE` and
 `TWO_WHEELER` travel modes, and when the `location_type` is
 [Location][google.maps.routing.v2.Location].
        bool vehicle_stopover = 4;
        Returns:
        The vehicleStopover.

      • getSideOfRoad

        boolean getSideOfRoad()
         Indicates that the location of this waypoint is meant to have a preference
 for the vehicle to stop at a particular side of road. When you set this
 value, the route will pass through the location so that the vehicle can
 stop at the side of road that the location is biased towards from the
 center of the road. This option works only for 'DRIVE' and 'TWO_WHEELER'
 [RouteTravelMode][google.maps.routing.v2.RouteTravelMode].
        bool side_of_road = 5;
        Returns:
        The sideOfRoad.