Interface RoutePedestrianSpan.Builder

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

  • Method Details

    • bestCaseDuration

      RoutePedestrianSpan.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.

    • country

      RoutePedestrianSpan.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

      RoutePedestrianSpan.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

      RoutePedestrianSpan.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

      RoutePedestrianSpan.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.

    • dynamicSpeed

      default RoutePedestrianSpan.Builder dynamicSpeed(Consumer<RouteSpanDynamicSpeedDetails.Builder> dynamicSpeed)

      Dynamic speed details corresponding to the span.

      Unit: KilometersPerHour

      This is a convenience method that creates an instance of the RouteSpanDynamicSpeedDetails.Builder avoiding the need to create one manually via RouteSpanDynamicSpeedDetails.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dynamicSpeed(RouteSpanDynamicSpeedDetails).

      Parameters:
      dynamicSpeed - a consumer that will call methods on RouteSpanDynamicSpeedDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • functionalClassification

      RoutePedestrianSpan.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.

    • geometryOffset

      RoutePedestrianSpan.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

      RoutePedestrianSpan.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

      RoutePedestrianSpan.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

      RoutePedestrianSpan.Builder names(Collection<LocalizedString> names)

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

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

    • names

      RoutePedestrianSpan.Builder names(LocalizedString... names)

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

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

    • names

      RoutePedestrianSpan.Builder names(Consumer<LocalizedString.Builder>... names)

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

      This is a convenience method that creates an instance of the LocalizedString.Builder avoiding the need to create one manually via LocalizedString.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to names(List<LocalizedString>).

      Parameters:
      names - a consumer that will call methods on LocalizedString.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • pedestrianAccessWithStrings

      RoutePedestrianSpan.Builder pedestrianAccessWithStrings(Collection<String> pedestrianAccess)

      Access attributes for a pedestrian corresponding to the span.

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

    • pedestrianAccessWithStrings

      RoutePedestrianSpan.Builder pedestrianAccessWithStrings(String... pedestrianAccess)

      Access attributes for a pedestrian corresponding to the span.

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

    • pedestrianAccess

      RoutePedestrianSpan.Builder pedestrianAccess(Collection<RouteSpanPedestrianAccessAttribute> pedestrianAccess)

      Access attributes for a pedestrian corresponding to the span.

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

    • pedestrianAccess

      RoutePedestrianSpan.Builder pedestrianAccess(RouteSpanPedestrianAccessAttribute... pedestrianAccess)

      Access attributes for a pedestrian corresponding to the span.

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

    • region

      RoutePedestrianSpan.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

      RoutePedestrianSpan.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

      RoutePedestrianSpan.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

      RoutePedestrianSpan.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

      RoutePedestrianSpan.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

      RoutePedestrianSpan.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

      RoutePedestrianSpan.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.

    • routeNumbers

      RoutePedestrianSpan.Builder routeNumbers(Consumer<RouteNumber.Builder>... routeNumbers)

      Designated route name or number corresponding to the span.

      This is a convenience method that creates an instance of the RouteNumber.Builder avoiding the need to create one manually via RouteNumber.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to routeNumbers(List<RouteNumber>).

      Parameters:
      routeNumbers - a consumer that will call methods on RouteNumber.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • speedLimit

      RoutePedestrianSpan.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.

    • speedLimit

      default RoutePedestrianSpan.Builder speedLimit(Consumer<RouteSpanSpeedLimitDetails.Builder> speedLimit)

      Speed limit details corresponding to the span.

      Unit: KilometersPerHour

      This is a convenience method that creates an instance of the RouteSpanSpeedLimitDetails.Builder avoiding the need to create one manually via RouteSpanSpeedLimitDetails.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to speedLimit(RouteSpanSpeedLimitDetails).

      Parameters:
      speedLimit - a consumer that will call methods on RouteSpanSpeedLimitDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • typicalDuration

      RoutePedestrianSpan.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.