Google Cloud Batch V1 Client - Class AllocationPolicy (0.15.0)

Reference documentation and code samples for the Google Cloud Batch V1 Client class AllocationPolicy.

A Job's resource allocation policy describes when, where, and how compute resources should be allocated for the Job.

Generated from protobuf message google.cloud.batch.v1.AllocationPolicy

Namespace

Google \ Cloud \ Batch \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ location Google\Cloud\Batch\V1\AllocationPolicy\LocationPolicy

Location where compute resources should be allocated for the Job.

↳ instances array<Google\Cloud\Batch\V1\AllocationPolicy\InstancePolicyOrTemplate>

Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now.

↳ service_account Google\Cloud\Batch\V1\ServiceAccount

Service account that VMs will run as.

↳ labels array|Google\Protobuf\Internal\MapField

Labels applied to all VM instances and other resources created by AllocationPolicy. Labels could be user provided or system generated. You can assign up to 64 labels. Google Compute Engine label restrictions apply. Label names that start with "goog-" or "google-" are reserved.

↳ network Google\Cloud\Batch\V1\AllocationPolicy\NetworkPolicy

The network policy. If you define an instance template in the InstancePolicyOrTemplate field, Batch will use the network settings in the instance template instead of this field.

↳ placement Google\Cloud\Batch\V1\AllocationPolicy\PlacementPolicy

The placement policy.

getLocation

Location where compute resources should be allocated for the Job.

Returns
TypeDescription
Google\Cloud\Batch\V1\AllocationPolicy\LocationPolicy|null

hasLocation

clearLocation

setLocation

Location where compute resources should be allocated for the Job.

Parameter
NameDescription
var Google\Cloud\Batch\V1\AllocationPolicy\LocationPolicy
Returns
TypeDescription
$this

getInstances

Describe instances that can be created by this AllocationPolicy.

Only instances[0] is supported now.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setInstances

Describe instances that can be created by this AllocationPolicy.

Only instances[0] is supported now.

Parameter
NameDescription
var array<Google\Cloud\Batch\V1\AllocationPolicy\InstancePolicyOrTemplate>
Returns
TypeDescription
$this

getServiceAccount

Service account that VMs will run as.

Returns
TypeDescription
Google\Cloud\Batch\V1\ServiceAccount|null

hasServiceAccount

clearServiceAccount

setServiceAccount

Service account that VMs will run as.

Parameter
NameDescription
var Google\Cloud\Batch\V1\ServiceAccount
Returns
TypeDescription
$this

getLabels

Labels applied to all VM instances and other resources created by AllocationPolicy.

Labels could be user provided or system generated. You can assign up to 64 labels. Google Compute Engine label restrictions apply. Label names that start with "goog-" or "google-" are reserved.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

Labels applied to all VM instances and other resources created by AllocationPolicy.

Labels could be user provided or system generated. You can assign up to 64 labels. Google Compute Engine label restrictions apply. Label names that start with "goog-" or "google-" are reserved.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getNetwork

The network policy.

If you define an instance template in the InstancePolicyOrTemplate field, Batch will use the network settings in the instance template instead of this field.

Returns
TypeDescription
Google\Cloud\Batch\V1\AllocationPolicy\NetworkPolicy|null

hasNetwork

clearNetwork

setNetwork

The network policy.

If you define an instance template in the InstancePolicyOrTemplate field, Batch will use the network settings in the instance template instead of this field.

Parameter
NameDescription
var Google\Cloud\Batch\V1\AllocationPolicy\NetworkPolicy
Returns
TypeDescription
$this

getPlacement

The placement policy.

Returns
TypeDescription
Google\Cloud\Batch\V1\AllocationPolicy\PlacementPolicy|null

hasPlacement

clearPlacement

setPlacement

The placement policy.

Parameter
NameDescription
var Google\Cloud\Batch\V1\AllocationPolicy\PlacementPolicy
Returns
TypeDescription
$this