Classes
ContainerImage
Definition of a container image for starting a notebook instance with the environment installed in a container.
Protobuf type google.events.cloud.notebooks.v1.ContainerImage
ContainerImage.Builder
Definition of a container image for starting a notebook instance with the environment installed in a container.
Protobuf type google.events.cloud.notebooks.v1.ContainerImage
Data
EncryptionConfig
Represents a custom encryption key configuration that can be applied to a resource. This will encrypt all disks in Virtual Machine.
Protobuf type google.events.cloud.notebooks.v1.EncryptionConfig
EncryptionConfig.Builder
Represents a custom encryption key configuration that can be applied to a resource. This will encrypt all disks in Virtual Machine.
Protobuf type google.events.cloud.notebooks.v1.EncryptionConfig
Environment
Definition of a software environment that is used to start a notebook instance.
Protobuf type google.events.cloud.notebooks.v1.Environment
Environment.Builder
Definition of a software environment that is used to start a notebook instance.
Protobuf type google.events.cloud.notebooks.v1.Environment
EnvironmentEventData
The data within all Environment events.
Protobuf type google.events.cloud.notebooks.v1.EnvironmentEventData
EnvironmentEventData.Builder
The data within all Environment events.
Protobuf type google.events.cloud.notebooks.v1.EnvironmentEventData
Execution
The definition of a single executed notebook.
Protobuf type google.events.cloud.notebooks.v1.Execution
Execution.Builder
The definition of a single executed notebook.
Protobuf type google.events.cloud.notebooks.v1.Execution
ExecutionEventData
The data within all Execution events.
Protobuf type google.events.cloud.notebooks.v1.ExecutionEventData
ExecutionEventData.Builder
The data within all Execution events.
Protobuf type google.events.cloud.notebooks.v1.ExecutionEventData
ExecutionTemplate
The description a notebook execution workload.
Protobuf type google.events.cloud.notebooks.v1.ExecutionTemplate
ExecutionTemplate.Builder
The description a notebook execution workload.
Protobuf type google.events.cloud.notebooks.v1.ExecutionTemplate
ExecutionTemplate.DataprocParameters
Parameters used in Dataproc JobType executions.
Protobuf type google.events.cloud.notebooks.v1.ExecutionTemplate.DataprocParameters
ExecutionTemplate.DataprocParameters.Builder
Parameters used in Dataproc JobType executions.
Protobuf type google.events.cloud.notebooks.v1.ExecutionTemplate.DataprocParameters
ExecutionTemplate.SchedulerAcceleratorConfig
Definition of a hardware accelerator. Note that not all combinations
of type and core_count are valid. See GPUs on
Compute Engine to find a valid
combination. TPUs are not supported.
Protobuf type
google.events.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorConfig
ExecutionTemplate.SchedulerAcceleratorConfig.Builder
Definition of a hardware accelerator. Note that not all combinations
of type and core_count are valid. See GPUs on
Compute Engine to find a valid
combination. TPUs are not supported.
Protobuf type
google.events.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorConfig
ExecutionTemplate.VertexAIParameters
Parameters used in Vertex AI JobType executions.
Protobuf type google.events.cloud.notebooks.v1.ExecutionTemplate.VertexAIParameters
ExecutionTemplate.VertexAIParameters.Builder
Parameters used in Vertex AI JobType executions.
Protobuf type google.events.cloud.notebooks.v1.ExecutionTemplate.VertexAIParameters
Instance
The definition of a notebook instance.
Protobuf type google.events.cloud.notebooks.v1.Instance
Instance.AcceleratorConfig
Definition of a hardware accelerator. Note that not all combinations
of type and core_count are valid. See GPUs on Compute
Engine to find a
valid combination. TPUs are not supported.
Protobuf type google.events.cloud.notebooks.v1.Instance.AcceleratorConfig
Instance.AcceleratorConfig.Builder
Definition of a hardware accelerator. Note that not all combinations
of type and core_count are valid. See GPUs on Compute
Engine to find a
valid combination. TPUs are not supported.
Protobuf type google.events.cloud.notebooks.v1.Instance.AcceleratorConfig
Instance.Builder
The definition of a notebook instance.
Protobuf type google.events.cloud.notebooks.v1.Instance
Instance.Disk
An instance-attached disk resource.
Protobuf type google.events.cloud.notebooks.v1.Instance.Disk
Instance.Disk.Builder
An instance-attached disk resource.
Protobuf type google.events.cloud.notebooks.v1.Instance.Disk
Instance.Disk.GuestOsFeature
Guest OS features for boot disk.
Protobuf type google.events.cloud.notebooks.v1.Instance.Disk.GuestOsFeature
Instance.Disk.GuestOsFeature.Builder
Guest OS features for boot disk.
Protobuf type google.events.cloud.notebooks.v1.Instance.Disk.GuestOsFeature
Instance.ShieldedInstanceConfig
A set of Shielded Instance options. See Images using supported Shielded VM features. Not all combinations are valid.
Protobuf type google.events.cloud.notebooks.v1.Instance.ShieldedInstanceConfig
Instance.ShieldedInstanceConfig.Builder
A set of Shielded Instance options. See Images using supported Shielded VM features. Not all combinations are valid.
Protobuf type google.events.cloud.notebooks.v1.Instance.ShieldedInstanceConfig
Instance.UpgradeHistoryEntry
The entry of VM image upgrade history.
Protobuf type google.events.cloud.notebooks.v1.Instance.UpgradeHistoryEntry
Instance.UpgradeHistoryEntry.Builder
The entry of VM image upgrade history.
Protobuf type google.events.cloud.notebooks.v1.Instance.UpgradeHistoryEntry
InstanceEventData
The data within all Instance events.
Protobuf type google.events.cloud.notebooks.v1.InstanceEventData
InstanceEventData.Builder
The data within all Instance events.
Protobuf type google.events.cloud.notebooks.v1.InstanceEventData
LocalDisk
A Local attached disk resource.
Protobuf type google.events.cloud.notebooks.v1.LocalDisk
LocalDisk.Builder
A Local attached disk resource.
Protobuf type google.events.cloud.notebooks.v1.LocalDisk
LocalDisk.RuntimeGuestOsFeature
Optional. 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. Guest OS features for boot disk.
Protobuf type google.events.cloud.notebooks.v1.LocalDisk.RuntimeGuestOsFeature
LocalDisk.RuntimeGuestOsFeature.Builder
Optional. 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. Guest OS features for boot disk.
Protobuf type google.events.cloud.notebooks.v1.LocalDisk.RuntimeGuestOsFeature
LocalDiskInitializeParams
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.
Protobuf type google.events.cloud.notebooks.v1.LocalDiskInitializeParams
LocalDiskInitializeParams.Builder
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.
Protobuf type google.events.cloud.notebooks.v1.LocalDiskInitializeParams
ReservationAffinity
Reservation Affinity for consuming Zonal reservation.
Protobuf type google.events.cloud.notebooks.v1.ReservationAffinity
ReservationAffinity.Builder
Reservation Affinity for consuming Zonal reservation.
Protobuf type google.events.cloud.notebooks.v1.ReservationAffinity
Runtime
The definition of a Runtime for a managed notebook instance.
Protobuf type google.events.cloud.notebooks.v1.Runtime
Runtime.Builder
The definition of a Runtime for a managed notebook instance.
Protobuf type google.events.cloud.notebooks.v1.Runtime
RuntimeAcceleratorConfig
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. Examples:
nvidia-tesla-k80nvidia-tesla-p100nvidia-tesla-v100nvidia-tesla-p4nvidia-tesla-t4nvidia-tesla-a100
Protobuf type google.events.cloud.notebooks.v1.RuntimeAcceleratorConfig
RuntimeAcceleratorConfig.Builder
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. Examples:
nvidia-tesla-k80nvidia-tesla-p100nvidia-tesla-v100nvidia-tesla-p4nvidia-tesla-t4nvidia-tesla-a100
Protobuf type google.events.cloud.notebooks.v1.RuntimeAcceleratorConfig
RuntimeAccessConfig
Specifies the login configuration for Runtime
Protobuf type google.events.cloud.notebooks.v1.RuntimeAccessConfig
RuntimeAccessConfig.Builder
Specifies the login configuration for Runtime
Protobuf type google.events.cloud.notebooks.v1.RuntimeAccessConfig
RuntimeEventData
The data within all Runtime events.
Protobuf type google.events.cloud.notebooks.v1.RuntimeEventData
RuntimeEventData.Builder
The data within all Runtime events.
Protobuf type google.events.cloud.notebooks.v1.RuntimeEventData
RuntimeMetrics
Contains runtime daemon metrics, such as OS and kernels and sessions stats.
Protobuf type google.events.cloud.notebooks.v1.RuntimeMetrics
RuntimeMetrics.Builder
Contains runtime daemon metrics, such as OS and kernels and sessions stats.
Protobuf type google.events.cloud.notebooks.v1.RuntimeMetrics
RuntimeShieldedInstanceConfig
A set of Shielded Instance options. See Images using supported Shielded VM features. Not all combinations are valid.
Protobuf type google.events.cloud.notebooks.v1.RuntimeShieldedInstanceConfig
RuntimeShieldedInstanceConfig.Builder
A set of Shielded Instance options. See Images using supported Shielded VM features. Not all combinations are valid.
Protobuf type google.events.cloud.notebooks.v1.RuntimeShieldedInstanceConfig
RuntimeSoftwareConfig
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: trueidle_shutdown_timeout: 180enable_health_monitoring: true
Protobuf type google.events.cloud.notebooks.v1.RuntimeSoftwareConfig
RuntimeSoftwareConfig.Builder
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: trueidle_shutdown_timeout: 180enable_health_monitoring: true
Protobuf type google.events.cloud.notebooks.v1.RuntimeSoftwareConfig
Schedule
The definition of a schedule.
Protobuf type google.events.cloud.notebooks.v1.Schedule
Schedule.Builder
The definition of a schedule.
Protobuf type google.events.cloud.notebooks.v1.Schedule
ScheduleEventData
The data within all Schedule events.
Protobuf type google.events.cloud.notebooks.v1.ScheduleEventData
ScheduleEventData.Builder
The data within all Schedule events.
Protobuf type google.events.cloud.notebooks.v1.ScheduleEventData
VirtualMachine
Runtime using Virtual Machine for computing.
Protobuf type google.events.cloud.notebooks.v1.VirtualMachine
VirtualMachine.Builder
Runtime using Virtual Machine for computing.
Protobuf type google.events.cloud.notebooks.v1.VirtualMachine
VirtualMachineConfig
The config settings for virtual machine.
Protobuf type google.events.cloud.notebooks.v1.VirtualMachineConfig
VirtualMachineConfig.BootImage
Definition of the boot image used by the Runtime. Used to facilitate runtime upgradeability.
Protobuf type google.events.cloud.notebooks.v1.VirtualMachineConfig.BootImage
VirtualMachineConfig.BootImage.Builder
Definition of the boot image used by the Runtime. Used to facilitate runtime upgradeability.
Protobuf type google.events.cloud.notebooks.v1.VirtualMachineConfig.BootImage
VirtualMachineConfig.Builder
The config settings for virtual machine.
Protobuf type google.events.cloud.notebooks.v1.VirtualMachineConfig
VmImage
Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM.
Protobuf type google.events.cloud.notebooks.v1.VmImage
VmImage.Builder
Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM.
Protobuf type google.events.cloud.notebooks.v1.VmImage
Interfaces
ContainerImageOrBuilder
EncryptionConfigOrBuilder
EnvironmentEventDataOrBuilder
EnvironmentOrBuilder
ExecutionEventDataOrBuilder
ExecutionOrBuilder
ExecutionTemplate.DataprocParametersOrBuilder
ExecutionTemplate.SchedulerAcceleratorConfigOrBuilder
ExecutionTemplate.VertexAIParametersOrBuilder
ExecutionTemplateOrBuilder
Instance.AcceleratorConfigOrBuilder
Instance.Disk.GuestOsFeatureOrBuilder
Instance.DiskOrBuilder
Instance.ShieldedInstanceConfigOrBuilder
Instance.UpgradeHistoryEntryOrBuilder
InstanceEventDataOrBuilder
InstanceOrBuilder
LocalDisk.RuntimeGuestOsFeatureOrBuilder
LocalDiskInitializeParamsOrBuilder
LocalDiskOrBuilder
ReservationAffinityOrBuilder
RuntimeAcceleratorConfigOrBuilder
RuntimeAccessConfigOrBuilder
RuntimeEventDataOrBuilder
RuntimeMetricsOrBuilder
RuntimeOrBuilder
RuntimeShieldedInstanceConfigOrBuilder
RuntimeSoftwareConfigOrBuilder
ScheduleEventDataOrBuilder
ScheduleOrBuilder
VirtualMachineConfig.BootImageOrBuilder
VirtualMachineConfigOrBuilder
VirtualMachineOrBuilder
VmImageOrBuilder
Enums
Environment.ImageTypeCase
Execution.State
Enum description of the state of the underlying AIP job.
Protobuf enum google.events.cloud.notebooks.v1.Execution.State
ExecutionTemplate.JobParametersCase
ExecutionTemplate.JobType
The backend used for this execution.
Protobuf enum google.events.cloud.notebooks.v1.ExecutionTemplate.JobType
ExecutionTemplate.ScaleTier
Required. Specifies the machine types, the number of replicas for workers and parameter servers.
Protobuf enum google.events.cloud.notebooks.v1.ExecutionTemplate.ScaleTier
ExecutionTemplate.SchedulerAcceleratorType
Hardware accelerator types for AI Platform Training jobs.
Protobuf enum
google.events.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorType
Instance.AcceleratorType
Definition of the types of hardware accelerators that can be used on this instance.
Protobuf enum google.events.cloud.notebooks.v1.Instance.AcceleratorType
Instance.DiskEncryption
Definition of the disk encryption options.
Protobuf enum google.events.cloud.notebooks.v1.Instance.DiskEncryption
Instance.DiskType
Possible disk types for notebook instances.
Protobuf enum google.events.cloud.notebooks.v1.Instance.DiskType
Instance.EnvironmentCase
Instance.NicType
The type of vNIC driver. Default should be UNSPECIFIED_NIC_TYPE.
Protobuf enum google.events.cloud.notebooks.v1.Instance.NicType
Instance.State
The definition of the states of this instance.
Protobuf enum google.events.cloud.notebooks.v1.Instance.State
Instance.UpgradeHistoryEntry.Action
The definition of operations of this upgrade history entry.
Protobuf enum google.events.cloud.notebooks.v1.Instance.UpgradeHistoryEntry.Action
Instance.UpgradeHistoryEntry.State
The definition of the states of this upgrade history entry.
Protobuf enum google.events.cloud.notebooks.v1.Instance.UpgradeHistoryEntry.State
LocalDiskInitializeParams.DiskType
Possible disk types.
Protobuf enum google.events.cloud.notebooks.v1.LocalDiskInitializeParams.DiskType
ReservationAffinity.Type
Indicates whether to consume capacity from an reservation or not.
Protobuf enum google.events.cloud.notebooks.v1.ReservationAffinity.Type
Runtime.HealthState
The runtime substate.
Protobuf enum google.events.cloud.notebooks.v1.Runtime.HealthState
Runtime.RuntimeTypeCase
Runtime.State
The definition of the states of this runtime.
Protobuf enum google.events.cloud.notebooks.v1.Runtime.State
RuntimeAcceleratorConfig.AcceleratorType
Type of this accelerator.
Protobuf enum google.events.cloud.notebooks.v1.RuntimeAcceleratorConfig.AcceleratorType
RuntimeAccessConfig.RuntimeAccessType
Possible ways to access runtime. Authentication mode. Currently supports: Single User only.
Protobuf enum google.events.cloud.notebooks.v1.RuntimeAccessConfig.RuntimeAccessType
RuntimeSoftwareConfig.PostStartupScriptBehavior
Behavior for the post startup script.
Protobuf enum
google.events.cloud.notebooks.v1.RuntimeSoftwareConfig.PostStartupScriptBehavior
Schedule.State
State of the job.
Protobuf enum google.events.cloud.notebooks.v1.Schedule.State
VirtualMachineConfig.NicType
The type of vNIC driver. Default should be UNSPECIFIED_NIC_TYPE.
Protobuf enum google.events.cloud.notebooks.v1.VirtualMachineConfig.NicType