Class CalculateRouteRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CalculateRouteRequest.Builder,
CalculateRouteRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Instant
Specifies the desired time of arrival.builder()
final String
The name of the route calculator resource that you want to use to calculate the route.Specifies route preferences when traveling byCar
, such as avoiding routes that use ferries or tolls.final Boolean
Sets the time of departure as the current time.The start position for the route.final Instant
Specifies the desired time of departure.The finish position for the route.final DistanceUnit
Set the unit system to specify the distance.final String
Set the unit system to specify the distance.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the DeparturePosition property.final boolean
For responses, this returns true if the service returned a value for the DestinationPosition property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the WaypointPositions property.final Boolean
Set to include the geometry details in the result for each path between a pair of positions.final String
key()
The optional API key to authorize the request.final OptimizationMode
Specifies the distance to optimize for when calculating a route.final String
Specifies the distance to optimize for when calculating a route.static Class
<? extends CalculateRouteRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final TravelMode
Specifies the mode of transport when calculating a route.final String
Specifies the mode of transport when calculating a route.Specifies route preferences when traveling byTruck
, such as avoiding routes that use ferries or tolls, and truck specifications to consider when choosing an optimal road.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 software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
arrivalTime
Specifies the desired time of arrival. 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.
ArrivalTime is not supported Esri.
- Returns:
- Specifies the desired time of arrival. 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.
ArrivalTime is not supported Esri.
-
calculatorName
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.
-
carModeOptions
Specifies route preferences when traveling by
Car
, such as avoiding routes that use ferries or tolls.Requirements:
TravelMode
must be specified asCar
.- Returns:
- Specifies route preferences when traveling by
Car
, such as avoiding routes that use ferries or tolls.Requirements:
TravelMode
must be specified asCar
.
-
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:
- 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
-
hasDeparturePosition
public final boolean hasDeparturePosition()For responses, this returns true if the service returned a value for the DeparturePosition property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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]
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasDeparturePosition()
method.- 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]
-
-
-
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.
-
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.
-
In ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
. For example,2020–07-2T12:15:20.000Z+01:00
-
-
-
hasDestinationPosition
public final boolean hasDestinationPosition()For responses, this returns true if the service returned a value for the DestinationPosition property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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]
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasDestinationPosition()
method.- 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]
-
-
-
distanceUnit
Set the unit system to specify the distance.
Default Value:
Kilometers
If the service returns an enum value that is not available in the current SDK version,
distanceUnit
will returnDistanceUnit.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdistanceUnitAsString()
.- Returns:
- Set the unit system to specify the distance.
Default Value:
Kilometers
- See Also:
-
distanceUnitAsString
Set the unit system to specify the distance.
Default Value:
Kilometers
If the service returns an enum value that is not available in the current SDK version,
distanceUnit
will returnDistanceUnit.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdistanceUnitAsString()
.- Returns:
- Set the unit system to specify the distance.
Default Value:
Kilometers
- See Also:
-
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:
- Set to include the geometry details in the result for each path between a pair of positions.
Default Value:
false
Valid Values:
false
|true
-
key
The optional API key to authorize the request.
- Returns:
- The optional API key to authorize the request.
-
optimizeFor
Specifies the distance to optimize for when calculating a route.
If the service returns an enum value that is not available in the current SDK version,
optimizeFor
will returnOptimizationMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoptimizeForAsString()
.- Returns:
- Specifies the distance to optimize for when calculating a route.
- See Also:
-
optimizeForAsString
Specifies the distance to optimize for when calculating a route.
If the service returns an enum value that is not available in the current SDK version,
optimizeFor
will returnOptimizationMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoptimizeForAsString()
.- Returns:
- Specifies the distance to optimize for when calculating a route.
- See Also:
-
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
,Walking
,Bicycle
orMotorcycle
as options for theTravelMode
.Bicycle
andMotorcycle
are only valid when using Grab as a data provider, and only within Southeast Asia.Truck
is not available for Grab.For more details on the using Grab for routing, including areas of coverage, see GrabMaps in the Amazon Location Service Developer Guide.
The
TravelMode
you specify also determines how you specify route preferences:-
If traveling by
Car
use theCarModeOptions
parameter. -
If traveling by
Truck
use theTruckModeOptions
parameter.
Default Value:
Car
If the service returns an enum value that is not available in the current SDK version,
travelMode
will returnTravelMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtravelModeAsString()
.- 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
,Walking
,Bicycle
orMotorcycle
as options for theTravelMode
.Bicycle
andMotorcycle
are only valid when using Grab as a data provider, and only within Southeast Asia.Truck
is not available for Grab.For more details on the using Grab for routing, including areas of coverage, see GrabMaps in the Amazon Location Service Developer Guide.
The
TravelMode
you specify also determines how you specify route preferences:-
If traveling by
Car
use theCarModeOptions
parameter. -
If traveling by
Truck
use theTruckModeOptions
parameter.
Default Value:
Car
-
- See Also:
-
-
travelModeAsString
Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. You can choose
Car
,Truck
,Walking
,Bicycle
orMotorcycle
as options for theTravelMode
.Bicycle
andMotorcycle
are only valid when using Grab as a data provider, and only within Southeast Asia.Truck
is not available for Grab.For more details on the using Grab for routing, including areas of coverage, see GrabMaps in the Amazon Location Service Developer Guide.
The
TravelMode
you specify also determines how you specify route preferences:-
If traveling by
Car
use theCarModeOptions
parameter. -
If traveling by
Truck
use theTruckModeOptions
parameter.
Default Value:
Car
If the service returns an enum value that is not available in the current SDK version,
travelMode
will returnTravelMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtravelModeAsString()
.- 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
,Walking
,Bicycle
orMotorcycle
as options for theTravelMode
.Bicycle
andMotorcycle
are only valid when using Grab as a data provider, and only within Southeast Asia.Truck
is not available for Grab.For more details on the using Grab for routing, including areas of coverage, see GrabMaps in the Amazon Location Service Developer Guide.
The
TravelMode
you specify also determines how you specify route preferences:-
If traveling by
Car
use theCarModeOptions
parameter. -
If traveling by
Truck
use theTruckModeOptions
parameter.
Default Value:
Car
-
- See Also:
-
-
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 asTruck
.- 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 asTruck
.
-
hasWaypointPositions
public final boolean hasWaypointPositions()For responses, this returns true if the service returned a value for the WaypointPositions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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]
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasWaypointPositions()
method.- 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]
-
-
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CalculateRouteRequest.Builder,
CalculateRouteRequest> - Specified by:
toBuilder
in classLocationRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-