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 \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ location
↳ instances
array< AllocationPolicy\InstancePolicyOrTemplate
>
Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now.
↳ service_account
ServiceAccount
Defines the service account for Batch-created VMs. If omitted, the default Compute Engine service account is used. Must match the service account specified in any used instance template configured in the Batch job. Includes the following fields: * * email: The service account's email address. If not set, the default Compute Engine service account is used. * * scopes: Additional OAuth scopes to grant the service account, beyond the default cloud-platform scope. (list of strings)
↳ labels
array| Google\Protobuf\Internal\MapField
Custom labels to apply to the job and all the Compute Engine resources that both are created by this allocation policy and support labels. Use labels to group and describe the resources they are applied to. Batch automatically applies predefined labels and supports multiple labels
fields for each job, which each let you apply custom labels to various resources. Label names that start with "goog-" or "google-" are reserved for predefined labels. For more information about labels with Batch, see Organize resources using labels
.
↳ network
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
↳ tags
array
Optional. Tags applied to the VM instances. The tags identify valid sources or targets for network firewalls. Each tag must be 1-63 characters long, and comply with RFC1035 .
getLocation
Location where compute resources should be allocated for the Job.
hasLocation
clearLocation
setLocation
Location where compute resources should be allocated for the Job.
$this
getInstances
Describe instances that can be created by this AllocationPolicy.
Only instances[0] is supported now.
setInstances
Describe instances that can be created by this AllocationPolicy.
Only instances[0] is supported now.
$this
getServiceAccount
Defines the service account for Batch-created VMs. If omitted, the default Compute Engine service account is used. Must match the service account specified in any used instance template configured in the Batch job.
Includes the following fields:
- email: The service account's email address. If not set, the default Compute Engine service account is used.
- scopes: Additional OAuth scopes to grant the service account, beyond the default cloud-platform scope. (list of strings)
hasServiceAccount
clearServiceAccount
setServiceAccount
Defines the service account for Batch-created VMs. If omitted, the default Compute Engine service account is used. Must match the service account specified in any used instance template configured in the Batch job.
Includes the following fields:
- email: The service account's email address. If not set, the default Compute Engine service account is used.
- scopes: Additional OAuth scopes to grant the service account, beyond the default cloud-platform scope. (list of strings)
$this
getLabels
Custom labels to apply to the job and all the Compute Engine resources that both are created by this allocation policy and support labels.
Use labels to group and describe the resources they are applied to. Batch
automatically applies predefined labels and supports multiple labels
fields for each job, which each let you apply custom labels to various
resources. Label names that start with "goog-" or "google-" are
reserved for predefined labels. For more information about labels with
Batch, see Organize resources using
labels
.
setLabels
Custom labels to apply to the job and all the Compute Engine resources that both are created by this allocation policy and support labels.
Use labels to group and describe the resources they are applied to. Batch
automatically applies predefined labels and supports multiple labels
fields for each job, which each let you apply custom labels to various
resources. Label names that start with "goog-" or "google-" are
reserved for predefined labels. For more information about labels with
Batch, see Organize resources using
labels
.
$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.
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.
$this
getPlacement
The placement policy.
hasPlacement
clearPlacement
setPlacement
The placement policy.
$this
getTags
Optional. Tags applied to the VM instances.
The tags identify valid sources or targets for network firewalls. Each tag must be 1-63 characters long, and comply with RFC1035 .
setTags
Optional. Tags applied to the VM instances.
The tags identify valid sources or targets for network firewalls. Each tag must be 1-63 characters long, and comply with RFC1035 .
var
string[]
$this
