Interface RouteMatchingOptions.Builder

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

  • Method Details

    • nameHint

      RouteMatchingOptions.Builder nameHint(String nameHint)

      Attempts to match the provided position to a road similar to the provided name.

      Parameters:
      nameHint - Attempts to match the provided position to a road similar to the provided name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • onRoadThreshold

      RouteMatchingOptions.Builder onRoadThreshold(Long onRoadThreshold)

      If the distance to a highway/bridge/tunnel/sliproad is within threshold, the waypoint will be snapped to the highway/bridge/tunnel/sliproad.

      Unit: meters

      Parameters:
      onRoadThreshold - If the distance to a highway/bridge/tunnel/sliproad is within threshold, the waypoint will be snapped to the highway/bridge/tunnel/sliproad.

      Unit: meters

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

    • radius

      RouteMatchingOptions.Builder radius(Long radius)

      Considers all roads within the provided radius to match the provided destination to. The roads that are considered are determined by the provided Strategy.

      Unit: Meters

      Parameters:
      radius - Considers all roads within the provided radius to match the provided destination to. The roads that are considered are determined by the provided Strategy.

      Unit: Meters

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

    • strategy

      RouteMatchingOptions.Builder strategy(String strategy)

      Strategy that defines matching of the position onto the road network. MatchAny considers all roads possible, whereas MatchMostSignificantRoad matches to the most significant road.

      Parameters:
      strategy - Strategy that defines matching of the position onto the road network. MatchAny considers all roads possible, whereas MatchMostSignificantRoad matches to the most significant road.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • strategy

      RouteMatchingOptions.Builder strategy(MatchingStrategy strategy)

      Strategy that defines matching of the position onto the road network. MatchAny considers all roads possible, whereas MatchMostSignificantRoad matches to the most significant road.

      Parameters:
      strategy - Strategy that defines matching of the position onto the road network. MatchAny considers all roads possible, whereas MatchMostSignificantRoad matches to the most significant road.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: