com.amazonaws.services.location.model

Class CalculateRouteMatrixRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.location.model.CalculateRouteMatrixRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CalculateRouteMatrixRequest
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
CalculateRouteMatrixRequest()

Method Summary

Modifier and Type	Method and Description
CalculateRouteMatrixRequest	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 matrix.
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<List<Double>>	getDeparturePositions() The list of departure (origin) positions for the route matrix.
Date	getDepartureTime() Specifies the desired time of departure.
List<List<Double>>	getDestinationPositions() The list of destination positions for the route matrix.
String	getDistanceUnit() Set the unit system to specify the distance.
String	getKey() The optional API key to authorize the request.
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.
int	hashCode()
Boolean	isDepartNow() Sets the time of departure as the current time.
void	setCalculatorName(String calculatorName) The name of the route calculator resource that you want to use to calculate the route matrix.
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	setDeparturePositions(Collection<List<Double>> departurePositions) The list of departure (origin) positions for the route matrix.
void	setDepartureTime(Date departureTime) Specifies the desired time of departure.
void	setDestinationPositions(Collection<List<Double>> destinationPositions) The list of destination positions for the route matrix.
void	setDistanceUnit(String distanceUnit) Set the unit system to specify the distance.
void	setKey(String key) The optional API key to authorize the request.
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.
String	toString() Returns a string representation of this object.
CalculateRouteMatrixRequest	withCalculatorName(String calculatorName) The name of the route calculator resource that you want to use to calculate the route matrix.
CalculateRouteMatrixRequest	withCarModeOptions(CalculateRouteCarModeOptions carModeOptions) Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or tolls.
CalculateRouteMatrixRequest	withDepartNow(Boolean departNow) Sets the time of departure as the current time.
CalculateRouteMatrixRequest	withDeparturePositions(Collection<List<Double>> departurePositions) The list of departure (origin) positions for the route matrix.
CalculateRouteMatrixRequest	withDeparturePositions(List<Double>... departurePositions) The list of departure (origin) positions for the route matrix.
CalculateRouteMatrixRequest	withDepartureTime(Date departureTime) Specifies the desired time of departure.
CalculateRouteMatrixRequest	withDestinationPositions(Collection<List<Double>> destinationPositions) The list of destination positions for the route matrix.
CalculateRouteMatrixRequest	withDestinationPositions(List<Double>... destinationPositions) The list of destination positions for the route matrix.
CalculateRouteMatrixRequest	withDistanceUnit(DistanceUnit distanceUnit) Set the unit system to specify the distance.
CalculateRouteMatrixRequest	withDistanceUnit(String distanceUnit) Set the unit system to specify the distance.
CalculateRouteMatrixRequest	withKey(String key) The optional API key to authorize the request.
CalculateRouteMatrixRequest	withTravelMode(String travelMode) Specifies the mode of transport when calculating a route.
CalculateRouteMatrixRequest	withTravelMode(TravelMode travelMode) Specifies the mode of transport when calculating a route.
CalculateRouteMatrixRequest	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.

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

CalculateRouteMatrixRequest

public CalculateRouteMatrixRequest()

Method Detail

setCalculatorName

public void setCalculatorName(String calculatorName)

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

Parameters:

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

getCalculatorName

public String getCalculatorName()

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

Returns:

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

withCalculatorName

public CalculateRouteMatrixRequest withCalculatorName(String calculatorName)

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

Parameters:

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

Returns:

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

getDeparturePositions

public List<List<Double>> getDeparturePositions()

The list of departure (origin) positions for the route matrix. An array of points, each of which is itself a 2-value array defined in WGS 84 format: [longitude, latitude]. For example, [-123.115, 49.285].

Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide.

For route calculators that use Esri as the data provider, if you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. The snapped value is available in the result in SnappedDeparturePositions.

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

Returns:

The list of departure (origin) positions for the route matrix. An array of points, each of which is itself a 2-value array defined in WGS 84 format: [longitude, latitude]. For example, [-123.115, 49.285].

Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide.

For route calculators that use Esri as the data provider, if you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. The snapped value is available in the result in SnappedDeparturePositions.

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

setDeparturePositions

public void setDeparturePositions(Collection<List<Double>> departurePositions)

The list of departure (origin) positions for the route matrix. An array of points, each of which is itself a 2-value array defined in WGS 84 format: [longitude, latitude]. For example, [-123.115, 49.285].

Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide.

For route calculators that use Esri as the data provider, if you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. The snapped value is available in the result in SnappedDeparturePositions.

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

Parameters:

departurePositions - The list of departure (origin) positions for the route matrix. An array of points, each of which is itself a 2-value array defined in WGS 84 format: [longitude, latitude]. For example, [-123.115, 49.285].

Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide.

For route calculators that use Esri as the data provider, if you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. The snapped value is available in the result in SnappedDeparturePositions.

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

withDeparturePositions

public CalculateRouteMatrixRequest withDeparturePositions(List<Double>... departurePositions)

The list of departure (origin) positions for the route matrix. An array of points, each of which is itself a 2-value array defined in WGS 84 format: [longitude, latitude]. For example, [-123.115, 49.285].

Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide.

For route calculators that use Esri as the data provider, if you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. The snapped value is available in the result in SnappedDeparturePositions.

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

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

Parameters:

departurePositions - The list of departure (origin) positions for the route matrix. An array of points, each of which is itself a 2-value array defined in WGS 84 format: [longitude, latitude]. For example, [-123.115, 49.285].

Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide.

For route calculators that use Esri as the data provider, if you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. The snapped value is available in the result in SnappedDeparturePositions.

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

Returns:

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

withDeparturePositions

public CalculateRouteMatrixRequest withDeparturePositions(Collection<List<Double>> departurePositions)

The list of departure (origin) positions for the route matrix. An array of points, each of which is itself a 2-value array defined in WGS 84 format: [longitude, latitude]. For example, [-123.115, 49.285].

Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide.

For route calculators that use Esri as the data provider, if you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. The snapped value is available in the result in SnappedDeparturePositions.

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

Parameters:

departurePositions - The list of departure (origin) positions for the route matrix. An array of points, each of which is itself a 2-value array defined in WGS 84 format: [longitude, latitude]. For example, [-123.115, 49.285].

Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide.

For route calculators that use Esri as the data provider, if you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. The snapped value is available in the result in SnappedDeparturePositions.

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

Returns:

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

getDestinationPositions

public List<List<Double>> getDestinationPositions()

The list of destination positions for the route matrix. An array of points, each of which is itself a 2-value array defined in WGS 84 format: [longitude, latitude]. For example, [-122.339, 47.615]

Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide.

For route calculators that use Esri as the data provider, if you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road. The snapped value is available in the result in SnappedDestinationPositions.

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

Returns:

The list of destination positions for the route matrix. An array of points, each of which is itself a 2-value array defined in WGS 84 format: [longitude, latitude]. For example, [-122.339, 47.615]

Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide.

For route calculators that use Esri as the data provider, if you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road. The snapped value is available in the result in SnappedDestinationPositions.

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

setDestinationPositions

public void setDestinationPositions(Collection<List<Double>> destinationPositions)

The list of destination positions for the route matrix. An array of points, each of which is itself a 2-value array defined in WGS 84 format: [longitude, latitude]. For example, [-122.339, 47.615]

Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide.

For route calculators that use Esri as the data provider, if you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road. The snapped value is available in the result in SnappedDestinationPositions.

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

Parameters:

destinationPositions - The list of destination positions for the route matrix. An array of points, each of which is itself a 2-value array defined in WGS 84 format: [longitude, latitude]. For example, [-122.339, 47.615]

Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide.

For route calculators that use Esri as the data provider, if you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road. The snapped value is available in the result in SnappedDestinationPositions.

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

withDestinationPositions

public CalculateRouteMatrixRequest withDestinationPositions(List<Double>... destinationPositions)

The list of destination positions for the route matrix. An array of points, each of which is itself a 2-value array defined in WGS 84 format: [longitude, latitude]. For example, [-122.339, 47.615]

Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide.

For route calculators that use Esri as the data provider, if you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road. The snapped value is available in the result in SnappedDestinationPositions.

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

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

Parameters:

destinationPositions - The list of destination positions for the route matrix. An array of points, each of which is itself a 2-value array defined in WGS 84 format: [longitude, latitude]. For example, [-122.339, 47.615]

Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide.

For route calculators that use Esri as the data provider, if you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road. The snapped value is available in the result in SnappedDestinationPositions.

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

Returns:

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

withDestinationPositions

public CalculateRouteMatrixRequest withDestinationPositions(Collection<List<Double>> destinationPositions)

The list of destination positions for the route matrix. An array of points, each of which is itself a 2-value array defined in WGS 84 format: [longitude, latitude]. For example, [-122.339, 47.615]

Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide.

For route calculators that use Esri as the data provider, if you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road. The snapped value is available in the result in SnappedDestinationPositions.

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

Parameters:

destinationPositions - The list of destination positions for the route matrix. An array of points, each of which is itself a 2-value array defined in WGS 84 format: [longitude, latitude]. For example, [-122.339, 47.615]

Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide.

For route calculators that use Esri as the data provider, if you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road. The snapped value is available in the result in SnappedDestinationPositions.

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

Returns:

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

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.

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.

Bicycle or Motorcycle are only valid when using Grab as a data provider, and only within Southeast Asia.

Truck is not available for Grab.

For more information about using Grab as a data provider, see GrabMaps in the Amazon Location Service Developer Guide.

Default Value: Car

Parameters:

travelMode - Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

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.

Bicycle or Motorcycle are only valid when using Grab as a data provider, and only within Southeast Asia.

Truck is not available for Grab.

For more information about using Grab as a data provider, see GrabMaps in the Amazon Location Service Developer Guide.

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.

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.

Bicycle or Motorcycle are only valid when using Grab as a data provider, and only within Southeast Asia.

Truck is not available for Grab.

For more information about using Grab as a data provider, see GrabMaps in the Amazon Location Service Developer Guide.

Default Value: Car

Returns:

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

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.

Bicycle or Motorcycle are only valid when using Grab as a data provider, and only within Southeast Asia.

Truck is not available for Grab.

For more information about using Grab as a data provider, see GrabMaps in the Amazon Location Service Developer Guide.

Default Value: Car

See Also:

TravelMode

withTravelMode

public CalculateRouteMatrixRequest withTravelMode(String travelMode)

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

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.

Bicycle or Motorcycle are only valid when using Grab as a data provider, and only within Southeast Asia.

Truck is not available for Grab.

For more information about using Grab as a data provider, see GrabMaps in the Amazon Location Service Developer Guide.

Default Value: Car

Parameters:

travelMode - Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

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.

Bicycle or Motorcycle are only valid when using Grab as a data provider, and only within Southeast Asia.

Truck is not available for Grab.

For more information about using Grab as a data provider, see GrabMaps in the Amazon Location Service Developer Guide.

Default Value: Car

Returns:

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

See Also:

TravelMode

withTravelMode

public CalculateRouteMatrixRequest withTravelMode(TravelMode travelMode)

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

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.

Bicycle or Motorcycle are only valid when using Grab as a data provider, and only within Southeast Asia.

Truck is not available for Grab.

For more information about using Grab as a data provider, see GrabMaps in the Amazon Location Service Developer Guide.

Default Value: Car

Parameters:

travelMode - Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

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.

Bicycle or Motorcycle are only valid when using Grab as a data provider, and only within Southeast Asia.

Truck is not available for Grab.

For more information about using Grab as a data provider, see GrabMaps in the Amazon Location Service Developer Guide.

Default Value: Car

Returns:

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

See Also:

TravelMode

setDepartureTime

public void setDepartureTime(Date departureTime)

Specifies the desired time of departure. Uses the given time to calculate the route matrix. You can't set both DepartureTime and DepartNow. If neither is set, the best time of day to travel with the best traffic conditions is used to calculate the route matrix.

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 matrix. You can't set both DepartureTime and DepartNow. If neither is set, the best time of day to travel with the best traffic conditions is used to calculate the route matrix.

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 matrix. You can't set both DepartureTime and DepartNow. If neither is set, the best time of day to travel with the best traffic conditions is used to calculate the route matrix.

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 matrix. You can't set both DepartureTime and DepartNow. If neither is set, the best time of day to travel with the best traffic conditions is used to calculate the route matrix.

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 CalculateRouteMatrixRequest withDepartureTime(Date departureTime)

Specifies the desired time of departure. Uses the given time to calculate the route matrix. You can't set both DepartureTime and DepartNow. If neither is set, the best time of day to travel with the best traffic conditions is used to calculate the route matrix.

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 matrix. You can't set both DepartureTime and DepartNow. If neither is set, the best time of day to travel with the best traffic conditions is used to calculate the route matrix.

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.

setDepartNow

public void setDepartNow(Boolean departNow)

Sets the time of departure as the current time. Uses the current time to calculate the route matrix. You can't set both DepartureTime and DepartNow. If neither is set, the best time of day to travel with the best traffic conditions is used to calculate the route matrix.

Default Value: false

Valid Values: false | true

Parameters:

departNow - Sets the time of departure as the current time. Uses the current time to calculate the route matrix. You can't set both DepartureTime and DepartNow. If neither is set, the best time of day to travel with the best traffic conditions is used to calculate the route matrix.

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 the route matrix. You can't set both DepartureTime and DepartNow. If neither is set, the best time of day to travel with the best traffic conditions is used to calculate the route matrix.

Default Value: false

Valid Values: false | true

Returns:

Sets the time of departure as the current time. Uses the current time to calculate the route matrix. You can't set both DepartureTime and DepartNow. If neither is set, the best time of day to travel with the best traffic conditions is used to calculate the route matrix.

Default Value: false

Valid Values: false | true

withDepartNow

public CalculateRouteMatrixRequest withDepartNow(Boolean departNow)

Sets the time of departure as the current time. Uses the current time to calculate the route matrix. You can't set both DepartureTime and DepartNow. If neither is set, the best time of day to travel with the best traffic conditions is used to calculate the route matrix.

Default Value: false

Valid Values: false | true

Parameters:

departNow - Sets the time of departure as the current time. Uses the current time to calculate the route matrix. You can't set both DepartureTime and DepartNow. If neither is set, the best time of day to travel with the best traffic conditions is used to calculate the route matrix.

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 the route matrix. You can't set both DepartureTime and DepartNow. If neither is set, the best time of day to travel with the best traffic conditions is used to calculate the route matrix.

Default Value: false

Valid Values: false | true

Returns:

Sets the time of departure as the current time. Uses the current time to calculate the route matrix. You can't set both DepartureTime and DepartNow. If neither is set, the best time of day to travel with the best traffic conditions is used to calculate the route matrix.

Default Value: false

Valid Values: false | true

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 CalculateRouteMatrixRequest 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 CalculateRouteMatrixRequest 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

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 CalculateRouteMatrixRequest 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.

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 CalculateRouteMatrixRequest 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.

setKey

public void setKey(String key)

The optional API key to authorize the request.

Parameters:

key - The optional API key to authorize the request.

getKey

public String getKey()

The optional API key to authorize the request.

Returns:

The optional API key to authorize the request.

withKey

public CalculateRouteMatrixRequest withKey(String key)

The optional API key to authorize the request.

Parameters:

key - The optional API key to authorize the request.

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 CalculateRouteMatrixRequest 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()