REST Resource: networks.vehicles

Resource: Vehicle

No name, it is stored as a map key within the Network.

JSON representation 
{
  "name": string,
  "capacities": [
    {
      object (ValueDimension)
    }
  ],
  "cost": {
    object (PricingStrategy)
  },
  "pricing": {
    object (PricingStrategy)
  },
  "allowedForGeneratedLines": boolean,
  "vehiclePositionConstraints": [
    {
      object (VehiclePositionConstraint)
    }
  ]
}
Fields
name

string

Identifier. Cannot be updated.
capacities[]

object (ValueDimension)

Optional. Vehicle characteristics.
cost

object (PricingStrategy)

Required. Cost for using the vehicle. These are functions of one argument: the distance the vehicle travels, the weight the vehicle transports, the number of pallets the vehicle transports. These functions account for maintenance, fuel, and handling costs. These cost may include an upfront cost (paid once the vehicle is used, mostly useful for subcontracting).
pricing

object (PricingStrategy)

Optional. Price to be paid by the paying party, only if the vehicle is being used in a generated line (i.e. not part of the input network).
allowedForGeneratedLines

boolean

Required. Whether this vehicle can be used for generated lines. If set to false, the vehicle will be limited to predefined lines where it is allowed.
vehiclePositionConstraints[]

object (VehiclePositionConstraint)

Optional. Forced positions for the current vehicle, along with times. For instance, use entries to model the fact that a vehicle that starts or ends at a given hub.

VehiclePositionConstraint

Constraint on the position of a vehicle.

JSON representation 
{
  "time": {
    object (DateTime)
  },
  "hubId": string
}
Fields
time

object (DateTime)

Time of the constraint.
hubId

string

Hub of the constraint.

Methods

create

 Creates a Vehicle.

delete

 Deletes a Vehicle.

get

 Gets the details of a Vehicle.

list

 Lists the Vehicles.

makeAvailable

 Makes a vehicle available.

makeUnavailable

 Makes a vehicle unavailable.

patch

 Updates a Vehicle.