AI Platform Notebooks v1 API - Class Instance (2.2.0)

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

Reference documentation and code samples for the AI Platform Notebooks v1 API class Instance.

The definition of a notebook instance.

Inheritance

Object > Instance

Implements

IMessage<Instance>, IEquatable<Instance>, IDeepCloneable<Instance>, IBufferMessage, IMessage

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Notebooks.V1

Assembly

Google.Cloud.Notebooks.V1.dll

Constructors

Instance()

public Instance()

Instance(Instance)

public Instance(Instance other)

Parameter
Name	Description
`other`	`Instance`

Properties

AcceleratorConfig

public Instance.Types.AcceleratorConfig AcceleratorConfig { get; set; }

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.

Property Value
Type	Description
`Instance.Types.AcceleratorConfig`

BootDiskSizeGb

public long BootDiskSizeGb { get; set; }

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.

Property Value
Type	Description
`Int64`

BootDiskType

public Instance.Types.DiskType BootDiskType { get; set; }

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

Property Value
Type	Description
`Instance.Types.DiskType`

CanIpForward

public bool CanIpForward { get; set; }

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

Property Value
Type	Description
`Boolean`

ContainerImage

public ContainerImage ContainerImage { get; set; }

Use a container image to start the notebook instance.

Property Value
Type	Description
`ContainerImage`

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Instance creation time.

Property Value
Type	Description
`Timestamp`

Creator

public string Creator { get; set; }

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

Property Value
Type	Description
`String`

CustomGpuDriverPath

public string CustomGpuDriverPath { get; set; }

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

Property Value
Type	Description
`String`

DataDiskSizeGb

public long DataDiskSizeGb { get; set; }

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.

Property Value
Type	Description
`Int64`

DataDiskType

public Instance.Types.DiskType DataDiskType { get; set; }

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

Property Value
Type	Description
`Instance.Types.DiskType`

DiskEncryption

public Instance.Types.DiskEncryption DiskEncryption { get; set; }

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

Property Value
Type	Description
`Instance.Types.DiskEncryption`

Disks

public RepeatedField<Instance.Types.Disk> Disks { get; }

Output only. Attached disks to notebook instance.

Property Value
Type	Description
`RepeatedField<Instance.Types.Disk>`

EnvironmentCase

public Instance.EnvironmentOneofCase EnvironmentCase { get; }

Property Value
Type	Description
`Instance.EnvironmentOneofCase`

InstallGpuDriver

public bool InstallGpuDriver { get; set; }

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.

Property Value
Type	Description
`Boolean`

InstanceName

public InstanceName InstanceName { get; set; }

InstanceName-typed view over the Name resource name property.

Property Value
Type	Description
`InstanceName`

InstanceOwners

public RepeatedField<string> InstanceOwners { get; }

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.

Property Value
Type	Description
`RepeatedField<String>`

KmsKey

public string KmsKey { get; set; }

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.

Property Value
Type	Description
`String`

Labels

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

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

Property Value
Type	Description
`MapField<String, String>`

MachineType

public string MachineType { get; set; }

Required. The Compute Engine machine type of this instance.

Property Value
Type	Description
`String`

Metadata

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

Custom metadata to apply to this instance.

Property Value
Type	Description
`MapField<String, String>`

Name

public string Name { get; set; }

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

Property Value
Type	Description
`String`

Network

public string Network { get; set; }

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

Property Value
Type	Description
`String`

NicType

public Instance.Types.NicType NicType { get; set; }

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

Property Value
Type	Description
`Instance.Types.NicType`

NoProxyAccess

public bool NoProxyAccess { get; set; }

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

Property Value
Type	Description
`Boolean`

NoPublicIp

public bool NoPublicIp { get; set; }

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

Property Value
Type	Description
`Boolean`

NoRemoveDataDisk

public bool NoRemoveDataDisk { get; set; }

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

Property Value
Type	Description
`Boolean`

PostStartupScript

public string PostStartupScript { get; set; }

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).

Property Value
Type	Description
`String`

ProxyUri

public string ProxyUri { get; set; }

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

Property Value
Type	Description
`String`

ReservationAffinity

public ReservationAffinity ReservationAffinity { get; set; }

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

Property Value
Type	Description
`ReservationAffinity`

ServiceAccount

public string ServiceAccount { get; set; }

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.

Property Value
Type	Description
`String`

ServiceAccountScopes

public RepeatedField<string> ServiceAccountScopes { get; }

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

Property Value
Type	Description
`RepeatedField<String>`

ShieldedInstanceConfig

public Instance.Types.ShieldedInstanceConfig ShieldedInstanceConfig { get; set; }

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

Property Value
Type	Description
`Instance.Types.ShieldedInstanceConfig`

State

public Instance.Types.State State { get; set; }

Output only. The state of this instance.

Property Value
Type	Description
`Instance.Types.State`

Subnet

public string Subnet { get; set; }

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

Property Value
Type	Description
`String`

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. Instance update time.

Property Value
Type	Description
`Timestamp`

UpgradeHistory

public RepeatedField<Instance.Types.UpgradeHistoryEntry> UpgradeHistory { get; }

The upgrade history of this instance.

Property Value
Type	Description
`RepeatedField<Instance.Types.UpgradeHistoryEntry>`

VmImage

public VmImage VmImage { get; set; }

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

Property Value
Type	Description
`VmImage`