Cloud AI Platform v1 API - Class NotebookRuntime (3.2.0) 

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

Reference documentation and code samples for the Cloud AI Platform v1 API class NotebookRuntime.

A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime limited to 24 hours.

Inheritance

object > NotebookRuntime

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

NotebookRuntime()

public NotebookRuntime()

NotebookRuntime(NotebookRuntime)

public NotebookRuntime(NotebookRuntime other)
Parameter
Name Description
other NotebookRuntime

Properties

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Timestamp when this NotebookRuntime was created.

Property Value
Type Description
Timestamp

Description

public string Description { get; set; }

The description of the NotebookRuntime.

Property Value
Type Description
string

DisplayName

public string DisplayName { get; set; }

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

Property Value
Type Description
string

EncryptionSpec

public EncryptionSpec EncryptionSpec { get; set; }

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

Property Value
Type Description
EncryptionSpec

ExpirationTime

public Timestamp ExpirationTime { get; set; }

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.
Property Value
Type Description
Timestamp

HealthState

public NotebookRuntime.Types.HealthState HealthState { get; set; }

Output only. The health state of the NotebookRuntime.

Property Value
Type Description
NotebookRuntimeTypesHealthState

IdleShutdownConfig

public NotebookIdleShutdownConfig IdleShutdownConfig { get; set; }

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

Property Value
Type Description
NotebookIdleShutdownConfig

IsUpgradable

public bool IsUpgradable { get; set; }

Output only. Whether NotebookRuntime is upgradable.

Property Value
Type Description
bool

Labels

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

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.
Property Value
Type Description
MapFieldstringstring

Name

public string Name { get; set; }

Output only. The resource name of the NotebookRuntime.

Property Value
Type Description
string

NetworkTags

public RepeatedField<string> NetworkTags { get; }

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

Property Value
Type Description
RepeatedFieldstring

NotebookRuntimeName

public NotebookRuntimeName NotebookRuntimeName { get; set; }

NotebookRuntimeName-typed view over the Name resource name property.

Property Value
Type Description
NotebookRuntimeName

NotebookRuntimeTemplateRef

public NotebookRuntimeTemplateRef NotebookRuntimeTemplateRef { get; set; }

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

Property Value
Type Description
NotebookRuntimeTemplateRef

NotebookRuntimeType

public NotebookRuntimeType NotebookRuntimeType { get; set; }

Output only. The type of the notebook runtime.

Property Value
Type Description
NotebookRuntimeType

ProxyUri

public string ProxyUri { get; set; }

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

Property Value
Type Description
string

RuntimeState

public NotebookRuntime.Types.RuntimeState RuntimeState { get; set; }

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

Property Value
Type Description
NotebookRuntimeTypesRuntimeState

RuntimeUser

public string RuntimeUser { get; set; }

Required. The user email of the NotebookRuntime.

Property Value
Type Description
string

SatisfiesPzi

public bool SatisfiesPzi { get; set; }

Output only. Reserved for future use.

Property Value
Type Description
bool

SatisfiesPzs

public bool SatisfiesPzs { get; set; }

Output only. Reserved for future use.

Property Value
Type Description
bool

ServiceAccount

public string ServiceAccount { get; set; }

Output only. The service account that the NotebookRuntime workload runs as.

Property Value
Type Description
string

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. Timestamp when this NotebookRuntime was most recently updated.

Property Value
Type Description
Timestamp

Version

public string Version { get; set; }

Output only. The VM os image version of NotebookRuntime.

Property Value
Type Description
string