package google.events.cloud.notebooks.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Definition of a container image for starting a notebook instance with the environment installed in a container.

Used in: Environment, Instance, RuntimeSoftwareConfig, VirtualMachineConfig

• string repository = 1

  Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`

• string tag = 2

  The tag of the container image. If not specified, this defaults to the latest tag.

Represents a custom encryption key configuration that can be applied to a resource. This will encrypt all disks in Virtual Machine.

Used in: VirtualMachineConfig

• string kms_key = 1

  The Cloud KMS resource identifier of the customer-managed encryption key used to protect a resource, such as a disks. It has the following format: `projects/{PROJECT_ID}/locations/{REGION}/keyRings/{KEY_RING_NAME}/cryptoKeys/{KEY_NAME}`

Definition of a software environment that is used to start a notebook instance.

Used in: EnvironmentEventData

• string name = 1

  Output only. Name of this environment. Format: `projects/{project_id}/locations/{location}/environments/{environment_id}`

• string display_name = 2

  Display name of this environment for the UI.

• string description = 3

  A brief description of this environment.

• oneof image_type

  Type of the environment; can be one of VM image, or container image.

  • VmImage vm_image = 6

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

  • ContainerImage container_image = 7

    Use a container image to start the notebook instance.

• string post_startup_script = 8

  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. Example: `"gs://path-to-file/file-name"`

• optional protobuf.Timestamp create_time = 9

  Output only. The time at which this environment was created.

The CloudEvent raised when an Environment is created.

• optional EnvironmentEventData data = 1

  The data associated with the event.

The CloudEvent raised when an Environment is deleted.

• optional EnvironmentEventData data = 1

  The data associated with the event.

The data within all Environment events.

Used in: EnvironmentCreatedEvent, EnvironmentDeletedEvent

• optional Environment payload = 1

  Optional. The Environment event payload. Unset for deletion events.

The definition of a single executed notebook.

Used in: ExecutionEventData, Schedule

• optional ExecutionTemplate execution_template = 1

  execute metadata including name, hardware spec, region, labels, etc.

• string name = 2

  Output only. The resource name of the execute. Format: `projects/{project_id}/locations/{location}/executions/{execution_id}`

• string display_name = 3

  Output only. Name used for UI purposes. Name can only contain alphanumeric characters and underscores '_'.

• string description = 4

  A brief description of this execution.

• optional protobuf.Timestamp create_time = 5

  Output only. Time the Execution was instantiated.

• optional protobuf.Timestamp update_time = 6

  Output only. Time the Execution was last updated.

• Execution.State state = 7

  Output only. State of the underlying AI Platform job.

• string output_notebook_file = 8

  Output notebook file generated by this execution

• string job_uri = 9

  Output only. The URI of the external job used to execute the notebook.

Enum description of the state of the underlying AIP job.

Used in: Execution

• STATE_UNSPECIFIED = 0

  The job state is unspecified.

• QUEUED = 1

  The job has been just created and processing has not yet begun.

• PREPARING = 2

  The service is preparing to execution the job.

• RUNNING = 3

  The job is in progress.

• SUCCEEDED = 4

  The job completed successfully.

• FAILED = 5

  The job failed. `error_message` should contain the details of the failure.

• CANCELLING = 6

  The job is being cancelled. `error_message` should describe the reason for the cancellation.

• CANCELLED = 7

  The job has been cancelled. `error_message` should describe the reason for the cancellation.

• EXPIRED = 9

  The job has become expired (relevant to Vertex AI jobs) https://cloud.google.com/vertex-ai/docs/reference/rest/v1/JobState

• INITIALIZING = 10

  The Execution is being created.

The CloudEvent raised when an Execution is created.

• optional ExecutionEventData data = 1

  The data associated with the event.

The CloudEvent raised when an Execution is deleted.

• optional ExecutionEventData data = 1

  The data associated with the event.

The data within all Execution events.

Used in: ExecutionCreatedEvent, ExecutionDeletedEvent

• optional Execution payload = 1

  Optional. The Execution event payload. Unset for deletion events.

The description a notebook execution workload.

Used in: Execution, Schedule

• ExecutionTemplate.ScaleTier scale_tier = 1

  Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported.

• string master_type = 2

  Specifies the type of virtual machine to use for your training job's master worker. You must specify this field when `scaleTier` is set to `CUSTOM`. You can use certain Compute Engine machine types directly in this field. The following types are supported: - `n1-standard-4` - `n1-standard-8` - `n1-standard-16` - `n1-standard-32` - `n1-standard-64` - `n1-standard-96` - `n1-highmem-2` - `n1-highmem-4` - `n1-highmem-8` - `n1-highmem-16` - `n1-highmem-32` - `n1-highmem-64` - `n1-highmem-96` - `n1-highcpu-16` - `n1-highcpu-32` - `n1-highcpu-64` - `n1-highcpu-96` Alternatively, you can use the following legacy machine types: - `standard` - `large_model` - `complex_model_s` - `complex_model_m` - `complex_model_l` - `standard_gpu` - `complex_model_m_gpu` - `complex_model_l_gpu` - `standard_p100` - `complex_model_m_p100` - `standard_v100` - `large_model_v100` - `complex_model_m_v100` - `complex_model_l_v100` Finally, if you want to use a TPU for training, specify `cloud_tpu` in this field. Learn more about the [special configuration options for training with TPU](https://cloud.google.com/ai-platform/training/docs/using-tpus#configuring_a_custom_tpu_machine).

• optional ExecutionTemplate.SchedulerAcceleratorConfig accelerator_config = 3

  Configuration (count and accelerator type) for hardware running notebook execution.

• map<string, string> labels = 4

  Labels for execution. If execution is scheduled, a field included will be 'nbs-scheduled'. Otherwise, it is an immediate execution, and an included field will be 'nbs-immediate'. Use fields to efficiently index between various types of executions.

• string input_notebook_file = 5

  Path to the notebook file to execute. Must be in a Google Cloud Storage bucket. Format: `gs://{bucket_name}/{folder}/{notebook_file_name}` Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb`

• string container_image_uri = 6

  Container Image URI to a DLVM Example: 'gcr.io/deeplearning-platform-release/base-cu100' More examples can be found at: https://cloud.google.com/ai-platform/deep-learning-containers/docs/choosing-container

• string output_notebook_folder = 7

  Path to the notebook folder to write to. Must be in a Google Cloud Storage bucket path. Format: `gs://{bucket_name}/{folder}` Ex: `gs://notebook_user/scheduled_notebooks`

• string params_yaml_file = 8

  Parameters to be overridden in the notebook during execution. Ref https://papermill.readthedocs.io/en/latest/usage-parameterize.html on how to specifying parameters in the input notebook and pass them here in an YAML file. Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml`

• string parameters = 9

  Parameters used within the 'input_notebook_file' notebook.

• string service_account = 10

  The email address of a service account to use when running the execution. You must have the `iam.serviceAccounts.actAs` permission for the specified service account.

• ExecutionTemplate.JobType job_type = 11

  The type of Job to be used on this execution.

• oneof job_parameters

  Parameters for an execution type. NOTE: There are currently no extra parameters for VertexAI jobs.

  • ExecutionTemplate.DataprocParameters dataproc_parameters = 12

    Parameters used in Dataproc JobType executions.

  • ExecutionTemplate.VertexAIParameters vertex_ai_parameters = 13

    Parameters used in Vertex AI JobType executions.

• string kernel_spec = 14

  Name of the kernel spec to use. This must be specified if the kernel spec name on the execution target does not match the name in the input notebook file.

• string tensorboard = 15

  The name of a Vertex AI [Tensorboard] resource to which this execution will upload Tensorboard logs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`

Parameters used in Dataproc JobType executions.

Used in: ExecutionTemplate

• string cluster = 1

  URI for cluster used to run Dataproc execution. Format: `projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}`

The backend used for this execution.

Used in: ExecutionTemplate

• JOB_TYPE_UNSPECIFIED = 0

  No type specified.

• VERTEX_AI = 1

  Custom Job in `aiplatform.googleapis.com`. Default value for an execution.

• DATAPROC = 2

  Run execution on a cluster with Dataproc as a job. https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs

Required. Specifies the machine types, the number of replicas for workers and parameter servers.

Used in: ExecutionTemplate

• SCALE_TIER_UNSPECIFIED = 0

  Unspecified Scale Tier.

• BASIC = 1

  A single worker instance. This tier is suitable for learning how to use Cloud ML, and for experimenting with new models using small datasets.

• STANDARD_1 = 2

  Many workers and a few parameter servers.

• PREMIUM_1 = 3

  A large number of workers with many parameter servers.

• BASIC_GPU = 4

  A single worker instance with a K80 GPU.

• BASIC_TPU = 5

  A single worker instance with a Cloud TPU.

• CUSTOM = 6

  The CUSTOM tier is not a set tier, but rather enables you to use your own cluster specification. When you use this tier, set values to configure your processing cluster according to these guidelines: * You _must_ set `ExecutionTemplate.masterType` to specify the type of machine to use for your master node. This is the only required setting.

Definition of a hardware accelerator. Note that not all combinations of `type` and `core_count` are valid. See [GPUs on Compute Engine](https://cloud.google.com/compute/docs/gpus) to find a valid combination. TPUs are not supported.

Used in: ExecutionTemplate

• SchedulerAcceleratorType type = 1

  Type of this accelerator.

• int64 core_count = 2

  Count of cores of this accelerator.

Hardware accelerator types for AI Platform Training jobs.

Used in: SchedulerAcceleratorConfig

• SCHEDULER_ACCELERATOR_TYPE_UNSPECIFIED = 0

  Unspecified accelerator type. Default to no GPU.

• NVIDIA_TESLA_K80 = 1

  Nvidia Tesla K80 GPU.

• NVIDIA_TESLA_P100 = 2

  Nvidia Tesla P100 GPU.

• NVIDIA_TESLA_V100 = 3

  Nvidia Tesla V100 GPU.

• NVIDIA_TESLA_P4 = 4

  Nvidia Tesla P4 GPU.

• NVIDIA_TESLA_T4 = 5

  Nvidia Tesla T4 GPU.

• NVIDIA_TESLA_A100 = 10

  Nvidia Tesla A100 GPU.

• TPU_V2 = 6

  TPU v2.

• TPU_V3 = 7

  TPU v3.

Parameters used in Vertex AI JobType executions.

Used in: ExecutionTemplate

• string network = 1

  The full name of the Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where `{project}` is a project number, as in `12345`, and `{network}` is a network name. Private services access must already be configured for the network. If left unspecified, the job is not peered with any network.

• map<string, string> env = 2

  Environment variables. At most 100 environment variables can be specified and unique. Example: `GCP_BUCKET=gs://my-bucket/samples/`

The definition of a notebook instance.

Used in: InstanceEventData

• string name = 1

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

• oneof environment

  Type of the environment; can be one of VM image, or container image.

  • VmImage vm_image = 2

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

  • ContainerImage container_image = 3

    Use a container image to start the notebook instance.

• string post_startup_script = 4

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

• string proxy_uri = 5

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

• string service_account = 7

  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](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.

• repeated string service_account_scopes = 31

  Optional. The URIs of service account scopes to be included in Compute Engine instances. If not specified, the following [scopes](https://cloud.google.com/compute/docs/access/service-accounts#accesscopesiam) 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

• string machine_type = 8

  Required. The [Compute Engine machine type](https://cloud.google.com/compute/docs/machine-types) of this instance.

• optional Instance.AcceleratorConfig accelerator_config = 9

  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](https://cloud.google.com/compute/docs/gpus/#gpus-list).

• Instance.State state = 10

  Output only. The state of this instance.

• bool install_gpu_driver = 11

  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.

• string custom_gpu_driver_path = 12

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

• repeated Instance.Disk disks = 28

  Output only. Attached disks to notebook instance.

• optional Instance.ShieldedInstanceConfig shielded_instance_config = 30

  Optional. Shielded VM configuration. [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm).

• bool no_public_ip = 17

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

• bool no_proxy_access = 18

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

• string network = 19

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

• string subnet = 20

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

• map<string, string> labels = 21

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

• map<string, string> metadata = 22

  Custom metadata to apply to this instance.

• repeated string tags = 32

  Optional. The Compute Engine tags to add to runtime (see [Tagging instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).

• repeated Instance.UpgradeHistoryEntry upgrade_history = 29

  The upgrade history of this instance.

• Instance.NicType nic_type = 33

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

• optional ReservationAffinity reservation_affinity = 34

  Optional. The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this notebook instance.

• string creator = 36

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

• bool can_ip_forward = 39

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

• optional protobuf.Timestamp create_time = 23

  Output only. Instance creation time.

• optional protobuf.Timestamp update_time = 24

  Output only. Instance update time.

Definition of a hardware accelerator. Note that not all combinations of `type` and `core_count` are valid. See [GPUs on Compute Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a valid combination. TPUs are not supported.

Used in: Instance

• AcceleratorType type = 1

  Type of this accelerator.

• int64 core_count = 2

  Count of cores of this accelerator.

Definition of the types of hardware accelerators that can be used on this instance.

Used in: AcceleratorConfig

• ACCELERATOR_TYPE_UNSPECIFIED = 0

  Accelerator type is not specified.

• NVIDIA_TESLA_K80 = 1

  Accelerator type is Nvidia Tesla K80.

• NVIDIA_TESLA_P100 = 2

  Accelerator type is Nvidia Tesla P100.

• NVIDIA_TESLA_V100 = 3

  Accelerator type is Nvidia Tesla V100.

• NVIDIA_TESLA_P4 = 4

  Accelerator type is Nvidia Tesla P4.

• NVIDIA_TESLA_T4 = 5

  Accelerator type is Nvidia Tesla T4.

• NVIDIA_TESLA_A100 = 11

  Accelerator type is Nvidia Tesla A100.

• NVIDIA_TESLA_T4_VWS = 8

  Accelerator type is NVIDIA Tesla T4 Virtual Workstations.

• NVIDIA_TESLA_P100_VWS = 9

  Accelerator type is NVIDIA Tesla P100 Virtual Workstations.

• NVIDIA_TESLA_P4_VWS = 10

  Accelerator type is NVIDIA Tesla P4 Virtual Workstations.

• TPU_V2 = 6

  (Coming soon) Accelerator type is TPU V2.

• TPU_V3 = 7

  (Coming soon) Accelerator type is TPU V3.

An instance-attached disk resource.

Used in: Instance

• bool auto_delete = 1

  Indicates whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

• bool boot = 2

  Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

• string device_name = 3

  Indicates a unique device name of your choice that is reflected into the `/dev/disk/by-id/google-*` tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine.This field is only applicable for persistent disks.

• int64 disk_size_gb = 4

  Indicates the size of the disk in base-2 GB.

• repeated Disk.GuestOsFeature guest_os_features = 5

  Indicates a list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

• int64 index = 6

  A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.

• string interface = 7

  Indicates the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. Valid values: * `NVME` * `SCSI`

• string kind = 8

  Type of the resource. Always compute#attachedDisk for attached disks.

• repeated string licenses = 9

  A list of publicly visible licenses. Reserved for Google's use. A License represents billing and aggregate usage data for public and marketplace images.

• string mode = 10

  The mode in which to attach this disk, either `READ_WRITE` or `READ_ONLY`. If not specified, the default is to attach the disk in `READ_WRITE` mode. Valid values: * `READ_ONLY` * `READ_WRITE`

• string source = 11

  Indicates a valid partial or full URL to an existing Persistent Disk resource.

• string type = 12

  Indicates the type of the disk, either `SCRATCH` or `PERSISTENT`. Valid values: * `PERSISTENT` * `SCRATCH`

Guest OS features for boot disk.

Used in: Disk

• string type = 1

  The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. Valid values: * `FEATURE_TYPE_UNSPECIFIED` * `MULTI_IP_SUBNET` * `SECURE_BOOT` * `UEFI_COMPATIBLE` * `VIRTIO_SCSI_MULTIQUEUE` * `WINDOWS`

Definition of the disk encryption options.

• DISK_ENCRYPTION_UNSPECIFIED = 0

  Disk encryption is not specified.

• GMEK = 1

  Use Google managed encryption keys to encrypt the boot disk.

• CMEK = 2

  Use customer managed encryption keys to encrypt the boot disk.

Possible disk types for notebook instances.

• DISK_TYPE_UNSPECIFIED = 0

  Disk type not set.

• PD_STANDARD = 1

  Standard persistent disk type.

• PD_SSD = 2

  SSD persistent disk type.

• PD_BALANCED = 3

  Balanced persistent disk type.

• PD_EXTREME = 4

  Extreme persistent disk type.

The type of vNIC driver. Default should be UNSPECIFIED_NIC_TYPE.

Used in: Instance

• UNSPECIFIED_NIC_TYPE = 0

  No type specified.

• VIRTIO_NET = 1

  VIRTIO

• GVNIC = 2

  GVNIC

A set of Shielded Instance options. See [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). Not all combinations are valid.

Used in: Instance

• bool enable_secure_boot = 1

  Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. Disabled by default.

• bool enable_vtpm = 2

  Defines whether the instance has the vTPM enabled. Enabled by default.

• bool enable_integrity_monitoring = 3

  Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. Enabled by default.

The definition of the states of this instance.

Used in: Instance

• STATE_UNSPECIFIED = 0

  State is not specified.

• STARTING = 1

  The control logic is starting the instance.

• PROVISIONING = 2

  The control logic is installing required frameworks and registering the instance with notebook proxy

• ACTIVE = 3

  The instance is running.

• STOPPING = 4

  The control logic is stopping the instance.

• STOPPED = 5

  The instance is stopped.

• DELETED = 6

  The instance is deleted.

• UPGRADING = 7

  The instance is upgrading.

• INITIALIZING = 8

  The instance is being created.

• REGISTERING = 9

  The instance is getting registered.

• SUSPENDING = 10

  The instance is suspending.

• SUSPENDED = 11

  The instance is suspended.

The entry of VM image upgrade history.

Used in: Instance

• string snapshot = 1

  The snapshot of the boot disk of this notebook instance before upgrade.

• string vm_image = 2

  The VM image before this instance upgrade.

• string container_image = 3

  The container image before this instance upgrade.

• string framework = 4

  The framework of this notebook instance.

• string version = 5

  The version of the notebook instance before this upgrade.

• UpgradeHistoryEntry.State state = 6

  The state of this instance upgrade history entry.

• optional protobuf.Timestamp create_time = 7

  The time that this instance upgrade history entry is created.

• string target_image = 8

  Target VM Image. Format: `ainotebooks-vm/project/image-name/name`.

• UpgradeHistoryEntry.Action action = 9

  Action. Rolloback or Upgrade.

• string target_version = 10

  Target VM Version, like m63.

The definition of operations of this upgrade history entry.

Used in: UpgradeHistoryEntry

• ACTION_UNSPECIFIED = 0

  Operation is not specified.

• UPGRADE = 1

  Upgrade.

• ROLLBACK = 2

  Rollback.

The definition of the states of this upgrade history entry.

Used in: UpgradeHistoryEntry

• STATE_UNSPECIFIED = 0

  State is not specified.

• STARTED = 1

  The instance upgrade is started.

• SUCCEEDED = 2

  The instance upgrade is succeeded.

• FAILED = 3

  The instance upgrade is failed.

The CloudEvent raised when an Instance is created.

• optional InstanceEventData data = 1

  The data associated with the event.

The CloudEvent raised when an Instance is deleted.

• optional InstanceEventData data = 1

  The data associated with the event.

The data within all Instance events.

Used in: InstanceCreatedEvent, InstanceDeletedEvent

• optional Instance payload = 1

  Optional. The Instance event payload. Unset for deletion events.

A Local attached disk resource.

Used in: VirtualMachineConfig

• bool auto_delete = 1

  Optional. Output only. Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

• bool boot = 2

  Optional. Output only. Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

• string device_name = 3

  Optional. Output only. Specifies a unique device name of your choice that is reflected into the `/dev/disk/by-id/google-*` tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.

• repeated LocalDisk.RuntimeGuestOsFeature guest_os_features = 4

  Output only. Indicates a list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

• int32 index = 5

  Output only. A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.

• string interface = 7

  Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. Valid values: * `NVME` * `SCSI`

• string kind = 8

  Output only. Type of the resource. Always compute#attachedDisk for attached disks.

• repeated string licenses = 9

  Output only. Any valid publicly visible licenses.

• string mode = 10

  The mode in which to attach this disk, either `READ_WRITE` or `READ_ONLY`. If not specified, the default is to attach the disk in `READ_WRITE` mode. Valid values: * `READ_ONLY` * `READ_WRITE`

• string source = 11

  Specifies a valid partial or full URL to an existing Persistent Disk resource.

• string type = 12

  Specifies the type of the disk, either `SCRATCH` or `PERSISTENT`. If not specified, the default is `PERSISTENT`. Valid values: * `PERSISTENT` * `SCRATCH`

Optional. A list of features to enable on the guest operating system. Applicable only for bootable images. Read [Enabling guest operating system features](https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features) to see a list of available options. Guest OS features for boot disk.

Used in: LocalDisk

• string type = 1

  The ID of a supported feature. Read [Enabling guest operating system features](https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features) to see a list of available options. Valid values: * `FEATURE_TYPE_UNSPECIFIED` * `MULTI_IP_SUBNET` * `SECURE_BOOT` * `UEFI_COMPATIBLE` * `VIRTIO_SCSI_MULTIQUEUE` * `WINDOWS`

Input only. Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new runtime. This property is mutually exclusive with the source property; you can only define one or the other, but not both.

• string description = 1

  Optional. Provide this property when creating the disk.

• string disk_name = 2

  Optional. Specifies the disk name. If not specified, the default is to use the name of the instance. If the disk with the instance name exists already in the given zone/region, a new name will be automatically generated.

• int64 disk_size_gb = 3

  Optional. Specifies the size of the disk in base-2 GB. If not specified, the disk will be the same size as the image (usually 10GB). If specified, the size must be equal to or larger than 10GB. Default 100 GB.

• map<string, string> labels = 5

  Optional. Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.

Possible disk types.

• DISK_TYPE_UNSPECIFIED = 0

  Disk type not set.

• PD_STANDARD = 1

  Standard persistent disk type.

• PD_SSD = 2

  SSD persistent disk type.

• PD_BALANCED = 3

  Balanced persistent disk type.

• PD_EXTREME = 4

  Extreme persistent disk type.

Reservation Affinity for consuming Zonal reservation.

Used in: Instance

• ReservationAffinity.Type consume_reservation_type = 1

  Optional. Type of reservation to consume

• string key = 2

  Optional. Corresponds to the label key of reservation resource.

• repeated string values = 3

  Optional. Corresponds to the label values of reservation resource.

Indicates whether to consume capacity from an reservation or not.

Used in: ReservationAffinity

• TYPE_UNSPECIFIED = 0

  Default type.

• NO_RESERVATION = 1

  Do not consume from any allocated capacity.

• ANY_RESERVATION = 2

  Consume any reservation available.

• SPECIFIC_RESERVATION = 3

  Must consume from a specific reservation. Must specify key value fields for specifying the reservations.

The definition of a Runtime for a managed notebook instance.

Used in: RuntimeEventData

• string name = 1

  Output only. The resource name of the runtime. Format: `projects/{project}/locations/{location}/runtimes/{runtimeId}`

• oneof runtime_type

  Type of the runtime; currently only supports Compute Engine VM.

  • VirtualMachine virtual_machine = 2

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

• Runtime.State state = 3

  Output only. Runtime state.

• Runtime.HealthState health_state = 4

  Output only. Runtime health_state.

• optional RuntimeAccessConfig access_config = 5

  The config settings for accessing runtime.

• optional RuntimeSoftwareConfig software_config = 6

  The config settings for software inside the runtime.

• optional RuntimeMetrics metrics = 7

  Output only. Contains Runtime daemon metrics such as Service status and JupyterLab stats.

• optional protobuf.Timestamp create_time = 20

  Output only. Runtime creation time.

• optional protobuf.Timestamp update_time = 21

  Output only. Runtime update time.

• map<string, string> labels = 23

  Optional. The labels to associate with this Managed Notebook or Runtime. Label **keys** must contain 1 to 63 characters, and must conform to [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt). Label **values** may be empty, but, if present, must contain 1 to 63 characters, and must conform to [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a cluster.

The runtime substate.

Used in: Runtime

• HEALTH_STATE_UNSPECIFIED = 0

  The runtime substate is unknown.

• HEALTHY = 1

  The runtime is known to be in an healthy state (for example, critical daemons are running) Applies to ACTIVE state.

• UNHEALTHY = 2

  The runtime is known to be in an unhealthy state (for example, critical daemons are not running) Applies to ACTIVE state.

• AGENT_NOT_INSTALLED = 3

  The runtime has not installed health monitoring agent. Applies to ACTIVE state.

• AGENT_NOT_RUNNING = 4

  The runtime health monitoring agent is not running. Applies to ACTIVE state.

The definition of the states of this runtime.

Used in: Runtime

• STATE_UNSPECIFIED = 0

  State is not specified.

• STARTING = 1

  The compute layer is starting the runtime. It is not ready for use.

• PROVISIONING = 2

  The compute layer is installing required frameworks and registering the runtime with notebook proxy. It cannot be used.

• ACTIVE = 3

  The runtime is currently running. It is ready for use.

• STOPPING = 4

  The control logic is stopping the runtime. It cannot be used.

• STOPPED = 5

  The runtime is stopped. It cannot be used.

• DELETING = 6

  The runtime is being deleted. It cannot be used.

• UPGRADING = 7

  The runtime is upgrading. It cannot be used.

• INITIALIZING = 8

  The runtime is being created and set up. It is not ready for use.

Definition of the types of hardware accelerators that can be used. Definition of the types of hardware accelerators that can be used. See [Compute Engine AcceleratorTypes](https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes). Examples: * `nvidia-tesla-k80` * `nvidia-tesla-p100` * `nvidia-tesla-v100` * `nvidia-tesla-p4` * `nvidia-tesla-t4` * `nvidia-tesla-a100`

Used in: VirtualMachineConfig

• RuntimeAcceleratorConfig.AcceleratorType type = 1

  Accelerator model.

• int64 core_count = 2

  Count of cores of this accelerator.

Type of this accelerator.

Used in: RuntimeAcceleratorConfig

• ACCELERATOR_TYPE_UNSPECIFIED = 0

  Accelerator type is not specified.

• NVIDIA_TESLA_K80 = 1

  Accelerator type is Nvidia Tesla K80.

• NVIDIA_TESLA_P100 = 2

  Accelerator type is Nvidia Tesla P100.

• NVIDIA_TESLA_V100 = 3

  Accelerator type is Nvidia Tesla V100.

• NVIDIA_TESLA_P4 = 4

  Accelerator type is Nvidia Tesla P4.

• NVIDIA_TESLA_T4 = 5

  Accelerator type is Nvidia Tesla T4.

• NVIDIA_TESLA_A100 = 6

  Accelerator type is Nvidia Tesla A100 - 40GB.

• TPU_V2 = 7

  (Coming soon) Accelerator type is TPU V2.

• TPU_V3 = 8

  (Coming soon) Accelerator type is TPU V3.

• NVIDIA_TESLA_T4_VWS = 9

  Accelerator type is NVIDIA Tesla T4 Virtual Workstations.

• NVIDIA_TESLA_P100_VWS = 10

  Accelerator type is NVIDIA Tesla P100 Virtual Workstations.

• NVIDIA_TESLA_P4_VWS = 11

  Accelerator type is NVIDIA Tesla P4 Virtual Workstations.

Specifies the login configuration for Runtime

Used in: Runtime

• RuntimeAccessConfig.RuntimeAccessType access_type = 1

  The type of access mode this instance.

• string runtime_owner = 2

  The owner of this runtime after creation. Format: `alias@example.com` Currently supports one owner only.

• string proxy_uri = 3

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

Possible ways to access runtime. Authentication mode. Currently supports: Single User only.

Used in: RuntimeAccessConfig

• RUNTIME_ACCESS_TYPE_UNSPECIFIED = 0

  Unspecified access.

• SINGLE_USER = 1

  Single user login.

• SERVICE_ACCOUNT = 2

  Service Account mode. In Service Account mode, Runtime creator will specify a SA that exists in the consumer project. Using Runtime Service Account field. Users accessing the Runtime need ActAs (Service Account User) permission.

The CloudEvent raised when a Runtime is created.

• optional RuntimeEventData data = 1

  The data associated with the event.

The CloudEvent raised when a Runtime is deleted.

• optional RuntimeEventData data = 1

  The data associated with the event.

The data within all Runtime events.

Used in: RuntimeCreatedEvent, RuntimeDeletedEvent, RuntimeUpdatedEvent

• optional Runtime payload = 1

  Optional. The Runtime event payload. Unset for deletion events.

Contains runtime daemon metrics, such as OS and kernels and sessions stats.

Used in: Runtime

• map<string, string> system_metrics = 1

  Output only. The system metrics.

A set of Shielded Instance options. See [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). Not all combinations are valid.

Used in: VirtualMachineConfig

• bool enable_secure_boot = 1

  Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. Disabled by default.

• bool enable_vtpm = 2

  Defines whether the instance has the vTPM enabled. Enabled by default.

• bool enable_integrity_monitoring = 3

  Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. Enabled by default.

Specifies the selection and configuration of software inside the runtime. The properties to set on runtime. Properties keys are specified in `key:value` format, for example: * `idle_shutdown: true` * `idle_shutdown_timeout: 180` * `enable_health_monitoring: true`

Used in: Runtime

• string notebook_upgrade_schedule = 1

  Cron expression in UTC timezone, used to schedule instance auto upgrade. Please follow the [cron format](https://en.wikipedia.org/wiki/Cron).

• optional bool enable_health_monitoring = 2

  Verifies core internal services are running. Default: True

• optional bool idle_shutdown = 3

  Runtime will automatically shutdown after idle_shutdown_time. Default: True

• int32 idle_shutdown_timeout = 4

  Time in minutes to wait before shutting down runtime. Default: 180 minutes

• bool install_gpu_driver = 5

  Install Nvidia Driver automatically. Default: True

• string custom_gpu_driver_path = 6

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

• string post_startup_script = 7

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

• repeated ContainerImage kernels = 8

  Optional. Use a list of container images to use as Kernels in the notebook instance.

• optional bool upgradeable = 9

  Output only. Bool indicating whether an newer image is available in an image family.

• RuntimeSoftwareConfig.PostStartupScriptBehavior post_startup_script_behavior = 10

  Behavior for the post startup script.

• optional bool disable_terminal = 11

  Bool indicating whether JupyterLab terminal will be available or not. Default: False

• optional string version = 12

  Output only. version of boot image such as M100, from release label of the image.

• optional bool mixer_disabled = 13

  Bool indicating whether mixer client should be disabled. Default: False

Behavior for the post startup script.

Used in: RuntimeSoftwareConfig

• POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED = 0

  Unspecified post startup script behavior. Will run only once at creation.

• RUN_EVERY_START = 1

  Runs the post startup script provided during creation at every start.

• DOWNLOAD_AND_RUN_EVERY_START = 2

  Downloads and runs the provided post startup script at every start.

The CloudEvent raised when a Runtime is updated.

• optional RuntimeEventData data = 1

  The data associated with the event.

The definition of a schedule.

Used in: ScheduleEventData

• string name = 1

  Output only. The name of this schedule. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`

• string display_name = 2

  Output only. Display name used for UI purposes. Name can only contain alphanumeric characters, hyphens `-`, and underscores `_`.

• string description = 3

  A brief description of this environment.

• Schedule.State state = 4

• string cron_schedule = 5

  Cron-tab formatted schedule by which the job will execute. Format: minute, hour, day of month, month, day of week, e.g. `0 0 * * WED` = every Wednesday More examples: https://crontab.guru/examples.html

• string time_zone = 6

  Timezone on which the cron_schedule. The value of this field must be a time zone name from the tz database. TZ Database: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string "utc". If a time zone is not specified, the default will be in UTC (also known as GMT).

• optional protobuf.Timestamp create_time = 7

  Output only. Time the schedule was created.

• optional protobuf.Timestamp update_time = 8

  Output only. Time the schedule was last updated.

• optional ExecutionTemplate execution_template = 9

  Notebook Execution Template corresponding to this schedule.

• repeated Execution recent_executions = 10

  Output only. The most recent execution names triggered from this schedule and their corresponding states.

State of the job.

Used in: Schedule

• STATE_UNSPECIFIED = 0

  Unspecified state.

• ENABLED = 1

  The job is executing normally.

• PAUSED = 2

  The job is paused by the user. It will not execute. A user can intentionally pause the job using [PauseJobRequest][].

• DISABLED = 3

  The job is disabled by the system due to error. The user cannot directly set a job to be disabled.

• UPDATE_FAILED = 4

  The job state resulting from a failed [CloudScheduler.UpdateJob][] operation. To recover a job from this state, retry [CloudScheduler.UpdateJob][] until a successful response is received.

• INITIALIZING = 5

  The schedule resource is being created.

• DELETING = 6

  The schedule resource is being deleted.

The CloudEvent raised when a Schedule is created.

• optional ScheduleEventData data = 1

  The data associated with the event.

The CloudEvent raised when a Schedule is deleted.

• optional ScheduleEventData data = 1

  The data associated with the event.

The data within all Schedule events.

Used in: ScheduleCreatedEvent, ScheduleDeletedEvent

• optional Schedule payload = 1

  Optional. The Schedule event payload. Unset for deletion events.

Runtime using Virtual Machine for computing.

Used in: Runtime

• string instance_name = 1

  Output only. The user-friendly name of the Managed Compute Engine instance.

• string instance_id = 2

  Output only. The unique identifier of the Managed Compute Engine instance.

• optional VirtualMachineConfig virtual_machine_config = 3

  Virtual Machine configuration settings.

The config settings for virtual machine.

Used in: VirtualMachine

• string zone = 1

  Output only. The zone where the virtual machine is located. If using regional request, the notebooks service will pick a location in the corresponding runtime region. On a get request, zone will always be present. Example: * `us-central1-b`

• string machine_type = 2

  Required. The Compute Engine machine type used for runtimes. Short name is valid. Examples: * `n1-standard-2` * `e2-standard-8`

• repeated ContainerImage container_images = 3

  Optional. Use a list of container images to use as Kernels in the notebook instance.

• optional LocalDisk data_disk = 4

  Required. Data disk option configuration settings.

• optional EncryptionConfig encryption_config = 5

  Optional. Encryption settings for virtual machine data disk.

• optional RuntimeShieldedInstanceConfig shielded_instance_config = 6

  Optional. Shielded VM Instance configuration settings.

• optional RuntimeAcceleratorConfig accelerator_config = 7

  Optional. The Compute Engine accelerator configuration for this runtime.

• string network = 8

  Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork. If neither `network` nor `subnet` is specified, the "default" network of the project is used, if it exists. A full URL or partial URI. Examples: * `https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default` * `projects/[project_id]/global/networks/default` Runtimes are managed resources inside Google Infrastructure. Runtimes support the following network configurations: * Google Managed Network (Network & subnet are empty) * Consumer Project VPC (network & subnet are required). Requires configuring Private Service Access. * Shared VPC (network & subnet are required). Requires configuring Private Service Access.

• string subnet = 9

  Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network. A full URL or partial URI are valid. Examples: * `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0` * `projects/[project_id]/regions/us-east1/subnetworks/sub0`

• bool internal_ip_only = 10

  Optional. If true, runtime will only have internal IP addresses. By default, runtimes are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each vm. This `internal_ip_only` restriction can only be enabled for subnetwork enabled networks, and all dependencies must be configured to be accessible without external IP addresses.

• repeated string tags = 13

  Optional. The Compute Engine tags to add to runtime (see [Tagging instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).

• map<string, string> guest_attributes = 14

  Output only. The Compute Engine guest attributes. (see [Project and instance guest attributes](https://cloud.google.com/compute/docs/storing-retrieving-metadata#guest_attributes)).

• map<string, string> metadata = 15

  Optional. The Compute Engine metadata entries to add to virtual machine. (see [Project and instance metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).

• map<string, string> labels = 16

  Optional. The labels to associate with this runtime. Label **keys** must contain 1 to 63 characters, and must conform to [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt). Label **values** may be empty, but, if present, must contain 1 to 63 characters, and must conform to [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a cluster.

• VirtualMachineConfig.NicType nic_type = 17

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

• string reserved_ip_range = 18

  Optional. Reserved IP Range name is used for VPC Peering. The subnetwork allocation will use the range *name* if it's assigned. Example: managed-notebooks-range-c PEERING_RANGE_NAME_3=managed-notebooks-range-c gcloud compute addresses create $PEERING_RANGE_NAME_3 \ --global \ --prefix-length=24 \ --description="Google Cloud Managed Notebooks Range 24 c" \ --network=$NETWORK \ --addresses=192.168.0.0 \ --purpose=VPC_PEERING Field value will be: `managed-notebooks-range-c`

• optional VirtualMachineConfig.BootImage boot_image = 19

  Optional. Boot image metadata used for runtime upgradeability.

Definition of the boot image used by the Runtime. Used to facilitate runtime upgradeability.

Used in: VirtualMachineConfig

(message has no fields)

The type of vNIC driver. Default should be UNSPECIFIED_NIC_TYPE.

Used in: VirtualMachineConfig

• UNSPECIFIED_NIC_TYPE = 0

  No type specified.

• VIRTIO_NET = 1

  VIRTIO

• GVNIC = 2

  GVNIC

Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM.

Used in: Environment, Instance

• string project = 1

  Required. The name of the Google Cloud project that this VM image belongs to. Format: `{project_id}`

• oneof image

  The reference to an external Compute Engine VM image.

  • string image_name = 2

    Use VM image name to find the image.

  • string image_family = 3

    Use this VM image family to find the image; the newest image in this family will be used.