diff --git a/gcloud/_version b/gcloud/_version index 2283ac060..6e12724ce 100644 --- a/gcloud/_version +++ b/gcloud/_version @@ -1,8 +1,8 @@ -Google Cloud SDK 404.0.0 -alpha 2022.09.23 -beta 2022.09.23 +Google Cloud SDK 405.0.0 +alpha 2022.09.30 +beta 2022.09.30 bq 2.0.78 bundled-python3-unix 3.9.12 -core 2022.09.23 +core 2022.09.30 gcloud-crc32c 1.0.0 gsutil 5.14 diff --git a/gcloud/alpha/alloydb/instances/create-secondary b/gcloud/alpha/alloydb/instances/create-secondary new file mode 100644 index 000000000..9448cca2e --- /dev/null +++ b/gcloud/alpha/alloydb/instances/create-secondary @@ -0,0 +1,50 @@ +NAME + gcloud alpha alloydb instances create-secondary - creates a new AlloyDB + secondary instance within a given cluster + +SYNOPSIS + gcloud alpha alloydb instances create-secondary INSTANCE --cluster=CLUSTER + --region=REGION [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Creates a new AlloyDB secondary instance within a given cluster. + +EXAMPLES + To create a new secondary instance, run: + + $ gcloud alpha alloydb instances create-secondary my-instance \ + --cluster=my-cluster --region=us-central1 + +POSITIONAL ARGUMENTS + INSTANCE + AlloyDB instance ID + +REQUIRED FLAGS + --cluster=CLUSTER + AlloyDB cluster ID + + --region=REGION + Regional location (e.g. asia-east1, us-east1). See the full list of + regions at https://cloud.google.com/sql/docs/instance-locations. + +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 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 alloydb instances create-secondary + diff --git a/gcloud/alpha/alloydb/instances/help b/gcloud/alpha/alloydb/instances/help index def1ada99..d666d05c2 100644 --- a/gcloud/alpha/alloydb/instances/help +++ b/gcloud/alpha/alloydb/instances/help @@ -20,6 +20,10 @@ COMMANDS create (ALPHA) Creates a new AlloyDB instance within a given cluster. + create-secondary + (ALPHA) Creates a new AlloyDB secondary instance within a given + cluster. + delete (ALPHA) Deletes an AlloyDB instance within a given cluster. diff --git a/gcloud/alpha/batch/help b/gcloud/alpha/batch/help index 6b07f0ea7..c6b1f31a5 100644 --- a/gcloud/alpha/batch/help +++ b/gcloud/alpha/batch/help @@ -33,7 +33,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud batch $ gcloud beta batch diff --git a/gcloud/alpha/batch/jobs/delete b/gcloud/alpha/batch/jobs/delete index 2a2106577..2179ab3bd 100644 --- a/gcloud/alpha/batch/jobs/delete +++ b/gcloud/alpha/batch/jobs/delete @@ -57,7 +57,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud batch jobs delete $ gcloud beta batch jobs delete diff --git a/gcloud/alpha/batch/jobs/describe b/gcloud/alpha/batch/jobs/describe index e2939aa40..1f3c776a4 100644 --- a/gcloud/alpha/batch/jobs/describe +++ b/gcloud/alpha/batch/jobs/describe @@ -57,7 +57,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud batch jobs describe $ gcloud beta batch jobs describe diff --git a/gcloud/alpha/batch/jobs/help b/gcloud/alpha/batch/jobs/help index 82701c183..9ab8ac37e 100644 --- a/gcloud/alpha/batch/jobs/help +++ b/gcloud/alpha/batch/jobs/help @@ -39,7 +39,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud batch jobs $ gcloud beta batch jobs diff --git a/gcloud/alpha/batch/jobs/list b/gcloud/alpha/batch/jobs/list index dc8437b1c..5ba5eff17 100644 --- a/gcloud/alpha/batch/jobs/list +++ b/gcloud/alpha/batch/jobs/list @@ -81,7 +81,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud batch jobs list $ gcloud beta batch jobs list diff --git a/gcloud/alpha/batch/jobs/submit b/gcloud/alpha/batch/jobs/submit index 6534576d9..afcac72be 100644 --- a/gcloud/alpha/batch/jobs/submit +++ b/gcloud/alpha/batch/jobs/submit @@ -151,7 +151,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud batch jobs submit $ gcloud beta batch jobs submit diff --git a/gcloud/alpha/batch/tasks/describe b/gcloud/alpha/batch/tasks/describe index 330b43b18..b1371d2ba 100644 --- a/gcloud/alpha/batch/tasks/describe +++ b/gcloud/alpha/batch/tasks/describe @@ -71,7 +71,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud batch tasks describe $ gcloud beta batch tasks describe diff --git a/gcloud/alpha/batch/tasks/help b/gcloud/alpha/batch/tasks/help index caef66a93..8064a7d14 100644 --- a/gcloud/alpha/batch/tasks/help +++ b/gcloud/alpha/batch/tasks/help @@ -33,7 +33,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud batch tasks $ gcloud beta batch tasks diff --git a/gcloud/alpha/batch/tasks/list b/gcloud/alpha/batch/tasks/list index d28be402f..aafe41fb6 100644 --- a/gcloud/alpha/batch/tasks/list +++ b/gcloud/alpha/batch/tasks/list @@ -88,7 +88,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud batch tasks list $ gcloud beta batch tasks list diff --git a/gcloud/alpha/bigtable/instances/tables/create b/gcloud/alpha/bigtable/instances/tables/create index e8d2f0328..ee6799d3f 100644 --- a/gcloud/alpha/bigtable/instances/tables/create +++ b/gcloud/alpha/bigtable/instances/tables/create @@ -6,7 +6,7 @@ SYNOPSIS gcloud alpha bigtable instances tables create (TABLE : --instance=INSTANCE) --column-families=[COLUMN_FAMILIES,...] [--change-stream-retention-period=CHANGE_STREAM_RETENTION_PERIOD] - [--splits=[SPLITS,...]] [GCLOUD_WIDE_FLAG ...] + [--deletion-protection] [--splits=[SPLITS,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Create a new Cloud Bigtable table. @@ -45,6 +45,20 @@ EXAMPLES --column-families="my-family:maxage=10d" \ --change-stream-retention-period=7d + To create a deletion-protected table my-table in instance my-instance with + a column family my-family, run: + + $ gcloud alpha bigtable instances tables create my-table \ + --instance=my-instance --column-families="my-family" \ + --deletion-protection + + To create a table my-table without deletion protection in instance + my-instance with a column family my-family, run: + + $ gcloud alpha bigtable instances tables create my-table \ + --instance=my-instance --column-families="my-family" \ + --no-deletion-protection + POSITIONAL ARGUMENTS Table resource - Cloud Bigtable table to create. The arguments in this group can be used to specify the attributes of this resource. (NOTE) Some @@ -85,6 +99,9 @@ OPTIONAL FLAGS kept and should be in the range of [1 day, 7 days]. For example: 5d or 48h + --deletion-protection + Once specified, the table is deletion protected. + --splits=[SPLITS,...] Row keys where the table should initially be split. For example: car,key diff --git a/gcloud/alpha/bigtable/instances/tables/delete b/gcloud/alpha/bigtable/instances/tables/delete new file mode 100644 index 000000000..757f08234 --- /dev/null +++ b/gcloud/alpha/bigtable/instances/tables/delete @@ -0,0 +1,61 @@ +NAME + gcloud alpha bigtable instances tables delete - delete a Cloud Bigtable + table + +SYNOPSIS + gcloud alpha bigtable instances tables delete (TABLE : --instance=INSTANCE) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Delete a Cloud Bigtable table. + +EXAMPLES + To delete the table my-table in instance my-instance, run: + + $ gcloud alpha bigtable instances tables delete my-table \ + --instance=my-instance + +POSITIONAL ARGUMENTS + Table resource - Cloud Bigtable table 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 table 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. + + TABLE + ID of the table or fully qualified identifier for the table. To set + the table attribute: + ▸ provide the argument table on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --instance=INSTANCE + Name of the Cloud Bigtable instance. To set the instance attribute: + ▸ provide the argument table on the command line with a fully + specified name; + ▸ provide the argument --instance 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. + +API REFERENCE + This command uses the bigtableadmin/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/bigtable/ + +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. + diff --git a/gcloud/alpha/bigtable/instances/tables/help b/gcloud/alpha/bigtable/instances/tables/help index d536582bd..0bba87331 100644 --- a/gcloud/alpha/bigtable/instances/tables/help +++ b/gcloud/alpha/bigtable/instances/tables/help @@ -28,6 +28,9 @@ COMMANDS create (ALPHA) Create a new Cloud Bigtable table. + delete + (ALPHA) Delete a Cloud Bigtable table. + describe (ALPHA) Retrieve information about a table. @@ -49,6 +52,9 @@ COMMANDS undelete (ALPHA) Undelete a previously deleted Cloud Bigtable table. + update + (ALPHA) Update an existing Cloud Bigtable table. + NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct diff --git a/gcloud/alpha/bigtable/instances/tables/update b/gcloud/alpha/bigtable/instances/tables/update new file mode 100644 index 000000000..423370d1c --- /dev/null +++ b/gcloud/alpha/bigtable/instances/tables/update @@ -0,0 +1,71 @@ +NAME + gcloud alpha bigtable instances tables update - update an existing Cloud + Bigtable table + +SYNOPSIS + gcloud alpha bigtable instances tables update (TABLE : --instance=INSTANCE) + [--deletion-protection] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Update an existing new Cloud Bigtable table with the specified + configuration. + +EXAMPLES + To enable deletion protection, run: + + $ gcloud alpha bigtable instances tables update my-table \ + --instance=my-instance --deletion-protection + + To disable deletion protection, run: + + $ gcloud alpha bigtable instances tables update my-table \ + --instance=my-instance --no-deletion-protection + +POSITIONAL ARGUMENTS + Table resource - Cloud Bigtable table to update. 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 table 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. + + TABLE + ID of the table or fully qualified identifier for the table. To set + the table attribute: + ▸ provide the argument table on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --instance=INSTANCE + Name of the Cloud Bigtable instance. To set the instance attribute: + ▸ provide the argument table on the command line with a fully + specified name; + ▸ provide the argument --instance on the command line. + +FLAGS + --deletion-protection + Once specified, the table is deletion protected. + +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. + +API REFERENCE + This command uses the bigtableadmin/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/bigtable/ + +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. + diff --git a/gcloud/alpha/certificate-manager/trust-configs/delete b/gcloud/alpha/certificate-manager/trust-configs/delete index dfebdae1c..3a9aa216b 100644 --- a/gcloud/alpha/certificate-manager/trust-configs/delete +++ b/gcloud/alpha/certificate-manager/trust-configs/delete @@ -3,7 +3,8 @@ NAME SYNOPSIS gcloud alpha certificate-manager trust-configs delete - (TRUST_CONFIG : --location=LOCATION) [--async] [GCLOUD_WIDE_FLAG ...] + (TRUST_CONFIG : --location=LOCATION) [--async] [--etag=ETAG] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Delete the specified TrustConfig. @@ -40,6 +41,10 @@ FLAGS Return immediately, without waiting for the operation in progress to complete. + --etag=ETAG + The current etag of the asset. If an etag is provided and does not + match the current etag of the asset, the deletion will be blocked. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/alpha/compute/disks/create b/gcloud/alpha/compute/disks/create index 7f564629b..b7354172f 100644 --- a/gcloud/alpha/compute/disks/create +++ b/gcloud/alpha/compute/disks/create @@ -123,8 +123,7 @@ FLAGS --provisioned-iops=PROVISIONED_IOPS Provisioned IOPS of pd-extreme disk to create. Only for use with disks of type pd-extreme. If specified, the value must be in the range - between 10000 and 120000. If not specified, the default value is - 100000. + between 2500 and 120000. If not specified, the default value is 100000. --provisioned-throughput=PROVISIONED_THROUGHPUT Provisioned throughput of disk to create. The throughput unit is MB per diff --git a/gcloud/alpha/compute/images/import b/gcloud/alpha/compute/images/import index 40a2105a6..9d53ec648 100644 --- a/gcloud/alpha/compute/images/import +++ b/gcloud/alpha/compute/images/import @@ -257,12 +257,13 @@ OPTIONAL FLAGS rhel-6, rhel-6-byol, rhel-7, rhel-7-byol, rhel-8, rhel-8-byol, rocky-8, sles-12, sles-12-byol, sles-15, sles-15-byol, sles-sap-12, sles-sap-12-byol, sles-sap-15, sles-sap-15-byol, ubuntu-1404, - ubuntu-1604, ubuntu-1804, ubuntu-2004, windows-10-x64-byol, - windows-10-x86-byol, windows-2008r2, windows-2008r2-byol, - windows-2012, windows-2012-byol, windows-2012r2, windows-2012r2-byol, - windows-2016, windows-2016-byol, windows-2019, windows-2019-byol, - windows-2022, windows-2022-byol, windows-7-x64-byol, - windows-7-x86-byol, windows-8-x64-byol, windows-8-x86-byol. + ubuntu-1604, ubuntu-1804, ubuntu-2004, ubuntu-2204, + windows-10-x64-byol, windows-10-x86-byol, windows-11-x64-byol, + windows-2008r2, windows-2008r2-byol, windows-2012, windows-2012-byol, + windows-2012r2, windows-2012r2-byol, windows-2016, windows-2016-byol, + windows-2019, windows-2019-byol, windows-2022, windows-2022-byol, + windows-7-x64-byol, windows-7-x86-byol, windows-8-x64-byol, + windows-8-x86-byol. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/alpha/compute/instance-templates/create b/gcloud/alpha/compute/instance-templates/create index f07e0361a..0820de88c 100644 --- a/gcloud/alpha/compute/instance-templates/create +++ b/gcloud/alpha/compute/instance-templates/create @@ -144,15 +144,15 @@ FLAGS you to override how the source-instance's disks are defined in the template. + device-name + Name of the device for which the configuration is being overridden. + auto-delete If true, this persistent disk will be automatically deleted when - the instance is deleted. However, if the disk is later detached - from the instance, this option won't apply. If not provided, the - setting is copied from the source instance. Allowed values of the - flag are: false, no, true, and yes. - - device-name - Name of the device. + the instance is deleted. However, if the disk is detached from the + instance, this option won't apply. If not provided, the setting is + copied from the source instance. Allowed values of the flag are: + false, no, true, and yes. instantiate-from Specifies whether to include the disk and which image to use. Valid diff --git a/gcloud/alpha/compute/instances/import b/gcloud/alpha/compute/instances/import index 604cfdfa1..87ac44bc2 100644 --- a/gcloud/alpha/compute/instances/import +++ b/gcloud/alpha/compute/instances/import @@ -169,12 +169,13 @@ OPTIONAL FLAGS rhel-6, rhel-6-byol, rhel-7, rhel-7-byol, rhel-8, rhel-8-byol, rocky-8, sles-12, sles-12-byol, sles-15, sles-15-byol, sles-sap-12, sles-sap-12-byol, sles-sap-15, sles-sap-15-byol, ubuntu-1404, - ubuntu-1604, ubuntu-1804, ubuntu-2004, windows-10-x64-byol, - windows-10-x86-byol, windows-2008r2, windows-2008r2-byol, windows-2012, - windows-2012-byol, windows-2012r2, windows-2012r2-byol, windows-2016, - windows-2016-byol, windows-2019, windows-2019-byol, windows-2022, - windows-2022-byol, windows-7-x64-byol, windows-7-x86-byol, - windows-8-x64-byol, windows-8-x86-byol. + ubuntu-1604, ubuntu-1804, ubuntu-2004, ubuntu-2204, + windows-10-x64-byol, windows-10-x86-byol, windows-11-x64-byol, + windows-2008r2, windows-2008r2-byol, windows-2012, windows-2012-byol, + windows-2012r2, windows-2012r2-byol, windows-2016, windows-2016-byol, + windows-2019, windows-2019-byol, windows-2022, windows-2022-byol, + windows-7-x64-byol, windows-7-x86-byol, windows-8-x64-byol, + windows-8-x86-byol. --private-network-ip=PRIVATE_NETWORK_IP Specifies the RFC1918 IP to assign to the instance. The IP should be in diff --git a/gcloud/alpha/compute/machine-images/import b/gcloud/alpha/compute/machine-images/import index 2ca6e631b..e62f0cffc 100644 --- a/gcloud/alpha/compute/machine-images/import +++ b/gcloud/alpha/compute/machine-images/import @@ -162,12 +162,13 @@ OPTIONAL FLAGS rhel-6, rhel-6-byol, rhel-7, rhel-7-byol, rhel-8, rhel-8-byol, rocky-8, sles-12, sles-12-byol, sles-15, sles-15-byol, sles-sap-12, sles-sap-12-byol, sles-sap-15, sles-sap-15-byol, ubuntu-1404, - ubuntu-1604, ubuntu-1804, ubuntu-2004, windows-10-x64-byol, - windows-10-x86-byol, windows-2008r2, windows-2008r2-byol, windows-2012, - windows-2012-byol, windows-2012r2, windows-2012r2-byol, windows-2016, - windows-2016-byol, windows-2019, windows-2019-byol, windows-2022, - windows-2022-byol, windows-7-x64-byol, windows-7-x86-byol, - windows-8-x64-byol, windows-8-x86-byol. + ubuntu-1604, ubuntu-1804, ubuntu-2004, ubuntu-2204, + windows-10-x64-byol, windows-10-x86-byol, windows-11-x64-byol, + windows-2008r2, windows-2008r2-byol, windows-2012, windows-2012-byol, + windows-2012r2, windows-2012r2-byol, windows-2016, windows-2016-byol, + windows-2019, windows-2019-byol, windows-2022, windows-2022-byol, + windows-7-x64-byol, windows-7-x86-byol, windows-8-x64-byol, + windows-8-x86-byol. --restart-on-failure The VMs created from the imported machine image are restarted if they diff --git a/gcloud/alpha/container/aws/clusters/update b/gcloud/alpha/container/aws/clusters/update index 4fcef8c66..62d633494 100644 --- a/gcloud/alpha/container/aws/clusters/update +++ b/gcloud/alpha/container/aws/clusters/update @@ -21,7 +21,7 @@ SYNOPSIS [--clear-security-group-ids | --security-group-ids=[SECURITY_GROUP_ID,...]] [--clear-ssh-ec2-key-pair | --ssh-ec2-key-pair=SSH_EC2_KEY_PAIR] - [GCLOUD_WIDE_FLAG ...] + [--clear-tags | --tags=TAG,[TAG,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Update an Anthos cluster on AWS. @@ -177,6 +177,20 @@ FLAGS Name of the EC2 key pair authorized to login to the control plane's nodes. + Tags + + At most one of these can be specified: + + --clear-tags + Clear any tags associated with the control plane's nodes. + + --tags=TAG,[TAG,...] + Applies the given tags (comma separated) on the control plane. + Example: + + $ gcloud alpha container aws clusters update EXAMPLE_CONTROL_PLANE \ + --tags=tag1=one,tag2=two + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/alpha/dataplex/tasks/create b/gcloud/alpha/dataplex/tasks/create index 9128c4547..1ec419e8e 100644 --- a/gcloud/alpha/dataplex/tasks/create +++ b/gcloud/alpha/dataplex/tasks/create @@ -7,7 +7,16 @@ SYNOPSIS : --execution-args=EXECUTION_ARGS --execution-project=EXECUTION_PROJECT --kms-key=KMS_KEY --max-job-execution-lifetime=MAX_JOB_EXECUTION_LIFETIME) - ((--spark-main-class=SPARK_MAIN_CLASS + ([--notebook=NOTEBOOK + : --notebook-archive-uris=[NOTEBOOK_ARCHIVE_URIS,...] + --notebook-file-uris=[NOTEBOOK_FILE_URIS,...] + --notebook-batch-executors-count=NOTEBOOK_BATCH_EXECUTORS_COUNT + --notebook-batch-max-executors-count=NOTEBOOK_BATCH_MAX_EXECUTORS_COUNT --notebook-container-image=NOTEBOOK_CONTAINER_IMAGE --notebook-container-image-java-jars=[NOTEBOOK_CONTAINER_IMAGE_JAVA_JARS, + ...] + --notebook-container-image-properties=NOTEBOOK_CONTAINER_IMAGE_PROPERTIES --notebook-vpc-network-tags=[NOTEBOOK_VPC_NETWORK_TAGS, + ...] --notebook-vpc-network-name=NOTEBOOK_VPC_NETWORK_NAME + | --notebook-vpc-sub-network-name=NOTEBOOK_VPC_SUB_NETWORK_NAME] + | [(--spark-main-class=SPARK_MAIN_CLASS | --spark-main-jar-file-uri=SPARK_MAIN_JAR_FILE_URI | --spark-python-script-file=SPARK_PYTHON_SCRIPT_FILE | --spark-sql-script=SPARK_SQL_SCRIPT @@ -22,7 +31,7 @@ SYNOPSIS --container-image-python-packages=[CONTAINER_IMAGE_PYTHON_PACKAGES, ...] --vpc-network-tags=[VPC_NETWORK_TAGS,...] --vpc-network-name=VPC_NETWORK_NAME - | --vpc-sub-network-name=VPC_SUB_NETWORK_NAME) + | --vpc-sub-network-name=VPC_SUB_NETWORK_NAME]) (--trigger-type=TRIGGER_TYPE : --trigger-disabled --trigger-max-retires=TRIGGER_MAX_RETIRES --trigger-schedule=TRIGGER_SCHEDULE @@ -142,91 +151,158 @@ REQUIRED FLAGS --max-job-execution-lifetime=MAX_JOB_EXECUTION_LIFETIME The maximum duration before the job execution expires. - Config related to running custom Spark tasks. - - At least one of these must be specified: - - --spark-archive-uris=[SPARK_ARCHIVE_URIS,...] - Google Cloud Storage URIs of archives to be extracted into the - working directory of each executor. Supported file types: .jar, .tar, - .tar.gz, .tgz, and .zip. - - --spark-file-uris=[SPARK_FILE_URIS,...] - Google Cloud Storage URIs of files to be placed in the working - directory of each executor. - - The specification of the main method to call to drive the job. Specify - either the jar file that contains the main class or the main class name. + Select which task you want to schedule and provide the required arguments + for the task. The 2 types of tasks supported are:- + ◆ spark tasks + ◆ notebook tasks Exactly one of these must be specified: - --spark-main-class=SPARK_MAIN_CLASS - The name of the driver's main class. The jar file that contains - the class must be in the default CLASSPATH or specified in - jar_file_uris. The execution args are passed in as a sequence of - named process arguments (--key=value). + Config related to running custom notebook tasks. - --spark-main-jar-file-uri=SPARK_MAIN_JAR_FILE_URI - The Google Cloud Storage URI of the jar file that contains the - main class. The execution args are passed in as a sequence of - named process arguments (--key=value). + --notebook=NOTEBOOK + Path to input notebook. This can be the Google Cloud Storage URI of + the notebook file or the path to a Notebook Content. The execution + args are accessible as environment variables (TASK_key=value). - --spark-python-script-file=SPARK_PYTHON_SCRIPT_FILE - The Google Cloud Storage URI of the main Python file to use as - the driver. Must be a .py file. + This flag argument must be specified if any of the other arguments + in this group are specified. - --spark-sql-script=SPARK_SQL_SCRIPT - The SQL query text. + --notebook-archive-uris=[NOTEBOOK_ARCHIVE_URIS,...] + Google Cloud Storage URIs of archives to be extracted into the + working directory of each executor. Supported file types: .jar, + .tar, .tar.gz, .tgz, and .zip. - --spark-sql-script-file=SPARK_SQL_SCRIPT_FILE - A reference to a query file. This can be the Google Cloud Storage - URI of the query file or it can the path to a SqlScript Content. + --notebook-file-uris=[NOTEBOOK_FILE_URIS,...] + Google Cloud Storage URIs of files to be placed in the working + directory of each executor. - Compute resources needed for a Task when using Dataproc Serverless. + Compute resources needed for a Task when using Dataproc Serverless. - --batch-executors-count=BATCH_EXECUTORS_COUNT - Total number of job executors. + --notebook-batch-executors-count=NOTEBOOK_BATCH_EXECUTORS_COUNT + Total number of job executors. - --batch-max-executors-count=BATCH_MAX_EXECUTORS_COUNT - Max configurable executors. If max_executors_count > - executors_count, then auto-scaling is enabled. + --notebook-batch-max-executors-count=NOTEBOOK_BATCH_MAX_EXECUTORS_COUNT + Max configurable executors. If max_executors_count > + executors_count, then auto-scaling is enabled. - Container Image Runtime Configuration. + Container Image Runtime Configuration. - --container-image=CONTAINER_IMAGE - Optional custom container image for the job. + --notebook-container-image=NOTEBOOK_CONTAINER_IMAGE + Optional custom container image for the job. - --container-image-java-jars=[CONTAINER_IMAGE_JAVA_JARS,...] - A list of Java JARS to add to the classpath. Valid input includes - Cloud Storage URIs to Jar binaries. For example, - gs://bucket-name/my/path/to/file.jar + --notebook-container-image-java-jars=[NOTEBOOK_CONTAINER_IMAGE_JAVA_JARS,...] + A list of Java JARS to add to the classpath. Valid input includes + Cloud Storage URIs to Jar binaries. For example, + gs://bucket-name/my/path/to/file.jar - --container-image-properties=CONTAINER_IMAGE_PROPERTIES - The properties to set on daemon config files. Property keys are - specified in prefix:property format, for example - core:hadoop.tmp.dir. For more information, see Cluster properties - (https://cloud.google.com/dataproc/docs/concepts/cluster-properties) + --notebook-container-image-properties=NOTEBOOK_CONTAINER_IMAGE_PROPERTIES + The properties to set on daemon config files. Property keys are + specified in prefix:property format, for example + core:hadoop.tmp.dir. For more information, see Cluster properties + (https://cloud.google.com/dataproc/docs/concepts/cluster-properties) - --container-image-python-packages=[CONTAINER_IMAGE_PYTHON_PACKAGES,...] - A list of python packages to be installed. Valid formats include - Cloud Storage URI to a PIP installable library. For example, - gs://bucket-name/my/path/to/lib.tar.gz + Cloud VPC Network used to run the infrastructure. - Cloud VPC Network used to run the infrastructure. + --notebook-vpc-network-tags=[NOTEBOOK_VPC_NETWORK_TAGS,...] + List of network tags to apply to the job. - --vpc-network-tags=[VPC_NETWORK_TAGS,...] - List of network tags to apply to the job. + The Cloud VPC network identifier. - The Cloud VPC network identifier. + At most one of these can be specified: - At most one of these can be specified: + --notebook-vpc-network-name=NOTEBOOK_VPC_NETWORK_NAME + The Cloud VPC network in which the job is run. By default, the + Cloud VPC network named Default within the project is used. - --vpc-network-name=VPC_NETWORK_NAME - The Cloud VPC network in which the job is run. By default, the - Cloud VPC network named Default within the project is used. + --notebook-vpc-sub-network-name=NOTEBOOK_VPC_SUB_NETWORK_NAME + The Cloud VPC sub-network in which the job is run. - --vpc-sub-network-name=VPC_SUB_NETWORK_NAME - The Cloud VPC sub-network in which the job is run. + Config related to running custom Spark tasks. + + --spark-archive-uris=[SPARK_ARCHIVE_URIS,...] + Google Cloud Storage URIs of archives to be extracted into the + working directory of each executor. Supported file types: .jar, + .tar, .tar.gz, .tgz, and .zip. + + --spark-file-uris=[SPARK_FILE_URIS,...] + Google Cloud Storage URIs of files to be placed in the working + directory of each executor. + + The specification of the main method to call to drive the job. Specify + either the jar file that contains the main class or the main class + name. + + Exactly one of these must be specified: + + --spark-main-class=SPARK_MAIN_CLASS + The name of the driver's main class. The jar file that contains + the class must be in the default CLASSPATH or specified in + jar_file_uris. The execution args are passed in as a sequence + of named process arguments (--key=value). + + --spark-main-jar-file-uri=SPARK_MAIN_JAR_FILE_URI + The Google Cloud Storage URI of the jar file that contains the + main class. The execution args are passed in as a sequence of + named process arguments (--key=value). + + --spark-python-script-file=SPARK_PYTHON_SCRIPT_FILE + The Google Cloud Storage URI of the main Python file to use as + the driver. Must be a .py file. + + --spark-sql-script=SPARK_SQL_SCRIPT + The SQL query text. + + --spark-sql-script-file=SPARK_SQL_SCRIPT_FILE + A reference to a query file. This can be the Google Cloud + Storage URI of the query file or it can the path to a SqlScript + Content. + + Compute resources needed for a Task when using Dataproc Serverless. + + --batch-executors-count=BATCH_EXECUTORS_COUNT + Total number of job executors. + + --batch-max-executors-count=BATCH_MAX_EXECUTORS_COUNT + Max configurable executors. If max_executors_count > + executors_count, then auto-scaling is enabled. + + Container Image Runtime Configuration. + + --container-image=CONTAINER_IMAGE + Optional custom container image for the job. + + --container-image-java-jars=[CONTAINER_IMAGE_JAVA_JARS,...] + A list of Java JARS to add to the classpath. Valid input includes + Cloud Storage URIs to Jar binaries. For example, + gs://bucket-name/my/path/to/file.jar + + --container-image-properties=CONTAINER_IMAGE_PROPERTIES + The properties to set on daemon config files. Property keys are + specified in prefix:property format, for example + core:hadoop.tmp.dir. For more information, see Cluster properties + (https://cloud.google.com/dataproc/docs/concepts/cluster-properties) + + --container-image-python-packages=[CONTAINER_IMAGE_PYTHON_PACKAGES,...] + A list of python packages to be installed. Valid formats include + Cloud Storage URI to a PIP installable library. For example, + gs://bucket-name/my/path/to/lib.tar.gz + + Cloud VPC Network used to run the infrastructure. + + --vpc-network-tags=[VPC_NETWORK_TAGS,...] + List of network tags to apply to the job. + + The Cloud VPC network identifier. + + At most one of these can be specified: + + --vpc-network-name=VPC_NETWORK_NAME + The Cloud VPC network in which the job is run. By default, the + Cloud VPC network named Default within the project is used. + + --vpc-sub-network-name=VPC_SUB_NETWORK_NAME + The Cloud VPC sub-network in which the job is run. Spec related to Dataplex task scheduling and frequency settings. diff --git a/gcloud/alpha/dataplex/tasks/update b/gcloud/alpha/dataplex/tasks/update index 5007c3460..b89f40f5d 100644 --- a/gcloud/alpha/dataplex/tasks/update +++ b/gcloud/alpha/dataplex/tasks/update @@ -10,7 +10,16 @@ SYNOPSIS --execution-service-account=EXECUTION_SERVICE_ACCOUNT --kms-key=KMS_KEY --max-job-execution-lifetime=MAX_JOB_EXECUTION_LIFETIME] - [--spark-archive-uris=[SPARK_ARCHIVE_URIS,...] + [--notebook=NOTEBOOK + --notebook-archive-uris=[NOTEBOOK_ARCHIVE_URIS,...] + --notebook-file-uris=[NOTEBOOK_FILE_URIS,...] + --notebook-batch-executors-count=NOTEBOOK_BATCH_EXECUTORS_COUNT + --notebook-batch-max-executors-count=NOTEBOOK_BATCH_MAX_EXECUTORS_COUNT --notebook-container-image=NOTEBOOK_CONTAINER_IMAGE --notebook-container-image-java-jars=[NOTEBOOK_CONTAINER_IMAGE_JAVA_JARS, + ...] + --notebook-container-image-properties=NOTEBOOK_CONTAINER_IMAGE_PROPERTIES --notebook-vpc-network-tags=[NOTEBOOK_VPC_NETWORK_TAGS, + ...] --notebook-vpc-network-name=NOTEBOOK_VPC_NETWORK_NAME + | --notebook-vpc-sub-network-name=NOTEBOOK_VPC_SUB_NETWORK_NAME + | --spark-archive-uris=[SPARK_ARCHIVE_URIS,...] --spark-file-uris=[SPARK_FILE_URIS,...] --batch-executors-count=BATCH_EXECUTORS_COUNT --batch-max-executors-count=BATCH_MAX_EXECUTORS_COUNT @@ -20,7 +29,7 @@ SYNOPSIS --container-image-python-packages=[CONTAINER_IMAGE_PYTHON_PACKAGES, ...] --vpc-network-tags=[VPC_NETWORK_TAGS,...] --vpc-network-name=VPC_NETWORK_NAME - | --vpc-sub-network-name=VPC_SUB_NETWORK_NAME + --vpc-sub-network-name=VPC_SUB_NETWORK_NAME --spark-main-class=SPARK_MAIN_CLASS | --spark-main-jar-file-uri=SPARK_MAIN_JAR_FILE_URI | --spark-python-script-file=SPARK_PYTHON_SCRIPT_FILE @@ -150,89 +159,154 @@ FLAGS --max-job-execution-lifetime=MAX_JOB_EXECUTION_LIFETIME The maximum duration before the job execution expires. - Config related to running custom Spark tasks. - - --spark-archive-uris=[SPARK_ARCHIVE_URIS,...] - Google Cloud Storage URIs of archives to be extracted into the - working directory of each executor. Supported file types: .jar, .tar, - .tar.gz, .tgz, and .zip. - - --spark-file-uris=[SPARK_FILE_URIS,...] - Google Cloud Storage URIs of files to be placed in the working - directory of each executor. - - Compute resources needed for a Task when using Dataproc Serverless. - - --batch-executors-count=BATCH_EXECUTORS_COUNT - Total number of job executors. - - --batch-max-executors-count=BATCH_MAX_EXECUTORS_COUNT - Max configurable executors. If max_executors_count > - executors_count, then auto-scaling is enabled. - - Container Image Runtime Configuration. - - --container-image=CONTAINER_IMAGE - Optional custom container image for the job. - - --container-image-java-jars=[CONTAINER_IMAGE_JAVA_JARS,...] - A list of Java JARS to add to the classpath. Valid input includes - Cloud Storage URIs to Jar binaries. For example, - gs://bucket-name/my/path/to/file.jar - - --container-image-properties=CONTAINER_IMAGE_PROPERTIES - Override to common configuration of open source components - installed on the Dataproc cluster. The properties to set on daemon - config files. Property keys are specified in prefix:property - format, for example core:hadoop.tmp.dir. For more information, see - Cluster properties - (https://cloud.google.com/dataproc/docs/concepts/cluster-properties). - - --container-image-python-packages=[CONTAINER_IMAGE_PYTHON_PACKAGES,...] - A list of python packages to be installed. Valid formats include - Cloud Storage URI to a PIP installable library. For example, - gs://bucket-name/my/path/to/lib.tar.gz - - Cloud VPC Network used to run the infrastructure. - - --vpc-network-tags=[VPC_NETWORK_TAGS,...] - List of network tags to apply to the job. - - The Cloud VPC network identifier. - - At most one of these can be specified: - - --vpc-network-name=VPC_NETWORK_NAME - The Cloud VPC network in which the job is run. By default, the - Cloud VPC network named Default within the project is used. - - --vpc-sub-network-name=VPC_SUB_NETWORK_NAME - The Cloud VPC sub-network in which the job is run. - - The specification of the main method to call to drive the job. Specify - either the jar file that contains the main class or the main class name. + Select which task you want to schedule and provide the required + arguments:- + ◆ spark tasks + ◆ notebook tasks At most one of these can be specified: - --spark-main-class=SPARK_MAIN_CLASS - The name of the driver's main class. The jar file that contains - the class must be in the default CLASSPATH or specified in + Config related to running custom Notebook tasks. - --spark-main-jar-file-uri=SPARK_MAIN_JAR_FILE_URI - The Google Cloud Storage URI of the jar file that contains the - main class. The execution args are passed in as a sequence of - named process arguments (--key=value). + --notebook=NOTEBOOK + Google Cloud Storage URIs of the notebook file or the path to a + Notebook Content. Path to input notebook. - --spark-python-script-file=SPARK_PYTHON_SCRIPT_FILE - The Google Cloud Storage URI of the main Python file to use as - the driver. Must be a .py file. + --notebook-archive-uris=[NOTEBOOK_ARCHIVE_URIS,...] + Google Cloud Storage URIs of archives to be extracted into the + working directory of each executor. Supported file types: .jar, + .tar, .tar.gz, .tgz, and .zip. - --spark-sql-script=SPARK_SQL_SCRIPT - The SQL query text. + --notebook-file-uris=[NOTEBOOK_FILE_URIS,...] + Google Cloud Storage URIs of files to be placed in the working + directory of each executor. - --spark-sql-script-file=SPARK_SQL_SCRIPT_FILE - A reference to a query file. This can be the Google Cloud Storage - URI of the query file or it can the path to a SqlScript Content. + Compute resources needed for a Task when using Dataproc Serverless. + + --notebook-batch-executors-count=NOTEBOOK_BATCH_EXECUTORS_COUNT + Total number of job executors. + + --notebook-batch-max-executors-count=NOTEBOOK_BATCH_MAX_EXECUTORS_COUNT + Max configurable executors. If max_executors_count > + executors_count, then auto-scaling is enabled. + + Container Image Runtime Configuration. + + --notebook-container-image=NOTEBOOK_CONTAINER_IMAGE + Optional custom container image for the job. + + --notebook-container-image-java-jars=[NOTEBOOK_CONTAINER_IMAGE_JAVA_JARS,...] + A list of Java JARS to add to the classpath. Valid input includes + Cloud Storage URIs to Jar binaries. For example, + gs://bucket-name/my/path/to/file.jar + + --notebook-container-image-properties=NOTEBOOK_CONTAINER_IMAGE_PROPERTIES + Override to common configuration of open source components + installed on the Dataproc cluster. The properties to set on + daemon config files. Property keys are specified in + prefix:property format, for example core:hadoop.tmp.dir. For more + information, see Cluster properties + (https://cloud.google.com/dataproc/docs/concepts/cluster-properties). + + Cloud VPC Network used to run the infrastructure. + + --notebook-vpc-network-tags=[NOTEBOOK_VPC_NETWORK_TAGS,...] + List of network tags to apply to the job. + + The Cloud VPC network identifier. + + At most one of these can be specified: + + --notebook-vpc-network-name=NOTEBOOK_VPC_NETWORK_NAME + The Cloud VPC network in which the job is run. By default, the + Cloud VPC network named Default within the project is used. + + --notebook-vpc-sub-network-name=NOTEBOOK_VPC_SUB_NETWORK_NAME + The Cloud VPC sub-network in which the job is run. + + Config related to running custom Spark tasks. + + --spark-archive-uris=[SPARK_ARCHIVE_URIS,...] + Google Cloud Storage URIs of archives to be extracted into the + working directory of each executor. Supported file types: .jar, + .tar, .tar.gz, .tgz, and .zip. + + --spark-file-uris=[SPARK_FILE_URIS,...] + Google Cloud Storage URIs of files to be placed in the working + directory of each executor. + + Compute resources needed for a Task when using Dataproc Serverless. + + --batch-executors-count=BATCH_EXECUTORS_COUNT + Total number of job executors. + + --batch-max-executors-count=BATCH_MAX_EXECUTORS_COUNT + Max configurable executors. If max_executors_count > + executors_count, then auto-scaling is enabled. + + Container Image Runtime Configuration. + + --container-image=CONTAINER_IMAGE + Optional custom container image for the job. + + --container-image-java-jars=[CONTAINER_IMAGE_JAVA_JARS,...] + A list of Java JARS to add to the classpath. Valid input includes + Cloud Storage URIs to Jar binaries. For example, + gs://bucket-name/my/path/to/file.jar + + --container-image-properties=CONTAINER_IMAGE_PROPERTIES + Override to common configuration of open source components + installed on the Dataproc cluster. The properties to set on + daemon config files. Property keys are specified in + prefix:property format, for example core:hadoop.tmp.dir. For more + information, see Cluster properties + (https://cloud.google.com/dataproc/docs/concepts/cluster-properties). + + --container-image-python-packages=[CONTAINER_IMAGE_PYTHON_PACKAGES,...] + A list of python packages to be installed. Valid formats include + Cloud Storage URI to a PIP installable library. For example, + gs://bucket-name/my/path/to/lib.tar.gz + + Cloud VPC Network used to run the infrastructure. + + --vpc-network-tags=[VPC_NETWORK_TAGS,...] + List of network tags to apply to the job. + + The Cloud VPC network identifier. + + --vpc-network-name=VPC_NETWORK_NAME + The Cloud VPC network in which the job is run. By default, the + Cloud VPC network named Default within the project is used. + + --vpc-sub-network-name=VPC_SUB_NETWORK_NAME + The Cloud VPC sub-network in which the job is run. + + The specification of the main method to call to drive the job. Specify + either the jar file that contains the main class or the main class + name. + + At most one of these can be specified: + + --spark-main-class=SPARK_MAIN_CLASS + The name of the driver's main class. The jar file that contains + the class must be in the default CLASSPATH or specified in + + --spark-main-jar-file-uri=SPARK_MAIN_JAR_FILE_URI + The Google Cloud Storage URI of the jar file that contains the + main class. The execution args are passed in as a sequence of + named process arguments (--key=value). + + --spark-python-script-file=SPARK_PYTHON_SCRIPT_FILE + The Google Cloud Storage URI of the main Python file to use as + the driver. Must be a .py file. + + --spark-sql-script=SPARK_SQL_SCRIPT + The SQL query text. + + --spark-sql-script-file=SPARK_SQL_SCRIPT_FILE + A reference to a query file. This can be the Google Cloud + Storage URI of the query file or it can the path to a SqlScript + Content. Spec related to how often and when a task should be triggered. diff --git a/gcloud/alpha/firestore/fields/help b/gcloud/alpha/firestore/fields/help index 7fb2ea4e2..8b8e68c27 100644 --- a/gcloud/alpha/firestore/fields/help +++ b/gcloud/alpha/firestore/fields/help @@ -22,7 +22,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud firestore fields $ gcloud beta firestore fields diff --git a/gcloud/alpha/firestore/fields/ttls/help b/gcloud/alpha/firestore/fields/ttls/help index fec14b674..d2ae4a2f4 100644 --- a/gcloud/alpha/firestore/fields/ttls/help +++ b/gcloud/alpha/firestore/fields/ttls/help @@ -26,7 +26,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud firestore fields ttls $ gcloud beta firestore fields ttls diff --git a/gcloud/alpha/firestore/fields/ttls/list b/gcloud/alpha/firestore/fields/ttls/list index 94733c9bd..f192982b1 100644 --- a/gcloud/alpha/firestore/fields/ttls/list +++ b/gcloud/alpha/firestore/fields/ttls/list @@ -92,7 +92,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud firestore fields ttls list $ gcloud beta firestore fields ttls list diff --git a/gcloud/alpha/firestore/fields/ttls/update b/gcloud/alpha/firestore/fields/ttls/update index 43651084b..a32f8d69f 100644 --- a/gcloud/alpha/firestore/fields/ttls/update +++ b/gcloud/alpha/firestore/fields/ttls/update @@ -90,7 +90,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud firestore fields ttls update $ gcloud beta firestore fields ttls update diff --git a/gcloud/alpha/run/deploy b/gcloud/alpha/run/deploy index 12d742ea8..fc40ab996 100644 --- a/gcloud/alpha/run/deploy +++ b/gcloud/alpha/run/deploy @@ -1,5 +1,5 @@ NAME - gcloud alpha run deploy - deploy a container to Cloud Run + gcloud alpha run deploy - create or update a Cloud Run service SYNOPSIS gcloud alpha run deploy [[SERVICE] --namespace=NAMESPACE] @@ -41,7 +41,7 @@ SYNOPSIS | --context=CONTEXT --kubeconfig=KUBECONFIG] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Deploys container images to Google Cloud Run. + (ALPHA) Creates or updates a Cloud Run service. EXAMPLES To deploy a container to the service my-backend on Cloud Run: diff --git a/gcloud/alpha/run/help b/gcloud/alpha/run/help index d2a769367..ddb0c9659 100644 --- a/gcloud/alpha/run/help +++ b/gcloud/alpha/run/help @@ -45,7 +45,7 @@ COMMANDS COMMAND is one of the following: deploy - (ALPHA) Deploy a container to Cloud Run. + (ALPHA) Create or update a Cloud Run service. NOTES This command is currently in alpha and might change without notice. If this diff --git a/gcloud/alpha/run/jobs/deploy b/gcloud/alpha/run/jobs/deploy new file mode 100644 index 000000000..7b7dca8c2 --- /dev/null +++ b/gcloud/alpha/run/jobs/deploy @@ -0,0 +1,205 @@ +NAME + gcloud alpha run jobs deploy - create or update a Cloud Run job + +SYNOPSIS + gcloud alpha run jobs deploy [JOB] [--args=[ARG,...]] + [--binary-authorization=POLICY] [--breakglass=JUSTIFICATION] + [--command=[COMMAND,...]] [--cpu=CPU] [--execute-now] [--key=KEY] + [--labels=[KEY=VALUE,...]] [--max-retries=MAX_RETRIES] + [--memory=MEMORY] [--parallelism=PARALLELISM] [--region=REGION] + [--service-account=SERVICE_ACCOUNT] + [--set-cloudsql-instances=[CLOUDSQL-INSTANCES,...]] + [--set-env-vars=[KEY=VALUE,...]] + [--set-secrets=[KEY=SECRET_NAME:SECRET_VERSION,...]] + [--task-timeout=TASK_TIMEOUT] [--tasks=TASKS; default=1] + [--vpc-connector=VPC_CONNECTOR] [--vpc-egress=VPC_EGRESS] + [--async | --wait] [--image=IMAGE | --source=SOURCE] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Creates or updates a Cloud Run job. + +EXAMPLES + To deploy a new job my-data-transformation to Cloud Run: + + $ gcloud alpha run jobs deploy my-data-transformation \ + --image=us-docker.pkg.dev/project/image + + You may also omit the job name. Then a prompt will be displayed with a + suggested default value: + + $ gcloud alpha run jobs deploy \ + --image=us-docker.pkg.dev/project/image + +POSITIONAL ARGUMENTS + Job resource - Job to deploy. 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 JOB on the command line with a fully specified + name; + ◆ specify the job name from an interactive prompt with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + [JOB] + ID of the Job or fully qualified identifier for the Job. To set the + jobs attribute: + ▸ provide the argument JOB on the command line; + ▸ specify the job name from an interactive prompt. + +FLAGS + --args=[ARG,...] + Comma-separated arguments passed to the command run by the container + image. If not specified and no '--command' is provided, the container + image's default Cmd is used. Otherwise, if not specified, no arguments + are passed. To reset this field to its default, pass an empty string. + + --binary-authorization=POLICY + Binary Authorization policy to check against. This must be set to + "default". + + --breakglass=JUSTIFICATION + Justification to bypass Binary Authorization policy constraints and + allow the operation. See + https://cloud.google.com/binary-authorization/docs/using-breakglass for + more information. + + --command=[COMMAND,...] + Entrypoint for the container image. If not specified, the container + image's default Entrypoint is run. To reset this field to its default, + pass an empty string. + + --cpu=CPU + Set a CPU limit in Kubernetes cpu units. + + Cloud Run (fully managed) supports values 1, 2 and 4. For Cloud Run + (fully managed), 4 cpus also requires a minimum 2Gi --memory value. + Examples 2, 2.0, 2000m + + --execute-now + Execute the job immediately after creation. + + --key=KEY + CMEK key reference to encrypt the container with. + + --labels=[KEY=VALUE,...] + List of label KEY=VALUE pairs to add. + + --max-retries=MAX_RETRIES + Number of times an task is allowed to restart in case of failure before + being failed permanently. This applies per-task, not per-job. If set to + 0, tasks will only run once and never be retried on failure. + + --memory=MEMORY + Set a memory limit. Ex: 1024Mi, 4Gi. + + --parallelism=PARALLELISM + Number of tasks that may run concurrently. Must be less than or equal + to the number of tasks. Set to 0 to unset. + + --region=REGION + Region in which the resource can be found. Alternatively, set the + property [run/region]. + + --service-account=SERVICE_ACCOUNT + Service account associated with the revision of the service. The + service account represents the identity of the running revision, and + determines what permissions the revision has. For the managed platform, + this is the email address of an IAM service account. For the + Kubernetes-based platforms (gke, kubernetes), this is the name of a + Kubernetes service account in the same namespace as the service. If not + provided, the revision will use the default service account of the + project, or default Kubernetes namespace service account respectively. + + --set-cloudsql-instances=[CLOUDSQL-INSTANCES,...] + You can specify a name of a Cloud SQL instance if it's in the same + project and region as your Cloud Run resource; otherwise specify + :: for the instance. + + --set-env-vars=[KEY=VALUE,...] + List of key-value pairs to set as environment variables. + + --set-secrets=[KEY=SECRET_NAME:SECRET_VERSION,...] + Specify secrets to provide as environment variables. For example: + '--set-secrets=ENV=mysecret:latest,OTHER_ENV=othersecret:1' will create + an environment variable named ENV whose value is the latest version of + secret 'mysecret' and an environment variable OTHER_ENV whose value is + version of 1 of secret 'othersecret'. + + --task-timeout=TASK_TIMEOUT + Set the maximum time (deadline) a job task attempt can run for. In the + case of retries, this deadline applies to each attempt of a task. If + the task attempt does not complete within this time, it will be killed. + It is specified as a duration; for example, "10m5s" is ten minutes, and + five seconds. If you don't specify a unit, seconds is assumed. For + example, "10" is 10 seconds. + + --tasks=TASKS; default=1 + Number of tasks that must run to completion for the job to be + considered done. Use this flag to trigger multiple runs of the job. + + --vpc-connector=VPC_CONNECTOR + Set a VPC connector for this resource. + + --vpc-egress=VPC_EGRESS + The outbound traffic to send through the VPC connector for this + resource. This resource must have a VPC connector to set VPC egress. + VPC_EGRESS must be one of: + + all + (DEPRECATED) Sends all outbound traffic through the VPC connector. + Provides the same functionality as 'all-traffic'. Prefer to use + 'all-traffic' instead. + all-traffic + Sends all outbound traffic through the VPC connector. + private-ranges-only + Default option. Sends outbound traffic to private IP addresses + defined by RFC1918 through the VPC connector. + + At most one of these can be specified: + + --async + Return immediately, without waiting for the operation in progress to + complete. + + --wait + Wait until the execution has completed running before exiting. If not + set, gcloud exits successfully when the execution has started. + Implies --execute-now. + + At most one of these can be specified: + + --image=IMAGE + Name of the container image to deploy (e.g. + us-docker.pkg.dev/cloudrun/container/job:latest). + + --source=SOURCE + The location of the source to build. If a Dockerfile is present in + the source code directory, it will be built using that Dockerfile, + otherwise it will use Google Cloud buildpacks. See + https://cloud.google.com/run/docs/deploying-source-code for more + details. The location can be a directory on a local disk or a gzipped + archive file (.tar.gz) in Google Cloud Storage. If the source is a + local directory, this command skips the files specified in the + --ignore-file. If --ignore-file is not specified, use.gcloudignore + file. If a .gcloudignore file is absent and a .gitignore file is + present in the local source directory, gcloud will use a generated + Git-compatible .gcloudignore file that respects your .gitignored + files. The global .gitignore is not respected. For more information + on .gcloudignore, see gcloud topic gcloudignore. + +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. + diff --git a/gcloud/alpha/run/jobs/help b/gcloud/alpha/run/jobs/help index efb9b1fc5..826135eea 100644 --- a/gcloud/alpha/run/jobs/help +++ b/gcloud/alpha/run/jobs/help @@ -42,6 +42,9 @@ COMMANDS delete (ALPHA) Delete a job. + deploy + (ALPHA) Create or update a Cloud Run job. + describe (ALPHA) Obtain details about jobs. diff --git a/gcloud/alpha/run/jobs/replace b/gcloud/alpha/run/jobs/replace index 332ab178f..e889c961c 100644 --- a/gcloud/alpha/run/jobs/replace +++ b/gcloud/alpha/run/jobs/replace @@ -40,5 +40,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud beta run jobs replace diff --git a/gcloud/alpha/spanner/instance-configs/create b/gcloud/alpha/spanner/instance-configs/create new file mode 100644 index 000000000..c067cd434 --- /dev/null +++ b/gcloud/alpha/spanner/instance-configs/create @@ -0,0 +1,177 @@ +NAME + gcloud alpha spanner instance-configs create - create a Cloud Spanner + instance configuration + +SYNOPSIS + gcloud alpha spanner instance-configs create INSTANCE_CONFIG + (--base-config=BASE_CONFIG --replicas=location=LOCATION,type=TYPE:[...] + | [--clone-config=INSTANCE_CONFIG + : --add-replicas=location=LOCATION,type=TYPE:[...] + --skip-replicas=location=LOCATION,type=TYPE:[...]]) [--async] + [--display-name=DISPLAY_NAME] [--etag=ETAG] [--labels=[KEY=VALUE,...]] + [--validate-only] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create a Cloud Spanner instance configuration. + +EXAMPLES + To create a custom Cloud Spanner instance configuration, run: + + $ gcloud alpha spanner instance-configs create \ + custom-instance-config \ + --display-name=custom-instance-config-name --base-config=nam3 \ + --replicas=location=us-east4,type=READ_WRITE:location=us-east4,\ + type=READ_WRITE:location=us-east1,\ + type=READ_WRITE:location=us-east1,\ + type=READ_WRITE:location=us-central1,type=WITNESS + + To create a custom Cloud Spanner instance configuration based on an + existing Google-managed configuration (nam3) by adding a 'READ_ONLY' type + replica in location 'us-east4', run: + + $ gcloud alpha spanner instance-configs create \ + custom-instance-config --clone-config=nam3 \ + --add-replicas=location=us-east4,type=READ_ONLY + + To create a custom Cloud Spanner instance configuration based on an + existing Google-managed configuration (nam3) by adding a 'READ_ONLY' type + replica in location 'us-east4' and removing a 'READ_ONLY' type replica in + location 'us-central1', run: + + $ gcloud alpha spanner instance-configs create \ + custom-instance-config --clone-config=nam3 \ + --add-replicas=location=us-east4,type=READ_ONLY \ + --skip-replicas=location=us-central1,type=READ_ONLY + +POSITIONAL ARGUMENTS + INSTANCE_CONFIG + Cloud Spanner instance configuration. The 'custom-' prefix is required + to avoid name conflicts with Google-managed configurations. + +REQUIRED FLAGS + Exactly one of these must be specified: + + Command-line flags to setup a custom instance configuration replicas: + + --base-config=BASE_CONFIG + The name of the Google-managed instance configuration, based on + which your custom configuration is created. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --replicas=location=LOCATION,type=TYPE:[...] + The geographic placement of nodes in this instance configuration + and their replication types. + + location + The location of the serving resources, e.g. "us-central1". + + type + The type of replica. + + Items in the list are separated by ":". The allowed values and + formats are as follows. + + READ_ONLY + Read-only replicas only support reads (not writes). Read-only + replicas: + + ▫ Maintain a full copy of your data. + + ▫ Serve reads. + + ▫ Do not participate in voting to commit writes. + + ▫ Are not eligible to become a leader. + + READ_WRITE + Read-write replicas support both reads and writes. These replicas: + + ▫ Maintain a full copy of your data. + + ▫ Serve reads. + + ▫ Can vote whether to commit a write. + + ▫ Participate in leadership election. + + ▫ Are eligible to become a leader. + + WITNESS + Witness replicas don't support reads but do participate in voting + to commit writes. Witness replicas: + + ▫ Do not maintain a full copy of data. + + ▫ Do not serve reads. + + ▫ Vote whether to commit writes. + + ▫ Participate in leader election but are not eligible to become + leader. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + Command-line flags to setup a custom instance configuration using clone + options: + + --clone-config=INSTANCE_CONFIG + The ID of the instance config, based on which this configuration is + created. The clone is an independent copy of this config. Available + configurations can be found by running "gcloud spanner + instance-configs list" + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --add-replicas=location=LOCATION,type=TYPE:[...] + Add new replicas while cloning from the source config. + + --skip-replicas=location=LOCATION,type=TYPE:[...] + Skip replicas from the source config while cloning. Each replica in + the list must exist in the source config replicas list. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --display-name=DISPLAY_NAME + The name of this instance configuration as it appears in UIs. Must + specify this option if creating an instance-config with --replicas. + + --etag=ETAG + Used for optimistic concurrency control. + + --labels=[KEY=VALUE,...] + List of label KEY=VALUE pairs to add. + + Keys must start with a lowercase character and contain only hyphens + (-), underscores (_), lowercase characters, and numbers. Values must + contain only hyphens (-), underscores (_), lowercase characters, and + numbers. + + --validate-only + Use this flag to validate that the request will succeed before + executing it. + +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. These variants are also available: + + $ gcloud spanner instance-configs create + + $ gcloud beta spanner instance-configs create + diff --git a/gcloud/alpha/spanner/instance-configs/delete b/gcloud/alpha/spanner/instance-configs/delete new file mode 100644 index 000000000..f34d3be74 --- /dev/null +++ b/gcloud/alpha/spanner/instance-configs/delete @@ -0,0 +1,47 @@ +NAME + gcloud alpha spanner instance-configs delete - delete a Cloud Spanner + instance configuration + +SYNOPSIS + gcloud alpha spanner instance-configs delete INSTANCE_CONFIG [--etag=ETAG] + [--validate-only] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Delete a Cloud Spanner instance configuration. + +EXAMPLES + To delete a custom Cloud Spanner instance configuration, run: + + $ gcloud alpha spanner instance-configs delete custom-instance-config + +POSITIONAL ARGUMENTS + INSTANCE_CONFIG + Cloud Spanner instance config. + +FLAGS + --etag=ETAG + Used for optimistic concurrency control as a way to help prevent + simultaneous deletes of an instance config from overwriting each other. + + --validate-only + Use this flag to validate that the request will succeed before + executing it. + +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. These variants are also available: + + $ gcloud spanner instance-configs delete + + $ gcloud beta spanner instance-configs delete + diff --git a/gcloud/alpha/spanner/instance-configs/describe b/gcloud/alpha/spanner/instance-configs/describe index f864b91f4..eaeb50bbb 100644 --- a/gcloud/alpha/spanner/instance-configs/describe +++ b/gcloud/alpha/spanner/instance-configs/describe @@ -1,13 +1,13 @@ NAME gcloud alpha spanner instance-configs describe - describe a Cloud Spanner - instance config + instance configuration SYNOPSIS gcloud alpha spanner instance-configs describe INSTANCE_CONFIG [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Describe a Cloud Spanner instance config. + (ALPHA) Describe a Cloud Spanner instance configuration. EXAMPLES To describe an instance config named regional-us-central1, run: diff --git a/gcloud/alpha/spanner/instance-configs/help b/gcloud/alpha/spanner/instance-configs/help index 6e4e60e71..ad5f742c0 100644 --- a/gcloud/alpha/spanner/instance-configs/help +++ b/gcloud/alpha/spanner/instance-configs/help @@ -16,11 +16,20 @@ GCLOUD WIDE FLAGS COMMANDS COMMAND is one of the following: + create + (ALPHA) Create a Cloud Spanner instance configuration. + + delete + (ALPHA) Delete a Cloud Spanner instance configuration. + describe - (ALPHA) Describe a Cloud Spanner instance config. + (ALPHA) Describe a Cloud Spanner instance configuration. list - (ALPHA) List the available Cloud Spanner instance configs. + (ALPHA) List the available Cloud Spanner instance configurations. + + update + (ALPHA) Update a Cloud Spanner instance configuration. NOTES This command is currently in alpha and might change without notice. If this diff --git a/gcloud/alpha/spanner/instance-configs/list b/gcloud/alpha/spanner/instance-configs/list index 1f9978a51..a2a5fb03a 100644 --- a/gcloud/alpha/spanner/instance-configs/list +++ b/gcloud/alpha/spanner/instance-configs/list @@ -1,6 +1,6 @@ NAME gcloud alpha spanner instance-configs list - list the available Cloud - Spanner instance configs + Spanner instance configurations SYNOPSIS gcloud alpha spanner instance-configs list [--filter=EXPRESSION] @@ -8,7 +8,7 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) List the available Cloud Spanner instance configs. + (ALPHA) List the available Cloud Spanner instance configurations. EXAMPLES To list the Cloud Spanner instance configs that are availble for this diff --git a/gcloud/alpha/spanner/instance-configs/update b/gcloud/alpha/spanner/instance-configs/update new file mode 100644 index 000000000..37c657c54 --- /dev/null +++ b/gcloud/alpha/spanner/instance-configs/update @@ -0,0 +1,107 @@ +NAME + gcloud alpha spanner instance-configs update - update a Cloud Spanner + instance configuration + +SYNOPSIS + gcloud alpha spanner instance-configs update INSTANCE_CONFIG [--async] + [--display-name=DISPLAY_NAME] [--etag=ETAG] + [--update-labels=[KEY=VALUE,...]] [--validate-only] + [--clear-labels | --remove-labels=[KEY,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Update a Cloud Spanner instance configuration. + +EXAMPLES + To update display name of a custom Cloud Spanner instance configuration + 'custom-instance-config', run: + + $ gcloud alpha spanner instance-configs update \ + custom-instance-config --display-name=nam3-RO-us-central1 + + To modify the instance config 'custom-instance-config' by adding label + 'k0', with value 'value1' and label 'k1' with value 'value2' and removing + labels with key 'k3', run: + + $ gcloud alpha spanner instance-configs update \ + custom-instance-config --update-labels=k0=value1,k1=value2 \ + --remove-labels=k3 + + To clear all labels of a custom Cloud Spanner instance configuration + 'custom-instance-config', run: + + $ gcloud alpha spanner instance-configs update \ + custom-instance-config --clear-labels + + To remove an existing label of a custom Cloud Spanner instance + configuration 'custom-instance-config', run: + + $ gcloud alpha spanner instance-configs update \ + custom-instance-config --remove-labels=KEY1,KEY2 + +POSITIONAL ARGUMENTS + INSTANCE_CONFIG + Cloud Spanner instance config. The 'custom-' prefix is required to + avoid name conflicts with Google-managed configurations. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --display-name=DISPLAY_NAME + The name of this instance configuration as it appears in UIs. + + --etag=ETAG + Used for optimistic concurrency control. + + --update-labels=[KEY=VALUE,...] + List of label KEY=VALUE pairs to update. If a label exists, its value + is modified. Otherwise, a new label is created. + + Keys must start with a lowercase character and contain only hyphens + (-), underscores (_), lowercase characters, and numbers. Values must + contain only hyphens (-), underscores (_), lowercase characters, and + numbers. + + --validate-only + Use this flag to validate that the request will succeed before + executing it. + + At most one of these can be specified: + + --clear-labels + Remove all labels. If --update-labels is also specified then + --clear-labels is applied first. + + For example, to remove all labels: + + $ gcloud alpha spanner instance-configs update --clear-labels + + To remove all existing labels and create two new labels, foo and baz: + + $ gcloud alpha spanner instance-configs update --clear-labels \ + --update-labels foo=bar,baz=qux + + --remove-labels=[KEY,...] + List of label keys to remove. If a label does not exist it is + silently ignored. If --update-labels is also specified then + --update-labels is applied first. + +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. These variants are also available: + + $ gcloud spanner instance-configs update + + $ gcloud beta spanner instance-configs update + diff --git a/gcloud/alpha/spanner/operations/cancel b/gcloud/alpha/spanner/operations/cancel index 76fc0f7f1..00df74d06 100644 --- a/gcloud/alpha/spanner/operations/cancel +++ b/gcloud/alpha/spanner/operations/cancel @@ -36,7 +36,7 @@ REQUIRED FLAGS The ID of the instance the operation is executing on. --instance-config=INSTANCE_CONFIG - The ID of the instance config the operation is executing on. + The ID of the instance configuration the operation is executing on. OPTIONAL FLAGS --backup=BACKUP diff --git a/gcloud/alpha/spanner/operations/describe b/gcloud/alpha/spanner/operations/describe index 49639784d..60cd8afda 100644 --- a/gcloud/alpha/spanner/operations/describe +++ b/gcloud/alpha/spanner/operations/describe @@ -37,7 +37,7 @@ REQUIRED FLAGS The ID of the instance the operation is executing on. --instance-config=INSTANCE_CONFIG - The ID of the instance config the operation is executing on. + The ID of the instance configuration the operation is executing on. OPTIONAL FLAGS --backup=BACKUP diff --git a/gcloud/alpha/spanner/operations/help b/gcloud/alpha/spanner/operations/help index b947b7949..ca3db6391 100644 --- a/gcloud/alpha/spanner/operations/help +++ b/gcloud/alpha/spanner/operations/help @@ -23,7 +23,7 @@ COMMANDS list (ALPHA) List the Cloud Spanner operations on the given instance or - database or instance-config. + database or instance configuration. NOTES This command is currently in alpha and might change without notice. If this diff --git a/gcloud/alpha/spanner/operations/list b/gcloud/alpha/spanner/operations/list index 06d755270..e8a74691b 100644 --- a/gcloud/alpha/spanner/operations/list +++ b/gcloud/alpha/spanner/operations/list @@ -1,6 +1,6 @@ NAME gcloud alpha spanner operations list - list the Cloud Spanner operations on - the given instance or database or instance-config + the given instance or database or instance configuration SYNOPSIS gcloud alpha spanner operations list @@ -11,7 +11,7 @@ SYNOPSIS DESCRIPTION (ALPHA) List the Cloud Spanner operations on the given instance or database - or instance-config. + or instance configuration. EXAMPLES To list Cloud Spanner instance operations for an instance, run: @@ -51,7 +51,7 @@ REQUIRED FLAGS The ID of the instance the operation is executing on. --instance-config=INSTANCE_CONFIG - The ID of the instance config the operation is executing on. + The ID of the instance configuration the operation is executing on. FLAGS --backup=BACKUP @@ -92,11 +92,11 @@ FLAGS Returns instance operations for the given instance. Note, type=INSTANCE does not work with --database or --backup. INSTANCE_CONFIG_CREATE - Instance config create operations are returned for the given - instance config (--instance-config). + Instance configuration create operations are returned for the given + instance configuration (--instance-config). INSTANCE_CONFIG_UPDATE - Instance config update operations are returned for the given - instance config (--instance-config). + Instance configuration update operations are returned for the given + instance configuration (--instance-config). LIST COMMAND FLAGS --filter=EXPRESSION diff --git a/gcloud/alpha/sql/instances/create b/gcloud/alpha/sql/instances/create index 891b20bf3..f73e8daa4 100644 --- a/gcloud/alpha/sql/instances/create +++ b/gcloud/alpha/sql/instances/create @@ -44,7 +44,7 @@ SYNOPSIS [--root-password=ROOT_PASSWORD] [--[no-]storage-auto-increase] [--storage-auto-increase-limit=STORAGE_AUTO_INCREASE_LIMIT] [--storage-size=STORAGE_SIZE] [--storage-type=STORAGE_TYPE] - [--tier=TIER, -t TIER] + [--tier=TIER, -t TIER] [--time-zone=TIME_ZONE] [--disk-encryption-key=DISK_ENCRYPTION_KEY : --disk-encryption-key-keyring=DISK_ENCRYPTION_KEY_KEYRING --disk-encryption-key-location=DISK_ENCRYPTION_KEY_LOCATION @@ -379,6 +379,9 @@ FLAGS --memory flags. Learn more about how CPU and memory affects pricing: https://cloud.google.com/sql/pricing. + --time-zone=TIME_ZONE + Set a non-default time zone. Only available for SQL Server instances. + Key resource - The Cloud KMS (Key Management Service) cryptokey that will be used to protect the instance. The 'Compute Engine Service Agent' service account must hold permission 'Cloud KMS CryptoKey diff --git a/gcloud/alpha/storage/buckets/notifications/delete b/gcloud/alpha/storage/buckets/notifications/delete index 739edbd6e..8fc350a9a 100644 --- a/gcloud/alpha/storage/buckets/notifications/delete +++ b/gcloud/alpha/storage/buckets/notifications/delete @@ -22,7 +22,7 @@ EXAMPLES example-bucket: $ gcloud alpha storage buckets notifications delete \ - b/example-bucket/notificationConfigs/3 + projects/_/buckets/example-bucket/notificationConfigs/3 Delete all notification configurations in the bucket example-bucket: diff --git a/gcloud/alpha/storage/buckets/notifications/describe b/gcloud/alpha/storage/buckets/notifications/describe index 4b6d8cd3e..3252bc846 100644 --- a/gcloud/alpha/storage/buckets/notifications/describe +++ b/gcloud/alpha/storage/buckets/notifications/describe @@ -15,7 +15,7 @@ EXAMPLES example-bucket: $ gcloud alpha storage buckets notifications describe \ - b/example-bucket/notificationConfigs/3 + projects/_/buckets/example-bucket/notificationConfigs/3 POSITIONAL ARGUMENTS URL diff --git a/gcloud/alpha/web-security-scanner/scan-configs/delete b/gcloud/alpha/web-security-scanner/scan-configs/delete index 302d99cc9..184c6f8db 100644 --- a/gcloud/alpha/web-security-scanner/scan-configs/delete +++ b/gcloud/alpha/web-security-scanner/scan-configs/delete @@ -26,8 +26,8 @@ POSITIONAL ARGUMENTS This must be specified. SCAN_CONFIG - ID of the scan_config or fully qualified identifier for the - scan_config. To set the scan_config attribute: + ID of the scan config or fully qualified identifier for the scan + config. To set the scan_config attribute: ▸ provide the argument scan_config on the command line. GCLOUD WIDE FLAGS diff --git a/gcloud/alpha/web-security-scanner/scan-configs/describe b/gcloud/alpha/web-security-scanner/scan-configs/describe index bf6a530ef..76a84c567 100644 --- a/gcloud/alpha/web-security-scanner/scan-configs/describe +++ b/gcloud/alpha/web-security-scanner/scan-configs/describe @@ -26,8 +26,8 @@ POSITIONAL ARGUMENTS This must be specified. SCAN_CONFIG - ID of the scan_config or fully qualified identifier for the - scan_config. To set the scan_config attribute: + ID of the scan config or fully qualified identifier for the scan + config. To set the scan_config attribute: ▸ provide the argument scan_config on the command line. GCLOUD WIDE FLAGS diff --git a/gcloud/alpha/web-security-scanner/scan-configs/update b/gcloud/alpha/web-security-scanner/scan-configs/update index 61ce5794a..3bdee15de 100644 --- a/gcloud/alpha/web-security-scanner/scan-configs/update +++ b/gcloud/alpha/web-security-scanner/scan-configs/update @@ -45,8 +45,8 @@ POSITIONAL ARGUMENTS This must be specified. SCAN_CONFIG - ID of the scan_config or fully qualified identifier for the - scan_config. To set the scan_config attribute: + ID of the scan config or fully qualified identifier for the scan + config. To set the scan_config attribute: ▸ provide the argument scan_config on the command line. FLAGS diff --git a/gcloud/alpha/web-security-scanner/scan-runs/describe b/gcloud/alpha/web-security-scanner/scan-runs/describe index 9462a1569..132fcbe5b 100644 --- a/gcloud/alpha/web-security-scanner/scan-runs/describe +++ b/gcloud/alpha/web-security-scanner/scan-runs/describe @@ -29,7 +29,7 @@ POSITIONAL ARGUMENTS This must be specified. SCAN_RUN - ID of the scan_run or fully qualified identifier for the scan_run. To + ID of the scan run or fully qualified identifier for the scan run. To set the scan_run attribute: ▸ provide the argument scan_run on the command line. diff --git a/gcloud/alpha/web-security-scanner/scan-runs/list b/gcloud/alpha/web-security-scanner/scan-runs/list index a66efc06a..dbfa24de0 100644 --- a/gcloud/alpha/web-security-scanner/scan-runs/list +++ b/gcloud/alpha/web-security-scanner/scan-runs/list @@ -28,8 +28,8 @@ REQUIRED FLAGS This must be specified. --scan-config=SCAN_CONFIG - ID of the scan-config or fully qualified identifier for the - scan-config. To set the scan-config attribute: + ID of the scan config or fully qualified identifier for the scan + config. To set the scan-config attribute: ▸ provide the argument --scan-config on the command line. LIST COMMAND FLAGS diff --git a/gcloud/alpha/web-security-scanner/scan-runs/list-crawled-urls b/gcloud/alpha/web-security-scanner/scan-runs/list-crawled-urls index 58347543e..81d22139c 100644 --- a/gcloud/alpha/web-security-scanner/scan-runs/list-crawled-urls +++ b/gcloud/alpha/web-security-scanner/scan-runs/list-crawled-urls @@ -34,7 +34,7 @@ REQUIRED FLAGS This must be specified. --scan-run=SCAN_RUN - ID of the scan-run or fully qualified identifier for the scan-run. To + ID of the scan run or fully qualified identifier for the scan run. To set the scan-run attribute: ▸ provide the argument --scan-run on the command line. diff --git a/gcloud/alpha/web-security-scanner/scan-runs/start b/gcloud/alpha/web-security-scanner/scan-runs/start index dcb88ccf6..739e62165 100644 --- a/gcloud/alpha/web-security-scanner/scan-runs/start +++ b/gcloud/alpha/web-security-scanner/scan-runs/start @@ -27,8 +27,8 @@ POSITIONAL ARGUMENTS This must be specified. SCAN_CONFIG - ID of the scan_config or fully qualified identifier for the - scan_config. To set the scan_config attribute: + ID of the scan config or fully qualified identifier for the scan + config. To set the scan_config attribute: ▸ provide the argument scan_config on the command line. GCLOUD WIDE FLAGS diff --git a/gcloud/alpha/web-security-scanner/scan-runs/stop b/gcloud/alpha/web-security-scanner/scan-runs/stop index 3b26c9039..5e0ea6826 100644 --- a/gcloud/alpha/web-security-scanner/scan-runs/stop +++ b/gcloud/alpha/web-security-scanner/scan-runs/stop @@ -26,7 +26,7 @@ POSITIONAL ARGUMENTS This must be specified. SCAN_RUN - ID of the scan_run or fully qualified identifier for the scan_run. To + ID of the scan run or fully qualified identifier for the scan run. To set the scan_run attribute: ▸ provide the argument scan_run on the command line. diff --git a/gcloud/asset/search-all-resources b/gcloud/asset/search-all-resources index 7683a8c4a..29c2d99e9 100644 --- a/gcloud/asset/search-all-resources +++ b/gcloud/asset/search-all-resources @@ -53,16 +53,15 @@ FLAGS ◆ displayName ◆ description ◆ location - ◆ kmsKey ◆ createTime ◆ updateTime ◆ state ◆ parentFullResourceName ◆ parentAssetType - All the other fields such as repeated fields (e.g., networkTags), map - fields (e.g., labels) and struct fields (e.g., additionalAttributes) - are not supported. + All the other fields such as repeated fields (e.g., networkTags, + kmsKeys), map fields (e.g., labels) and struct fields (e.g., + additionalAttributes) are not supported. Both --order-by and --sort-by flags can be used to sort the output, with the following differences: @@ -95,6 +94,10 @@ FLAGS ◆ labels.env:* to find Cloud resources that have a label env. ◆ kmsKey:key to find Cloud resources encrypted with a customer-managed encryption key whose name contains key as a word. + This field is deprecated. Please use the kmsKeys field to retrieve + KMS key information. + ◆ kmsKeys:key to find Cloud resources encrypted with customer-managed + encryption keys whose name contains the word key. ◆ relationships:instance-group-1 to find Cloud resources that have relationships with instance-group-1 in the related resource name. ◆ relationships:INSTANCE_TO_INSTANCEGROUP to find Compute instances @@ -138,7 +141,7 @@ FLAGS ◆ location ◆ labels ◆ network_tags or networkTags - ◆ kms_key or kmsKey + ◆ kms_keys or kmsKeys ◆ create_time or createTime ◆ update_time or updateTime ◆ state diff --git a/gcloud/batch/help b/gcloud/batch/help new file mode 100644 index 000000000..b9ac801d9 --- /dev/null +++ b/gcloud/batch/help @@ -0,0 +1,38 @@ +NAME + gcloud batch - manage Batch resources + +SYNOPSIS + gcloud batch GROUP [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + The gcloud batch command group lets you submit Batch jobs and manipulate + Batch jobs and tasks. + + With Batch, you can utilize the fully managed service to schedule, queue, + and execute batch jobs on Google's infrastructure. + + For more information about Batch, see the Batch overview + (https://cloud.google.com/batch) and the Batch documentation + (https://cloud.google.com/batch/docs/). + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + jobs + Manage Batch job resources. + + tasks + Manage Batch task resources. + +NOTES + These variants are also available: + + $ gcloud alpha batch + + $ gcloud beta batch + diff --git a/gcloud/batch/jobs/delete b/gcloud/batch/jobs/delete new file mode 100644 index 000000000..79224d237 --- /dev/null +++ b/gcloud/batch/jobs/delete @@ -0,0 +1,61 @@ +NAME + gcloud batch jobs delete - delete a job + +SYNOPSIS + gcloud batch jobs delete (JOB : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + 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 batch jobs delete \ + projects/foo/locations/us-central1/jobs/bar + +POSITIONAL ARGUMENTS + Job resource - The Batch job resource. If not specified,the current + batch/location is used. 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 argument 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; + ▸ set the property batch/location. + +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 + These variants are also available: + + $ gcloud alpha batch jobs delete + + $ gcloud beta batch jobs delete + diff --git a/gcloud/batch/jobs/describe b/gcloud/batch/jobs/describe new file mode 100644 index 000000000..0e2768a22 --- /dev/null +++ b/gcloud/batch/jobs/describe @@ -0,0 +1,62 @@ +NAME + gcloud batch jobs describe - show details of a job + +SYNOPSIS + gcloud batch jobs describe (JOB : --location=LOCATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + 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 batch jobs describe \ + projects/foo/locations/us-central1/jobs/bar + +POSITIONAL ARGUMENTS + Job resource - The Batch job resource. If not specified,the current + batch/location is used. 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 argument 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; + ▸ set the property batch/location. + +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 + These variants are also available: + + $ gcloud alpha batch jobs describe + + $ gcloud beta batch jobs describe + diff --git a/gcloud/batch/jobs/help b/gcloud/batch/jobs/help new file mode 100644 index 000000000..c2455ee8d --- /dev/null +++ b/gcloud/batch/jobs/help @@ -0,0 +1,44 @@ +NAME + gcloud batch jobs - manage Batch job resources + +SYNOPSIS + gcloud batch jobs COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + The gcloud batch jobs command group lets you submit, describe, list and + delete Batch jobs. + + With Batch, you can utilize the fully managed service to schedule, queue, + and execute batch jobs on Google's infrastructure. + + For more information about Batch, see the Batch overview + (https://cloud.google.com/batch) and the Batch documentation + (https://cloud.google.com/batch/docs/). + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + delete + Delete a job. + + describe + Show details of a job. + + list + List jobs for a specified Batch project/location. + + submit + Submit a Batch job. + +NOTES + These variants are also available: + + $ gcloud alpha batch jobs + + $ gcloud beta batch jobs + diff --git a/gcloud/batch/jobs/list b/gcloud/batch/jobs/list new file mode 100644 index 000000000..677a927b2 --- /dev/null +++ b/gcloud/batch/jobs/list @@ -0,0 +1,85 @@ +NAME + gcloud batch jobs list - list jobs for a specified Batch project/location + +SYNOPSIS + gcloud batch jobs list [--location=LOCATION] [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + 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 all available locations for the default + project, run: + + $ gcloud batch jobs list + + To print all the jobs under projects/location + projects/foo/locations/us-central1, run: + + $ gcloud batch jobs list --project=foo --location=us-central1 + +FLAGS + Location resource - The Batch location resource. If you omit this flag, + the defaultlocation is used if you set the batch/location + property.Otherwise, omitting this flag lists jobs across all locations. + 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; + ◆ set the property batch/location with a fully specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --location=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; + ▸ set the property batch/location. + +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 + These variants are also available: + + $ gcloud alpha batch jobs list + + $ gcloud beta batch jobs list + diff --git a/gcloud/batch/jobs/submit b/gcloud/batch/jobs/submit new file mode 100644 index 000000000..942be33ce --- /dev/null +++ b/gcloud/batch/jobs/submit @@ -0,0 +1,156 @@ +NAME + gcloud batch jobs submit - submit a Batch job + +SYNOPSIS + gcloud 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 + 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 batch jobs submit \ + projects/foo/locations/us-central1/jobs/bar --config=config.json + + To submit the job through stdin with json job config and name + projects/foo/locations/us-central1/jobs/bar, run: + + $ gcloud batch jobs submit \ + projects/foo/locations/us-central1/jobs/bar --config=- + + then input json job config via stdin + { + json job config + } + + To submit the job through HereDoc with json job config and name + projects/foo/locations/us-central1/jobs/bar, run: + + $ gcloud batch jobs submit \ + projects/foo/locations/us-central1/jobs/bar --config=- << EOF + + { + json job config + } + EOF + +POSITIONAL ARGUMENTS + Job resource - The Batch job resource. If not specified,the current + batch/location is used. 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 argument 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; + ▸ set the property batch/location. + +REQUIRED FLAGS + At least one of these must be specified: + + --config=CONFIG + The file path of the JSON job config JSON. It also supports direct + input from stdin with '-' or HereDoc (in shells with HereDoc support + like Bash) with '- < - executors_count, then auto-scaling is enabled. + --notebook-batch-max-executors-count=NOTEBOOK_BATCH_MAX_EXECUTORS_COUNT + Max configurable executors. If max_executors_count > + executors_count, then auto-scaling is enabled. - Container Image Runtime Configuration. + Container Image Runtime Configuration. - --container-image=CONTAINER_IMAGE - Optional custom container image for the job. + --notebook-container-image=NOTEBOOK_CONTAINER_IMAGE + Optional custom container image for the job. - --container-image-java-jars=[CONTAINER_IMAGE_JAVA_JARS,...] - A list of Java JARS to add to the classpath. Valid input includes - Cloud Storage URIs to Jar binaries. For example, - gs://bucket-name/my/path/to/file.jar + --notebook-container-image-java-jars=[NOTEBOOK_CONTAINER_IMAGE_JAVA_JARS,...] + A list of Java JARS to add to the classpath. Valid input includes + Cloud Storage URIs to Jar binaries. For example, + gs://bucket-name/my/path/to/file.jar - --container-image-properties=CONTAINER_IMAGE_PROPERTIES - The properties to set on daemon config files. Property keys are - specified in prefix:property format, for example - core:hadoop.tmp.dir. For more information, see Cluster properties - (https://cloud.google.com/dataproc/docs/concepts/cluster-properties) + --notebook-container-image-properties=NOTEBOOK_CONTAINER_IMAGE_PROPERTIES + The properties to set on daemon config files. Property keys are + specified in prefix:property format, for example + core:hadoop.tmp.dir. For more information, see Cluster properties + (https://cloud.google.com/dataproc/docs/concepts/cluster-properties) - --container-image-python-packages=[CONTAINER_IMAGE_PYTHON_PACKAGES,...] - A list of python packages to be installed. Valid formats include - Cloud Storage URI to a PIP installable library. For example, - gs://bucket-name/my/path/to/lib.tar.gz + Cloud VPC Network used to run the infrastructure. - Cloud VPC Network used to run the infrastructure. + --notebook-vpc-network-tags=[NOTEBOOK_VPC_NETWORK_TAGS,...] + List of network tags to apply to the job. - --vpc-network-tags=[VPC_NETWORK_TAGS,...] - List of network tags to apply to the job. + The Cloud VPC network identifier. - The Cloud VPC network identifier. + At most one of these can be specified: - At most one of these can be specified: + --notebook-vpc-network-name=NOTEBOOK_VPC_NETWORK_NAME + The Cloud VPC network in which the job is run. By default, the + Cloud VPC network named Default within the project is used. - --vpc-network-name=VPC_NETWORK_NAME - The Cloud VPC network in which the job is run. By default, the - Cloud VPC network named Default within the project is used. + --notebook-vpc-sub-network-name=NOTEBOOK_VPC_SUB_NETWORK_NAME + The Cloud VPC sub-network in which the job is run. - --vpc-sub-network-name=VPC_SUB_NETWORK_NAME - The Cloud VPC sub-network in which the job is run. + Config related to running custom Spark tasks. + + --spark-archive-uris=[SPARK_ARCHIVE_URIS,...] + Google Cloud Storage URIs of archives to be extracted into the + working directory of each executor. Supported file types: .jar, + .tar, .tar.gz, .tgz, and .zip. + + --spark-file-uris=[SPARK_FILE_URIS,...] + Google Cloud Storage URIs of files to be placed in the working + directory of each executor. + + The specification of the main method to call to drive the job. Specify + either the jar file that contains the main class or the main class + name. + + Exactly one of these must be specified: + + --spark-main-class=SPARK_MAIN_CLASS + The name of the driver's main class. The jar file that contains + the class must be in the default CLASSPATH or specified in + jar_file_uris. The execution args are passed in as a sequence + of named process arguments (--key=value). + + --spark-main-jar-file-uri=SPARK_MAIN_JAR_FILE_URI + The Google Cloud Storage URI of the jar file that contains the + main class. The execution args are passed in as a sequence of + named process arguments (--key=value). + + --spark-python-script-file=SPARK_PYTHON_SCRIPT_FILE + The Google Cloud Storage URI of the main Python file to use as + the driver. Must be a .py file. + + --spark-sql-script=SPARK_SQL_SCRIPT + The SQL query text. + + --spark-sql-script-file=SPARK_SQL_SCRIPT_FILE + A reference to a query file. This can be the Google Cloud + Storage URI of the query file or it can the path to a SqlScript + Content. + + Compute resources needed for a Task when using Dataproc Serverless. + + --batch-executors-count=BATCH_EXECUTORS_COUNT + Total number of job executors. + + --batch-max-executors-count=BATCH_MAX_EXECUTORS_COUNT + Max configurable executors. If max_executors_count > + executors_count, then auto-scaling is enabled. + + Container Image Runtime Configuration. + + --container-image=CONTAINER_IMAGE + Optional custom container image for the job. + + --container-image-java-jars=[CONTAINER_IMAGE_JAVA_JARS,...] + A list of Java JARS to add to the classpath. Valid input includes + Cloud Storage URIs to Jar binaries. For example, + gs://bucket-name/my/path/to/file.jar + + --container-image-properties=CONTAINER_IMAGE_PROPERTIES + The properties to set on daemon config files. Property keys are + specified in prefix:property format, for example + core:hadoop.tmp.dir. For more information, see Cluster properties + (https://cloud.google.com/dataproc/docs/concepts/cluster-properties) + + --container-image-python-packages=[CONTAINER_IMAGE_PYTHON_PACKAGES,...] + A list of python packages to be installed. Valid formats include + Cloud Storage URI to a PIP installable library. For example, + gs://bucket-name/my/path/to/lib.tar.gz + + Cloud VPC Network used to run the infrastructure. + + --vpc-network-tags=[VPC_NETWORK_TAGS,...] + List of network tags to apply to the job. + + The Cloud VPC network identifier. + + At most one of these can be specified: + + --vpc-network-name=VPC_NETWORK_NAME + The Cloud VPC network in which the job is run. By default, the + Cloud VPC network named Default within the project is used. + + --vpc-sub-network-name=VPC_SUB_NETWORK_NAME + The Cloud VPC sub-network in which the job is run. Spec related to Dataplex task scheduling and frequency settings. diff --git a/gcloud/dataplex/tasks/update b/gcloud/dataplex/tasks/update index eea576ad5..697ac1417 100644 --- a/gcloud/dataplex/tasks/update +++ b/gcloud/dataplex/tasks/update @@ -10,7 +10,16 @@ SYNOPSIS --execution-service-account=EXECUTION_SERVICE_ACCOUNT --kms-key=KMS_KEY --max-job-execution-lifetime=MAX_JOB_EXECUTION_LIFETIME] - [--spark-archive-uris=[SPARK_ARCHIVE_URIS,...] + [--notebook=NOTEBOOK + --notebook-archive-uris=[NOTEBOOK_ARCHIVE_URIS,...] + --notebook-file-uris=[NOTEBOOK_FILE_URIS,...] + --notebook-batch-executors-count=NOTEBOOK_BATCH_EXECUTORS_COUNT + --notebook-batch-max-executors-count=NOTEBOOK_BATCH_MAX_EXECUTORS_COUNT --notebook-container-image=NOTEBOOK_CONTAINER_IMAGE --notebook-container-image-java-jars=[NOTEBOOK_CONTAINER_IMAGE_JAVA_JARS, + ...] + --notebook-container-image-properties=NOTEBOOK_CONTAINER_IMAGE_PROPERTIES --notebook-vpc-network-tags=[NOTEBOOK_VPC_NETWORK_TAGS, + ...] --notebook-vpc-network-name=NOTEBOOK_VPC_NETWORK_NAME + | --notebook-vpc-sub-network-name=NOTEBOOK_VPC_SUB_NETWORK_NAME + | --spark-archive-uris=[SPARK_ARCHIVE_URIS,...] --spark-file-uris=[SPARK_FILE_URIS,...] --batch-executors-count=BATCH_EXECUTORS_COUNT --batch-max-executors-count=BATCH_MAX_EXECUTORS_COUNT @@ -20,7 +29,7 @@ SYNOPSIS --container-image-python-packages=[CONTAINER_IMAGE_PYTHON_PACKAGES, ...] --vpc-network-tags=[VPC_NETWORK_TAGS,...] --vpc-network-name=VPC_NETWORK_NAME - | --vpc-sub-network-name=VPC_SUB_NETWORK_NAME + --vpc-sub-network-name=VPC_SUB_NETWORK_NAME --spark-main-class=SPARK_MAIN_CLASS | --spark-main-jar-file-uri=SPARK_MAIN_JAR_FILE_URI | --spark-python-script-file=SPARK_PYTHON_SCRIPT_FILE @@ -150,89 +159,154 @@ FLAGS --max-job-execution-lifetime=MAX_JOB_EXECUTION_LIFETIME The maximum duration before the job execution expires. - Config related to running custom Spark tasks. - - --spark-archive-uris=[SPARK_ARCHIVE_URIS,...] - Google Cloud Storage URIs of archives to be extracted into the - working directory of each executor. Supported file types: .jar, .tar, - .tar.gz, .tgz, and .zip. - - --spark-file-uris=[SPARK_FILE_URIS,...] - Google Cloud Storage URIs of files to be placed in the working - directory of each executor. - - Compute resources needed for a Task when using Dataproc Serverless. - - --batch-executors-count=BATCH_EXECUTORS_COUNT - Total number of job executors. - - --batch-max-executors-count=BATCH_MAX_EXECUTORS_COUNT - Max configurable executors. If max_executors_count > - executors_count, then auto-scaling is enabled. - - Container Image Runtime Configuration. - - --container-image=CONTAINER_IMAGE - Optional custom container image for the job. - - --container-image-java-jars=[CONTAINER_IMAGE_JAVA_JARS,...] - A list of Java JARS to add to the classpath. Valid input includes - Cloud Storage URIs to Jar binaries. For example, - gs://bucket-name/my/path/to/file.jar - - --container-image-properties=CONTAINER_IMAGE_PROPERTIES - Override to common configuration of open source components - installed on the Dataproc cluster. The properties to set on daemon - config files. Property keys are specified in prefix:property - format, for example core:hadoop.tmp.dir. For more information, see - Cluster properties - (https://cloud.google.com/dataproc/docs/concepts/cluster-properties). - - --container-image-python-packages=[CONTAINER_IMAGE_PYTHON_PACKAGES,...] - A list of python packages to be installed. Valid formats include - Cloud Storage URI to a PIP installable library. For example, - gs://bucket-name/my/path/to/lib.tar.gz - - Cloud VPC Network used to run the infrastructure. - - --vpc-network-tags=[VPC_NETWORK_TAGS,...] - List of network tags to apply to the job. - - The Cloud VPC network identifier. - - At most one of these can be specified: - - --vpc-network-name=VPC_NETWORK_NAME - The Cloud VPC network in which the job is run. By default, the - Cloud VPC network named Default within the project is used. - - --vpc-sub-network-name=VPC_SUB_NETWORK_NAME - The Cloud VPC sub-network in which the job is run. - - The specification of the main method to call to drive the job. Specify - either the jar file that contains the main class or the main class name. + Select which task you want to schedule and provide the required + arguments:- + ◆ spark tasks + ◆ notebook tasks At most one of these can be specified: - --spark-main-class=SPARK_MAIN_CLASS - The name of the driver's main class. The jar file that contains - the class must be in the default CLASSPATH or specified in + Config related to running custom Notebook tasks. - --spark-main-jar-file-uri=SPARK_MAIN_JAR_FILE_URI - The Google Cloud Storage URI of the jar file that contains the - main class. The execution args are passed in as a sequence of - named process arguments (--key=value). + --notebook=NOTEBOOK + Google Cloud Storage URIs of the notebook file or the path to a + Notebook Content. Path to input notebook. - --spark-python-script-file=SPARK_PYTHON_SCRIPT_FILE - The Google Cloud Storage URI of the main Python file to use as - the driver. Must be a .py file. + --notebook-archive-uris=[NOTEBOOK_ARCHIVE_URIS,...] + Google Cloud Storage URIs of archives to be extracted into the + working directory of each executor. Supported file types: .jar, + .tar, .tar.gz, .tgz, and .zip. - --spark-sql-script=SPARK_SQL_SCRIPT - The SQL query text. + --notebook-file-uris=[NOTEBOOK_FILE_URIS,...] + Google Cloud Storage URIs of files to be placed in the working + directory of each executor. - --spark-sql-script-file=SPARK_SQL_SCRIPT_FILE - A reference to a query file. This can be the Google Cloud Storage - URI of the query file or it can the path to a SqlScript Content. + Compute resources needed for a Task when using Dataproc Serverless. + + --notebook-batch-executors-count=NOTEBOOK_BATCH_EXECUTORS_COUNT + Total number of job executors. + + --notebook-batch-max-executors-count=NOTEBOOK_BATCH_MAX_EXECUTORS_COUNT + Max configurable executors. If max_executors_count > + executors_count, then auto-scaling is enabled. + + Container Image Runtime Configuration. + + --notebook-container-image=NOTEBOOK_CONTAINER_IMAGE + Optional custom container image for the job. + + --notebook-container-image-java-jars=[NOTEBOOK_CONTAINER_IMAGE_JAVA_JARS,...] + A list of Java JARS to add to the classpath. Valid input includes + Cloud Storage URIs to Jar binaries. For example, + gs://bucket-name/my/path/to/file.jar + + --notebook-container-image-properties=NOTEBOOK_CONTAINER_IMAGE_PROPERTIES + Override to common configuration of open source components + installed on the Dataproc cluster. The properties to set on + daemon config files. Property keys are specified in + prefix:property format, for example core:hadoop.tmp.dir. For more + information, see Cluster properties + (https://cloud.google.com/dataproc/docs/concepts/cluster-properties). + + Cloud VPC Network used to run the infrastructure. + + --notebook-vpc-network-tags=[NOTEBOOK_VPC_NETWORK_TAGS,...] + List of network tags to apply to the job. + + The Cloud VPC network identifier. + + At most one of these can be specified: + + --notebook-vpc-network-name=NOTEBOOK_VPC_NETWORK_NAME + The Cloud VPC network in which the job is run. By default, the + Cloud VPC network named Default within the project is used. + + --notebook-vpc-sub-network-name=NOTEBOOK_VPC_SUB_NETWORK_NAME + The Cloud VPC sub-network in which the job is run. + + Config related to running custom Spark tasks. + + --spark-archive-uris=[SPARK_ARCHIVE_URIS,...] + Google Cloud Storage URIs of archives to be extracted into the + working directory of each executor. Supported file types: .jar, + .tar, .tar.gz, .tgz, and .zip. + + --spark-file-uris=[SPARK_FILE_URIS,...] + Google Cloud Storage URIs of files to be placed in the working + directory of each executor. + + Compute resources needed for a Task when using Dataproc Serverless. + + --batch-executors-count=BATCH_EXECUTORS_COUNT + Total number of job executors. + + --batch-max-executors-count=BATCH_MAX_EXECUTORS_COUNT + Max configurable executors. If max_executors_count > + executors_count, then auto-scaling is enabled. + + Container Image Runtime Configuration. + + --container-image=CONTAINER_IMAGE + Optional custom container image for the job. + + --container-image-java-jars=[CONTAINER_IMAGE_JAVA_JARS,...] + A list of Java JARS to add to the classpath. Valid input includes + Cloud Storage URIs to Jar binaries. For example, + gs://bucket-name/my/path/to/file.jar + + --container-image-properties=CONTAINER_IMAGE_PROPERTIES + Override to common configuration of open source components + installed on the Dataproc cluster. The properties to set on + daemon config files. Property keys are specified in + prefix:property format, for example core:hadoop.tmp.dir. For more + information, see Cluster properties + (https://cloud.google.com/dataproc/docs/concepts/cluster-properties). + + --container-image-python-packages=[CONTAINER_IMAGE_PYTHON_PACKAGES,...] + A list of python packages to be installed. Valid formats include + Cloud Storage URI to a PIP installable library. For example, + gs://bucket-name/my/path/to/lib.tar.gz + + Cloud VPC Network used to run the infrastructure. + + --vpc-network-tags=[VPC_NETWORK_TAGS,...] + List of network tags to apply to the job. + + The Cloud VPC network identifier. + + --vpc-network-name=VPC_NETWORK_NAME + The Cloud VPC network in which the job is run. By default, the + Cloud VPC network named Default within the project is used. + + --vpc-sub-network-name=VPC_SUB_NETWORK_NAME + The Cloud VPC sub-network in which the job is run. + + The specification of the main method to call to drive the job. Specify + either the jar file that contains the main class or the main class + name. + + At most one of these can be specified: + + --spark-main-class=SPARK_MAIN_CLASS + The name of the driver's main class. The jar file that contains + the class must be in the default CLASSPATH or specified in + + --spark-main-jar-file-uri=SPARK_MAIN_JAR_FILE_URI + The Google Cloud Storage URI of the jar file that contains the + main class. The execution args are passed in as a sequence of + named process arguments (--key=value). + + --spark-python-script-file=SPARK_PYTHON_SCRIPT_FILE + The Google Cloud Storage URI of the main Python file to use as + the driver. Must be a .py file. + + --spark-sql-script=SPARK_SQL_SCRIPT + The SQL query text. + + --spark-sql-script-file=SPARK_SQL_SCRIPT_FILE + A reference to a query file. This can be the Google Cloud + Storage URI of the query file or it can the path to a SqlScript + Content. Spec related to how often and when a task should be triggered. diff --git a/gcloud/firestore/fields/help b/gcloud/firestore/fields/help new file mode 100644 index 000000000..648a58293 --- /dev/null +++ b/gcloud/firestore/fields/help @@ -0,0 +1,27 @@ +NAME + gcloud firestore fields - manage field metadata for Cloud Firestore + +SYNOPSIS + gcloud firestore fields GROUP [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage field metadata for Cloud Firestore. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + ttls + Manage Time-to-live metadata for Cloud Firestore. + +NOTES + These variants are also available: + + $ gcloud alpha firestore fields + + $ gcloud beta firestore fields + diff --git a/gcloud/firestore/fields/ttls/help b/gcloud/firestore/fields/ttls/help new file mode 100644 index 000000000..1ef727522 --- /dev/null +++ b/gcloud/firestore/fields/ttls/help @@ -0,0 +1,31 @@ +NAME + gcloud firestore fields ttls - manage Time-to-live metadata for Cloud + Firestore + +SYNOPSIS + gcloud firestore fields ttls COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage Time-to-live metadata for Cloud Firestore. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + list + List all fields used as a Time To Live expiration setting. + + update + Update the TTL configuration of the given field. + +NOTES + These variants are also available: + + $ gcloud alpha firestore fields ttls + + $ gcloud beta firestore fields ttls + diff --git a/gcloud/firestore/fields/ttls/list b/gcloud/firestore/fields/ttls/list new file mode 100644 index 000000000..114dc04b7 --- /dev/null +++ b/gcloud/firestore/fields/ttls/list @@ -0,0 +1,96 @@ +NAME + gcloud firestore fields ttls list - list all fields used as a Time To Live + expiration setting + +SYNOPSIS + gcloud firestore fields ttls list [--collection-group=COLLECTION_GROUP] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List fields that give an expiration timestamp for documents in a collection + group or kind. + +EXAMPLES + The following command lists all TTL fields for the whole database: + + $ gcloud firestore fields ttls list + +FLAGS + Collection group resource - Collection group of the ttl. + + This can be omitted to include fields across all collection groups + (kinds). 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 --collection-group on the command line with a + fully specified name; + ◆ provide the argument [--collection-group] on the command line with a + fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. To set the + database attribute: + ◆ provide the argument --collection-group on the command line with a + fully specified name; + ◆ provide the argument [--collection-group] on the command line with a + fully specified name; + ◆ provide the argument [--database] on the command line (currently + '(default)' is the only supported value). + + --collection-group=COLLECTION_GROUP + ID of the collection group or fully qualified identifier for the + collection group. To set the collection-group attribute: + ▸ provide the argument --collection-group on the command line; + ▸ provide the argument [--collection-group] 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. + + --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. + +API REFERENCE + This command uses the firestore/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/firestore + +NOTES + These variants are also available: + + $ gcloud alpha firestore fields ttls list + + $ gcloud beta firestore fields ttls list + diff --git a/gcloud/firestore/fields/ttls/update b/gcloud/firestore/fields/ttls/update new file mode 100644 index 000000000..8f6b31cb8 --- /dev/null +++ b/gcloud/firestore/fields/ttls/update @@ -0,0 +1,95 @@ +NAME + gcloud firestore fields ttls update - update the TTL configuration of the + given field + +SYNOPSIS + gcloud firestore fields ttls update + (FIELD : --collection-group=COLLECTION_GROUP) + (--disable-ttl | --enable-ttl) [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Update the TTL configuration of the given field. + + This enables or disables using a field as the TTL field for its collection + group or kind. Note that only one field can be the TTL field for a + collection group. + +EXAMPLES + The following command sets the expiry field of the Events collection group + (kind) to be the TTL field: + + $ gcloud firestore fields ttls update expiry \ + --collection-group=Events --enable-ttl + + The following command disables the expiry field so it is no longer the TTL + for the Events collection group (kind): + + $ gcloud firestore fields ttls update expiry \ + --collection-group=Events --disable-ttl + +POSITIONAL ARGUMENTS + Field resource - Field to update. 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 field on the command line with a fully specified + name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. To set the + database attribute: + ◆ provide the argument field on the command line with a fully specified + name; + ◆ provide the argument [--database] on the command line (currently + '(default)' is the only supported value). + + This must be specified. + + FIELD + ID of the field or fully qualified identifier for the field. To set + the field attribute: + ▸ provide the argument field on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --collection-group=COLLECTION_GROUP + Collection group of the field. + + To set the collection-group attribute: + ▸ provide the argument field on the command line with a fully + specified name; + ▸ provide the argument --collection-group on the command line. + +REQUIRED FLAGS + Exactly one of these must be specified: + + --disable-ttl + Set to make this field no longer the TTL for its collection group. + + --enable-ttl + Set to enable this field as the TTL for its collection group. + +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 help for details. + +API REFERENCE + This command uses the firestore/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/firestore + +NOTES + These variants are also available: + + $ gcloud alpha firestore fields ttls update + + $ gcloud beta firestore fields ttls update + diff --git a/gcloud/firestore/help b/gcloud/firestore/help index 2133358d4..96f51a05c 100644 --- a/gcloud/firestore/help +++ b/gcloud/firestore/help @@ -24,6 +24,9 @@ GROUPS databases Manage Creation of Cloud Firestore in Native mode Database. + fields + Manage field metadata for Cloud Firestore. + indexes Manage indexes for Cloud Firestore. diff --git a/gcloud/run/deploy b/gcloud/run/deploy index 9eabd90f2..592fd52c7 100644 --- a/gcloud/run/deploy +++ b/gcloud/run/deploy @@ -1,5 +1,5 @@ NAME - gcloud run deploy - deploy a container to Cloud Run + gcloud run deploy - create or update a Cloud Run service SYNOPSIS gcloud run deploy [[SERVICE] --namespace=NAMESPACE] [--args=[ARG,...]] @@ -38,7 +38,7 @@ SYNOPSIS | --context=CONTEXT --kubeconfig=KUBECONFIG] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - Deploys container images to Google Cloud Run. + Creates or updates a Cloud Run service. EXAMPLES To deploy a container to the service my-backend on Cloud Run: diff --git a/gcloud/run/help b/gcloud/run/help index d8e03376e..87750ba40 100644 --- a/gcloud/run/help +++ b/gcloud/run/help @@ -39,7 +39,7 @@ COMMANDS COMMAND is one of the following: deploy - Deploy a container to Cloud Run. + Create or update a Cloud Run service. NOTES These variants are also available: diff --git a/gcloud/spanner/instance-configs/create b/gcloud/spanner/instance-configs/create new file mode 100644 index 000000000..1f6d765e5 --- /dev/null +++ b/gcloud/spanner/instance-configs/create @@ -0,0 +1,173 @@ +NAME + gcloud spanner instance-configs create - create a Cloud Spanner instance + configuration + +SYNOPSIS + gcloud spanner instance-configs create INSTANCE_CONFIG + (--base-config=BASE_CONFIG --replicas=location=LOCATION,type=TYPE:[...] + | [--clone-config=INSTANCE_CONFIG + : --add-replicas=location=LOCATION,type=TYPE:[...] + --skip-replicas=location=LOCATION,type=TYPE:[...]]) [--async] + [--display-name=DISPLAY_NAME] [--etag=ETAG] [--labels=[KEY=VALUE,...]] + [--validate-only] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a Cloud Spanner instance configuration. + +EXAMPLES + To create a custom Cloud Spanner instance configuration, run: + + $ gcloud spanner instance-configs create custom-instance-config \ + --display-name=custom-instance-config-name --base-config=nam3 \ + --replicas=location=us-east4,type=READ_WRITE:location=us-east4,\ + type=READ_WRITE:location=us-east1,\ + type=READ_WRITE:location=us-east1,\ + type=READ_WRITE:location=us-central1,type=WITNESS + + To create a custom Cloud Spanner instance configuration based on an + existing Google-managed configuration (nam3) by adding a 'READ_ONLY' type + replica in location 'us-east4', run: + + $ gcloud spanner instance-configs create custom-instance-config \ + --clone-config=nam3 \ + --add-replicas=location=us-east4,type=READ_ONLY + + To create a custom Cloud Spanner instance configuration based on an + existing Google-managed configuration (nam3) by adding a 'READ_ONLY' type + replica in location 'us-east4' and removing a 'READ_ONLY' type replica in + location 'us-central1', run: + + $ gcloud spanner instance-configs create custom-instance-config \ + --clone-config=nam3 \ + --add-replicas=location=us-east4,type=READ_ONLY \ + --skip-replicas=location=us-central1,type=READ_ONLY + +POSITIONAL ARGUMENTS + INSTANCE_CONFIG + Cloud Spanner instance configuration. The 'custom-' prefix is required + to avoid name conflicts with Google-managed configurations. + +REQUIRED FLAGS + Exactly one of these must be specified: + + Command-line flags to setup a custom instance configuration replicas: + + --base-config=BASE_CONFIG + The name of the Google-managed instance configuration, based on + which your custom configuration is created. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --replicas=location=LOCATION,type=TYPE:[...] + The geographic placement of nodes in this instance configuration + and their replication types. + + location + The location of the serving resources, e.g. "us-central1". + + type + The type of replica. + + Items in the list are separated by ":". The allowed values and + formats are as follows. + + READ_ONLY + Read-only replicas only support reads (not writes). Read-only + replicas: + + ▫ Maintain a full copy of your data. + + ▫ Serve reads. + + ▫ Do not participate in voting to commit writes. + + ▫ Are not eligible to become a leader. + + READ_WRITE + Read-write replicas support both reads and writes. These replicas: + + ▫ Maintain a full copy of your data. + + ▫ Serve reads. + + ▫ Can vote whether to commit a write. + + ▫ Participate in leadership election. + + ▫ Are eligible to become a leader. + + WITNESS + Witness replicas don't support reads but do participate in voting + to commit writes. Witness replicas: + + ▫ Do not maintain a full copy of data. + + ▫ Do not serve reads. + + ▫ Vote whether to commit writes. + + ▫ Participate in leader election but are not eligible to become + leader. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + Command-line flags to setup a custom instance configuration using clone + options: + + --clone-config=INSTANCE_CONFIG + The ID of the instance config, based on which this configuration is + created. The clone is an independent copy of this config. Available + configurations can be found by running "gcloud spanner + instance-configs list" + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --add-replicas=location=LOCATION,type=TYPE:[...] + Add new replicas while cloning from the source config. + + --skip-replicas=location=LOCATION,type=TYPE:[...] + Skip replicas from the source config while cloning. Each replica in + the list must exist in the source config replicas list. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --display-name=DISPLAY_NAME + The name of this instance configuration as it appears in UIs. Must + specify this option if creating an instance-config with --replicas. + + --etag=ETAG + Used for optimistic concurrency control. + + --labels=[KEY=VALUE,...] + List of label KEY=VALUE pairs to add. + + Keys must start with a lowercase character and contain only hyphens + (-), underscores (_), lowercase characters, and numbers. Values must + contain only hyphens (-), underscores (_), lowercase characters, and + numbers. + + --validate-only + Use this flag to validate that the request will succeed before + executing it. + +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 + These variants are also available: + + $ gcloud alpha spanner instance-configs create + + $ gcloud beta spanner instance-configs create + diff --git a/gcloud/spanner/instance-configs/delete b/gcloud/spanner/instance-configs/delete new file mode 100644 index 000000000..465c14b70 --- /dev/null +++ b/gcloud/spanner/instance-configs/delete @@ -0,0 +1,44 @@ +NAME + gcloud spanner instance-configs delete - delete a Cloud Spanner instance + configuration + +SYNOPSIS + gcloud spanner instance-configs delete INSTANCE_CONFIG [--etag=ETAG] + [--validate-only] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Delete a Cloud Spanner instance configuration. + +EXAMPLES + To delete a custom Cloud Spanner instance configuration, run: + + $ gcloud spanner instance-configs delete custom-instance-config + +POSITIONAL ARGUMENTS + INSTANCE_CONFIG + Cloud Spanner instance config. + +FLAGS + --etag=ETAG + Used for optimistic concurrency control as a way to help prevent + simultaneous deletes of an instance config from overwriting each other. + + --validate-only + Use this flag to validate that the request will succeed before + executing it. + +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 + These variants are also available: + + $ gcloud alpha spanner instance-configs delete + + $ gcloud beta spanner instance-configs delete + diff --git a/gcloud/spanner/instance-configs/describe b/gcloud/spanner/instance-configs/describe index 0c4035894..e741400ff 100644 --- a/gcloud/spanner/instance-configs/describe +++ b/gcloud/spanner/instance-configs/describe @@ -1,13 +1,13 @@ NAME gcloud spanner instance-configs describe - describe a Cloud Spanner - instance config + instance configuration SYNOPSIS gcloud spanner instance-configs describe INSTANCE_CONFIG [GCLOUD_WIDE_FLAG ...] DESCRIPTION - Describe a Cloud Spanner instance config. + Describe a Cloud Spanner instance configuration. EXAMPLES To describe an instance config named regional-us-central1, run: diff --git a/gcloud/spanner/instance-configs/help b/gcloud/spanner/instance-configs/help index a493ef700..df49cc58d 100644 --- a/gcloud/spanner/instance-configs/help +++ b/gcloud/spanner/instance-configs/help @@ -15,11 +15,20 @@ GCLOUD WIDE FLAGS COMMANDS COMMAND is one of the following: + create + Create a Cloud Spanner instance configuration. + + delete + Delete a Cloud Spanner instance configuration. + describe - Describe a Cloud Spanner instance config. + Describe a Cloud Spanner instance configuration. list - List the available Cloud Spanner instance configs. + List the available Cloud Spanner instance configurations. + + update + Update a Cloud Spanner instance configuration. NOTES These variants are also available: diff --git a/gcloud/spanner/instance-configs/list b/gcloud/spanner/instance-configs/list index 348c84a87..e3e1a8743 100644 --- a/gcloud/spanner/instance-configs/list +++ b/gcloud/spanner/instance-configs/list @@ -1,6 +1,6 @@ NAME gcloud spanner instance-configs list - list the available Cloud Spanner - instance configs + instance configurations SYNOPSIS gcloud spanner instance-configs list [--filter=EXPRESSION] [--limit=LIMIT] @@ -8,7 +8,7 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - List the available Cloud Spanner instance configs. + List the available Cloud Spanner instance configurations. EXAMPLES To list the Cloud Spanner instance configs that are availble for this diff --git a/gcloud/spanner/instance-configs/update b/gcloud/spanner/instance-configs/update new file mode 100644 index 000000000..ebac6ad73 --- /dev/null +++ b/gcloud/spanner/instance-configs/update @@ -0,0 +1,103 @@ +NAME + gcloud spanner instance-configs update - update a Cloud Spanner instance + configuration + +SYNOPSIS + gcloud spanner instance-configs update INSTANCE_CONFIG [--async] + [--display-name=DISPLAY_NAME] [--etag=ETAG] + [--update-labels=[KEY=VALUE,...]] [--validate-only] + [--clear-labels | --remove-labels=[KEY,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Update a Cloud Spanner instance configuration. + +EXAMPLES + To update display name of a custom Cloud Spanner instance configuration + 'custom-instance-config', run: + + $ gcloud spanner instance-configs update custom-instance-config \ + --display-name=nam3-RO-us-central1 + + To modify the instance config 'custom-instance-config' by adding label + 'k0', with value 'value1' and label 'k1' with value 'value2' and removing + labels with key 'k3', run: + + $ gcloud spanner instance-configs update custom-instance-config \ + --update-labels=k0=value1,k1=value2 --remove-labels=k3 + + To clear all labels of a custom Cloud Spanner instance configuration + 'custom-instance-config', run: + + $ gcloud spanner instance-configs update custom-instance-config \ + --clear-labels + + To remove an existing label of a custom Cloud Spanner instance + configuration 'custom-instance-config', run: + + $ gcloud spanner instance-configs update custom-instance-config \ + --remove-labels=KEY1,KEY2 + +POSITIONAL ARGUMENTS + INSTANCE_CONFIG + Cloud Spanner instance config. The 'custom-' prefix is required to + avoid name conflicts with Google-managed configurations. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --display-name=DISPLAY_NAME + The name of this instance configuration as it appears in UIs. + + --etag=ETAG + Used for optimistic concurrency control. + + --update-labels=[KEY=VALUE,...] + List of label KEY=VALUE pairs to update. If a label exists, its value + is modified. Otherwise, a new label is created. + + Keys must start with a lowercase character and contain only hyphens + (-), underscores (_), lowercase characters, and numbers. Values must + contain only hyphens (-), underscores (_), lowercase characters, and + numbers. + + --validate-only + Use this flag to validate that the request will succeed before + executing it. + + At most one of these can be specified: + + --clear-labels + Remove all labels. If --update-labels is also specified then + --clear-labels is applied first. + + For example, to remove all labels: + + $ gcloud spanner instance-configs update --clear-labels + + To remove all existing labels and create two new labels, foo and baz: + + $ gcloud spanner instance-configs update --clear-labels \ + --update-labels foo=bar,baz=qux + + --remove-labels=[KEY,...] + List of label keys to remove. If a label does not exist it is + silently ignored. If --update-labels is also specified then + --update-labels is applied first. + +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 + These variants are also available: + + $ gcloud alpha spanner instance-configs update + + $ gcloud beta spanner instance-configs update + diff --git a/gcloud/spanner/operations/cancel b/gcloud/spanner/operations/cancel index bc8e8977e..8fb36704d 100644 --- a/gcloud/spanner/operations/cancel +++ b/gcloud/spanner/operations/cancel @@ -2,7 +2,8 @@ NAME gcloud spanner operations cancel - cancel a Cloud Spanner operation SYNOPSIS - gcloud spanner operations cancel OPERATION-ID --instance=INSTANCE + gcloud spanner operations cancel OPERATION-ID + (--instance=INSTANCE | --instance-config=INSTANCE_CONFIG) [--backup=BACKUP] [--database=DATABASE] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -29,8 +30,13 @@ POSITIONAL ARGUMENTS ID of the operation REQUIRED FLAGS - --instance=INSTANCE - The ID of the instance the operation is executing on. + Exactly one of these must be specified: + + --instance=INSTANCE + The ID of the instance the operation is executing on. + + --instance-config=INSTANCE_CONFIG + The ID of the instance configuration the operation is executing on. OPTIONAL FLAGS --backup=BACKUP diff --git a/gcloud/spanner/operations/describe b/gcloud/spanner/operations/describe index bd503f4ba..2ac9ee7a5 100644 --- a/gcloud/spanner/operations/describe +++ b/gcloud/spanner/operations/describe @@ -2,7 +2,8 @@ NAME gcloud spanner operations describe - describe a Cloud Spanner operation SYNOPSIS - gcloud spanner operations describe OPERATION-ID --instance=INSTANCE + gcloud spanner operations describe OPERATION-ID + (--instance=INSTANCE | --instance-config=INSTANCE_CONFIG) [--backup=BACKUP] [--database=DATABASE] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -29,8 +30,13 @@ POSITIONAL ARGUMENTS ID of the operation REQUIRED FLAGS - --instance=INSTANCE - The ID of the instance the operation is executing on. + Exactly one of these must be specified: + + --instance=INSTANCE + The ID of the instance the operation is executing on. + + --instance-config=INSTANCE_CONFIG + The ID of the instance configuration the operation is executing on. OPTIONAL FLAGS --backup=BACKUP diff --git a/gcloud/spanner/operations/help b/gcloud/spanner/operations/help index 23ebc8e71..d6ecff086 100644 --- a/gcloud/spanner/operations/help +++ b/gcloud/spanner/operations/help @@ -22,7 +22,8 @@ COMMANDS Describe a Cloud Spanner operation. list - List the Cloud Spanner operations on the given instance or database. + List the Cloud Spanner operations on the given instance or database or + instance configuration. NOTES These variants are also available: diff --git a/gcloud/spanner/operations/list b/gcloud/spanner/operations/list index 58f86e0d7..74dc3b515 100644 --- a/gcloud/spanner/operations/list +++ b/gcloud/spanner/operations/list @@ -1,15 +1,17 @@ NAME gcloud spanner operations list - list the Cloud Spanner operations on the - given instance or database + given instance or database or instance configuration SYNOPSIS - gcloud spanner operations list --instance=INSTANCE [--backup=BACKUP] - [--database=DATABASE] [--type=TYPE] [--filter=EXPRESSION] - [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] - [GCLOUD_WIDE_FLAG ...] + gcloud spanner operations list + (--instance=INSTANCE | --instance-config=INSTANCE_CONFIG) + [--backup=BACKUP] [--database=DATABASE] [--type=TYPE] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - List the Cloud Spanner operations on the given instance or database. + List the Cloud Spanner operations on the given instance or database or + instance configuration. EXAMPLES To list Cloud Spanner instance operations for an instance, run: @@ -43,8 +45,13 @@ EXAMPLES --backup=my-backup-id --type=BACKUP REQUIRED FLAGS - --instance=INSTANCE - The ID of the instance the operations are executing on. + Exactly one of these must be specified: + + --instance=INSTANCE + The ID of the instance the operation is executing on. + + --instance-config=INSTANCE_CONFIG + The ID of the instance configuration the operation is executing on. FLAGS --backup=BACKUP @@ -84,6 +91,12 @@ FLAGS INSTANCE Returns instance operations for the given instance. Note, type=INSTANCE does not work with --database or --backup. + INSTANCE_CONFIG_CREATE + Instance configuration create operations are returned for the given + instance configuration (--instance-config). + INSTANCE_CONFIG_UPDATE + Instance configuration update operations are returned for the given + instance configuration (--instance-config). LIST COMMAND FLAGS --filter=EXPRESSION diff --git a/gcloud/sql/instances/create b/gcloud/sql/instances/create index 8c068b07c..ff5686d95 100644 --- a/gcloud/sql/instances/create +++ b/gcloud/sql/instances/create @@ -41,7 +41,7 @@ SYNOPSIS [--retained-transaction-log-days=RETAINED_TRANSACTION_LOG_DAYS] [--root-password=ROOT_PASSWORD] [--[no-]storage-auto-increase] [--storage-size=STORAGE_SIZE] [--storage-type=STORAGE_TYPE] - [--tier=TIER, -t TIER] + [--tier=TIER, -t TIER] [--time-zone=TIME_ZONE] [--disk-encryption-key=DISK_ENCRYPTION_KEY : --disk-encryption-key-keyring=DISK_ENCRYPTION_KEY_KEYRING --disk-encryption-key-location=DISK_ENCRYPTION_KEY_LOCATION @@ -356,6 +356,9 @@ FLAGS --memory flags. Learn more about how CPU and memory affects pricing: https://cloud.google.com/sql/pricing. + --time-zone=TIME_ZONE + Set a non-default time zone. Only available for SQL Server instances. + Key resource - The Cloud KMS (Key Management Service) cryptokey that will be used to protect the instance. The 'Compute Engine Service Agent' service account must hold permission 'Cloud KMS CryptoKey diff --git a/gcloud/storage/buckets/notifications/delete b/gcloud/storage/buckets/notifications/delete index df781ddd6..456a8c6bb 100644 --- a/gcloud/storage/buckets/notifications/delete +++ b/gcloud/storage/buckets/notifications/delete @@ -22,7 +22,7 @@ EXAMPLES example-bucket: $ gcloud storage buckets notifications delete \ - b/example-bucket/notificationConfigs/3 + projects/_/buckets/example-bucket/notificationConfigs/3 Delete all notification configurations in the bucket example-bucket: diff --git a/gcloud/storage/buckets/notifications/describe b/gcloud/storage/buckets/notifications/describe index 3251ad28d..5528fb28e 100644 --- a/gcloud/storage/buckets/notifications/describe +++ b/gcloud/storage/buckets/notifications/describe @@ -14,7 +14,7 @@ EXAMPLES example-bucket: $ gcloud storage buckets notifications describe \ - b/example-bucket/notificationConfigs/3 + projects/_/buckets/example-bucket/notificationConfigs/3 POSITIONAL ARGUMENTS URL