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

gcloud/colab/runtimes/create

@@ -0,0 +1,111 @@
+NAME
+    gcloud colab runtimes create - create a notebook runtime
+
+SYNOPSIS
+    gcloud colab runtimes create --display-name=DISPLAY_NAME
+        --runtime-template=RUNTIME_TEMPLATE [--async]
+        [--description=DESCRIPTION] [--labels=[KEY=VALUE,...]]
+        [--region=REGION] [--runtime-id=RUNTIME_ID]
+        [--runtime-user=RUNTIME_USER] [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    Create a notebook runtime that can be used to run code from your notebook
+    (IPYNB file).
+
+EXAMPLES
+    To create a runtime in region 'us-central1' with the display name
+    'my-runtime' and template with id 'my-template', run:
+
+        $ gcloud colab runtimes create --region=us-central1 \
+            --display-name=my-runtime --runtime-template=my-template
+
+    To create a runtime for user 'USER@DOMAIN.COM', run:
+
+        $ gcloud colab runtimes create --runtime-user=USER@DOMAIN.COM \
+            --region=us-central1 --display-name=my-runtime \
+            --runtime-template=my-template
+
+REQUIRED FLAGS
+     --display-name=DISPLAY_NAME
+        The display name of the runtime to create.
+
+     Runtime template resource - Unique name of the runtime template to
+     configure the runtime with. This was optionally provided by setting
+     --runtime-template-id in the create runtime-template command, or was
+     system-generated if unspecified. 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 --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 --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.
+
+       --runtime-template=RUNTIME_TEMPLATE
+          ID of the runtime template or fully qualified identifier for the
+          runtime template.
+
+          To set the name attribute:
+          ▸ provide the argument --runtime-template on the command line.
+
+OPTIONAL FLAGS
+     --async
+        Return immediately, without waiting for the operation in progress to
+        complete.
+
+     --description=DESCRIPTION
+        The description
+
+     --labels=[KEY=VALUE,...]
+        Add labels to identify and group the runtime template.
+
+     Region resource - Cloud region to create runtime. Please see
+     https://cloud.google.com/colab/docs/locations for a list of supported
+     regions. 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.
+
+     --runtime-id=RUNTIME_ID
+        The id of the runtime to create. If not specified, a random id will be
+        generated.
+
+     --runtime-user=RUNTIME_USER
+        User email for the runtime owner. Runtimes can only be used by the
+        owner. If a user is not provided, the gcloud user will be assumed to be
+        the owner. The user cannot be a service account.
+
+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 runtimes create
+

gcloud/colab/runtimes/delete

@@ -0,0 +1,66 @@
+NAME
+    gcloud colab runtimes delete - delete a runtime
+
+SYNOPSIS
+    gcloud colab runtimes delete (RUNTIME : --region=REGION) [--async]
+        [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    Delete a Colab Enterprise notebook runtime.
+
+EXAMPLES
+    To delete a runtime with id 'my-runtime' in region 'us-central1', run:
+
+        $ gcloud colab runtimes delete my-runtime --region=us-central1
+
+POSITIONAL ARGUMENTS
+     Runtime resource - Unique name of the runtime to delete. This was
+     optionally provided by setting --runtime-id in the create runtime command,
+     or was system-generated if unspecified. 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 runtime 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.
+
+       RUNTIME
+          ID of the runtime or fully qualified identifier for the runtime.
+
+          To set the name attribute:
+          ▸ provide the argument runtime 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 runtime.
+
+          To set the region attribute:
+          ▸ provide the argument runtime 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 runtimes delete
+

gcloud/colab/runtimes/describe

@@ -0,0 +1,61 @@
+NAME
+    gcloud colab runtimes describe - describe a runtime
+
+SYNOPSIS
+    gcloud colab runtimes describe (RUNTIME : --region=REGION)
+        [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    Describe a Colab Enterprise notebook runtime.
+
+EXAMPLES
+    To describe a runtime with id 'my-runtime' in region 'us-central1', run:
+
+        $ gcloud colab runtimes describe my-runtime --region=us-central1
+
+POSITIONAL ARGUMENTS
+     Runtime resource - Unique name of the runtime to describe. This was
+     optionally provided by setting --runtime-id in the create runtime command,
+     or was system-generated if unspecified. 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 runtime 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.
+
+       RUNTIME
+          ID of the runtime or fully qualified identifier for the runtime.
+
+          To set the name attribute:
+          ▸ provide the argument runtime 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 runtime.
+
+          To set the region attribute:
+          ▸ provide the argument runtime 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 runtimes describe
+

gcloud/colab/runtimes/help

@@ -0,0 +1,41 @@
+NAME
+    gcloud colab runtimes - manage Colab Enterprise runtimes
+
+SYNOPSIS
+    gcloud colab runtimes COMMAND [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    For more information about runtimes, see
+    https://cloud.google.com/colab/docs/runtimes#runtimes
+
+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 a notebook runtime.
+
+     delete
+        Delete a runtime.
+
+     describe
+        Describe a runtime.
+
+     list
+        List your project's runtimes.
+
+     start
+        Start a stopped runtime.
+
+     upgrade
+        Upgrade a runtime.
+
+NOTES
+    This variant is also available:
+
+        $ gcloud beta colab runtimes
+

gcloud/colab/runtimes/list

@@ -0,0 +1,81 @@
+NAME
+    gcloud colab runtimes list - list your project's runtimes
+
+SYNOPSIS
+    gcloud colab runtimes 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 runtimes in a given region.
+
+EXAMPLES
+    To list your runtimes in region 'us-central1', run:
+
+        $ gcloud colab runtimes list --region=us-central1
+
+FLAGS
+     Region resource - Cloud region for which to list all runtimes. Please see
+     https://cloud.google.com/colab/docs/locations for a list of supported
+     regions. 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 runtimes list
+

gcloud/colab/runtimes/start

@@ -0,0 +1,66 @@
+NAME
+    gcloud colab runtimes start - start a stopped runtime
+
+SYNOPSIS
+    gcloud colab runtimes start (RUNTIME : --region=REGION) [--async]
+        [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    Start a stopped Colab Enterprise notebook runtime.
+
+EXAMPLES
+    To start a runtime with id 'my-runtime' in region 'us-central1', run:
+
+        $ gcloud colab runtimes start my-runtime --region=us-central1
+
+POSITIONAL ARGUMENTS
+     Runtime resource - Unique name of the runtime to start. This was
+     optionally provided by setting --runtime-id in the create runtime command,
+     or was system-generated if unspecified. 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 runtime 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.
+
+       RUNTIME
+          ID of the runtime or fully qualified identifier for the runtime.
+
+          To set the name attribute:
+          ▸ provide the argument runtime 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 runtime.
+
+          To set the region attribute:
+          ▸ provide the argument runtime 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 runtimes start
+

gcloud/colab/runtimes/upgrade

@@ -0,0 +1,66 @@
+NAME
+    gcloud colab runtimes upgrade - upgrade a runtime
+
+SYNOPSIS
+    gcloud colab runtimes upgrade (RUNTIME : --region=REGION) [--async]
+        [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    Upgrade a Colab Enterprise notebook runtime.
+
+EXAMPLES
+    To upgrade a runtime with id 'my-runtime' in region 'us-central1', run:
+
+        $ gcloud colab runtimes upgrade my-runtime --region=us-central1
+
+POSITIONAL ARGUMENTS
+     Runtime resource - Unique name of the runtime to upgrade. This was
+     optionally provided by setting --runtime-id in the create runtime command,
+     or was system-generated if unspecified. 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 runtime 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.
+
+       RUNTIME
+          ID of the runtime or fully qualified identifier for the runtime.
+
+          To set the name attribute:
+          ▸ provide the argument runtime 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 runtime.
+
+          To set the region attribute:
+          ▸ provide the argument runtime 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 runtimes upgrade
+