public static interface CalculateRouteMatrixRequest.Builder extends LocationRequest.Builder, SdkPojo, CopyableBuilder<CalculateRouteMatrixRequest.Builder,CalculateRouteMatrixRequest>
| Modifier and Type | Method and Description |
|---|---|
CalculateRouteMatrixRequest.Builder |
calculatorName(String calculatorName)
The name of the route calculator resource that you want to use to calculate the route matrix.
|
CalculateRouteMatrixRequest.Builder |
carModeOptions(CalculateRouteCarModeOptions carModeOptions)
Specifies route preferences when traveling by
Car, such as avoiding routes that use ferries or
tolls. |
default CalculateRouteMatrixRequest.Builder |
carModeOptions(Consumer<CalculateRouteCarModeOptions.Builder> carModeOptions)
Specifies route preferences when traveling by
Car, such as avoiding routes that use ferries or
tolls. |
CalculateRouteMatrixRequest.Builder |
departNow(Boolean departNow)
Sets the time of departure as the current time.
|
CalculateRouteMatrixRequest.Builder |
departurePositions(Collection<? extends Collection<Double>> departurePositions)
The list of departure (origin) positions for the route matrix.
|
CalculateRouteMatrixRequest.Builder |
departurePositions(Collection<Double>... departurePositions)
The list of departure (origin) positions for the route matrix.
|
CalculateRouteMatrixRequest.Builder |
departureTime(Instant departureTime)
Specifies the desired time of departure.
|
CalculateRouteMatrixRequest.Builder |
destinationPositions(Collection<? extends Collection<Double>> destinationPositions)
The list of destination positions for the route matrix.
|
CalculateRouteMatrixRequest.Builder |
destinationPositions(Collection<Double>... destinationPositions)
The list of destination positions for the route matrix.
|
CalculateRouteMatrixRequest.Builder |
distanceUnit(DistanceUnit distanceUnit)
Set the unit system to specify the distance.
|
CalculateRouteMatrixRequest.Builder |
distanceUnit(String distanceUnit)
Set the unit system to specify the distance.
|
CalculateRouteMatrixRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
CalculateRouteMatrixRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
CalculateRouteMatrixRequest.Builder |
travelMode(String travelMode)
Specifies the mode of transport when calculating a route.
|
CalculateRouteMatrixRequest.Builder |
travelMode(TravelMode travelMode)
Specifies the mode of transport when calculating a route.
|
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. |
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. |
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildCalculateRouteMatrixRequest.Builder calculatorName(String calculatorName)
The name of the route calculator resource that you want to use to calculate the route matrix.
calculatorName - The name of the route calculator resource that you want to use to calculate the route matrix.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.
carModeOptions - Specifies route preferences when traveling by Car, such as avoiding routes that use
ferries or tolls.
Requirements: TravelMode must be specified as Car.
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.
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).carModeOptions - a consumer that will call methods on CalculateRouteCarModeOptions.BuildercarModeOptions(CalculateRouteCarModeOptions)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
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
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]
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]
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]
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]
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
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
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]
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]
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]
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]
CalculateRouteMatrixRequest.Builder distanceUnit(String distanceUnit)
Set the unit system to specify the distance.
Default Value: Kilometers
distanceUnit - Set the unit system to specify the distance.
Default Value: Kilometers
DistanceUnit,
DistanceUnitCalculateRouteMatrixRequest.Builder distanceUnit(DistanceUnit distanceUnit)
Set the unit system to specify the distance.
Default Value: Kilometers
distanceUnit - Set the unit system to specify the distance.
Default Value: Kilometers
DistanceUnit,
DistanceUnitCalculateRouteMatrixRequest.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.
Default Value: Car
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.
Default Value: Car
TravelMode,
TravelModeCalculateRouteMatrixRequest.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.
Default Value: Car
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.
Default Value: Car
TravelMode,
TravelModeCalculateRouteMatrixRequest.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.
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.
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.
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).truckModeOptions - a consumer that will call methods on CalculateRouteTruckModeOptions.BuildertruckModeOptions(CalculateRouteTruckModeOptions)CalculateRouteMatrixRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderCalculateRouteMatrixRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2022. All rights reserved.