Package com.azure.maps.route.models

Class RouteDirectionsOptions

java.lang.Object
com.azure.maps.route.models.BaseRouteOptions<RouteDirectionsOptions>
com.azure.maps.route.models.RouteDirectionsOptions
public class RouteDirectionsOptions extends BaseRouteOptions<RouteDirectionsOptions>
Route Directions Options

  • Constructor Details

    • RouteDirectionsOptions

      public RouteDirectionsOptions(List<com.azure.core.models.GeoPosition> routePoints)
      Builds a new set of options for the Route Directions call.
      Parameters:
      routePoints - a list of GeoPosition route points.

  • Method Details

    • getRoutePoints

      public List<com.azure.core.models.GeoPosition> getRoutePoints()
      Returns the route points
      Returns:
      a list of GeoPosition route points.

    • getMaxAlternatives

      public Integer getMaxAlternatives()
      Returns the maximum number of alternative routes.
      Returns:
      the maximum number of alternative routes.

    • getAlternativeType

      public AlternativeRouteType getAlternativeType()
      Returns the type of the alternative route
      Returns:
      a AlternativeRouteType

    • getMinDeviationDistance

      public Integer getMinDeviationDistance()
      Returns the minimum deviation distance.
      Returns:
      the minimum deviation distance.

    • getArriveAt

      public OffsetDateTime getArriveAt()
      Returns the arrival time.
      Returns:
      the arrival time.

    • getMinDeviationTime

      public Integer getMinDeviationTime()
      Returns the minimal deviation time.
      Returns:
      minimum deviation time.

    • getInstructionsType

      public RouteInstructionsType getInstructionsType()
      Returns the type of route instructions.
      Returns:
      RouteInstructionsType

    • getLanguage

      public String getLanguage()
      Returns the language.
      Returns:
      the language.

    • getComputeBestWaypointOrder

      public Boolean getComputeBestWaypointOrder()
      Returns whether to use the best waypoint order.
      Returns:
      whether to use the best waypoint order.

    • getRouteRepresentationForBestOrder

      public RouteRepresentationForBestOrder getRouteRepresentationForBestOrder()
      Returns the representation for the best order.
      Returns:
      RouteRepresentationForBestOrder

    • getComputeTravelTime

      public ComputeTravelTime getComputeTravelTime()
      Returns the type of computation for the travel time.
      Returns:
      ComputeTravelTime

    • getVehicleHeading

      public Integer getVehicleHeading()
      Returns the vehicle heading.
      Returns:
      the vehicle heading.

    • getReport

      public Report getReport()
      Returns the type of Report
      Returns:
      Report

    • getFilterSectionType

      public SectionType getFilterSectionType()
      Returns the type of SectionType used for filtering.
      Returns:
      SectionType

    • setRoutePoints

      public RouteDirectionsOptions setRoutePoints(List<com.azure.core.models.GeoPosition> routePoints)
      Sets the route points
      Parameters:
      routePoints - a list of GeoPosition route points.
      Returns:
      a reference to this RouteDirectionsOptions

    • setMaxAlternatives

      public RouteDirectionsOptions setMaxAlternatives(Integer maxAlternatives)
      Sets the maximum number of alternative routes.
      Parameters:
      maxAlternatives - the maximum number of alternative routes.
      Returns:
      a reference to this RouteDirectionsOptions

    • setAlternativeType

      public RouteDirectionsOptions setAlternativeType(AlternativeRouteType alternativeType)
      Sets the type of the alternative route
      Parameters:
      alternativeType - AlternativeRouteType
      Returns:
      a reference to this RouteDirectionsOptions

    • setMinDeviationDistance

      public RouteDirectionsOptions setMinDeviationDistance(Integer minDeviationDistance)
      Sets the minimum deviation distance.
      Parameters:
      minDeviationDistance - the minimum deviation distance.
      Returns:
      a reference to this RouteDirectionsOptions

    • setArriveAt

      public RouteDirectionsOptions setArriveAt(OffsetDateTime arriveAt)
      Sets the arrival time.
      Parameters:
      arriveAt - the arrival time.
      Returns:
      a reference to this RouteDirectionsOptions

    • setMinDeviationTime

      public RouteDirectionsOptions setMinDeviationTime(Integer minDeviationTime)
      Sets the minimal deviation time.
      Parameters:
      minDeviationTime - the minimal deviation time.
      Returns:
      a reference to this RouteDirectionsOptions

    • setInstructionsType

      public RouteDirectionsOptions setInstructionsType(RouteInstructionsType instructionsType)
      Sets the type of route instructions.
      Parameters:
      instructionsType - RouteInstructionsType
      Returns:
      a reference to this RouteDirectionsOptions

    • language

      public RouteDirectionsOptions language(String language)
      Sets the language.
      Parameters:
      language - Sets the language.
      Returns:
      a reference to this RouteDirectionsOptions

    • setComputeBestWaypointOrder

      public RouteDirectionsOptions setComputeBestWaypointOrder(Boolean computeBestWaypointOrder)
      Sets whether to use the best waypoint order.
      Parameters:
      computeBestWaypointOrder - whether to use the best waypoint order.
      Returns:
      a reference to this RouteDirectionsOptions

    • setRouteRepresentationForBestOrder

      public RouteDirectionsOptions setRouteRepresentationForBestOrder(RouteRepresentationForBestOrder routeRepresentationForBestOrder)
      Sets the representation for the best order.
      Parameters:
      routeRepresentationForBestOrder - RouteRepresentationForBestOrder
      Returns:
      a reference to this RouteDirectionsOptions

    • setComputeTravelTime

      public RouteDirectionsOptions setComputeTravelTime(ComputeTravelTime computeTravelTime)
      Sets the type of computation for the travel time.
      Parameters:
      computeTravelTime - ComputeTravelTime
      Returns:
      a reference to this RouteDirectionsOptions

    • setVehicleHeading

      public RouteDirectionsOptions setVehicleHeading(Integer vehicleHeading)
      Sets the vehicle heading.
      Parameters:
      vehicleHeading - the vehicle heading.
      Returns:
      a reference to this RouteDirectionsOptions

    • setReport

      public RouteDirectionsOptions setReport(Report report)
      Sets the type of Report
      Parameters:
      report - the type of Report
      Returns:
      a reference to this RouteDirectionsOptions

    • setFilterSectionType

      public RouteDirectionsOptions setFilterSectionType(SectionType filterSectionType)
      Sets the type of SectionType used for filtering.
      Parameters:
      filterSectionType - SectionType
      Returns:
      a reference to this RouteDirectionsOptions