Package software.amazon.awssdk.services.location.model

Interface CalculateRouteMatrixRequest.Builder

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

  • Method Details

    • calculatorName

      CalculateRouteMatrixRequest.Builder calculatorName(String calculatorName)

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

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

    • carModeOptions

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

    • departNow

      CalculateRouteMatrixRequest.Builder departNow(Boolean departNow)

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

      Default Value: false

      Valid Values: false | true

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

      Default Value: false

      Valid Values: false | true

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

    • departurePositions

      CalculateRouteMatrixRequest.Builder departurePositions(Collection<? extends Collection<Double>> departurePositions)

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

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

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

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

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

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

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

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

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

    • departurePositions

      CalculateRouteMatrixRequest.Builder departurePositions(Collection<Double>... departurePositions)

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

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

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

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

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

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

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

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

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

    • departureTime

      CalculateRouteMatrixRequest.Builder departureTime(Instant departureTime)

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

      Setting a departure time in the past returns a 400 ValidationException error.

      • In ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00

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

      Setting a departure time in the past returns a 400 ValidationException error.

      • In ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00

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

    • destinationPositions

      CalculateRouteMatrixRequest.Builder destinationPositions(Collection<? extends Collection<Double>> destinationPositions)

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

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

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

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

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

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

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

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

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

    • destinationPositions

      CalculateRouteMatrixRequest.Builder destinationPositions(Collection<Double>... destinationPositions)

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

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

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

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

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

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

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

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

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

    • distanceUnit

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

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

    • key

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

    • travelMode

      CalculateRouteMatrixRequest.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 also determines how you specify route preferences:

      • If traveling by Car use the CarModeOptions parameter.

      • If traveling by Truck use the TruckModeOptions parameter.

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

      Truck is not available for Grab.

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

      Default Value: Car

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

      The TravelMode you specify also determines how you specify route preferences:

      • If traveling by Car use the CarModeOptions parameter.

      • If traveling by Truck use the TruckModeOptions parameter.

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

      Truck is not available for Grab.

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

      Default Value: Car

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

    • travelMode

      CalculateRouteMatrixRequest.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 also determines how you specify route preferences:

      • If traveling by Car use the CarModeOptions parameter.

      • If traveling by Truck use the TruckModeOptions parameter.

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

      Truck is not available for Grab.

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

      Default Value: Car

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

      The TravelMode you specify also determines how you specify route preferences:

      • If traveling by Car use the CarModeOptions parameter.

      • If traveling by Truck use the TruckModeOptions parameter.

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

      Truck is not available for Grab.

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

      Default Value: Car

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

    • truckModeOptions

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

    • overrideConfiguration

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

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