Package com.google.maps.routing.v2

Class Waypoint

  • All Implemented Interfaces:
    WaypointOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Waypoint
extends com.google.protobuf.GeneratedMessageV3
implements WaypointOrBuilder
     Encapsulates a waypoint. Waypoints mark both the beginning and end of a
 route, and include intermediate stops along the route.
    Protobuf type google.maps.routing.v2.Waypoint
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Waypoint.Builder
      Encapsulates a waypoint.
      static class  Waypoint.LocationTypeCase  

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)  
      String getAddress()
      Human readable address or a plus code.
      com.google.protobuf.ByteString getAddressBytes()
      Human readable address or a plus code.
      static Waypoint getDefaultInstance()  
      Waypoint getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      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()  
      com.google.protobuf.Parser<Waypoint> getParserForType()  
      String getPlaceId()
      The POI Place ID associated with the waypoint.
      com.google.protobuf.ByteString getPlaceIdBytes()
      The POI Place ID associated with the waypoint.
      int getSerializedSize()  
      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.
      int hashCode()  
      boolean hasLocation()
      A point specified using geographic coordinates, including an optional heading.
      boolean hasPlaceId()
      The POI Place ID associated with the waypoint.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static Waypoint.Builder newBuilder()  
      static Waypoint.Builder newBuilder​(Waypoint prototype)  
      Waypoint.Builder newBuilderForType()  
      protected Waypoint.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static Waypoint parseDelimitedFrom​(InputStream input)  
      static Waypoint parseDelimitedFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Waypoint parseFrom​(byte[] data)  
      static Waypoint parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Waypoint parseFrom​(com.google.protobuf.ByteString data)  
      static Waypoint parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Waypoint parseFrom​(com.google.protobuf.CodedInputStream input)  
      static Waypoint parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Waypoint parseFrom​(InputStream input)  
      static Waypoint parseFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Waypoint parseFrom​(ByteBuffer data)  
      static Waypoint parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<Waypoint> parser()  
      Waypoint.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

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

        toByteArray, toByteString, writeDelimitedTo, writeTo

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

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

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • hasLocation

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

      • getLocation

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

      • hasPlaceId

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

      • getPlaceId

        public String getPlaceId()
         The POI Place ID associated with the waypoint.
        string place_id = 2;
        Specified by:
        getPlaceId in interface WaypointOrBuilder
        Returns:
        The placeId.

      • getPlaceIdBytes

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

      • hasAddress

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

      • getAddress

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

      • getAddressBytes

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

      • getVia

        public 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;
        Specified by:
        getVia in interface WaypointOrBuilder
        Returns:
        The via.

      • getVehicleStopover

        public 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;
        Specified by:
        getVehicleStopover in interface WaypointOrBuilder
        Returns:
        The vehicleStopover.

      • getSideOfRoad

        public 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;
        Specified by:
        getSideOfRoad in interface WaypointOrBuilder
        Returns:
        The sideOfRoad.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Waypoint parseFrom​(ByteBuffer data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Waypoint parseFrom​(ByteBuffer data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Waypoint parseFrom​(com.google.protobuf.ByteString data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Waypoint parseFrom​(com.google.protobuf.ByteString data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Waypoint parseFrom​(byte[] data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Waypoint parseFrom​(byte[] data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Waypoint parseFrom​(com.google.protobuf.CodedInputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Waypoint.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Waypoint.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Waypoint.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Waypoint getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Waypoint> parser()

      • getParserForType

        public com.google.protobuf.Parser<Waypoint> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Waypoint getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder