Class Waypoint (1.45.0)

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

Implements

WaypointOrBuilder

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()
Returns
Type Description
Waypoint

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Waypoint.Builder newBuilder()
Returns
Type Description
Waypoint.Builder

newBuilder(Waypoint prototype)

public static Waypoint.Builder newBuilder(Waypoint prototype)
Parameter
Name Description
prototype Waypoint
Returns
Type Description
Waypoint.Builder

parseDelimitedFrom(InputStream input)

public static Waypoint parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Waypoint
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Waypoint parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Waypoint
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Waypoint parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Waypoint
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Waypoint parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Waypoint
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Waypoint parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Waypoint
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Waypoint parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Waypoint
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Waypoint parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Waypoint
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Waypoint parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Waypoint
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Waypoint parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Waypoint
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Waypoint parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Waypoint
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Waypoint parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Waypoint
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Waypoint parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Waypoint
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Waypoint> parser()
Returns
Type Description
Parser<Waypoint>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Waypoint getDefaultInstanceForType()
Returns
Type Description
Waypoint

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;

Returns
Type Description
LocationOrBuilder

getLocationTypeCase()

public Waypoint.LocationTypeCase getLocationTypeCase()
Returns
Type Description
Waypoint.LocationTypeCase

getParserForType()

public Parser<Waypoint> getParserForType()
Returns
Type Description
Parser<Waypoint>
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()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Waypoint.Builder newBuilderForType()
Returns
Type Description
Waypoint.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Waypoint.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Waypoint.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Waypoint.Builder toBuilder()
Returns
Type Description
Waypoint.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException