gcloud: Wed Jul 20 08:59:31 UTC 2022

gcloud/alpha/batch/help

@@ -0,0 +1,31 @@
+NAME
+    gcloud alpha batch - manage Batch resources
+
+SYNOPSIS
+    gcloud alpha batch GROUP [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (ALPHA) Manage Batch resources.
+
+GCLOUD WIDE FLAGS
+    These flags are available to all commands: --help.
+
+    Run $ gcloud help for details.
+
+GROUPS
+    GROUP is one of the following:
+
+     jobs
+        (ALPHA) Manage Batch job resources.
+
+     tasks
+        (ALPHA) Manage Batch task resources.
+
+NOTES
+    This command is currently in alpha and might change without notice. If this
+    command fails with API permission errors despite specifying the correct
+    project, you might be trying to access an API with an invitation-only early
+    access allowlist. This variant is also available:
+
+        $ gcloud beta batch
+

gcloud/alpha/batch/jobs/delete

@@ -0,0 +1,61 @@
+NAME
+    gcloud alpha batch jobs delete - delete a job
+
+SYNOPSIS
+    gcloud alpha batch jobs delete (JOB : --location=LOCATION)
+        [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (ALPHA) This command can fail for the following reasons:
+      ▪ The job specified does not exist.
+      ▪ The active account does not have permission to delete the given job.
+
+EXAMPLES
+    To delete the job with name projects/foo/locations/us-central1/jobs/bar,
+    run:
+
+        $ gcloud alpha batch jobs delete \
+            projects/foo/locations/us-central1/jobs/bar
+
+POSITIONAL ARGUMENTS
+     Job resource - The Batch job resource. 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 JOB 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.
+
+       JOB
+          ID of the job or fully qualified identifier for the job. To set the
+          job attribute:
+          ▸ provide the argument JOB on the command line.
+
+          This positional must be specified if any of the other arguments in
+          this group are specified.
+
+       --location=LOCATION
+          Google Cloud location for the job. To set the location attribute:
+          ▸ provide the argument JOB on the command line with a fully
+            specified name;
+          ▸ provide the argument --location on the command line.
+
+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 alpha and might change without notice. If this
+    command fails with API permission errors despite specifying the correct
+    project, you might be trying to access an API with an invitation-only early
+    access allowlist. This variant is also available:
+
+        $ gcloud beta batch jobs delete
+

gcloud/alpha/batch/jobs/describe

@@ -0,0 +1,61 @@
+NAME
+    gcloud alpha batch jobs describe - show details of a job
+
+SYNOPSIS
+    gcloud alpha batch jobs describe (JOB : --location=LOCATION)
+        [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (ALPHA) This command can fail for the following reasons:
+      ▪ The job specified does not exist.
+      ▪ The active account does not have permission to access the given job.
+
+EXAMPLES
+    To print details of the job with name
+    projects/foo/locations/us-central1/jobs/bar, run:
+
+        $ gcloud alpha batch jobs describe \
+            projects/foo/locations/us-central1/jobs/bar
+
+POSITIONAL ARGUMENTS
+     Job resource - The Batch job resource. 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 JOB 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.
+
+       JOB
+          ID of the job or fully qualified identifier for the job. To set the
+          job attribute:
+          ▸ provide the argument JOB on the command line.
+
+          This positional must be specified if any of the other arguments in
+          this group are specified.
+
+       --location=LOCATION
+          Google Cloud location for the job. To set the location attribute:
+          ▸ provide the argument JOB on the command line with a fully
+            specified name;
+          ▸ provide the argument --location on the command line.
+
+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 alpha and might change without notice. If this
+    command fails with API permission errors despite specifying the correct
+    project, you might be trying to access an API with an invitation-only early
+    access allowlist. This variant is also available:
+
+        $ gcloud beta batch jobs describe
+

gcloud/alpha/batch/jobs/help

@@ -0,0 +1,37 @@
+NAME
+    gcloud alpha batch jobs - manage Batch job resources
+
+SYNOPSIS
+    gcloud alpha batch jobs COMMAND [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (ALPHA) Manage Batch job resources.
+
+GCLOUD WIDE FLAGS
+    These flags are available to all commands: --help.
+
+    Run $ gcloud help for details.
+
+COMMANDS
+    COMMAND is one of the following:
+
+     delete
+        (ALPHA) Delete a job.
+
+     describe
+        (ALPHA) Show details of a job.
+
+     list
+        (ALPHA) List jobs for a specified Batch project/location.
+
+     submit
+        (ALPHA) Submit a Batch job.
+
+NOTES
+    This command is currently in alpha and might change without notice. If this
+    command fails with API permission errors despite specifying the correct
+    project, you might be trying to access an API with an invitation-only early
+    access allowlist. This variant is also available:
+
+        $ gcloud beta batch jobs
+

gcloud/alpha/batch/jobs/list

@@ -0,0 +1,78 @@
+NAME
+    gcloud alpha batch jobs list - list jobs for a specified Batch
+        project/location
+
+SYNOPSIS
+    gcloud alpha batch jobs list LOCATION [--filter=EXPRESSION] [--limit=LIMIT]
+        [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (ALPHA) This command can fail for the following reasons:
+      ▪ The project/location specified do not exist.
+      ▪ The active account does not have permission to access the given
+        project/location.
+
+EXAMPLES
+    To print all the jobs under projects/location
+    projects/foo/locations/us-central1, run:
+
+        $ gcloud alpha batch jobs list projects/foo/locations/us-central1
+
+POSITIONAL ARGUMENTS
+     Location resource - The Batch location resource. 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 LOCATION 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.
+
+       LOCATION
+          ID of the location or fully qualified identifier for the location. To
+          set the location attribute:
+          ▸ provide the argument LOCATION on the command line.
+
+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.
+
+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 alpha and might change without notice. If this
+    command fails with API permission errors despite specifying the correct
+    project, you might be trying to access an API with an invitation-only early
+    access allowlist. This variant is also available:
+
+        $ gcloud beta batch jobs list
+

gcloud/alpha/batch/jobs/submit

@@ -0,0 +1,131 @@
+NAME
+    gcloud alpha batch jobs submit - submit a Batch job
+
+SYNOPSIS
+    gcloud alpha batch jobs submit (JOB : --location=LOCATION)
+        (--config=CONFIG --container-commands-file=CONTAINER_COMMANDS_FILE
+          --container-entrypoint=CONTAINER_ENTRYPOINT
+          --container-image-uri=CONTAINER_IMAGE_URI
+          | --script-file-path=SCRIPT_FILE_PATH | --script-text=SCRIPT_TEXT)
+        [--machine-type=MACHINE_TYPE] [--priority=PRIORITY]
+        [--provisioning-model=PROVISIONING_MODEL]
+        [--network=NETWORK --subnetwork=SUBNETWORK] [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (ALPHA) This command can fail for the following reasons:
+      ▪ The active account does not have permission to create the Batch job.
+
+EXAMPLES
+    To submit the job with config.json sample config file and name
+    projects/foo/locations/us-central1/jobs/bar, run:
+
+        $ gcloud alpha batch jobs submit \
+            projects/foo/locations/us-central1/jobs/bar --config=config.json
+
+POSITIONAL ARGUMENTS
+     Job resource - The Batch job resource. 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 JOB 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.
+
+       JOB
+          ID of the job or fully qualified identifier for the job. To set the
+          job attribute:
+          ▸ provide the argument JOB on the command line.
+
+          This positional must be specified if any of the other arguments in
+          this group are specified.
+
+       --location=LOCATION
+          Google Cloud location for the job. To set the location attribute:
+          ▸ provide the argument JOB on the command line with a fully
+            specified name;
+          ▸ provide the argument --location on the command line.
+
+REQUIRED FLAGS
+     At least one of these must be specified:
+
+       --config=CONFIG
+          The JSON file of the job config.
+
+       Either specify the config file for the job or the first runnable in the
+       task spec. Specify either a script file or container arguments for the
+       first runnable in the task spec.
+
+       At most one of these can be specified:
+
+         Options to specify the container arguments for the first runnable in
+         the task spec.
+
+           --container-commands-file=CONTAINER_COMMANDS_FILE
+              Overrides the CMD specified in the container. If there is an
+              ENTRYPOINT (either in the container image or with the entrypoint
+              field below) then commands are appended as arguments to the
+              ENTRYPOINT.
+
+           --container-entrypoint=CONTAINER_ENTRYPOINT
+              Overrides the ENTRYPOINT specified in the container.
+
+           --container-image-uri=CONTAINER_IMAGE_URI
+              The URI to pull the container image from.
+
+         Either specify a path to a script file to run or provide inline text
+         to execute directly.
+
+         At most one of these can be specified:
+
+           --script-file-path=SCRIPT_FILE_PATH
+              Path to script file to run as first runnable in task spec. File
+              path should be a valid path on the instance volume.
+
+           --script-text=SCRIPT_TEXT
+              Text to run as first runnable in task spec.
+
+OPTIONAL FLAGS
+     --machine-type=MACHINE_TYPE
+        Specify the Compute Engine machine type, for example, e2-standard-4.
+        Currently only one machine type is supported.
+
+     --priority=PRIORITY
+        Job priority [0-99] 0 is the lowest priority.
+
+     --provisioning-model=PROVISIONING_MODEL
+        Specify the allowed provisioning model for the compute instances.
+        PROVISIONING_MODEL must be one of:
+
+         SPOT
+            The SPOT VM provisioning model. Ideal for fault-tolerant workloads
+            that can withstand preemption.
+         STANDARD
+            The STANDARD VM provisioning model
+
+     --network=NETWORK
+        The URL for the network resource. Must specify subnetwork as well if
+        network is specified
+
+     --subnetwork=SUBNETWORK
+        The URL for the subnetwork resource. Must specify network as well if
+        subnetwork is specified
+
+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 alpha and might change without notice. If this
+    command fails with API permission errors despite specifying the correct
+    project, you might be trying to access an API with an invitation-only early
+    access allowlist. This variant is also available:
+
+        $ gcloud beta batch jobs submit
+

gcloud/alpha/batch/tasks/describe

@@ -0,0 +1,75 @@
+NAME
+    gcloud alpha batch tasks describe - show details of a task
+
+SYNOPSIS
+    gcloud alpha batch tasks describe
+        (TASK : --job=JOB --location=LOCATION --task_group=TASK_GROUP)
+        [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (ALPHA) This command can fail for the following reasons:
+      ▪ The task specified does not exist.
+      ▪ The active account does not have permission to access the given task.
+
+EXAMPLES
+    To print details of the task with name
+    projects/foo/locations/us-central1/jobs/bar/taskGroups/group0/tasks/0, run:
+
+        $ gcloud alpha batch tasks describe \
+            projects/foo/locations/us-central1/jobs/bar/taskGroups/group0/\
+        tasks/0
+
+POSITIONAL ARGUMENTS
+     Task resource - The Batch task resource. 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 TASK 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.
+
+       TASK
+          ID of the task or fully qualified identifier for the task. To set the
+          task attribute:
+          ▸ provide the argument TASK on the command line.
+
+          This positional must be specified if any of the other arguments in
+          this group are specified.
+
+       --job=JOB
+          The job ID for the task. To set the job attribute:
+          ▸ provide the argument TASK on the command line with a fully
+            specified name;
+          ▸ provide the argument --job on the command line.
+
+       --location=LOCATION
+          Google Cloud location for the task. To set the location attribute:
+          ▸ provide the argument TASK on the command line with a fully
+            specified name;
+          ▸ provide the argument --location on the command line.
+
+       --task_group=TASK_GROUP
+          The task_group ID for the task. To set the task_group attribute:
+          ▸ provide the argument TASK on the command line with a fully
+            specified name;
+          ▸ provide the argument --task_group on the command line.
+
+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 alpha and might change without notice. If this
+    command fails with API permission errors despite specifying the correct
+    project, you might be trying to access an API with an invitation-only early
+    access allowlist. This variant is also available:
+
+        $ gcloud beta batch tasks describe
+

gcloud/alpha/batch/tasks/help

@@ -0,0 +1,31 @@
+NAME
+    gcloud alpha batch tasks - manage Batch task resources
+
+SYNOPSIS
+    gcloud alpha batch tasks COMMAND [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (ALPHA) Manage Batch task resources.
+
+GCLOUD WIDE FLAGS
+    These flags are available to all commands: --help.
+
+    Run $ gcloud help for details.
+
+COMMANDS
+    COMMAND is one of the following:
+
+     describe
+        (ALPHA) Show details of a task.
+
+     list
+        (ALPHA) List tasks for a specified Batch task_group.
+
+NOTES
+    This command is currently in alpha and might change without notice. If this
+    command fails with API permission errors despite specifying the correct
+    project, you might be trying to access an API with an invitation-only early
+    access allowlist. This variant is also available:
+
+        $ gcloud beta batch tasks
+

gcloud/alpha/batch/tasks/list

@@ -0,0 +1,96 @@
+NAME
+    gcloud alpha batch tasks list - list tasks for a specified Batch task_group
+
+SYNOPSIS
+    gcloud alpha batch tasks list (TASK_GROUP : --job=JOB --location=LOCATION)
+        [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
+        [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (ALPHA) This command can fail for the following reasons:
+      ▪ The task_group specified does not exist.
+      ▪ The active account does not have permission to access the given
+        task_group.
+
+EXAMPLES
+    To print all tasks under the task_group with name
+    projects/foo/locations/us-central1/jobs/bar/taskGroups/group0, run:
+
+        $ gcloud alpha batch tasks list \
+            projects/foo/locations/us-central1/jobs/bar/taskGroups/group0
+
+POSITIONAL ARGUMENTS
+     Task group resource - The Batch task_group resource. 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 TASK_GROUP 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.
+
+       TASK_GROUP
+          ID of the task_group or fully qualified identifier for the
+          task_group. To set the task_group attribute:
+          ▸ provide the argument TASK_GROUP on the command line.
+
+          This positional must be specified if any of the other arguments in
+          this group are specified.
+
+       --job=JOB
+          The job ID for the task_group. To set the job attribute:
+          ▸ provide the argument TASK_GROUP on the command line with a fully
+            specified name;
+          ▸ provide the argument --job on the command line.
+
+       --location=LOCATION
+          Google Cloud location for the task_group. To set the location
+          attribute:
+          ▸ provide the argument TASK_GROUP on the command line with a fully
+            specified name;
+          ▸ provide the argument --location on the command line.
+
+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.
+
+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 alpha and might change without notice. If this
+    command fails with API permission errors despite specifying the correct
+    project, you might be trying to access an API with an invitation-only early
+    access allowlist. This variant is also available:
+
+        $ gcloud beta batch tasks list
+