Batch v1 API - Class AllocationPolicy (2.10.0)

public sealed class AllocationPolicy : IMessage<AllocationPolicy>, IEquatable<AllocationPolicy>, IDeepCloneable<AllocationPolicy>, IBufferMessage, IMessage

Reference documentation and code samples for the Batch v1 API class AllocationPolicy.

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

Inheritance

object > AllocationPolicy

Namespace

Google.Cloud.Batch.V1

Assembly

Google.Cloud.Batch.V1.dll

Constructors

AllocationPolicy()

public AllocationPolicy()

AllocationPolicy(AllocationPolicy)

public AllocationPolicy(AllocationPolicy other)
Parameter
Name Description
other AllocationPolicy

Properties

Instances

public RepeatedField<AllocationPolicy.Types.InstancePolicyOrTemplate> Instances { get; }

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

Property Value
Type Description
RepeatedFieldAllocationPolicyTypesInstancePolicyOrTemplate

Labels

public MapField<string, string> Labels { get; }

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.

Property Value
Type Description
MapFieldstringstring

Location

public AllocationPolicy.Types.LocationPolicy Location { get; set; }

Location where compute resources should be allocated for the Job.

Property Value
Type Description
AllocationPolicyTypesLocationPolicy

Network

public AllocationPolicy.Types.NetworkPolicy Network { get; set; }

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.

Property Value
Type Description
AllocationPolicyTypesNetworkPolicy

Placement

public AllocationPolicy.Types.PlacementPolicy Placement { get; set; }

The placement policy.

Property Value
Type Description
AllocationPolicyTypesPlacementPolicy

ServiceAccount

public ServiceAccount ServiceAccount { get; set; }

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)
Property Value
Type Description
ServiceAccount

Tags

public RepeatedField<string> Tags { get; }

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.

Property Value
Type Description
RepeatedFieldstring