Class Waypoint (1.20.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
TypeDescription
int

PLACE_ID_FIELD_NUMBER

public static final int PLACE_ID_FIELD_NUMBER
Field Value
TypeDescription
int

SIDE_OF_ROAD_FIELD_NUMBER

public static final int SIDE_OF_ROAD_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Waypoint getDefaultInstance()
Returns
TypeDescription
Waypoint

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Waypoint.Builder newBuilder()
Returns
TypeDescription
Waypoint.Builder

newBuilder(Waypoint prototype)

public static Waypoint.Builder newBuilder(Waypoint prototype)
Parameter
NameDescription
prototypeWaypoint
Returns
TypeDescription
Waypoint.Builder

parseDelimitedFrom(InputStream input)

public static Waypoint parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Waypoint
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Waypoint parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Waypoint
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Waypoint parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Waypoint
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Waypoint parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Waypoint
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Waypoint parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Waypoint
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Waypoint parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Waypoint
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Waypoint parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Waypoint
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Waypoint parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Waypoint
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Waypoint parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Waypoint
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Waypoint parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Waypoint
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Waypoint parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Waypoint
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Waypoint parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Waypoint
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Waypoint> parser()
Returns
TypeDescription
Parser<Waypoint>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public Waypoint getDefaultInstanceForType()
Returns
TypeDescription
Waypoint

getLocation()

public Location getLocation()

A point specified using geographic coordinates, including an optional heading.

.google.cloud.optimization.v1.Location location = 1;

Returns
TypeDescription
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
TypeDescription
LocationOrBuilder

getLocationTypeCase()

public Waypoint.LocationTypeCase getLocationTypeCase()
Returns
TypeDescription
Waypoint.LocationTypeCase

getParserForType()

public Parser<Waypoint> getParserForType()
Returns
TypeDescription
Parser<Waypoint>
Overrides

getPlaceId()

public String getPlaceId()

The POI Place ID associated with the waypoint.

string place_id = 2;

Returns
TypeDescription
String

The placeId.

getPlaceIdBytes()

public ByteString getPlaceIdBytes()

The POI Place ID associated with the waypoint.

string place_id = 2;

Returns
TypeDescription
ByteString

The bytes for placeId.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the location field is set.

hasPlaceId()

public boolean hasPlaceId()

The POI Place ID associated with the waypoint.

string place_id = 2;

Returns
TypeDescription
boolean

Whether the placeId field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Waypoint.Builder newBuilderForType()
Returns
TypeDescription
Waypoint.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Waypoint.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Waypoint.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Waypoint.Builder toBuilder()
Returns
TypeDescription
Waypoint.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException