gcloud beta colab executions create

NAME
gcloud beta colab executions create - create an execution
SYNOPSIS
gcloud beta colab executions create(--display-name=DISPLAY_NAME--gcs-output-uri=GCS_OUTPUT_URI--notebook-runtime-template=NOTEBOOK_RUNTIME_TEMPLATE (--direct-content=DIRECT_CONTENT | [--dataform-repository-name=DATAFORM_REPOSITORY_NAME :--commit-sha=COMMIT_SHA] | [--gcs-notebook-uri=GCS_NOTEBOOK_URI :--generation=GENERATION]) (--service-account=SERVICE_ACCOUNT |--user-email=USER_EMAIL) :--execution-timeout=EXECUTION_TIMEOUT; default="24h")[--async][--region=REGION][GCLOUD_WIDE_FLAG]
DESCRIPTION
(BETA) Create a notebook execution to be used on a Colab Enterpriseruntime.
EXAMPLES
To create an execution of a notebook file with Cloud Storage URIgs://my-bucket/my-notebook.ipynb, with an execution job displaynamemy-execution, compute configured from runtime templatemy-runtime-template-id, running with service accountmy-service-account@my-project.iam.gserviceaccount.com, with resultsuploaded to Cloud Storage bucketgs://my-bucket/results, and inregionus-central1 run:
gcloudbetacolabexecutionscreate--display-name=my-execution--runtime-template=my-runtime-template-id--gcs-notebook-uri=gs://my-bucket/my-notebook.ipynb--service-account=my-service-account@my-project.iam.gserviceaccount.com--gcs-output-uri=gs://my-bucket/results--region=us-central1
REQUIRED FLAGS
Configuration of the execution job.

This must be specified.

--display-name=DISPLAY_NAME
The display name of the execution.

This flag argument must be specified if any of the other arguments in this groupare specified.

--gcs-output-uri=GCS_OUTPUT_URI
The Cloud Storage location to upload notebook execution results to. Format:gs://bucket-name.

This flag argument must be specified if any of the other arguments in this groupare specified.

Notebook runtime template resource - The runtime template specifying the computeconfiguration for the notebook execution. The runtime template should be in thesame region as the execution. This represents a Cloud resource. (NOTE) Someattributes are not given arguments in this group but can be set in other ways.

To set theproject attribute:

  • provide the argument--notebook-runtime-template on the commandline with a fully specified name;
  • provide the argument--project on the command line;
  • set the propertycore/project.

To set theregion attribute:

  • provide the argument--notebook-runtime-template on the commandline with a fully specified name;
  • provide the argument--region on the command line;
  • set the propertycolab/region.

This must be specified.

--notebook-runtime-template=NOTEBOOK_RUNTIME_TEMPLATE
ID of the notebook runtime template or fully qualified identifier for thenotebook runtime template.

To set thename attribute:

  • provide the argument--notebook-runtime-template on the commandline.
--execution-timeout=EXECUTION_TIMEOUT; default="24h"
The max running time of the execution job, as a duration. See '$gcloud topic datetimes' fordetails on formatting the input duration.
Source of the notebook to execute.

Exactly one of these must be specified:

--direct-content=DIRECT_CONTENT
The direct notebook content as IPYNB. This can be a local filepath to an .ipynbfile or can be set to- to read content from stdin.
Or at least one of these can be specified:
The Dataform repository containing the notebook. Any notebook created from theColab UI is automatically stored in a Dataform repository. The repository namecan be found via the Dataform API by listing repositories in the same projectand region as the notebook.
Dataform repository resource - Unique name of the Dataform repository to sourceinput notebook from. This represents a Cloud resource. (NOTE) Some attributesare not given arguments in this group but can be set in other ways.

To set theproject attribute:

  • provide the argument--dataform-repository-name on the command linewith a fully specified name;
  • provide the argument--project on the command line;
  • set the propertycore/project.

To set theregion attribute:

  • provide the argument--dataform-repository-name on the command linewith a fully specified name;
  • provide the argument--region on the command line;
  • set the propertycolab/region.

This must be specified.

--dataform-repository-name=DATAFORM_REPOSITORY_NAME
ID of the dataform repository or fully qualified identifier for the dataformrepository.

To set thename attribute:

  • provide the argument--dataform-repository-name on the commandline.
--commit-sha=COMMIT_SHA
The commit SHA to read from the Dataform repository. If unset, the file will beread from HEAD.
Or at least one of these can be specified:
The Cloud Storage notebook source.
--gcs-notebook-uri=GCS_NOTEBOOK_URI
The Cloud Storage uri pointing to the notebook. Format:gs://bucket/notebook_file.ipynb

This flag argument must be specified if any of the other arguments in this groupare specified.

--generation=GENERATION
The version of the Cloud Storage object to read. If unset, the current versionof the object will be used.
Identity to run the execution as.

Exactly one of these must be specified:

--service-account=SERVICE_ACCOUNT
The service account to run the execution as.
--user-email=USER_EMAIL
The user email to run the execution as. This requires the provided runtimetemplate to have end user credentials enabled.
OPTIONAL FLAGS
--async
Return immediately, without waiting for the operation in progress to complete.
Region resource - Cloud region to create. This represents a Cloud resource.(NOTE) Some attributes are not given arguments in this group but can be set inother ways.

To set theproject attribute:

  • provide the argument--region on the command line with a fullyspecified name;
  • set the propertycolab/region with a fully specified name;
  • provide the argument--project on the command line;
  • set the propertycore/project.
--region=REGION
ID of the region or fully qualified identifier for the region.

To set theregion attribute:

  • provide the argument--region on the command line;
  • set the propertycolab/region.
GCLOUD WIDE FLAGS
These flags are available to all commands:--access-token-file,--account,--billing-project,--configuration,--flags-file,--flatten,--format,--help,--impersonate-service-account,--log-http,--project,--quiet,--trace-token,--user-output-enabled,--verbosity.

Run$gcloud help for details.

NOTES
This command is currently in beta and might change without notice. This variantis also available:
gcloudcolabexecutionscreate

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-01-21 UTC.