diff --git a/gcloud/_version b/gcloud/_version index 9111d522b..83a514ed0 100644 --- a/gcloud/_version +++ b/gcloud/_version @@ -1,8 +1,8 @@ -Google Cloud SDK 415.0.0 -alpha 2023.01.20 -beta 2023.01.20 +Google Cloud SDK 416.0.0 +alpha 2023.01.30 +beta 2023.01.30 bq 2.0.84 bundled-python3-unix 3.9.16 -core 2023.01.20 +core 2023.01.30 gcloud-crc32c 1.0.0 -gsutil 5.18 +gsutil 5.19 diff --git a/gcloud/ai/hp-tuning-jobs/create b/gcloud/ai/hp-tuning-jobs/create index 280a670fa..b9477b91c 100644 --- a/gcloud/ai/hp-tuning-jobs/create +++ b/gcloud/ai/hp-tuning-jobs/create @@ -5,9 +5,9 @@ SYNOPSIS gcloud ai hp-tuning-jobs create --config=CONFIG --display-name=DISPLAY_NAME [--algorithm=ALGORITHM] [--enable-dashboard-access] [--enable-web-access] [--labels=[KEY=VALUE,...]] - [--max-trial-count=MAX_TRIAL_COUNT; default=1] [--network=NETWORK] - [--parallel-trial-count=PARALLEL_TRIAL_COUNT; default=1] - [--region=REGION] [--service-account=SERVICE_ACCOUNT] + [--max-trial-count=MAX_TRIAL_COUNT] [--network=NETWORK] + [--parallel-trial-count=PARALLEL_TRIAL_COUNT] [--region=REGION] + [--service-account=SERVICE_ACCOUNT] [--kms-key=KMS_KEY : --kms-keyring=KMS_KEYRING --kms-location=KMS_LOCATION --kms-project=KMS_PROJECT] [GCLOUD_WIDE_FLAG ...] @@ -81,7 +81,7 @@ OPTIONAL FLAGS contain only hyphens (-), underscores (_), lowercase characters, and numbers. - --max-trial-count=MAX_TRIAL_COUNT; default=1 + --max-trial-count=MAX_TRIAL_COUNT Desired total number of trials. The default value is 1. --network=NETWORK @@ -89,7 +89,7 @@ OPTIONAL FLAGS peered with. Private services access must already have been configured. If unspecified, the Job is not peered with any network. - --parallel-trial-count=PARALLEL_TRIAL_COUNT; default=1 + --parallel-trial-count=PARALLEL_TRIAL_COUNT Desired number of Trials to run in parallel. The default value is 1. Region resource - Cloud region to create a hyperparameter tuning job. This diff --git a/gcloud/alpha/ai/hp-tuning-jobs/create b/gcloud/alpha/ai/hp-tuning-jobs/create index deedfbc6c..9b5f3089e 100644 --- a/gcloud/alpha/ai/hp-tuning-jobs/create +++ b/gcloud/alpha/ai/hp-tuning-jobs/create @@ -5,9 +5,8 @@ SYNOPSIS gcloud alpha ai hp-tuning-jobs create --config=CONFIG --display-name=DISPLAY_NAME [--algorithm=ALGORITHM] [--enable-dashboard-access] [--enable-web-access] - [--labels=[KEY=VALUE,...]] - [--max-trial-count=MAX_TRIAL_COUNT; default=1] [--network=NETWORK] - [--parallel-trial-count=PARALLEL_TRIAL_COUNT; default=1] + [--labels=[KEY=VALUE,...]] [--max-trial-count=MAX_TRIAL_COUNT] + [--network=NETWORK] [--parallel-trial-count=PARALLEL_TRIAL_COUNT] [--region=REGION] [--service-account=SERVICE_ACCOUNT] [--kms-key=KMS_KEY : --kms-keyring=KMS_KEYRING --kms-location=KMS_LOCATION --kms-project=KMS_PROJECT] @@ -82,7 +81,7 @@ OPTIONAL FLAGS contain only hyphens (-), underscores (_), lowercase characters, and numbers. - --max-trial-count=MAX_TRIAL_COUNT; default=1 + --max-trial-count=MAX_TRIAL_COUNT Desired total number of trials. The default value is 1. --network=NETWORK @@ -90,7 +89,7 @@ OPTIONAL FLAGS peered with. Private services access must already have been configured. If unspecified, the Job is not peered with any network. - --parallel-trial-count=PARALLEL_TRIAL_COUNT; default=1 + --parallel-trial-count=PARALLEL_TRIAL_COUNT Desired number of Trials to run in parallel. The default value is 1. Region resource - Cloud region to create a hyperparameter tuning job. This diff --git a/gcloud/alpha/alloydb/clusters/create b/gcloud/alpha/alloydb/clusters/create index 037aa1f1d..9637b6d6d 100644 --- a/gcloud/alpha/alloydb/clusters/create +++ b/gcloud/alpha/alloydb/clusters/create @@ -5,6 +5,10 @@ NAME SYNOPSIS gcloud alpha alloydb clusters create CLUSTER --password=PASSWORD --region=REGION [--async] [--network=NETWORK] + [--continuous-backup-recovery-window-days=RECOVERY_PERIOD + --enable-continuous-backup + [--continuous-backup-encryption-key=CONTINUOUS_BACKUP_ENCRYPTION_KEY + : --continuous-backup-encryption-key-keyring=CONTINUOUS_BACKUP_ENCRYPTION_KEY_KEYRING --continuous-backup-encryption-key-location=CONTINUOUS_BACKUP_ENCRYPTION_KEY_LOCATION --continuous-backup-encryption-key-project=CONTINUOUS_BACKUP_ENCRYPTION_KEY_PROJECT]] [--disable-automated-backup | [--automated-backup-days-of-week=[DAYS_OF_WEEK,...] --automated-backup-start-times=[START_TIMES,...] @@ -48,6 +52,52 @@ OPTIONAL FLAGS network, 'testsharednetwork', this would be of the form:--network=projects/testproject/global/networks/testsharednetwork + Continuous Backup configuration. + + --continuous-backup-recovery-window-days=RECOVERY_PERIOD + Recovery window of the log files and backups saved to support + Continuous Backups. + + --enable-continuous-backup + Enables Continuous Backups on the cluster. + + Key resource - The Cloud KMS (Key Management Service) cryptokey that + will be used to protect the continuous backup. The 'AlloyDB Service + Agent's service account must hold permission 'Cloud KMS CryptoKey + Encrypter/Decrypter'. The arguments in this group can be used to specify + the attributes of this resource. + + --continuous-backup-encryption-key=CONTINUOUS_BACKUP_ENCRYPTION_KEY + ID of the key or fully qualified identifier for the key. To set the + kms-key attribute: + ▫ provide the argument --continuous-backup-encryption-key on the + command line. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --continuous-backup-encryption-key-keyring=CONTINUOUS_BACKUP_ENCRYPTION_KEY_KEYRING + The KMS keyring of the key. To set the kms-keyring attribute: + ▫ provide the argument --continuous-backup-encryption-key on the + command line with a fully specified name; + ▫ provide the argument --continuous-backup-encryption-key-keyring + on the command line. + + --continuous-backup-encryption-key-location=CONTINUOUS_BACKUP_ENCRYPTION_KEY_LOCATION + The Cloud location for the key. To set the kms-location attribute: + ▫ provide the argument --continuous-backup-encryption-key on the + command line with a fully specified name; + ▫ provide the argument + --continuous-backup-encryption-key-location on the command line. + + --continuous-backup-encryption-key-project=CONTINUOUS_BACKUP_ENCRYPTION_KEY_PROJECT + The Cloud project for the key. To set the kms-project attribute: + ▫ provide the argument --continuous-backup-encryption-key on the + command line with a fully specified name; + ▫ provide the argument --continuous-backup-encryption-key-project + on the command line; + ▫ set the property core/project. + Automated backup policy. If unspecified, automated backups are enabled. At most one of these can be specified: diff --git a/gcloud/alpha/alloydb/clusters/restore b/gcloud/alpha/alloydb/clusters/restore index caeefd23c..f568d59c6 100644 --- a/gcloud/alpha/alloydb/clusters/restore +++ b/gcloud/alpha/alloydb/clusters/restore @@ -3,8 +3,10 @@ NAME given backup SYNOPSIS - gcloud alpha alloydb clusters restore CLUSTER --region=REGION - --backup=BACKUP [--async] [--network=NETWORK] + gcloud alpha alloydb clusters restore CLUSTER --region=REGION [--async] + [--network=NETWORK] + [--backup=BACKUP + : --point-in-time=POINT_IN_TIME --source-cluster=SOURCE_CLUSTER] [--kms-key=KMS_KEY : --kms-keyring=KMS_KEYRING --kms-location=KMS_LOCATION --kms-project=KMS_PROJECT] [GCLOUD_WIDE_FLAG ...] @@ -28,15 +30,6 @@ REQUIRED FLAGS regions at https://cloud.google.com/sql/docs/instance-locations. OPTIONAL FLAGS - RestoreCluster source types. - - At most one of these can be specified: - - Restore a cluster using a specific backup as the source. - - --backup=BACKUP - AlloyDB backup ID - --async Return immediately, without waiting for the operation in progress to complete. @@ -48,6 +41,30 @@ OPTIONAL FLAGS network, 'testsharednetwork', this would be of the form:--network=projects/testproject/global/networks/testsharednetwork + RestoreCluster source types. + + At most one of these can be specified: + + Restore a cluster using a specific backup as the source. + + --backup=BACKUP + AlloyDB backup ID + + Restore a cluster from a source cluster at a given point in time. + + --point-in-time=POINT_IN_TIME + Point in time to restore to, in RFC 3339 format. For example, + 2012-11-15T16:19:00.094Z. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --source-cluster=SOURCE_CLUSTER + Source cluster name. + + This flag argument must be specified if any of the other arguments + in this group are specified. + Key resource - The Cloud KMS (Key Management Service) cryptokey that will be used to protect the cluster. The 'AlloyDB Service Agent' service account must hold permission 'Cloud KMS CryptoKey Encrypter/Decrypter'. diff --git a/gcloud/alpha/alloydb/clusters/update b/gcloud/alpha/alloydb/clusters/update index 8aa413242..27b9bb646 100644 --- a/gcloud/alpha/alloydb/clusters/update +++ b/gcloud/alpha/alloydb/clusters/update @@ -10,6 +10,10 @@ SYNOPSIS : --automated-backup-window=TIMEOUT_PERIOD [--automated-backup-encryption-key=AUTOMATED_BACKUP_ENCRYPTION_KEY : --automated-backup-encryption-key-keyring=AUTOMATED_BACKUP_ENCRYPTION_KEY_KEYRING --automated-backup-encryption-key-location=AUTOMATED_BACKUP_ENCRYPTION_KEY_LOCATION --automated-backup-encryption-key-project=AUTOMATED_BACKUP_ENCRYPTION_KEY_PROJECT] --automated-backup-retention-count=RETENTION_COUNT | --automated-backup-retention-period=RETENTION_PERIOD]] + [--continuous-backup-recovery-window-days=RECOVERY_PERIOD + --enable-continuous-backup + [--continuous-backup-encryption-key=CONTINUOUS_BACKUP_ENCRYPTION_KEY + : --continuous-backup-encryption-key-keyring=CONTINUOUS_BACKUP_ENCRYPTION_KEY_KEYRING --continuous-backup-encryption-key-location=CONTINUOUS_BACKUP_ENCRYPTION_KEY_LOCATION --continuous-backup-encryption-key-project=CONTINUOUS_BACKUP_ENCRYPTION_KEY_PROJECT]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -126,6 +130,52 @@ OPTIONAL FLAGS Retention period of the backup relative to creation time. See $ gcloud topic datetimes for information on duration formats. + Continuous Backup configuration. + + --continuous-backup-recovery-window-days=RECOVERY_PERIOD + Recovery window of the log files and backups saved to support + Continuous Backups. + + --enable-continuous-backup + Enables Continuous Backups on the cluster. + + Key resource - The Cloud KMS (Key Management Service) cryptokey that + will be used to protect the continuous backup. The 'AlloyDB Service + Agent's service account must hold permission 'Cloud KMS CryptoKey + Encrypter/Decrypter'. The arguments in this group can be used to specify + the attributes of this resource. + + --continuous-backup-encryption-key=CONTINUOUS_BACKUP_ENCRYPTION_KEY + ID of the key or fully qualified identifier for the key. To set the + kms-key attribute: + ▫ provide the argument --continuous-backup-encryption-key on the + command line. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --continuous-backup-encryption-key-keyring=CONTINUOUS_BACKUP_ENCRYPTION_KEY_KEYRING + The KMS keyring of the key. To set the kms-keyring attribute: + ▫ provide the argument --continuous-backup-encryption-key on the + command line with a fully specified name; + ▫ provide the argument --continuous-backup-encryption-key-keyring + on the command line. + + --continuous-backup-encryption-key-location=CONTINUOUS_BACKUP_ENCRYPTION_KEY_LOCATION + The Cloud location for the key. To set the kms-location attribute: + ▫ provide the argument --continuous-backup-encryption-key on the + command line with a fully specified name; + ▫ provide the argument + --continuous-backup-encryption-key-location on the command line. + + --continuous-backup-encryption-key-project=CONTINUOUS_BACKUP_ENCRYPTION_KEY_PROJECT + The Cloud project for the key. To set the kms-project attribute: + ▫ provide the argument --continuous-backup-encryption-key on the + command line with a fully specified name; + ▫ provide the argument --continuous-backup-encryption-key-project + on the command line; + ▫ set the property core/project. + 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/blockchain-node-engine/nodes/describe b/gcloud/alpha/blockchain-node-engine/nodes/describe new file mode 100644 index 000000000..d3f5a9dec --- /dev/null +++ b/gcloud/alpha/blockchain-node-engine/nodes/describe @@ -0,0 +1,64 @@ +NAME + gcloud alpha blockchain-node-engine nodes describe - describe a Blockchain + Node Engine node + +SYNOPSIS + gcloud alpha blockchain-node-engine nodes describe + (NODE_NAME : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Describe a Blockchain Node Engine node configuration and state. + +EXAMPLES + To describe a blockchain node with id my-node, run: + + $ gcloud alpha blockchain-node-engine nodes describe my-node + +POSITIONAL ARGUMENTS + Node resource - Arguments and flags that specify the Blockchain Node + Engine node you want to describe. The arguments in this group can be used + to specify the attributes of this resource. (NOTE) Some attributes are not + given arguments in this group but can be set in other ways. To set the + project attribute: + ◆ provide the argument node_name on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + NODE_NAME + ID of the node or fully qualified identifier for the node. To set the + node_name attribute: + ▸ provide the argument node_name on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Location of the blockchain node resource. + + To set the location attribute: + ▸ provide the argument node_name on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property web3/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. + +API REFERENCE + This command uses the blockchainnodeengine/v1alpha1 API. The full + documentation for this API can be found at: https://cloud.google.com/web3 + +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/blockchain-node-engine/nodes/help b/gcloud/alpha/blockchain-node-engine/nodes/help index 813ce5094..5a97177a0 100644 --- a/gcloud/alpha/blockchain-node-engine/nodes/help +++ b/gcloud/alpha/blockchain-node-engine/nodes/help @@ -16,6 +16,9 @@ GCLOUD WIDE FLAGS COMMANDS COMMAND is one of the following: + describe + (ALPHA) Describe a Blockchain Node Engine node. + list (ALPHA) List Blockchain Node Engine nodes. diff --git a/gcloud/alpha/compute/commitments/create b/gcloud/alpha/compute/commitments/create index f2214c2fe..662a5b783 100644 --- a/gcloud/alpha/compute/commitments/create +++ b/gcloud/alpha/compute/commitments/create @@ -174,8 +174,7 @@ OPTIONAL FLAGS --maintenance-interval=MAINTENANCE_INTERVAL Specifies how infrastructure upgrades should be applied to the - VM. MAINTENANCE_INTERVAL must be (currently only one value is - supported): + VM. MAINTENANCE_INTERVAL must be one of: PERIODIC VMs receive infrastructure and hypervisor updates on a @@ -183,6 +182,14 @@ OPTIONAL FLAGS operations (live migrations or terminations) on an individual VM. Security updates will still be applied as soon as they are available. + RECURRENT + VMs receive infrastructure and hypervisor updates on a + periodic basis, minimizing the number of maintenance + operations (live migrations or terminations) on an individual + VM. This may mean a VM will take longer to receive an update + than if it was configured for AS_NEEDED. Security updates + will still be applied as soonas they are available. RECURRENT + is used for GEN3 and Sliceof Hardware VMs. --min-cpu-platform=MIN_CPU_PLATFORM Optional minimum CPU platform of the reservation to create. diff --git a/gcloud/alpha/compute/forwarding-rules/create b/gcloud/alpha/compute/forwarding-rules/create index 81cb23456..6af1754ed 100644 --- a/gcloud/alpha/compute/forwarding-rules/create +++ b/gcloud/alpha/compute/forwarding-rules/create @@ -201,10 +201,9 @@ OPTIONAL FLAGS service or a target instance. --allow-psc-global-access - If specified, then clients from all regions can access this Private - Service Connect forwarding rule. This can only be specified if the - forwarding rule's target is a service attachment - (--target-service-attachment). + If specified, clients from all regions can access this Private Service + Connect forwarding rule. This can only be specified if the forwarding + rule's target is a service attachment (--target-service-attachment). --description=DESCRIPTION Optional textual description for the forwarding rule. diff --git a/gcloud/alpha/compute/forwarding-rules/update b/gcloud/alpha/compute/forwarding-rules/update index 9e7106f75..8a498006f 100644 --- a/gcloud/alpha/compute/forwarding-rules/update +++ b/gcloud/alpha/compute/forwarding-rules/update @@ -49,10 +49,9 @@ FLAGS service or a target instance. --allow-psc-global-access - If specified, then clients from all regions can access this Private - Service Connect forwarding rule. This can only be specified if the - forwarding rule's target is a service attachment - (--target-service-attachment). + If specified, clients from all regions can access this Private Service + Connect forwarding rule. This can only be specified if the forwarding + rule's target is a service attachment (--target-service-attachment). --network-tier=NETWORK_TIER Update the network tier of a forwarding rule. It does not allow to diff --git a/gcloud/alpha/compute/future-reservations/create b/gcloud/alpha/compute/future-reservations/create index 61fbf40bf..f688023c8 100644 --- a/gcloud/alpha/compute/future-reservations/create +++ b/gcloud/alpha/compute/future-reservations/create @@ -108,14 +108,21 @@ REQUIRED FLAGS --maintenance-interval=MAINTENANCE_INTERVAL Specifies how infrastructure upgrades should be applied to the VM. - MAINTENANCE_INTERVAL must be (currently only one value is - supported): + MAINTENANCE_INTERVAL must be one of: PERIODIC VMs receive infrastructure and hypervisor updates on a periodic basis, minimizing the number of maintenance operations (live migrations or terminations) on an individual VM. Security updates will still be applied as soon as they are available. + RECURRENT + VMs receive infrastructure and hypervisor updates on a periodic + basis, minimizing the number of maintenance operations (live + migrations or terminations) on an individual VM. This may mean + a VM will take longer to receive an update than if it was + configured for AS_NEEDED. Security updates will still be + applied as soonas they are available. RECURRENT is used for + GEN3 and Sliceof Hardware VMs. --min-cpu-platform=MIN_CPU_PLATFORM Optional minimum CPU platform of the reservation to create. diff --git a/gcloud/alpha/compute/future-reservations/update b/gcloud/alpha/compute/future-reservations/update index 011d97baa..a3745476a 100644 --- a/gcloud/alpha/compute/future-reservations/update +++ b/gcloud/alpha/compute/future-reservations/update @@ -106,13 +106,21 @@ FLAGS --maintenance-interval=MAINTENANCE_INTERVAL Specifies how infrastructure upgrades should be applied to the VM. - MAINTENANCE_INTERVAL must be (currently only one value is supported): + MAINTENANCE_INTERVAL must be one of: PERIODIC VMs receive infrastructure and hypervisor updates on a periodic basis, minimizing the number of maintenance operations (live migrations or terminations) on an individual VM. Security updates will still be applied as soon as they are available. + RECURRENT + VMs receive infrastructure and hypervisor updates on a periodic + basis, minimizing the number of maintenance operations (live + migrations or terminations) on an individual VM. This may mean a + VM will take longer to receive an update than if it was + configured for AS_NEEDED. Security updates will still be applied + as soonas they are available. RECURRENT is used for GEN3 and + Sliceof Hardware VMs. --min-cpu-platform=MIN_CPU_PLATFORM Optional minimum CPU platform of the reservation to create. diff --git a/gcloud/alpha/compute/instance-groups/managed/create b/gcloud/alpha/compute/instance-groups/managed/create index c684ec879..80e76f3ba 100644 --- a/gcloud/alpha/compute/instance-groups/managed/create +++ b/gcloud/alpha/compute/instance-groups/managed/create @@ -29,14 +29,30 @@ DESCRIPTION (ALPHA) gcloud alpha compute instance-groups managed create creates a Compute Engine managed instance group. - For example, running: +EXAMPLES + Running: $ gcloud alpha compute instance-groups managed create \ - example-managed-instance-group --zone us-central1-a \ - --template example-instance-template --size 1 + example-managed-instance-group --zone=us-central1-a \ + --template=example-global-instance-template --size=1 will create one managed instance group called - 'example-managed-instance-group' in the us-central1-a zone. + 'example-managed-instance-group' in the us-central1-a zone with global + instance template resource: 'example-global-instance-template'. + + To use a regional instance template, specify its full URL. + + Running: + + $ gcloud alpha compute instance-groups managed create \ + example-managed-instance-group --zone=us-central1-a \ + --template=https://www.googleapis.com/compute/alpha/projects/\ + example-project/regions/us-central1/instanceTemplates/\ + example-regional-instance-template --size=1 + + will create one managed instance group called + 'example-managed-instance-group' in the us-central1-a zone with regional + instance template resource: 'example-instance-template'. POSITIONAL ARGUMENTS NAME @@ -44,16 +60,17 @@ POSITIONAL ARGUMENTS REQUIRED FLAGS --size=SIZE - The initial number of instances you want in this group. + Initial number of instances you want in this group. --template=TEMPLATE - Specifies the instance template to use when creating new instances. + Specifies the instance template to use when creating new instances. An + instance template is either a global or regional resource. OPTIONAL FLAGS --base-instance-name=BASE_INSTANCE_NAME - The base name to use for the Compute Engine instances that will be - created with the managed instance group. If not provided base instance - name will be the prefix of instance group name. + Base name to use for the Compute Engine instances that will be created + with the managed instance group. If not provided base instance name + will be the prefix of instance group name. --description=DESCRIPTION An optional description for this group. diff --git a/gcloud/alpha/compute/instances/bulk/create b/gcloud/alpha/compute/instances/bulk/create index b8667c792..8b450b9a6 100644 --- a/gcloud/alpha/compute/instances/bulk/create +++ b/gcloud/alpha/compute/instances/bulk/create @@ -23,6 +23,7 @@ SYNOPSIS [--local-ssd=[device-name=DEVICE-NAME], [interface=INTERFACE],[size=SIZE]] [--location-policy=[ZONE=POLICY,...]] [--machine-type=MACHINE_TYPE] + [--max-count-per-zone=[ZONE=MAX_COUNT_PER_ZONE,...]] [--max-run-duration=MAX_RUN_DURATION] [--metadata=KEY=VALUE,[KEY=VALUE,...]] [--metadata-from-file=KEY=LOCAL_FILE_PATH,[...]] @@ -458,8 +459,8 @@ OPTIONAL FLAGS Policy for which zones to include or exclude during bulk instance creation within a region. Policy is defined as a list of key-value pairs, with the key being the zone name, and value being the applied - policy. Available policies are allow and deny. Default for zones left - unspecified is allow. + policy. Available policies are allow and deny. Default for zones if + left unspecified is allow. Example: @@ -472,6 +473,17 @@ OPTIONAL FLAGS available machine types, run 'gcloud compute machine-types list'. If unspecified, the default type is n1-standard-1. + --max-count-per-zone=[ZONE=MAX_COUNT_PER_ZONE,...] + Maximum number of instances per zone specified as key-value pairs. The + zone name is the key and the max count per zone is the value in that + zone. + + Example: + + gcloud compute instances bulk create --name-pattern=example-### + --count=5 --region=us-east1 + --max-count-per-zone=us-east1-b=2,us-east-1-c=1 + --max-run-duration=MAX_RUN_DURATION Limits how long this VM instance can run, specified as a duration relative to the VM instance's most-recent start time. Format the diff --git a/gcloud/alpha/compute/instances/create b/gcloud/alpha/compute/instances/create index d34cb6017..3b729312e 100644 --- a/gcloud/alpha/compute/instances/create +++ b/gcloud/alpha/compute/instances/create @@ -386,11 +386,11 @@ FLAGS https://cloud.google.com/compute/docs/disks/sharing-disks-between-vms. replica-zones - If specified, the created disk is regional. Only one zone can be - specified and it has to be different from the zone of the instance, - the other replica zone will be inferred from the instance zone. The - disk will be replicated to the specified replica zone and the zone - of the newly created instance. + Required for each regional disk associated with the instance. + Specify the URLs of the zones where the disk should be replicated + to. You must provide exactly two replica zones, and one zone must + be the same as the instance zone. You can't use this option with + boot disks. provisioned-throughput Indicates how much throughput to provision for the disk. This sets @@ -601,13 +601,20 @@ FLAGS --maintenance-interval=MAINTENANCE_INTERVAL Specifies how infrastructure upgrades should be applied to the VM. - MAINTENANCE_INTERVAL must be (currently only one value is supported): + MAINTENANCE_INTERVAL must be one of: PERIODIC VMs receive infrastructure and hypervisor updates on a periodic basis, minimizing the number of maintenance operations (live migrations or terminations) on an individual VM. Security updates will still be applied as soon as they are available. + RECURRENT + VMs receive infrastructure and hypervisor updates on a periodic + basis, minimizing the number of maintenance operations (live + migrations or terminations) on an individual VM. This may mean a VM + will take longer to receive an update than if it was configured for + AS_NEEDED. Security updates will still be applied as soonas they + are available. RECURRENT is used for GEN3 and Sliceof Hardware VMs. --max-run-duration=MAX_RUN_DURATION Limits how long this VM instance can run, specified as a duration diff --git a/gcloud/alpha/compute/queued-resources/create b/gcloud/alpha/compute/queued-resources/create index 110c5f27b..4489e887e 100644 --- a/gcloud/alpha/compute/queued-resources/create +++ b/gcloud/alpha/compute/queued-resources/create @@ -443,8 +443,8 @@ OPTIONAL FLAGS Policy for which zones to include or exclude during bulk instance creation within a region. Policy is defined as a list of key-value pairs, with the key being the zone name, and value being the applied - policy. Available policies are allow and deny. Default for zones left - unspecified is allow. + policy. Available policies are allow and deny. Default for zones if + left unspecified is allow. Example: diff --git a/gcloud/alpha/compute/queued-resources/help b/gcloud/alpha/compute/queued-resources/help index aab7d75a0..a9fe10e8a 100644 --- a/gcloud/alpha/compute/queued-resources/help +++ b/gcloud/alpha/compute/queued-resources/help @@ -28,7 +28,7 @@ COMMANDS (ALPHA) Describe a Compute Engine queued resource. list - (ALPHA) List Compute Engine queued resources. + (ALPHA) List Google Compute Engine queued resources. NOTES This command is currently in alpha and might change without notice. If this diff --git a/gcloud/alpha/compute/queued-resources/list b/gcloud/alpha/compute/queued-resources/list index 69af63178..70d5e6c48 100644 --- a/gcloud/alpha/compute/queued-resources/list +++ b/gcloud/alpha/compute/queued-resources/list @@ -1,32 +1,53 @@ NAME - gcloud alpha compute queued-resources list - list Compute Engine queued - resources + gcloud alpha compute queued-resources list - list Google Compute Engine + queued resources SYNOPSIS - gcloud alpha compute queued-resources list --zones=ZONE,[ZONE,...] + gcloud alpha compute queued-resources list [NAME ...] + [--regexp=REGEXP, -r REGEXP] [--zones=ZONE,[ZONE,...]] [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) gcloud alpha compute queued-resources list displays all Compute - Engine queued resources in a project in given zones. + (ALPHA) gcloud alpha compute queued-resources list displays all Google + Compute Engine queued resources in a project. + + By default, queued resources from all zones are listed. The results can be + narrowed down using a filter: --filter="zone:( ZONE ... )". EXAMPLES - To list all queued resources in a project in table form in specified zones, + To list all queued resources in a project in table form, run: + + $ gcloud alpha compute queued-resources list + + To list the URIs of all queued resources in a project, run: + + $ gcloud alpha compute queued-resources list --uri + + To list all queued resources in the us-central1-b and europe-west1-d zones, run: $ gcloud alpha compute queued-resources list \ - --zones=us-central1-a,us-central1-b + --filter="zone:( us-central1-b europe-west1-d )" - To list the URIs of all queued resources in a project in specified zones, - run: +POSITIONAL ARGUMENTS + [NAME ...] + (DEPRECATED) If provided, show details for the specified names and/or + URIs of resources. - $ gcloud alpha compute queued-resources list \ - --zones=us-central1-a,us-central1-b --uri + Argument NAME is deprecated. Use --filter="name=( 'NAME' ... )" + instead. + +FLAGS + --regexp=REGEXP, -r REGEXP + (DEPRECATED) Regular expression to filter the names of the results on. + Any names that do not match the entire regular expression will be + filtered out. + + Flag --regexp is deprecated. Use --filter="name~'REGEXP'" instead. -REQUIRED FLAGS --zones=ZONE,[ZONE,...] - Only resources from the given zones are queried. + If provided, only resources from the given zones are queried. LIST COMMAND FLAGS --filter=EXPRESSION diff --git a/gcloud/alpha/compute/reservations/create b/gcloud/alpha/compute/reservations/create index c91653cb8..41bf718cf 100644 --- a/gcloud/alpha/compute/reservations/create +++ b/gcloud/alpha/compute/reservations/create @@ -119,8 +119,7 @@ REQUIRED FLAGS --maintenance-interval=MAINTENANCE_INTERVAL Specifies how infrastructure upgrades should be applied to the - VM. MAINTENANCE_INTERVAL must be (currently only one value is - supported): + VM. MAINTENANCE_INTERVAL must be one of: PERIODIC VMs receive infrastructure and hypervisor updates on a @@ -128,6 +127,14 @@ REQUIRED FLAGS operations (live migrations or terminations) on an individual VM. Security updates will still be applied as soon as they are available. + RECURRENT + VMs receive infrastructure and hypervisor updates on a + periodic basis, minimizing the number of maintenance + operations (live migrations or terminations) on an individual + VM. This may mean a VM will take longer to receive an update + than if it was configured for AS_NEEDED. Security updates + will still be applied as soonas they are available. RECURRENT + is used for GEN3 and Sliceof Hardware VMs. --min-cpu-platform=MIN_CPU_PLATFORM Optional minimum CPU platform of the reservation to create. diff --git a/gcloud/alpha/compute/resource-policies/create-snapshot-schedule b/gcloud/alpha/compute/resource-policies/create-snapshot-schedule index d722d971a..c8ad5e5a9 100644 --- a/gcloud/alpha/compute/resource-policies/create-snapshot-schedule +++ b/gcloud/alpha/compute/resource-policies/create-snapshot-schedule @@ -39,17 +39,20 @@ REQUIRED FLAGS Exactly one of these must be specified: - From file: + Using a file: --weekly-schedule-from-file=WEEKLY_CYCLE_FROM_FILE - A JSON/YAML file which specifies a weekly schedule. It should be a - list of objects with the following fields: + A JSON/YAML file which specifies a weekly schedule. The file should + contain the following fields: day: Day of the week with the same choices as --weekly-schedule. startTime: Start time of the snapshot schedule with the same format as --start-time. - From flags: + For more information about using a file, see + https://cloud.google.com/compute/docs/disks/scheduled-snapshots#create_snapshot_schedule + + Using command flags: --start-time=START_TIME Start time for the disk snapshot schedule. See $ gcloud topic @@ -120,7 +123,7 @@ OPTIONAL FLAGS contain only hyphens (-), underscores (_), lowercase characters, and numbers. - These will be added to the disk snapshots on creation. + The label is added to each snapshot created by the schedule. --storage-location=LOCATION Google Cloud Storage location, either regional or multi-regional, diff --git a/gcloud/alpha/compute/resource-policies/create/snapshot-schedule b/gcloud/alpha/compute/resource-policies/create/snapshot-schedule index 33cd99e6f..f15ede991 100644 --- a/gcloud/alpha/compute/resource-policies/create/snapshot-schedule +++ b/gcloud/alpha/compute/resource-policies/create/snapshot-schedule @@ -37,17 +37,20 @@ REQUIRED FLAGS Exactly one of these must be specified: - From file: + Using a file: --weekly-schedule-from-file=WEEKLY_CYCLE_FROM_FILE - A JSON/YAML file which specifies a weekly schedule. It should be a - list of objects with the following fields: + A JSON/YAML file which specifies a weekly schedule. The file should + contain the following fields: day: Day of the week with the same choices as --weekly-schedule. startTime: Start time of the snapshot schedule with the same format as --start-time. - From flags: + For more information about using a file, see + https://cloud.google.com/compute/docs/disks/scheduled-snapshots#create_snapshot_schedule + + Using command flags: --start-time=START_TIME Start time for the disk snapshot schedule in UTC. For example, @@ -118,7 +121,7 @@ OPTIONAL FLAGS contain only hyphens (-), underscores (_), lowercase characters, and numbers. - These will be added to the disk snapshots on creation. + The label is added to each snapshot created by the schedule. --storage-location=LOCATION Google Cloud Storage location, either regional or multi-regional, diff --git a/gcloud/alpha/compute/resource-policies/help b/gcloud/alpha/compute/resource-policies/help index 2c6aca1d8..13e39c3ee 100644 --- a/gcloud/alpha/compute/resource-policies/help +++ b/gcloud/alpha/compute/resource-policies/help @@ -27,6 +27,9 @@ GROUPS create (ALPHA) Create Compute Engine Resource Policies. + update + (ALPHA) Update Compute Engine Resource Policies. + COMMANDS COMMAND is one of the following: diff --git a/gcloud/alpha/compute/resource-policies/update/help b/gcloud/alpha/compute/resource-policies/update/help new file mode 100644 index 000000000..16e74b9bb --- /dev/null +++ b/gcloud/alpha/compute/resource-policies/update/help @@ -0,0 +1,30 @@ +NAME + gcloud alpha compute resource-policies update - update Compute Engine + Resource Policies + +SYNOPSIS + gcloud alpha compute resource-policies update COMMAND + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Update Compute Engine Resource Policies. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + snapshot-schedule + (ALPHA) Update a Compute Engine Snapshot Schedule Resource Policy. + +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 compute resource-policies update + diff --git a/gcloud/alpha/compute/resource-policies/update/snapshot-schedule b/gcloud/alpha/compute/resource-policies/update/snapshot-schedule new file mode 100644 index 000000000..8645d4f4a --- /dev/null +++ b/gcloud/alpha/compute/resource-policies/update/snapshot-schedule @@ -0,0 +1,116 @@ +NAME + gcloud alpha compute resource-policies update snapshot-schedule - update a + Compute Engine Snapshot Schedule Resource Policy + +SYNOPSIS + gcloud alpha compute resource-policies update snapshot-schedule NAME + [--description=DESCRIPTION] [--region=REGION] + [--snapshot-labels=[KEY=VALUE,...]] + [--weekly-schedule-from-file=WEEKLY_CYCLE_FROM_FILE + | --start-time=START_TIME (--daily-schedule | --hourly-schedule=HOURS + | --weekly-schedule=WEEKLY_CYCLE)] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Update a Compute Engine Snapshot Schedule Resource Policy. + +EXAMPLES + The following command updates a Compute Engine Snapshot Schedule Resource + Policy to take a daily snapshot taken at 13:00 UTC + + $ gcloud alpha compute resource-policies update snapshot-schedule \ + my-resource-policy --region=REGION --start-time=13:00 \ + --daily-schedule + +POSITIONAL ARGUMENTS + NAME + Name of the resource policy to operate on. + +FLAGS + --description=DESCRIPTION + An optional, textual description for the backend. + + --region=REGION + Region of the resource policy to operate on. If not specified, you + might be prompted to select a region (interactive mode only). + + To avoid prompting when this flag is omitted, you can set the + compute/region property: + + $ gcloud config set compute/region REGION + + A list of regions can be fetched by running: + + $ gcloud compute regions list + + To unset the property, run: + + $ gcloud config unset compute/region + + Alternatively, the region can be stored in the environment variable + CLOUDSDK_COMPUTE_REGION. + + --snapshot-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. + + The label is added to each snapshot created by the schedule. + + Cycle Frequency Group. + + At most one of these can be specified: + + Using a file: + + --weekly-schedule-from-file=WEEKLY_CYCLE_FROM_FILE + A JSON/YAML file which specifies a weekly schedule. The file should + contain the following fields: + + day: Day of the week with the same choices as --weekly-schedule. + startTime: Start time of the snapshot schedule with the same format + as --start-time. + + For more information about using a file, see + https://cloud.google.com/compute/docs/disks/scheduled-snapshots#create_snapshot_schedule + + Using command flags: + + --start-time=START_TIME + Start time for the disk snapshot schedule in UTC. For example, + --start-time="15:00". + + This flag argument must be specified if any of the other arguments + in this group are specified. + + Exactly one of these must be specified: + + --daily-schedule + Snapshot schedule starts daily at START_TIME. + + --hourly-schedule=HOURS + Snapshot schedule occurs every n hours starting at START_TIME. + + --weekly-schedule=WEEKLY_CYCLE + Snapshot schedule occurs weekly on WEEKLY_SCHEDULE at START_TIME. + WEEKLY_CYCLE must be one of: monday, tuesday, wednesday, + thursday, friday, saturday, sunday. + +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 compute resource-policies update snapshot-schedule + diff --git a/gcloud/alpha/compute/tpus/queued-resources/create b/gcloud/alpha/compute/tpus/queued-resources/create index 95ed89609..6a7a6fe94 100644 --- a/gcloud/alpha/compute/tpus/queued-resources/create +++ b/gcloud/alpha/compute/tpus/queued-resources/create @@ -5,8 +5,9 @@ NAME SYNOPSIS gcloud alpha compute tpus queued-resources create (QUEUED_RESOURCE : --zone=ZONE) --accelerator-type=ACCELERATOR_TYPE - --node-id=[NODE_ID,...] --runtime-version=RUNTIME_VERSION [--async] - [--best-effort] [--guaranteed] [--internal-ips] [--reserved] + --runtime-version=RUNTIME_VERSION + (--node-id=NODE_ID : --node-count=NODE_COUNT --node-prefix=NODE_PREFIX) + [--async] [--best-effort] [--guaranteed] [--internal-ips] [--reserved] [--valid-after-duration=VALID_AFTER_DURATION] [--valid-after-time=VALID_AFTER_TIME] [--valid-until-duration=VALID_UNTIL_DURATION] @@ -17,19 +18,19 @@ DESCRIPTION EXAMPLES To create a Queued Resource with ID my-queued-resource in zone - us-central1-b and project my-project, run: + us-central2-b and project my-project, run: $ gcloud alpha compute tpus queued-resources create \ - my-queued-resource --accelerator-type=v2-8 \ - --runtime-version=v2-alpha --node-id=my-node-001 \ - --zone=us-central1-b --project=my-project + my-queued-resource --accelerator-type=v4-8 \ + --runtime-version=v2-alpha-tpuv4 --node-id=my-node-001 \ + --zone=us-central2-b --project=my-project To create a Queued Resource with multiple nodes, run: $ gcloud alpha compute tpus queued-resources create \ - my-queued-resource --accelerator-type=v2-8 \ - --runtime-version=v2-alpha --node-id=my-node-001,my-node-002 \ - --zone=us-central1-b --project=my-project + my-queued-resource --accelerator-type=v4-8 \ + --runtime-version=v2-alpha-tpuv4 --node-prefix=my-node \ + --node-count=2 --zone=us-central2-b --project=my-project POSITIONAL ARGUMENTS Queued resource resource - The Queued Resource you want to create. The @@ -66,16 +67,45 @@ REQUIRED FLAGS --accelerator-type=ACCELERATOR_TYPE Accelerator type for the TPU. - --node-id=[NODE_ID,...] - The unqualified Node identifier, used to identify the TPU in the Nodes - collection once provisioned. - - To request a resource with multiple nodes, enter multiple, unique, - unqualified Node identifiers as a comma delimited list. - --runtime-version=RUNTIME_VERSION Runtime version for the TPU, such as 2.3. + Specify TPU node(s) with either a single node id, or a node prefix and + node count combination + + Exactly one of these must be specified: + + Single node creation + + --node-id=NODE_ID + Unqualified node identifier used to identify the node in the + project once provisioned. + + To request a resource with multiple nodes, use --node-prefix to + specify the prefix for each node and --node-count to specify the + number of nodes in place of --node-id. + + Multinode creation + + --node-count=NODE_COUNT + The number of nodes in a multislice provision, also used to + generate the qualified name for nodes in the provision. Value must + be greater than 1. + + Must also specify --node-prefix. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --node-prefix=NODE_PREFIX + Node prefix used to generate the qualified name of each node the + multislice node provision. + + Must also specify --node-count. + + This flag argument must be specified if any of the other arguments + in this group are specified. + OPTIONAL FLAGS --async Return immediately, without waiting for the operation in progress to diff --git a/gcloud/alpha/config/get b/gcloud/alpha/config/get index 3862de10d..dffde274e 100644 --- a/gcloud/alpha/config/get +++ b/gcloud/alpha/config/get @@ -648,6 +648,14 @@ AVAILABLE PROPERTIES SERVICE_ACCOUNT_2. SERVICE_ACCOUNT_1 is the impersonated service account and SERVICE_ACCOUNT_2 is the delegate. + service_account_disable_id_token_refresh + If True, disable ID token refresh for service account. + + service_account_use_self_signed_jwt + If True, use self signed jwt flow to get service account + credentials access token. This only applies to service account json + file and not to the legacy .p12 file. + token_host Overrides the token endpoint to provision access tokens. It can be used with Private Service Connect. diff --git a/gcloud/alpha/config/help b/gcloud/alpha/config/help index c356a28c2..08a4a21c4 100644 --- a/gcloud/alpha/config/help +++ b/gcloud/alpha/config/help @@ -680,6 +680,14 @@ AVAILABLE PROPERTIES SERVICE_ACCOUNT_2. SERVICE_ACCOUNT_1 is the impersonated service account and SERVICE_ACCOUNT_2 is the delegate. + service_account_disable_id_token_refresh + If True, disable ID token refresh for service account. + + service_account_use_self_signed_jwt + If True, use self signed jwt flow to get service account + credentials access token. This only applies to service account json + file and not to the legacy .p12 file. + token_host Overrides the token endpoint to provision access tokens. It can be used with Private Service Connect. diff --git a/gcloud/alpha/config/list b/gcloud/alpha/config/list index 8a60db09e..55de6b459 100644 --- a/gcloud/alpha/config/list +++ b/gcloud/alpha/config/list @@ -692,6 +692,14 @@ AVAILABLE PROPERTIES SERVICE_ACCOUNT_2. SERVICE_ACCOUNT_1 is the impersonated service account and SERVICE_ACCOUNT_2 is the delegate. + service_account_disable_id_token_refresh + If True, disable ID token refresh for service account. + + service_account_use_self_signed_jwt + If True, use self signed jwt flow to get service account + credentials access token. This only applies to service account json + file and not to the legacy .p12 file. + token_host Overrides the token endpoint to provision access tokens. It can be used with Private Service Connect. diff --git a/gcloud/alpha/config/set b/gcloud/alpha/config/set index 57b1c9178..e6775b935 100644 --- a/gcloud/alpha/config/set +++ b/gcloud/alpha/config/set @@ -695,6 +695,14 @@ AVAILABLE PROPERTIES SERVICE_ACCOUNT_2. SERVICE_ACCOUNT_1 is the impersonated service account and SERVICE_ACCOUNT_2 is the delegate. + service_account_disable_id_token_refresh + If True, disable ID token refresh for service account. + + service_account_use_self_signed_jwt + If True, use self signed jwt flow to get service account + credentials access token. This only applies to service account json + file and not to the legacy .p12 file. + token_host Overrides the token endpoint to provision access tokens. It can be used with Private Service Connect. diff --git a/gcloud/alpha/config/unset b/gcloud/alpha/config/unset index ae4aa3bb4..ff0ec8560 100644 --- a/gcloud/alpha/config/unset +++ b/gcloud/alpha/config/unset @@ -656,6 +656,14 @@ AVAILABLE PROPERTIES SERVICE_ACCOUNT_2. SERVICE_ACCOUNT_1 is the impersonated service account and SERVICE_ACCOUNT_2 is the delegate. + service_account_disable_id_token_refresh + If True, disable ID token refresh for service account. + + service_account_use_self_signed_jwt + If True, use self signed jwt flow to get service account + credentials access token. This only applies to service account json + file and not to the legacy .p12 file. + token_host Overrides the token endpoint to provision access tokens. It can be used with Private Service Connect. diff --git a/gcloud/alpha/container/fleet/identity-service/delete b/gcloud/alpha/container/fleet/identity-service/delete index f2283f433..a9c5c209c 100644 --- a/gcloud/alpha/container/fleet/identity-service/delete +++ b/gcloud/alpha/container/fleet/identity-service/delete @@ -4,6 +4,7 @@ NAME SYNOPSIS gcloud alpha container fleet identity-service delete + [--fleet-default-member-config] [--membership=MEMBERSHIP : --location=LOCATION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -16,6 +17,16 @@ EXAMPLES --membership=MEMBERSHIP_NAME FLAGS + --fleet-default-member-config + If specified, deletes the default membership configuration present in + your fleet. + + To delete the default membership configuration present in your + fleet, run: + + $ gcloud alpha container fleet identity-service delete \ + --fleet-default-member-config + Membership resource - The group of arguments defining a membership. 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 diff --git a/gcloud/alpha/container/fleet/identity-service/enable b/gcloud/alpha/container/fleet/identity-service/enable index beb13681c..aeb8bac88 100644 --- a/gcloud/alpha/container/fleet/identity-service/enable +++ b/gcloud/alpha/container/fleet/identity-service/enable @@ -3,7 +3,9 @@ NAME Service Feature SYNOPSIS - gcloud alpha container fleet identity-service enable [GCLOUD_WIDE_FLAG ...] + gcloud alpha container fleet identity-service enable + [--fleet-default-member-config=FLEET_DEFAULT_MEMBER_CONFIG] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) This command enables the Identity Service Feature in a fleet. @@ -13,6 +15,20 @@ EXAMPLES $ gcloud alpha container fleet identity-service enable +FLAGS + --fleet-default-member-config=FLEET_DEFAULT_MEMBER_CONFIG + The path to an identity-service.yaml identity configuration file. If + specified, this configuration would be the default Identity Service + configuration for all memberships in your fleet. It could be overridden + with a membership-specific configuration by using the the Apply command + with the --config argument. + + To enable the Identity Service Feature with a fleet-level default + membership configuration, run: + + $ gcloud alpha container fleet identity-service enable \ + --fleet-default-member-config=/path/to/identity-service.yaml + 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/container/hub/identity-service/delete b/gcloud/alpha/container/hub/identity-service/delete index 4d26ea77c..43262ade8 100644 --- a/gcloud/alpha/container/hub/identity-service/delete +++ b/gcloud/alpha/container/hub/identity-service/delete @@ -4,6 +4,7 @@ NAME SYNOPSIS gcloud alpha container hub identity-service delete + [--fleet-default-member-config] [--membership=MEMBERSHIP : --location=LOCATION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -16,6 +17,16 @@ EXAMPLES --membership=MEMBERSHIP_NAME FLAGS + --fleet-default-member-config + If specified, deletes the default membership configuration present in + your fleet. + + To delete the default membership configuration present in your + fleet, run: + + $ gcloud alpha container hub identity-service delete \ + --fleet-default-member-config + Membership resource - The group of arguments defining a membership. 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 diff --git a/gcloud/alpha/container/hub/identity-service/enable b/gcloud/alpha/container/hub/identity-service/enable index bc4d4c813..7a4efa518 100644 --- a/gcloud/alpha/container/hub/identity-service/enable +++ b/gcloud/alpha/container/hub/identity-service/enable @@ -3,7 +3,9 @@ NAME Service Feature SYNOPSIS - gcloud alpha container hub identity-service enable [GCLOUD_WIDE_FLAG ...] + gcloud alpha container hub identity-service enable + [--fleet-default-member-config=FLEET_DEFAULT_MEMBER_CONFIG] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) This command enables the Identity Service Feature in a fleet. @@ -13,6 +15,20 @@ EXAMPLES $ gcloud alpha container hub identity-service enable +FLAGS + --fleet-default-member-config=FLEET_DEFAULT_MEMBER_CONFIG + The path to an identity-service.yaml identity configuration file. If + specified, this configuration would be the default Identity Service + configuration for all memberships in your fleet. It could be overridden + with a membership-specific configuration by using the the Apply command + with the --config argument. + + To enable the Identity Service Feature with a fleet-level default + membership configuration, run: + + $ gcloud alpha container hub identity-service enable \ + --fleet-default-member-config=/path/to/identity-service.yaml + 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/data-attribute-bindings/add-iam-policy-binding b/gcloud/alpha/dataplex/data-attribute-bindings/add-iam-policy-binding new file mode 100644 index 000000000..a8de031d5 --- /dev/null +++ b/gcloud/alpha/dataplex/data-attribute-bindings/add-iam-policy-binding @@ -0,0 +1,89 @@ +NAME + gcloud alpha dataplex data-attribute-bindings add-iam-policy-binding - add + IAM policy binding to a Dataplex Data Attribute Binding + +SYNOPSIS + gcloud alpha dataplex data-attribute-bindings add-iam-policy-binding + (DATA_ATTRIBUTE_BINDING : --location=LOCATION) --member=PRINCIPAL + --role=ROLE [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Add IAM policy binding to a Dataplex Data Attribute Binding. + +EXAMPLES + To add an IAM policy binding for the role of roles/dataplex.viewer for the + user test-user@gmail.com to Data Attribute Binding test-attribute-binding + in location us-central, run: + + $ gcloud alpha dataplex data-attribute-bindings \ + add-iam-policy-binding test-attribute-binding \ + --project=test-project --location=us-central1 \ + --role=roles/dataplex.viewer --member=user:foo@gmail.com + + See https://cloud.google.com/dataplex/docs/iam-roles for details of policy + role and member types. + +POSITIONAL ARGUMENTS + Data attribute binding resource - The DataAttributeBinding to add IAM + policy binding to. 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 data_attribute_binding 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. + + DATA_ATTRIBUTE_BINDING + ID of the data attribute binding or fully qualified identifier for + the data attribute binding. To set the data_attribute_binding + attribute: + ▸ provide the argument data_attribute_binding on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the Dataplex resource. To set the location attribute: + ▸ provide the argument data_attribute_binding on the command line + with a fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + +REQUIRED FLAGS + --member=PRINCIPAL + The principal to add the binding for. Should be of the form + user|group|serviceAccount:email or domain:domain. + + Examples: user:test-user@gmail.com, group:admins@example.com, + serviceAccount:test123@example.domain.com, or + domain:example.domain.com. + + Some resources also accept the following special values: + ◆ allUsers - Special identifier that represents anyone who is on the + internet, with or without a Google account. + ◆ allAuthenticatedUsers - Special identifier that represents anyone + who is authenticated with a Google account or a service account. + + --role=ROLE + Role name to assign to the principal. The role name is the complete + path of a predefined role, such as roles/logging.viewer, or the role ID + for a custom role, such as + organizations/{ORGANIZATION_ID}/roles/logging.viewer. + +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/dataplex/data-attribute-bindings/create b/gcloud/alpha/dataplex/data-attribute-bindings/create new file mode 100644 index 000000000..b2b2baf14 --- /dev/null +++ b/gcloud/alpha/dataplex/data-attribute-bindings/create @@ -0,0 +1,126 @@ +NAME + gcloud alpha dataplex data-attribute-bindings create - create a Dataplex + Data Attribute Binding + +SYNOPSIS + gcloud alpha dataplex data-attribute-bindings create + (DATA_ATTRIBUTE_BINDING : --location=LOCATION) + [--description=DESCRIPTION] [--display-name=DISPLAY_NAME] + [--labels=[KEY=VALUE,...]] [--path-file-format=PATH_FILE_FORMAT] + [--resource=RESOURCE] [--resource-attributes=[ATTRIBUTES,...]] + [--async | --validate-only] + [--path-file-name=PATH_FILE_NAME | --paths=[PATH,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create a Dataplex Data Attribute Binding. + +EXAMPLES + To create Data Attribute Binding test-attribute-binding in project + test-dataplex at location us-central1 with resouce name 'testResource' and + resource attributes a1 and a2. Test column 'testColumn1' attached to + attribute 'a1' and 'testColumn2' attached to attribute 'a2' , run: + + $ gcloud alpha dataplex data-attribute-bindings create \ + test-attribute-binding --project=test-dataplex \ + --location=us-central1 \ + --resource='projects/test-dataplex/locations/us-central1/lakes/m\ + y-lake/zones/test-zone/entities/testResource' \ + --resource-attributes='a1,a2' \ + --paths=name=testColumn1,attributes=a1 \ + --paths=name=testColumn2,attributes=a2 + +POSITIONAL ARGUMENTS + Data attribute binding resource - The DataAttributeBinding to create. 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 data_attribute_binding 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. + + DATA_ATTRIBUTE_BINDING + ID of the data attribute binding or fully qualified identifier for + the data attribute binding. To set the data_attribute_binding + attribute: + ▸ provide the argument data_attribute_binding on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the Dataplex resource. To set the location attribute: + ▸ provide the argument data_attribute_binding on the command line + with a fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + +FLAGS + --description=DESCRIPTION + Description of the Data Attribute Binding. + + --display-name=DISPLAY_NAME + Display Name of the Data Attribute Binding. + + --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. + + --path-file-format=PATH_FILE_FORMAT + The format of the file to create the path. Specify either yaml or json. + Defaults to json if not specified. Will be ignored if --file-name is + not specified. PATH_FILE_FORMAT must be one of: json, yaml. + + --resource=RESOURCE + The resource name of the resource that is binded to Data Attribute. + + --resource-attributes=[ATTRIBUTES,...] + List of attributes to be associated with the resource. It should be + fully qualified attribute name + + At most one of these can be specified: + + --async + Return immediately, without waiting for the operation in progress to + complete. + + --validate-only + Validate the create action, but don't actually perform it. + + Creation options. + + At most one of these can be specified: + + --path-file-name=PATH_FILE_NAME + The name of the JSON or YAML file to define Path config from. + + --paths=[PATH,...] + The list of paths for items within the associated resource (eg. + columns within a table) along with attribute bindings. The args can + be passed as key value pair. Supported Keys are + --path=name=value1,attributes=value2 ,See + https://cloud.google.com/sdk/gcloud/reference/topic/escaping for + details on using a delimiter other than a comma. Attribute name + should be fully qualified attribute name. + +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/dataplex/data-attribute-bindings/delete b/gcloud/alpha/dataplex/data-attribute-bindings/delete new file mode 100644 index 000000000..da8e540b4 --- /dev/null +++ b/gcloud/alpha/dataplex/data-attribute-bindings/delete @@ -0,0 +1,76 @@ +NAME + gcloud alpha dataplex data-attribute-bindings delete - delete a Dataplex + Data Attribute Binding + +SYNOPSIS + gcloud alpha dataplex data-attribute-bindings delete + (DATA_ATTRIBUTE_BINDING : --location=LOCATION) --etag=ETAG [--async] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Delete a Dataplex Data Attribute Binding. + +EXAMPLES + To Delete Data Attribute Binding test-attribute-binding in project + test-dataplex at location us-central1, run: + + $gcloud alpha dataplex data-attribute-bindings delete test-attribute-binding --project=test-dataplex --location=us-central1 + +POSITIONAL ARGUMENTS + Data attribute binding resource - Arguments and flags that define the + Dataplex Attribute Binding you want 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 data_attribute_binding on the command line with + a fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + DATA_ATTRIBUTE_BINDING + ID of the data attribute binding or fully qualified identifier for + the data attribute binding. To set the data_attribute_binding + attribute: + ▸ provide the argument data_attribute_binding on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Location of the Dataplex resource. + + To set the location attribute: + ▸ provide the argument data_attribute_binding on the command line + with a fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + +REQUIRED FLAGS + --etag=ETAG + etag value for particular Data Attribute Binding. + +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 dataplex/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/dataplex/docs + +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/dataplex/data-attribute-bindings/describe b/gcloud/alpha/dataplex/data-attribute-bindings/describe new file mode 100644 index 000000000..8fe056edd --- /dev/null +++ b/gcloud/alpha/dataplex/data-attribute-bindings/describe @@ -0,0 +1,67 @@ +NAME + gcloud alpha dataplex data-attribute-bindings describe - describe a Data + Attribute Binding resource + +SYNOPSIS + gcloud alpha dataplex data-attribute-bindings describe + (DATA_ATTRIBUTE_BINDING : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Describe a Data Attribute Binding resource. Displays all details of + a Data Attribute Binding resource given a valid DataAttributeBindingID. + +EXAMPLES + To Describe Data Attribute Binding test-attribute-binding in project + test-dataplex at location us-central1, run: + + $gcloud alpha dataplex data-attribute-bindings describe test-attribute-binding --project=test-dataplex --location=us-central1 + +POSITIONAL ARGUMENTS + Data attribute binding resource - Data Attribute Binding you want to + describe. The arguments in this group can be used to specify the + attributes of this resource. (NOTE) Some attributes are not given + arguments in this group but can be set in other ways. To set the project + attribute: + ◆ provide the argument data_attribute_binding on the command line with + a fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + DATA_ATTRIBUTE_BINDING + ID of the data attribute binding or fully qualified identifier for + the data attribute binding. To set the data_attribute_binding + attribute: + ▸ provide the argument data_attribute_binding on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Location of the Dataplex resource. + + To set the location attribute: + ▸ provide the argument data_attribute_binding on the command line + with a fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/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. + +API REFERENCE + This command uses the dataplex/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/dataplex/docs + +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/dataplex/data-attribute-bindings/get-iam-policy b/gcloud/alpha/dataplex/data-attribute-bindings/get-iam-policy new file mode 100644 index 000000000..1b5168295 --- /dev/null +++ b/gcloud/alpha/dataplex/data-attribute-bindings/get-iam-policy @@ -0,0 +1,100 @@ +NAME + gcloud alpha dataplex data-attribute-bindings get-iam-policy - retrieve a + Dataplex Data Attribute Binding IAM policy + +SYNOPSIS + gcloud alpha dataplex data-attribute-bindings get-iam-policy + (DATA_ATTRIBUTE_BINDING : --location=LOCATION) [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Displays the IAM policy associated with a Dataplex Data Attribute + Binding resource. If formatted as JSON, the output can be edited and used + as a policy file for set-iam-policy. The output includes an "etag" field + identifying the version emitted and allowing detection of concurrent policy + updates. + +EXAMPLES + To get the IAM policy of a Dataplex Data Attribute Binding + test-attribute-binding in project test-project under location us-central1 + + $ gcloud alpha dataplex data-attribute-bindings get-iam-policy \ + test-attribute-binding --project=test-project \ + --location=us-central1 + +POSITIONAL ARGUMENTS + Data attribute binding resource - Arguments and flags that define the + Dataplex Data Attribute Binding IAM policy you want to retrieve. 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 data_attribute_binding on the command line with + a fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + DATA_ATTRIBUTE_BINDING + ID of the data attribute binding or fully qualified identifier for + the data attribute binding. To set the data_attribute_binding + attribute: + ▸ provide the argument data_attribute_binding on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Location of the Dataplex resource. + + To set the location attribute: + ▸ provide the argument data_attribute_binding on the command line + with a fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/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. + +API REFERENCE + This command uses the dataplex/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/dataplex/docs + +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/dataplex/data-attribute-bindings/help b/gcloud/alpha/dataplex/data-attribute-bindings/help new file mode 100644 index 000000000..f83198c3a --- /dev/null +++ b/gcloud/alpha/dataplex/data-attribute-bindings/help @@ -0,0 +1,54 @@ +NAME + gcloud alpha dataplex data-attribute-bindings - manage Dataplex Data + Attribute Bindings + +SYNOPSIS + gcloud alpha dataplex data-attribute-bindings COMMAND + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Manage Dataplex Data Attribute Bindings. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + add-iam-policy-binding + (ALPHA) Add IAM policy binding to a Dataplex Data Attribute Binding. + + create + (ALPHA) Create a Dataplex Data Attribute Binding. + + delete + (ALPHA) Delete a Dataplex Data Attribute Binding. + + describe + (ALPHA) Describe a Data Attribute Binding resource. + + get-iam-policy + (ALPHA) Retrieve a Dataplex Data Attribute Binding IAM policy. + + list + (ALPHA) List Data Attribute Bindings. + + remove-iam-policy-binding + (ALPHA) Removes IAM policy binding from a Dataplex Data Attribute + Binding. + + set-iam-policy + (ALPHA) Set an IAM policy binding for a Dataplex Data Attribute Binding + as defined in a JSON or YAML file. + + update + (ALPHA) Update a Dataplex Data Attribute Binding. + +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/dataplex/data-attribute-bindings/list b/gcloud/alpha/dataplex/data-attribute-bindings/list new file mode 100644 index 000000000..3dcfd53bc --- /dev/null +++ b/gcloud/alpha/dataplex/data-attribute-bindings/list @@ -0,0 +1,85 @@ +NAME + gcloud alpha dataplex data-attribute-bindings list - list Data Attribute + Bindings + +SYNOPSIS + gcloud alpha dataplex data-attribute-bindings list [--location=LOCATION] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List Data Attribute Bindings. + +EXAMPLES + To List all the Data Attribute Bindings in project test-dataplex at + location us-central1, run: + + $gcloud alpha dataplex data-attribute-bindings list --project=test-dataplex --location=us-central1 + +FLAGS + Location resource - Location in which to list Data Attribute Bindings. + 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 dataplex/location with a fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + --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 dataplex/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. + + --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 dataplex/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/dataplex/docs + +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/dataplex/data-attribute-bindings/remove-iam-policy-binding b/gcloud/alpha/dataplex/data-attribute-bindings/remove-iam-policy-binding new file mode 100644 index 000000000..5924ad0d8 --- /dev/null +++ b/gcloud/alpha/dataplex/data-attribute-bindings/remove-iam-policy-binding @@ -0,0 +1,91 @@ +NAME + gcloud alpha dataplex data-attribute-bindings remove-iam-policy-binding - + removes IAM policy binding from a Dataplex Data Attribute Binding + +SYNOPSIS + gcloud alpha dataplex data-attribute-bindings remove-iam-policy-binding + (DATA_ATTRIBUTE_BINDING : --location=LOCATION) --member=PRINCIPAL + --role=ROLE [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Removes IAM policy binding from a Dataplex Data Attribute Binding. + +EXAMPLES + To remove an IAM policy binding for the role roles/dataplex.viewer for the + user testuser@gmail.com from an Data Attribute Binding + test-attribute-binding within projet test-project in location us-central1, + run: + + $ gcloud alpha dataplex data-attribute-bindings \ + remove-iam-policy-binding test-attribute-binding \ + --project=test-project --location=us-central1 \ + --role=roles/dataplex.viewer --member=user:testuser@gmail.com + + See https://cloud.google.com/dataplex/docs/iam-roles for details of policy + role and member types. + +POSITIONAL ARGUMENTS + Data attribute binding resource - The DataAttributeBinding to remove IAM + policy binding from 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 data_attribute_binding 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. + + DATA_ATTRIBUTE_BINDING + ID of the data attribute binding or fully qualified identifier for + the data attribute binding. To set the data_attribute_binding + attribute: + ▸ provide the argument data_attribute_binding on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the Dataplex resource. To set the location attribute: + ▸ provide the argument data_attribute_binding on the command line + with a fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + +REQUIRED FLAGS + --member=PRINCIPAL + The principal to remove the binding for. Should be of the form + user|group|serviceAccount:email or domain:domain. + + Examples: user:test-user@gmail.com, group:admins@example.com, + serviceAccount:test123@example.domain.com, or + domain:example.domain.com. + + Deleted principals have an additional deleted: prefix and a ?uid=UID + suffix, where UID is a unique identifier for the principal. Example: + deleted:user:test-user@gmail.com?uid=123456789012345678901. + + Some resources also accept the following special values: + ◆ allUsers - Special identifier that represents anyone who is on the + internet, with or without a Google account. + ◆ allAuthenticatedUsers - Special identifier that represents anyone + who is authenticated with a Google account or a service account. + + --role=ROLE + The role to remove the principal from. + +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/dataplex/data-attribute-bindings/set-iam-policy b/gcloud/alpha/dataplex/data-attribute-bindings/set-iam-policy new file mode 100644 index 000000000..c8aa9a52c --- /dev/null +++ b/gcloud/alpha/dataplex/data-attribute-bindings/set-iam-policy @@ -0,0 +1,75 @@ +NAME + gcloud alpha dataplex data-attribute-bindings set-iam-policy - set an IAM + policy binding for a Dataplex Data Attribute Binding as defined in a + JSON or YAML file + +SYNOPSIS + gcloud alpha dataplex data-attribute-bindings set-iam-policy + (DATA_ATTRIBUTE_BINDING : --location=LOCATION) POLICY_FILE + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) See https://cloud.google.com/iam/docs/managing-policies for details + of the policy file format and contents. + +EXAMPLES + The following command will read an IAM policy defined in a JSON file + policy.json and set it for the Dataplex Data Attribute Binding + test-attribute-binding within project test-project in location us-central1: + + $ gcloud alpha dataplex data-attribute-bindings set-iam-policy \ + test-attribute-binding --project=test-project \ + --location=us-central1 policy.json + + where policy.json is the relative path to the json file. + +POSITIONAL ARGUMENTS + Data attribute binding resource - The DataAttributeBinding to set IAM + policy to. 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 data_attribute_binding 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. + + DATA_ATTRIBUTE_BINDING + ID of the data attribute binding or fully qualified identifier for + the data attribute binding. To set the data_attribute_binding + attribute: + ▸ provide the argument data_attribute_binding on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the Dataplex resource. To set the location attribute: + ▸ provide the argument data_attribute_binding on the command line + with a fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + + POLICY_FILE + Path to a local JSON or YAML formatted file containing a valid policy. + + The output of the get-iam-policy command is a valid file, as is any + JSON or YAML file conforming to the structure of a Policy + (https://cloud.google.com/iam/reference/rest/v1/Policy). + +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/dataplex/data-attribute-bindings/update b/gcloud/alpha/dataplex/data-attribute-bindings/update new file mode 100644 index 000000000..dadfbc88a --- /dev/null +++ b/gcloud/alpha/dataplex/data-attribute-bindings/update @@ -0,0 +1,122 @@ +NAME + gcloud alpha dataplex data-attribute-bindings update - update a Dataplex + Data Attribute Binding + +SYNOPSIS + gcloud alpha dataplex data-attribute-bindings update + (DATA_ATTRIBUTE_BINDING : --location=LOCATION) --etag=ETAG + [--description=DESCRIPTION] [--display-name=DISPLAY_NAME] + [--labels=[KEY=VALUE,...]] [--path-file-format=PATH_FILE_FORMAT] + [--resource-attributes=[ATTRIBUTES,...]] [--async | --validate-only] + [--path-file-name=PATH_FILE_NAME | --paths=[PATH,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Update a Dataplex Data Attribute Binding. + +EXAMPLES + To Update Data Attribute Binding test-attribute-binding in project + test-dataplex at location us-central1 with resource attributes a1 and a2. + Test column 'testColumn1' attached to attribute 'a1' and 'testColumn2' + attached to attribute 'a2' , run: + + $ gcloud alpha dataplex data-attribute-bindings update \ + test-attribute-binding --project=test-dataplex \ + --location=us-central1 --resource-attributes='a1,a2' \ + --paths=name=testColumn1,attributes=a1 \ + --paths=name=testColumn2,attributes=a2 \ + --etag=Etag_Received_From_Get + +POSITIONAL ARGUMENTS + Data attribute binding resource - The DataAttributeBinding 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 data_attribute_binding 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. + + DATA_ATTRIBUTE_BINDING + ID of the data attribute binding or fully qualified identifier for + the data attribute binding. To set the data_attribute_binding + attribute: + ▸ provide the argument data_attribute_binding on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the Dataplex resource. To set the location attribute: + ▸ provide the argument data_attribute_binding on the command line + with a fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + +REQUIRED FLAGS + --etag=ETAG + etag value for particulat Data Attribute Binding resource. + +OPTIONAL FLAGS + --description=DESCRIPTION + Description of the Data Attribute Binding. + + --display-name=DISPLAY_NAME + Display Name of the Data Attribute Binding. + + --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. + + --path-file-format=PATH_FILE_FORMAT + The format of the file to create the path. Specify either yaml or json. + Defaults to yaml if not specified. Will be ignored if --file-name is + not specified. PATH_FILE_FORMAT must be one of: json, yaml. + + --resource-attributes=[ATTRIBUTES,...] + List of Data Attributes to be associated with the resource + + At most one of these can be specified: + + --async + Return immediately, without waiting for the operation in progress to + complete. + + --validate-only + Validate the update action, but don't actually perform it. + + Creation options. + + At most one of these can be specified: + + --path-file-name=PATH_FILE_NAME + The name of the JSON or YAML file to define Path config from. + + --paths=[PATH,...] + The list of paths for items within the associated resource (eg. + columns within a table) along with attribute bindings. The args can + be passed as key value pair. Supported Keys are + --path=name=value1,attributes=value2 ,See + https://cloud.google.com/sdk/gcloud/reference/topic/escaping for + details on using a delimiter other than a comma. + +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/dataplex/data-taxonomies/add-iam-policy-binding b/gcloud/alpha/dataplex/data-taxonomies/add-iam-policy-binding new file mode 100644 index 000000000..c01f561ed --- /dev/null +++ b/gcloud/alpha/dataplex/data-taxonomies/add-iam-policy-binding @@ -0,0 +1,86 @@ +NAME + gcloud alpha dataplex data-taxonomies add-iam-policy-binding - add IAM + policy binding to a Dataplex Data Taxonomy + +SYNOPSIS + gcloud alpha dataplex data-taxonomies add-iam-policy-binding + (DATA_TAXONOMY : --location=LOCATION) --member=PRINCIPAL --role=ROLE + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Add IAM policy binding to a Dataplex Data Taxonomy. + +EXAMPLES + To add an IAM policy binding for the role of roles/dataplex.viewer for the + user test-user@gmail.com to Data Taxonomy test-taxonomy in location + us-central, run: + + $ gcloud alpha dataplex data-taxonomies add-iam-policy-binding \ + test-taxonomy --project=test-project --location=us-central1 \ + --role=roles/dataplex.viewer --member=user:foo@gmail.com + + See https://cloud.google.com/dataplex/docs/iam-roles for details of policy + role and member types. + +POSITIONAL ARGUMENTS + Data taxonomy resource - The DataTaxonomy to add IAM policy binding to. + 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 data_taxonomy 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. + + DATA_TAXONOMY + ID of the data taxonomy or fully qualified identifier for the data + taxonomy. To set the data_taxonomy attribute: + ▸ provide the argument data_taxonomy on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the Dataplex resource. To set the location attribute: + ▸ provide the argument data_taxonomy on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + +REQUIRED FLAGS + --member=PRINCIPAL + The principal to add the binding for. Should be of the form + user|group|serviceAccount:email or domain:domain. + + Examples: user:test-user@gmail.com, group:admins@example.com, + serviceAccount:test123@example.domain.com, or + domain:example.domain.com. + + Some resources also accept the following special values: + ◆ allUsers - Special identifier that represents anyone who is on the + internet, with or without a Google account. + ◆ allAuthenticatedUsers - Special identifier that represents anyone + who is authenticated with a Google account or a service account. + + --role=ROLE + Role name to assign to the principal. The role name is the complete + path of a predefined role, such as roles/logging.viewer, or the role ID + for a custom role, such as + organizations/{ORGANIZATION_ID}/roles/logging.viewer. + +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/dataplex/data-taxonomies/attributes/add-iam-policy-binding b/gcloud/alpha/dataplex/data-taxonomies/attributes/add-iam-policy-binding new file mode 100644 index 000000000..24b66177a --- /dev/null +++ b/gcloud/alpha/dataplex/data-taxonomies/attributes/add-iam-policy-binding @@ -0,0 +1,94 @@ +NAME + gcloud alpha dataplex data-taxonomies attributes add-iam-policy-binding - + add IAM policy binding to a Dataplex Data Attribute + +SYNOPSIS + gcloud alpha dataplex data-taxonomies attributes add-iam-policy-binding + (DATA_ATTRIBUTE : --data_taxonomy=DATA_TAXONOMY --location=LOCATION) + --member=PRINCIPAL --role=ROLE [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Add IAM policy binding to a Dataplex Data Attribute. + +EXAMPLES + To add an IAM policy binding for the role of roles/dataplex.viewer for the + user test-user@gmail.com to Data Attribute test-attribute in location + us-central, in Data Taxonomy 'test-taxonomy', run: + + $ gcloud alpha dataplex data-taxonomies attributes \ + add-iam-policy-binding test-attribute --project=test-project \ + --location=us-central1 --data_taxonomy=test-datataxonomy \ + --role=roles/dataplex.viewer --member=user:foo@gmail.com + + See https://cloud.google.com/dataplex/docs/iam-roles for details of policy + role and member types. + +POSITIONAL ARGUMENTS + Data attribute resource - The DataAttribute to add IAM policy binding to. + 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 data_attribute 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. + + DATA_ATTRIBUTE + ID of the data attribute or fully qualified identifier for the data + attribute. To set the data_attribute attribute: + ▸ provide the argument data_attribute on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --data_taxonomy=DATA_TAXONOMY + The name of data attribute to use. To set the data_taxonomy + attribute: + ▸ provide the argument data_attribute on the command line with a + fully specified name; + ▸ provide the argument --data_taxonomy on the command line. + + --location=LOCATION + The location of the Dataplex resource. To set the location attribute: + ▸ provide the argument data_attribute on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + +REQUIRED FLAGS + --member=PRINCIPAL + The principal to add the binding for. Should be of the form + user|group|serviceAccount:email or domain:domain. + + Examples: user:test-user@gmail.com, group:admins@example.com, + serviceAccount:test123@example.domain.com, or + domain:example.domain.com. + + Some resources also accept the following special values: + ◆ allUsers - Special identifier that represents anyone who is on the + internet, with or without a Google account. + ◆ allAuthenticatedUsers - Special identifier that represents anyone + who is authenticated with a Google account or a service account. + + --role=ROLE + Role name to assign to the principal. The role name is the complete + path of a predefined role, such as roles/logging.viewer, or the role ID + for a custom role, such as + organizations/{ORGANIZATION_ID}/roles/logging.viewer. + +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/dataplex/data-taxonomies/attributes/create b/gcloud/alpha/dataplex/data-taxonomies/attributes/create new file mode 100644 index 000000000..a80095c0b --- /dev/null +++ b/gcloud/alpha/dataplex/data-taxonomies/attributes/create @@ -0,0 +1,131 @@ +NAME + gcloud alpha dataplex data-taxonomies attributes create - create a Dataplex + Data Attribute + +SYNOPSIS + gcloud alpha dataplex data-taxonomies attributes create + (DATA_ATTRIBUTE : --data_taxonomy=DATA_TAXONOMY --location=LOCATION) + [--data-readers=[DATA_READERS,...]] [--description=DESCRIPTION] + [--display-name=DISPLAY_NAME] [--labels=[KEY=VALUE,...]] + [--parent=PARENT] [--async | --validate-only] + [--resource-owners=[RESOURCE_OWNERS,...] + --resource-readers=[RESOURCE_READERS,...] + --resource-writers=[RESOURCE_WRITERS,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create a Dataplex Data Attribute. + +EXAMPLES + To create Data Attribute test-attribute for Data Taxonomy test-datataxonomy + in project test-dataplex at location us-central1 with description as test + description , display name as displayName, resource-readers as + user:test@google.com, resource-writers as user:test@google.com, + resource-owner as user:test@google.com, data-readers as + user:test@google.com and parent as test-attribute-parent, run: + + $ gcloud alpha dataplex data-taxonomies attributes create \ + test-attribute-6 --location=us-central1 --project=test-dataplex' + --data_taxonomy=test-datataxonomy --description='test description' + --display-name='displayName' --resource-readers='user:test@google.com' + --resource-writers='user:test@google.com' --resource-owners='user:test@google.com' + --data-readers='user:test@google.com' + --parent='test-attribute-parent' + +POSITIONAL ARGUMENTS + Data attribute resource - The DataAttribute to create. 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 data_attribute 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. + + DATA_ATTRIBUTE + ID of the data attribute or fully qualified identifier for the data + attribute. To set the data_attribute attribute: + ▸ provide the argument data_attribute on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --data_taxonomy=DATA_TAXONOMY + The name of data attribute to use. To set the data_taxonomy + attribute: + ▸ provide the argument data_attribute on the command line with a + fully specified name; + ▸ provide the argument --data_taxonomy on the command line. + + --location=LOCATION + The location of the Dataplex resource. To set the location attribute: + ▸ provide the argument data_attribute on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + +FLAGS + Specified when applied to data stored on the resource (eg: rows,columns in + BigQuery Tables). + + --data-readers=[DATA_READERS,...] + The set of principals to be granted reader role on the resource. + Expected principal formats are user:$userEmail, group:$groupEmail + + --description=DESCRIPTION + Description of the Data Attribute. + + --display-name=DISPLAY_NAME + Display Name of the Data Attribute. + + --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. + + --parent=PARENT + Parent Data Attribute for the created Data Attribute. It can be + attribute name or fully qualified attribute name. + + At most one of these can be specified: + + --async + Return immediately, without waiting for the operation in progress to + complete. + + --validate-only + Validate the create action, but don't actually perform it. + + Spec related to Dataplex Resource.Specified when applied to a resource + (eg: Google Cloud Storage bucket, BigQuery, dataset, BigQuery table). + + --resource-owners=[RESOURCE_OWNERS,...] + The set of principals to be granted owner role on the resource. + Expected principal formats are user:$userEmail, group:$groupEmail + + --resource-readers=[RESOURCE_READERS,...] + The set of principals to be granted reader role on the resource. + Expected principal formats are user:$userEmail, group:$groupEmail + + --resource-writers=[RESOURCE_WRITERS,...] + The set of principals to be granted writer role on the resource. + Expected principal formats are user:$userEmail, group:$groupEmail + +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/dataplex/data-taxonomies/attributes/delete b/gcloud/alpha/dataplex/data-taxonomies/attributes/delete new file mode 100644 index 000000000..198f34c9c --- /dev/null +++ b/gcloud/alpha/dataplex/data-taxonomies/attributes/delete @@ -0,0 +1,84 @@ +NAME + gcloud alpha dataplex data-taxonomies attributes delete - delete a Dataplex + Data Attribute + +SYNOPSIS + gcloud alpha dataplex data-taxonomies attributes delete + (DATA_ATTRIBUTE : --data_taxonomy=DATA_TAXONOMY --location=LOCATION) + [--async] [--etag=ETAG] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Delete a Dataplex Data Attribute. + +EXAMPLES + To delete Data Attribute test-attribute for Data Taxonomy test-datataxonomy + in project test-dataplex at location us-central1, run: + + $ gcloud alpha dataplex data-taxonomies attributes delete \ + test-attribute --location=us-central1 --project=test-dataplex \ + --data_taxonomy=test-datataxonomy + +POSITIONAL ARGUMENTS + Data attribute resource - Arguments and flags that define the Dataplex + Data Attribute you want 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 data_attribute on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + DATA_ATTRIBUTE + ID of the data attribute or fully qualified identifier for the data + attribute. To set the data_attribute attribute: + ▸ provide the argument data_attribute on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --data_taxonomy=DATA_TAXONOMY + Identifier of the Dataplex DataTaxonomy resource. + + To set the data_taxonomy attribute: + ▸ provide the argument data_attribute on the command line with a + fully specified name; + ▸ provide the argument --data_taxonomy on the command line. + + --location=LOCATION + Location of the Dataplex resource. + + To set the location attribute: + ▸ provide the argument data_attribute on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --etag=ETAG + etag value for particular Data Attribute resource. + +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 dataplex/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/dataplex/docs + +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/dataplex/data-taxonomies/attributes/describe b/gcloud/alpha/dataplex/data-taxonomies/attributes/describe new file mode 100644 index 000000000..6ace40670 --- /dev/null +++ b/gcloud/alpha/dataplex/data-taxonomies/attributes/describe @@ -0,0 +1,75 @@ +NAME + gcloud alpha dataplex data-taxonomies attributes describe - describe a + Dataplex Data Attribute + +SYNOPSIS + gcloud alpha dataplex data-taxonomies attributes describe + (DATA_ATTRIBUTE : --data_taxonomy=DATA_TAXONOMY --location=LOCATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Describe a Dataplex Data Attribute. + +EXAMPLES + To Describe Data Attribute test-attribute for Data Taxonomy + test-datataxonomy in project test-dataplex at location us-central1, run: + + $ gcloud alpha dataplex data-taxonomies attributes describe \ + test-attribute --location=us-central1 --project=test-dataplex \ + --data_taxonomy=test-datataxonomy + +POSITIONAL ARGUMENTS + Data attribute resource - DataAttribute to describe The arguments in this + group can be used to specify the attributes of this resource. (NOTE) Some + attributes are not given arguments in this group but can be set in other + ways. To set the project attribute: + ◆ provide the argument data_attribute on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + DATA_ATTRIBUTE + ID of the data attribute or fully qualified identifier for the data + attribute. To set the data_attribute attribute: + ▸ provide the argument data_attribute on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --data_taxonomy=DATA_TAXONOMY + Identifier of the Dataplex DataTaxonomy resource. + + To set the data_taxonomy attribute: + ▸ provide the argument data_attribute on the command line with a + fully specified name; + ▸ provide the argument --data_taxonomy on the command line. + + --location=LOCATION + Location of the Dataplex resource. + + To set the location attribute: + ▸ provide the argument data_attribute on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/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. + +API REFERENCE + This command uses the dataplex/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/dataplex/docs + +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/dataplex/data-taxonomies/attributes/get-iam-policy b/gcloud/alpha/dataplex/data-taxonomies/attributes/get-iam-policy new file mode 100644 index 000000000..d37d624aa --- /dev/null +++ b/gcloud/alpha/dataplex/data-taxonomies/attributes/get-iam-policy @@ -0,0 +1,108 @@ +NAME + gcloud alpha dataplex data-taxonomies attributes get-iam-policy - retrieve + a Dataplex Data Attribute IAM policy + +SYNOPSIS + gcloud alpha dataplex data-taxonomies attributes get-iam-policy + (DATA_ATTRIBUTE : --data_taxonomy=DATA_TAXONOMY --location=LOCATION) + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Displays the IAM policy associated with a Dataplex Data Attribute + resource. If formatted as JSON, the output can be edited and used as a + policy file for set-iam-policy. The output includes an "etag" field + identifying the version emitted and allowing detection of concurrent policy + updates. + +EXAMPLES + To get the IAM policy of a Dataplex Data Attribute test-attribute in + project test-project under location us-central1 in Data Taxonomy + 'test-taxonomy' + + $ gcloud alpha dataplex data-taxonomies attributes get-iam-policy \ + test-taxonomy --project=test-project --location=us-central1 \ + --data_taxonomy=test-datataxonomy + +POSITIONAL ARGUMENTS + Data attribute resource - Arguments and flags that define the Dataplex + Data Attribute IAM policy you want to retrieve. 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 data_attribute on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + DATA_ATTRIBUTE + ID of the data attribute or fully qualified identifier for the data + attribute. To set the data_attribute attribute: + ▸ provide the argument data_attribute on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --data_taxonomy=DATA_TAXONOMY + Identifier of the Dataplex DataTaxonomy resource. + + To set the data_taxonomy attribute: + ▸ provide the argument data_attribute on the command line with a + fully specified name; + ▸ provide the argument --data_taxonomy on the command line. + + --location=LOCATION + Location of the Dataplex resource. + + To set the location attribute: + ▸ provide the argument data_attribute on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/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. + +API REFERENCE + This command uses the dataplex/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/dataplex/docs + +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/dataplex/data-taxonomies/attributes/help b/gcloud/alpha/dataplex/data-taxonomies/attributes/help new file mode 100644 index 000000000..19a742716 --- /dev/null +++ b/gcloud/alpha/dataplex/data-taxonomies/attributes/help @@ -0,0 +1,53 @@ +NAME + gcloud alpha dataplex data-taxonomies attributes - manage Dataplex Data + Attributes + +SYNOPSIS + gcloud alpha dataplex data-taxonomies attributes COMMAND + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Manage Dataplex Data Attributes. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + add-iam-policy-binding + (ALPHA) Add IAM policy binding to a Dataplex Data Attribute. + + create + (ALPHA) Create a Dataplex Data Attribute. + + delete + (ALPHA) Delete a Dataplex Data Attribute. + + describe + (ALPHA) Describe a Dataplex Data Attribute. + + get-iam-policy + (ALPHA) Retrieve a Dataplex Data Attribute IAM policy. + + list + (ALPHA) List Data Attributes within provided Data Taxonomy. + + remove-iam-policy-binding + (ALPHA) Removes IAM policy binding from a Dataplex Data Attribute. + + set-iam-policy + (ALPHA) Set an IAM policy binding for a Dataplex Data Attribute as + defined in a JSON or YAML file. + + update + (ALPHA) Update a Dataplex Data Attribute. + +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/dataplex/data-taxonomies/attributes/list b/gcloud/alpha/dataplex/data-taxonomies/attributes/list new file mode 100644 index 000000000..a45c09561 --- /dev/null +++ b/gcloud/alpha/dataplex/data-taxonomies/attributes/list @@ -0,0 +1,100 @@ +NAME + gcloud alpha dataplex data-taxonomies attributes list - list Data + Attributes within provided Data Taxonomy + +SYNOPSIS + gcloud alpha dataplex data-taxonomies attributes list + (--data_taxonomy=DATA_TAXONOMY : --location=LOCATION) + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List Data Attributes within provided Data Taxonomy. + +EXAMPLES + To List Data Attribute test-attribute for Data Taxonomy test-datataxonomy + in project test-dataplex at location us-central1, run: + + $ gcloud alpha dataplex data-taxonomies attributes list \ + test-attribute --location=us-central1 --project=test-dataplex \ + --data_taxonomy=test-datataxonomy + +REQUIRED FLAGS + Data taxonomy resource - Data Taxonomy in which to list Data Attributes. + 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 --data_taxonomy on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + --data_taxonomy=DATA_TAXONOMY + ID of the data taxonomy or fully qualified identifier for the data + taxonomy. To set the data_taxonomy attribute: + ▸ provide the argument --data_taxonomy on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location of the Dataplex resource. + + To set the location attribute: + ▸ provide the argument --data_taxonomy on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/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. + + --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 dataplex/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/dataplex/docs + +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/dataplex/data-taxonomies/attributes/remove-iam-policy-binding b/gcloud/alpha/dataplex/data-taxonomies/attributes/remove-iam-policy-binding new file mode 100644 index 000000000..d4b5eeebc --- /dev/null +++ b/gcloud/alpha/dataplex/data-taxonomies/attributes/remove-iam-policy-binding @@ -0,0 +1,96 @@ +NAME + gcloud alpha dataplex data-taxonomies attributes remove-iam-policy-binding + - removes IAM policy binding from a Dataplex Data Attribute + +SYNOPSIS + gcloud alpha dataplex data-taxonomies attributes remove-iam-policy-binding + (DATA_ATTRIBUTE : --data_taxonomy=DATA_TAXONOMY --location=LOCATION) + --member=PRINCIPAL --role=ROLE [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Removes IAM policy binding from a Dataplex Data Attribute. + +EXAMPLES + To remove an IAM policy binding for the role roles/dataplex.viewer for the + user testuser@gmail.com from Data Attribute test-attribute in location + us-central, in Data Taxonomy 'test-taxonomy', run: + + $ gcloud alpha dataplex data-taxonomies attributes \ + remove-iam-policy-binding test-attribute \ + --project=test-project --location=us-central1 \ + --data_taxonomy=test-datataxonomy --role=roles/dataplex.viewer \ + --member=user:testuser@gmail.com + + See https://cloud.google.com/dataplex/docs/iam-roles for details of policy + role and member types. + +POSITIONAL ARGUMENTS + Data attribute resource - The DataAttribute to remove IAM policy binding + from 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 data_attribute 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. + + DATA_ATTRIBUTE + ID of the data attribute or fully qualified identifier for the data + attribute. To set the data_attribute attribute: + ▸ provide the argument data_attribute on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --data_taxonomy=DATA_TAXONOMY + The name of data attribute to use. To set the data_taxonomy + attribute: + ▸ provide the argument data_attribute on the command line with a + fully specified name; + ▸ provide the argument --data_taxonomy on the command line. + + --location=LOCATION + The location of the Dataplex resource. To set the location attribute: + ▸ provide the argument data_attribute on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + +REQUIRED FLAGS + --member=PRINCIPAL + The principal to remove the binding for. Should be of the form + user|group|serviceAccount:email or domain:domain. + + Examples: user:test-user@gmail.com, group:admins@example.com, + serviceAccount:test123@example.domain.com, or + domain:example.domain.com. + + Deleted principals have an additional deleted: prefix and a ?uid=UID + suffix, where UID is a unique identifier for the principal. Example: + deleted:user:test-user@gmail.com?uid=123456789012345678901. + + Some resources also accept the following special values: + ◆ allUsers - Special identifier that represents anyone who is on the + internet, with or without a Google account. + ◆ allAuthenticatedUsers - Special identifier that represents anyone + who is authenticated with a Google account or a service account. + + --role=ROLE + The role to remove the principal from. + +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/dataplex/data-taxonomies/attributes/set-iam-policy b/gcloud/alpha/dataplex/data-taxonomies/attributes/set-iam-policy new file mode 100644 index 000000000..ed373cb80 --- /dev/null +++ b/gcloud/alpha/dataplex/data-taxonomies/attributes/set-iam-policy @@ -0,0 +1,80 @@ +NAME + gcloud alpha dataplex data-taxonomies attributes set-iam-policy - set an + IAM policy binding for a Dataplex Data Attribute as defined in a JSON + or YAML file + +SYNOPSIS + gcloud alpha dataplex data-taxonomies attributes set-iam-policy + (DATA_ATTRIBUTE : --data_taxonomy=DATA_TAXONOMY --location=LOCATION) + POLICY_FILE [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) See https://cloud.google.com/iam/docs/managing-policies for details + of the policy file format and contents. + +EXAMPLES + The following command will read an IAM policy defined in a JSON file + policy.json and set it for the Dataplex Data Attribute test-attribute in + location us-central, in Data Taxonomy 'test-taxonomy', run: + + $ gcloud alpha dataplex data-taxonomies attributes set-iam-policy \ + test-attribute --project=test-project --location=us-central1 \ + --data_taxonomy=test-datataxonomy policy.json + + where policy.json is the relative path to the json file. + +POSITIONAL ARGUMENTS + Data attribute resource - The DataAttribute to set IAM policy to. 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 data_attribute 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. + + DATA_ATTRIBUTE + ID of the data attribute or fully qualified identifier for the data + attribute. To set the data_attribute attribute: + ▸ provide the argument data_attribute on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --data_taxonomy=DATA_TAXONOMY + The name of data attribute to use. To set the data_taxonomy + attribute: + ▸ provide the argument data_attribute on the command line with a + fully specified name; + ▸ provide the argument --data_taxonomy on the command line. + + --location=LOCATION + The location of the Dataplex resource. To set the location attribute: + ▸ provide the argument data_attribute on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + + POLICY_FILE + Path to a local JSON or YAML formatted file containing a valid policy. + + The output of the get-iam-policy command is a valid file, as is any + JSON or YAML file conforming to the structure of a Policy + (https://cloud.google.com/iam/reference/rest/v1/Policy). + +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/dataplex/data-taxonomies/attributes/update b/gcloud/alpha/dataplex/data-taxonomies/attributes/update new file mode 100644 index 000000000..7c7fa1c59 --- /dev/null +++ b/gcloud/alpha/dataplex/data-taxonomies/attributes/update @@ -0,0 +1,136 @@ +NAME + gcloud alpha dataplex data-taxonomies attributes update - update a Dataplex + Data Attribute + +SYNOPSIS + gcloud alpha dataplex data-taxonomies attributes update + (DATA_ATTRIBUTE : --data_taxonomy=DATA_TAXONOMY --location=LOCATION) + [--data-readers=[DATA_READERS,...]] [--description=DESCRIPTION] + [--display-name=DISPLAY_NAME] [--etag=ETAG] [--labels=[KEY=VALUE,...]] + [--parent=PARENT] [--async | --validate-only] + [--resource-owners=[RESOURCE_OWNERS,...] + --resource-readers=[RESOURCE_READERS,...] + --resource-writers=[RESOURCE_WRITERS,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Update a Dataplex Data Attribute. + +EXAMPLES + To update Data Attribute test-attribute for Data Taxonomy test-datataxonomy + in project test-dataplex at location us-central1 with description as test + description , display name as displayName, resource-readers as + user:test@google.com, resource-writers as user:test@google.com, + resource-owner as user:test@google.com run: data-readers as + user:test@google.com and parent as test-attribute-parent, run: + + $ gcloud alpha dataplex data-taxonomies attributes update \ + test-attribute --location=us-central1 --project=test-dataplex' + --data_taxonomy=test-datataxonomy --description='test description' + --display-name='displayName' --resource-readers='user:test@google.com' + --resource-writers='user:test@google.com' --resource-owners='user:test@google.com' + --data-readers='user:test@google.com' + --parent='test-attribute-parent' + +POSITIONAL ARGUMENTS + Data attribute resource - The DataAttribute 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 data_attribute 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. + + DATA_ATTRIBUTE + ID of the data attribute or fully qualified identifier for the data + attribute. To set the data_attribute attribute: + ▸ provide the argument data_attribute on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --data_taxonomy=DATA_TAXONOMY + The name of data attribute to use. To set the data_taxonomy + attribute: + ▸ provide the argument data_attribute on the command line with a + fully specified name; + ▸ provide the argument --data_taxonomy on the command line. + + --location=LOCATION + The location of the Dataplex resource. To set the location attribute: + ▸ provide the argument data_attribute on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + +FLAGS + Specified when applied to data stored on the resource (eg: rows,columns in + BigQuery Tables). + + --data-readers=[DATA_READERS,...] + The set of principals to be granted reader role on the resource. + Expected principal formats are user:$userEmail, group:$groupEmail + + --description=DESCRIPTION + Description of the Data Attribute. + + --display-name=DISPLAY_NAME + Display Name of the Data Attribute. + + --etag=ETAG + etag value for particular Data Attribute resource. + + --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. + + --parent=PARENT + Parent Data Attribute for the defined Data Attribute. It can be + attribute name or fully qualified attribute name. + + At most one of --async | --validate-only can be specified. + + At most one of these can be specified: + + --async + Return immediately, without waiting for the operation in progress to + complete. + + --validate-only + Validate the update action, but don't actually perform it. + + Spec related to Dataplex Resource.Specified when applied to a resource + (eg: Google Cloud Storage bucket, BigQuery, dataset, BigQuery table). + + --resource-owners=[RESOURCE_OWNERS,...] + The set of principals to be granted owner role on the resource. + Expected principal formats are user:$userEmail, group:$groupEmail + + --resource-readers=[RESOURCE_READERS,...] + The set of principals to be granted reader role on the resource. + Expected principal formats are user:$userEmail, group:$groupEmail + + --resource-writers=[RESOURCE_WRITERS,...] + The set of principals to be granted writer role on the resource. + Expected principal formats are user:$userEmail, group:$groupEmail + +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/dataplex/data-taxonomies/create b/gcloud/alpha/dataplex/data-taxonomies/create new file mode 100644 index 000000000..b664d4ed6 --- /dev/null +++ b/gcloud/alpha/dataplex/data-taxonomies/create @@ -0,0 +1,88 @@ +NAME + gcloud alpha dataplex data-taxonomies create - create a Dataplex Data + Taxonomy + +SYNOPSIS + gcloud alpha dataplex data-taxonomies create + (DATA_TAXONOMY : --location=LOCATION) [--description=DESCRIPTION] + [--display-name=DISPLAY_NAME] [--labels=[KEY=VALUE,...]] + [--async | --validate-only] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) A Data Taxonomy represents a logical group of related Data + Attributes. + +EXAMPLES + To create Data Taxonomy test-taxonomy in project test-dataplex at location + us-central1, with description test description and displayName displayName + , run: + + $ gcloud alpha dataplex data-taxonomies create test-taxonomy \ + --location=us-central1 --project=test-dataplex \ + --description='test description' --display-name='displayName' + +POSITIONAL ARGUMENTS + Data taxonomy resource - The DataTaxonomy to create. 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 data_taxonomy 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. + + DATA_TAXONOMY + ID of the data taxonomy or fully qualified identifier for the data + taxonomy. To set the data_taxonomy attribute: + ▸ provide the argument data_taxonomy on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the Dataplex resource. To set the location attribute: + ▸ provide the argument data_taxonomy on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + +FLAGS + --description=DESCRIPTION + Description of the Data Taxonomy. + + --display-name=DISPLAY_NAME + Display Name of the Data Taxonomy. + + --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. + + At most one of these can be specified: + + --async + Return immediately, without waiting for the operation in progress to + complete. + + --validate-only + Validate the create action, but don't actually perform 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. + diff --git a/gcloud/alpha/dataplex/data-taxonomies/delete b/gcloud/alpha/dataplex/data-taxonomies/delete new file mode 100644 index 000000000..ef5e004d0 --- /dev/null +++ b/gcloud/alpha/dataplex/data-taxonomies/delete @@ -0,0 +1,75 @@ +NAME + gcloud alpha dataplex data-taxonomies delete - delete a Dataplex Data + Taxonomy + +SYNOPSIS + gcloud alpha dataplex data-taxonomies delete + (DATA_TAXONOMY : --location=LOCATION) [--async] [--etag=ETAG] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Delete a Dataplex Data Taxonomy. + +EXAMPLES + To Delete Data Taxonomy test-taxonomy in project test-dataplex at location + us-central1, run: + + $ gcloud alpha dataplex data-taxonomies delete test-taxonomy \ + --location=us-central1 --project=test-dataplex + +POSITIONAL ARGUMENTS + Data taxonomy resource - Arguments and flags that define the Dataplex Data + Taxonomy you want 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 data_taxonomy on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + DATA_TAXONOMY + ID of the data taxonomy or fully qualified identifier for the data + taxonomy. To set the data_taxonomy attribute: + ▸ provide the argument data_taxonomy on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Location of the Dataplex resource. + + To set the location attribute: + ▸ provide the argument data_taxonomy on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --etag=ETAG + etag value for particular Data Taxonomy. + +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 dataplex/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/dataplex/docs + +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/dataplex/data-taxonomies/describe b/gcloud/alpha/dataplex/data-taxonomies/describe new file mode 100644 index 000000000..ed855ec3c --- /dev/null +++ b/gcloud/alpha/dataplex/data-taxonomies/describe @@ -0,0 +1,65 @@ +NAME + gcloud alpha dataplex data-taxonomies describe - describe a Data Taxonomy + +SYNOPSIS + gcloud alpha dataplex data-taxonomies describe + (DATA_TAXONOMY : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Describe a Data Taxonomy. Displays all details of a Data Taxonomy + given a valid Data Taxonomy ID. + +EXAMPLES + To describe a Dataplex Data Taxonomy test-taxonomy within location + us-central1 and in project test-project + + $ gcloud alpha dataplex data-taxonomies describe test-taxonomy \ + --location=us-central1 --project=test-project + +POSITIONAL ARGUMENTS + Data taxonomy resource - Data Taxonomies you want to describe. The + arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. To set the project attribute: + ◆ provide the argument data_taxonomy on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + DATA_TAXONOMY + ID of the data taxonomy or fully qualified identifier for the data + taxonomy. To set the data_taxonomy attribute: + ▸ provide the argument data_taxonomy on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Location of the Dataplex resource. + + To set the location attribute: + ▸ provide the argument data_taxonomy on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/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. + +API REFERENCE + This command uses the dataplex/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/dataplex/docs + +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/dataplex/data-taxonomies/get-iam-policy b/gcloud/alpha/dataplex/data-taxonomies/get-iam-policy new file mode 100644 index 000000000..d22445647 --- /dev/null +++ b/gcloud/alpha/dataplex/data-taxonomies/get-iam-policy @@ -0,0 +1,98 @@ +NAME + gcloud alpha dataplex data-taxonomies get-iam-policy - retrieve a Dataplex + Data Taxonomy IAM policy + +SYNOPSIS + gcloud alpha dataplex data-taxonomies get-iam-policy + (DATA_TAXONOMY : --location=LOCATION) [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Displays the IAM policy associated with a Dataplex Data Taxonomy + resource. If formatted as JSON, the output can be edited and used as a + policy file for set-iam-policy. The output includes an "etag" field + identifying the version emitted and allowing detection of concurrent policy + updates. + +EXAMPLES + To get the IAM policy of a Dataplex Data Taxonomy test-taxonomy in project + test-project under location us-central1 + + $ gcloud alpha dataplex data-taxonomies get-iam-policy \ + test-taxonomy --project=test-project --location=us-central1 + +POSITIONAL ARGUMENTS + Data taxonomy resource - Arguments and flags that define the Dataplex Data + Taxonomy IAM policy you want to retrieve. 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 data_taxonomy on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + DATA_TAXONOMY + ID of the data taxonomy or fully qualified identifier for the data + taxonomy. To set the data_taxonomy attribute: + ▸ provide the argument data_taxonomy on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Location of the Dataplex resource. + + To set the location attribute: + ▸ provide the argument data_taxonomy on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/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. + +API REFERENCE + This command uses the dataplex/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/dataplex/docs + +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/dataplex/data-taxonomies/help b/gcloud/alpha/dataplex/data-taxonomies/help new file mode 100644 index 000000000..c85de5de3 --- /dev/null +++ b/gcloud/alpha/dataplex/data-taxonomies/help @@ -0,0 +1,58 @@ +NAME + gcloud alpha dataplex data-taxonomies - manage Dataplex Data Taxonomies + +SYNOPSIS + gcloud alpha dataplex data-taxonomies GROUP | COMMAND + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Manage Dataplex Data Taxonomies. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + attributes + (ALPHA) Manage Dataplex Data Attributes. + +COMMANDS + COMMAND is one of the following: + + add-iam-policy-binding + (ALPHA) Add IAM policy binding to a Dataplex Data Taxonomy. + + create + (ALPHA) Create a Dataplex Data Taxonomy. + + delete + (ALPHA) Delete a Dataplex Data Taxonomy. + + describe + (ALPHA) Describe a Data Taxonomy. + + get-iam-policy + (ALPHA) Retrieve a Dataplex Data Taxonomy IAM policy. + + list + (ALPHA) List Data Taxonomies. + + remove-iam-policy-binding + (ALPHA) Removes IAM policy binding from a Dataplex Data Taxonomy. + + set-iam-policy + (ALPHA) Set an IAM policy binding for a Dataplex Data Taxonomy as + defined in a JSON or YAML file. + + update + (ALPHA) Update a Dataplex Data Taxonomy. + +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/dataplex/data-taxonomies/list b/gcloud/alpha/dataplex/data-taxonomies/list new file mode 100644 index 000000000..a18b5804d --- /dev/null +++ b/gcloud/alpha/dataplex/data-taxonomies/list @@ -0,0 +1,84 @@ +NAME + gcloud alpha dataplex data-taxonomies list - list Data Taxonomies + +SYNOPSIS + gcloud alpha dataplex data-taxonomies list [--location=LOCATION] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List Data Taxonomies. + +EXAMPLES + To List Data Taxonomies in project test-dataplex at location us-central1 + + $ gcloud alpha dataplex data-taxonomies list \ + --location=us-central1 --project=test-dataplex + +FLAGS + Location resource - Location in which to list Data Taxonomies. 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 dataplex/location with a fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + --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 dataplex/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. + + --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 dataplex/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/dataplex/docs + +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/dataplex/data-taxonomies/remove-iam-policy-binding b/gcloud/alpha/dataplex/data-taxonomies/remove-iam-policy-binding new file mode 100644 index 000000000..90854abd5 --- /dev/null +++ b/gcloud/alpha/dataplex/data-taxonomies/remove-iam-policy-binding @@ -0,0 +1,87 @@ +NAME + gcloud alpha dataplex data-taxonomies remove-iam-policy-binding - removes + IAM policy binding from a Dataplex Data Taxonomy + +SYNOPSIS + gcloud alpha dataplex data-taxonomies remove-iam-policy-binding + (DATA_TAXONOMY : --location=LOCATION) --member=PRINCIPAL --role=ROLE + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Removes IAM policy binding from a Dataplex Data Taxonomy. + +EXAMPLES + To remove an IAM policy binding for the role roles/dataplex.viewer for the + user testuser@gmail.com from an taxonomy test-taxonomy within projet + test-project in location us-central1, run: + + $ gcloud alpha dataplex data-taxonomies remove-iam-policy-binding \ + test-taxonomy --project=test-project --location=us-central1 \ + --role=roles/dataplex.viewer --member=user:testuser@gmail.com + + See https://cloud.google.com/dataplex/docs/iam-roles for details of policy + role and member types. + +POSITIONAL ARGUMENTS + Data taxonomy resource - The DataTaxonomy to remove IAM policy binding + from 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 data_taxonomy 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. + + DATA_TAXONOMY + ID of the data taxonomy or fully qualified identifier for the data + taxonomy. To set the data_taxonomy attribute: + ▸ provide the argument data_taxonomy on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the Dataplex resource. To set the location attribute: + ▸ provide the argument data_taxonomy on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + +REQUIRED FLAGS + --member=PRINCIPAL + The principal to remove the binding for. Should be of the form + user|group|serviceAccount:email or domain:domain. + + Examples: user:test-user@gmail.com, group:admins@example.com, + serviceAccount:test123@example.domain.com, or + domain:example.domain.com. + + Deleted principals have an additional deleted: prefix and a ?uid=UID + suffix, where UID is a unique identifier for the principal. Example: + deleted:user:test-user@gmail.com?uid=123456789012345678901. + + Some resources also accept the following special values: + ◆ allUsers - Special identifier that represents anyone who is on the + internet, with or without a Google account. + ◆ allAuthenticatedUsers - Special identifier that represents anyone + who is authenticated with a Google account or a service account. + + --role=ROLE + The role to remove the principal from. + +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/dataplex/data-taxonomies/set-iam-policy b/gcloud/alpha/dataplex/data-taxonomies/set-iam-policy new file mode 100644 index 000000000..e7f8168b6 --- /dev/null +++ b/gcloud/alpha/dataplex/data-taxonomies/set-iam-policy @@ -0,0 +1,72 @@ +NAME + gcloud alpha dataplex data-taxonomies set-iam-policy - set an IAM policy + binding for a Dataplex Data Taxonomy as defined in a JSON or YAML file + +SYNOPSIS + gcloud alpha dataplex data-taxonomies set-iam-policy + (DATA_TAXONOMY : --location=LOCATION) POLICY_FILE + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) See https://cloud.google.com/iam/docs/managing-policies for details + of the policy file format and contents. + +EXAMPLES + The following command will read an IAM policy defined in a JSON file + policy.json and set it for the Dataplex Data Taxonomy test-taxonomy within + project test-project in location us-central1: + + $ gcloud alpha dataplex data-taxonomies set-iam-policy \ + test-taxonomy --project=test-project --location=us-central1 \ + policy.json + + where policy.json is the relative path to the json file. + +POSITIONAL ARGUMENTS + Data taxonomy resource - The DataTaxonomy to set IAM policy to. 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 data_taxonomy 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. + + DATA_TAXONOMY + ID of the data taxonomy or fully qualified identifier for the data + taxonomy. To set the data_taxonomy attribute: + ▸ provide the argument data_taxonomy on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the Dataplex resource. To set the location attribute: + ▸ provide the argument data_taxonomy on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + + POLICY_FILE + Path to a local JSON or YAML formatted file containing a valid policy. + + The output of the get-iam-policy command is a valid file, as is any + JSON or YAML file conforming to the structure of a Policy + (https://cloud.google.com/iam/reference/rest/v1/Policy). + +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/dataplex/data-taxonomies/update b/gcloud/alpha/dataplex/data-taxonomies/update new file mode 100644 index 000000000..d29cc9270 --- /dev/null +++ b/gcloud/alpha/dataplex/data-taxonomies/update @@ -0,0 +1,90 @@ +NAME + gcloud alpha dataplex data-taxonomies update - update a Dataplex Data + Taxonomy + +SYNOPSIS + gcloud alpha dataplex data-taxonomies update + (DATA_TAXONOMY : --location=LOCATION) [--description=DESCRIPTION] + [--display-name=DISPLAY_NAME] [--etag=ETAG] [--labels=[KEY=VALUE,...]] + [--async | --validate-only] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Update a Dataplex Data Taxonomy. + +EXAMPLES + To update Data Taxonomy test-taxonomy in project test-dataplex at location + us-central1, with description updated description and displayName + displayName + + $ gcloud alpha dataplex data-taxonomies update test-taxonomy \ + --location=us-central1 --project=test-dataplex \ + --description='updated description' + +POSITIONAL ARGUMENTS + Data taxonomy resource - The DataTaxonomy 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 data_taxonomy 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. + + DATA_TAXONOMY + ID of the data taxonomy or fully qualified identifier for the data + taxonomy. To set the data_taxonomy attribute: + ▸ provide the argument data_taxonomy on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the Dataplex resource. To set the location attribute: + ▸ provide the argument data_taxonomy on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + +FLAGS + --description=DESCRIPTION + Description of the Data Taxonomy. + + --display-name=DISPLAY_NAME + Display Name of the Data Taxonomy. + + --etag=ETAG + etag value for particular Data Taxonomy. + + --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. + + At most one of these can be specified: + + --async + Return immediately, without waiting for the operation in progress to + complete. + + --validate-only + Validate the update action, but don't actually perform 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. + diff --git a/gcloud/alpha/dataplex/help b/gcloud/alpha/dataplex/help index 9b8d30ee1..b5ba7f2fb 100644 --- a/gcloud/alpha/dataplex/help +++ b/gcloud/alpha/dataplex/help @@ -21,6 +21,12 @@ GROUPS content (ALPHA) Manage Dataplex Content. + data-attribute-bindings + (ALPHA) Manage Dataplex Data Attribute Bindings. + + data-taxonomies + (ALPHA) Manage Dataplex Data Taxonomies. + datascan (ALPHA) Manage Dataplex Datascan. diff --git a/gcloud/alpha/immersive-stream/help b/gcloud/alpha/immersive-stream/help index 4bbf08674..af83fe54a 100644 --- a/gcloud/alpha/immersive-stream/help +++ b/gcloud/alpha/immersive-stream/help @@ -22,5 +22,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 immersive-stream diff --git a/gcloud/alpha/immersive-stream/xr/contents/build b/gcloud/alpha/immersive-stream/xr/contents/build index f5a41c082..8763661bf 100644 --- a/gcloud/alpha/immersive-stream/xr/contents/build +++ b/gcloud/alpha/immersive-stream/xr/contents/build @@ -70,5 +70,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 immersive-stream xr contents build diff --git a/gcloud/alpha/immersive-stream/xr/contents/create b/gcloud/alpha/immersive-stream/xr/contents/create index e577a94d2..deeae97ce 100644 --- a/gcloud/alpha/immersive-stream/xr/contents/create +++ b/gcloud/alpha/immersive-stream/xr/contents/create @@ -70,5 +70,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 immersive-stream xr contents create diff --git a/gcloud/alpha/immersive-stream/xr/contents/delete b/gcloud/alpha/immersive-stream/xr/contents/delete index fe1fbd923..661ce0c9c 100644 --- a/gcloud/alpha/immersive-stream/xr/contents/delete +++ b/gcloud/alpha/immersive-stream/xr/contents/delete @@ -62,5 +62,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 immersive-stream xr contents delete diff --git a/gcloud/alpha/immersive-stream/xr/contents/describe b/gcloud/alpha/immersive-stream/xr/contents/describe index 357d013a5..9a08b6d99 100644 --- a/gcloud/alpha/immersive-stream/xr/contents/describe +++ b/gcloud/alpha/immersive-stream/xr/contents/describe @@ -57,5 +57,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 immersive-stream xr contents describe diff --git a/gcloud/alpha/immersive-stream/xr/contents/help b/gcloud/alpha/immersive-stream/xr/contents/help index f0bf50ffa..e544071a8 100644 --- a/gcloud/alpha/immersive-stream/xr/contents/help +++ b/gcloud/alpha/immersive-stream/xr/contents/help @@ -38,5 +38,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 immersive-stream xr contents diff --git a/gcloud/alpha/immersive-stream/xr/contents/list b/gcloud/alpha/immersive-stream/xr/contents/list index 6d78ec02a..54f8c0624 100644 --- a/gcloud/alpha/immersive-stream/xr/contents/list +++ b/gcloud/alpha/immersive-stream/xr/contents/list @@ -80,5 +80,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 immersive-stream xr contents list diff --git a/gcloud/alpha/immersive-stream/xr/contents/update b/gcloud/alpha/immersive-stream/xr/contents/update index e75af8da6..3c2d4c7d6 100644 --- a/gcloud/alpha/immersive-stream/xr/contents/update +++ b/gcloud/alpha/immersive-stream/xr/contents/update @@ -70,5 +70,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 immersive-stream xr contents update diff --git a/gcloud/alpha/immersive-stream/xr/help b/gcloud/alpha/immersive-stream/xr/help index 492e5d1e9..361f7bef9 100644 --- a/gcloud/alpha/immersive-stream/xr/help +++ b/gcloud/alpha/immersive-stream/xr/help @@ -28,5 +28,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 immersive-stream xr diff --git a/gcloud/alpha/immersive-stream/xr/instances/create b/gcloud/alpha/immersive-stream/xr/instances/create index 72328afe8..81bc36768 100644 --- a/gcloud/alpha/immersive-stream/xr/instances/create +++ b/gcloud/alpha/immersive-stream/xr/instances/create @@ -99,5 +99,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 immersive-stream xr instances create diff --git a/gcloud/alpha/immersive-stream/xr/instances/delete b/gcloud/alpha/immersive-stream/xr/instances/delete index 507cf9ea6..d02fed2a8 100644 --- a/gcloud/alpha/immersive-stream/xr/instances/delete +++ b/gcloud/alpha/immersive-stream/xr/instances/delete @@ -62,5 +62,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 immersive-stream xr instances delete diff --git a/gcloud/alpha/immersive-stream/xr/instances/describe b/gcloud/alpha/immersive-stream/xr/instances/describe index 99a4b02ae..80f3a46f9 100644 --- a/gcloud/alpha/immersive-stream/xr/instances/describe +++ b/gcloud/alpha/immersive-stream/xr/instances/describe @@ -57,5 +57,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 immersive-stream xr instances describe diff --git a/gcloud/alpha/immersive-stream/xr/instances/help b/gcloud/alpha/immersive-stream/xr/instances/help index 42ccc57dc..ce4eb4c4a 100644 --- a/gcloud/alpha/immersive-stream/xr/instances/help +++ b/gcloud/alpha/immersive-stream/xr/instances/help @@ -35,5 +35,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 immersive-stream xr instances diff --git a/gcloud/alpha/immersive-stream/xr/instances/list b/gcloud/alpha/immersive-stream/xr/instances/list index 5142f64ef..8e2e213c6 100644 --- a/gcloud/alpha/immersive-stream/xr/instances/list +++ b/gcloud/alpha/immersive-stream/xr/instances/list @@ -80,5 +80,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 immersive-stream xr instances list diff --git a/gcloud/alpha/immersive-stream/xr/instances/update b/gcloud/alpha/immersive-stream/xr/instances/update index 690a01de5..a72f162ac 100644 --- a/gcloud/alpha/immersive-stream/xr/instances/update +++ b/gcloud/alpha/immersive-stream/xr/instances/update @@ -130,5 +130,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 immersive-stream xr instances update diff --git a/gcloud/alpha/immersive-stream/xr/operations/describe b/gcloud/alpha/immersive-stream/xr/operations/describe index 3e8d04da7..290eeaf64 100644 --- a/gcloud/alpha/immersive-stream/xr/operations/describe +++ b/gcloud/alpha/immersive-stream/xr/operations/describe @@ -65,5 +65,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 immersive-stream xr operations describe diff --git a/gcloud/alpha/immersive-stream/xr/operations/help b/gcloud/alpha/immersive-stream/xr/operations/help index 28431ad16..ea1fe2705 100644 --- a/gcloud/alpha/immersive-stream/xr/operations/help +++ b/gcloud/alpha/immersive-stream/xr/operations/help @@ -31,5 +31,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 immersive-stream xr operations diff --git a/gcloud/alpha/immersive-stream/xr/operations/list b/gcloud/alpha/immersive-stream/xr/operations/list index 03534430a..7645c4a42 100644 --- a/gcloud/alpha/immersive-stream/xr/operations/list +++ b/gcloud/alpha/immersive-stream/xr/operations/list @@ -80,5 +80,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 immersive-stream xr operations list diff --git a/gcloud/alpha/immersive-stream/xr/operations/wait b/gcloud/alpha/immersive-stream/xr/operations/wait index f8945c0fa..7ddefc6c9 100644 --- a/gcloud/alpha/immersive-stream/xr/operations/wait +++ b/gcloud/alpha/immersive-stream/xr/operations/wait @@ -66,5 +66,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 immersive-stream xr operations wait diff --git a/gcloud/alpha/run/jobs/executions/help b/gcloud/alpha/run/jobs/executions/help index 208e9b7fb..3c406fcb7 100644 --- a/gcloud/alpha/run/jobs/executions/help +++ b/gcloud/alpha/run/jobs/executions/help @@ -28,6 +28,9 @@ GCLOUD WIDE FLAGS GROUPS GROUP is one of the following: + logs + (ALPHA) Read logs for Cloud Run jobs executions. + tasks (ALPHA) View and manage your Cloud Run jobs tasks. diff --git a/gcloud/alpha/run/jobs/executions/logs/help b/gcloud/alpha/run/jobs/executions/logs/help new file mode 100644 index 000000000..a5fa3a36e --- /dev/null +++ b/gcloud/alpha/run/jobs/executions/logs/help @@ -0,0 +1,45 @@ +NAME + gcloud alpha run jobs executions logs - read logs for Cloud Run jobs + executions + +SYNOPSIS + gcloud alpha run jobs executions logs COMMAND [--region=REGION] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Read logs for Cloud Run jobs executions. + +EXAMPLES + To tail logs for a job execution, run: + + $ gcloud alpha run jobs executions logs tail my-job-execution + + To read logs for a job execution, run: + + $ gcloud alpha run jobs executions logs read my-job-execution + +FLAGS + --region=REGION + Region in which the resource can be found. Alternatively, set the + property [run/region]. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + read + (ALPHA) Read logs for Cloud Run job executions. + + tail + (ALPHA) Tail logs for Cloud Run job executions. + +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/executions/logs/read b/gcloud/alpha/run/jobs/executions/logs/read new file mode 100644 index 000000000..c4d341a3a --- /dev/null +++ b/gcloud/alpha/run/jobs/executions/logs/read @@ -0,0 +1,84 @@ +NAME + gcloud alpha run jobs executions logs read - read logs for Cloud Run job + executions + +SYNOPSIS + gcloud alpha run jobs executions logs read EXECUTION + [--freshness=FRESHNESS; default="1d"] [--log-filter=LOG_FILTER] + [--order=ORDER; default="desc"] [--region=REGION] [--limit=LIMIT] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) gcloud alpha run jobs executions logs read reads log entries. Log + entries matching --log-filter are returned according to the specified + --order. If the log entries come from multiple logs, then entries from + different logs might be intermingled in the results. + +EXAMPLES + To read log entries from for a Cloud Run job execution, run: + + $ gcloud alpha run jobs executions logs read my-job-execution + + To read log entries with severity ERROR or higher, run: + + $ gcloud alpha run jobs executions logs read my-job-execution \ + --log-filter="severity>=ERROR" + + To read log entries written in a specific time window, run: + + $ gcloud alpha run jobs executions logs read my-job-execution \ + --log-filter='timestamp<="2015-05-31T23:59:59Z" AND + timestamp>="2015-05-31T00:00:00Z"' + + To read up to 10 log entries in your job payloads that include the word + SearchText and format the output in JSON format, run: + + $ gcloud alpha run jobs executions logs read my-job-execution \ + --log-filter="textPayload:SearchText" --limit=10 --format=json + + Detailed information about filters can be found at: + https://cloud.google.com/logging/docs/view/advanced_filters + +POSITIONAL ARGUMENTS + EXECUTION + Name for a Cloud Run job execution. + +FLAGS + --freshness=FRESHNESS; default="1d" + Return entries that are not older than this value. Works only with DESC + ordering and filters without a timestamp. See $ gcloud topic datetimes + for information on duration formats. + + --log-filter=LOG_FILTER + Filter expression that specifies the log entries to return. Detailed + information about filters can be found at: + https://cloud.google.com/logging/docs/view/logging-query-language + + --order=ORDER; default="desc" + Ordering of returned log entries based on timestamp field. ORDER must + be one of: desc, asc. + + --region=REGION + Region in which the resource can be found. Alternatively, set the + property [run/region]. + +LIST COMMAND FLAGS + --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. + +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/executions/logs/tail b/gcloud/alpha/run/jobs/executions/logs/tail new file mode 100644 index 000000000..fd99cad59 --- /dev/null +++ b/gcloud/alpha/run/jobs/executions/logs/tail @@ -0,0 +1,54 @@ +NAME + gcloud alpha run jobs executions logs tail - tail logs for Cloud Run job + executions + +SYNOPSIS + gcloud alpha run jobs executions logs tail EXECUTION + [--log-filter=LOG_FILTER] [--region=REGION] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) gcloud alpha run jobs executions logs tail tails log-entries for a + particular Cloud Run job exeuction in real time. The log entries are + formatted for consumption in a terminal. + +EXAMPLES + To tail log entries for a Cloud Run job exeuction, run: + + $ gcloud alpha run jobs executions logs tail my-job-execution + + To tail log entries with severity ERROR or higher, run: + + $ gcloud alpha run jobs executions logs tail my-job-execution \ + --log-filter="severity>=ERROR" + + Detailed information about filters can be found at: + https://cloud.google.com/logging/docs/view/advanced_filters + +POSITIONAL ARGUMENTS + EXECUTION + Name for a Cloud Run job. + +FLAGS + --log-filter=LOG_FILTER + Filter expression that specifies the log entries to return. Detailed + information about filters can be found at: + https://cloud.google.com/logging/docs/view/logging-query-language + + --region=REGION + Region in which the resource can be found. Alternatively, set the + property [run/region]. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This 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 30329b51d..01c5dd518 100644 --- a/gcloud/alpha/run/jobs/help +++ b/gcloud/alpha/run/jobs/help @@ -31,7 +31,7 @@ GROUPS (ALPHA) View and manage your Cloud Run jobs executions. logs - (ALPHA) Read logs for Cloud Run (fully managed) services. + (ALPHA) Read logs for Cloud Run jobs. COMMANDS COMMAND is one of the following: diff --git a/gcloud/alpha/run/jobs/logs/help b/gcloud/alpha/run/jobs/logs/help index 9825b785f..1e874e980 100644 --- a/gcloud/alpha/run/jobs/logs/help +++ b/gcloud/alpha/run/jobs/logs/help @@ -1,12 +1,11 @@ NAME - gcloud alpha run jobs logs - read logs for Cloud Run (fully managed) - services + gcloud alpha run jobs logs - read logs for Cloud Run jobs SYNOPSIS gcloud alpha run jobs logs COMMAND [--region=REGION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Read logs for Cloud Run (fully managed) services. + (ALPHA) Read logs for Cloud Run jobs. EXAMPLES To tail logs executions for a job, run: @@ -31,14 +30,16 @@ COMMANDS COMMAND is one of the following: read - (ALPHA) Read logs for a job. + (ALPHA) Read logs for Cloud Run jobs. tail - (ALPHA) Tail logs for a job. + (ALPHA) Tail logs for Cloud Run jobs. 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 logs diff --git a/gcloud/alpha/run/jobs/logs/read b/gcloud/alpha/run/jobs/logs/read index 853d343cd..5c557d050 100644 --- a/gcloud/alpha/run/jobs/logs/read +++ b/gcloud/alpha/run/jobs/logs/read @@ -1,5 +1,5 @@ NAME - gcloud alpha run jobs logs read - read logs for a job + gcloud alpha run jobs logs read - read logs for Cloud Run jobs SYNOPSIS gcloud alpha run jobs logs read JOB [--freshness=FRESHNESS; default="1d"] @@ -13,7 +13,7 @@ DESCRIPTION might be intermingled in the results. EXAMPLES - To read log entries from for a Cloud Run Job, run: + To read log entries from for a Cloud Run job, run: $ gcloud alpha run jobs logs read my-job @@ -78,5 +78,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 logs read diff --git a/gcloud/alpha/run/jobs/logs/tail b/gcloud/alpha/run/jobs/logs/tail index 1445df90c..3e569f84d 100644 --- a/gcloud/alpha/run/jobs/logs/tail +++ b/gcloud/alpha/run/jobs/logs/tail @@ -1,5 +1,5 @@ NAME - gcloud alpha run jobs logs tail - tail logs for a job + gcloud alpha run jobs logs tail - tail logs for Cloud Run jobs SYNOPSIS gcloud alpha run jobs logs tail JOB [--log-filter=LOG_FILTER] @@ -49,5 +49,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 logs tail diff --git a/gcloud/alpha/run/revisions/help b/gcloud/alpha/run/revisions/help index 5c3b7c6f1..2a24cc8e5 100644 --- a/gcloud/alpha/run/revisions/help +++ b/gcloud/alpha/run/revisions/help @@ -102,7 +102,7 @@ GROUPS GROUP is one of the following: logs - (ALPHA) Read logs for Cloud Run (fully managed) revisions. + (ALPHA) Read logs for Cloud Run revisions. COMMANDS COMMAND is one of the following: diff --git a/gcloud/alpha/run/revisions/logs/help b/gcloud/alpha/run/revisions/logs/help index 5d4f56632..dcc67e696 100644 --- a/gcloud/alpha/run/revisions/logs/help +++ b/gcloud/alpha/run/revisions/logs/help @@ -1,6 +1,5 @@ NAME - gcloud alpha run revisions logs - read logs for Cloud Run (fully managed) - revisions + gcloud alpha run revisions logs - read logs for Cloud Run revisions SYNOPSIS gcloud alpha run revisions logs COMMAND @@ -10,7 +9,7 @@ SYNOPSIS | --context=CONTEXT --kubeconfig=KUBECONFIG] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Read logs for Cloud Run (fully managed) revisions. + (ALPHA) Read logs for Cloud Run revisions. FLAGS --platform=PLATFORM; default="managed" @@ -97,10 +96,10 @@ COMMANDS COMMAND is one of the following: read - (ALPHA) Read logs for a revision. + (ALPHA) Read logs for a Cloud Run revision. tail - (ALPHA) Tail logs for a revision. + (ALPHA) Tail logs for a Cloud Run revision. NOTES This command is currently in alpha and might change without notice. If this diff --git a/gcloud/alpha/run/revisions/logs/read b/gcloud/alpha/run/revisions/logs/read index 223c8352f..af9e0920a 100644 --- a/gcloud/alpha/run/revisions/logs/read +++ b/gcloud/alpha/run/revisions/logs/read @@ -1,5 +1,5 @@ NAME - gcloud alpha run revisions logs read - read logs for a revision + gcloud alpha run revisions logs read - read logs for a Cloud Run revision SYNOPSIS gcloud alpha run revisions logs read REVISION diff --git a/gcloud/alpha/run/revisions/logs/tail b/gcloud/alpha/run/revisions/logs/tail index 12c41e1bf..82456f6e0 100644 --- a/gcloud/alpha/run/revisions/logs/tail +++ b/gcloud/alpha/run/revisions/logs/tail @@ -1,5 +1,5 @@ NAME - gcloud alpha run revisions logs tail - tail logs for a revision + gcloud alpha run revisions logs tail - tail logs for a Cloud Run revision SYNOPSIS gcloud alpha run revisions logs tail REVISION [--log-filter=LOG_FILTER] diff --git a/gcloud/alpha/run/services/help b/gcloud/alpha/run/services/help index fd1fe8b90..9037aaedd 100644 --- a/gcloud/alpha/run/services/help +++ b/gcloud/alpha/run/services/help @@ -104,7 +104,7 @@ GROUPS GROUP is one of the following: logs - (ALPHA) Read logs for Cloud Run (fully managed) services. + (ALPHA) Read logs for Cloud Run services. COMMANDS COMMAND is one of the following: diff --git a/gcloud/alpha/run/services/logs/help b/gcloud/alpha/run/services/logs/help index f84fba15a..2847c1a19 100644 --- a/gcloud/alpha/run/services/logs/help +++ b/gcloud/alpha/run/services/logs/help @@ -1,6 +1,5 @@ NAME - gcloud alpha run services logs - read logs for Cloud Run (fully managed) - services + gcloud alpha run services logs - read logs for Cloud Run services SYNOPSIS gcloud alpha run services logs COMMAND @@ -10,7 +9,7 @@ SYNOPSIS | --context=CONTEXT --kubeconfig=KUBECONFIG] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Read logs for Cloud Run (fully managed) services. + (ALPHA) Read logs for Cloud Run services. FLAGS --platform=PLATFORM; default="managed" @@ -97,10 +96,10 @@ COMMANDS COMMAND is one of the following: read - (ALPHA) Read logs for a service. + (ALPHA) Read logs for a Cloud Run service. tail - (ALPHA) Tail logs for a service. + (ALPHA) Tail logs for a Cloud Run service. NOTES This command is currently in alpha and might change without notice. If this diff --git a/gcloud/alpha/run/services/logs/read b/gcloud/alpha/run/services/logs/read index e64988a95..ee9fe5623 100644 --- a/gcloud/alpha/run/services/logs/read +++ b/gcloud/alpha/run/services/logs/read @@ -1,5 +1,5 @@ NAME - gcloud alpha run services logs read - read logs for a service + gcloud alpha run services logs read - read logs for a Cloud Run service SYNOPSIS gcloud alpha run services logs read SERVICE diff --git a/gcloud/alpha/run/services/logs/tail b/gcloud/alpha/run/services/logs/tail index c5cf5d740..2c6b11126 100644 --- a/gcloud/alpha/run/services/logs/tail +++ b/gcloud/alpha/run/services/logs/tail @@ -1,5 +1,5 @@ NAME - gcloud alpha run services logs tail - tail logs for a service + gcloud alpha run services logs tail - tail logs for a Cloud Run service SYNOPSIS gcloud alpha run services logs tail SERVICE [--log-filter=LOG_FILTER] diff --git a/gcloud/alpha/sql/users/describe b/gcloud/alpha/sql/users/describe index b8c31f5c8..cdf91650e 100644 --- a/gcloud/alpha/sql/users/describe +++ b/gcloud/alpha/sql/users/describe @@ -46,7 +46,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 sql users describe $ gcloud beta sql users describe diff --git a/gcloud/beta/ai/hp-tuning-jobs/create b/gcloud/beta/ai/hp-tuning-jobs/create index a2125ad0f..2d3bb08f0 100644 --- a/gcloud/beta/ai/hp-tuning-jobs/create +++ b/gcloud/beta/ai/hp-tuning-jobs/create @@ -5,9 +5,8 @@ SYNOPSIS gcloud beta ai hp-tuning-jobs create --config=CONFIG --display-name=DISPLAY_NAME [--algorithm=ALGORITHM] [--enable-dashboard-access] [--enable-web-access] - [--labels=[KEY=VALUE,...]] - [--max-trial-count=MAX_TRIAL_COUNT; default=1] [--network=NETWORK] - [--parallel-trial-count=PARALLEL_TRIAL_COUNT; default=1] + [--labels=[KEY=VALUE,...]] [--max-trial-count=MAX_TRIAL_COUNT] + [--network=NETWORK] [--parallel-trial-count=PARALLEL_TRIAL_COUNT] [--region=REGION] [--service-account=SERVICE_ACCOUNT] [--kms-key=KMS_KEY : --kms-keyring=KMS_KEYRING --kms-location=KMS_LOCATION --kms-project=KMS_PROJECT] @@ -82,7 +81,7 @@ OPTIONAL FLAGS contain only hyphens (-), underscores (_), lowercase characters, and numbers. - --max-trial-count=MAX_TRIAL_COUNT; default=1 + --max-trial-count=MAX_TRIAL_COUNT Desired total number of trials. The default value is 1. --network=NETWORK @@ -90,7 +89,7 @@ OPTIONAL FLAGS peered with. Private services access must already have been configured. If unspecified, the Job is not peered with any network. - --parallel-trial-count=PARALLEL_TRIAL_COUNT; default=1 + --parallel-trial-count=PARALLEL_TRIAL_COUNT Desired number of Trials to run in parallel. The default value is 1. Region resource - Cloud region to create a hyperparameter tuning job. This diff --git a/gcloud/beta/alloydb/clusters/create b/gcloud/beta/alloydb/clusters/create index 0b02221e9..0787d8f18 100644 --- a/gcloud/beta/alloydb/clusters/create +++ b/gcloud/beta/alloydb/clusters/create @@ -5,6 +5,10 @@ NAME SYNOPSIS gcloud beta alloydb clusters create CLUSTER --password=PASSWORD --region=REGION [--async] [--network=NETWORK] + [--continuous-backup-recovery-window-days=RECOVERY_PERIOD + --enable-continuous-backup + [--continuous-backup-encryption-key=CONTINUOUS_BACKUP_ENCRYPTION_KEY + : --continuous-backup-encryption-key-keyring=CONTINUOUS_BACKUP_ENCRYPTION_KEY_KEYRING --continuous-backup-encryption-key-location=CONTINUOUS_BACKUP_ENCRYPTION_KEY_LOCATION --continuous-backup-encryption-key-project=CONTINUOUS_BACKUP_ENCRYPTION_KEY_PROJECT]] [--disable-automated-backup | [--automated-backup-days-of-week=[DAYS_OF_WEEK,...] --automated-backup-start-times=[START_TIMES,...] @@ -48,6 +52,52 @@ OPTIONAL FLAGS network, 'testsharednetwork', this would be of the form:--network=projects/testproject/global/networks/testsharednetwork + Continuous Backup configuration. + + --continuous-backup-recovery-window-days=RECOVERY_PERIOD + Recovery window of the log files and backups saved to support + Continuous Backups. + + --enable-continuous-backup + Enables Continuous Backups on the cluster. + + Key resource - The Cloud KMS (Key Management Service) cryptokey that + will be used to protect the continuous backup. The 'AlloyDB Service + Agent's service account must hold permission 'Cloud KMS CryptoKey + Encrypter/Decrypter'. The arguments in this group can be used to specify + the attributes of this resource. + + --continuous-backup-encryption-key=CONTINUOUS_BACKUP_ENCRYPTION_KEY + ID of the key or fully qualified identifier for the key. To set the + kms-key attribute: + ▫ provide the argument --continuous-backup-encryption-key on the + command line. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --continuous-backup-encryption-key-keyring=CONTINUOUS_BACKUP_ENCRYPTION_KEY_KEYRING + The KMS keyring of the key. To set the kms-keyring attribute: + ▫ provide the argument --continuous-backup-encryption-key on the + command line with a fully specified name; + ▫ provide the argument --continuous-backup-encryption-key-keyring + on the command line. + + --continuous-backup-encryption-key-location=CONTINUOUS_BACKUP_ENCRYPTION_KEY_LOCATION + The Cloud location for the key. To set the kms-location attribute: + ▫ provide the argument --continuous-backup-encryption-key on the + command line with a fully specified name; + ▫ provide the argument + --continuous-backup-encryption-key-location on the command line. + + --continuous-backup-encryption-key-project=CONTINUOUS_BACKUP_ENCRYPTION_KEY_PROJECT + The Cloud project for the key. To set the kms-project attribute: + ▫ provide the argument --continuous-backup-encryption-key on the + command line with a fully specified name; + ▫ provide the argument --continuous-backup-encryption-key-project + on the command line; + ▫ set the property core/project. + Automated backup policy. If unspecified, automated backups are enabled. At most one of these can be specified: diff --git a/gcloud/beta/alloydb/clusters/restore b/gcloud/beta/alloydb/clusters/restore index 45ceeb288..2d3fc3fb1 100644 --- a/gcloud/beta/alloydb/clusters/restore +++ b/gcloud/beta/alloydb/clusters/restore @@ -3,8 +3,10 @@ NAME given backup SYNOPSIS - gcloud beta alloydb clusters restore CLUSTER --region=REGION - --backup=BACKUP [--async] [--network=NETWORK] + gcloud beta alloydb clusters restore CLUSTER --region=REGION [--async] + [--network=NETWORK] + [--backup=BACKUP + : --point-in-time=POINT_IN_TIME --source-cluster=SOURCE_CLUSTER] [--kms-key=KMS_KEY : --kms-keyring=KMS_KEYRING --kms-location=KMS_LOCATION --kms-project=KMS_PROJECT] [GCLOUD_WIDE_FLAG ...] @@ -28,15 +30,6 @@ REQUIRED FLAGS regions at https://cloud.google.com/sql/docs/instance-locations. OPTIONAL FLAGS - RestoreCluster source types. - - At most one of these can be specified: - - Restore a cluster using a specific backup as the source. - - --backup=BACKUP - AlloyDB backup ID - --async Return immediately, without waiting for the operation in progress to complete. @@ -48,6 +41,30 @@ OPTIONAL FLAGS network, 'testsharednetwork', this would be of the form:--network=projects/testproject/global/networks/testsharednetwork + RestoreCluster source types. + + At most one of these can be specified: + + Restore a cluster using a specific backup as the source. + + --backup=BACKUP + AlloyDB backup ID + + Restore a cluster from a source cluster at a given point in time. + + --point-in-time=POINT_IN_TIME + Point in time to restore to, in RFC 3339 format. For example, + 2012-11-15T16:19:00.094Z. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --source-cluster=SOURCE_CLUSTER + Source cluster name. + + This flag argument must be specified if any of the other arguments + in this group are specified. + Key resource - The Cloud KMS (Key Management Service) cryptokey that will be used to protect the cluster. The 'AlloyDB Service Agent' service account must hold permission 'Cloud KMS CryptoKey Encrypter/Decrypter'. diff --git a/gcloud/beta/alloydb/clusters/update b/gcloud/beta/alloydb/clusters/update index 6058146b9..21c70119d 100644 --- a/gcloud/beta/alloydb/clusters/update +++ b/gcloud/beta/alloydb/clusters/update @@ -10,6 +10,10 @@ SYNOPSIS : --automated-backup-window=TIMEOUT_PERIOD [--automated-backup-encryption-key=AUTOMATED_BACKUP_ENCRYPTION_KEY : --automated-backup-encryption-key-keyring=AUTOMATED_BACKUP_ENCRYPTION_KEY_KEYRING --automated-backup-encryption-key-location=AUTOMATED_BACKUP_ENCRYPTION_KEY_LOCATION --automated-backup-encryption-key-project=AUTOMATED_BACKUP_ENCRYPTION_KEY_PROJECT] --automated-backup-retention-count=RETENTION_COUNT | --automated-backup-retention-period=RETENTION_PERIOD]] + [--continuous-backup-recovery-window-days=RECOVERY_PERIOD + --enable-continuous-backup + [--continuous-backup-encryption-key=CONTINUOUS_BACKUP_ENCRYPTION_KEY + : --continuous-backup-encryption-key-keyring=CONTINUOUS_BACKUP_ENCRYPTION_KEY_KEYRING --continuous-backup-encryption-key-location=CONTINUOUS_BACKUP_ENCRYPTION_KEY_LOCATION --continuous-backup-encryption-key-project=CONTINUOUS_BACKUP_ENCRYPTION_KEY_PROJECT]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -126,6 +130,52 @@ OPTIONAL FLAGS Retention period of the backup relative to creation time. See $ gcloud topic datetimes for information on duration formats. + Continuous Backup configuration. + + --continuous-backup-recovery-window-days=RECOVERY_PERIOD + Recovery window of the log files and backups saved to support + Continuous Backups. + + --enable-continuous-backup + Enables Continuous Backups on the cluster. + + Key resource - The Cloud KMS (Key Management Service) cryptokey that + will be used to protect the continuous backup. The 'AlloyDB Service + Agent's service account must hold permission 'Cloud KMS CryptoKey + Encrypter/Decrypter'. The arguments in this group can be used to specify + the attributes of this resource. + + --continuous-backup-encryption-key=CONTINUOUS_BACKUP_ENCRYPTION_KEY + ID of the key or fully qualified identifier for the key. To set the + kms-key attribute: + ▫ provide the argument --continuous-backup-encryption-key on the + command line. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --continuous-backup-encryption-key-keyring=CONTINUOUS_BACKUP_ENCRYPTION_KEY_KEYRING + The KMS keyring of the key. To set the kms-keyring attribute: + ▫ provide the argument --continuous-backup-encryption-key on the + command line with a fully specified name; + ▫ provide the argument --continuous-backup-encryption-key-keyring + on the command line. + + --continuous-backup-encryption-key-location=CONTINUOUS_BACKUP_ENCRYPTION_KEY_LOCATION + The Cloud location for the key. To set the kms-location attribute: + ▫ provide the argument --continuous-backup-encryption-key on the + command line with a fully specified name; + ▫ provide the argument + --continuous-backup-encryption-key-location on the command line. + + --continuous-backup-encryption-key-project=CONTINUOUS_BACKUP_ENCRYPTION_KEY_PROJECT + The Cloud project for the key. To set the kms-project attribute: + ▫ provide the argument --continuous-backup-encryption-key on the + command line with a fully specified name; + ▫ provide the argument --continuous-backup-encryption-key-project + on the command line; + ▫ set the property core/project. + 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/beta/app/instances/help b/gcloud/beta/app/instances/help index 3191bfbf8..a61aa796f 100644 --- a/gcloud/beta/app/instances/help +++ b/gcloud/beta/app/instances/help @@ -42,7 +42,8 @@ COMMANDS project. scp - (BETA) SCP from or to the VM of an App Engine Flexible instance. + (BETA) SCP from or to the VM of an App Engine Flexible environment + instance. ssh (BETA) SSH into the VM of an App Engine Flexible instance. diff --git a/gcloud/beta/app/instances/scp b/gcloud/beta/app/instances/scp index bb719029b..334ac574b 100644 --- a/gcloud/beta/app/instances/scp +++ b/gcloud/beta/app/instances/scp @@ -1,15 +1,15 @@ NAME gcloud beta app instances scp - SCP from or to the VM of an App Engine - Flexible instance + Flexible environment instance SYNOPSIS gcloud beta app instances scp [INSTANCE:]SRC [[INSTANCE:]SRC ...] [INSTANCE:]DEST [--compress] [--recurse] [--service=SERVICE] - [--version=VERSION] [GCLOUD_WIDE_FLAG ...] + [--tunnel-through-iap] [--version=VERSION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) gcloud beta app instances scp lets you remotely copy files to or - from an App Engine Flexible instance. + from an App Engine Flexible environment instance. gcloud beta app instances scp resolves the instance's IP address and pre-populates the VM with a public key managed by gcloud. If the gcloud @@ -54,6 +54,13 @@ FLAGS --service=SERVICE The service ID. + --tunnel-through-iap + Tunnel the ssh connection through Identity-Aware Proxy for TCP + forwarding. + + To learn more, see the IAP for TCP forwarding documentation + (https://cloud.google.com/iap/docs/tcp-forwarding-overview). + --version=VERSION The version ID. diff --git a/gcloud/beta/app/instances/ssh b/gcloud/beta/app/instances/ssh index 0eda194ee..fedc1cb68 100644 --- a/gcloud/beta/app/instances/ssh +++ b/gcloud/beta/app/instances/ssh @@ -60,7 +60,7 @@ FLAGS The service ID. --tunnel-through-iap - Tunnel the ssh connection through Cloud Identity-Aware Proxy for TCP + Tunnel the ssh connection through Identity-Aware Proxy for TCP forwarding. To learn more, see the IAP for TCP forwarding documentation diff --git a/gcloud/beta/compute/commitments/create b/gcloud/beta/compute/commitments/create index 922abb77d..2bb00c92e 100644 --- a/gcloud/beta/compute/commitments/create +++ b/gcloud/beta/compute/commitments/create @@ -173,8 +173,7 @@ OPTIONAL FLAGS --maintenance-interval=MAINTENANCE_INTERVAL Specifies how infrastructure upgrades should be applied to the - VM. MAINTENANCE_INTERVAL must be (currently only one value is - supported): + VM. MAINTENANCE_INTERVAL must be one of: PERIODIC VMs receive infrastructure and hypervisor updates on a @@ -182,6 +181,14 @@ OPTIONAL FLAGS operations (live migrations or terminations) on an individual VM. Security updates will still be applied as soon as they are available. + RECURRENT + VMs receive infrastructure and hypervisor updates on a + periodic basis, minimizing the number of maintenance + operations (live migrations or terminations) on an individual + VM. This may mean a VM will take longer to receive an update + than if it was configured for AS_NEEDED. Security updates + will still be applied as soonas they are available. RECURRENT + is used for GEN3 and Sliceof Hardware VMs. --min-cpu-platform=MIN_CPU_PLATFORM Optional minimum CPU platform of the reservation to create. diff --git a/gcloud/beta/compute/forwarding-rules/create b/gcloud/beta/compute/forwarding-rules/create index 9e5b3590c..1819cfd8f 100644 --- a/gcloud/beta/compute/forwarding-rules/create +++ b/gcloud/beta/compute/forwarding-rules/create @@ -14,9 +14,10 @@ SYNOPSIS | --target-ssl-proxy=TARGET_SSL_PROXY | --target-tcp-proxy=TARGET_TCP_PROXY | --target-vpn-gateway=TARGET_VPN_GATEWAY) [--address=ADDRESS] - [--allow-global-access] [--description=DESCRIPTION] - [--disable-automate-dns-zone] [--ip-protocol=IP_PROTOCOL] - [--ip-version=IP_VERSION] [--is-mirroring-collector] + [--allow-global-access] [--allow-psc-global-access] + [--description=DESCRIPTION] [--disable-automate-dns-zone] + [--ip-protocol=IP_PROTOCOL] [--ip-version=IP_VERSION] + [--is-mirroring-collector] [--load-balancing-scheme=LOAD_BALANCING_SCHEME] [--network=NETWORK] [--network-tier=NETWORK_TIER] [--service-directory-registration=SERVICE_DIRECTORY_REGISTRATION] @@ -199,6 +200,11 @@ OPTIONAL FLAGS forwarding rules of type INTERNAL, the target must be either a backend service or a target instance. + --allow-psc-global-access + If specified, clients from all regions can access this Private Service + Connect forwarding rule. This can only be specified if the forwarding + rule's target is a service attachment (--target-service-attachment). + --description=DESCRIPTION Optional textual description for the forwarding rule. diff --git a/gcloud/beta/compute/forwarding-rules/update b/gcloud/beta/compute/forwarding-rules/update index 29d0ad3ff..7562979dc 100644 --- a/gcloud/beta/compute/forwarding-rules/update +++ b/gcloud/beta/compute/forwarding-rules/update @@ -4,7 +4,7 @@ NAME SYNOPSIS gcloud beta compute forwarding-rules update NAME [--allow-global-access] - [--source-ip-ranges=SOURCE_IP_RANGE,[...]] + [--allow-psc-global-access] [--source-ip-ranges=SOURCE_IP_RANGE,[...]] [--update-labels=[KEY=VALUE,...]] [--clear-labels | --remove-labels=[KEY,...]] [--global | --region=REGION] [GCLOUD_WIDE_FLAG ...] @@ -47,6 +47,11 @@ FLAGS forwarding rules of type INTERNAL, the target must be either a backend service or a target instance. + --allow-psc-global-access + If specified, clients from all regions can access this Private Service + Connect forwarding rule. This can only be specified if the forwarding + rule's target is a service attachment (--target-service-attachment). + --source-ip-ranges=SOURCE_IP_RANGE,[...] List of comma-separated IP addresses or IP ranges. If not empty, this Forwarding Rule will only forward the traffic when the source IP diff --git a/gcloud/beta/compute/instance-groups/managed/create b/gcloud/beta/compute/instance-groups/managed/create index 7647d873c..eb42ef36e 100644 --- a/gcloud/beta/compute/instance-groups/managed/create +++ b/gcloud/beta/compute/instance-groups/managed/create @@ -29,14 +29,16 @@ DESCRIPTION (BETA) gcloud beta compute instance-groups managed create creates a Compute Engine managed instance group. - For example, running: +EXAMPLES + Running: $ gcloud beta compute instance-groups managed create \ - example-managed-instance-group --zone us-central1-a \ - --template example-instance-template --size 1 + example-managed-instance-group --zone=us-central1-a \ + --template=example-global-instance-template --size=1 will create one managed instance group called - 'example-managed-instance-group' in the us-central1-a zone. + 'example-managed-instance-group' in the us-central1-a zone with global + instance template resource: 'example-global-instance-template'. POSITIONAL ARGUMENTS NAME @@ -44,16 +46,16 @@ POSITIONAL ARGUMENTS REQUIRED FLAGS --size=SIZE - The initial number of instances you want in this group. + Initial number of instances you want in this group. --template=TEMPLATE Specifies the instance template to use when creating new instances. OPTIONAL FLAGS --base-instance-name=BASE_INSTANCE_NAME - The base name to use for the Compute Engine instances that will be - created with the managed instance group. If not provided base instance - name will be the prefix of instance group name. + Base name to use for the Compute Engine instances that will be created + with the managed instance group. If not provided base instance name + will be the prefix of instance group name. --description=DESCRIPTION An optional description for this group. diff --git a/gcloud/beta/compute/instances/bulk/create b/gcloud/beta/compute/instances/bulk/create index bb4b5b8b2..f09f05bc9 100644 --- a/gcloud/beta/compute/instances/bulk/create +++ b/gcloud/beta/compute/instances/bulk/create @@ -443,8 +443,8 @@ OPTIONAL FLAGS Policy for which zones to include or exclude during bulk instance creation within a region. Policy is defined as a list of key-value pairs, with the key being the zone name, and value being the applied - policy. Available policies are allow and deny. Default for zones left - unspecified is allow. + policy. Available policies are allow and deny. Default for zones if + left unspecified is allow. Example: diff --git a/gcloud/beta/compute/resource-policies/create-snapshot-schedule b/gcloud/beta/compute/resource-policies/create-snapshot-schedule index 28cb4656a..56de96e5f 100644 --- a/gcloud/beta/compute/resource-policies/create-snapshot-schedule +++ b/gcloud/beta/compute/resource-policies/create-snapshot-schedule @@ -39,17 +39,20 @@ REQUIRED FLAGS Exactly one of these must be specified: - From file: + Using a file: --weekly-schedule-from-file=WEEKLY_CYCLE_FROM_FILE - A JSON/YAML file which specifies a weekly schedule. It should be a - list of objects with the following fields: + A JSON/YAML file which specifies a weekly schedule. The file should + contain the following fields: day: Day of the week with the same choices as --weekly-schedule. startTime: Start time of the snapshot schedule with the same format as --start-time. - From flags: + For more information about using a file, see + https://cloud.google.com/compute/docs/disks/scheduled-snapshots#create_snapshot_schedule + + Using command flags: --start-time=START_TIME Start time for the disk snapshot schedule. See $ gcloud topic @@ -120,7 +123,7 @@ OPTIONAL FLAGS contain only hyphens (-), underscores (_), lowercase characters, and numbers. - These will be added to the disk snapshots on creation. + The label is added to each snapshot created by the schedule. --storage-location=LOCATION Google Cloud Storage location, either regional or multi-regional, diff --git a/gcloud/beta/compute/resource-policies/create/snapshot-schedule b/gcloud/beta/compute/resource-policies/create/snapshot-schedule index 0ce2abbcd..0e353210c 100644 --- a/gcloud/beta/compute/resource-policies/create/snapshot-schedule +++ b/gcloud/beta/compute/resource-policies/create/snapshot-schedule @@ -37,17 +37,20 @@ REQUIRED FLAGS Exactly one of these must be specified: - From file: + Using a file: --weekly-schedule-from-file=WEEKLY_CYCLE_FROM_FILE - A JSON/YAML file which specifies a weekly schedule. It should be a - list of objects with the following fields: + A JSON/YAML file which specifies a weekly schedule. The file should + contain the following fields: day: Day of the week with the same choices as --weekly-schedule. startTime: Start time of the snapshot schedule with the same format as --start-time. - From flags: + For more information about using a file, see + https://cloud.google.com/compute/docs/disks/scheduled-snapshots#create_snapshot_schedule + + Using command flags: --start-time=START_TIME Start time for the disk snapshot schedule in UTC. For example, @@ -118,7 +121,7 @@ OPTIONAL FLAGS contain only hyphens (-), underscores (_), lowercase characters, and numbers. - These will be added to the disk snapshots on creation. + The label is added to each snapshot created by the schedule. --storage-location=LOCATION Google Cloud Storage location, either regional or multi-regional, diff --git a/gcloud/beta/compute/resource-policies/help b/gcloud/beta/compute/resource-policies/help index 66706b2ea..225879b36 100644 --- a/gcloud/beta/compute/resource-policies/help +++ b/gcloud/beta/compute/resource-policies/help @@ -27,6 +27,9 @@ GROUPS create (BETA) Create Compute Engine Resource Policies. + update + (BETA) Update Compute Engine Resource Policies. + COMMANDS COMMAND is one of the following: diff --git a/gcloud/beta/compute/resource-policies/update/help b/gcloud/beta/compute/resource-policies/update/help new file mode 100644 index 000000000..551c9e103 --- /dev/null +++ b/gcloud/beta/compute/resource-policies/update/help @@ -0,0 +1,27 @@ +NAME + gcloud beta compute resource-policies update - update Compute Engine + Resource Policies + +SYNOPSIS + gcloud beta compute resource-policies update COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Update Compute Engine Resource Policies. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + snapshot-schedule + (BETA) Update a Compute Engine Snapshot Schedule Resource Policy. + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha compute resource-policies update + diff --git a/gcloud/beta/compute/resource-policies/update/snapshot-schedule b/gcloud/beta/compute/resource-policies/update/snapshot-schedule new file mode 100644 index 000000000..875be461f --- /dev/null +++ b/gcloud/beta/compute/resource-policies/update/snapshot-schedule @@ -0,0 +1,114 @@ +NAME + gcloud beta compute resource-policies update snapshot-schedule - update a + Compute Engine Snapshot Schedule Resource Policy + +SYNOPSIS + gcloud beta compute resource-policies update snapshot-schedule NAME + [--description=DESCRIPTION] [--region=REGION] + [--snapshot-labels=[KEY=VALUE,...]] + [--weekly-schedule-from-file=WEEKLY_CYCLE_FROM_FILE + | --start-time=START_TIME (--daily-schedule | --hourly-schedule=HOURS + | --weekly-schedule=WEEKLY_CYCLE)] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Update a Compute Engine Snapshot Schedule Resource Policy. + +EXAMPLES + The following command updates a Compute Engine Snapshot Schedule Resource + Policy to take a daily snapshot taken at 13:00 UTC + + $ gcloud beta compute resource-policies update snapshot-schedule \ + my-resource-policy --region=REGION --start-time=13:00 \ + --daily-schedule + +POSITIONAL ARGUMENTS + NAME + Name of the resource policy to operate on. + +FLAGS + --description=DESCRIPTION + An optional, textual description for the backend. + + --region=REGION + Region of the resource policy to operate on. If not specified, you + might be prompted to select a region (interactive mode only). + + To avoid prompting when this flag is omitted, you can set the + compute/region property: + + $ gcloud config set compute/region REGION + + A list of regions can be fetched by running: + + $ gcloud compute regions list + + To unset the property, run: + + $ gcloud config unset compute/region + + Alternatively, the region can be stored in the environment variable + CLOUDSDK_COMPUTE_REGION. + + --snapshot-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. + + The label is added to each snapshot created by the schedule. + + Cycle Frequency Group. + + At most one of these can be specified: + + Using a file: + + --weekly-schedule-from-file=WEEKLY_CYCLE_FROM_FILE + A JSON/YAML file which specifies a weekly schedule. The file should + contain the following fields: + + day: Day of the week with the same choices as --weekly-schedule. + startTime: Start time of the snapshot schedule with the same format + as --start-time. + + For more information about using a file, see + https://cloud.google.com/compute/docs/disks/scheduled-snapshots#create_snapshot_schedule + + Using command flags: + + --start-time=START_TIME + Start time for the disk snapshot schedule in UTC. For example, + --start-time="15:00". + + This flag argument must be specified if any of the other arguments + in this group are specified. + + Exactly one of these must be specified: + + --daily-schedule + Snapshot schedule starts daily at START_TIME. + + --hourly-schedule=HOURS + Snapshot schedule occurs every n hours starting at START_TIME. + + --weekly-schedule=WEEKLY_CYCLE + Snapshot schedule occurs weekly on WEEKLY_SCHEDULE at START_TIME. + WEEKLY_CYCLE must be one of: monday, tuesday, wednesday, + thursday, friday, saturday, sunday. + +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 beta and might change without notice. This + variant is also available: + + $ gcloud alpha compute resource-policies update snapshot-schedule + diff --git a/gcloud/beta/config/get b/gcloud/beta/config/get index 938b53433..5fbf0f035 100644 --- a/gcloud/beta/config/get +++ b/gcloud/beta/config/get @@ -648,6 +648,14 @@ AVAILABLE PROPERTIES SERVICE_ACCOUNT_2. SERVICE_ACCOUNT_1 is the impersonated service account and SERVICE_ACCOUNT_2 is the delegate. + service_account_disable_id_token_refresh + If True, disable ID token refresh for service account. + + service_account_use_self_signed_jwt + If True, use self signed jwt flow to get service account + credentials access token. This only applies to service account json + file and not to the legacy .p12 file. + token_host Overrides the token endpoint to provision access tokens. It can be used with Private Service Connect. diff --git a/gcloud/beta/config/help b/gcloud/beta/config/help index 3726ca9f0..ff743a901 100644 --- a/gcloud/beta/config/help +++ b/gcloud/beta/config/help @@ -680,6 +680,14 @@ AVAILABLE PROPERTIES SERVICE_ACCOUNT_2. SERVICE_ACCOUNT_1 is the impersonated service account and SERVICE_ACCOUNT_2 is the delegate. + service_account_disable_id_token_refresh + If True, disable ID token refresh for service account. + + service_account_use_self_signed_jwt + If True, use self signed jwt flow to get service account + credentials access token. This only applies to service account json + file and not to the legacy .p12 file. + token_host Overrides the token endpoint to provision access tokens. It can be used with Private Service Connect. diff --git a/gcloud/beta/config/list b/gcloud/beta/config/list index 54106b065..0742e619f 100644 --- a/gcloud/beta/config/list +++ b/gcloud/beta/config/list @@ -692,6 +692,14 @@ AVAILABLE PROPERTIES SERVICE_ACCOUNT_2. SERVICE_ACCOUNT_1 is the impersonated service account and SERVICE_ACCOUNT_2 is the delegate. + service_account_disable_id_token_refresh + If True, disable ID token refresh for service account. + + service_account_use_self_signed_jwt + If True, use self signed jwt flow to get service account + credentials access token. This only applies to service account json + file and not to the legacy .p12 file. + token_host Overrides the token endpoint to provision access tokens. It can be used with Private Service Connect. diff --git a/gcloud/beta/config/set b/gcloud/beta/config/set index e2e577216..9fa02bda1 100644 --- a/gcloud/beta/config/set +++ b/gcloud/beta/config/set @@ -695,6 +695,14 @@ AVAILABLE PROPERTIES SERVICE_ACCOUNT_2. SERVICE_ACCOUNT_1 is the impersonated service account and SERVICE_ACCOUNT_2 is the delegate. + service_account_disable_id_token_refresh + If True, disable ID token refresh for service account. + + service_account_use_self_signed_jwt + If True, use self signed jwt flow to get service account + credentials access token. This only applies to service account json + file and not to the legacy .p12 file. + token_host Overrides the token endpoint to provision access tokens. It can be used with Private Service Connect. diff --git a/gcloud/beta/config/unset b/gcloud/beta/config/unset index 79d689c4a..416973e88 100644 --- a/gcloud/beta/config/unset +++ b/gcloud/beta/config/unset @@ -656,6 +656,14 @@ AVAILABLE PROPERTIES SERVICE_ACCOUNT_2. SERVICE_ACCOUNT_1 is the impersonated service account and SERVICE_ACCOUNT_2 is the delegate. + service_account_disable_id_token_refresh + If True, disable ID token refresh for service account. + + service_account_use_self_signed_jwt + If True, use self signed jwt flow to get service account + credentials access token. This only applies to service account json + file and not to the legacy .p12 file. + token_host Overrides the token endpoint to provision access tokens. It can be used with Private Service Connect. diff --git a/gcloud/beta/container/fleet/identity-service/delete b/gcloud/beta/container/fleet/identity-service/delete index 2d76d5eda..f49721829 100644 --- a/gcloud/beta/container/fleet/identity-service/delete +++ b/gcloud/beta/container/fleet/identity-service/delete @@ -4,6 +4,7 @@ NAME SYNOPSIS gcloud beta container fleet identity-service delete + [--fleet-default-member-config] [--membership=MEMBERSHIP : --location=LOCATION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -16,6 +17,16 @@ EXAMPLES --membership=MEMBERSHIP_NAME FLAGS + --fleet-default-member-config + If specified, deletes the default membership configuration present in + your fleet. + + To delete the default membership configuration present in your + fleet, run: + + $ gcloud beta container fleet identity-service delete \ + --fleet-default-member-config + Membership resource - The group of arguments defining a membership. 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 diff --git a/gcloud/beta/container/fleet/identity-service/enable b/gcloud/beta/container/fleet/identity-service/enable index cab5a3052..fe49a417d 100644 --- a/gcloud/beta/container/fleet/identity-service/enable +++ b/gcloud/beta/container/fleet/identity-service/enable @@ -3,7 +3,9 @@ NAME Service Feature SYNOPSIS - gcloud beta container fleet identity-service enable [GCLOUD_WIDE_FLAG ...] + gcloud beta container fleet identity-service enable + [--fleet-default-member-config=FLEET_DEFAULT_MEMBER_CONFIG] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) This command enables the Identity Service Feature in a fleet. @@ -13,6 +15,20 @@ EXAMPLES $ gcloud beta container fleet identity-service enable +FLAGS + --fleet-default-member-config=FLEET_DEFAULT_MEMBER_CONFIG + The path to an identity-service.yaml identity configuration file. If + specified, this configuration would be the default Identity Service + configuration for all memberships in your fleet. It could be overridden + with a membership-specific configuration by using the the Apply command + with the --config argument. + + To enable the Identity Service Feature with a fleet-level default + membership configuration, run: + + $ gcloud beta container fleet identity-service enable \ + --fleet-default-member-config=/path/to/identity-service.yaml + 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/beta/container/hub/identity-service/delete b/gcloud/beta/container/hub/identity-service/delete index f23047d9d..15c47f689 100644 --- a/gcloud/beta/container/hub/identity-service/delete +++ b/gcloud/beta/container/hub/identity-service/delete @@ -4,6 +4,7 @@ NAME SYNOPSIS gcloud beta container hub identity-service delete + [--fleet-default-member-config] [--membership=MEMBERSHIP : --location=LOCATION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -16,6 +17,16 @@ EXAMPLES --membership=MEMBERSHIP_NAME FLAGS + --fleet-default-member-config + If specified, deletes the default membership configuration present in + your fleet. + + To delete the default membership configuration present in your + fleet, run: + + $ gcloud beta container hub identity-service delete \ + --fleet-default-member-config + Membership resource - The group of arguments defining a membership. 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 diff --git a/gcloud/beta/container/hub/identity-service/enable b/gcloud/beta/container/hub/identity-service/enable index b15d52ade..e8001e8f9 100644 --- a/gcloud/beta/container/hub/identity-service/enable +++ b/gcloud/beta/container/hub/identity-service/enable @@ -3,7 +3,9 @@ NAME Feature SYNOPSIS - gcloud beta container hub identity-service enable [GCLOUD_WIDE_FLAG ...] + gcloud beta container hub identity-service enable + [--fleet-default-member-config=FLEET_DEFAULT_MEMBER_CONFIG] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) This command enables the Identity Service Feature in a fleet. @@ -13,6 +15,20 @@ EXAMPLES $ gcloud beta container hub identity-service enable +FLAGS + --fleet-default-member-config=FLEET_DEFAULT_MEMBER_CONFIG + The path to an identity-service.yaml identity configuration file. If + specified, this configuration would be the default Identity Service + configuration for all memberships in your fleet. It could be overridden + with a membership-specific configuration by using the the Apply command + with the --config argument. + + To enable the Identity Service Feature with a fleet-level default + membership configuration, run: + + $ gcloud beta container hub identity-service enable \ + --fleet-default-member-config=/path/to/identity-service.yaml + 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/beta/filestore/instances/create b/gcloud/beta/filestore/instances/create index c50c7bb2f..b2c0d24d8 100644 --- a/gcloud/beta/filestore/instances/create +++ b/gcloud/beta/filestore/instances/create @@ -9,8 +9,8 @@ SYNOPSIS --network=[connect-mode=CONNECT-MODE], [name=NAME],[reserved-ip-range=RESERVED-IP-RANGE] [--async] [--description=DESCRIPTION] [--labels=[KEY=VALUE,...]] - [--location=LOCATION] [--region=REGION] - [--tier=TIER; default="BASIC_HDD"] + [--location=LOCATION] [--protocol=PROTOCOL; default="NFS_V3"] + [--region=REGION] [--tier=TIER; default="BASIC_HDD"] [--kms-key=KMS_KEY : --kms-keyring=KMS_KEYRING --kms-location=KMS_LOCATION --kms-project=KMS_PROJECT] [GCLOUD_WIDE_FLAG ...] @@ -23,7 +23,7 @@ EXAMPLES volume. $ gcloud beta filestore instances create NAME \ - --description=DESCRIPTION --tier=TIER \ + --description=DESCRIPTION --tier=TIER --protocol=PROTOCOL \ --file-share=name=VOLUME_NAME,capacity=CAPACITY \ --network=name=NETWORK_NAME,\ reserved-ip-range=RESERVED_IP_RANGE,connect-mode=CONNECT_MODE \ @@ -195,6 +195,15 @@ OPTIONAL FLAGS --location=LOCATION Location of the Cloud Filestore instance/operation. + --protocol=PROTOCOL; default="NFS_V3" + The service protocol for the Cloud Filestore instance. PROTOCOL must be + one of: + + nfs-v3 + NFSv3 protocol. + nfs-v4-1 + NFSv4.1 protocol. + --region=REGION Region of the Cloud Filestore instance. diff --git a/gcloud/beta/run/jobs/help b/gcloud/beta/run/jobs/help index 1e761049a..5f838259a 100644 --- a/gcloud/beta/run/jobs/help +++ b/gcloud/beta/run/jobs/help @@ -30,6 +30,9 @@ GROUPS executions (BETA) View and manage your Cloud Run jobs executions. + logs + (BETA) Read logs for Cloud Run jobs. + COMMANDS COMMAND is one of the following: diff --git a/gcloud/beta/run/jobs/logs/help b/gcloud/beta/run/jobs/logs/help new file mode 100644 index 000000000..ee640a2ad --- /dev/null +++ b/gcloud/beta/run/jobs/logs/help @@ -0,0 +1,43 @@ +NAME + gcloud beta run jobs logs - read logs for Cloud Run jobs + +SYNOPSIS + gcloud beta run jobs logs COMMAND [--region=REGION] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Read logs for Cloud Run jobs. + +EXAMPLES + To tail logs executions for a job, run: + + $ gcloud beta run jobs logs tail my-job + + To read logs executions for a job, run: + + $ gcloud beta run jobs logs read my-job + +FLAGS + --region=REGION + Region in which the resource can be found. Alternatively, set the + property [run/region]. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + read + (BETA) Read logs for Cloud Run jobs. + + tail + (BETA) Tail logs for Cloud Run jobs. + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha run jobs logs + diff --git a/gcloud/beta/run/jobs/logs/read b/gcloud/beta/run/jobs/logs/read new file mode 100644 index 000000000..0df568801 --- /dev/null +++ b/gcloud/beta/run/jobs/logs/read @@ -0,0 +1,82 @@ +NAME + gcloud beta run jobs logs read - read logs for Cloud Run jobs + +SYNOPSIS + gcloud beta run jobs logs read JOB [--freshness=FRESHNESS; default="1d"] + [--log-filter=LOG_FILTER] [--order=ORDER; default="desc"] + [--region=REGION] [--limit=LIMIT] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) gcloud beta run jobs logs read reads log entries. Log entries + matching --log-filter are returned according to the specified --order. If + the log entries come from multiple logs, then entries from different logs + might be intermingled in the results. + +EXAMPLES + To read log entries from for a Cloud Run job, run: + + $ gcloud beta run jobs logs read my-job + + To read log entries with severity ERROR or higher, run: + + $ gcloud beta run jobs logs read my-job \ + --log-filter="severity>=ERROR" + + To read log entries written in a specific time window, run: + + $ gcloud beta run jobs logs read my-job \ + --log-filter='timestamp<="2015-05-31T23:59:59Z" AND + timestamp>="2015-05-31T00:00:00Z"' + + To read up to 10 log entries in your job payloads that include the word + SearchText and format the output in JSON format, run: + + $ gcloud beta run jobs logs read my-job \ + --log-filter="textPayload:SearchText" --limit=10 --format=json + + Detailed information about filters can be found at: + https://cloud.google.com/logging/docs/view/advanced_filters + +POSITIONAL ARGUMENTS + JOB + Name for a Cloud Run job. + +FLAGS + --freshness=FRESHNESS; default="1d" + Return entries that are not older than this value. Works only with DESC + ordering and filters without a timestamp. See $ gcloud topic datetimes + for information on duration formats. + + --log-filter=LOG_FILTER + Filter expression that specifies the log entries to return. Detailed + information about filters can be found at: + https://cloud.google.com/logging/docs/view/logging-query-language + + --order=ORDER; default="desc" + Ordering of returned log entries based on timestamp field. ORDER must + be one of: desc, asc. + + --region=REGION + Region in which the resource can be found. Alternatively, set the + property [run/region]. + +LIST COMMAND FLAGS + --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. + +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 beta and might change without notice. This + variant is also available: + + $ gcloud alpha run jobs logs read + diff --git a/gcloud/beta/run/jobs/logs/tail b/gcloud/beta/run/jobs/logs/tail new file mode 100644 index 000000000..91c06c296 --- /dev/null +++ b/gcloud/beta/run/jobs/logs/tail @@ -0,0 +1,53 @@ +NAME + gcloud beta run jobs logs tail - tail logs for Cloud Run jobs + +SYNOPSIS + gcloud beta run jobs logs tail JOB [--log-filter=LOG_FILTER] + [--region=REGION] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) gcloud beta run jobs logs tail tails log-entries for a particular + Cloud Run job in real time. The log entries are formatted for consumption + in a terminal. + +EXAMPLES + To tail log entries for a Cloud Run job, run: + + $ gcloud beta run jobs logs tail my-job + + To tail log entries with severity ERROR or higher, run: + + $ gcloud beta run jobs logs tail my-job \ + --log-filter="severity>=ERROR" + + Detailed information about filters can be found at: + https://cloud.google.com/logging/docs/view/advanced_filters + +POSITIONAL ARGUMENTS + JOB + Name for a Cloud Run job. + +FLAGS + --log-filter=LOG_FILTER + Filter expression that specifies the log entries to return. Detailed + information about filters can be found at: + https://cloud.google.com/logging/docs/view/logging-query-language + + --region=REGION + Region in which the resource can be found. Alternatively, set the + property [run/region]. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha run jobs logs tail + diff --git a/gcloud/beta/run/revisions/help b/gcloud/beta/run/revisions/help index 4b4f4f485..a9856d0fc 100644 --- a/gcloud/beta/run/revisions/help +++ b/gcloud/beta/run/revisions/help @@ -102,7 +102,7 @@ GROUPS GROUP is one of the following: logs - (BETA) Read logs for Cloud Run (fully managed) revisions. + (BETA) Read logs for Cloud Run revisions. COMMANDS COMMAND is one of the following: diff --git a/gcloud/beta/run/revisions/logs/help b/gcloud/beta/run/revisions/logs/help index 3ac5a21af..0d199a3f8 100644 --- a/gcloud/beta/run/revisions/logs/help +++ b/gcloud/beta/run/revisions/logs/help @@ -1,6 +1,5 @@ NAME - gcloud beta run revisions logs - read logs for Cloud Run (fully managed) - revisions + gcloud beta run revisions logs - read logs for Cloud Run revisions SYNOPSIS gcloud beta run revisions logs COMMAND @@ -10,7 +9,7 @@ SYNOPSIS | --context=CONTEXT --kubeconfig=KUBECONFIG] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Read logs for Cloud Run (fully managed) revisions. + (BETA) Read logs for Cloud Run revisions. FLAGS --platform=PLATFORM; default="managed" @@ -97,10 +96,10 @@ COMMANDS COMMAND is one of the following: read - (BETA) Read logs for a revision. + (BETA) Read logs for a Cloud Run revision. tail - (BETA) Tail logs for a revision. + (BETA) Tail logs for a Cloud Run revision. NOTES This command is currently in beta and might change without notice. This diff --git a/gcloud/beta/run/revisions/logs/read b/gcloud/beta/run/revisions/logs/read index ac20bb492..b0dcdc6ae 100644 --- a/gcloud/beta/run/revisions/logs/read +++ b/gcloud/beta/run/revisions/logs/read @@ -1,5 +1,5 @@ NAME - gcloud beta run revisions logs read - read logs for a revision + gcloud beta run revisions logs read - read logs for a Cloud Run revision SYNOPSIS gcloud beta run revisions logs read REVISION diff --git a/gcloud/beta/run/revisions/logs/tail b/gcloud/beta/run/revisions/logs/tail index 67ca0f376..bdf54dd8e 100644 --- a/gcloud/beta/run/revisions/logs/tail +++ b/gcloud/beta/run/revisions/logs/tail @@ -1,5 +1,5 @@ NAME - gcloud beta run revisions logs tail - tail logs for a revision + gcloud beta run revisions logs tail - tail logs for a Cloud Run revision SYNOPSIS gcloud beta run revisions logs tail REVISION [--log-filter=LOG_FILTER] diff --git a/gcloud/beta/run/services/help b/gcloud/beta/run/services/help index d46a7b5cf..458e41f9d 100644 --- a/gcloud/beta/run/services/help +++ b/gcloud/beta/run/services/help @@ -104,7 +104,7 @@ GROUPS GROUP is one of the following: logs - (BETA) Read logs for Cloud Run (fully managed) services. + (BETA) Read logs for Cloud Run services. COMMANDS COMMAND is one of the following: diff --git a/gcloud/beta/run/services/logs/help b/gcloud/beta/run/services/logs/help index 3a44f9ef4..0cc2a3a87 100644 --- a/gcloud/beta/run/services/logs/help +++ b/gcloud/beta/run/services/logs/help @@ -1,6 +1,5 @@ NAME - gcloud beta run services logs - read logs for Cloud Run (fully managed) - services + gcloud beta run services logs - read logs for Cloud Run services SYNOPSIS gcloud beta run services logs COMMAND @@ -10,7 +9,7 @@ SYNOPSIS | --context=CONTEXT --kubeconfig=KUBECONFIG] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Read logs for Cloud Run (fully managed) services. + (BETA) Read logs for Cloud Run services. FLAGS --platform=PLATFORM; default="managed" @@ -97,10 +96,10 @@ COMMANDS COMMAND is one of the following: read - (BETA) Read logs for a service. + (BETA) Read logs for a Cloud Run service. tail - (BETA) Tail logs for a service. + (BETA) Tail logs for a Cloud Run service. NOTES This command is currently in beta and might change without notice. This diff --git a/gcloud/beta/run/services/logs/read b/gcloud/beta/run/services/logs/read index 56cf5f029..68201e4dd 100644 --- a/gcloud/beta/run/services/logs/read +++ b/gcloud/beta/run/services/logs/read @@ -1,5 +1,5 @@ NAME - gcloud beta run services logs read - read logs for a service + gcloud beta run services logs read - read logs for a Cloud Run service SYNOPSIS gcloud beta run services logs read SERVICE diff --git a/gcloud/beta/run/services/logs/tail b/gcloud/beta/run/services/logs/tail index 00b4f1c99..974fa0ffd 100644 --- a/gcloud/beta/run/services/logs/tail +++ b/gcloud/beta/run/services/logs/tail @@ -1,5 +1,5 @@ NAME - gcloud beta run services logs tail - tail logs for a service + gcloud beta run services logs tail - tail logs for a Cloud Run service SYNOPSIS gcloud beta run services logs tail SERVICE [--log-filter=LOG_FILTER] diff --git a/gcloud/beta/sql/users/describe b/gcloud/beta/sql/users/describe index 702d460c3..9ad0c79b7 100644 --- a/gcloud/beta/sql/users/describe +++ b/gcloud/beta/sql/users/describe @@ -43,8 +43,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud sql users describe $ gcloud alpha sql users describe diff --git a/gcloud/compute/instance-groups/managed/create b/gcloud/compute/instance-groups/managed/create index 106a9506b..cc16029c1 100644 --- a/gcloud/compute/instance-groups/managed/create +++ b/gcloud/compute/instance-groups/managed/create @@ -24,14 +24,16 @@ DESCRIPTION gcloud compute instance-groups managed create creates a Compute Engine managed instance group. - For example, running: +EXAMPLES + Running: $ gcloud compute instance-groups managed create \ - example-managed-instance-group --zone us-central1-a \ - --template example-instance-template --size 1 + example-managed-instance-group --zone=us-central1-a \ + --template=example-global-instance-template --size=1 will create one managed instance group called - 'example-managed-instance-group' in the us-central1-a zone. + 'example-managed-instance-group' in the us-central1-a zone with global + instance template resource: 'example-global-instance-template'. POSITIONAL ARGUMENTS NAME @@ -39,16 +41,16 @@ POSITIONAL ARGUMENTS REQUIRED FLAGS --size=SIZE - The initial number of instances you want in this group. + Initial number of instances you want in this group. --template=TEMPLATE Specifies the instance template to use when creating new instances. OPTIONAL FLAGS --base-instance-name=BASE_INSTANCE_NAME - The base name to use for the Compute Engine instances that will be - created with the managed instance group. If not provided base instance - name will be the prefix of instance group name. + Base name to use for the Compute Engine instances that will be created + with the managed instance group. If not provided base instance name + will be the prefix of instance group name. --description=DESCRIPTION An optional description for this group. diff --git a/gcloud/compute/instances/bulk/create b/gcloud/compute/instances/bulk/create index 8a8941ae9..92cd676bd 100644 --- a/gcloud/compute/instances/bulk/create +++ b/gcloud/compute/instances/bulk/create @@ -431,8 +431,8 @@ OPTIONAL FLAGS Policy for which zones to include or exclude during bulk instance creation within a region. Policy is defined as a list of key-value pairs, with the key being the zone name, and value being the applied - policy. Available policies are allow and deny. Default for zones left - unspecified is allow. + policy. Available policies are allow and deny. Default for zones if + left unspecified is allow. Example: diff --git a/gcloud/compute/resource-policies/create/snapshot-schedule b/gcloud/compute/resource-policies/create/snapshot-schedule index 3badddb24..78a50e248 100644 --- a/gcloud/compute/resource-policies/create/snapshot-schedule +++ b/gcloud/compute/resource-policies/create/snapshot-schedule @@ -37,17 +37,20 @@ REQUIRED FLAGS Exactly one of these must be specified: - From file: + Using a file: --weekly-schedule-from-file=WEEKLY_CYCLE_FROM_FILE - A JSON/YAML file which specifies a weekly schedule. It should be a - list of objects with the following fields: + A JSON/YAML file which specifies a weekly schedule. The file should + contain the following fields: day: Day of the week with the same choices as --weekly-schedule. startTime: Start time of the snapshot schedule with the same format as --start-time. - From flags: + For more information about using a file, see + https://cloud.google.com/compute/docs/disks/scheduled-snapshots#create_snapshot_schedule + + Using command flags: --start-time=START_TIME Start time for the disk snapshot schedule in UTC. For example, @@ -118,7 +121,7 @@ OPTIONAL FLAGS contain only hyphens (-), underscores (_), lowercase characters, and numbers. - These will be added to the disk snapshots on creation. + The label is added to each snapshot created by the schedule. --storage-location=LOCATION Google Cloud Storage location, either regional or multi-regional, diff --git a/gcloud/config/get b/gcloud/config/get index dcf656ff9..7b2eb1b45 100644 --- a/gcloud/config/get +++ b/gcloud/config/get @@ -648,6 +648,14 @@ AVAILABLE PROPERTIES SERVICE_ACCOUNT_2. SERVICE_ACCOUNT_1 is the impersonated service account and SERVICE_ACCOUNT_2 is the delegate. + service_account_disable_id_token_refresh + If True, disable ID token refresh for service account. + + service_account_use_self_signed_jwt + If True, use self signed jwt flow to get service account + credentials access token. This only applies to service account json + file and not to the legacy .p12 file. + token_host Overrides the token endpoint to provision access tokens. It can be used with Private Service Connect. diff --git a/gcloud/config/help b/gcloud/config/help index 54babb43e..d22aa5f29 100644 --- a/gcloud/config/help +++ b/gcloud/config/help @@ -680,6 +680,14 @@ AVAILABLE PROPERTIES SERVICE_ACCOUNT_2. SERVICE_ACCOUNT_1 is the impersonated service account and SERVICE_ACCOUNT_2 is the delegate. + service_account_disable_id_token_refresh + If True, disable ID token refresh for service account. + + service_account_use_self_signed_jwt + If True, use self signed jwt flow to get service account + credentials access token. This only applies to service account json + file and not to the legacy .p12 file. + token_host Overrides the token endpoint to provision access tokens. It can be used with Private Service Connect. diff --git a/gcloud/config/list b/gcloud/config/list index bf196b18b..bd62c98e4 100644 --- a/gcloud/config/list +++ b/gcloud/config/list @@ -692,6 +692,14 @@ AVAILABLE PROPERTIES SERVICE_ACCOUNT_2. SERVICE_ACCOUNT_1 is the impersonated service account and SERVICE_ACCOUNT_2 is the delegate. + service_account_disable_id_token_refresh + If True, disable ID token refresh for service account. + + service_account_use_self_signed_jwt + If True, use self signed jwt flow to get service account + credentials access token. This only applies to service account json + file and not to the legacy .p12 file. + token_host Overrides the token endpoint to provision access tokens. It can be used with Private Service Connect. diff --git a/gcloud/config/set b/gcloud/config/set index 48387217d..8672b2677 100644 --- a/gcloud/config/set +++ b/gcloud/config/set @@ -695,6 +695,14 @@ AVAILABLE PROPERTIES SERVICE_ACCOUNT_2. SERVICE_ACCOUNT_1 is the impersonated service account and SERVICE_ACCOUNT_2 is the delegate. + service_account_disable_id_token_refresh + If True, disable ID token refresh for service account. + + service_account_use_self_signed_jwt + If True, use self signed jwt flow to get service account + credentials access token. This only applies to service account json + file and not to the legacy .p12 file. + token_host Overrides the token endpoint to provision access tokens. It can be used with Private Service Connect. diff --git a/gcloud/config/unset b/gcloud/config/unset index 47c4aedbb..41d44ab10 100644 --- a/gcloud/config/unset +++ b/gcloud/config/unset @@ -656,6 +656,14 @@ AVAILABLE PROPERTIES SERVICE_ACCOUNT_2. SERVICE_ACCOUNT_1 is the impersonated service account and SERVICE_ACCOUNT_2 is the delegate. + service_account_disable_id_token_refresh + If True, disable ID token refresh for service account. + + service_account_use_self_signed_jwt + If True, use self signed jwt flow to get service account + credentials access token. This only applies to service account json + file and not to the legacy .p12 file. + token_host Overrides the token endpoint to provision access tokens. It can be used with Private Service Connect. diff --git a/gcloud/dataproc/clusters/create b/gcloud/dataproc/clusters/create index 0eb3a1df3..228107edc 100644 --- a/gcloud/dataproc/clusters/create +++ b/gcloud/dataproc/clusters/create @@ -60,7 +60,7 @@ SYNOPSIS --tags=TAG,[TAG,...] --network=NETWORK | --subnet=SUBNET --reservation=RESERVATION --reservation-affinity=RESERVATION_AFFINITY; default="any"] - [[--metric-sources=[METRIC_SOURCES,...] + [[--metric-sources=[METRIC_SOURCE,...] : --metric-overrides=[METRIC_SOURCE:INSTANCE:GROUP:METRIC,...] | --metric-overrides-file=METRIC_OVERRIDES_FILE]] [--single-node | --num-secondary-workers=NUM_SECONDARY_WORKERS @@ -771,21 +771,42 @@ FLAGS The type of reservation for the instance. RESERVATION_AFFINITY must be one of: any, none, specific. - --metric-sources=[METRIC_SOURCES,...] - Specifies a list of Metric Sources to collect custom metrics from the - cluster. METRIC_SOURCES must be one of: HDFS, HIVEMETASTORE, - HIVESERVER2, MONITORING_AGENT_DEFAULTS, SPARK, SPARK_HISTORY_SERVER, - YARN. + --metric-sources=[METRIC_SOURCE,...] + Specifies a list of cluster Metric Sources + (https://cloud.google.com/dataproc/docs/guides/monitoring#available_oss_metrics) + to collect custom metrics. METRIC_SOURCE must be one of: HDFS, + HIVEMETASTORE, HIVESERVER2, MONITORING_AGENT_DEFAULTS, SPARK, + SPARK_HISTORY_SERVER, YARN. At most one of these can be specified: --metric-overrides=[METRIC_SOURCE:INSTANCE:GROUP:METRIC,...] - List of Metrics that override the default metrics enabled for the - metric source + List of metrics that override the default metrics enabled for the + metric sources. Any of the available OSS metrics + (https://cloud.google.com/dataproc/docs/guides/monitoring#available_oss_metrics) + and all Spark metrics, can be listed for collection as a metric + override. Override metric values are case sensitive, and must be + provided, if appropriate, in CamelCase format, for example: + + sparkHistoryServer:JVM:Memory:NonHeapMemoryUsage.committed + hiveserver2:JVM:Memory:NonHeapMemoryUsage.used + + Only the specified overridden metrics will be collected from a given + metric source. For example, if one or more spark:executive metrics + are listed as metric overrides, other SPARK metrics will not be + collected. The collection of default OSS metrics from other metric + sources is unaffected. For example, if both SPARK and YARN metric + sources are enabled, and overrides are provided for Spark metrics + only, all default YARN metrics will be collected. + + The source of the specified metric override must be enabled. For + example, if one or more spark:driver metrics are provided as metric + overrides, the spark metric source must be enabled + (--metric-sources=spark). --metric-overrides-file=METRIC_OVERRIDES_FILE Path to a file containing list of Metrics that override the default - metrics enabled for the metric source. The path can be a Cloud + metrics enabled for the metric sources. The path can be a Cloud Storage URL (example: gs://path/to/file) or a local file system path. At most one of these can be specified: diff --git a/gcloud/dataproc/workflow-templates/set-managed-cluster b/gcloud/dataproc/workflow-templates/set-managed-cluster index 6b1a4d6f6..2deffd1c5 100644 --- a/gcloud/dataproc/workflow-templates/set-managed-cluster +++ b/gcloud/dataproc/workflow-templates/set-managed-cluster @@ -46,7 +46,7 @@ SYNOPSIS --tags=TAG,[TAG,...] --network=NETWORK | --subnet=SUBNET --reservation=RESERVATION --reservation-affinity=RESERVATION_AFFINITY; default="any"] - [[--metric-sources=[METRIC_SOURCES,...] + [[--metric-sources=[METRIC_SOURCE,...] : --metric-overrides=[METRIC_SOURCE:INSTANCE:GROUP:METRIC,...] | --metric-overrides-file=METRIC_OVERRIDES_FILE]] [--single-node | --num-secondary-workers=NUM_SECONDARY_WORKERS @@ -644,21 +644,42 @@ FLAGS The type of reservation for the instance. RESERVATION_AFFINITY must be one of: any, none, specific. - --metric-sources=[METRIC_SOURCES,...] - Specifies a list of Metric Sources to collect custom metrics from the - cluster. METRIC_SOURCES must be one of: HDFS, HIVEMETASTORE, - HIVESERVER2, MONITORING_AGENT_DEFAULTS, SPARK, SPARK_HISTORY_SERVER, - YARN. + --metric-sources=[METRIC_SOURCE,...] + Specifies a list of cluster Metric Sources + (https://cloud.google.com/dataproc/docs/guides/monitoring#available_oss_metrics) + to collect custom metrics. METRIC_SOURCE must be one of: HDFS, + HIVEMETASTORE, HIVESERVER2, MONITORING_AGENT_DEFAULTS, SPARK, + SPARK_HISTORY_SERVER, YARN. At most one of these can be specified: --metric-overrides=[METRIC_SOURCE:INSTANCE:GROUP:METRIC,...] - List of Metrics that override the default metrics enabled for the - metric source + List of metrics that override the default metrics enabled for the + metric sources. Any of the available OSS metrics + (https://cloud.google.com/dataproc/docs/guides/monitoring#available_oss_metrics) + and all Spark metrics, can be listed for collection as a metric + override. Override metric values are case sensitive, and must be + provided, if appropriate, in CamelCase format, for example: + + sparkHistoryServer:JVM:Memory:NonHeapMemoryUsage.committed + hiveserver2:JVM:Memory:NonHeapMemoryUsage.used + + Only the specified overridden metrics will be collected from a given + metric source. For example, if one or more spark:executive metrics + are listed as metric overrides, other SPARK metrics will not be + collected. The collection of default OSS metrics from other metric + sources is unaffected. For example, if both SPARK and YARN metric + sources are enabled, and overrides are provided for Spark metrics + only, all default YARN metrics will be collected. + + The source of the specified metric override must be enabled. For + example, if one or more spark:driver metrics are provided as metric + overrides, the spark metric source must be enabled + (--metric-sources=spark). --metric-overrides-file=METRIC_OVERRIDES_FILE Path to a file containing list of Metrics that override the default - metrics enabled for the metric source. The path can be a Cloud + metrics enabled for the metric sources. The path can be a Cloud Storage URL (example: gs://path/to/file) or a local file system path. At most one of these can be specified: diff --git a/gcloud/immersive-stream/help b/gcloud/immersive-stream/help new file mode 100644 index 000000000..e1ed87cb7 --- /dev/null +++ b/gcloud/immersive-stream/help @@ -0,0 +1,25 @@ +NAME + gcloud immersive-stream - manage Immersive Stream resources + +SYNOPSIS + gcloud immersive-stream GROUP [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage Immersive Stream resources. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + xr + Manage Immersive Stream resources. + +NOTES + This variant is also available: + + $ gcloud alpha immersive-stream + diff --git a/gcloud/immersive-stream/xr/contents/build b/gcloud/immersive-stream/xr/contents/build new file mode 100644 index 000000000..357e41d28 --- /dev/null +++ b/gcloud/immersive-stream/xr/contents/build @@ -0,0 +1,72 @@ +NAME + gcloud immersive-stream xr contents build - build an Immersive Stream for + XR content resource + +SYNOPSIS + gcloud immersive-stream xr contents build (CONTENT : --location=LOCATION) + --version=VERSION [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Build an Immersive Stream for XR content resource and tag it with a user + specified version tag. + +EXAMPLES + To build a content resource my-content tagged with version tag my-version, + run: + + $ gcloud immersive-stream xr contents build my-content \ + --version=my-version + +POSITIONAL ARGUMENTS + Content resource - Immersive Stream for XR content resource to be built. + 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 content on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + CONTENT + ID of the content or fully qualified identifier for the content. To + set the content attribute: + ▸ provide the argument content on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Global location name. To set the location attribute: + ▸ provide the argument content on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ global is the only supported location. + +REQUIRED FLAGS + --version=VERSION + User-specified version tag of content build. + +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 stream/v1 API. The full documentation for this API + can be found at: https://cloud.google.com + +NOTES + This variant is also available: + + $ gcloud alpha immersive-stream xr contents build + diff --git a/gcloud/immersive-stream/xr/contents/create b/gcloud/immersive-stream/xr/contents/create new file mode 100644 index 000000000..522eaa6aa --- /dev/null +++ b/gcloud/immersive-stream/xr/contents/create @@ -0,0 +1,72 @@ +NAME + gcloud immersive-stream xr contents create - create an Immersive Stream for + XR content resource + +SYNOPSIS + gcloud immersive-stream xr contents create (CONTENT : --location=LOCATION) + --bucket=BUCKET [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create an Immersive Stream for XR content resource. + +EXAMPLES + To create a content resource called my-content using Cloud Storage bucket + my-bucket, run: + + $ gcloud immersive-stream xr contents create my-content \ + --bucket=my-bucket + +POSITIONAL ARGUMENTS + Content resource - Immersive Stream for XR content resource to be created. + 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 content on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + CONTENT + ID of the content or fully qualified identifier for the content. To + set the content attribute: + ▸ provide the argument content on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Global location name. To set the location attribute: + ▸ provide the argument content on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ global is the only supported location. + +REQUIRED FLAGS + --bucket=BUCKET + The name of the Cloud Storage bucket in the consumer project that + stores the content source. + +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 stream/v1 API. The full documentation for this API + can be found at: https://cloud.google.com + +NOTES + This variant is also available: + + $ gcloud alpha immersive-stream xr contents create + diff --git a/gcloud/immersive-stream/xr/contents/delete b/gcloud/immersive-stream/xr/contents/delete new file mode 100644 index 000000000..c58aff910 --- /dev/null +++ b/gcloud/immersive-stream/xr/contents/delete @@ -0,0 +1,65 @@ +NAME + gcloud immersive-stream xr contents delete - delete an Immersive Stream for + XR content resource + +SYNOPSIS + gcloud immersive-stream xr contents delete (CONTENT : --location=LOCATION) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Delete an Immersive Stream for XR content resource. + +EXAMPLES + To delete a content called my-content, run: + + $ gcloud immersive-stream xr contents delete my-content + +POSITIONAL ARGUMENTS + Content resource - Immersive Stream for XR content resource 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 content on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + CONTENT + ID of the content or fully qualified identifier for the content. To + set the content attribute: + ▸ provide the argument content on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Global location name. To set the location attribute: + ▸ provide the argument content on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ global is the only supported location. + +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 stream/v1 API. The full documentation for this API + can be found at: https://cloud.google.com + +NOTES + This variant is also available: + + $ gcloud alpha immersive-stream xr contents delete + diff --git a/gcloud/immersive-stream/xr/contents/describe b/gcloud/immersive-stream/xr/contents/describe new file mode 100644 index 000000000..1cb8c15b1 --- /dev/null +++ b/gcloud/immersive-stream/xr/contents/describe @@ -0,0 +1,60 @@ +NAME + gcloud immersive-stream xr contents describe - describe a specific + Immersive Stream for XR content resource + +SYNOPSIS + gcloud immersive-stream xr contents describe + (CONTENT : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Describe a specific Immersive Stream for XR content resource. + +EXAMPLES + To describe the content, run: + + $ gcloud immersive-stream xr contents describe my-content + +POSITIONAL ARGUMENTS + Content resource - The name of the content resource you want to describe. + The arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. To set the project attribute: + ◆ provide the argument content on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + CONTENT + ID of the content or fully qualified identifier for the content. To + set the content attribute: + ▸ provide the argument content on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Global location name. To set the location attribute: + ▸ provide the argument content on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ global is the only supported 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. + +API REFERENCE + This command uses the stream/v1 API. The full documentation for this API + can be found at: https://cloud.google.com + +NOTES + This variant is also available: + + $ gcloud alpha immersive-stream xr contents describe + diff --git a/gcloud/immersive-stream/xr/contents/help b/gcloud/immersive-stream/xr/contents/help new file mode 100644 index 000000000..9d38e51fe --- /dev/null +++ b/gcloud/immersive-stream/xr/contents/help @@ -0,0 +1,41 @@ +NAME + gcloud immersive-stream xr contents - manage Immersive Stream for XR + contents + +SYNOPSIS + gcloud immersive-stream xr contents COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage Immersive Stream for XR contents. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + build + Build an Immersive Stream for XR content resource. + + create + Create an Immersive Stream for XR content resource. + + delete + Delete an Immersive Stream for XR content resource. + + describe + Describe a specific Immersive Stream for XR content resource. + + list + List Immersive Stream for XR content resources. + + update + Update an Immersive Stream for XR content resource. + +NOTES + This variant is also available: + + $ gcloud alpha immersive-stream xr contents + diff --git a/gcloud/immersive-stream/xr/contents/list b/gcloud/immersive-stream/xr/contents/list new file mode 100644 index 000000000..23c94787e --- /dev/null +++ b/gcloud/immersive-stream/xr/contents/list @@ -0,0 +1,83 @@ +NAME + gcloud immersive-stream xr contents list - list Immersive Stream for XR + content resources + +SYNOPSIS + gcloud immersive-stream xr contents list [--location=LOCATION] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List Immersive Stream for XR content resources. + +EXAMPLES + To list Immersive Stream for XR content resources, run: + + $ gcloud immersive-stream xr contents list + +FLAGS + Location resource - Location to list all Immersive Stream for XR content + resources, defaults to global. 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; + ◆ global is the only supported location with a fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + --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; + ▸ global is the only supported 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. + + --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 stream/v1 API. The full documentation for this API + can be found at: https://cloud.google.com + +NOTES + This variant is also available: + + $ gcloud alpha immersive-stream xr contents list + diff --git a/gcloud/immersive-stream/xr/contents/update b/gcloud/immersive-stream/xr/contents/update new file mode 100644 index 000000000..f6e2bfe4b --- /dev/null +++ b/gcloud/immersive-stream/xr/contents/update @@ -0,0 +1,72 @@ +NAME + gcloud immersive-stream xr contents update - update an Immersive Stream for + XR content resource + +SYNOPSIS + gcloud immersive-stream xr contents update (CONTENT : --location=LOCATION) + --bucket=BUCKET [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Update an Immersive Stream for XR content resource. + +EXAMPLES + To update the Cloud Storage bucket used by the content resource my-content, + to my-new-bucket run: + + $ gcloud immersive-stream xr contents update my-content \ + --bucket=my-new-bucket + +POSITIONAL ARGUMENTS + Content resource - Immersive Stream for XR content resource to be updated. + 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 content on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + CONTENT + ID of the content or fully qualified identifier for the content. To + set the content attribute: + ▸ provide the argument content on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Global location name. To set the location attribute: + ▸ provide the argument content on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ global is the only supported location. + +REQUIRED FLAGS + --bucket=BUCKET + The name of the Cloud Storage bucket in the consumer project that + stores the content source. + +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 stream/v1 API. The full documentation for this API + can be found at: https://cloud.google.com + +NOTES + This variant is also available: + + $ gcloud alpha immersive-stream xr contents update + diff --git a/gcloud/immersive-stream/xr/help b/gcloud/immersive-stream/xr/help new file mode 100644 index 000000000..952540dc8 --- /dev/null +++ b/gcloud/immersive-stream/xr/help @@ -0,0 +1,31 @@ +NAME + gcloud immersive-stream xr - manage Immersive Stream resources + +SYNOPSIS + gcloud immersive-stream xr GROUP [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage Immersive Stream resources. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + contents + Manage Immersive Stream for XR contents. + + instances + Manage Immersive Stream for XR instances. + + operations + Manage Immersive Stream for XR operations. + +NOTES + This variant is also available: + + $ gcloud alpha immersive-stream xr + diff --git a/gcloud/immersive-stream/xr/instances/create b/gcloud/immersive-stream/xr/instances/create new file mode 100644 index 000000000..337bb5265 --- /dev/null +++ b/gcloud/immersive-stream/xr/instances/create @@ -0,0 +1,102 @@ +NAME + gcloud immersive-stream xr instances create - create an Immersive Stream + for XR service instance + +SYNOPSIS + gcloud immersive-stream xr instances create INSTANCE + --add-region=[capacity=CAPACITY],[region=REGION] --version=VERSION + (--content=CONTENT : --location=LOCATION) [--async] + [--fallback-url=FALLBACK_URL] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create an Immersive Stream for XR service instance. + +EXAMPLES + To create a service instance called my-instance serving content my-content + with version my-version that has availablilty for 2 concurent sessions in + us-west1 region and 3 concurrent sessions in us-east4 region, run: + + $ gcloud immersive-stream xr instances create my-instance \ + --content=my-content --version=my-version \ + --add-region=region=us-west1,capacity=2 \ + --add-region=region=us-east4,capacity=3 + + Optionally, a fallback url may be specified. Users will be redirected to + this fallback url when the service instance is unable to provide the + streaming experience. To create a service instance called my-instance + serving content my-content with version my-version that has availablilty + for 2 concurent sessions in us-west1 and uses fallback url + https://www.google.com run: + + $ gcloud immersive-stream xr instances create my-instance \ + --content=my-content --version=my-version \ + --add-region=region=us-west1,capacity=2 \ + --fallback-url="https://www.google.com" + +POSITIONAL ARGUMENTS + INSTANCE + Name of the instance to be created + +REQUIRED FLAGS + --add-region=[capacity=CAPACITY],[region=REGION] + Flag used to specify region and capacity required for the service + instance's availability. + + 'region' is the region in which the instance is deployed. + + 'capacity' is the maxium number of concurrent streaming sessions that the instance can support in the given region. + + This is a repeatable flag. + + --version=VERSION + Build version tag of the content served by this instance + + Content resource - Immersive Stream for XR content resource served by the + instance. 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 --content 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. + + --content=CONTENT + ID of the content or fully qualified identifier for the content. To + set the name attribute: + ▸ provide the argument --content on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Google Cloud location for the content. To set the location attribute: + ▸ provide the argument --content on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ location is always global. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --fallback-url=FALLBACK_URL + Fallback url to redirect users to when this service instance is unable + to provide the streaming experience + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This variant is also available: + + $ gcloud alpha immersive-stream xr instances create + diff --git a/gcloud/immersive-stream/xr/instances/delete b/gcloud/immersive-stream/xr/instances/delete new file mode 100644 index 000000000..ab706f244 --- /dev/null +++ b/gcloud/immersive-stream/xr/instances/delete @@ -0,0 +1,65 @@ +NAME + gcloud immersive-stream xr instances delete - delete an Immersive Stream + for XR service instance + +SYNOPSIS + gcloud immersive-stream xr instances delete + (INSTANCE : --location=LOCATION) [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Delete an Immersive Stream for XR service instance. + +EXAMPLES + To delete a service instance called my-instance, run: + + $ gcloud immersive-stream xr instances delete my-instance + +POSITIONAL ARGUMENTS + Instance resource - Immersive Stream for XR service instance 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 instance on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + INSTANCE + ID of the instance or fully qualified identifier for the instance. To + set the instance attribute: + ▸ provide the argument instance on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Global location name. To set the location attribute: + ▸ provide the argument instance on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ global is the only supported location. + +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 stream/v1 API. The full documentation for this API + can be found at: https://cloud.google.com + +NOTES + This variant is also available: + + $ gcloud alpha immersive-stream xr instances delete + diff --git a/gcloud/immersive-stream/xr/instances/describe b/gcloud/immersive-stream/xr/instances/describe new file mode 100644 index 000000000..0825b6ded --- /dev/null +++ b/gcloud/immersive-stream/xr/instances/describe @@ -0,0 +1,60 @@ +NAME + gcloud immersive-stream xr instances describe - describe a specific + Immersive Stream for XR service instance + +SYNOPSIS + gcloud immersive-stream xr instances describe + (INSTANCE : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Describe a specific Immersive Stream for XR service instance. + +EXAMPLES + To describe the service instance, run: + + $ gcloud immersive-stream xr instances describe my-instance + +POSITIONAL ARGUMENTS + Instance resource - The name of the service instance you want to describe. + The arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. To set the project attribute: + ◆ provide the argument instance on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + INSTANCE + ID of the instance or fully qualified identifier for the instance. To + set the instance attribute: + ▸ provide the argument instance on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Global location name. To set the location attribute: + ▸ provide the argument instance on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ global is the only supported 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. + +API REFERENCE + This command uses the stream/v1 API. The full documentation for this API + can be found at: https://cloud.google.com + +NOTES + This variant is also available: + + $ gcloud alpha immersive-stream xr instances describe + diff --git a/gcloud/immersive-stream/xr/instances/help b/gcloud/immersive-stream/xr/instances/help new file mode 100644 index 000000000..4968c8566 --- /dev/null +++ b/gcloud/immersive-stream/xr/instances/help @@ -0,0 +1,38 @@ +NAME + gcloud immersive-stream xr instances - manage Immersive Stream for XR + instances + +SYNOPSIS + gcloud immersive-stream xr instances COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage Immersive Stream for XR instances. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + Create an Immersive Stream for XR service instance. + + delete + Delete an Immersive Stream for XR service instance. + + describe + Describe a specific Immersive Stream for XR service instance. + + list + List Immersive Stream for XR service instances. + + update + Update an Immersive Stream for XR service instance. + +NOTES + This variant is also available: + + $ gcloud alpha immersive-stream xr instances + diff --git a/gcloud/immersive-stream/xr/instances/list b/gcloud/immersive-stream/xr/instances/list new file mode 100644 index 000000000..0d74b385e --- /dev/null +++ b/gcloud/immersive-stream/xr/instances/list @@ -0,0 +1,83 @@ +NAME + gcloud immersive-stream xr instances list - list Immersive Stream for XR + service instances + +SYNOPSIS + gcloud immersive-stream xr instances list [--location=LOCATION] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List Immersive Stream for XR service instances. + +EXAMPLES + To list Immersive Stream for XR service instances, run: + + $ gcloud immersive-stream xr instances list + +FLAGS + Location resource - Location to list all Immersive Stream for XR service + instances, defaults to global. 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; + ◆ global is the only supported location with a fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + --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; + ▸ global is the only supported 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. + + --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 stream/v1 API. The full documentation for this API + can be found at: https://cloud.google.com + +NOTES + This variant is also available: + + $ gcloud alpha immersive-stream xr instances list + diff --git a/gcloud/immersive-stream/xr/instances/update b/gcloud/immersive-stream/xr/instances/update new file mode 100644 index 000000000..677ee3c5e --- /dev/null +++ b/gcloud/immersive-stream/xr/instances/update @@ -0,0 +1,133 @@ +NAME + gcloud immersive-stream xr instances update - update an Immersive Stream + for XR service instance + +SYNOPSIS + gcloud immersive-stream xr instances update + (INSTANCE : --location=LOCATION) + (--add-region=[capacity=CAPACITY],[region=REGION] + | --fallback-url=FALLBACK_URL | --remove-region=REMOVE_REGION + | --update-region=[capacity=CAPACITY],[region=REGION] + | --version=VERSION) [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Update an Immersive Stream for XR service instance. This command can be + used to update one of the following: + ▪ the capacity for an existing region of the service instance + ▪ the content build version served by the instance + ▪ the fallback url to redirect users to when the service instance is + unable to provide the streaming experience + + If updating the capacity, only one region may be updated for each command + execution, and the new capacity may not be 0 or exceed the quota limit. + +EXAMPLES + To update the service instance my-instance to have capacity 2 for an + existing region us-west1, run: + + $ gcloud immersive-stream xr instances update my-instance \ + --update-region=region=us-west1,capacity=2 + + To update the service instance my-instance to have capacity 1 for a new + region us-east4, run: + + $ gcloud immersive-stream xr instances update my-instance \ + --add-region=region=us-east4,capacity=1 + + To update the service instance my-instance to remove the existing region + us-east4, run: + + $ gcloud immersive-stream xr instances update my-instance \ + --remove-region=us-east4 + + To update the service instance my-instance to serve content version + my-version, run: + + $ gcloud immersive-stream xr instances update my-instance \ + --version=my-version + + To update the service instance my-instance to use fallback url + https://www.google.com, run: + + $ gcloud immersive-stream xr instances update my-instance \ + --fallback-url="https://www.google.com" + +POSITIONAL ARGUMENTS + Instance resource - Immersive Stream for XR service instance 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 instance 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. + + INSTANCE + ID of the instance or fully qualified identifier for the instance. To + set the name attribute: + ▸ provide the argument instance 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 instance. To set the location + attribute: + ▸ provide the argument instance on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ location is always global. + +REQUIRED FLAGS + Update options + + Exactly one of these must be specified: + + --add-region=[capacity=CAPACITY],[region=REGION] + Flag used to specify region and capacity required for the service + instance's availability. + + 'region' is the region in which the instance is deployed. + + 'capacity' is the maxium number of concurrent streaming sessions that + the instance can support in the given region. + + --fallback-url=FALLBACK_URL + Fallback url to redirect users to when this service instance is + unable to provide the streaming experience + + --remove-region=REMOVE_REGION + Region to remove + + --update-region=[capacity=CAPACITY],[region=REGION] + Flag used to specify region and capacity required for the service + instance's availability. + + 'region' is the region in which the instance is deployed. + + 'capacity' is the maxium number of concurrent streaming sessions that + the instance can support in the given region. + + --version=VERSION + Build version tag of the content served by this instance + +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 variant is also available: + + $ gcloud alpha immersive-stream xr instances update + diff --git a/gcloud/immersive-stream/xr/operations/describe b/gcloud/immersive-stream/xr/operations/describe new file mode 100644 index 000000000..b0c3a796a --- /dev/null +++ b/gcloud/immersive-stream/xr/operations/describe @@ -0,0 +1,67 @@ +NAME + gcloud immersive-stream xr operations describe - get description of a + long-running Immersive Stream for XR operation + +SYNOPSIS + gcloud immersive-stream xr operations describe + (OPERATION : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Get information about a long-running Immersive Stream for XR operation. + +EXAMPLES + To get information about a long-running operation with name + projects/my-project/locations/global/operations/operation-123, run the + following command: + + $ gcloud immersive-stream xr operations describe \ + projects/my-project/locations/global/operations/operation-123 + + or simply run + + $ gcloud immersive-stream xr operations describe operation-123 + +POSITIONAL ARGUMENTS + Operation resource - The ID of the operation to describe. The arguments in + this group can be used to specify the attributes of this resource. (NOTE) + Some attributes are not given arguments in this group but can be set in + other ways. To set the project attribute: + ◆ provide the argument operation on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + OPERATION + ID of the operation or fully qualified identifier for the operation. + To set the operation attribute: + ▸ provide the argument operation on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Global location name. To set the location attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ global is the only supported 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. + +API REFERENCE + This command uses the stream/v1 API. The full documentation for this API + can be found at: https://cloud.google.com + +NOTES + This variant is also available: + + $ gcloud alpha immersive-stream xr operations describe + diff --git a/gcloud/immersive-stream/xr/operations/help b/gcloud/immersive-stream/xr/operations/help new file mode 100644 index 000000000..b592d4497 --- /dev/null +++ b/gcloud/immersive-stream/xr/operations/help @@ -0,0 +1,32 @@ +NAME + gcloud immersive-stream xr operations - manage Immersive Stream for XR + operations + +SYNOPSIS + gcloud immersive-stream xr operations COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage Immersive Stream for XR operations. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + describe + Get description of a long-running Immersive Stream for XR operation. + + list + List Immersive Stream for XR operations. + + wait + Poll long-running Immersive Stream for XR operation until it completes. + +NOTES + This variant is also available: + + $ gcloud alpha immersive-stream xr operations + diff --git a/gcloud/immersive-stream/xr/operations/list b/gcloud/immersive-stream/xr/operations/list new file mode 100644 index 000000000..4c9617524 --- /dev/null +++ b/gcloud/immersive-stream/xr/operations/list @@ -0,0 +1,83 @@ +NAME + gcloud immersive-stream xr operations list - list Immersive Stream for XR + operations + +SYNOPSIS + gcloud immersive-stream xr operations list [--location=LOCATION] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List Immersive Stream for XR operations. + +EXAMPLES + To list Immersive Stream for XR operations, run: + + $ gcloud immersive-stream xr operations list + +FLAGS + Location resource - Location to list all Immersive Stream for XR + operations, defaults to global. 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; + ◆ global is the only supported location with a fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + --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; + ▸ global is the only supported 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. + + --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 stream/v1 API. The full documentation for this API + can be found at: https://cloud.google.com + +NOTES + This variant is also available: + + $ gcloud alpha immersive-stream xr operations list + diff --git a/gcloud/immersive-stream/xr/operations/wait b/gcloud/immersive-stream/xr/operations/wait new file mode 100644 index 000000000..1eff7f81a --- /dev/null +++ b/gcloud/immersive-stream/xr/operations/wait @@ -0,0 +1,69 @@ +NAME + gcloud immersive-stream xr operations wait - poll long-running Immersive + Stream for XR operation until it completes + +SYNOPSIS + gcloud immersive-stream xr operations wait + (OPERATION : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Poll a long-running Immersive Stream for XR operation until it completes. + When the operation is complete, this command will display the results of + the analysis. + +EXAMPLES + To poll a long-running Immersive Stream for XR operation named + projects/my-project/locations/global/operations/operation-123 until it + completes, run the following: + + $ gcloud immersive-stream xr operations wait \ + projects/my-project/locations/global/operations/operation-123 + + or simply run + + $ gcloud immersive-stream xr operations wait operation-123 + +POSITIONAL ARGUMENTS + Operation resource - The ID of the operation to poll until complete. 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 operation on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + OPERATION + ID of the operation or fully qualified identifier for the operation. + To set the operation attribute: + ▸ provide the argument operation on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Global location name. To set the location attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ global is the only supported 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. + +API REFERENCE + This command uses the stream/v1 API. The full documentation for this API + can be found at: https://cloud.google.com + +NOTES + This variant is also available: + + $ gcloud alpha immersive-stream xr operations wait + diff --git a/gcloud/sql/users/describe b/gcloud/sql/users/describe new file mode 100644 index 000000000..8e092d5eb --- /dev/null +++ b/gcloud/sql/users/describe @@ -0,0 +1,50 @@ +NAME + gcloud sql users describe - retrieves information about a Cloud SQL user in + a given instance + +SYNOPSIS + gcloud sql users describe USERNAME --instance=INSTANCE, -i INSTANCE + [--host=HOST] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Retrieves information about a Cloud SQL user in a given instance. + +EXAMPLES + To fetch a user with name 'my-user' and optional host '%' in instance + 'my-instance', run: + + $ gcloud sql users describe my-user --host=% --instance=my-instance + +POSITIONAL ARGUMENTS + USERNAME + Cloud SQL username. + +REQUIRED FLAGS + --instance=INSTANCE, -i INSTANCE + Cloud SQL instance ID. + +OPTIONAL FLAGS + --host=HOST + Cloud SQL user's hostname expressed as a specific IP address or address + range. % denotes an unrestricted hostname. Applicable flag for MySQL + instances; ignored for all other engines. Note, if you connect to your + instance using IP addresses, you must add your client IP address as an + authorized address, even if your hostname is unrestricted. For more + information, see Configure IP + (https://cloud.google.com/sql/docs/mysql/configure-ip). + +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 sql users describe + + $ gcloud beta sql users describe + diff --git a/gcloud/sql/users/help b/gcloud/sql/users/help index 28d543824..c6c3adeb3 100644 --- a/gcloud/sql/users/help +++ b/gcloud/sql/users/help @@ -22,6 +22,9 @@ COMMANDS delete Deletes a Cloud SQL user in a given instance. + describe + Retrieves information about a Cloud SQL user in a given instance. + list Lists Cloud SQL users in a given instance.