Skip to main content
← back to extensions

Gcp/notebooks

@swamp/gcp/notebooksv2026.07.21.4· 4d agoMODELS
01README

Google Cloud notebooks infrastructure models

02Release Notes
  • Added: environments, executions, runtimes, schedules
  • Updated: locations, instances
03Models6
@swamp/gcp/notebooks/environmentsv2026.07.21.1environments.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
containerImage?objectUse a container image to start the notebook instance.
description?stringA brief description of this environment.
displayName?stringDisplay name of this environment for the UI.
postStartupScript?stringPath to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path. Example: `"gs://path-to-file/file-name"`
vmImage?objectUse a Compute Engine VM image to start the notebook instance.
environmentId?stringRequired. User-defined unique ID of this environment. The `environment_id` must be 1 to 63 characters long and contain only lowercase letters, numeric characters, and dashes. The first character must be a lowercase letter and the last character cannot be a dash.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a environments
fn get(identifier: string)
Get a environments
ArgumentTypeDescription
identifierstringThe name of the environments
fn delete(identifier: string)
Delete the environments
ArgumentTypeDescription
identifierstringThe name of the environments
fn sync(identifier?: string)
Sync environments state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific environments by name (e.g. one discovered by list)
fn list(pageSize?: number, maxPages?: number)
List environments resources
ArgumentTypeDescription
pageSize?numberMaximum return size of the list call.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— Definition of a software environment that is used to start a notebook instance.
@swamp/gcp/notebooks/executionsv2026.07.21.1executions.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
description?stringA brief description of this execution.
executionTemplate?objectexecute metadata including name, hardware spec, region, labels, etc.
outputNotebookFile?stringOutput notebook file generated by this execution
executionId?stringRequired. User-defined unique ID of this execution.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create(waitForReady?: boolean)
Create a executions
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
fn get(identifier: string)
Get a executions
ArgumentTypeDescription
identifierstringThe name of the executions
fn delete(identifier: string)
Delete the executions
ArgumentTypeDescription
identifierstringThe name of the executions
fn sync(identifier?: string)
Sync executions state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific executions by name (e.g. one discovered by list)
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List executions resources
ArgumentTypeDescription
filter?stringFilter applied to resulting executions. Currently only supports filtering executions by a specified `schedule_id`. Format: `schedule_id=`
orderBy?stringSort by field.
pageSize?numberMaximum return size of the list call.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— The definition of a single executed notebook.
@swamp/gcp/notebooks/instancesv2026.07.21.4instances.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
disableProxyAccess?booleanOptional. If true, the notebook instance will not register with the proxy.
enableDeletionProtection?booleanOptional. If true, deletion protection will be enabled for this Workbench Instance. If false, deletion protection will be disabled for this Workbench Instance.
enableManagedEuc?booleanOptional. Flag to enable managed end user credentials for the instance.
enableThirdPartyIdentity?booleanOptional. Flag that specifies that a notebook can be accessed with third party identity provider.
gceSetup?objectOptional. Compute Engine setup for the notebook. Uses notebook-defined fields.
instanceOwners?arrayOptional. The owner of this instance after creation. Format: `alias@example.com` Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.
labels?recordOptional. Labels to apply to this instance. These can be later modified by the UpdateInstance method.
instanceId?stringRequired. User-defined unique ID of this instance.
requestId?stringOptional. Idempotent request UUID.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create(waitForReady?: boolean)
Create a instances
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
fn get(identifier: string)
Get a instances
ArgumentTypeDescription
identifierstringThe name of the instances
fn update(identifier?: string, waitForReady?: boolean)
Update instances attributes
ArgumentTypeDescription
identifier?stringTarget a specific instances by name (e.g. one discovered by list)
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
fn delete(identifier: string)
Delete the instances
ArgumentTypeDescription
identifierstringThe name of the instances
fn sync(identifier?: string)
Sync instances state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific instances by name (e.g. one discovered by list)
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List instances resources
ArgumentTypeDescription
filter?stringOptional. List filter.
orderBy?stringOptional. Sort results. Supported values are "name", "name desc" or "" (unsorted).
pageSize?numberOptional. Maximum return size of the list call.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn check_authorization(authorizationDetails?: any)
check authorization
ArgumentTypeDescription
authorizationDetails?any
fn check_upgradability()
check upgradability
fn diagnose(diagnosticConfig?: any, timeoutMinutes?: any)
diagnose
ArgumentTypeDescription
diagnosticConfig?any
timeoutMinutes?any
fn generate_access_token(vmToken?: any)
generate access token
ArgumentTypeDescription
vmToken?any
fn get_config()
get config
fn get_iam_policy()
get iam policy
fn report_info_system(event?: any, vmId?: any)
report info system
ArgumentTypeDescription
event?any
vmId?any
fn reset()
reset
fn resize_disk(bootDisk?: any, dataDisk?: any)
resize disk
ArgumentTypeDescription
bootDisk?any
dataDisk?any
fn restore(snapshot?: any)
restore
ArgumentTypeDescription
snapshot?any
fn rollback(revisionId?: any, targetSnapshot?: any)
rollback
ArgumentTypeDescription
revisionId?any
targetSnapshot?any
fn set_iam_policy(policy?: any)
set iam policy
ArgumentTypeDescription
policy?any
fn start()
start
fn stop()
stop
fn test_iam_permissions(permissions?: any)
test iam permissions
ArgumentTypeDescription
permissions?any
fn upgrade(imageFamily?: any)
upgrade
ArgumentTypeDescription
imageFamily?any
fn upgrade_system(vmId?: any)
upgrade system
ArgumentTypeDescription
vmId?any

Resources

state(infinite)— The definition of a notebook instance.
@swamp/gcp/notebooks/locationsv2026.07.21.3locations.ts

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
namestringThe resource that owns the locations collection, if applicable.
fn get(identifier: string)
Get a locations
ArgumentTypeDescription
identifierstringThe name of the locations
fn sync(identifier?: string)
Sync locations state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific locations by name (e.g. one discovered by list)
fn list(extraLocationTypes?: string, filter?: string, pageSize?: number, maxPages?: number)
List locations resources
ArgumentTypeDescription
extraLocationTypes?stringOptional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.
filter?stringA filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
pageSize?numberThe maximum number of results to return. If not set, the service selects a default.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— A resource that represents a Google Cloud location.
@swamp/gcp/notebooks/runtimesv2026.07.21.1runtimes.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
accessConfig?objectThe config settings for accessing runtime.
labels?recordOptional. The labels to associate with this Managed Notebook or Runtime. Label **keys** must contain 1 to 63 characters, and must conform to [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt). Label **values** may be empty, but, if present, must contain 1 to 63 characters, and must conform to [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a cluster.
softwareConfig?objectThe config settings for software inside the runtime.
virtualMachine?objectUse a Compute Engine VM image to start the managed notebook instance.
requestId?stringIdempotent request UUID.
runtimeId?stringRequired. User-defined unique ID of this Runtime.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create(waitForReady?: boolean)
Create a runtimes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
fn get(identifier: string)
Get a runtimes
ArgumentTypeDescription
identifierstringThe name of the runtimes
fn update(identifier?: string, waitForReady?: boolean)
Update runtimes attributes
ArgumentTypeDescription
identifier?stringTarget a specific runtimes by name (e.g. one discovered by list)
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
fn delete(identifier: string)
Delete the runtimes
ArgumentTypeDescription
identifierstringThe name of the runtimes
fn sync(identifier?: string)
Sync runtimes state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific runtimes by name (e.g. one discovered by list)
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List runtimes resources
ArgumentTypeDescription
filter?stringOptional. List filter.
orderBy?stringOptional. Sort results. Supported values are "name", "name desc" or "" (unsorted).
pageSize?numberMaximum return size of the list call.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn diagnose(diagnosticConfig?: any, timeoutMinutes?: any)
diagnose
ArgumentTypeDescription
diagnosticConfig?any
timeoutMinutes?any
fn get_iam_policy()
get iam policy
fn migrate(network?: any, postStartupScriptOption?: any, requestId?: any, serviceAccount?: any, subnet?: any)
migrate
ArgumentTypeDescription
network?any
postStartupScriptOption?any
requestId?any
serviceAccount?any
subnet?any
fn refresh_runtime_token_internal(vmId?: any)
refresh runtime token internal
ArgumentTypeDescription
vmId?any
fn report_event(event?: any, vmId?: any)
report event
ArgumentTypeDescription
event?any
vmId?any
fn reset(requestId?: any)
reset
ArgumentTypeDescription
requestId?any
fn set_iam_policy(policy?: any)
set iam policy
ArgumentTypeDescription
policy?any
fn start(requestId?: any)
start
ArgumentTypeDescription
requestId?any
fn stop(requestId?: any)
stop
ArgumentTypeDescription
requestId?any
fn switch(acceleratorConfig?: any, machineType?: any, requestId?: any)
switch
ArgumentTypeDescription
acceleratorConfig?any
machineType?any
requestId?any
fn test_iam_permissions(permissions?: any)
test iam permissions
ArgumentTypeDescription
permissions?any
fn upgrade(requestId?: any)
upgrade
ArgumentTypeDescription
requestId?any

Resources

state(infinite)— The definition of a Runtime for a managed notebook instance.
@swamp/gcp/notebooks/schedulesv2026.07.21.1schedules.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
cronSchedule?stringCron-tab formatted schedule by which the job will execute. Format: minute, hour, day of month, month, day of week, e.g. `0 0 * * WED` = every Wednesday More examples: https://crontab.guru/examples.html
description?stringA brief description of this environment.
executionTemplate?objectNotebook Execution Template corresponding to this schedule.
state?enum
timeZone?stringTimezone on which the cron_schedule. The value of this field must be a time zone name from the tz database. TZ Database: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string "utc". If a time zone is not specified, the default will be in UTC (also known as GMT).
scheduleId?stringRequired. User-defined unique ID of this schedule.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create(waitForReady?: boolean)
Create a schedules
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
fn get(identifier: string)
Get a schedules
ArgumentTypeDescription
identifierstringThe name of the schedules
fn delete(identifier: string)
Delete the schedules
ArgumentTypeDescription
identifierstringThe name of the schedules
fn sync(identifier?: string)
Sync schedules state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific schedules by name (e.g. one discovered by list)
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List schedules resources
ArgumentTypeDescription
filter?stringFilter applied to resulting schedules.
orderBy?stringField to order results by.
pageSize?numberMaximum return size of the list call.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn trigger()
trigger

Resources

state(infinite)— The definition of a schedule.
04Previous Versions19
2026.07.21.1
  • Updated: instances, environments, executions, runtimes, schedules
2026.07.20.2
  • Added: environments, executions, runtimes, schedules
  • Updated: locations, instances

Added 4 models

2026.07.20.1
  • Updated: locations, instances

Removed 4 models

2026.07.19.2
  • Updated: locations
2026.07.19.1
  • Updated: locations, instances, environments, executions, runtimes, schedules
2026.07.18.2
  • Updated: locations, instances, environments, executions, runtimes, schedules
2026.07.17.2
  • Updated: instances, runtimes
2026.07.17.1
  • Updated: instances, environments, executions, runtimes, schedules
2026.06.08.2
  • Updated: locations, instances, environments, executions, runtimes, schedules
2026.06.07.1
  • Updated: locations, instances, environments, executions, runtimes, schedules
2026.06.05.1
  • Added: environments, executions, runtimes, schedules

Added 4 models

2026.05.27.1
  • Updated: locations, instances
2026.05.26.1
  • Updated: instances
2026.05.25.1
  • Updated: locations, instances

Modified 2 models

2026.05.24.1
  • Updated: locations, instances
2026.05.21.2
  • Updated: locations, instances
2026.05.21.1

Modified 1 models

2026.05.20.1
  • Updated: instances
2026.05.19.2
05Stats
A
100 / 100
Downloads
0
Archive size
112.8 KB
Verified by Swamp
  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types (deprecated)1/1earned
  • Dependencies pass trust audit2/2earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License declared1/1earned
  • Verified public repository2/2earned
Repository
https://github.com/swamp-club/swamp-extensions
06Platforms
07Labels
#gcp#google-cloud#notebooks#cloud#infrastructure