Class Waypoint.Builder (1.83.0)

public static final class Waypoint.Builder extends GeneratedMessage.Builder<Waypoint.Builder> 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 Methods

getDescriptor()

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

Methods

build()

public Waypoint build()
Returns
Type Description
Waypoint

buildPartial()

public Waypoint buildPartial()
Returns
Type Description
Waypoint

clear()

public Waypoint.Builder clear()
Returns
Type Description
Waypoint.Builder
Overrides

clearLocation()

public Waypoint.Builder clearLocation()

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

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

Returns
Type Description
Waypoint.Builder

clearLocationType()

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

clearPlaceId()

public Waypoint.Builder clearPlaceId()

The POI Place ID associated with the waypoint.

string place_id = 2;

Returns
Type Description
Waypoint.Builder

This builder for chaining.

clearSideOfRoad()

public Waypoint.Builder clearSideOfRoad()

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
Waypoint.Builder

This builder for chaining.

getDefaultInstanceForType()

public Waypoint getDefaultInstanceForType()
Returns
Type Description
Waypoint

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getLocationBuilder()

public Location.Builder getLocationBuilder()

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

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

Returns
Type Description
Location.Builder

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

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Waypoint other)

public Waypoint.Builder mergeFrom(Waypoint other)
Parameter
Name Description
other Waypoint
Returns
Type Description
Waypoint.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Waypoint.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Waypoint.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Waypoint.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Waypoint.Builder
Overrides

mergeLocation(Location value)

public Waypoint.Builder mergeLocation(Location value)

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

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

Parameter
Name Description
value Location
Returns
Type Description
Waypoint.Builder

setLocation(Location value)

public Waypoint.Builder setLocation(Location value)

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

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

Parameter
Name Description
value Location
Returns
Type Description
Waypoint.Builder

setLocation(Location.Builder builderForValue)

public Waypoint.Builder setLocation(Location.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Location.Builder
Returns
Type Description
Waypoint.Builder

setPlaceId(String value)

public Waypoint.Builder setPlaceId(String value)

The POI Place ID associated with the waypoint.

string place_id = 2;

Parameter
Name Description
value String

The placeId to set.

Returns
Type Description
Waypoint.Builder

This builder for chaining.

setPlaceIdBytes(ByteString value)

public Waypoint.Builder setPlaceIdBytes(ByteString value)

The POI Place ID associated with the waypoint.

string place_id = 2;

Parameter
Name Description
value ByteString

The bytes for placeId to set.

Returns
Type Description
Waypoint.Builder

This builder for chaining.

setSideOfRoad(boolean value)

public Waypoint.Builder setSideOfRoad(boolean value)

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;

Parameter
Name Description
value boolean

The sideOfRoad to set.

Returns
Type Description
Waypoint.Builder

This builder for chaining.