Interface RouteTrafficOptions.Builder

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

  • Method Details

    • flowEventThresholdOverride

      RouteTrafficOptions.Builder flowEventThresholdOverride(Long flowEventThresholdOverride)

      Duration for which flow traffic is considered valid. For this period, the flow traffic is used over historical traffic data. Flow traffic refers to congestion, which changes very quickly. Duration in seconds for which flow traffic event would be considered valid. While flow traffic event is valid it will be used over the historical traffic data.

      Parameters:
      flowEventThresholdOverride - Duration for which flow traffic is considered valid. For this period, the flow traffic is used over historical traffic data. Flow traffic refers to congestion, which changes very quickly. Duration in seconds for which flow traffic event would be considered valid. While flow traffic event is valid it will be used over the historical traffic data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • usage

      RouteTrafficOptions.Builder usage(String usage)

      Specifies how traffic data should be used when calculating routes.

      Default Value: UseTrafficData

      Traffic data usage depends on the time parameters in your route request:

      • When Usage is set to UseTrafficData:

        • If DepartNow is set to true, or if you specify DepartureTime or ArrivalTime, then all traffic data is considered (including live traffic and closures).

        • If DepartNow, DepartureTime, and ArrivalTime are all unspecified, then only long-term closures are considered, regardless of this setting.

      • When Usage is set to IgnoreTrafficData, then all traffic data is ignored regardless of the time parameters in your route request.

      Parameters:
      usage - Specifies how traffic data should be used when calculating routes.

      Default Value: UseTrafficData

      Traffic data usage depends on the time parameters in your route request:

      • When Usage is set to UseTrafficData:

        • If DepartNow is set to true, or if you specify DepartureTime or ArrivalTime, then all traffic data is considered (including live traffic and closures).

        • If DepartNow, DepartureTime, and ArrivalTime are all unspecified, then only long-term closures are considered, regardless of this setting.

      • When Usage is set to IgnoreTrafficData, then all traffic data is ignored regardless of the time parameters in your route request.

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

    • usage

      RouteTrafficOptions.Builder usage(TrafficUsage usage)

      Specifies how traffic data should be used when calculating routes.

      Default Value: UseTrafficData

      Traffic data usage depends on the time parameters in your route request:

      • When Usage is set to UseTrafficData:

        • If DepartNow is set to true, or if you specify DepartureTime or ArrivalTime, then all traffic data is considered (including live traffic and closures).

        • If DepartNow, DepartureTime, and ArrivalTime are all unspecified, then only long-term closures are considered, regardless of this setting.

      • When Usage is set to IgnoreTrafficData, then all traffic data is ignored regardless of the time parameters in your route request.

      Parameters:
      usage - Specifies how traffic data should be used when calculating routes.

      Default Value: UseTrafficData

      Traffic data usage depends on the time parameters in your route request:

      • When Usage is set to UseTrafficData:

        • If DepartNow is set to true, or if you specify DepartureTime or ArrivalTime, then all traffic data is considered (including live traffic and closures).

        • If DepartNow, DepartureTime, and ArrivalTime are all unspecified, then only long-term closures are considered, regardless of this setting.

      • When Usage is set to IgnoreTrafficData, then all traffic data is ignored regardless of the time parameters in your route request.

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