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
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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. |
getLocation
Location where compute resources should be allocated for the Job.
Generated from protobuf field .google.cloud.batch.v1.AllocationPolicy.LocationPolicy location = 1;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Batch\V1\AllocationPolicy\LocationPolicy|null | |
hasLocation
clearLocation
setLocation
Location where compute resources should be allocated for the Job.
Generated from protobuf field .google.cloud.batch.v1.AllocationPolicy.LocationPolicy location = 1;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Batch\V1\AllocationPolicy\LocationPolicy
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getInstances
Describe instances that can be created by this AllocationPolicy.
Only instances[0] is supported now.
Generated from protobuf field repeated .google.cloud.batch.v1.AllocationPolicy.InstancePolicyOrTemplate instances = 8;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setInstances
Describe instances that can be created by this AllocationPolicy.
Only instances[0] is supported now.
Generated from protobuf field repeated .google.cloud.batch.v1.AllocationPolicy.InstancePolicyOrTemplate instances = 8;
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Batch\V1\AllocationPolicy\InstancePolicyOrTemplate>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getServiceAccount
Service account that VMs will run as.
Generated from protobuf field .google.cloud.batch.v1.ServiceAccount service_account = 9;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Batch\V1\ServiceAccount|null | |
hasServiceAccount
clearServiceAccount
setServiceAccount
Service account that VMs will run as.
Generated from protobuf field .google.cloud.batch.v1.ServiceAccount service_account = 9;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Batch\V1\ServiceAccount
|
| Returns | |
|---|---|
| Type | Description |
$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.
Generated from protobuf field map<string, string> labels = 6;
| Returns | |
|---|---|
| Type | Description |
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.
Generated from protobuf field map<string, string> labels = 6;
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getNetwork
The network policy.
Generated from protobuf field .google.cloud.batch.v1.AllocationPolicy.NetworkPolicy network = 7;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Batch\V1\AllocationPolicy\NetworkPolicy|null | |
hasNetwork
clearNetwork
setNetwork
The network policy.
Generated from protobuf field .google.cloud.batch.v1.AllocationPolicy.NetworkPolicy network = 7;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Batch\V1\AllocationPolicy\NetworkPolicy
|
| Returns | |
|---|---|
| Type | Description |
$this | |