Show / Hide Table of Contents

Class GoogleCloudAiplatformV1NotebookRuntimeTemplate

A template that specifies runtime configurations such as machine type, runtime version, network configurations, etc. Multiple runtimes can be created from a runtime template.

Inheritance
object
GoogleCloudAiplatformV1NotebookRuntimeTemplate
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 GoogleCloudAiplatformV1NotebookRuntimeTemplate : 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 NotebookRuntimeTemplate was created.

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

DataPersistentDiskSpec

Optional. The specification of persistent disk attached to the runtime as data disk storage.

Declaration
[JsonProperty("dataPersistentDiskSpec")]
public virtual GoogleCloudAiplatformV1PersistentDiskSpec DataPersistentDiskSpec { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1PersistentDiskSpec

Description

The description of the NotebookRuntimeTemplate.

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

DisplayName

Required. The display name of the NotebookRuntimeTemplate. 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

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

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

EncryptionSpec

Customer-managed encryption key spec for the notebook runtime.

Declaration
[JsonProperty("encryptionSpec")]
public virtual GoogleCloudAiplatformV1EncryptionSpec EncryptionSpec { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1EncryptionSpec

EucConfig

EUC configuration of the NotebookRuntimeTemplate.

Declaration
[JsonProperty("eucConfig")]
public virtual GoogleCloudAiplatformV1NotebookEucConfig EucConfig { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1NotebookEucConfig

IdleShutdownConfig

The idle shutdown configuration of NotebookRuntimeTemplate. This config will only be set when idle shutdown is enabled.

Declaration
[JsonProperty("idleShutdownConfig")]
public virtual GoogleCloudAiplatformV1NotebookIdleShutdownConfig IdleShutdownConfig { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1NotebookIdleShutdownConfig

IsDefault

Output only. Deprecated: This field has no behavior. Use notebook_runtime_type = 'ONE_CLICK' instead. The default template to use if not specified.

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

Labels

The labels with user-defined metadata to organize the NotebookRuntimeTemplates. 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. See https://goo.gl/xmQnxf for more information and examples of labels.

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

MachineSpec

Optional. Immutable. The specification of a single machine for the template.

Declaration
[JsonProperty("machineSpec")]
public virtual GoogleCloudAiplatformV1MachineSpec MachineSpec { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1MachineSpec

Name

The resource name of the NotebookRuntimeTemplate.

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

NetworkSpec

Optional. Network spec.

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>

NotebookRuntimeType

Optional. Immutable. The type of the notebook runtime template.

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

ReservationAffinity

Optional. Reservation Affinity of the notebook runtime template.

Declaration
[JsonProperty("reservationAffinity")]
public virtual GoogleCloudAiplatformV1NotebookReservationAffinity ReservationAffinity { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1NotebookReservationAffinity

ServiceAccount

Deprecated: This field is ignored 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. For NotebookExecutionJob, use NotebookExecutionJob.service_account instead. The service account that the runtime workload runs as. 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

ShieldedVmConfig

Optional. Immutable. Runtime Shielded VM spec.

Declaration
[JsonProperty("shieldedVmConfig")]
public virtual GoogleCloudAiplatformV1ShieldedVmConfig ShieldedVmConfig { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1ShieldedVmConfig

SoftwareConfig

Optional. The notebook software configuration 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 NotebookRuntimeTemplate was most recently updated.

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

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX