Reference documentation and code samples for the Cloud Optimization V1 API class Google::Cloud::Optimization::V1::Shipment::Load.
When performing a visit, a predefined amount may be added to the vehicle
load if it's a pickup, or subtracted if it's a delivery. This message
defines such amount. See
load_demands.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#amount
defamount()->::Integer
Returns
(::Integer) — The amount by which the load of the vehicle performing the corresponding
visit will vary. Since it is an integer, users are advised to choose an
appropriate unit to avoid loss of precision. Must be ≥ 0.
#amount=
defamount=(value)->::Integer
Parameter
value (::Integer) — The amount by which the load of the vehicle performing the corresponding
visit will vary. Since it is an integer, users are advised to choose an
appropriate unit to avoid loss of precision. Must be ≥ 0.
Returns
(::Integer) — The amount by which the load of the vehicle performing the corresponding
visit will vary. Since it is an integer, users are advised to choose an
appropriate unit to avoid loss of precision. Must be ≥ 0.
[[["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 - Class Google::Cloud::Optimization::V1::Shipment::Load (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-Shipment-Load)\n- [0.11.1](/ruby/docs/reference/google-cloud-optimization-v1/0.11.1/Google-Cloud-Optimization-V1-Shipment-Load)\n- [0.10.0](/ruby/docs/reference/google-cloud-optimization-v1/0.10.0/Google-Cloud-Optimization-V1-Shipment-Load)\n- [0.9.2](/ruby/docs/reference/google-cloud-optimization-v1/0.9.2/Google-Cloud-Optimization-V1-Shipment-Load)\n- [0.8.2](/ruby/docs/reference/google-cloud-optimization-v1/0.8.2/Google-Cloud-Optimization-V1-Shipment-Load)\n- [0.7.0](/ruby/docs/reference/google-cloud-optimization-v1/0.7.0/Google-Cloud-Optimization-V1-Shipment-Load)\n- [0.6.0](/ruby/docs/reference/google-cloud-optimization-v1/0.6.0/Google-Cloud-Optimization-V1-Shipment-Load)\n- [0.5.0](/ruby/docs/reference/google-cloud-optimization-v1/0.5.0/Google-Cloud-Optimization-V1-Shipment-Load)\n- [0.4.1](/ruby/docs/reference/google-cloud-optimization-v1/0.4.1/Google-Cloud-Optimization-V1-Shipment-Load)\n- [0.3.0](/ruby/docs/reference/google-cloud-optimization-v1/0.3.0/Google-Cloud-Optimization-V1-Shipment-Load)\n- [0.2.1](/ruby/docs/reference/google-cloud-optimization-v1/0.2.1/Google-Cloud-Optimization-V1-Shipment-Load)\n- [0.1.1](/ruby/docs/reference/google-cloud-optimization-v1/0.1.1/Google-Cloud-Optimization-V1-Shipment-Load) \nReference documentation and code samples for the Cloud Optimization V1 API class Google::Cloud::Optimization::V1::Shipment::Load.\n\nWhen performing a visit, a predefined amount may be added to the vehicle\nload if it's a pickup, or subtracted if it's a delivery. This message\ndefines such amount. See\n[load_demands](/ruby/docs/reference/google-cloud-optimization-v1/latest/Google-Cloud-Optimization-V1-Shipment#Google__Cloud__Optimization__V1__Shipment_load_demands_instance_ \"Google::Cloud::Optimization::V1::Shipment#load_demands (method)\"). \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #amount\n\n def amount() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- The amount by which the load of the vehicle performing the corresponding visit will vary. Since it is an integer, users are advised to choose an appropriate unit to avoid loss of precision. Must be ≥ 0.\n\n### #amount=\n\n def amount=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::Integer) --- The amount by which the load of the vehicle performing the corresponding visit will vary. Since it is an integer, users are advised to choose an appropriate unit to avoid loss of precision. Must be ≥ 0. \n**Returns**\n\n- (::Integer) --- The amount by which the load of the vehicle performing the corresponding visit will vary. Since it is an integer, users are advised to choose an appropriate unit to avoid loss of precision. Must be ≥ 0."]]