Class GoogleCloudAiplatformV1NotebookRuntime

A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime. Default runtimes have a lifetime of 18 hours, while custom runtimes last for 6 months from their creation or last upgrade.

Inheritance

object

GoogleCloudAiplatformV1NotebookRuntime

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

Assembly: Google.Apis.Aiplatform.v1.dll

Syntax

public class GoogleCloudAiplatformV1NotebookRuntime : IDirectResponseSchema

Properties

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. Timestamp when this NotebookRuntime was created.

Declaration

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

Property Value

Type	Description
string

DataPersistentDiskSpec

Output only. The specification of persistent disk attached to the notebook runtime as data disk storage.

Declaration

[JsonProperty("dataPersistentDiskSpec")]
public virtual GoogleCloudAiplatformV1PersistentDiskSpec DataPersistentDiskSpec { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1PersistentDiskSpec

Description

The description of the NotebookRuntime.

Declaration

[JsonProperty("description")]
public virtual string Description { get; set; }

Property Value

Type	Description
string

DisplayName

Required. The display name of the NotebookRuntime. The name can be up to 128 characters long and can consist of any UTF-8 characters.

Declaration

[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }

Property Value

Type	Description
string

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

EncryptionSpec

Output only. Customer-managed encryption key spec for the notebook runtime.

Declaration

[JsonProperty("encryptionSpec")]
public virtual GoogleCloudAiplatformV1EncryptionSpec EncryptionSpec { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1EncryptionSpec

EucConfig

Output only. EUC configuration of the notebook runtime.

Declaration

[JsonProperty("eucConfig")]
public virtual GoogleCloudAiplatformV1NotebookEucConfig EucConfig { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1NotebookEucConfig

ExpirationTime

object representation of ExpirationTimeRaw.

Declaration

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

Property Value

Type	Description
object

ExpirationTimeDateTimeOffset

DateTimeOffset representation of ExpirationTimeRaw.

Declaration

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

Property Value

Type	Description
DateTimeOffset?

ExpirationTimeRaw

Output only. Timestamp when this NotebookRuntime will be expired: 1. System Predefined NotebookRuntime: 24 hours after creation. After expiration, system predifined runtime will be deleted. 2. User created NotebookRuntime: 6 months after last upgrade. After expiration, user created runtime will be stopped and allowed for upgrade.

Declaration

[JsonProperty("expirationTime")]
public virtual string ExpirationTimeRaw { get; set; }

Property Value

Type	Description
string

HealthState

Output only. The health state of the NotebookRuntime.

Declaration

[JsonProperty("healthState")]
public virtual string HealthState { get; set; }

Property Value

Type	Description
string

IdleShutdownConfig

Output only. The idle shutdown configuration of the notebook runtime.

Declaration

[JsonProperty("idleShutdownConfig")]
public virtual GoogleCloudAiplatformV1NotebookIdleShutdownConfig IdleShutdownConfig { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1NotebookIdleShutdownConfig

IsUpgradable

Output only. Whether NotebookRuntime is upgradable.

Declaration

[JsonProperty("isUpgradable")]
public virtual bool? IsUpgradable { get; set; }

Property Value

Type	Description
bool?

Labels

The labels with user-defined metadata to organize your NotebookRuntime. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one NotebookRuntime (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for NotebookRuntime: * "aiplatform.googleapis.com/notebook_runtime_gce_instance_id": output only, its value is the Compute Engine instance id. * "aiplatform.googleapis.com/colab_enterprise_entry_service": its value is either "bigquery" or "vertex"; if absent, it should be "vertex". This is to describe the entry service, either BigQuery or Vertex.

Declaration

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

Property Value

Type	Description
IDictionary<string, string>

MachineSpec

Output only. The specification of a single machine used by the notebook runtime.

Declaration

[JsonProperty("machineSpec")]
public virtual GoogleCloudAiplatformV1MachineSpec MachineSpec { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1MachineSpec

Name

Output only. The resource name of the NotebookRuntime.

Declaration

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

Property Value

Type	Description
string

NetworkSpec

Output only. Network spec of the notebook runtime.

Declaration

[JsonProperty("networkSpec")]
public virtual GoogleCloudAiplatformV1NetworkSpec NetworkSpec { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1NetworkSpec

NetworkTags

Optional. The Compute Engine tags to add to runtime (see Tagging instances).

Declaration

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

Property Value

Type	Description
IList<string>

NotebookRuntimeTemplateRef

Output only. The pointer to NotebookRuntimeTemplate this NotebookRuntime is created from.

Declaration

[JsonProperty("notebookRuntimeTemplateRef")]
public virtual GoogleCloudAiplatformV1NotebookRuntimeTemplateRef NotebookRuntimeTemplateRef { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1NotebookRuntimeTemplateRef

NotebookRuntimeType

Output only. The type of the notebook runtime.

Declaration

[JsonProperty("notebookRuntimeType")]
public virtual string NotebookRuntimeType { get; set; }

Property Value

Type	Description
string

ProxyUri

Output only. The proxy endpoint used to access the NotebookRuntime.

Declaration

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

Property Value

Type	Description
string

ReservationAffinity

Output only. Reservation Affinity of the notebook runtime.

Declaration

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

Property Value

Type	Description
GoogleCloudAiplatformV1NotebookReservationAffinity

RuntimeState

Output only. The runtime (instance) state of the NotebookRuntime.

Declaration

[JsonProperty("runtimeState")]
public virtual string RuntimeState { get; set; }

Property Value

Type	Description
string

RuntimeUser

Required. The user email of the NotebookRuntime.

Declaration

[JsonProperty("runtimeUser")]
public virtual string RuntimeUser { get; set; }

Property Value

Type	Description
string

SatisfiesPzi

Output only. Reserved for future use.

Declaration

[JsonProperty("satisfiesPzi")]
public virtual bool? SatisfiesPzi { get; set; }

Property Value

Type	Description
bool?

SatisfiesPzs

Output only. Reserved for future use.

Declaration

[JsonProperty("satisfiesPzs")]
public virtual bool? SatisfiesPzs { get; set; }

Property Value

Type	Description
bool?

ServiceAccount

Output only. Deprecated: This field is no longer used and the "Vertex AI Notebook Service Account" (service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com) is used for the runtime workload identity. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account for more details. The service account that the NotebookRuntime workload runs as.

Declaration

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

Property Value

Type	Description
string

ShieldedVmConfig

Output only. Runtime Shielded VM spec.

Declaration

[JsonProperty("shieldedVmConfig")]
public virtual GoogleCloudAiplatformV1ShieldedVmConfig ShieldedVmConfig { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1ShieldedVmConfig

SoftwareConfig

Output only. Software config of the notebook runtime.

Declaration

[JsonProperty("softwareConfig")]
public virtual GoogleCloudAiplatformV1NotebookSoftwareConfig SoftwareConfig { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1NotebookSoftwareConfig

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. Timestamp when this NotebookRuntime was most recently updated.

Declaration

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

Property Value

Type	Description
string

Version

Output only. The VM os image version of NotebookRuntime.

Declaration

[JsonProperty("version")]
public virtual string Version { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema