Get Instance
vertex_notebooks.get_instance
ActionGoogle Cloudconnection required
Calls Notebooks GET /v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}.
Gets details of a single Instance.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- OAuth 2.0
- Providers
- Google Notebooks
- Secret shape
- {"client_id", "client_secret", "refresh_token"}
- Config it needs
- location, project_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
3 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
project_id GCP project id (overrides connection). | string | No | — | — | — |
location Location / region (overrides connection). | string | No | — | — | — |
instance Id of the instance to act on, from vertex_notebooks.list_instances — not its name. | string | Yes | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
ok | boolean | — |
enableDeletionProtection | boolean | — |
createTime | string | — |
thirdPartyProxyUrl | string | — |
proxyUri | string | — |
updateTime | string | — |
enableManagedEuc | boolean | — |
{
"createTime": "",
"enableDeletionProtection": false,
"enableManagedEuc": false,
"ok": false,
"proxyUri": "",
"thirdPartyProxyUrl": "",
"updateTime": ""
}Related Google Notebooks nodes
See Get Instance run in a workflow.
In a technical demo we add the Google Notebooks connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.