Send feedback
  
   
 
  
    
      Class Waypoint (1.65.0)
    
    
       
    
    
      
      Stay organized with collections
     
    
      
      Save and categorize content based on your preferences.
     
    
  
      
     
  
  
   
  
    
  
  
    
    
    
  Version 1.65.0keyboard_arrow_down  
  
 
    
    
    
    
      
  
  
  
    
public   final   class  Waypoint   extends   GeneratedMessageV3   implements   WaypointOrBuilder  
   
   Encapsulates a waypoint. Waypoints mark arrival and departure locations of
 VisitRequests, and start and end locations of Vehicles.
 Protobuf type google.cloud.optimization.v1.Waypoint
 
  
  
  
    Inherited Members 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT) 
    
    
      com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int) 
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>) 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int) 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
   
  Static Fields
   
  LOCATION_FIELD_NUMBER 
  
    
public   static   final   int   LOCATION_FIELD_NUMBER  
   
  
    
      
        Field Value  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  PLACE_ID_FIELD_NUMBER 
  
    
public   static   final   int   PLACE_ID_FIELD_NUMBER  
   
  
    
      
        Field Value  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  SIDE_OF_ROAD_FIELD_NUMBER 
  
    
public   static   final   int   SIDE_OF_ROAD_FIELD_NUMBER  
   
  
    
      
        Field Value  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  Static Methods
   
   
  getDefaultInstance() 
  
    
public   static   Waypoint   getDefaultInstance ()  
   
  
   
  getDescriptor() 
  
    
public   static   final   Descriptors . Descriptor   getDescriptor ()  
   
  
   
  newBuilder() 
  
    
public   static   Waypoint . Builder   newBuilder ()  
   
  
   
  newBuilder(Waypoint prototype) 
  
    
public   static   Waypoint . Builder   newBuilder ( Waypoint   prototype )  
   
  
    
      
        Parameter  
       
      
        Name  
        Description  
       
      
        prototype 
        Waypoint  
       
     
  
  
   
  
  
    
public   static   Waypoint   parseDelimitedFrom ( InputStream   input )  
   
  
  
  
   
  
  
    
public   static   Waypoint   parseDelimitedFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  parseFrom(byte[] data) 
  
    
public   static   Waypoint   parseFrom ( byte []   data )  
   
  
    
      
        Parameter  
       
      
        Name  
        Description  
       
      
        data 
        byte [] 
       
     
  
  
  
   
  parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   Waypoint   parseFrom ( byte []   data ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  parseFrom(ByteString data) 
  
    
public   static   Waypoint   parseFrom ( ByteString   data )  
   
  
  
  
   
  parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   Waypoint   parseFrom ( ByteString   data ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  
  
    
public   static   Waypoint   parseFrom ( CodedInputStream   input )  
   
  
  
  
   
  
  
    
public   static   Waypoint   parseFrom ( CodedInputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  
  
    
public   static   Waypoint   parseFrom ( InputStream   input )  
   
  
  
  
   
  
  
    
public   static   Waypoint   parseFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  parseFrom(ByteBuffer data) 
  
    
public   static   Waypoint   parseFrom ( ByteBuffer   data )  
   
  
  
  
   
  parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   Waypoint   parseFrom ( ByteBuffer   data ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  parser() 
  
    
public   static   Parser<Waypoint>   parser ()  
   
  
  Methods
   
   
  equals(Object obj) 
  
    
public   boolean   equals ( Object   obj )  
   
  
    
      
        Parameter  
       
      
        Name  
        Description  
       
      
        obj 
        Object  
       
     
  
  
  Overrides 
  
   
  getDefaultInstanceForType() 
  
    
public   Waypoint   getDefaultInstanceForType ()  
   
  
   
  getLocation() 
  
    
public   Location   getLocation ()  
   
   A point specified using geographic coordinates, including an optional
 heading.
 .google.cloud.optimization.v1.Location location = 1;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        Location  
        The location.
 
       
     
  
   
  getLocationOrBuilder() 
  
    
public   LocationOrBuilder   getLocationOrBuilder ()  
   
   A point specified using geographic coordinates, including an optional
 heading.
 .google.cloud.optimization.v1.Location location = 1;
 
  
   
  getLocationTypeCase() 
  
    
public   Waypoint . LocationTypeCase   getLocationTypeCase ()  
   
  
   
  getParserForType() 
  
    
public   Parser<Waypoint>   getParserForType ()  
   
  
  Overrides 
  
   
  getPlaceId() 
  
    
public   String   getPlaceId ()  
   
   The POI Place ID associated with the waypoint.
 string place_id = 2;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        String  
        The placeId.
 
       
     
  
   
  getPlaceIdBytes() 
  
    
public   ByteString   getPlaceIdBytes ()  
   
   The POI Place ID associated with the waypoint.
 string place_id = 2;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        ByteString  
        The bytes for placeId.
 
       
     
  
   
  getSerializedSize() 
  
    
public   int   getSerializedSize ()  
   
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  Overrides 
  
   
  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 the 'DRIVING' travel mode,
 and when the 'location_type' is set to 'location'.
 bool side_of_road = 3;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        boolean  
        The sideOfRoad.
 
       
     
  
   
  hasLocation() 
  
    
public   boolean   hasLocation ()  
   
   A point specified using geographic coordinates, including an optional
 heading.
 .google.cloud.optimization.v1.Location location = 1;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        boolean  
        Whether the location field is set.
 
       
     
  
   
  hasPlaceId() 
  
    
public   boolean   hasPlaceId ()  
   
   The POI Place ID associated with the waypoint.
 string place_id = 2;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        boolean  
        Whether the placeId field is set.
 
       
     
  
   
  hashCode() 
  
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  Overrides 
  
   
  internalGetFieldAccessorTable() 
  
    
protected   GeneratedMessageV3 . FieldAccessorTable   internalGetFieldAccessorTable ()  
   
  
  Overrides 
  
   
  isInitialized() 
  
    
public   final   boolean   isInitialized ()  
   
  
  Overrides 
  
   
  newBuilderForType() 
  
    
public   Waypoint . Builder   newBuilderForType ()  
   
  
   
  newBuilderForType(GeneratedMessageV3.BuilderParent parent) 
  
    
protected   Waypoint . Builder   newBuilderForType ( GeneratedMessageV3 . BuilderParent   parent )  
   
  
  
  Overrides 
  
   
  newInstance(GeneratedMessageV3.UnusedPrivateParameter unused) 
  
    
protected   Object   newInstance ( GeneratedMessageV3 . UnusedPrivateParameter   unused )  
   
  
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        Object  
         
       
     
  
  Overrides 
  
   
  toBuilder() 
  
    
public   Waypoint . Builder   toBuilder ()  
   
  
   
  writeTo(CodedOutputStream output) 
  
    
public   void   writeTo ( CodedOutputStream   output )  
   
  
  Overrides 
  
  
 
     
    
  
  
  
     
  
 
  
    
    
      
    
     
  
       
         
  
  
    
    Send feedback
  
   
 
       
    
    
  
  
 
  Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
  Last updated 2025-10-30 UTC.
 
 
  
  
    
    
    
      
  
  
    Need to tell us more?
  
   
 
     
  
  
    
      [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-30 UTC."],[],[]]