API documentation for notebooks_v2.types package.
Classes
AcceleratorConfig
An accelerator configuration for a VM instance Definition of a
hardware accelerator. Note that there is no check on type and
core_count combinations. TPUs are not supported. See GPUs on
Compute
Engine <https://cloud.google.com/compute/docs/gpus/#gpus-list>__ to
find a valid combination.
BootDisk
The definition of a boot disk.
CheckInstanceUpgradabilityRequest
Request for checking if a notebook instance is upgradeable.
CheckInstanceUpgradabilityResponse
Response for checking if a notebook instance is upgradeable.
ContainerImage
Definition of a container image for starting a notebook instance with the environment installed in a container.
CreateInstanceRequest
Request for creating a notebook instance.
DataDisk
An instance-attached disk resource.
DeleteInstanceRequest
Request for deleting a notebook instance.
DiagnoseInstanceRequest
Request for creating a notebook instance diagnostic file.
DiagnosticConfig
Defines flags that are used to run the diagnostic tool
DiskEncryption
Definition of the disk encryption options.
Values: 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.
DiskType
Possible disk types.
Values: 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.
Event
The definition of an Event for a managed / semi-managed notebook instance.
GPUDriverConfig
A GPU driver configuration
GceSetup
The definition of how to configure a VM instance outside of Resources and Identity.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
GetInstanceRequest
Request for getting a notebook instance.
HealthState
The instance health state.
Values: HEALTH_STATE_UNSPECIFIED (0): The instance substate is unknown. HEALTHY (1): The instance is known to be in an healthy state (for example, critical daemons are running) Applies to ACTIVE state. UNHEALTHY (2): The instance is known to be in an unhealthy state (for example, critical daemons are not running) Applies to ACTIVE state. AGENT_NOT_INSTALLED (3): The instance has not installed health monitoring agent. Applies to ACTIVE state. AGENT_NOT_RUNNING (4): The instance health monitoring agent is not running. Applies to ACTIVE state.
Instance
The definition of a notebook instance.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ListInstancesRequest
Request for listing notebook instances.
ListInstancesResponse
Response for listing notebook instances.
NetworkInterface
The definition of a network interface resource attached to a VM.
OperationMetadata
Represents the metadata of the long-running operation.
ResetInstanceRequest
Request for resetting a notebook instance
RollbackInstanceRequest
Request for rollbacking a notebook instance
ServiceAccount
A service account that acts as an identity.
ShieldedInstanceConfig
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.
StartInstanceRequest
Request for starting a notebook instance
State
The definition of the states of this instance.
Values: 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. SUSPENDING (9): The instance is suspending. SUSPENDED (10): The instance is suspended.
StopInstanceRequest
Request for stopping a notebook instance
UpdateInstanceRequest
Request for updating a notebook instance.
UpgradeHistoryEntry
The entry of VM image upgrade history.
UpgradeInstanceRequest
Request for upgrading a notebook instance
VmImage
Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields