Package com.azure.maps.route.models

Class RouteSummary

java.lang.Object
com.azure.maps.route.models.RouteSummary
All Implemented Interfaces:
com.azure.json.JsonSerializable<RouteSummary>
public final class RouteSummary extends Object implements com.azure.json.JsonSerializable<RouteSummary>
Summary object.

  • Constructor Summary

    Constructors
    Constructor
    Description
    RouteSummary()
    Creates an instance of RouteSummary class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static RouteSummary
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of RouteSummary from the JsonReader.
    OffsetDateTime
    getArrivalTime()
    Get the arrivalTime property: The estimated arrival time for the route or leg.
    OffsetDateTime
    getDepartureTime()
    Get the departureTime property: The estimated departure time for the route or leg.
    Integer
    getLengthInMeters()
    Get the lengthInMeters property: Length In Meters property.
    Duration
    getTrafficDelayInSeconds()
    Get the trafficDelayInSeconds property: Estimated delay in seconds caused by the real-time incident(s) according to traffic information.
    Duration
    getTravelTimeInSeconds()
    Get the travelTimeInSeconds property: Estimated travel time in seconds property that includes the delay due to real-time traffic.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Constructor Details

    • RouteSummary

      public RouteSummary()
      Creates an instance of RouteSummary class.

  • Method Details

    • getLengthInMeters

      public Integer getLengthInMeters()
      Get the lengthInMeters property: Length In Meters property.
      Returns:
      the lengthInMeters value.

    • getTravelTimeInSeconds

      public Duration getTravelTimeInSeconds()
      Get the travelTimeInSeconds property: Estimated travel time in seconds property that includes the delay due to real-time traffic. Note that even when traffic=false travelTimeInSeconds still includes the delay due to traffic. If DepartAt is in the future, travel time is calculated using time-dependent historic traffic data.
      Returns:
      the travelTimeInSeconds value.

    • getTrafficDelayInSeconds

      public Duration getTrafficDelayInSeconds()
      Get the trafficDelayInSeconds property: Estimated delay in seconds caused by the real-time incident(s) according to traffic information. For routes planned with departure time in the future, delays is always 0. To return additional travel times using different types of traffic information, parameter computeTravelTimeFor=all needs to be added.
      Returns:
      the trafficDelayInSeconds value.

    • getDepartureTime

      public OffsetDateTime getDepartureTime()
      Get the departureTime property: The estimated departure time for the route or leg. Time is in UTC.
      Returns:
      the departureTime value.

    • getArrivalTime

      public OffsetDateTime getArrivalTime()
      Get the arrivalTime property: The estimated arrival time for the route or leg. Time is in UTC.
      Returns:
      the arrivalTime value.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<RouteSummary>
      Throws:
      IOException

    • fromJson

      public static RouteSummary fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of RouteSummary from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of RouteSummary if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IOException - If an error occurs while reading the RouteSummary.