com.amazonaws.services.location.model

Class CalculateRouteRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.location.model.CalculateRouteRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CalculateRouteRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CalculateRouteRequest()

Method Summary

Modifier and Type	Method and Description
CalculateRouteRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getCalculatorName() The name of the route calculator resource that you want to use to calculate the route.
CalculateRouteCarModeOptions	getCarModeOptions() Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or tolls.
Boolean	getDepartNow() Sets the time of departure as the current time.
List<Double>	getDeparturePosition() The start position for the route.
Date	getDepartureTime() Specifies the desired time of departure.
List<Double>	getDestinationPosition() The finish position for the route.
String	getDistanceUnit() Set the unit system to specify the distance.
Boolean	getIncludeLegGeometry() Set to include the geometry details in the result for each path between a pair of positions.
String	getTravelMode() Specifies the mode of transport when calculating a route.
CalculateRouteTruckModeOptions	getTruckModeOptions() Specifies route preferences when traveling by Truck, such as avoiding routes that use ferries or tolls, and truck specifications to consider when choosing an optimal road.
List<List<Double>>	getWaypointPositions() Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position.
int	hashCode()
Boolean	isDepartNow() Sets the time of departure as the current time.
Boolean	isIncludeLegGeometry() Set to include the geometry details in the result for each path between a pair of positions.
void	setCalculatorName(String calculatorName) The name of the route calculator resource that you want to use to calculate the route.
void	setCarModeOptions(CalculateRouteCarModeOptions carModeOptions) Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or tolls.
void	setDepartNow(Boolean departNow) Sets the time of departure as the current time.
void	setDeparturePosition(Collection<Double> departurePosition) The start position for the route.
void	setDepartureTime(Date departureTime) Specifies the desired time of departure.
void	setDestinationPosition(Collection<Double> destinationPosition) The finish position for the route.
void	setDistanceUnit(String distanceUnit) Set the unit system to specify the distance.
void	setIncludeLegGeometry(Boolean includeLegGeometry) Set to include the geometry details in the result for each path between a pair of positions.
void	setTravelMode(String travelMode) Specifies the mode of transport when calculating a route.
void	setTruckModeOptions(CalculateRouteTruckModeOptions truckModeOptions) Specifies route preferences when traveling by Truck, such as avoiding routes that use ferries or tolls, and truck specifications to consider when choosing an optimal road.
void	setWaypointPositions(Collection<List<Double>> waypointPositions) Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position.
String	toString() Returns a string representation of this object.
CalculateRouteRequest	withCalculatorName(String calculatorName) The name of the route calculator resource that you want to use to calculate the route.
CalculateRouteRequest	withCarModeOptions(CalculateRouteCarModeOptions carModeOptions) Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or tolls.
CalculateRouteRequest	withDepartNow(Boolean departNow) Sets the time of departure as the current time.
CalculateRouteRequest	withDeparturePosition(Collection<Double> departurePosition) The start position for the route.
CalculateRouteRequest	withDeparturePosition(Double... departurePosition) The start position for the route.
CalculateRouteRequest	withDepartureTime(Date departureTime) Specifies the desired time of departure.
CalculateRouteRequest	withDestinationPosition(Collection<Double> destinationPosition) The finish position for the route.
CalculateRouteRequest	withDestinationPosition(Double... destinationPosition) The finish position for the route.
CalculateRouteRequest	withDistanceUnit(DistanceUnit distanceUnit) Set the unit system to specify the distance.
CalculateRouteRequest	withDistanceUnit(String distanceUnit) Set the unit system to specify the distance.
CalculateRouteRequest	withIncludeLegGeometry(Boolean includeLegGeometry) Set to include the geometry details in the result for each path between a pair of positions.
CalculateRouteRequest	withTravelMode(String travelMode) Specifies the mode of transport when calculating a route.
CalculateRouteRequest	withTravelMode(TravelMode travelMode) Specifies the mode of transport when calculating a route.
CalculateRouteRequest	withTruckModeOptions(CalculateRouteTruckModeOptions truckModeOptions) Specifies route preferences when traveling by Truck, such as avoiding routes that use ferries or tolls, and truck specifications to consider when choosing an optimal road.
CalculateRouteRequest	withWaypointPositions(Collection<List<Double>> waypointPositions) Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position.
CalculateRouteRequest	withWaypointPositions(List<Double>... waypointPositions) Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CalculateRouteRequest

public CalculateRouteRequest()

Method Detail

setCalculatorName

public void setCalculatorName(String calculatorName)

The name of the route calculator resource that you want to use to calculate the route.

Parameters:

calculatorName - The name of the route calculator resource that you want to use to calculate the route.

getCalculatorName

public String getCalculatorName()

The name of the route calculator resource that you want to use to calculate the route.

Returns:

The name of the route calculator resource that you want to use to calculate the route.

withCalculatorName

public CalculateRouteRequest withCalculatorName(String calculatorName)

The name of the route calculator resource that you want to use to calculate the route.

Parameters:

calculatorName - The name of the route calculator resource that you want to use to calculate the route.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCarModeOptions

public void setCarModeOptions(CalculateRouteCarModeOptions carModeOptions)

Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or tolls.

Requirements: TravelMode must be specified as Car.

Parameters:

carModeOptions - Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or tolls.

Requirements: TravelMode must be specified as Car.

getCarModeOptions

public CalculateRouteCarModeOptions getCarModeOptions()

Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or tolls.

Requirements: TravelMode must be specified as Car.

Returns:

Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or tolls.

Requirements: TravelMode must be specified as Car.

withCarModeOptions

public CalculateRouteRequest withCarModeOptions(CalculateRouteCarModeOptions carModeOptions)

Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or tolls.

Requirements: TravelMode must be specified as Car.

Parameters:

carModeOptions - Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or tolls.

Requirements: TravelMode must be specified as Car.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDepartNow

public void setDepartNow(Boolean departNow)

Sets the time of departure as the current time. Uses the current time to calculate a route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

Default Value: false

Valid Values: false | true

Parameters:

departNow - Sets the time of departure as the current time. Uses the current time to calculate a route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

Default Value: false

Valid Values: false | true

getDepartNow

public Boolean getDepartNow()

Sets the time of departure as the current time. Uses the current time to calculate a route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

Default Value: false

Valid Values: false | true

Returns:

Sets the time of departure as the current time. Uses the current time to calculate a route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

Default Value: false

Valid Values: false | true

withDepartNow

public CalculateRouteRequest withDepartNow(Boolean departNow)

Sets the time of departure as the current time. Uses the current time to calculate a route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

Default Value: false

Valid Values: false | true

Parameters:

departNow - Sets the time of departure as the current time. Uses the current time to calculate a route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

Default Value: false

Valid Values: false | true

Returns:

Returns a reference to this object so that method calls can be chained together.

isDepartNow

public Boolean isDepartNow()

Sets the time of departure as the current time. Uses the current time to calculate a route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

Default Value: false

Valid Values: false | true

Returns:

Sets the time of departure as the current time. Uses the current time to calculate a route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

Default Value: false

Valid Values: false | true

getDeparturePosition

public List<Double> getDeparturePosition()

The start position for the route. Defined in World Geodetic System (WGS 84) format: [longitude, latitude].

• For example, [-123.115, 49.285]

If you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.

Valid Values: [-180 to 180,-90 to 90]

Returns:

The start position for the route. Defined in World Geodetic System (WGS 84) format: [longitude, latitude].

• For example, [-123.115, 49.285]

If you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.

Valid Values: [-180 to 180,-90 to 90]

setDeparturePosition

public void setDeparturePosition(Collection<Double> departurePosition)

The start position for the route. Defined in World Geodetic System (WGS 84) format: [longitude, latitude].

• For example, [-123.115, 49.285]

If you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.

Valid Values: [-180 to 180,-90 to 90]

Parameters:

departurePosition - The start position for the route. Defined in World Geodetic System (WGS 84) format: [longitude, latitude].

• For example, [-123.115, 49.285]

If you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.

Valid Values: [-180 to 180,-90 to 90]

withDeparturePosition

public CalculateRouteRequest withDeparturePosition(Double... departurePosition)

The start position for the route. Defined in World Geodetic System (WGS 84) format: [longitude, latitude].

• For example, [-123.115, 49.285]

If you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.

Valid Values: [-180 to 180,-90 to 90]

NOTE: This method appends the values to the existing list (if any). Use setDeparturePosition(java.util.Collection) or withDeparturePosition(java.util.Collection) if you want to override the existing values.

Parameters:

departurePosition - The start position for the route. Defined in World Geodetic System (WGS 84) format: [longitude, latitude].

• For example, [-123.115, 49.285]

If you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.

Valid Values: [-180 to 180,-90 to 90]

Returns:

Returns a reference to this object so that method calls can be chained together.

withDeparturePosition

public CalculateRouteRequest withDeparturePosition(Collection<Double> departurePosition)

The start position for the route. Defined in World Geodetic System (WGS 84) format: [longitude, latitude].

• For example, [-123.115, 49.285]

If you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.

Valid Values: [-180 to 180,-90 to 90]

Parameters:

departurePosition - The start position for the route. Defined in World Geodetic System (WGS 84) format: [longitude, latitude].

• For example, [-123.115, 49.285]

If you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.

Valid Values: [-180 to 180,-90 to 90]

Returns:

Returns a reference to this object so that method calls can be chained together.

setDepartureTime

public void setDepartureTime(Date departureTime)

Specifies the desired time of departure. Uses the given time to calculate the route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

Setting a departure time in the past returns a 400 ValidationException error.

• In ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00

Parameters:

departureTime - Specifies the desired time of departure. Uses the given time to calculate the route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

Setting a departure time in the past returns a 400 ValidationException error.

• In ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00

getDepartureTime

public Date getDepartureTime()

Specifies the desired time of departure. Uses the given time to calculate the route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

Setting a departure time in the past returns a 400 ValidationException error.

• In ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00

Returns:

Specifies the desired time of departure. Uses the given time to calculate the route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

Setting a departure time in the past returns a 400 ValidationException error.

• In ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00

withDepartureTime

public CalculateRouteRequest withDepartureTime(Date departureTime)

Specifies the desired time of departure. Uses the given time to calculate the route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

Setting a departure time in the past returns a 400 ValidationException error.

• In ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00

Parameters:

departureTime - Specifies the desired time of departure. Uses the given time to calculate the route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

Setting a departure time in the past returns a 400 ValidationException error.

• In ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00

Returns:

Returns a reference to this object so that method calls can be chained together.

getDestinationPosition

public List<Double> getDestinationPosition()

The finish position for the route. Defined in World Geodetic System (WGS 84) format: [longitude, latitude].

• For example, [-122.339, 47.615]

If you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road.

Valid Values: [-180 to 180,-90 to 90]

Returns:

The finish position for the route. Defined in World Geodetic System (WGS 84) format: [longitude, latitude].

• For example, [-122.339, 47.615]

If you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road.

Valid Values: [-180 to 180,-90 to 90]

setDestinationPosition

public void setDestinationPosition(Collection<Double> destinationPosition)

The finish position for the route. Defined in World Geodetic System (WGS 84) format: [longitude, latitude].

• For example, [-122.339, 47.615]

If you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road.

Valid Values: [-180 to 180,-90 to 90]

Parameters:

destinationPosition - The finish position for the route. Defined in World Geodetic System (WGS 84) format: [longitude, latitude].

• For example, [-122.339, 47.615]

If you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road.

Valid Values: [-180 to 180,-90 to 90]

withDestinationPosition

public CalculateRouteRequest withDestinationPosition(Double... destinationPosition)

The finish position for the route. Defined in World Geodetic System (WGS 84) format: [longitude, latitude].

• For example, [-122.339, 47.615]

If you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road.

Valid Values: [-180 to 180,-90 to 90]

NOTE: This method appends the values to the existing list (if any). Use setDestinationPosition(java.util.Collection) or withDestinationPosition(java.util.Collection) if you want to override the existing values.

Parameters:

destinationPosition - The finish position for the route. Defined in World Geodetic System (WGS 84) format: [longitude, latitude].

• For example, [-122.339, 47.615]

If you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road.

Valid Values: [-180 to 180,-90 to 90]

Returns:

Returns a reference to this object so that method calls can be chained together.

withDestinationPosition

public CalculateRouteRequest withDestinationPosition(Collection<Double> destinationPosition)

The finish position for the route. Defined in World Geodetic System (WGS 84) format: [longitude, latitude].

• For example, [-122.339, 47.615]

If you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road.

Valid Values: [-180 to 180,-90 to 90]

Parameters:

destinationPosition - The finish position for the route. Defined in World Geodetic System (WGS 84) format: [longitude, latitude].

• For example, [-122.339, 47.615]

If you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road.

Valid Values: [-180 to 180,-90 to 90]

Returns:

Returns a reference to this object so that method calls can be chained together.

setDistanceUnit

public void setDistanceUnit(String distanceUnit)

Set the unit system to specify the distance.

Default Value: Kilometers

Parameters:

distanceUnit - Set the unit system to specify the distance.

Default Value: Kilometers

See Also:

DistanceUnit

getDistanceUnit

public String getDistanceUnit()

Set the unit system to specify the distance.

Default Value: Kilometers

Returns:

Set the unit system to specify the distance.

Default Value: Kilometers

See Also:

DistanceUnit

withDistanceUnit

public CalculateRouteRequest withDistanceUnit(String distanceUnit)

Set the unit system to specify the distance.

Default Value: Kilometers

Parameters:

distanceUnit - Set the unit system to specify the distance.

Default Value: Kilometers

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DistanceUnit

withDistanceUnit

public CalculateRouteRequest withDistanceUnit(DistanceUnit distanceUnit)

Set the unit system to specify the distance.

Default Value: Kilometers

Parameters:

distanceUnit - Set the unit system to specify the distance.

Default Value: Kilometers

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DistanceUnit

setIncludeLegGeometry

public void setIncludeLegGeometry(Boolean includeLegGeometry)

Set to include the geometry details in the result for each path between a pair of positions.

Default Value: false

Valid Values: false | true

Parameters:

includeLegGeometry - Set to include the geometry details in the result for each path between a pair of positions.

Default Value: false

Valid Values: false | true

getIncludeLegGeometry

public Boolean getIncludeLegGeometry()

Set to include the geometry details in the result for each path between a pair of positions.

Default Value: false

Valid Values: false | true

Returns:

Set to include the geometry details in the result for each path between a pair of positions.

Default Value: false

Valid Values: false | true

withIncludeLegGeometry

public CalculateRouteRequest withIncludeLegGeometry(Boolean includeLegGeometry)

Set to include the geometry details in the result for each path between a pair of positions.

Default Value: false

Valid Values: false | true

Parameters:

includeLegGeometry - Set to include the geometry details in the result for each path between a pair of positions.

Default Value: false

Valid Values: false | true

Returns:

Returns a reference to this object so that method calls can be chained together.

isIncludeLegGeometry

public Boolean isIncludeLegGeometry()

Set to include the geometry details in the result for each path between a pair of positions.

Default Value: false

Valid Values: false | true

Returns:

Set to include the geometry details in the result for each path between a pair of positions.

Default Value: false

Valid Values: false | true

setTravelMode

public void setTravelMode(String travelMode)

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. You can choose Car, Truck, or Walking as options for the TravelMode.

The TravelMode you specify also determines how you specify route preferences:

• If traveling by Car use the CarModeOptions parameter.

• If traveling by Truck use the TruckModeOptions parameter.

Default Value: Car

Parameters:

travelMode - Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. You can choose Car, Truck, or Walking as options for the TravelMode.

The TravelMode you specify also determines how you specify route preferences:

• If traveling by Car use the CarModeOptions parameter.

• If traveling by Truck use the TruckModeOptions parameter.

Default Value: Car

See Also:

TravelMode

getTravelMode

public String getTravelMode()

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. You can choose Car, Truck, or Walking as options for the TravelMode.

The TravelMode you specify also determines how you specify route preferences:

• If traveling by Car use the CarModeOptions parameter.

• If traveling by Truck use the TruckModeOptions parameter.

Default Value: Car

Returns:

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. You can choose Car, Truck, or Walking as options for the TravelMode.

The TravelMode you specify also determines how you specify route preferences:

• If traveling by Car use the CarModeOptions parameter.

• If traveling by Truck use the TruckModeOptions parameter.

Default Value: Car

See Also:

TravelMode

withTravelMode

public CalculateRouteRequest withTravelMode(String travelMode)

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. You can choose Car, Truck, or Walking as options for the TravelMode.

The TravelMode you specify also determines how you specify route preferences:

• If traveling by Car use the CarModeOptions parameter.

• If traveling by Truck use the TruckModeOptions parameter.

Default Value: Car

Parameters:

travelMode - Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. You can choose Car, Truck, or Walking as options for the TravelMode.

The TravelMode you specify also determines how you specify route preferences:

• If traveling by Car use the CarModeOptions parameter.

• If traveling by Truck use the TruckModeOptions parameter.

Default Value: Car

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

TravelMode

withTravelMode

public CalculateRouteRequest withTravelMode(TravelMode travelMode)

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. You can choose Car, Truck, or Walking as options for the TravelMode.

The TravelMode you specify also determines how you specify route preferences:

• If traveling by Car use the CarModeOptions parameter.

• If traveling by Truck use the TruckModeOptions parameter.

Default Value: Car

Parameters:

travelMode - Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. You can choose Car, Truck, or Walking as options for the TravelMode.

The TravelMode you specify also determines how you specify route preferences:

• If traveling by Car use the CarModeOptions parameter.

• If traveling by Truck use the TruckModeOptions parameter.

Default Value: Car

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

TravelMode

setTruckModeOptions

public void setTruckModeOptions(CalculateRouteTruckModeOptions truckModeOptions)

Specifies route preferences when traveling by Truck, such as avoiding routes that use ferries or tolls, and truck specifications to consider when choosing an optimal road.

Requirements: TravelMode must be specified as Truck.

Parameters:

truckModeOptions - Specifies route preferences when traveling by Truck, such as avoiding routes that use ferries or tolls, and truck specifications to consider when choosing an optimal road.

Requirements: TravelMode must be specified as Truck.

getTruckModeOptions

public CalculateRouteTruckModeOptions getTruckModeOptions()

Specifies route preferences when traveling by Truck, such as avoiding routes that use ferries or tolls, and truck specifications to consider when choosing an optimal road.

Requirements: TravelMode must be specified as Truck.

Returns:

Specifies route preferences when traveling by Truck, such as avoiding routes that use ferries or tolls, and truck specifications to consider when choosing an optimal road.

Requirements: TravelMode must be specified as Truck.

withTruckModeOptions

public CalculateRouteRequest withTruckModeOptions(CalculateRouteTruckModeOptions truckModeOptions)

Specifies route preferences when traveling by Truck, such as avoiding routes that use ferries or tolls, and truck specifications to consider when choosing an optimal road.

Requirements: TravelMode must be specified as Truck.

Parameters:

truckModeOptions - Specifies route preferences when traveling by Truck, such as avoiding routes that use ferries or tolls, and truck specifications to consider when choosing an optimal road.

Requirements: TravelMode must be specified as Truck.

Returns:

Returns a reference to this object so that method calls can be chained together.

getWaypointPositions

public List<List<Double>> getWaypointPositions()

Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position.

• For example, from the DeparturePosition [-123.115, 49.285], the route follows the order that the waypoint positions are given [[-122.757, 49.0021],[-122.349, 47.620]]

If you specify a waypoint position that's not located on a road, Amazon Location moves the position to the nearest road.

Specifying more than 23 waypoints returns a 400 ValidationException error.

If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.

Valid Values: [-180 to 180,-90 to 90]

Returns:

Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position.

• For example, from the DeparturePosition [-123.115, 49.285], the route follows the order that the waypoint positions are given [[-122.757, 49.0021],[-122.349, 47.620]]

If you specify a waypoint position that's not located on a road, Amazon Location moves the position to the nearest road.

Specifying more than 23 waypoints returns a 400 ValidationException error.

If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.

Valid Values: [-180 to 180,-90 to 90]

setWaypointPositions

public void setWaypointPositions(Collection<List<Double>> waypointPositions)

Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position.

• For example, from the DeparturePosition [-123.115, 49.285], the route follows the order that the waypoint positions are given [[-122.757, 49.0021],[-122.349, 47.620]]

If you specify a waypoint position that's not located on a road, Amazon Location moves the position to the nearest road.

Specifying more than 23 waypoints returns a 400 ValidationException error.

If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.

Valid Values: [-180 to 180,-90 to 90]

Parameters:

waypointPositions - Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position.

• For example, from the DeparturePosition [-123.115, 49.285], the route follows the order that the waypoint positions are given [[-122.757, 49.0021],[-122.349, 47.620]]

If you specify a waypoint position that's not located on a road, Amazon Location moves the position to the nearest road.

Specifying more than 23 waypoints returns a 400 ValidationException error.

If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.

Valid Values: [-180 to 180,-90 to 90]

withWaypointPositions

public CalculateRouteRequest withWaypointPositions(List<Double>... waypointPositions)

Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position.

• For example, from the DeparturePosition [-123.115, 49.285], the route follows the order that the waypoint positions are given [[-122.757, 49.0021],[-122.349, 47.620]]

If you specify a waypoint position that's not located on a road, Amazon Location moves the position to the nearest road.

Specifying more than 23 waypoints returns a 400 ValidationException error.

If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.

Valid Values: [-180 to 180,-90 to 90]

NOTE: This method appends the values to the existing list (if any). Use setWaypointPositions(java.util.Collection) or withWaypointPositions(java.util.Collection) if you want to override the existing values.

Parameters:

waypointPositions - Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position.

• For example, from the DeparturePosition [-123.115, 49.285], the route follows the order that the waypoint positions are given [[-122.757, 49.0021],[-122.349, 47.620]]

If you specify a waypoint position that's not located on a road, Amazon Location moves the position to the nearest road.

Specifying more than 23 waypoints returns a 400 ValidationException error.

If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.

Valid Values: [-180 to 180,-90 to 90]

Returns:

Returns a reference to this object so that method calls can be chained together.

withWaypointPositions

public CalculateRouteRequest withWaypointPositions(Collection<List<Double>> waypointPositions)

Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position.

• For example, from the DeparturePosition [-123.115, 49.285], the route follows the order that the waypoint positions are given [[-122.757, 49.0021],[-122.349, 47.620]]

If you specify a waypoint position that's not located on a road, Amazon Location moves the position to the nearest road.

Specifying more than 23 waypoints returns a 400 ValidationException error.

If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.

Valid Values: [-180 to 180,-90 to 90]

Parameters:

waypointPositions - Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position.

• For example, from the DeparturePosition [-123.115, 49.285], the route follows the order that the waypoint positions are given [[-122.757, 49.0021],[-122.349, 47.620]]

If you specify a waypoint position that's not located on a road, Amazon Location moves the position to the nearest road.

Specifying more than 23 waypoints returns a 400 ValidationException error.

If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.

Valid Values: [-180 to 180,-90 to 90]

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CalculateRouteRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()