Reference documentation and code samples for the Google Cloud Batch V1 Client class PlacementPolicy.
PlacementPolicy describes a group placement policy for the VMs controlled
by this AllocationPolicy.
Generated from protobuf messagegoogle.cloud.batch.v1.AllocationPolicy.PlacementPolicy
Namespace
Google \ Cloud \ Batch \ V1 \ AllocationPolicy
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ collocation
string
UNSPECIFIED vs. COLLOCATED (default UNSPECIFIED). Use COLLOCATED when you want VMs to be located close to each other for low network latency between the VMs. No placement policy will be generated when collocation is UNSPECIFIED.
↳ max_distance
int|string
When specified, causes the job to fail if more than max_distance logical switches are required between VMs. Batch uses the most compact possible placement of VMs even when max_distance is not specified. An explicit max_distance makes that level of compactness a strict requirement. Not yet implemented
getCollocation
UNSPECIFIED vs. COLLOCATED (default UNSPECIFIED). Use COLLOCATED when you
want VMs to be located close to each other for low network latency
between the VMs. No placement policy will be generated when collocation
is UNSPECIFIED.
Returns
Type
Description
string
setCollocation
UNSPECIFIED vs. COLLOCATED (default UNSPECIFIED). Use COLLOCATED when you
want VMs to be located close to each other for low network latency
between the VMs. No placement policy will be generated when collocation
is UNSPECIFIED.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getMaxDistance
When specified, causes the job to fail if more than max_distance logical
switches are required between VMs. Batch uses the most compact possible
placement of VMs even when max_distance is not specified. An explicit
max_distance makes that level of compactness a strict requirement.
Not yet implemented
Returns
Type
Description
int|string
setMaxDistance
When specified, causes the job to fail if more than max_distance logical
switches are required between VMs. Batch uses the most compact possible
placement of VMs even when max_distance is not specified. An explicit
max_distance makes that level of compactness a strict requirement.
[[["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 Cloud Batch V1 Client - Class PlacementPolicy (1.2.2)\n\nVersion latestkeyboard_arrow_down\n\n- [1.2.2 (latest)](/php/docs/reference/cloud-batch/latest/V1.AllocationPolicy.PlacementPolicy)\n- [1.2.1](/php/docs/reference/cloud-batch/1.2.1/V1.AllocationPolicy.PlacementPolicy)\n- [1.1.7](/php/docs/reference/cloud-batch/1.1.7/V1.AllocationPolicy.PlacementPolicy)\n- [1.0.3](/php/docs/reference/cloud-batch/1.0.3/V1.AllocationPolicy.PlacementPolicy)\n- [0.17.0](/php/docs/reference/cloud-batch/0.17.0/V1.AllocationPolicy.PlacementPolicy)\n- [0.16.10](/php/docs/reference/cloud-batch/0.16.10/V1.AllocationPolicy.PlacementPolicy)\n- [0.15.0](/php/docs/reference/cloud-batch/0.15.0/V1.AllocationPolicy.PlacementPolicy)\n- [0.14.0](/php/docs/reference/cloud-batch/0.14.0/V1.AllocationPolicy.PlacementPolicy)\n- [0.13.1](/php/docs/reference/cloud-batch/0.13.1/V1.AllocationPolicy.PlacementPolicy)\n- [0.12.1](/php/docs/reference/cloud-batch/0.12.1/V1.AllocationPolicy.PlacementPolicy)\n- [0.11.3](/php/docs/reference/cloud-batch/0.11.3/V1.AllocationPolicy.PlacementPolicy)\n- [0.10.0](/php/docs/reference/cloud-batch/0.10.0/V1.AllocationPolicy.PlacementPolicy)\n- [0.9.0](/php/docs/reference/cloud-batch/0.9.0/V1.AllocationPolicy.PlacementPolicy)\n- [0.8.0](/php/docs/reference/cloud-batch/0.8.0/V1.AllocationPolicy.PlacementPolicy)\n- [0.7.0](/php/docs/reference/cloud-batch/0.7.0/V1.AllocationPolicy.PlacementPolicy)\n- [0.6.0](/php/docs/reference/cloud-batch/0.6.0/V1.AllocationPolicy.PlacementPolicy)\n- [0.5.2](/php/docs/reference/cloud-batch/0.5.2/V1.AllocationPolicy.PlacementPolicy)\n- [0.4.0](/php/docs/reference/cloud-batch/0.4.0/V1.AllocationPolicy.PlacementPolicy)\n- [0.3.0](/php/docs/reference/cloud-batch/0.3.0/V1.AllocationPolicy.PlacementPolicy)\n- [0.2.2](/php/docs/reference/cloud-batch/0.2.2/V1.AllocationPolicy.PlacementPolicy) \nReference documentation and code samples for the Google Cloud Batch V1 Client class PlacementPolicy.\n\nPlacementPolicy describes a group placement policy for the VMs controlled\nby this AllocationPolicy.\n\nGenerated from protobuf message `google.cloud.batch.v1.AllocationPolicy.PlacementPolicy`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Batch \\\\ V1 \\\\ AllocationPolicy\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getCollocation\n\nUNSPECIFIED vs. COLLOCATED (default UNSPECIFIED). Use COLLOCATED when you\nwant VMs to be located close to each other for low network latency\nbetween the VMs. No placement policy will be generated when collocation\nis UNSPECIFIED.\n\n### setCollocation\n\nUNSPECIFIED vs. COLLOCATED (default UNSPECIFIED). Use COLLOCATED when you\nwant VMs to be located close to each other for low network latency\nbetween the VMs. No placement policy will be generated when collocation\nis UNSPECIFIED.\n\n### getMaxDistance\n\nWhen specified, causes the job to fail if more than max_distance logical\nswitches are required between VMs. Batch uses the most compact possible\nplacement of VMs even when max_distance is not specified. An explicit\nmax_distance makes that level of compactness a strict requirement.\n\nNot yet implemented\n\n### setMaxDistance\n\nWhen specified, causes the job to fail if more than max_distance logical\nswitches are required between VMs. Batch uses the most compact possible\nplacement of VMs even when max_distance is not specified. An explicit\nmax_distance makes that level of compactness a strict requirement.\n\nNot yet implemented"]]
