imjasonh/gcloud-help
1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-18 14:56:05 +00:00
Code Activity

gcloud: Wed Nov 13 10:04:10 UTC 2024

Browse source
This commit is contained in:
Automated 2024-11-13 10:04:10 +00:00
parent 7da5872e5c
commit a63704a3af
252 changed files with 4821 additions and 807 deletions
Download patch file Download diff file Expand all files Collapse all files

187
gcloud/colab/executions/create Normal file
View file

@ -0,0 +1,187 @@
NAME
gcloud colab executions create - create an execution
SYNOPSIS
gcloud 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
Create 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 name
my-execution, compute configured from runtime template
my-runtime-template-id, running with service account
my-service-account@my-project.iam.gserviceaccount.com, with results
uploaded to Cloud Storage bucket gs://my-bucket/results, and in region
us-central1 run:
$ gcloud colab 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.gserviceacco\
unt.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 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 project attribute:
▸ provide the argument --notebook-runtime-template on the command
line with a fully specified name;
▸ provide the argument --project on the command line;
▸ set the property core/project.
To set the region attribute:
▸ provide the argument --notebook-runtime-template on the command
line with a fully specified name;
▸ provide the argument --region on the command line;
▸ set the property colab/region.
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 name attribute:
▫ provide the argument --notebook-runtime-template on the command
line.
--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 project attribute:
◇ provide the argument --dataform-repository-name on the command
line with a fully specified name;
◇ provide the argument --project on the command line;
◇ set the property core/project.
To set the region attribute:
◇ provide the argument --dataform-repository-name on the command
line with a fully specified name;
◇ provide the argument --region on the command line;
◇ set the property colab/region.
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 name attribute:
▹ provide the argument --dataform-repository-name on the
command line.
--commit-sha=COMMIT_SHA
The commit SHA to read from the Dataform repository. If unset,
the file will be read from HEAD.
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.
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 in other ways.
To set the project attribute:
◆ provide the argument --region on the command line with a fully
specified name;
◆ set the property colab/region with a fully specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
--region=REGION
ID of the region or fully qualified identifier for the region.
To set the region attribute:
▸ provide the argument --region on the command line;
▸ set the property colab/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 variant is also available:
$ gcloud beta colab executions create

66
gcloud/colab/executions/delete Normal file
View file

@ -0,0 +1,66 @@
NAME
gcloud colab executions delete - delete an execution
SYNOPSIS
gcloud colab executions delete (EXECUTION : --region=REGION) [--async]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Delete a Colab Enterprise notebook execution.
EXAMPLES
To delete an execution with id my-execution, in region us-central1, run:
$ gcloud colab executions delete my-execution --region=us-central1
POSITIONAL ARGUMENTS
Notebook execution job resource - Unique resource name of the execution to
delete. The arguments in this group can be used to specify the attributes
of this resource. (NOTE) Some attributes are not given arguments in this
group but can be set in other ways.
To set the project attribute:
◆ provide the argument execution on the command line with a fully
specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
This must be specified.
EXECUTION
ID of the notebook execution job or fully qualified identifier for
the notebook execution job.
To set the name attribute:
▸ provide the argument execution on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--region=REGION
Cloud region for the notebook execution job.
To set the region attribute:
▸ provide the argument execution on the command line with a fully
specified name;
▸ provide the argument --region on the command line;
▸ set the property colab/region.
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 help for details.
NOTES
This variant is also available:
$ gcloud beta colab executions delete

62
gcloud/colab/executions/describe Normal file
View file

@ -0,0 +1,62 @@
NAME
gcloud colab executions describe - describe an execution
SYNOPSIS
gcloud colab executions describe (EXECUTION : --region=REGION)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Describe a Colab Enterprise notebook execution.
EXAMPLES
To describe a notebook execution with id my-execution in region
us-central1, run:
$ gcloud colab executions describe my-execution --region=us-central1
POSITIONAL ARGUMENTS
Notebook execution job resource - Unique resource name of the execution to
describe. The arguments in this group can be used to specify the
attributes of this resource. (NOTE) Some attributes are not given
arguments in this group but can be set in other ways.
To set the project attribute:
◆ provide the argument execution on the command line with a fully
specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
This must be specified.
EXECUTION
ID of the notebook execution job or fully qualified identifier for
the notebook execution job.
To set the name attribute:
▸ provide the argument execution on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--region=REGION
Cloud region for the notebook execution job.
To set the region attribute:
▸ provide the argument execution on the command line with a fully
specified name;
▸ provide the argument --region on the command line;
▸ set the property colab/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 variant is also available:
$ gcloud beta colab executions describe

35
gcloud/colab/executions/help Normal file
View file

@ -0,0 +1,35 @@
NAME
gcloud colab executions - manage Colab Enterprise notebook execution jobs
SYNOPSIS
gcloud colab executions COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
For more information about executions, see
https://cloud.google.com/colab/docs/schedule-notebook-run.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
create
Create an execution.
delete
Delete an execution.
describe
Describe an execution.
list
List your Colab Enterprise notebook execution jobs.
NOTES
This variant is also available:
$ gcloud beta colab executions

81
gcloud/colab/executions/list Normal file
View file

@ -0,0 +1,81 @@
NAME
gcloud colab executions list - list your Colab Enterprise notebook
execution jobs
SYNOPSIS
gcloud colab executions list [--region=REGION] [--filter=EXPRESSION]
[--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
List your project's Colab Enterprise notebook executions in a given region.
EXAMPLES
To list your executions in region us-central1, run:
$ gcloud colab executions list --region=us-central1
FLAGS
Region resource - Cloud region for which to list all executions. 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 project attribute:
◆ provide the argument --region on the command line with a fully
specified name;
◆ set the property colab/region with a fully specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
--region=REGION
ID of the region or fully qualified identifier for the region.
To set the region attribute:
▸ provide the argument --region on the command line;
▸ set the property colab/region.
LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filter EXPRESSION to each resource item to be listed.
If the expression evaluates True, then that item is listed. For more
details and examples of filter expressions, run $ gcloud topic filters.
This flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--limit=LIMIT
Maximum number of resources to list. The default is unlimited. This
flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--page-size=PAGE_SIZE
Some services group resource list output into pages. This flag
specifies the maximum number of resources per page. The default is
determined by the service if it supports paging, otherwise it is
unlimited (no paging). Paging may be applied before or after --filter
and --limit depending on the service.
--sort-by=[FIELD,...]
Comma-separated list of resource field key names to sort by. The
default order is ascending. Prefix a field with ``~'' for descending
order on that field. This flag interacts with other flags that are
applied in this order: --flatten, --sort-by, --filter, --limit.
--uri
Print a list of resource URIs instead of the default output, and change
the command output to a list of URIs. If this flag is used with
--format, the formatting is applied on this URI list. To display URIs
alongside other keys instead, use the uri() transform.
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 variant is also available:
$ gcloud beta colab executions list