- NAME
-
- gcloud beta notebook-executor executions create - create an execution of a Colab Enterprise notebook
- SYNOPSIS
-
-
gcloud beta notebook-executor executions create--region=REGION(--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] [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
-
(BETA)Creates a notebook execution to be used on a Colab Enterprise runtime. - EXAMPLES
-
To create an execution of a notebook file with Cloud Storage URI
gs://my-bucket/my-notebook.ipynb, with an execution job display namemy-execution, compute configured from runtime templatemy-runtime-template-id, running with service accountmy-service-account@my-project.iam.gserviceaccount.com, with results uploaded to Cloud Storage bucketgs://my-bucket/results, and in regionus-central1run:gcloud beta notebook-executor executions create --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
-
-
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 in
other ways.
To set the
projectattribute:-
provide the argument
--regionon the command line with a fully specified name; -
provide the argument
--projecton the command line; -
set the property
core/project.
This must be specified.
--region=REGION-
ID of the region or fully qualified identifier for the region.
To set the
regionattribute:-
provide the argument
--regionon the command line.
-
provide the argument
-
provide the argument
-
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 group are 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 group are specified.
-
Notebook runtime template resource - The runtime template specifying the compute
configuration for the notebook execution. The runtime template should be in the
same region as the execution. This represents a Cloud resource. (NOTE) Some
attributes are not given arguments in this group but can be set in other ways.
To set the
projectattribute:-
provide the argument
--notebook-runtime-templateon the command line with a fully specified name; -
provide the argument
--projecton the command line; -
set the property
core/project.
To set the
regionattribute:-
provide the argument
--notebook-runtime-templateon the command line with a fully specified name; -
provide the argument
--regionon the command line.
This must be specified.
--notebook-runtime-template=NOTEBOOK_RUNTIME_TEMPLATE-
ID of the notebook runtime template or fully qualified identifier for the
notebook runtime template.
To set the
nameattribute:-
provide the argument
--notebook-runtime-templateon the command line.
-
provide the argument
-
provide the argument
--execution-timeout=EXECUTION_TIMEOUT; default="24h"- The max running time of the execution job, as a duration. See '$ gcloud topic datetimes' for details 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 .ipynb
file or can be set to
-to read content from stdin. -
The Dataform repository containing the notebook. Any notebook created from the
Colab UI is automatically stored in a Dataform repository. The repository name
can be found via the Dataform API by listing repositories in the same project
and region as the notebook.
-
Dataform repository resource - Unique name of the Dataform repository to source
input notebook from. This represents a Cloud resource. (NOTE) Some attributes
are not given arguments in this group but can be set in other ways.
To set the
projectattribute:-
provide the argument
--dataform-repository-nameon the command line with a fully specified name; -
provide the argument
--projecton the command line; -
set the property
core/project.
To set the
regionattribute:-
provide the argument
--dataform-repository-nameon the command line with a fully specified name; -
provide the argument
--regionon the command line.
This must be specified.
--dataform-repository-name=DATAFORM_REPOSITORY_NAME-
ID of the dataform repository or fully qualified identifier for the dataform
repository.
To set the
nameattribute:-
provide the argument
--dataform-repository-nameon the command line.
-
provide the argument
-
provide the argument
--commit-sha=COMMIT_SHA- The commit SHA to read from the Dataform repository. If unset, the file will be read from HEAD.
-
Dataform repository resource - Unique name of the Dataform repository to source
input notebook from. This represents a Cloud resource. (NOTE) Some attributes
are not given arguments in this group but can be set in other ways.
-
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 group are specified.
--generation=GENERATION- The version of the Cloud Storage object to read. If unset, the current version of 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 runtime template to have end user credentials enabled.
-
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 in
other ways.
- OPTIONAL FLAGS
-
--async- Return immediately, without waiting for the operation in progress to complete.
- 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 helpfor details. - NOTES
- This command is currently in beta and might change without notice.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-01 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
{"lastModified": "Last updated 2024-10-01 UTC."}
[[["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 2024-10-01 UTC."]]