Class Instance

The definition of a notebook instance.

Inheritance

object

Instance

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.AIPlatformNotebooks.v1.Data

Assembly: Google.Apis.AIPlatformNotebooks.v1.dll

Syntax

public class Instance : IDirectResponseSchema

Properties

AcceleratorConfig

The hardware accelerator used on this instance. If you use accelerators, make sure that your configuration has enough vCPUs and memory to support the machine_type you have selected.

Declaration

[JsonProperty("acceleratorConfig")]
public virtual AcceleratorConfig AcceleratorConfig { get; set; }

Property Value

Type	Description
AcceleratorConfig

BootDiskSizeGb

Input only. The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). The minimum recommended value is 100 GB. If not specified, this defaults to 100.

Declaration

[JsonProperty("bootDiskSizeGb")]
public virtual long? BootDiskSizeGb { get; set; }

Property Value

Type	Description
long?

BootDiskType

Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (PD_STANDARD).

Declaration

[JsonProperty("bootDiskType")]
public virtual string BootDiskType { get; set; }

Property Value

Type	Description
string

CanIpForward

Optional. Flag to enable ip forwarding or not, default false/off. https://cloud.google.com/vpc/docs/using-routes#canipforward

Declaration

[JsonProperty("canIpForward")]
public virtual bool? CanIpForward { get; set; }

Property Value

Type	Description
bool?

ContainerImage

Use a container image to start the notebook instance.

Declaration

[JsonProperty("containerImage")]
public virtual ContainerImage ContainerImage { get; set; }

Property Value

Type	Description
ContainerImage

CreateTime

object representation of CreateTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }

Property Value

Type	Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

CreateTimeRaw

Output only. Instance creation time.

Declaration

[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }

Property Value

Type	Description
string

Creator

Output only. Email address of entity that sent original CreateInstance request.

Declaration

[JsonProperty("creator")]
public virtual string Creator { get; set; }

Property Value

Type	Description
string

CustomGpuDriverPath

Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.

Declaration

[JsonProperty("customGpuDriverPath")]
public virtual string CustomGpuDriverPath { get; set; }

Property Value

Type	Description
string

DataDiskSizeGb

Input only. The size of the data disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). You can choose the size of the data disk based on how big your notebooks and data are. If not specified, this defaults to 100.

Declaration

[JsonProperty("dataDiskSizeGb")]
public virtual long? DataDiskSizeGb { get; set; }

Property Value

Type	Description
long?

DataDiskType

Input only. The type of the data disk attached to this instance, defaults to standard persistent disk (PD_STANDARD).

Declaration

[JsonProperty("dataDiskType")]
public virtual string DataDiskType { get; set; }

Property Value

Type	Description
string

DiskEncryption

Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.

Declaration

[JsonProperty("diskEncryption")]
public virtual string DiskEncryption { get; set; }

Property Value

Type	Description
string

Disks

Output only. Attached disks to notebook instance.

Declaration

[JsonProperty("disks")]
public virtual IList<Disk> Disks { get; set; }

Property Value

Type	Description
IList<Disk>

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

InstallGpuDriver

Whether the end user authorizes Google Cloud to install GPU driver on this instance. If this field is empty or set to false, the GPU driver won't be installed. Only applicable to instances with GPUs.

Declaration

[JsonProperty("installGpuDriver")]
public virtual bool? InstallGpuDriver { get; set; }

Property Value

Type	Description
bool?

InstanceMigrationEligibility

Output only. Checks how feasible a migration from UmN to WbI is.

Declaration

[JsonProperty("instanceMigrationEligibility")]
public virtual InstanceMigrationEligibility InstanceMigrationEligibility { get; set; }

Property Value

Type	Description
InstanceMigrationEligibility

InstanceOwners

Input only. The owner of this instance after creation. Format: alias@example.com Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.

Declaration

[JsonProperty("instanceOwners")]
public virtual IList<string> InstanceOwners { get; set; }

Property Value

Type	Description
IList<string>

KmsKey

Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id} Learn more about using your own encryption keys.

Declaration

[JsonProperty("kmsKey")]
public virtual string KmsKey { get; set; }

Property Value

Type	Description
string

Labels

Labels to apply to this instance. These can be later modified by the setLabels method.

Declaration

[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }

Property Value

Type	Description
IDictionary<string, string>

MachineType

Required. The Compute Engine machine type of this instance.

Declaration

[JsonProperty("machineType")]
public virtual string MachineType { get; set; }

Property Value

Type	Description
string

Metadata

Custom metadata to apply to this instance. For example, to specify a Cloud Storage bucket for automatic backup, you can use the gcs-data-bucket metadata tag. Format: "--metadata=gcs-data-bucket=BUCKET".

Declaration

[JsonProperty("metadata")]
public virtual IDictionary<string, string> Metadata { get; set; }

Property Value

Type	Description
IDictionary<string, string>

Migrated

Output only. Bool indicating whether this notebook has been migrated to a Workbench Instance

Declaration

[JsonProperty("migrated")]
public virtual bool? Migrated { get; set; }

Property Value

Type	Description
bool?

Name

Output only. The name of this notebook instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

Declaration

[JsonProperty("name")]
public virtual string Name { get; set; }

Property Value

Type	Description
string

Network

The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}

Declaration

[JsonProperty("network")]
public virtual string Network { get; set; }

Property Value

Type	Description
string

NicType

Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

Declaration

[JsonProperty("nicType")]
public virtual string NicType { get; set; }

Property Value

Type	Description
string

NoProxyAccess

If true, the notebook instance will not register with the proxy.

Declaration

[JsonProperty("noProxyAccess")]
public virtual bool? NoProxyAccess { get; set; }

Property Value

Type	Description
bool?

NoPublicIp

If true, no external IP will be assigned to this instance.

Declaration

[JsonProperty("noPublicIp")]
public virtual bool? NoPublicIp { get; set; }

Property Value

Type	Description
bool?

NoRemoveDataDisk

Input only. If true, the data disk will not be auto deleted when deleting the instance.

Declaration

[JsonProperty("noRemoveDataDisk")]
public virtual bool? NoRemoveDataDisk { get; set; }

Property Value

Type	Description
bool?

PostStartupScript

Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (gs://path-to-file/file-name).

Declaration

[JsonProperty("postStartupScript")]
public virtual string PostStartupScript { get; set; }

Property Value

Type	Description
string

ProxyUri

Output only. The proxy endpoint that is used to access the Jupyter notebook.

Declaration

[JsonProperty("proxyUri")]
public virtual string ProxyUri { get; set; }

Property Value

Type	Description
string

ReservationAffinity

Optional. The optional reservation affinity. Setting this field will apply the specified Zonal Compute Reservation to this notebook instance.

Declaration

[JsonProperty("reservationAffinity")]
public virtual ReservationAffinity ReservationAffinity { get; set; }

Property Value

Type	Description
ReservationAffinity

ServiceAccount

The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the Compute Engine default service account is used.

Declaration

[JsonProperty("serviceAccount")]
public virtual string ServiceAccount { get; set; }

Property Value

Type	Description
string

ServiceAccountScopes

Optional. The URIs of service account scopes to be included in Compute Engine instances. If not specified, the following scopes are defined: - https://www.googleapis.com/auth/cloud-platform - https://www.googleapis.com/auth/userinfo.email If not using default scopes, you need at least: https://www.googleapis.com/auth/compute

Declaration

[JsonProperty("serviceAccountScopes")]
public virtual IList<string> ServiceAccountScopes { get; set; }

Property Value

Type	Description
IList<string>

ShieldedInstanceConfig

Optional. Shielded VM configuration. Images using supported Shielded VM features.

Declaration

[JsonProperty("shieldedInstanceConfig")]
public virtual ShieldedInstanceConfig ShieldedInstanceConfig { get; set; }

Property Value

Type	Description
ShieldedInstanceConfig

State

Output only. The state of this instance.

Declaration

[JsonProperty("state")]
public virtual string State { get; set; }

Property Value

Type	Description
string

Subnet

The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}

Declaration

[JsonProperty("subnet")]
public virtual string Subnet { get; set; }

Property Value

Type	Description
string

UpdateTime

object representation of UpdateTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }

Property Value

Type	Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

UpdateTimeRaw

Output only. Instance update time.

Declaration

[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }

Property Value

Type	Description
string

UpgradeHistory

The upgrade history of this instance.

Declaration

[JsonProperty("upgradeHistory")]
public virtual IList<UpgradeHistoryEntry> UpgradeHistory { get; set; }

Property Value

Type	Description
IList<UpgradeHistoryEntry>

VmImage

Use a Compute Engine VM image to start the notebook instance.

Declaration

[JsonProperty("vmImage")]
public virtual VmImage VmImage { get; set; }

Property Value

Type	Description
VmImage

Implements

IDirectResponseSchema