Reference documentation and code samples for the Google Maps Route Optimization V1 Client class RequirementMode.
Modes defining the appearance of dependent shipments on a route.
Protobuf type google.maps.routeoptimization.v1.ShipmentTypeRequirement.RequirementMode
Namespace
Google \ Maps \ RouteOptimization \ V1 \ ShipmentTypeRequirement
Methods
static::name
Parameter
Name
Description
value
mixed
static::value
Parameter
Name
Description
name
mixed
Constants
REQUIREMENT_MODE_UNSPECIFIED
Value: 0
Unspecified requirement mode. This value should never be used.
Generated from protobuf enum REQUIREMENT_MODE_UNSPECIFIED = 0;
PERFORMED_BY_SAME_VEHICLE
Value: 1
In this mode, all "dependent" shipments must share the same vehicle as at
least one of their "required" shipments.
Generated from protobuf enum PERFORMED_BY_SAME_VEHICLE = 1;
IN_SAME_VEHICLE_AT_PICKUP_TIME
Value: 2
With the IN_SAME_VEHICLE_AT_PICKUP_TIME mode, all "dependent"
shipments need to have at least one "required" shipment on their vehicle
at the time of their pickup.
A "dependent" shipment pickup must therefore have either:
A delivery-only "required" shipment delivered on the route after, or
A "required" shipment picked up on the route before it, and if the
"required" shipment has a delivery, this delivery must be performed
after the "dependent" shipment's pickup.
Generated from protobuf enum IN_SAME_VEHICLE_AT_PICKUP_TIME = 2;
IN_SAME_VEHICLE_AT_DELIVERY_TIME
Value: 3
Same as before, except the "dependent" shipments need to have a
"required" shipment on their vehicle at the time of their delivery.
Generated from protobuf enum IN_SAME_VEHICLE_AT_DELIVERY_TIME = 3;
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Maps Route Optimization V1 Client - Class RequirementMode (0.4.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.4.1 (latest)](/php/docs/reference/maps-routeoptimization/latest/V1.ShipmentTypeRequirement.RequirementMode)\n- [0.4.0](/php/docs/reference/maps-routeoptimization/0.4.0/V1.ShipmentTypeRequirement.RequirementMode)\n- [0.3.3](/php/docs/reference/maps-routeoptimization/0.3.3/V1.ShipmentTypeRequirement.RequirementMode)\n- [0.2.0](/php/docs/reference/maps-routeoptimization/0.2.0/V1.ShipmentTypeRequirement.RequirementMode)\n- [0.1.0](/php/docs/reference/maps-routeoptimization/0.1.0/V1.ShipmentTypeRequirement.RequirementMode) \nReference documentation and code samples for the Google Maps Route Optimization V1 Client class RequirementMode.\n\nModes defining the appearance of dependent shipments on a route.\n\nProtobuf type `google.maps.routeoptimization.v1.ShipmentTypeRequirement.RequirementMode`\n\nNamespace\n---------\n\nGoogle \\\\ Maps \\\\ RouteOptimization \\\\ V1 \\\\ ShipmentTypeRequirement\n\nMethods\n-------\n\n### static::name\n\n### static::value\n\nConstants\n---------\n\n### REQUIREMENT_MODE_UNSPECIFIED\n\n Value: 0\n\nUnspecified requirement mode. This value should never be used.\n\nGenerated from protobuf enum `REQUIREMENT_MODE_UNSPECIFIED = 0;`\n\n### PERFORMED_BY_SAME_VEHICLE\n\n Value: 1\n\nIn this mode, all \"dependent\" shipments must share the same vehicle as at\nleast one of their \"required\" shipments.\n\nGenerated from protobuf enum `PERFORMED_BY_SAME_VEHICLE = 1;`\n\n### IN_SAME_VEHICLE_AT_PICKUP_TIME\n\n Value: 2\n\nWith the `IN_SAME_VEHICLE_AT_PICKUP_TIME` mode, all \"dependent\"\nshipments need to have at least one \"required\" shipment on their vehicle\nat the time of their pickup.\n\nA \"dependent\" shipment pickup must therefore have either:\n\n- A delivery-only \"required\" shipment delivered on the route after, or\n- A \"required\" shipment picked up on the route before it, and if the \"required\" shipment has a delivery, this delivery must be performed after the \"dependent\" shipment's pickup.\n\nGenerated from protobuf enum `IN_SAME_VEHICLE_AT_PICKUP_TIME = 2;`\n\n### IN_SAME_VEHICLE_AT_DELIVERY_TIME\n\n Value: 3\n\nSame as before, except the \"dependent\" shipments need to have a\n\"required\" shipment on their vehicle at the time of their *delivery*.\n\nGenerated from protobuf enum `IN_SAME_VEHICLE_AT_DELIVERY_TIME = 3;`"]]
