Notebooks API

The Notebooks API lets you manage Vertex AI Workbench resources in Google Cloud.

Service: notebooks.googleapis.com

The Service name notebooks.googleapis.com is needed to create RPC client stubs.

google.cloud.location.Locations

Methods
GetLocationGets information about a location.
ListLocationsLists information about the supported locations for this service.

google.cloud.notebooks.v1.ManagedNotebookService

Methods
CreateRuntimeCreates a new Runtime in a given project and location.
DeleteRuntimeDeletes a single Runtime.
GetRuntimeGets details of a single Runtime.
ListRuntimesLists Runtimes in a given project and location.
MigrateRuntimeMigrate an existing Runtime to a new Workbench Instance.
ReportRuntimeEventReports and processes a runtime event.
ResetRuntimeResets a Managed Notebook Runtime.
StartRuntimeStarts a Managed Notebook Runtime.
StopRuntimeStops a Managed Notebook Runtime.
SwitchRuntimeSwitch a Managed Notebook Runtime.
UpdateRuntimeUpdate Notebook Runtime configuration.

google.cloud.notebooks.v1.NotebookService

Methods
CreateEnvironmentCreates a new Environment.
CreateExecutionCreates a new Execution in a given project and location.
CreateInstanceCreates a new Instance in a given project and location.
CreateScheduleCreates a new Scheduled Notebook in a given project and location.
DeleteEnvironmentDeletes a single Environment.
DeleteExecutionDeletes execution
DeleteInstanceDeletes a single Instance.
DeleteScheduleDeletes schedule and all underlying jobs
DiagnoseInstanceCreates a Diagnostic File and runs Diagnostic Tool given an Instance.
GetEnvironmentGets details of a single Environment.
GetExecutionGets details of executions
GetInstanceGets details of a single Instance.
GetInstanceHealthChecks whether a notebook instance is healthy.
GetScheduleGets details of schedule
IsInstanceUpgradeableChecks whether a notebook instance is upgradable.
ListEnvironmentsLists environments in a project.
ListExecutionsLists executions in a given project and location
ListInstancesLists instances in a given project and location.
ListSchedulesLists schedules in a given project and location.
MigrateInstanceMigrates an existing User-Managed Notebook to Workbench Instances.
RegisterInstanceRegisters an existing legacy notebook instance to the Notebooks API server.
ReportInstanceInfoAllows notebook instances to report their latest instance information to the Notebooks API server.
ResetInstanceResets a notebook instance.
RollbackInstanceRollbacks a notebook instance to the previous version.
SetInstanceAcceleratorUpdates the guest accelerators of a single Instance.
SetInstanceLabelsReplaces all the labels of an Instance.
SetInstanceMachineTypeUpdates the machine type of a single Instance.
StartInstanceStarts a notebook instance.
StopInstanceStops a notebook instance.
UpdateInstanceConfigUpdate Notebook Instance configurations.
UpdateInstanceMetadataItemsAdd/update metadata items for an instance.
UpdateShieldedInstanceConfigUpdates the Shielded instance configuration of a single Instance.
UpgradeInstanceUpgrades a notebook instance to the latest version.

google.cloud.notebooks.v2.NotebookService

Methods
CheckInstanceUpgradabilityChecks whether a notebook instance is upgradable.
CreateInstanceCreates a new Instance in a given project and location.
DeleteInstanceDeletes a single Instance.
DiagnoseInstanceCreates a Diagnostic File and runs Diagnostic Tool given an Instance.
GetConfigReturns various configuration parameters.
GetInstanceGets details of a single Instance.
ListInstancesLists instances in a given project and location.
ResetInstanceResets a notebook instance.
ResizeDiskResize a notebook instance disk to a higher capacity.
RestoreInstanceRestoreInstance restores an Instance from a BackupSource.
RollbackInstanceRollbacks a notebook instance to the previous version.
StartInstanceStarts a notebook instance.
StopInstanceStops a notebook instance.
UpdateInstanceUpdateInstance updates an Instance.
UpgradeInstanceUpgrades a notebook instance to the latest version.

google.iam.v1.IAMPolicy

Methods
GetIamPolicyGets the access control policy for a resource.
SetIamPolicySets the access control policy on the specified resource.
TestIamPermissionsReturns permissions that a caller has on the specified resource.

google.longrunning.Operations

Methods
CancelOperationStarts asynchronous cancellation on a long-running operation.
DeleteOperationDeletes a long-running operation.
GetOperationGets the latest state of a long-running operation.
ListOperationsLists operations that match the specified filter in the request.
WaitOperationWaits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.