REST Resource: projects.locations.notebookRuntimeTemplates

Resource: NotebookRuntimeTemplate

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

JSON representation
{
  "name": string,
  "displayName": string,
  "description": string,
  "isDefault": boolean,
  "machineSpec": {
    object (MachineSpec)
  },
  "dataPersistentDiskSpec": {
    object (PersistentDiskSpec)
  },
  "networkSpec": {
    object (NetworkSpec)
  },
  "serviceAccount": string,
  "etag": string,
  "labels": {
    string: string,
    ...
  },
  "idleShutdownConfig": {
    object (NotebookIdleShutdownConfig)
  },
  "eucConfig": {
    object (NotebookEucConfig)
  },
  "createTime": string,
  "updateTime": string,
  "notebookRuntimeType": enum (NotebookRuntimeType)
}
Fields
name

string

Output only. The resource name of the NotebookRuntimeTemplate.

displayName

string

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

description

string

The description of the NotebookRuntimeTemplate.

isDefault

boolean

Output only. The default template to use if not specified.

machineSpec

object (MachineSpec)

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

dataPersistentDiskSpec

object (PersistentDiskSpec)

Optional. The specification of [persistent disk][https://cloud.google.com/compute/docs/disks/persistent-disks] attached to the runtime as data disk storage.

networkSpec

object (NetworkSpec)

Optional. Network spec.

serviceAccount

string

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.

etag

string

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

labels

map (key: string, value: string)

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.

idleShutdownConfig

object (NotebookIdleShutdownConfig)

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

eucConfig

object (NotebookEucConfig)

EUC configuration of the NotebookRuntimeTemplate.

createTime

string (Timestamp format)

Output only. timestamp when this NotebookRuntimeTemplate was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. timestamp when this NotebookRuntimeTemplate was most recently updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

notebookRuntimeType

enum (NotebookRuntimeType)

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

PersistentDiskSpec

Represents the spec of [persistent disk][https://cloud.google.com/compute/docs/disks/persistent-disks] options.

JSON representation
{
  "diskType": string,
  "diskSizeGb": string
}
Fields
diskType

string

type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk)

diskSizeGb

string (int64 format)

size in GB of the disk (default is 100GB).

NetworkSpec

Network spec.

JSON representation
{
  "enableInternetAccess": boolean,
  "network": string,
  "subnetwork": string
}
Fields
enableInternetAccess

boolean

Whether to enable public internet access. Default false.

network

string

The full name of the Google Compute Engine network

subnetwork

string

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

NotebookIdleShutdownConfig

The idle shutdown configuration of NotebookRuntimeTemplate, which contains the idleTimeout as required field.

JSON representation
{
  "idleTimeout": string,
  "idleShutdownDisabled": boolean
}
Fields
idleTimeout

string (Duration format)

Required. Duration is accurate to the second. In Notebook, Idle Timeout is accurate to minute so the range of idleTimeout (second) is: 10 * 60 ~ 1440 * 60.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

idleShutdownDisabled

boolean

Whether Idle Shutdown is disabled in this NotebookRuntimeTemplate.

NotebookEucConfig

The euc configuration of NotebookRuntimeTemplate.

JSON representation
{
  "eucDisabled": boolean,
  "bypassActasCheck": boolean
}
Fields
eucDisabled

boolean

Input only. Whether EUC is disabled in this NotebookRuntimeTemplate. In proto3, the default value of a boolean is false. In this way, by default EUC will be enabled for NotebookRuntimeTemplate.

bypassActasCheck

boolean

Output only. Whether ActAs check is bypassed for service account attached to the VM. If false, we need ActAs check for the default Compute Engine service account. When a Runtime is created, a VM is allocated using Default Compute Engine service Account. Any user requesting to use this Runtime requires service Account user (ActAs) permission over this SA. If true, Runtime owner is using EUC and does not require the above permission as VM no longer use default Compute Engine SA, but a P4SA.

Methods

create

Creates a NotebookRuntimeTemplate.

delete

Deletes a NotebookRuntimeTemplate.

get

Gets a NotebookRuntimeTemplate.

getIamPolicy

Gets the access control policy for a resource.

list

Lists NotebookRuntimeTemplates in a Location.

setIamPolicy

Sets the access control policy on the specified resource.

testIamPermissions

Returns permissions that a caller has on the specified resource.