Reference documentation and code samples for the Cloud Optimization V1 API module Google::Cloud::Optimization::V1::ShipmentTypeRequirement::RequirementMode.
Modes defining the appearance of dependent shipments on a route.
Constants
REQUIREMENT_MODE_UNSPECIFIED
value: 0 Unspecified requirement mode. This value should never be used.
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.
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.
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.
[[["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-09 UTC."],[],[],null,["# Cloud Optimization V1 API - Module Google::Cloud::Optimization::V1::ShipmentTypeRequirement::RequirementMode (v0.12.0)\n\nVersion latestkeyboard_arrow_down\n\n- [0.12.0 (latest)](/ruby/docs/reference/google-cloud-optimization-v1/latest/Google-Cloud-Optimization-V1-ShipmentTypeRequirement-RequirementMode)\n- [0.11.1](/ruby/docs/reference/google-cloud-optimization-v1/0.11.1/Google-Cloud-Optimization-V1-ShipmentTypeRequirement-RequirementMode)\n- [0.10.0](/ruby/docs/reference/google-cloud-optimization-v1/0.10.0/Google-Cloud-Optimization-V1-ShipmentTypeRequirement-RequirementMode)\n- [0.9.2](/ruby/docs/reference/google-cloud-optimization-v1/0.9.2/Google-Cloud-Optimization-V1-ShipmentTypeRequirement-RequirementMode)\n- [0.8.2](/ruby/docs/reference/google-cloud-optimization-v1/0.8.2/Google-Cloud-Optimization-V1-ShipmentTypeRequirement-RequirementMode)\n- [0.7.0](/ruby/docs/reference/google-cloud-optimization-v1/0.7.0/Google-Cloud-Optimization-V1-ShipmentTypeRequirement-RequirementMode)\n- [0.6.0](/ruby/docs/reference/google-cloud-optimization-v1/0.6.0/Google-Cloud-Optimization-V1-ShipmentTypeRequirement-RequirementMode)\n- [0.5.0](/ruby/docs/reference/google-cloud-optimization-v1/0.5.0/Google-Cloud-Optimization-V1-ShipmentTypeRequirement-RequirementMode)\n- [0.4.1](/ruby/docs/reference/google-cloud-optimization-v1/0.4.1/Google-Cloud-Optimization-V1-ShipmentTypeRequirement-RequirementMode)\n- [0.3.0](/ruby/docs/reference/google-cloud-optimization-v1/0.3.0/Google-Cloud-Optimization-V1-ShipmentTypeRequirement-RequirementMode)\n- [0.2.1](/ruby/docs/reference/google-cloud-optimization-v1/0.2.1/Google-Cloud-Optimization-V1-ShipmentTypeRequirement-RequirementMode)\n- [0.1.1](/ruby/docs/reference/google-cloud-optimization-v1/0.1.1/Google-Cloud-Optimization-V1-ShipmentTypeRequirement-RequirementMode) \nReference documentation and code samples for the Cloud Optimization V1 API module Google::Cloud::Optimization::V1::ShipmentTypeRequirement::RequirementMode.\n\nModes defining the appearance of dependent shipments on a route.\n\nConstants\n---------\n\n### REQUIREMENT_MODE_UNSPECIFIED\n\n**value:** 0 \nUnspecified requirement mode. This value should never be used.\n\n### PERFORMED_BY_SAME_VEHICLE\n\n**value:** 1 \nIn this mode, all \"dependent\" shipments must share the same vehicle as at\nleast one of their \"required\" shipments.\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\n\u003cbr /\u003e\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\n### IN_SAME_VEHICLE_AT_DELIVERY_TIME\n\n**value:** 3 \nSame as before, except the \"dependent\" shipments need to have a\n\"required\" shipment on their vehicle at the time of their *delivery*."]]