Deprecated, use NotebookStatus.Phase. The state of the underlying container. For more information, refer to https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#containerstate-v1-core.
phasestring
A string that contains the current Pod phase.
reasonstring
A string that contains the reason the Pod is in its current state.
If the Notebook is not currently running or the controller failed to query pod status, the time when the Notebook pod was first observed to not be running.
Defines the containers, environment variables for the container, and other properties such as the scheduler name and security context. For more information, refer to https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#podspec-v1-core.
userClusterstring
UserCluster is the name of the user cluster where the Notebook workload is created. The cluster must have sufficient resources to run the workload specified in PodSpec.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-25 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eaiplatform.gdc.goog/v1\u003c/code\u003e package defines the API schema for managing Notebook resources within the aiplatform.gdc.goog v1 API group.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eNotebook\u003c/code\u003e resources are described with fields for \u003ccode\u003eapiVersion\u003c/code\u003e, \u003ccode\u003ekind\u003c/code\u003e, \u003ccode\u003emetadata\u003c/code\u003e, \u003ccode\u003espec\u003c/code\u003e (desired state), and \u003ccode\u003estatus\u003c/code\u003e (observed state), all of which are essential for defining and monitoring Notebook instances.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eNotebookStatus\u003c/code\u003e tracks the state of a \u003ccode\u003eNotebook\u003c/code\u003e, including its \u003ccode\u003econditions\u003c/code\u003e, \u003ccode\u003ereadyReplicas\u003c/code\u003e, \u003ccode\u003econtainerState\u003c/code\u003e, \u003ccode\u003ephase\u003c/code\u003e, and potential \u003ccode\u003eerror\u003c/code\u003e information.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eNotebookSpec\u003c/code\u003e defines the desired state of a Notebook, which includes a \u003ccode\u003eNotebookTemplateSpec\u003c/code\u003e to describe the desired workload, and the specification of the \u003ccode\u003euserCluster\u003c/code\u003e where it will run.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eNotebookList\u003c/code\u003e resource is a resource that serves the purpose of containing a list of multiple \u003ccode\u003eNotebook\u003c/code\u003e resources, while providing a \u003ccode\u003emetadata\u003c/code\u003e field to provide metadata information.\u003c/p\u003e\n"]]],[],null,["# Vertex AI Workbench KRM API reference\n\nPackages\n--------\n\n- [aiplatform.gdc.goog/v1](#aiplatformgdcgoogv1)\n\naiplatform.gdc.goog/v1\n----------------------\n\nPackage v1 contains API schema definitions for the aiplatform.gdc.goog v1 API\ngroup.\n\n### Resource Types\n\n- [Notebook](#notebook)\n- [NotebookList](#notebooklist)\n\n#### Notebook\n\n`Notebook` is the Schema for the Notebooks API.\n\n*Appears in:*\n- [NotebookList](#notebooklist)\n\n#### NotebookCondition\n\n*Appears in:*\n- [NotebookStatus](#notebookstatus)\n\n#### NotebookError\n\n`NotebookError` represents an error that occurred while updating Notebook resources.\n\n*Appears in:*\n- [NotebookStatus](#notebookstatus)\n\n#### NotebookList\n\n`NotebookList` contains a list of `Notebook` instances.\n\n#### NotebookSpec\n\n`NotebookSpec` defines the desired state of the Notebook.\n\n*Appears in:*\n- [Notebook](#notebook)\n\n#### NotebookStatus\n\n`NotebookStatus` defines the observed state of the Notebook.\n\n*Appears in:*\n- [Notebook](#notebook)\n\n#### NotebookTemplateSpec\n\n`NotebookTemplateSpec` defines the desired state of the cluster.\n\n*Appears in:*\n- [NotebookSpec](#notebookspec)"]]
