Package com.azure.maps.route.models

Class RouteDirectionsParameters

java.lang.Object
com.azure.maps.route.models.RouteDirectionsParameters
public final class RouteDirectionsParameters extends Object
Post body parameters for Route directions.

  • Constructor Summary

    Constructors
    Constructor
    Description
    RouteDirectionsParameters()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    List<String>
    getAllowVignette()
    Get the allowVignette property: This is a list of 3-character, ISO 3166-1, alpha-3 country codes of countries in which toll roads with vignettes are allowed, e.g.
    com.azure.core.models.GeoPolygonCollection
    getAvoidAreas()
    Get the avoidAreas property: A GeoJSON MultiPolygon representing list of areas to avoid.
    List<String>
    getAvoidVignette()
    Get the avoidVignette property: This is a list of 3-character, ISO 3166-1, alpha-3 country codes of countries in which all toll roads with vignettes are to be avoided, e.g.
    com.azure.core.models.GeoCollection
    getSupportingPoints()
    Get the supportingPoints property: A GeoJSON Geometry collection representing sequence of coordinates used as input for route reconstruction and for calculating zero or more alternative routes to this reference route.
    RouteDirectionsParameters
    setAllowVignette(List<String> allowVignette)
    Set the allowVignette property: This is a list of 3-character, ISO 3166-1, alpha-3 country codes of countries in which toll roads with vignettes are allowed, e.g.
    RouteDirectionsParameters
    setAvoidAreas(com.azure.core.models.GeoPolygonCollection avoidAreas)
    Set the avoidAreas property: A GeoJSON MultiPolygon representing list of areas to avoid.
    RouteDirectionsParameters
    setAvoidVignette(List<String> avoidVignette)
    Set the avoidVignette property: This is a list of 3-character, ISO 3166-1, alpha-3 country codes of countries in which all toll roads with vignettes are to be avoided, e.g.
    RouteDirectionsParameters
    setSupportingPoints(com.azure.core.models.GeoCollection supportingPoints)
    Set the supportingPoints property: A GeoJSON Geometry collection representing sequence of coordinates used as input for route reconstruction and for calculating zero or more alternative routes to this reference route.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • RouteDirectionsParameters

      public RouteDirectionsParameters()

  • Method Details

    • getSupportingPoints

      public com.azure.core.models.GeoCollection getSupportingPoints()
      Get the supportingPoints property: A GeoJSON Geometry collection representing sequence of coordinates used as input for route reconstruction and for calculating zero or more alternative routes to this reference route. - The provided sequence of supporting points is used as input for route reconstruction. - The alternative routes are calculated between the origin and destination points specified in the base path parameter locations. - If both _minDeviationDistance_ and _minDeviationTime_ are set to zero, then these origin and destination points are expected to be at (or very near) the beginning and end of the reference route, respectively. - Intermediate locations (_waypoints_) are not supported when using <_supportingPoints_>. - The reference route may contain traffic incidents of type _ROAD_CLOSURE_, which are ignored for the calculation of the reference route's travel time and traffic delay. Please refer to [Supporting Points](https://docs.microsoft.com/azure/azure-maps/how-to-use-best-practices-for-routing#calculate-and-bias-alternative-routes-using-supporting-points) for details.
      Returns:
      the supportingPoints value.

    • setSupportingPoints

      public RouteDirectionsParameters setSupportingPoints(com.azure.core.models.GeoCollection supportingPoints)
      Set the supportingPoints property: A GeoJSON Geometry collection representing sequence of coordinates used as input for route reconstruction and for calculating zero or more alternative routes to this reference route. - The provided sequence of supporting points is used as input for route reconstruction. - The alternative routes are calculated between the origin and destination points specified in the base path parameter locations. - If both _minDeviationDistance_ and _minDeviationTime_ are set to zero, then these origin and destination points are expected to be at (or very near) the beginning and end of the reference route, respectively. - Intermediate locations (_waypoints_) are not supported when using <_supportingPoints_>. - The reference route may contain traffic incidents of type _ROAD_CLOSURE_, which are ignored for the calculation of the reference route's travel time and traffic delay. Please refer to [Supporting Points](https://docs.microsoft.com/azure/azure-maps/how-to-use-best-practices-for-routing#calculate-and-bias-alternative-routes-using-supporting-points) for details.
      Parameters:
      supportingPoints - the supportingPoints value to set.
      Returns:
      the RouteDirectionParameters object itself.

    • getAvoidVignette

      public List<String> getAvoidVignette()
      Get the avoidVignette property: This is a list of 3-character, ISO 3166-1, alpha-3 country codes of countries in which all toll roads with vignettes are to be avoided, e.g. "AUS,CHE". Toll roads with vignettes in countries not in the list are unaffected. Note: It is an error to specify both **avoidVignette** and **allowVignette**.
      Returns:
      the avoidVignette value.

    • setAvoidVignette

      public RouteDirectionsParameters setAvoidVignette(List<String> avoidVignette)
      Set the avoidVignette property: This is a list of 3-character, ISO 3166-1, alpha-3 country codes of countries in which all toll roads with vignettes are to be avoided, e.g. "AUS,CHE". Toll roads with vignettes in countries not in the list are unaffected. Note: It is an error to specify both **avoidVignette** and **allowVignette**.
      Parameters:
      avoidVignette - the avoidVignette value to set.
      Returns:
      the RouteDirectionParameters object itself.

    • getAllowVignette

      public List<String> getAllowVignette()
      Get the allowVignette property: This is a list of 3-character, ISO 3166-1, alpha-3 country codes of countries in which toll roads with vignettes are allowed, e.g. "AUS,CHE". Specifying **allowVignette** with some countries X is equivalent to specifying **avoidVignette** with all countries but X. Specifying **allowVignette** with an empty list is the same as avoiding all toll roads with vignettes. Note: It is an error to specify both **avoidVignette** and **allowVignette**.
      Returns:
      the allowVignette value.

    • setAllowVignette

      public RouteDirectionsParameters setAllowVignette(List<String> allowVignette)
      Set the allowVignette property: This is a list of 3-character, ISO 3166-1, alpha-3 country codes of countries in which toll roads with vignettes are allowed, e.g. "AUS,CHE". Specifying **allowVignette** with some countries X is equivalent to specifying **avoidVignette** with all countries but X. Specifying **allowVignette** with an empty list is the same as avoiding all toll roads with vignettes. Note: It is an error to specify both **avoidVignette** and **allowVignette**.
      Parameters:
      allowVignette - the allowVignette value to set.
      Returns:
      the RouteDirectionParameters object itself.

    • getAvoidAreas

      public com.azure.core.models.GeoPolygonCollection getAvoidAreas()
      Get the avoidAreas property: A GeoJSON MultiPolygon representing list of areas to avoid. Only rectangle polygons are supported. The maximum size of a rectangle is about 160x160 km. Maximum number of avoided areas is **10**. It cannot cross the 180th meridian. It must be between -80 and +80 degrees of latitude.
      Returns:
      the avoidAreas value.

    • setAvoidAreas

      public RouteDirectionsParameters setAvoidAreas(com.azure.core.models.GeoPolygonCollection avoidAreas)
      Set the avoidAreas property: A GeoJSON MultiPolygon representing list of areas to avoid. Only rectangle polygons are supported. The maximum size of a rectangle is about 160x160 km. Maximum number of avoided areas is **10**. It cannot cross the 180th meridian. It must be between -80 and +80 degrees of latitude.
      Parameters:
      avoidAreas - the avoidAreas value to set.
      Returns:
      the RouteDirectionParameters object itself.