CalculateRouteRequest.Builder (AWS Java SDK :: Services

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CalculateRouteRequest.Builder,CalculateRouteRequest>, LocationRequest.Builder, SdkBuilder<CalculateRouteRequest.Builder,CalculateRouteRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CalculateRouteRequest
```
public static interface CalculateRouteRequest.Builder
extends LocationRequest.Builder, SdkPojo, CopyableBuilder<CalculateRouteRequest.Builder,CalculateRouteRequest>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`CalculateRouteRequest.Builder`	`calculatorName(String calculatorName)` The name of the route calculator resource that you want to use to calculate a route.
`CalculateRouteRequest.Builder`	`carModeOptions(CalculateRouteCarModeOptions carModeOptions)` Specifies route preferences when traveling by `Car`, such as avoiding routes that use ferries or tolls.
`default CalculateRouteRequest.Builder`	`carModeOptions(Consumer<CalculateRouteCarModeOptions.Builder> carModeOptions)` Specifies route preferences when traveling by `Car`, such as avoiding routes that use ferries or tolls.
`CalculateRouteRequest.Builder`	`departNow(Boolean departNow)` Sets the time of departure as the current time.
`CalculateRouteRequest.Builder`	`departurePosition(Collection<Double> departurePosition)` The start position for the route.
`CalculateRouteRequest.Builder`	`departurePosition(Double... departurePosition)` The start position for the route.
`CalculateRouteRequest.Builder`	`departureTime(Instant departureTime)` Specifies the desired time of departure.
`CalculateRouteRequest.Builder`	`destinationPosition(Collection<Double> destinationPosition)` The finish position for the route.
`CalculateRouteRequest.Builder`	`destinationPosition(Double... destinationPosition)` The finish position for the route.
`CalculateRouteRequest.Builder`	`distanceUnit(DistanceUnit distanceUnit)` Set the unit system to specify the distance.
`CalculateRouteRequest.Builder`	`distanceUnit(String distanceUnit)` Set the unit system to specify the distance.
`CalculateRouteRequest.Builder`	`includeLegGeometry(Boolean includeLegGeometry)` Set to include the geometry details in the result for each path between a pair of positions.
`CalculateRouteRequest.Builder`	`overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)`
`CalculateRouteRequest.Builder`	`overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)`
`CalculateRouteRequest.Builder`	`travelMode(String travelMode)` Specifies the mode of transport when calculating a route.
`CalculateRouteRequest.Builder`	`travelMode(TravelMode travelMode)` Specifies the mode of transport when calculating a route.
`CalculateRouteRequest.Builder`	`truckModeOptions(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.
`default CalculateRouteRequest.Builder`	`truckModeOptions(Consumer<CalculateRouteTruckModeOptions.Builder> 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.Builder`	`waypointPositions(Collection<? extends Collection<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.Builder`	`waypointPositions(Collection<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 interface software.amazon.awssdk.services.location.model.LocationRequest.Builder
build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - calculatorName
```
CalculateRouteRequest.Builder calculatorName(String calculatorName)
```
    The name of the route calculator resource that you want to use to calculate a route.
    
    Parameters:
    
    calculatorName - The name of the route calculator resource that you want to use to calculate a route.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - carModeOptions
```
CalculateRouteRequest.Builder carModeOptions(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.
  - carModeOptions
```
default CalculateRouteRequest.Builder carModeOptions(Consumer<CalculateRouteCarModeOptions.Builder> carModeOptions)
```
    Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or tolls.
    
    Requirements: TravelMode must be specified as Car.
    This is a convenience that creates an instance of the CalculateRouteCarModeOptions.Builder avoiding the need to create one manually via CalculateRouteCarModeOptions.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to carModeOptions(CalculateRouteCarModeOptions).
    
    Parameters:
    
    carModeOptions - a consumer that will call methods on CalculateRouteCarModeOptions.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    carModeOptions(CalculateRouteCarModeOptions)
  - departNow
```
CalculateRouteRequest.Builder departNow(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.
  - departurePosition
```
CalculateRouteRequest.Builder departurePosition(Collection<Double> departurePosition)
```
    The start position for the route. Defined in 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 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.
  - departurePosition
```
CalculateRouteRequest.Builder departurePosition(Double... departurePosition)
```
    The start position for the route. Defined in 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 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.
  - departureTime
```
CalculateRouteRequest.Builder departureTime(Instant departureTime)
```
    Specifies the desired time of departure. Uses the given time to calculate a 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 a 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.
  - destinationPosition
```
CalculateRouteRequest.Builder destinationPosition(Collection<Double> destinationPosition)
```
    The finish position for the route. Defined in 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 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.
  - destinationPosition
```
CalculateRouteRequest.Builder destinationPosition(Double... destinationPosition)
```
    The finish position for the route. Defined in 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 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.
  - distanceUnit
```
CalculateRouteRequest.Builder distanceUnit(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, DistanceUnit
  - distanceUnit
```
CalculateRouteRequest.Builder distanceUnit(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, DistanceUnit
  - includeLegGeometry
```
CalculateRouteRequest.Builder includeLegGeometry(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.
  - travelMode
```
CalculateRouteRequest.Builder travelMode(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 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.
    
    The TravelMode you specify 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, TravelMode
  - travelMode
```
CalculateRouteRequest.Builder travelMode(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 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.
    
    The TravelMode you specify 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, TravelMode
  - truckModeOptions
```
CalculateRouteRequest.Builder truckModeOptions(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.
  - truckModeOptions
```
default CalculateRouteRequest.Builder truckModeOptions(Consumer<CalculateRouteTruckModeOptions.Builder> 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.
    This is a convenience that creates an instance of the CalculateRouteTruckModeOptions.Builder avoiding the need to create one manually via CalculateRouteTruckModeOptions.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to truckModeOptions(CalculateRouteTruckModeOptions).
    
    Parameters:
    
    truckModeOptions - a consumer that will call methods on CalculateRouteTruckModeOptions.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    truckModeOptions(CalculateRouteTruckModeOptions)
  - waypointPositions
```
CalculateRouteRequest.Builder waypointPositions(Collection<? extends Collection<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.
  - waypointPositions
```
CalculateRouteRequest.Builder waypointPositions(Collection<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.
  - overrideConfiguration
```
CalculateRouteRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder
  - overrideConfiguration
```
CalculateRouteRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder

Interface CalculateRouteRequest.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.services.location.model.LocationRequest.Builder

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

Method Detail

calculatorName

carModeOptions

carModeOptions

departNow

departurePosition

departurePosition

departureTime

destinationPosition

destinationPosition

distanceUnit

distanceUnit

includeLegGeometry

travelMode

travelMode

truckModeOptions

truckModeOptions

waypointPositions

waypointPositions

overrideConfiguration

overrideConfiguration