notebooks/v2 library

Notebooks API - v2

Notebooks API is used to manage notebook resources in Google Cloud.

For more information, see cloud.google.com/notebooks/docs/

Create an instance of AIPlatformNotebooksApi to access these resources:

Classes

AcceleratorConfig
An accelerator configuration for a VM instance Definition of a hardware accelerator.
AccessConfig
An access configuration attached to an instance's network interface.
AIPlatformNotebooksApi
Notebooks API is used to manage notebook resources in Google Cloud.
Binding
Associates members, or principals, with a role.
BootDisk
The definition of a boot disk.
Config
Response for getting WbI configurations in a location
ContainerImage
Definition of a container image for starting a notebook instance with the environment installed in a container.
DataDisk
An instance-attached disk resource.
DefaultValues
DefaultValues represents the default configuration values.
DiagnoseInstanceRequest
Request for creating a notebook instance diagnostic file.
DiagnosticConfig
Defines flags that are used to run the diagnostic tool
Event
The definition of an Event for a managed / semi-managed notebook instance.
GceSetup
The definition of how to configure a VM instance outside of Resources and Identity.
GPUDriverConfig
A GPU driver configuration
ImageRelease
ConfigImage represents an image release available to create a WbI
Instance
The definition of a notebook instance.
ListInstancesResponse
Response for listing notebook instances.
ListLocationsResponse
The response message for Locations.ListLocations.
ListOperationsResponse
The response message for Operations.ListOperations.
NetworkInterface
The definition of a network interface resource attached to a VM.
Operation
This resource represents a long-running operation that is the result of a network API call.
Policy
An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.
ProjectsLocationsInstancesResource
ProjectsLocationsOperationsResource
ProjectsLocationsResource
ProjectsResource
ReportInstanceInfoSystemRequest
Request for notebook instances to report information to Notebooks API.
ResizeDiskRequest
Request for resizing the notebook instance disks
RollbackInstanceRequest
Request for rollbacking a notebook instance
ServiceAccount
A service account that acts as an identity.
SetIamPolicyRequest
Request message for SetIamPolicy method.
ShieldedInstanceConfig
A set of Shielded Instance options.
SupportedValues
SupportedValues represents the values supported by the configuration.
UpgradeHistoryEntry
The entry of VM image upgrade history.
VmImage
Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM.

Typedefs

CancelOperationRequest = $Empty
The request message for Operations.CancelOperation.
CheckInstanceUpgradabilityResponse = $Response
Response for checking if a notebook instance is upgradeable.
Empty = $Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs.
Expr = $Expr
Represents a textual expression in the Common Expression Language (CEL) syntax.
Location = $Location00
A resource that represents a Google Cloud location.
ResetInstanceRequest = $Empty
Request for resetting a notebook instance
StartInstanceRequest = $Empty
Request for starting a notebook instance
Status = $Status
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs.
StopInstanceRequest = $Empty
Request for stopping a notebook instance
TestIamPermissionsRequest = $TestIamPermissionsRequest00
Request message for TestIamPermissions method.
TestIamPermissionsResponse = $PermissionsResponse
Response message for TestIamPermissions method.
UpgradeInstanceRequest = $Empty
Request for upgrading a notebook instance
UpgradeInstanceSystemRequest = $Request09
Request for upgrading a notebook instance from within the VM

Exceptions / Errors

ApiRequestError
Represents a general error reported by the API endpoint.
DetailedApiRequestError
Represents a specific error reported by the API endpoint.