Interface RouteVehicleSpan.Builder

    • Method Detail

      • bestCaseDuration

        RouteVehicleSpan.Builder bestCaseDuration​(Long bestCaseDuration)

        Duration of the computed span without traffic congestion.

        Unit: seconds

        Parameters:
        bestCaseDuration - Duration of the computed span without traffic congestion.

        Unit: seconds

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

        RouteVehicleSpan.Builder carAccessWithStrings​(Collection<String> carAccess)

        Access attributes for a car corresponding to the span.

        Parameters:
        carAccess - Access attributes for a car corresponding to the span.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • carAccessWithStrings

        RouteVehicleSpan.Builder carAccessWithStrings​(String... carAccess)

        Access attributes for a car corresponding to the span.

        Parameters:
        carAccess - Access attributes for a car corresponding to the span.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • carAccess

        RouteVehicleSpan.Builder carAccess​(Collection<RouteSpanCarAccessAttribute> carAccess)

        Access attributes for a car corresponding to the span.

        Parameters:
        carAccess - Access attributes for a car corresponding to the span.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • carAccess

        RouteVehicleSpan.Builder carAccess​(RouteSpanCarAccessAttribute... carAccess)

        Access attributes for a car corresponding to the span.

        Parameters:
        carAccess - Access attributes for a car corresponding to the span.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • country

        RouteVehicleSpan.Builder country​(String country)

        3 letter Country code corresponding to the Span.

        Parameters:
        country - 3 letter Country code corresponding to the Span.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • distance

        RouteVehicleSpan.Builder distance​(Long distance)

        Distance of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.

        Parameters:
        distance - Distance of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • duration

        RouteVehicleSpan.Builder duration​(Long duration)

        Duration of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.

        Unit: seconds

        Parameters:
        duration - Duration of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.

        Unit: seconds

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

        RouteVehicleSpan.Builder dynamicSpeed​(RouteSpanDynamicSpeedDetails dynamicSpeed)

        Dynamic speed details corresponding to the span.

        Unit: KilometersPerHour

        Parameters:
        dynamicSpeed - Dynamic speed details corresponding to the span.

        Unit: KilometersPerHour

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

        RouteVehicleSpan.Builder functionalClassification​(Integer functionalClassification)

        Functional classification of the road segment corresponding to the span.

        Parameters:
        functionalClassification - Functional classification of the road segment corresponding to the span.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • gate

        RouteVehicleSpan.Builder gate​(String gate)

        Attributes corresponding to a gate. The gate is present at the end of the returned span.

        Parameters:
        gate - Attributes corresponding to a gate. The gate is present at the end of the returned span.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        RouteSpanGateAttribute, RouteSpanGateAttribute
      • geometryOffset

        RouteVehicleSpan.Builder geometryOffset​(Integer geometryOffset)

        Offset in the leg geometry corresponding to the start of this span.

        Parameters:
        geometryOffset - Offset in the leg geometry corresponding to the start of this span.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • incidents

        RouteVehicleSpan.Builder incidents​(Collection<Integer> incidents)

        Incidents corresponding to the span. These index into the Incidents in the parent Leg.

        Parameters:
        incidents - Incidents corresponding to the span. These index into the Incidents in the parent Leg.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • incidents

        RouteVehicleSpan.Builder incidents​(Integer... incidents)

        Incidents corresponding to the span. These index into the Incidents in the parent Leg.

        Parameters:
        incidents - Incidents corresponding to the span. These index into the Incidents in the parent Leg.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • names

        RouteVehicleSpan.Builder names​(Collection<LocalizedString> names)

        Provides an array of names of the vehicle span in available languages.

        Parameters:
        names - Provides an array of names of the vehicle span in available languages.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • names

        RouteVehicleSpan.Builder names​(LocalizedString... names)

        Provides an array of names of the vehicle span in available languages.

        Parameters:
        names - Provides an array of names of the vehicle span in available languages.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • notices

        RouteVehicleSpan.Builder notices​(Collection<Integer> notices)

        Notices are additional information returned that indicate issues that occurred during route calculation.

        Parameters:
        notices - Notices are additional information returned that indicate issues that occurred during route calculation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • notices

        RouteVehicleSpan.Builder notices​(Integer... notices)

        Notices are additional information returned that indicate issues that occurred during route calculation.

        Parameters:
        notices - Notices are additional information returned that indicate issues that occurred during route calculation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • railwayCrossing

        RouteVehicleSpan.Builder railwayCrossing​(String railwayCrossing)

        Attributes corresponding to a railway crossing. The gate is present at the end of the returned span.

        Parameters:
        railwayCrossing - Attributes corresponding to a railway crossing. The gate is present at the end of the returned span.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        RouteSpanRailwayCrossingAttribute, RouteSpanRailwayCrossingAttribute
      • region

        RouteVehicleSpan.Builder region​(String region)

        2-3 letter Region code corresponding to the Span. This is either a province or a state.

        Parameters:
        region - 2-3 letter Region code corresponding to the Span. This is either a province or a state.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • roadAttributesWithStrings

        RouteVehicleSpan.Builder roadAttributesWithStrings​(Collection<String> roadAttributes)

        Attributes for the road segment corresponding to the span.

        Parameters:
        roadAttributes - Attributes for the road segment corresponding to the span.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • roadAttributesWithStrings

        RouteVehicleSpan.Builder roadAttributesWithStrings​(String... roadAttributes)

        Attributes for the road segment corresponding to the span.

        Parameters:
        roadAttributes - Attributes for the road segment corresponding to the span.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • roadAttributes

        RouteVehicleSpan.Builder roadAttributes​(Collection<RouteSpanRoadAttribute> roadAttributes)

        Attributes for the road segment corresponding to the span.

        Parameters:
        roadAttributes - Attributes for the road segment corresponding to the span.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • roadAttributes

        RouteVehicleSpan.Builder roadAttributes​(RouteSpanRoadAttribute... roadAttributes)

        Attributes for the road segment corresponding to the span.

        Parameters:
        roadAttributes - Attributes for the road segment corresponding to the span.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • routeNumbers

        RouteVehicleSpan.Builder routeNumbers​(Collection<RouteNumber> routeNumbers)

        Designated route name or number corresponding to the span.

        Parameters:
        routeNumbers - Designated route name or number corresponding to the span.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • routeNumbers

        RouteVehicleSpan.Builder routeNumbers​(RouteNumber... routeNumbers)

        Designated route name or number corresponding to the span.

        Parameters:
        routeNumbers - Designated route name or number corresponding to the span.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • scooterAccessWithStrings

        RouteVehicleSpan.Builder scooterAccessWithStrings​(Collection<String> scooterAccess)

        Access attributes for a scooter corresponding to the span.

        Parameters:
        scooterAccess - Access attributes for a scooter corresponding to the span.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • scooterAccessWithStrings

        RouteVehicleSpan.Builder scooterAccessWithStrings​(String... scooterAccess)

        Access attributes for a scooter corresponding to the span.

        Parameters:
        scooterAccess - Access attributes for a scooter corresponding to the span.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • scooterAccess

        RouteVehicleSpan.Builder scooterAccess​(Collection<RouteSpanScooterAccessAttribute> scooterAccess)

        Access attributes for a scooter corresponding to the span.

        Parameters:
        scooterAccess - Access attributes for a scooter corresponding to the span.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • scooterAccess

        RouteVehicleSpan.Builder scooterAccess​(RouteSpanScooterAccessAttribute... scooterAccess)

        Access attributes for a scooter corresponding to the span.

        Parameters:
        scooterAccess - Access attributes for a scooter corresponding to the span.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • speedLimit

        RouteVehicleSpan.Builder speedLimit​(RouteSpanSpeedLimitDetails speedLimit)

        Speed limit details corresponding to the span.

        Unit: KilometersPerHour

        Parameters:
        speedLimit - Speed limit details corresponding to the span.

        Unit: KilometersPerHour

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

        RouteVehicleSpan.Builder tollSystems​(Collection<Integer> tollSystems)

        Toll systems are authorities that collect payments for the toll.

        Parameters:
        tollSystems - Toll systems are authorities that collect payments for the toll.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • tollSystems

        RouteVehicleSpan.Builder tollSystems​(Integer... tollSystems)

        Toll systems are authorities that collect payments for the toll.

        Parameters:
        tollSystems - Toll systems are authorities that collect payments for the toll.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • truckAccessWithStrings

        RouteVehicleSpan.Builder truckAccessWithStrings​(Collection<String> truckAccess)

        Access attributes for a truck corresponding to the span.

        Parameters:
        truckAccess - Access attributes for a truck corresponding to the span.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • truckAccessWithStrings

        RouteVehicleSpan.Builder truckAccessWithStrings​(String... truckAccess)

        Access attributes for a truck corresponding to the span.

        Parameters:
        truckAccess - Access attributes for a truck corresponding to the span.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • truckAccess

        RouteVehicleSpan.Builder truckAccess​(Collection<RouteSpanTruckAccessAttribute> truckAccess)

        Access attributes for a truck corresponding to the span.

        Parameters:
        truckAccess - Access attributes for a truck corresponding to the span.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • truckAccess

        RouteVehicleSpan.Builder truckAccess​(RouteSpanTruckAccessAttribute... truckAccess)

        Access attributes for a truck corresponding to the span.

        Parameters:
        truckAccess - Access attributes for a truck corresponding to the span.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • truckRoadTypes

        RouteVehicleSpan.Builder truckRoadTypes​(Collection<Integer> truckRoadTypes)

        Truck road type identifiers. BK1 through BK4 apply only to Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.

        There are currently no other supported values as of 26th April 2024.

        Parameters:
        truckRoadTypes - Truck road type identifiers. BK1 through BK4 apply only to Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.

        There are currently no other supported values as of 26th April 2024.

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

        RouteVehicleSpan.Builder truckRoadTypes​(Integer... truckRoadTypes)

        Truck road type identifiers. BK1 through BK4 apply only to Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.

        There are currently no other supported values as of 26th April 2024.

        Parameters:
        truckRoadTypes - Truck road type identifiers. BK1 through BK4 apply only to Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.

        There are currently no other supported values as of 26th April 2024.

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

        RouteVehicleSpan.Builder typicalDuration​(Long typicalDuration)

        Duration of the computed span under typical traffic congestion.

        Unit: seconds

        Parameters:
        typicalDuration - Duration of the computed span under typical traffic congestion.

        Unit: seconds

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

        RouteVehicleSpan.Builder zones​(Collection<Integer> zones)

        Zones corresponding to this leg of the route.

        Parameters:
        zones - Zones corresponding to this leg of the route.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • zones

        RouteVehicleSpan.Builder zones​(Integer... zones)

        Zones corresponding to this leg of the route.

        Parameters:
        zones - Zones corresponding to this leg of the route.
        Returns:
        Returns a reference to this object so that method calls can be chained together.