notebooks/v1 library
Notebooks API - v1
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
- Definition of a hardware accelerator.
- AIPlatformNotebooksApi
- Notebooks API is used to manage notebook resources in Google Cloud.
- Binding
-
Associates
members
, or principals, with arole
. - ContainerImage
- Definition of a container image for starting a notebook instance with the environment installed in a container.
- DataprocParameters
- Parameters used in Dataproc JobType executions.
- DiagnoseInstanceRequest
- Request for creating a notebook instance diagnostic file.
- DiagnoseRuntimeRequest
- Request for creating a notebook instance diagnostic file.
- DiagnosticConfig
- Defines flags that are used to run the diagnostic tool
- Disk
- An instance-attached disk resource.
- EncryptionConfig
- Represents a custom encryption key configuration that can be applied to a resource.
- Environment
- Definition of a software environment that is used to start a notebook instance.
- Event
- The definition of an Event for a managed / semi-managed notebook instance.
- Execution
- The definition of a single executed notebook.
- ExecutionTemplate
- The description a notebook execution workload.
- GetInstanceHealthResponse
- Response for checking if a notebook instance is healthy.
- GuestOsFeature
- Guest OS features for boot disk.
- Instance
- The definition of a notebook instance.
- InstanceConfig
- Notebook instance configurations that can be updated.
- InstanceMigrationEligibility
- InstanceMigrationEligibility represents the feasibility information of a migration from UmN to WbI.
- ListEnvironmentsResponse
- Response for listing environments.
- ListExecutionsResponse
- Response for listing scheduled notebook executions
- ListInstancesResponse
- Response for listing notebook instances.
- ListLocationsResponse
- The response message for Locations.ListLocations.
- ListOperationsResponse
- The response message for Operations.ListOperations.
- ListRuntimesResponse
- Response for listing Managed Notebook Runtimes.
- ListSchedulesResponse
- Response for listing scheduled notebook job.
- LocalDisk
- A Local attached disk resource.
- LocalDiskInitializeParams
- Input only.
- MigrateInstanceRequest
- Request for migrating a User-Managed Notebook to Workbench Instances.
- MigrateRuntimeRequest
- Request for migrating a Runtime to a Workbench Instance.
- 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.
- ProjectsLocationsEnvironmentsResource
- ProjectsLocationsExecutionsResource
- ProjectsLocationsInstancesResource
- ProjectsLocationsOperationsResource
- ProjectsLocationsResource
- ProjectsLocationsRuntimesResource
- ProjectsLocationsSchedulesResource
- ProjectsResource
- RefreshRuntimeTokenInternalResponse
- Response with a new access token.
- RegisterInstanceRequest
- Request for registering a notebook instance.
- ReportInstanceEventRequest
- Request for reporting a Managed Notebook Event.
- ReportInstanceInfoRequest
- Request for notebook instances to report information to Notebooks API.
- ReportRuntimeEventRequest
- Request for reporting a Managed Notebook Event.
- ReservationAffinity
- Reservation Affinity for consuming Zonal reservation.
- RollbackInstanceRequest
- Request for rollbacking a notebook instance
- Runtime
- The definition of a Runtime for a managed notebook instance.
- RuntimeAcceleratorConfig
- Definition of the types of hardware accelerators that can be used.
- RuntimeAccessConfig
- Specifies the login configuration for Runtime
- RuntimeGuestOsFeature
- A list of features to enable on the guest operating system.
- RuntimeMetrics
- Contains runtime daemon metrics, such as OS and kernels and sessions stats.
- RuntimeMigrationEligibility
- RuntimeMigrationEligibility represents the feasibility information of a migration from GmN to WbI.
- RuntimeSoftwareConfig
- Specifies the selection and configuration of software inside the runtime.
- Schedule
- The definition of a schedule.
- SchedulerAcceleratorConfig
- Definition of a hardware accelerator.
- SetIamPolicyRequest
-
Request message for
SetIamPolicy
method. - SetInstanceAcceleratorRequest
- Request for setting instance accelerator.
- SetInstanceLabelsRequest
- Request for setting instance labels.
- SetInstanceMachineTypeRequest
- Request for setting instance machine type.
- SwitchRuntimeRequest
- Request for switching a Managed Notebook Runtime.
- UpdateInstanceConfigRequest
- Request for updating instance configurations.
- UpdateInstanceMetadataItemsRequest
- Request for adding/changing metadata items for an instance.
- UpdateInstanceMetadataItemsResponse
- Response for adding/changing metadata items for an instance.
- UpdateShieldedInstanceConfigRequest
- Request for updating the Shielded Instance config for a notebook instance.
- UpgradeHistoryEntry
- The entry of VM image upgrade history.
- UpgradeInstanceInternalRequest
- Request for upgrading a notebook instance from within the VM
- UpgradeInstanceRequest
- Request for upgrading a notebook instance
- VertexAIParameters
- Parameters used in Vertex AI JobType executions.
- VirtualMachine
- Runtime using Virtual Machine for computing.
- VirtualMachineConfig
- The config settings for virtual machine.
- VmImage
- Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM.
Typedefs
- BootImage = $Empty
- Definition of the boot image used by the Runtime.
- CancelOperationRequest = $Empty
- The request message for Operations.CancelOperation.
- 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.
- IsInstanceUpgradeableResponse = $Response
- Response for checking if a notebook instance is upgradeable.
- Location = $Location00
- A resource that represents a Google Cloud location.
- RefreshRuntimeTokenInternalRequest = $Request09
- Request for getting a new access token.
- ResetInstanceRequest = $Empty
- Request for resetting a notebook instance
- ResetRuntimeRequest = $RuntimeRequest
- Request for resetting a Managed Notebook Runtime.
- RuntimeShieldedInstanceConfig = $ShieldedInstanceConfig
- A set of Shielded Instance options.
- ShieldedInstanceConfig = $ShieldedInstanceConfig
- A set of Shielded Instance options.
- StartInstanceRequest = $Empty
- Request for starting a notebook instance
- StartRuntimeRequest = $RuntimeRequest
- Request for starting a Managed Notebook Runtime.
- 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
- StopRuntimeRequest = $RuntimeRequest
- Request for stopping a Managed Notebook Runtime.
- TestIamPermissionsRequest = $TestIamPermissionsRequest00
-
Request message for
TestIamPermissions
method. - TestIamPermissionsResponse = $PermissionsResponse
-
Response message for
TestIamPermissions
method. - TriggerScheduleRequest = $Empty
- Request for created scheduled notebooks
- UpgradeRuntimeRequest = $RuntimeRequest
- Request for upgrading a Managed Notebook Runtime to the latest version.
Exceptions / Errors
- ApiRequestError
- Represents a general error reported by the API endpoint.
- DetailedApiRequestError
- Represents a specific error reported by the API endpoint.