Interface CalculateRouteRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CalculateRouteRequest.Builder,CalculateRouteRequest>, LocationRequest.Builder, SdkBuilder<CalculateRouteRequest.Builder,CalculateRouteRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CalculateRouteRequest
@Mutable @NotThreadSafe public static interface CalculateRouteRequest.Builder extends LocationRequest.Builder, SdkPojo, CopyableBuilder<CalculateRouteRequest.Builder,CalculateRouteRequest>

  • Method Details

    • calculatorName

      CalculateRouteRequest.Builder calculatorName(String calculatorName)

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

      Parameters:
      calculatorName - The name of the route calculator resource that you want to use to calculate the route.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • departurePosition

      CalculateRouteRequest.Builder departurePosition(Collection<Double> departurePosition)

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

      • For example, [-123.115, 49.285]

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

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

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

      • For example, [-123.115, 49.285]

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

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

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

    • departurePosition

      CalculateRouteRequest.Builder departurePosition(Double... departurePosition)

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

      • For example, [-123.115, 49.285]

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

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

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

      • For example, [-123.115, 49.285]

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

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

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

    • destinationPosition

      CalculateRouteRequest.Builder destinationPosition(Collection<Double> destinationPosition)

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

      • For example, [-122.339, 47.615]

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

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

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

      • For example, [-122.339, 47.615]

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

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

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

    • destinationPosition

      CalculateRouteRequest.Builder destinationPosition(Double... destinationPosition)

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

      • For example, [-122.339, 47.615]

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

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

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

      • For example, [-122.339, 47.615]

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

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

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

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

    • 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. You can choose Car, Truck, Walking, Bicycle or Motorcycle as options for the TravelMode.

      Bicycle and Motorcycle 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 the CarModeOptions parameter.

      • If traveling by Truck use the TruckModeOptions parameter.

      Default Value: Car

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

      Bicycle and Motorcycle 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 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

      CalculateRouteRequest.Builder travelMode(TravelMode travelMode)

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

      Bicycle and Motorcycle 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 the CarModeOptions parameter.

      • If traveling by Truck use the TruckModeOptions parameter.

      Default Value: Car

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

      Bicycle and Motorcycle 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 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:

    • departureTime

      CalculateRouteRequest.Builder departureTime(Instant 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

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

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

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

    • 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

      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:

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

    • 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 method 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:

    • 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 method 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:

    • arrivalTime

      CalculateRouteRequest.Builder arrivalTime(Instant 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.

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

    • optimizeFor

      CalculateRouteRequest.Builder optimizeFor(String optimizeFor)

      Specifies the distance to optimize for when calculating a route.

      Parameters:
      optimizeFor - Specifies the distance to optimize for when calculating a route.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • optimizeFor

      CalculateRouteRequest.Builder optimizeFor(OptimizationMode optimizeFor)

      Specifies the distance to optimize for when calculating a route.

      Parameters:
      optimizeFor - Specifies the distance to optimize for when calculating a route.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • key

      CalculateRouteRequest.Builder key(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.

    • overrideConfiguration

      CalculateRouteRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CalculateRouteRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.