Cloud Optimization v1 API - Class DistanceLimit (2.5.0)

Reference documentation and code samples for the Cloud Optimization v1 API class DistanceLimit.

A limit defining a maximum distance which can be traveled. It can be either hard or soft.

If a soft limit is defined, both soft_max_meters and cost_per_kilometer_above_soft_max must be defined and be nonnegative.

Cost per kilometer incurred if distance is above soft_max_meters limit. The additional cost is 0 if the distance is under the limit, otherwise the formula used to compute the cost is the following:

  (distance_meters - soft_max_meters) / 1000.0 *
  cost_per_kilometer_above_soft_max.

The cost must be nonnegative.

Cost per kilometer incurred, increasing up to soft_max_meters, with formula:

  min(distance_meters, soft_max_meters) / 1000.0 *
  cost_per_kilometer_below_soft_max.

This cost is not supported in route_distance_limit.

Gets whether the "cost_per_kilometer_above_soft_max" field is set

Gets whether the "cost_per_kilometer_below_soft_max" field is set

Gets whether the "max_meters" field is set

Gets whether the "soft_max_meters" field is set

A hard limit constraining the distance to be at most max_meters. The limit must be nonnegative.

A soft limit not enforcing a maximum distance limit, but when violated results in a cost which adds up to other costs defined in the model, with the same unit.

If defined soft_max_meters must be less than max_meters and must be nonnegative.