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

Interface CalculateRouteSummary.Builder

    • Method Detail

      • dataSource

        CalculateRouteSummary.Builder dataSource​(String 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

        CalculateRouteSummary.Builder distance​(Double 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

        CalculateRouteSummary.Builder distanceUnit​(String 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, DistanceUnit

      • distanceUnit

        CalculateRouteSummary.Builder distanceUnit​(DistanceUnit 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, DistanceUnit

      • durationSeconds

        CalculateRouteSummary.Builder durationSeconds​(Double 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

        CalculateRouteSummary.Builder routeBBox​(Collection<Double> 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

        CalculateRouteSummary.Builder routeBBox​(Double... 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.