Google Cloud Batch V1 Client - Class PlacementPolicy (1.0.3)

Version 1.0.3

• 1.1.3 (latest)
• 1.1.2
• 1.0.3
• 0.17.0
• 0.16.10
• 0.15.0
• 0.14.0
• 0.13.1
• 0.12.1
• 0.11.3
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.2
• 0.4.0
• 0.3.0
• 0.2.2

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 message google.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.

Not yet implemented

Parameter
Name	Description
var	int|string

Returns
Type	Description
$this