events/cloud/notebooks/v1 library
Classes
- ContainerImage
- Definition of a container image for starting a notebook instance with the environment installed in a container.
- EncryptionConfig
- Represents a custom encryption key configuration that can be applied to a resource. This will encrypt all disks in Virtual Machine.
- Environment
- Definition of a software environment that is used to start a notebook instance.
- EnvironmentCreatedEvent
- The CloudEvent raised when an Environment is created.
- EnvironmentDeletedEvent
- The CloudEvent raised when an Environment is deleted.
- EnvironmentEventData
- The data within all Environment events.
- Execution
- The definition of a single executed notebook.
- Execution_State
- Enum description of the state of the underlying AIP job.
- ExecutionCreatedEvent
- The CloudEvent raised when an Execution is created.
- ExecutionDeletedEvent
- The CloudEvent raised when an Execution is deleted.
- ExecutionEventData
- The data within all Execution events.
- ExecutionTemplate
- The description a notebook execution workload.
- ExecutionTemplate_DataprocParameters
- Parameters used in Dataproc JobType executions.
- ExecutionTemplate_JobType
- The backend used for this execution.
- ExecutionTemplate_ScaleTier
- Required. Specifies the machine types, the number of replicas for workers and parameter servers.
- ExecutionTemplate_SchedulerAcceleratorConfig
-
Definition of a hardware accelerator. Note that not all combinations
of
typeandcore_countare valid. See GPUs on Compute Engine to find a valid combination. TPUs are not supported. - ExecutionTemplate_SchedulerAcceleratorType
- Hardware accelerator types for AI Platform Training jobs.
- ExecutionTemplate_VertexAIParameters
- Parameters used in Vertex AI JobType executions.
- Instance
- The definition of a notebook instance.
- Instance_AcceleratorConfig
-
Definition of a hardware accelerator. Note that not all combinations
of
typeandcore_countare valid. See GPUs on Compute Engine to find a valid combination. TPUs are not supported. - Instance_AcceleratorType
- Definition of the types of hardware accelerators that can be used on this instance.
- Instance_Disk
- An instance-attached disk resource.
- Instance_Disk_GuestOsFeature
- Guest OS features for boot disk.
- Instance_DiskEncryption
- Definition of the disk encryption options.
- Instance_DiskType
- Possible disk types for notebook instances.
- Instance_NicType
- The type of vNIC driver. Default should be UNSPECIFIED_NIC_TYPE.
- Instance_ShieldedInstanceConfig
- A set of Shielded Instance options. See Images using supported Shielded VM features. Not all combinations are valid.
- Instance_State
- The definition of the states of this instance.
- Instance_UpgradeHistoryEntry
- The entry of VM image upgrade history.
- Instance_UpgradeHistoryEntry_Action
- The definition of operations of this upgrade history entry.
- Instance_UpgradeHistoryEntry_State
- The definition of the states of this upgrade history entry.
- InstanceCreatedEvent
- The CloudEvent raised when an Instance is created.
- InstanceDeletedEvent
- The CloudEvent raised when an Instance is deleted.
- InstanceEventData
- The data within all Instance events.
- LocalDisk
- A Local attached disk resource.
- 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.
- 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.
- LocalDiskInitializeParams_DiskType
- Possible disk types.
- ReservationAffinity
- Reservation Affinity for consuming Zonal reservation.
- ReservationAffinity_Type
- Indicates whether to consume capacity from an reservation or not.
- Runtime
- The definition of a Runtime for a managed notebook instance.
- Runtime_HealthState
- The runtime substate.
- Runtime_State
- The definition of the states of this 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:
- RuntimeAcceleratorConfig_AcceleratorType
- Type of this accelerator.
- RuntimeAccessConfig
- Specifies the login configuration for Runtime
- RuntimeAccessConfig_RuntimeAccessType
- Possible ways to access runtime. Authentication mode. Currently supports: Single User only.
- RuntimeCreatedEvent
- The CloudEvent raised when a Runtime is created.
- RuntimeDeletedEvent
- The CloudEvent raised when a Runtime is deleted.
- RuntimeEventData
- The data within all Runtime events.
- RuntimeMetrics
- Contains runtime daemon metrics, such as OS and kernels and sessions stats.
- RuntimeShieldedInstanceConfig
- A set of Shielded Instance options. See Images using supported Shielded VM features. Not all combinations are valid.
- RuntimeSoftwareConfig
-
Specifies the selection and configuration of software inside the runtime.
The properties to set on runtime.
Properties keys are specified in
key:valueformat, for example: - RuntimeSoftwareConfig_PostStartupScriptBehavior
- Behavior for the post startup script.
- RuntimeUpdatedEvent
- The CloudEvent raised when a Runtime is updated.
- Schedule
- The definition of a schedule.
- Schedule_State
- State of the job.
- ScheduleCreatedEvent
- The CloudEvent raised when a Schedule is created.
- ScheduleDeletedEvent
- The CloudEvent raised when a Schedule is deleted.
- ScheduleEventData
- The data within all Schedule events.
- VirtualMachine
- Runtime using Virtual Machine for computing.
- VirtualMachineConfig
- The config settings for virtual machine.
- VirtualMachineConfig_BootImage
- Definition of the boot image used by the Runtime. Used to facilitate runtime upgradeability.
- VirtualMachineConfig_NicType
- The type of vNIC driver. Default should be UNSPECIFIED_NIC_TYPE.
- VmImage
- Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM.