Reference documentation and code samples for the Batch V1 API class Google::Cloud::Batch::V1::AllocationPolicy::LocationPolicy.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#allowed_locations
defallowed_locations()->::Array<::String>
Returns
(::Array<::String>) — A list of allowed location names represented by internal URLs.
Each location can be a region or a zone.
Only one region or multiple zones in one region is supported now.
For example,
["regions/us-central1"] allow VMs in any zones in region us-central1.
["zones/us-central1-a", "zones/us-central1-c"] only allow VMs
in zones us-central1-a and us-central1-c.
Mixing locations from different regions would cause errors.
For example,
["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b",
"zones/us-west1-a"] contains locations from two distinct regions:
us-central1 and us-west1. This combination will trigger an error.
#allowed_locations=
defallowed_locations=(value)->::Array<::String>
Parameter
value (::Array<::String>) — A list of allowed location names represented by internal URLs.
Each location can be a region or a zone.
Only one region or multiple zones in one region is supported now.
For example,
["regions/us-central1"] allow VMs in any zones in region us-central1.
["zones/us-central1-a", "zones/us-central1-c"] only allow VMs
in zones us-central1-a and us-central1-c.
Mixing locations from different regions would cause errors.
For example,
["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b",
"zones/us-west1-a"] contains locations from two distinct regions:
us-central1 and us-west1. This combination will trigger an error.
Returns
(::Array<::String>) — A list of allowed location names represented by internal URLs.
Each location can be a region or a zone.
Only one region or multiple zones in one region is supported now.
For example,
["regions/us-central1"] allow VMs in any zones in region us-central1.
["zones/us-central1-a", "zones/us-central1-c"] only allow VMs
in zones us-central1-a and us-central1-c.
Mixing locations from different regions would cause errors.
For example,
["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b",
"zones/us-west1-a"] contains locations from two distinct regions:
us-central1 and us-west1. This combination will trigger an error.
[[["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,["# Batch V1 API - Class Google::Cloud::Batch::V1::AllocationPolicy::LocationPolicy (v1.2.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.2.0 (latest)](/ruby/docs/reference/google-cloud-batch-v1/latest/Google-Cloud-Batch-V1-AllocationPolicy-LocationPolicy)\n- [1.1.1](/ruby/docs/reference/google-cloud-batch-v1/1.1.1/Google-Cloud-Batch-V1-AllocationPolicy-LocationPolicy)\n- [1.0.0](/ruby/docs/reference/google-cloud-batch-v1/1.0.0/Google-Cloud-Batch-V1-AllocationPolicy-LocationPolicy)\n- [0.21.0](/ruby/docs/reference/google-cloud-batch-v1/0.21.0/Google-Cloud-Batch-V1-AllocationPolicy-LocationPolicy)\n- [0.20.1](/ruby/docs/reference/google-cloud-batch-v1/0.20.1/Google-Cloud-Batch-V1-AllocationPolicy-LocationPolicy)\n- [0.19.2](/ruby/docs/reference/google-cloud-batch-v1/0.19.2/Google-Cloud-Batch-V1-AllocationPolicy-LocationPolicy)\n- [0.18.3](/ruby/docs/reference/google-cloud-batch-v1/0.18.3/Google-Cloud-Batch-V1-AllocationPolicy-LocationPolicy)\n- [0.17.4](/ruby/docs/reference/google-cloud-batch-v1/0.17.4/Google-Cloud-Batch-V1-AllocationPolicy-LocationPolicy)\n- [0.16.2](/ruby/docs/reference/google-cloud-batch-v1/0.16.2/Google-Cloud-Batch-V1-AllocationPolicy-LocationPolicy)\n- [0.15.1](/ruby/docs/reference/google-cloud-batch-v1/0.15.1/Google-Cloud-Batch-V1-AllocationPolicy-LocationPolicy)\n- [0.14.0](/ruby/docs/reference/google-cloud-batch-v1/0.14.0/Google-Cloud-Batch-V1-AllocationPolicy-LocationPolicy)\n- [0.13.1](/ruby/docs/reference/google-cloud-batch-v1/0.13.1/Google-Cloud-Batch-V1-AllocationPolicy-LocationPolicy)\n- [0.12.0](/ruby/docs/reference/google-cloud-batch-v1/0.12.0/Google-Cloud-Batch-V1-AllocationPolicy-LocationPolicy)\n- [0.11.1](/ruby/docs/reference/google-cloud-batch-v1/0.11.1/Google-Cloud-Batch-V1-AllocationPolicy-LocationPolicy)\n- [0.10.5](/ruby/docs/reference/google-cloud-batch-v1/0.10.5/Google-Cloud-Batch-V1-AllocationPolicy-LocationPolicy)\n- [0.9.0](/ruby/docs/reference/google-cloud-batch-v1/0.9.0/Google-Cloud-Batch-V1-AllocationPolicy-LocationPolicy)\n- [0.8.0](/ruby/docs/reference/google-cloud-batch-v1/0.8.0/Google-Cloud-Batch-V1-AllocationPolicy-LocationPolicy)\n- [0.7.0](/ruby/docs/reference/google-cloud-batch-v1/0.7.0/Google-Cloud-Batch-V1-AllocationPolicy-LocationPolicy)\n- [0.6.0](/ruby/docs/reference/google-cloud-batch-v1/0.6.0/Google-Cloud-Batch-V1-AllocationPolicy-LocationPolicy)\n- [0.5.0](/ruby/docs/reference/google-cloud-batch-v1/0.5.0/Google-Cloud-Batch-V1-AllocationPolicy-LocationPolicy)\n- [0.4.3](/ruby/docs/reference/google-cloud-batch-v1/0.4.3/Google-Cloud-Batch-V1-AllocationPolicy-LocationPolicy)\n- [0.3.0](/ruby/docs/reference/google-cloud-batch-v1/0.3.0/Google-Cloud-Batch-V1-AllocationPolicy-LocationPolicy)\n- [0.2.0](/ruby/docs/reference/google-cloud-batch-v1/0.2.0/Google-Cloud-Batch-V1-AllocationPolicy-LocationPolicy)\n- [0.1.0](/ruby/docs/reference/google-cloud-batch-v1/0.1.0/Google-Cloud-Batch-V1-AllocationPolicy-LocationPolicy) \nReference documentation and code samples for the Batch V1 API class Google::Cloud::Batch::V1::AllocationPolicy::LocationPolicy. \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### #allowed_locations\n\n def allowed_locations() -\u003e ::Array\u003c::String\u003e\n\n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- A list of allowed location names represented by internal URLs.\n\n Each location can be a region or a zone.\n Only one region or multiple zones in one region is supported now.\n For example,\n \\[\"regions/us-central1\"\\] allow VMs in any zones in region us-central1.\n \\[\"zones/us-central1-a\", \"zones/us-central1-c\"\\] only allow VMs\n in zones us-central1-a and us-central1-c.\n\n Mixing locations from different regions would cause errors.\n For example,\n \\[\"regions/us-central1\", \"zones/us-central1-a\", \"zones/us-central1-b\",\n \"zones/us-west1-a\"\\] contains locations from two distinct regions:\n us-central1 and us-west1. This combination will trigger an error.\n\n### #allowed_locations=\n\n def allowed_locations=(value) -\u003e ::Array\u003c::String\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c::String\\\u003e) --- A list of allowed location names represented by internal URLs.\n\n\n Each location can be a region or a zone.\n Only one region or multiple zones in one region is supported now.\n For example,\n \\[\"regions/us-central1\"\\] allow VMs in any zones in region us-central1.\n \\[\"zones/us-central1-a\", \"zones/us-central1-c\"\\] only allow VMs\n in zones us-central1-a and us-central1-c.\n\n Mixing locations from different regions would cause errors.\n For example,\n \\[\"regions/us-central1\", \"zones/us-central1-a\", \"zones/us-central1-b\",\n \"zones/us-west1-a\"\\] contains locations from two distinct regions:\nus-central1 and us-west1. This combination will trigger an error. \n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- A list of allowed location names represented by internal URLs.\n\n Each location can be a region or a zone.\n Only one region or multiple zones in one region is supported now.\n For example,\n \\[\"regions/us-central1\"\\] allow VMs in any zones in region us-central1.\n \\[\"zones/us-central1-a\", \"zones/us-central1-c\"\\] only allow VMs\n in zones us-central1-a and us-central1-c.\n\n Mixing locations from different regions would cause errors.\n For example,\n \\[\"regions/us-central1\", \"zones/us-central1-a\", \"zones/us-central1-b\",\n \"zones/us-west1-a\"\\] contains locations from two distinct regions:\n us-central1 and us-west1. This combination will trigger an error."]]