/* * Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.geo.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; /** *

* Calculates a route matrix given the following required parameters: * DeparturePositions and DestinationPositions. * CalculateRouteMatrix calculates routes and returns the travel * time and travel distance from each departure position to each destination * position in the request. For example, given departure positions A and B, and * destination positions X and Y, CalculateRouteMatrix will return * time and distance for routes from A to X, A to Y, B to X, and B to Y (in that * order). The number of results returned (and routes calculated) will be the * number of DeparturePositions times the number of * DestinationPositions. *

* *

* Your account is charged for each route calculated, not the number of * requests. *

* *

* Requires that you first create a route calculator resource. *

* By default, a request that doesn't specify a departure time uses the best * time of day to travel with the best traffic conditions when calculating * routes. *

* Additional options include: *

*
* Specifying a departure time using either DepartureTime or * DepartNow. This calculates routes based on predictive traffic * data at the given time. *
* *
* You can't specify both DepartureTime and DepartNow * in a single request. Specifying both parameters returns a validation error. *
*
*
* Specifying a travel mode using TravelMode sets the transportation mode * used to calculate the routes. This also lets you specify additional route * preferences in CarModeOptions if traveling by Car, * or TruckModeOptions if traveling by Truck. *
*

*/ public class CalculateRouteMatrixRequest extends AmazonWebServiceRequest implements Serializable { /** *

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

* Constraints:
* Length: 1 - 100
* Pattern: ^[-._\w]+$
*/ private String calculatorName; /** *

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

* Requirements: TravelMode must be specified as * Car. *

*/ private CalculateRouteCarModeOptions carModeOptions; /** *

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

*/ private Boolean departNow; /** *

* 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] *

*/ private java.util.List> departurePositions; /** *

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

*/ private java.util.Date departureTime; /** *

* 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] *

* *

* 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] *

*/ private java.util.List> destinationPositions; /** *

* Set the unit system to specify the distance. *

* Default Value: Kilometers *

* Constraints:
* Allowed Values: Kilometers, Miles */ private String distanceUnit; /** *

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

* Constraints:
* Allowed Values: Car, Truck, Walking, Bicycle, Motorcycle */ private String travelMode; /** *

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

*/ private CalculateRouteTruckModeOptions truckModeOptions; /** *

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

* Constraints:
* Length: 1 - 100
* Pattern: ^[-._\w]+$
* * @return

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

*/ public String getCalculatorName() { return calculatorName; } /** *

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

* Constraints:
* Length: 1 - 100
* Pattern: ^[-._\w]+$
* * @param calculatorName

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

*/ public void setCalculatorName(String calculatorName) { this.calculatorName = calculatorName; } /** *

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

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

* Constraints:
* Length: 1 - 100
* Pattern: ^[-._\w]+$
* * @param calculatorName

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

* @return A reference to this updated object so that method calls can be * chained together. */ public CalculateRouteMatrixRequest withCalculatorName(String calculatorName) { this.calculatorName = calculatorName; return this; } /** *

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

* Requirements: TravelMode must be specified as * Car. *

* * @return

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

* Requirements: TravelMode must be specified as * Car. *

*/ public CalculateRouteCarModeOptions getCarModeOptions() { return carModeOptions; } /** *

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

* Requirements: TravelMode must be specified as * Car. *

* * @param carModeOptions

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

* Requirements: TravelMode must be specified as * Car. *

*/ public void setCarModeOptions(CalculateRouteCarModeOptions carModeOptions) { this.carModeOptions = 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 a reference to this object so that method calls can be chained * together. * * @param carModeOptions

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

* Requirements: TravelMode must be specified as * Car. *

* @return A reference to this updated object so that method calls can be * chained together. */ public CalculateRouteMatrixRequest withCarModeOptions( CalculateRouteCarModeOptions carModeOptions) { this.carModeOptions = carModeOptions; return this; } /** *

* Default Value: false *

* Valid Values: false | true *

* * @return

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

*/ public Boolean isDepartNow() { return departNow; } /** *

* Default Value: false *

* Valid Values: false | true *

* * @return

* Default Value: false *

* Valid Values: false | true *

*/ public Boolean getDepartNow() { return departNow; } /** *

* Default Value: false *

* Valid Values: false | true *

* * @param 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 *

*/ public void setDepartNow(Boolean departNow) { this.departNow = departNow; } /** *

* Default Value: false *

* Valid Values: false | true *

* Returns a reference to this object so that method calls can be chained * together. * * @param departNow

* Default Value: false *

* Valid Values: false | true *

* @return A reference to this updated object so that method calls can be * chained together. */ public CalculateRouteMatrixRequest withDepartNow(Boolean departNow) { this.departNow = departNow; return this; } /** *

* *

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

* * @return

* 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] *

*/ public java.util.List> getDeparturePositions() { return departurePositions; } /** *

* *

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

* * @param 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] *

*/ public void setDeparturePositions( java.util.Collection> departurePositions) { if (departurePositions == null) { this.departurePositions = null; return; } this.departurePositions = new java.util.ArrayList>( departurePositions); } /** *

* *

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

* Returns a reference to this object so that method calls can be chained * together. * * @param departurePositions

* *

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

* @return A reference to this updated object so that method calls can be * chained together. */ public CalculateRouteMatrixRequest withDeparturePositions( java.util.List... departurePositions) { if (getDeparturePositions() == null) { this.departurePositions = new java.util.ArrayList>( departurePositions.length); } for (java.util.List value : departurePositions) { this.departurePositions.add(value); } return this; } /** *

* *

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

* Returns a reference to this object so that method calls can be chained * together. * * @param departurePositions

* *

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

* @return A reference to this updated object so that method calls can be * chained together. */ public CalculateRouteMatrixRequest withDeparturePositions( java.util.Collection> departurePositions) { setDeparturePositions(departurePositions); return this; } /** *

* *

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

* * @return

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

*/ public java.util.Date getDepartureTime() { return departureTime; } /** *

* *

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

* * @param 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 *
*

*/ public void setDepartureTime(java.util.Date departureTime) { this.departureTime = departureTime; } /** *

* *

* 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 a reference to this object so that method calls can be chained * together. * * @param departureTime

* *

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

* @return A reference to this updated object so that method calls can be * chained together. */ public CalculateRouteMatrixRequest withDepartureTime(java.util.Date departureTime) { this.departureTime = departureTime; return this; } /** *

* *

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

* * @return

* 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] *

* *

* 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] *

*/ public java.util.List> getDestinationPositions() { return destinationPositions; } /** *

* *

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

* * @param 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] *

* *

* 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] *

*/ public void setDestinationPositions( java.util.Collection> destinationPositions) { if (destinationPositions == null) { this.destinationPositions = null; return; } this.destinationPositions = new java.util.ArrayList>( destinationPositions); } /** *

* *

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

* Returns a reference to this object so that method calls can be chained * together. * * @param destinationPositions

* *

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

* @return A reference to this updated object so that method calls can be * chained together. */ public CalculateRouteMatrixRequest withDestinationPositions( java.util.List... destinationPositions) { if (getDestinationPositions() == null) { this.destinationPositions = new java.util.ArrayList>( destinationPositions.length); } for (java.util.List value : destinationPositions) { this.destinationPositions.add(value); } return this; } /** *

* *

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

* Returns a reference to this object so that method calls can be chained * together. * * @param destinationPositions

* *

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

* @return A reference to this updated object so that method calls can be * chained together. */ public CalculateRouteMatrixRequest withDestinationPositions( java.util.Collection> destinationPositions) { setDestinationPositions(destinationPositions); return this; } /** *

* Set the unit system to specify the distance. *

* Default Value: Kilometers *

* Constraints:
* Allowed Values: Kilometers, Miles * * @return

* Set the unit system to specify the distance. *

* Default Value: Kilometers *

* @see DistanceUnit */ public String getDistanceUnit() { return distanceUnit; } /** *

* Set the unit system to specify the distance. *

* Default Value: Kilometers *

* Constraints:
* Allowed Values: Kilometers, Miles * * @param distanceUnit

* Set the unit system to specify the distance. *

* Default Value: Kilometers *

* @see DistanceUnit */ public void setDistanceUnit(String distanceUnit) { this.distanceUnit = distanceUnit; } /** *

* Set the unit system to specify the distance. *

* Default Value: Kilometers *

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

* Constraints:
* Allowed Values: Kilometers, Miles * * @param distanceUnit

* Set the unit system to specify the distance. *

* Default Value: Kilometers *

* @return A reference to this updated object so that method calls can be * chained together. * @see DistanceUnit */ public CalculateRouteMatrixRequest withDistanceUnit(String distanceUnit) { this.distanceUnit = distanceUnit; return this; } /** *

* Set the unit system to specify the distance. *

* Default Value: Kilometers *

* Constraints:
* Allowed Values: Kilometers, Miles * * @param distanceUnit

* Set the unit system to specify the distance. *

* Default Value: Kilometers *

* @see DistanceUnit */ public void setDistanceUnit(DistanceUnit distanceUnit) { this.distanceUnit = distanceUnit.toString(); } /** *

* Set the unit system to specify the distance. *

* Default Value: Kilometers *

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

* Constraints:
* Allowed Values: Kilometers, Miles * * @param distanceUnit

* Set the unit system to specify the distance. *

* Default Value: Kilometers *

* @return A reference to this updated object so that method calls can be * chained together. * @see DistanceUnit */ public CalculateRouteMatrixRequest withDistanceUnit(DistanceUnit distanceUnit) { this.distanceUnit = distanceUnit.toString(); return this; } /** *

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

* Constraints:
* Allowed Values: Car, Truck, Walking, Bicycle, Motorcycle * * @return

* 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 TravelMode */ public String getTravelMode() { return 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 *

* Constraints:
* Allowed Values: Car, Truck, Walking, Bicycle, Motorcycle * * @param 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 TravelMode */ public void setTravelMode(String travelMode) { this.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 *

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

* Constraints:
* Allowed Values: Car, Truck, Walking, Bicycle, Motorcycle * * @param 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 *

* @return A reference to this updated object so that method calls can be * chained together. * @see TravelMode */ public CalculateRouteMatrixRequest withTravelMode(String travelMode) { this.travelMode = travelMode; return this; } /** *

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

* Constraints:
* Allowed Values: Car, Truck, Walking, Bicycle, Motorcycle * * @param 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 TravelMode */ public void setTravelMode(TravelMode travelMode) { this.travelMode = travelMode.toString(); } /** *

* 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 a reference to this object so that method calls can be chained * together. *

* Constraints:
* Allowed Values: Car, Truck, Walking, Bicycle, Motorcycle * * @param 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 *

* @return A reference to this updated object so that method calls can be * chained together. * @see TravelMode */ public CalculateRouteMatrixRequest withTravelMode(TravelMode travelMode) { this.travelMode = travelMode.toString(); return this; } /** *

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

* * @return

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

*/ public CalculateRouteTruckModeOptions getTruckModeOptions() { return 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. *

* * @param 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. *

*/ public void setTruckModeOptions(CalculateRouteTruckModeOptions truckModeOptions) { this.truckModeOptions = 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 a reference to this object so that method calls can be chained * together. * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public CalculateRouteMatrixRequest withTruckModeOptions( CalculateRouteTruckModeOptions truckModeOptions) { this.truckModeOptions = truckModeOptions; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getCalculatorName() != null) sb.append("CalculatorName: " + getCalculatorName() + ","); if (getCarModeOptions() != null) sb.append("CarModeOptions: " + getCarModeOptions() + ","); if (getDepartNow() != null) sb.append("DepartNow: " + getDepartNow() + ","); if (getDeparturePositions() != null) sb.append("DeparturePositions: " + getDeparturePositions() + ","); if (getDepartureTime() != null) sb.append("DepartureTime: " + getDepartureTime() + ","); if (getDestinationPositions() != null) sb.append("DestinationPositions: " + getDestinationPositions() + ","); if (getDistanceUnit() != null) sb.append("DistanceUnit: " + getDistanceUnit() + ","); if (getTravelMode() != null) sb.append("TravelMode: " + getTravelMode() + ","); if (getTruckModeOptions() != null) sb.append("TruckModeOptions: " + getTruckModeOptions()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getCalculatorName() == null) ? 0 : getCalculatorName().hashCode()); hashCode = prime * hashCode + ((getCarModeOptions() == null) ? 0 : getCarModeOptions().hashCode()); hashCode = prime * hashCode + ((getDepartNow() == null) ? 0 : getDepartNow().hashCode()); hashCode = prime * hashCode + ((getDeparturePositions() == null) ? 0 : getDeparturePositions().hashCode()); hashCode = prime * hashCode + ((getDepartureTime() == null) ? 0 : getDepartureTime().hashCode()); hashCode = prime * hashCode + ((getDestinationPositions() == null) ? 0 : getDestinationPositions().hashCode()); hashCode = prime * hashCode + ((getDistanceUnit() == null) ? 0 : getDistanceUnit().hashCode()); hashCode = prime * hashCode + ((getTravelMode() == null) ? 0 : getTravelMode().hashCode()); hashCode = prime * hashCode + ((getTruckModeOptions() == null) ? 0 : getTruckModeOptions().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof CalculateRouteMatrixRequest == false) return false; CalculateRouteMatrixRequest other = (CalculateRouteMatrixRequest) obj; if (other.getCalculatorName() == null ^ this.getCalculatorName() == null) return false; if (other.getCalculatorName() != null && other.getCalculatorName().equals(this.getCalculatorName()) == false) return false; if (other.getCarModeOptions() == null ^ this.getCarModeOptions() == null) return false; if (other.getCarModeOptions() != null && other.getCarModeOptions().equals(this.getCarModeOptions()) == false) return false; if (other.getDepartNow() == null ^ this.getDepartNow() == null) return false; if (other.getDepartNow() != null && other.getDepartNow().equals(this.getDepartNow()) == false) return false; if (other.getDeparturePositions() == null ^ this.getDeparturePositions() == null) return false; if (other.getDeparturePositions() != null && other.getDeparturePositions().equals(this.getDeparturePositions()) == false) return false; if (other.getDepartureTime() == null ^ this.getDepartureTime() == null) return false; if (other.getDepartureTime() != null && other.getDepartureTime().equals(this.getDepartureTime()) == false) return false; if (other.getDestinationPositions() == null ^ this.getDestinationPositions() == null) return false; if (other.getDestinationPositions() != null && other.getDestinationPositions().equals(this.getDestinationPositions()) == false) return false; if (other.getDistanceUnit() == null ^ this.getDistanceUnit() == null) return false; if (other.getDistanceUnit() != null && other.getDistanceUnit().equals(this.getDistanceUnit()) == false) return false; if (other.getTravelMode() == null ^ this.getTravelMode() == null) return false; if (other.getTravelMode() != null && other.getTravelMode().equals(this.getTravelMode()) == false) return false; if (other.getTruckModeOptions() == null ^ this.getTruckModeOptions() == null) return false; if (other.getTruckModeOptions() != null && other.getTruckModeOptions().equals(this.getTruckModeOptions()) == false) return false; return true; } }