Show / Hide Table of Contents

Class InstancePolicyOrTemplate

InstancePolicyOrTemplate lets you define the type of resources to use for this job either with an InstancePolicy or an instance template. If undefined, Batch picks the type of VM to use and doesn't include optional VM resources such as GPUs and extra disks.

Inheritance
object
InstancePolicyOrTemplate
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Batch.v1.Data
Assembly: Google.Apis.Batch.v1.dll
Syntax
public class InstancePolicyOrTemplate : IDirectResponseSchema

Properties

BlockProjectSshKeys

Optional. Set this field to true if you want Batch to block project-level SSH keys from accessing this job's VMs. Alternatively, you can configure the job to specify a VM instance template that blocks project-level SSH keys. In either case, Batch blocks project-level SSH keys while creating the VMs for this job. Batch allows project-level SSH keys for a job's VMs only if all the following are true: + This field is undefined or set to false. + The job's VM instance template (if any) doesn't block project-level SSH keys. Notably, you can override this behavior by manually updating a VM to block or allow project-level SSH keys. For more information about blocking project-level SSH keys, see the Compute Engine documentation: https://cloud.google.com/compute/docs/connect/restrict-ssh-keys#block-keys

Declaration
[JsonProperty("blockProjectSshKeys")]
public virtual bool? BlockProjectSshKeys { get; set; }
Property Value
Type Description
bool?

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

InstallGpuDrivers

Set this field true if you want Batch to help fetch drivers from a third party location and install them for GPUs specified in policy.accelerators or instance_template on your behalf. Default is false. For Container-Optimized Image cases, Batch will install the accelerator driver following milestones of https://cloud.google.com/container-optimized-os/docs/release-notes. For non Container-Optimized Image cases, following https://github.com/GoogleCloudPlatform/compute-gpu-installation/blob/main/linux/install_gpu_driver.py.

Declaration
[JsonProperty("installGpuDrivers")]
public virtual bool? InstallGpuDrivers { get; set; }
Property Value
Type Description
bool?

InstallOpsAgent

Optional. Set this field true if you want Batch to install Ops Agent on your behalf. Default is false.

Declaration
[JsonProperty("installOpsAgent")]
public virtual bool? InstallOpsAgent { get; set; }
Property Value
Type Description
bool?

InstanceTemplate

Name of an instance template used to create VMs. Named the field as 'instance_template' instead of 'template' to avoid C++ keyword conflict. Batch only supports global instance templates from the same project as the job. You can specify the global instance template as a full or partial URL.

Declaration
[JsonProperty("instanceTemplate")]
public virtual string InstanceTemplate { get; set; }
Property Value
Type Description
string

Policy

InstancePolicy.

Declaration
[JsonProperty("policy")]
public virtual InstancePolicy Policy { get; set; }
Property Value
Type Description
InstancePolicy

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX