REST Resource: networks.lines.rotations

Resource: LineRotation

A vehicle starts operating this line at a particular time.

JSON representation
{
  "name": string,
  "arrivalTimes": {
    string: {
      object (DateTimeRange)
    },
    ...
  },
  "departureTimes": {
    string: {
      object (DateTimeRange)
    },
    ...
  },
  "departureEarlinessTardinessCosts": {
    string: {
      object (EarlinessTardiness)
    },
    ...
  },
  "arrivalEarlinessTardinessCosts": {
    string: {
      object (EarlinessTardiness)
    },
    ...
  },
  "vehicles": [
    string
  ],
  "fixedPrice": {
    object (PricingStrategy)
  },
  "maximumNumberVehicles": {
    object (IntegerRange)
  }
}
Fields
name

string

Identifier. Cannot be updated.

arrivalTimes

map (key: string, value: object (DateTimeRange))

Optional. Range where departure is allowed without cost (i.e., if not pointwise, the actual arrival times are decided by the system). This map is supposed to have the same keys (minus the source hub, with no arrival time).

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

departureTimes

map (key: string, value: object (DateTimeRange))

Optional. Range where arrival is allowed without cost (i.e., if not pointwise, the actual departure times are decided by the system). This map is supposed to have the same keys (minus the destination hub, with no departure time).

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

departureEarlinessTardinessCosts

map (key: string, value: object (EarlinessTardiness))

Optional. Earliness/tardiness costs and bounds for departure. This maps is supposed to have the same keys (minus the destination hub, with no departure time).

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

arrivalEarlinessTardinessCosts

map (key: string, value: object (EarlinessTardiness))

Optional. Earliness/tardiness costs and bounds for arrival. This maps is supposed to have the same keys (minus the source hub, with no arrival time).

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

vehicles[]

string

Optional. List of vehicles that could be doing this line rotation (i.e. allow list). If number_vehicles reduces to one value corresponding to the number of vehicles, all those vehicles will be assigned to the line rotation. If no vehicles, all are considered to be available.

fixedPrice

object (PricingStrategy)

Optional. Cost of having any vehicle doing this line, regardless of vehicle (driver, maintenance, etc.).

maximumNumberVehicles

object (IntegerRange)

Optional. Maximum number of vehicles that can be assigned to this rotation. If unset: no limit in terms of vehicles for this rotation. Otherwise, upper bound on the number of vehicles that can be allocated to this rotation (among the allow list vehicle_ids). In particular, a value of 0 disables this rotation (no vehicles allowed).

IntegerRange

Range of integers.

JSON representation
{
  "startValue": integer,
  "endValue": integer
}
Fields
startValue

integer

Interval open if unset.

endValue

integer

Interval open if unset.

Methods

create

Creates a LineRotation.

delete

Deletes a LineRotation.

get

Gets the details of a LineRotation.

list

Lists the LineRotations.

patch

Updates a LineRotation.