Interface CalculateRouteSummary.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<CalculateRouteSummary.Builder,
,CalculateRouteSummary> SdkBuilder<CalculateRouteSummary.Builder,
,CalculateRouteSummary> SdkPojo
- Enclosing class:
CalculateRouteSummary
-
Method Summary
Modifier and TypeMethodDescriptiondataSource
(String dataSource) The data provider of traffic and road network data used to calculate the route.The total distance covered by the route.distanceUnit
(String distanceUnit) The unit of measurement for route distances.distanceUnit
(DistanceUnit distanceUnit) The unit of measurement for route distances.durationSeconds
(Double durationSeconds) The total travel time for the route measured in seconds.Specifies a geographical box surrounding a route.routeBBox
(Collection<Double> routeBBox) Specifies a geographical box surrounding a route.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
dataSource
The data provider of traffic and road network data used to calculate the route. Indicates one of the available providers:
-
Esri
-
Grab
-
Here
For more information about data providers, see Amazon Location Service data providers.
- Parameters:
dataSource
- The data provider of traffic and road network data used to calculate the route. Indicates one of the available providers:-
Esri
-
Grab
-
Here
For more information about data providers, see Amazon Location Service data providers.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
distance
The total distance covered by the route. The sum of the distance travelled between every stop on the route.
If Esri is the data source for the route calculator, the route distance can’t be greater than 400 km. If the route exceeds 400 km, the response is a
400 RoutesValidationException
error.- Parameters:
distance
- The total distance covered by the route. The sum of the distance travelled between every stop on the route.If Esri is the data source for the route calculator, the route distance can’t be greater than 400 km. If the route exceeds 400 km, the response is a
400 RoutesValidationException
error.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
distanceUnit
The unit of measurement for route distances.
- Parameters:
distanceUnit
- The unit of measurement for route distances.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
distanceUnit
The unit of measurement for route distances.
- Parameters:
distanceUnit
- The unit of measurement for route distances.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
durationSeconds
The total travel time for the route measured in seconds. The sum of the travel time between every stop on the route.
- Parameters:
durationSeconds
- The total travel time for the route measured in seconds. The sum of the travel time between every stop on the route.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
routeBBox
Specifies a geographical box surrounding a route. Used to zoom into a route when displaying it in a map. For example,
[min x, min y, max x, max y]
.The first 2
bbox
parameters describe the lower southwest corner:-
The first
bbox
position is the X coordinate or longitude of the lower southwest corner. -
The second
bbox
position is the Y coordinate or latitude of the lower southwest corner.
The next 2
bbox
parameters describe the upper northeast corner:-
The third
bbox
position is the X coordinate, or longitude of the upper northeast corner. -
The fourth
bbox
position is the Y coordinate, or latitude of the upper northeast corner.
- Parameters:
routeBBox
- Specifies a geographical box surrounding a route. Used to zoom into a route when displaying it in a map. For example,[min x, min y, max x, max y]
.The first 2
bbox
parameters describe the lower southwest corner:-
The first
bbox
position is the X coordinate or longitude of the lower southwest corner. -
The second
bbox
position is the Y coordinate or latitude of the lower southwest corner.
The next 2
bbox
parameters describe the upper northeast corner:-
The third
bbox
position is the X coordinate, or longitude of the upper northeast corner. -
The fourth
bbox
position is the Y coordinate, or latitude of the upper northeast corner.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
routeBBox
Specifies a geographical box surrounding a route. Used to zoom into a route when displaying it in a map. For example,
[min x, min y, max x, max y]
.The first 2
bbox
parameters describe the lower southwest corner:-
The first
bbox
position is the X coordinate or longitude of the lower southwest corner. -
The second
bbox
position is the Y coordinate or latitude of the lower southwest corner.
The next 2
bbox
parameters describe the upper northeast corner:-
The third
bbox
position is the X coordinate, or longitude of the upper northeast corner. -
The fourth
bbox
position is the Y coordinate, or latitude of the upper northeast corner.
- Parameters:
routeBBox
- Specifies a geographical box surrounding a route. Used to zoom into a route when displaying it in a map. For example,[min x, min y, max x, max y]
.The first 2
bbox
parameters describe the lower southwest corner:-
The first
bbox
position is the X coordinate or longitude of the lower southwest corner. -
The second
bbox
position is the Y coordinate or latitude of the lower southwest corner.
The next 2
bbox
parameters describe the upper northeast corner:-
The third
bbox
position is the X coordinate, or longitude of the upper northeast corner. -
The fourth
bbox
position is the Y coordinate, or latitude of the upper northeast corner.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-