diff --git a/gcloud/_version b/gcloud/_version index 46e8d8303..0235d9f89 100644 --- a/gcloud/_version +++ b/gcloud/_version @@ -1,8 +1,8 @@ -Google Cloud SDK 494.0.0 -alpha 2024.09.20 -beta 2024.09.20 +Google Cloud SDK 495.0.0 +alpha 2024.09.27 +beta 2024.09.27 bq 2.1.8 bundled-python3-unix 3.11.9 -core 2024.09.20 +core 2024.09.27 gcloud-crc32c 1.0.0 gsutil 5.30 diff --git a/gcloud/access-context-manager/cloud-bindings/create b/gcloud/access-context-manager/cloud-bindings/create index c04ead904..76267b483 100644 --- a/gcloud/access-context-manager/cloud-bindings/create +++ b/gcloud/access-context-manager/cloud-bindings/create @@ -4,8 +4,9 @@ NAME SYNOPSIS gcloud access-context-manager cloud-bindings create --group-key=GROUP_KEY - [--dry-run-level=[DRY_RUN_LEVEL,...]] [--level=[LEVEL,...]] - [--organization=ORGANIZATION] [GCLOUD_WIDE_FLAG ...] + [--binding-file=YAML_FILE] [--dry-run-level=[DRY_RUN_LEVEL,...]] + [--level=[LEVEL,...]] [--organization=ORGANIZATION] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION Create a new cloud access binding. The access level will be globally bound @@ -51,6 +52,14 @@ REQUIRED FLAGS binding. OPTIONAL FLAGS + --binding-file=YAML_FILE + Path to the file that contains a Google Cloud Platform user access + binding. + + This file contains a YAML-compliant object representing a + GcpUserAccessBinding (as described in the API reference) containing + ScopedAccessSettings only. No other binding fields are allowed. + --dry-run-level=[DRY_RUN_LEVEL,...] The dry run access level that binds to the given group. The dry run access level will be evaluated but won't be enforced. Denial on dry run diff --git a/gcloud/access-context-manager/cloud-bindings/update b/gcloud/access-context-manager/cloud-bindings/update index 7e7edefcb..11d8176a6 100644 --- a/gcloud/access-context-manager/cloud-bindings/update +++ b/gcloud/access-context-manager/cloud-bindings/update @@ -5,8 +5,8 @@ NAME SYNOPSIS gcloud access-context-manager cloud-bindings update (--binding=BINDING : --organization=ORGANIZATION) - [--dry-run-level=[DRY_RUN_LEVEL,...]] [--level=[LEVEL,...]] - [GCLOUD_WIDE_FLAG ...] + [--binding-file=YAML_FILE] [--dry-run-level=[DRY_RUN_LEVEL,...]] + [--level=[LEVEL,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION Update an existing cloud access binding. You can update the level, dry run @@ -57,6 +57,17 @@ REQUIRED FLAGS ▸ set the property access_context_manager/organization. OPTIONAL FLAGS + --binding-file=YAML_FILE + Path to the file that contains a Google Cloud Platform user access + binding. + + This file contains a YAML-compliant object representing a + GcpUserAccessBinding (as described in the API reference) containing + ScopedAccessSettings only. No other binding fields are allowed. + + The file content replaces the corresponding fields in the existing + binding. + --dry-run-level=[DRY_RUN_LEVEL,...] The dry run access level that replaces the existing dry run level for the given binding. The input must be the full identifier of an access diff --git a/gcloud/alloydb/clusters/create b/gcloud/alloydb/clusters/create index 36da73bd8..e5a356ea4 100644 --- a/gcloud/alloydb/clusters/create +++ b/gcloud/alloydb/clusters/create @@ -60,7 +60,7 @@ OPTIONAL FLAGS --database-version=DATABASE_VERSION Database version of the cluster. DATABASE_VERSION must be one of: - POSTGRES_14, POSTGRES_15. + POSTGRES_14, POSTGRES_15, POSTGRES_16. --enable-private-service-connect Enable Private Service Connect (PSC) connectivity for the cluster. diff --git a/gcloud/alpha/access-context-manager/cloud-bindings/create b/gcloud/alpha/access-context-manager/cloud-bindings/create index d04aa268e..0da374cd0 100644 --- a/gcloud/alpha/access-context-manager/cloud-bindings/create +++ b/gcloud/alpha/access-context-manager/cloud-bindings/create @@ -4,8 +4,9 @@ NAME SYNOPSIS gcloud alpha access-context-manager cloud-bindings create - [--dry-run-level=[DRY_RUN_LEVEL,...]] [--group-key=GROUP_KEY] - [--level=[LEVEL,...]] [--organization=ORGANIZATION] + [--binding-file=YAML_FILE] [--dry-run-level=[DRY_RUN_LEVEL,...]] + [--group-key=GROUP_KEY] [--level=[LEVEL,...]] + [--organization=ORGANIZATION] [--restricted-client-application-client-ids=[RESTRICTED_CLIENT_APPLICATION_CLIENT_IDS, ...]] [--restricted-client-application-names=[RESTRICTED_CLIENT_APPLICATION_NAMES, @@ -98,6 +99,14 @@ EXAMPLES --organization='1234567890' \ FLAGS + --binding-file=YAML_FILE + Path to the file that contains a Google Cloud Platform user access + binding. + + This file contains a YAML-compliant object representing a + GcpUserAccessBinding (as described in the API reference) containing + ScopedAccessSettings only. No other binding fields are allowed. + --dry-run-level=[DRY_RUN_LEVEL,...] The dry run access level that binds to the given group and restricted client applications. The dry run access level is evaluated but isn't diff --git a/gcloud/alpha/access-context-manager/cloud-bindings/update b/gcloud/alpha/access-context-manager/cloud-bindings/update index 1454d94ee..4d98a937b 100644 --- a/gcloud/alpha/access-context-manager/cloud-bindings/update +++ b/gcloud/alpha/access-context-manager/cloud-bindings/update @@ -5,7 +5,8 @@ NAME SYNOPSIS gcloud alpha access-context-manager cloud-bindings update (--binding=BINDING : --organization=ORGANIZATION) - [--dry-run-level=[DRY_RUN_LEVEL,...]] [--level=[LEVEL,...]] + [--binding-file=YAML_FILE] [--dry-run-level=[DRY_RUN_LEVEL,...]] + [--level=[LEVEL,...]] [--restricted-client-application-client-ids=[RESTRICTED_CLIENT_APPLICATION_CLIENT_IDS, ...]] [--restricted-client-application-names=[RESTRICTED_CLIENT_APPLICATION_NAMES, @@ -70,6 +71,17 @@ REQUIRED FLAGS ▸ set the property access_context_manager/organization. OPTIONAL FLAGS + --binding-file=YAML_FILE + Path to the file that contains a Google Cloud Platform user access + binding. + + This file contains a YAML-compliant object representing a + GcpUserAccessBinding (as described in the API reference) containing + ScopedAccessSettings only. No other binding fields are allowed. + + The file content replaces the corresponding fields in the existing + binding. + --dry-run-level=[DRY_RUN_LEVEL,...] The dry run access level that replaces the existing dry run level for the given binding. The input must be the full identifier of an access diff --git a/gcloud/alpha/compute/backend-buckets/create b/gcloud/alpha/compute/backend-buckets/create index b1c3185ee..5e1df654d 100644 --- a/gcloud/alpha/compute/backend-buckets/create +++ b/gcloud/alpha/compute/backend-buckets/create @@ -11,7 +11,8 @@ SYNOPSIS [--compression-mode=COMPRESSION_MODE] [--custom-response-header=CUSTOM_RESPONSE_HEADER] [--default-ttl=DEFAULT_TTL] [--description=DESCRIPTION] - [--[no-]enable-cdn] [--max-ttl=MAX_TTL] [--[no-]negative-caching] + [--[no-]enable-cdn] [--load-balancing-scheme=LOAD_BALANCING_SCHEME] + [--max-ttl=MAX_TTL] [--[no-]negative-caching] [--negative-caching-policy=[[CODE=TTL],...]] [--[no-]request-coalescing] [--serve-while-stale=SERVE_WHILE_STALE] [--signed-url-cache-max-age=SIGNED_URL_CACHE_MAX_AGE] @@ -158,6 +159,12 @@ OPTIONAL FLAGS responses from a backend bucket at the edge of the network, close to users. Use --enable-cdn to enable and --no-enable-cdn to disable. + --load-balancing-scheme=LOAD_BALANCING_SCHEME + The load balancing scheme of the backend bucket. If left blank, the + backend bucket will be compatible with Global External Application Load + Balancer or Classic Application Load Balancer. LOAD_BALANCING_SCHEME + must be (only one value is supported): INTERNAL_MANAGED. + --max-ttl=MAX_TTL Specifies the maximum allowed TTL for cached content served by this origin. diff --git a/gcloud/alpha/compute/commitments/create b/gcloud/alpha/compute/commitments/create index 62a385807..b57a2bf2d 100644 --- a/gcloud/alpha/compute/commitments/create +++ b/gcloud/alpha/compute/commitments/create @@ -112,7 +112,9 @@ OPTIONAL FLAGS general-purpose-c4, general-purpose-e2, general-purpose-n2, general-purpose-n2d, general-purpose-n4, general-purpose-t2d, graphics-optimized, memory-optimized, memory-optimized-m3, - memory-optimized-x4, storage-optimized-z3. + memory-optimized-x4, memory-optimized-x4-16tb, + memory-optimized-x4-24tb, memory-optimized-x4-32tb, + storage-optimized-z3. Manage the reservations to be created with the commitment. diff --git a/gcloud/alpha/compute/disk-settings/help b/gcloud/alpha/compute/disk-settings/help new file mode 100644 index 000000000..79e0164ac --- /dev/null +++ b/gcloud/alpha/compute/disk-settings/help @@ -0,0 +1,23 @@ +NAME + gcloud alpha compute disk-settings - read Compute Engine disk settings + +SYNOPSIS + gcloud alpha compute disk-settings COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Disks settings allows the configuration of various disk-related + behavior. + + At this time, only the access location is allowed to be configured. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + 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/compute/help b/gcloud/alpha/compute/help index 55d066202..395321fc3 100644 --- a/gcloud/alpha/compute/help +++ b/gcloud/alpha/compute/help @@ -42,6 +42,9 @@ GROUPS diagnose (ALPHA) Debugging tools for Compute Engine virtual machine instances. + disk-settings + (ALPHA) Read Compute Engine disk settings. + disk-types (ALPHA) Read Compute Engine virtual disk types. diff --git a/gcloud/alpha/compute/scp b/gcloud/alpha/compute/scp index e789f4899..e9e69cfbd 100644 --- a/gcloud/alpha/compute/scp +++ b/gcloud/alpha/compute/scp @@ -31,6 +31,8 @@ DESCRIPTION be from the same virtual machine. ▪ When the destination of your transfer is remote instead, all sources must be local. + ▪ When the destination is Windows Server, the source must be using a + similar SSH version. Under the covers, scp(1) is used to facilitate the transfer. diff --git a/gcloud/alpha/compute/snapshots/update b/gcloud/alpha/compute/snapshots/update index cba1808e1..3cbdc56fa 100644 --- a/gcloud/alpha/compute/snapshots/update +++ b/gcloud/alpha/compute/snapshots/update @@ -4,11 +4,11 @@ NAME SYNOPSIS gcloud alpha compute snapshots update SNAPSHOT_NAME [--update-labels=[KEY=VALUE,...]] - [--clear-labels | --remove-labels=[KEY,...]] [GCLOUD_WIDE_FLAG ...] + [--clear-labels | --remove-labels=[KEY,...]] + [--global | --region=REGION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) gcloud alpha compute snapshots update updates labels for a Compute - Engine snapshot. + (ALPHA) Update a Compute Engine snapshot. EXAMPLES To update labels k0 and k1 and remove labels with key k3, run: @@ -61,6 +61,15 @@ FLAGS silently ignored. If --update-labels is also specified then --update-labels is applied first. + At most one of these can be specified: + + --global + If set, the snapshot is global. + + --region=REGION + Region of the snapshot to update. Overrides the default + compute/region property value for this command invocation. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/alpha/compute/tpus/queued-resources/create b/gcloud/alpha/compute/tpus/queued-resources/create index 701f3a4c6..22200880c 100644 --- a/gcloud/alpha/compute/tpus/queued-resources/create +++ b/gcloud/alpha/compute/tpus/queued-resources/create @@ -12,18 +12,19 @@ SYNOPSIS [--boot-disk=[KEY=VALUE,...]] [--data-disk=[mode=MODE],[source=SOURCE]] [--description=DESCRIPTION] [--guaranteed] [--labels=[KEY=VALUE,...]] [--metadata=[KEY=VALUE,...]] [--metadata-from-file=[KEY=VALUE,...]] - [--range=RANGE] [--reservation-host-folder=RESERVATION_HOST_FOLDER] - [--reservation-host-organization=RESERVATION_HOST_ORGANIZATION] - [--reservation-host-project=RESERVATION_HOST_PROJECT] [--reserved] - [--scopes=[SCOPES,...]] [--service-account=SERVICE_ACCOUNT] - [--shielded-secure-boot] [--spot] [--tags=[TAGS,...]] - [--valid-after-duration=VALID_AFTER_DURATION] + [--range=RANGE] [--reserved] [--scopes=[SCOPES,...]] + [--service-account=SERVICE_ACCOUNT] [--shielded-secure-boot] [--spot] + [--tags=[TAGS,...]] [--valid-after-duration=VALID_AFTER_DURATION] [--valid-after-time=VALID_AFTER_TIME] [--valid-until-duration=VALID_UNTIL_DURATION] [--valid-until-time=VALID_UNTIL_TIME] [--network-config=[external-ips=EXTERNAL-IPS], [network=NETWORK],[subnetwork=SUBNETWORK] | --internal-ips --network=NETWORK; default="default" --subnetwork=SUBNETWORK] + [--reservation=RESERVATION + | --reservation-host-folder=RESERVATION_HOST_FOLDER + --reservation-host-organization=RESERVATION_HOST_ORGANIZATION + --reservation-host-project=RESERVATION_HOST_PROJECT] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -220,18 +221,6 @@ OPTIONAL FLAGS network, or the provided network is peered with another network that is using that CIDR range. - --reservation-host-folder=RESERVATION_HOST_FOLDER - The folder hosting the reservation that the TPU should use. Only one - reservation host entity may be specified. - - --reservation-host-organization=RESERVATION_HOST_ORGANIZATION - The organization hosting the reservation that the TPU should use. Only - one reservation host entity may be specified. - - --reservation-host-project=RESERVATION_HOST_PROJECT - The project hosting the reservation that the TPU should use. Only one - reservation host entity may be specified. - --reserved Specifies the request should be scheduled on reserved capacity. @@ -313,6 +302,31 @@ OPTIONAL FLAGS --subnetwork=SUBNETWORK Subnetwork that this TPU will be a part of. + At most one of these can be specified: + + --reservation=RESERVATION + The name of the reservation. This can either be the full name or just + the name. + + However, a full name is required if the reservation is not in the + default project. + + Full reservation name format is: + + projects//reservations/. + + --reservation-host-folder=RESERVATION_HOST_FOLDER + The folder hosting the reservation that the TPU should use. Only one + reservation host entity may be specified. + + --reservation-host-organization=RESERVATION_HOST_ORGANIZATION + The organization hosting the reservation that the TPU should use. + Only one reservation host entity may be specified. + + --reservation-host-project=RESERVATION_HOST_PROJECT + The project hosting the reservation that the TPU should use. Only one + reservation host entity may be specified. + 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/fleet/config-management/status b/gcloud/alpha/container/fleet/config-management/status index da660eef5..1e6bd2d30 100644 --- a/gcloud/alpha/container/fleet/config-management/status +++ b/gcloud/alpha/container/fleet/config-management/status @@ -30,22 +30,25 @@ EXAMPLES View the status for the cluster named managed-cluster-a: $ gcloud alpha container fleet config-management status \ + --flatten=acm_status \ --filter="acm_status.name:managed-cluster-a" Use a regular expression to list status for multiple clusters: $ gcloud alpha container fleet config-management status \ + --flatten=acm_status \ --filter="acm_status.name ~ managed-cluster.*" List all clusters where current Config Sync Status is SYNCED: $ gcloud alpha container fleet config-management status \ - --filter="acm_status.config_sync:SYNCED" + --flatten=acm_status --filter="acm_status.config_sync:SYNCED" List all the clusters where sync_branch is v1 and current Config Sync Status is not SYNCED: $ gcloud alpha container fleet config-management status \ + --flatten=acm_status \ --filter="acm_status.sync_branch:v1 AND \ -acm_status.config_sync:SYNCED" diff --git a/gcloud/alpha/container/fleet/mesh/update b/gcloud/alpha/container/fleet/mesh/update index b340c077c..e1bfb7fa4 100644 --- a/gcloud/alpha/container/fleet/mesh/update +++ b/gcloud/alpha/container/fleet/mesh/update @@ -54,7 +54,7 @@ REQUIRED FLAGS The --control-plane flag is now deprecated. Please use --management instead. See https://cloud.google.com/service-mesh/docs/managed/provision-managed-anthos-service-mesh. - CONTROL_PLANE must be one of: automatic, manual. + CONTROL_PLANE must be one of: automatic, manual, unspecified. --management=MANAGEMENT The management mode to update to. MANAGEMENT must be one of: diff --git a/gcloud/alpha/container/hub/config-management/status b/gcloud/alpha/container/hub/config-management/status index 6ecb6d5f2..ef317c2ee 100644 --- a/gcloud/alpha/container/hub/config-management/status +++ b/gcloud/alpha/container/hub/config-management/status @@ -30,22 +30,25 @@ EXAMPLES View the status for the cluster named managed-cluster-a: $ gcloud alpha container hub config-management status \ + --flatten=acm_status \ --filter="acm_status.name:managed-cluster-a" Use a regular expression to list status for multiple clusters: $ gcloud alpha container hub config-management status \ + --flatten=acm_status \ --filter="acm_status.name ~ managed-cluster.*" List all clusters where current Config Sync Status is SYNCED: $ gcloud alpha container hub config-management status \ - --filter="acm_status.config_sync:SYNCED" + --flatten=acm_status --filter="acm_status.config_sync:SYNCED" List all the clusters where sync_branch is v1 and current Config Sync Status is not SYNCED: $ gcloud alpha container hub config-management status \ + --flatten=acm_status \ --filter="acm_status.sync_branch:v1 AND \ -acm_status.config_sync:SYNCED" diff --git a/gcloud/alpha/container/hub/mesh/update b/gcloud/alpha/container/hub/mesh/update index f292cf7cd..0f1154688 100644 --- a/gcloud/alpha/container/hub/mesh/update +++ b/gcloud/alpha/container/hub/mesh/update @@ -54,7 +54,7 @@ REQUIRED FLAGS The --control-plane flag is now deprecated. Please use --management instead. See https://cloud.google.com/service-mesh/docs/managed/provision-managed-anthos-service-mesh. - CONTROL_PLANE must be one of: automatic, manual. + CONTROL_PLANE must be one of: automatic, manual, unspecified. --management=MANAGEMENT The management mode to update to. MANAGEMENT must be one of: diff --git a/gcloud/alpha/deploy/deploy-policies/describe b/gcloud/alpha/deploy/deploy-policies/describe index 19cee2f70..191ce4c4e 100644 --- a/gcloud/alpha/deploy/deploy-policies/describe +++ b/gcloud/alpha/deploy/deploy-policies/describe @@ -1,5 +1,5 @@ NAME - gcloud alpha deploy deploy-policies describe - show details for a deploy + gcloud alpha deploy deploy-policies describe - show details about a deploy policy SYNOPSIS @@ -7,18 +7,20 @@ SYNOPSIS (DEPLOY_POLICY : --region=REGION) [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Show details for a specified deploy policy. + (ALPHA) Show details about a deploy policy. EXAMPLES - To show details about a deploy policy test-policy in region us-central, - run: $ gcloud alpha deploy deploy-policies describe test-policy \ + To describe a deploy policy called 'test-policy' in region 'us-central1', + run: + + $ gcloud alpha deploy deploy-policies describe test-policy \ --region=us-central1 POSITIONAL ARGUMENTS - Deploy policy resource - The name of the deploy policy 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. + Deploy policy resource - The name of the Deploy Policy. 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 deploy_policy on the command line with a fully @@ -39,7 +41,8 @@ POSITIONAL ARGUMENTS arguments in this group are specified. --region=REGION - Location of the deploy policy. + The Cloud region for the deploy policy. Alternatively, set the + property [deploy/region]. To set the region attribute: ▸ provide the argument deploy_policy on the command line with a @@ -55,10 +58,6 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. -API REFERENCE - This command uses the clouddeploy/v1 API. The full documentation for this - API can be found at: https://cloud.google.com/deploy/ - NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct diff --git a/gcloud/alpha/deploy/deploy-policies/export b/gcloud/alpha/deploy/deploy-policies/export index ad5b12917..6d716fec4 100644 --- a/gcloud/alpha/deploy/deploy-policies/export +++ b/gcloud/alpha/deploy/deploy-policies/export @@ -33,8 +33,8 @@ POSITIONAL ARGUMENTS This must be specified. DEPLOY_POLICY - ID of the deploy_policy or fully qualified identifier for the - deploy_policy. + ID of the deploy policy or fully qualified identifier for the deploy + policy. To set the deploy_policy attribute: ▸ provide the argument deploy_policy on the command line. @@ -43,7 +43,7 @@ POSITIONAL ARGUMENTS arguments in this group are specified. --region=REGION - The Cloud region for the deploy_policy. Alternatively, set the + The Cloud region for the deploy policy. Alternatively, set the property [deploy/region]. To set the region attribute: diff --git a/gcloud/alpha/deploy/deploy-policies/help b/gcloud/alpha/deploy/deploy-policies/help index 6b37048f1..99cabbcef 100644 --- a/gcloud/alpha/deploy/deploy-policies/help +++ b/gcloud/alpha/deploy/deploy-policies/help @@ -20,7 +20,7 @@ COMMANDS (ALPHA) Delete a deploy policy. describe - (ALPHA) Show details for a deploy policy. + (ALPHA) Show details about a deploy policy. export (ALPHA) Returns the .yaml definition of the specified deploy policy. diff --git a/gcloud/alpha/iap/settings/get b/gcloud/alpha/iap/settings/get index 444d838a1..96ff11449 100644 --- a/gcloud/alpha/iap/settings/get +++ b/gcloud/alpha/iap/settings/get @@ -73,20 +73,22 @@ FLAGS Project ID. --region=REGION - Region name. Not applicable for app-engine. Required when resource-type - is compute and regional scoped. Not applicable for compute when global - scoped. + Region name. Not applicable for app-engine. Required when + resource-type=compute and regional scoped. Not applicable for global + scoped compute. Required when resource-type=cloud-run. --resource-type=RESOURCE_TYPE - Resource type of the IAP resource. RESOURCE_TYPE must be one of: - app-engine, iap_web, compute, organization, folder, forwarding-rule. + Resource type of the IAP resource. --resource-type=cloud-run is private + priview feature and reach out to cloud-run team if you want to test it. + RESOURCE_TYPE must be one of: app-engine, iap_web, compute, + organization, folder, forwarding-rule, cloud-run. --service=SERVICE Service name. Optional when resource-type is compute or app-engine. --version=VERSION - Version name. Not applicable for compute. Optional when resource-type - is app-engine. + Version name. Not applicable for compute. Optional when + resource-type=app-engine. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/alpha/iap/settings/set b/gcloud/alpha/iap/settings/set index 08b9b6787..d37e3f543 100644 --- a/gcloud/alpha/iap/settings/set +++ b/gcloud/alpha/iap/settings/set @@ -125,20 +125,22 @@ FLAGS Project ID. --region=REGION - Region name. Not applicable for app-engine. Required when resource-type - is compute and regional scoped. Not applicable for compute when global - scoped. + Region name. Not applicable for app-engine. Required when + resource-type=compute and regional scoped. Not applicable for global + scoped compute. Required when resource-type=cloud-run. --resource-type=RESOURCE_TYPE - Resource type of the IAP resource. RESOURCE_TYPE must be one of: - app-engine, iap_web, compute, organization, folder, forwarding-rule. + Resource type of the IAP resource. --resource-type=cloud-run is private + priview feature and reach out to cloud-run team if you want to test it. + RESOURCE_TYPE must be one of: app-engine, iap_web, compute, + organization, folder, forwarding-rule, cloud-run. --service=SERVICE Service name. Optional when resource-type is compute or app-engine. --version=VERSION - Version name. Not applicable for compute. Optional when resource-type - is app-engine. + Version name. Not applicable for compute. Optional when + resource-type=app-engine. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/alpha/iap/web/add-iam-policy-binding b/gcloud/alpha/iap/web/add-iam-policy-binding index b5f5dd0c0..556b402e0 100644 --- a/gcloud/alpha/iap/web/add-iam-policy-binding +++ b/gcloud/alpha/iap/web/add-iam-policy-binding @@ -116,13 +116,15 @@ OPTIONAL FLAGS relative path to a local file containing the value of condition. --region=REGION - Region name. Should only be specified with - --resource-type=backend-services if it is a regional scoped. Not - applicable for global scoped backend services. + Region name. Not applicable for resource-type=app-engine. Required when + resource-type=backend-services and regional scoped. Not applicable for + global backend-services. Required when resource-type=cloud-run. --resource-type=RESOURCE_TYPE - Resource type of the IAP resource. RESOURCE_TYPE must be one of: - app-engine, backend-services, forwarding-rule. + Resource type of the IAP resource. --resource-type=cloud-run is private + priview feature and reach out to cloud-run team if you want to test it. + RESOURCE_TYPE must be one of: app-engine, backend-services, + forwarding-rule, cloud-run. --service=SERVICE Service name. diff --git a/gcloud/alpha/iap/web/get-iam-policy b/gcloud/alpha/iap/web/get-iam-policy index 4a3d45061..dcd8547f6 100644 --- a/gcloud/alpha/iap/web/get-iam-policy +++ b/gcloud/alpha/iap/web/get-iam-policy @@ -66,13 +66,15 @@ EXAMPLES FLAGS --region=REGION - Region name. Should only be specified with - --resource-type=backend-services if it is a regional scoped. Not - applicable for global scoped backend services. + Region name. Not applicable for resource-type=app-engine. Required when + resource-type=backend-services and regional scoped. Not applicable for + global backend-services. Required when resource-type=cloud-run. --resource-type=RESOURCE_TYPE - Resource type of the IAP resource. RESOURCE_TYPE must be one of: - app-engine, backend-services, forwarding-rule. + Resource type of the IAP resource. --resource-type=cloud-run is private + priview feature and reach out to cloud-run team if you want to test it. + RESOURCE_TYPE must be one of: app-engine, backend-services, + forwarding-rule, cloud-run. --service=SERVICE Service name. diff --git a/gcloud/alpha/iap/web/remove-iam-policy-binding b/gcloud/alpha/iap/web/remove-iam-policy-binding index 826e521bd..d020b9fab 100644 --- a/gcloud/alpha/iap/web/remove-iam-policy-binding +++ b/gcloud/alpha/iap/web/remove-iam-policy-binding @@ -133,13 +133,15 @@ OPTIONAL FLAGS relative path to a local file containing the value of condition. --region=REGION - Region name. Should only be specified with - --resource-type=backend-services if it is a regional scoped. Not - applicable for global scoped backend services. + Region name. Not applicable for resource-type=app-engine. Required when + resource-type=backend-services and regional scoped. Not applicable for + global backend-services. Required when resource-type=cloud-run. --resource-type=RESOURCE_TYPE - Resource type of the IAP resource. RESOURCE_TYPE must be one of: - app-engine, backend-services, forwarding-rule. + Resource type of the IAP resource. --resource-type=cloud-run is private + priview feature and reach out to cloud-run team if you want to test it. + RESOURCE_TYPE must be one of: app-engine, backend-services, + forwarding-rule, cloud-run. --service=SERVICE Service name. diff --git a/gcloud/alpha/iap/web/set-iam-policy b/gcloud/alpha/iap/web/set-iam-policy index 59cde9f3b..09772f6f1 100644 --- a/gcloud/alpha/iap/web/set-iam-policy +++ b/gcloud/alpha/iap/web/set-iam-policy @@ -74,13 +74,15 @@ POSITIONAL ARGUMENTS FLAGS --region=REGION - Region name. Should only be specified with - --resource-type=backend-services if it is a regional scoped. Not - applicable for global scoped backend services. + Region name. Not applicable for resource-type=app-engine. Required when + resource-type=backend-services and regional scoped. Not applicable for + global backend-services. Required when resource-type=cloud-run. --resource-type=RESOURCE_TYPE - Resource type of the IAP resource. RESOURCE_TYPE must be one of: - app-engine, backend-services, forwarding-rule. + Resource type of the IAP resource. --resource-type=cloud-run is private + priview feature and reach out to cloud-run team if you want to test it. + RESOURCE_TYPE must be one of: app-engine, backend-services, + forwarding-rule, cloud-run. --service=SERVICE Service name. diff --git a/gcloud/alpha/logging/settings/update b/gcloud/alpha/logging/settings/update index 567ef0283..287229a48 100644 --- a/gcloud/alpha/logging/settings/update +++ b/gcloud/alpha/logging/settings/update @@ -63,7 +63,7 @@ EXAMPLES $ gcloud alpha logging settings update \ --organization=[ORGANIZATION_ID] --disable-default-sink=false \ - --analytics-mode=enabled + --analytics-mode=required REQUIRED FLAGS Exactly one of these must be specified: diff --git a/gcloud/alpha/pubsub/subscriptions/create b/gcloud/alpha/pubsub/subscriptions/create index 5da589d43..bf0ef3f4c 100644 --- a/gcloud/alpha/pubsub/subscriptions/create +++ b/gcloud/alpha/pubsub/subscriptions/create @@ -123,7 +123,7 @@ OPTIONAL FLAGS backlog, from the moment a message is published. If --retain-acked-messages is true, this also configures the retention of acknowledged messages. The default value is 7 days, the minimum is 10 - minutes, and the maximum is 7 days. Valid values are strings of the + minutes, and the maximum is 31 days. Valid values are strings of the form INTEGER[UNIT], where UNIT is one of "s", "m", "h", and "d" for seconds, minutes, hours, and days, respectively. If the unit is omitted, seconds is assumed. @@ -209,7 +209,7 @@ OPTIONAL FLAGS --cloud-storage-max-bytes=CLOUD_STORAGE_MAX_BYTES The maximum bytes that can be written to a Cloud Storage file - before a new file is created. The value must be between 1KB to + before a new file is created. The value must be between 1000B and 10GB. If the unit is omitted, KB is assumed. --cloud-storage-max-duration=CLOUD_STORAGE_MAX_DURATION diff --git a/gcloud/alpha/pubsub/subscriptions/update b/gcloud/alpha/pubsub/subscriptions/update index 90ca7a112..59ed1f2e7 100644 --- a/gcloud/alpha/pubsub/subscriptions/update +++ b/gcloud/alpha/pubsub/subscriptions/update @@ -77,7 +77,7 @@ FLAGS backlog, from the moment a message is published. If --retain-acked-messages is true, this also configures the retention of acknowledged messages. Specify "default" to use the default value of 7 - days. The minimum is 10 minutes, and the maximum is 7 days. Valid + days. The minimum is 10 minutes, and the maximum is 31 days. Valid values are strings of the form INTEGER[UNIT], where UNIT is one of "s", "m", "h", and "d" for seconds, minutes, hours, and days, respectively. If the unit is omitted, seconds is assumed. @@ -197,7 +197,7 @@ FLAGS --cloud-storage-max-bytes=CLOUD_STORAGE_MAX_BYTES The maximum bytes that can be written to a Cloud Storage file - before a new file is created. The value must be between 1KB to + before a new file is created. The value must be between 1000B and 10GB. If the unit is omitted, KB is assumed. --cloud-storage-max-duration=CLOUD_STORAGE_MAX_DURATION diff --git a/gcloud/alpha/spanner/backup-schedules/add-iam-policy-binding b/gcloud/alpha/spanner/backup-schedules/add-iam-policy-binding new file mode 100644 index 000000000..159dbae86 --- /dev/null +++ b/gcloud/alpha/spanner/backup-schedules/add-iam-policy-binding @@ -0,0 +1,161 @@ +NAME + gcloud alpha spanner backup-schedules add-iam-policy-binding - add IAM + policy binding to a Cloud Spanner backup schedule + +SYNOPSIS + gcloud alpha spanner backup-schedules add-iam-policy-binding + (BACKUP_SCHEDULE : --database=DATABASE --instance=INSTANCE) + --member=PRINCIPAL --role=ROLE + [--condition=[KEY=VALUE,...] | --condition-from-file=PATH_TO_FILE] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Add an IAM policy binding to a Cloud Spanner backup schedule. One + binding consists of a member, a role, and an optional condition. + +EXAMPLES + To add an IAM policy binding for the role of 'roles/editor' for the user + 'test-user@gmail.com', run: + + $ gcloud alpha spanner backup-schedules add-iam-policy-binding \ + backup-schedule-id --instance=instance-id \ + --database=database-id --member='user:test-user@gmail.com' \ + --role='roles/editor' + + To add an IAM policy binding which expires at the end of the year 2025 for + the role of 'roles/editor' and the user 'test-user@gmail.com', run: + + $ gcloud alpha spanner backup-schedules add-iam-policy-binding \ + backup-schedule-id --instance=instance-id \ + --database=database-id --member='user:test-user@gmail.com' \ + --role='roles/editor' \ + --condition='expression=request.time < + timestamp("2026-01-01T00:00:00Z"),title=expires_end_of_2025,descrip\ + tion=Expires at midnight on 2025-12-31' + + See https://cloud.google.com/iam/docs/managing-policies for details of + policy role and member types. + +POSITIONAL ARGUMENTS + BackupSchedule resource - The Cloud Spanner backup schedule to which to + add the IAM policy binding. 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 backup_schedule 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. + + BACKUP_SCHEDULE + ID of the backupSchedule or fully qualified identifier for the + backupSchedule. + + To set the backup_schedule attribute: + ▸ provide the argument backup_schedule on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --database=DATABASE + The name of the Cloud Spanner database. + + To set the database attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --database on the command line. + + --instance=INSTANCE + The name of the Cloud Spanner instance. + + To set the instance attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --instance on the command line; + ▸ set the property spanner/instance. + +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. + +OPTIONAL FLAGS + At most one of these can be specified: + + --condition=[KEY=VALUE,...] + A condition to include in the binding. When the condition is + explicitly specified as None (--condition=None), a binding without a + condition is added. When the condition is specified and is not None, + --role cannot be a basic role. Basic roles are roles/editor, + roles/owner, and roles/viewer. For more on conditions, refer to the + conditions overview guide: + https://cloud.google.com/iam/docs/conditions-overview + + When using the --condition flag, include the following key-value + pairs: + + expression + (Required) Condition expression that evaluates to True or False. + This uses a subset of Common Expression Language syntax. + + If the condition expression includes a comma, use a different + delimiter to separate the key-value pairs. Specify the delimiter + before listing the key-value pairs. For example, to specify a + colon (:) as the delimiter, do the following: + --condition=^:^title=TITLE:expression=EXPRESSION. For more + information, see + https://cloud.google.com/sdk/gcloud/reference/topic/escaping. + + title + (Required) A short string describing the purpose of the + expression. + + description + (Optional) Additional description for the expression. + + --condition-from-file=PATH_TO_FILE + Path to a local JSON or YAML file that defines the condition. To see + available fields, see the help for --condition. Use a full or + relative path to a local file containing the value of condition. + +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 spanner/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/spanner/ + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. These variants are also available: + + $ gcloud spanner backup-schedules add-iam-policy-binding + + $ gcloud beta spanner backup-schedules add-iam-policy-binding + diff --git a/gcloud/alpha/spanner/backup-schedules/create b/gcloud/alpha/spanner/backup-schedules/create new file mode 100644 index 000000000..752c77d35 --- /dev/null +++ b/gcloud/alpha/spanner/backup-schedules/create @@ -0,0 +1,168 @@ +NAME + gcloud alpha spanner backup-schedules create - create a Cloud Spanner + backup schedule + +SYNOPSIS + gcloud alpha spanner backup-schedules create + (BACKUP_SCHEDULE : --database=DATABASE --instance=INSTANCE) + --backup-type=[BACKUP_TYPE] --cron=CRON + --retention-duration=RETENTION_DURATION + [--encryption-type=ENCRYPTION_TYPE [--kms-key=KMS_KEY + : --kms-keyring=KMS_KEYRING + --kms-location=KMS_LOCATION --kms-project=KMS_PROJECT]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create a Cloud Spanner backup schedule. + +EXAMPLES + To create a Cloud Spanner backup schedule, run: + + $ gcloud alpha spanner backup-schedules create backup-schedule-id \ + --instance=instance-id --database=database-id \ + --cron="0 2 * * *" --retention-duration=2w \ + --backup-type=full-backup + +POSITIONAL ARGUMENTS + Backup schedule resource - The Cloud Spanner backup schedule 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 backup_schedule 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. + + BACKUP_SCHEDULE + ID of the backup-schedule or fully qualified identifier for the + backup-schedule. + + To set the backup-schedule attribute: + ▸ provide the argument backup_schedule on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --database=DATABASE + The Cloud Spanner database for the backup-schedule. + + To set the database attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --database on the command line. + + --instance=INSTANCE + The Cloud Spanner instance for the backup-schedule. + + To set the instance attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --instance on the command line; + ▸ set the property spanner/instance. + +REQUIRED FLAGS + --backup-type=[BACKUP_TYPE] + Type of backups created by this schedule. + + Supported backup types: + + full-backup A full backup stores the entire contents of the database at + a given version time. + + incremental-backup An incremental backup contains only the data that + has changed since a previous backup. + + BACKUP_TYPE must be one of: full-backup, incremental-backup. + + --cron=CRON + Textual representation of the crontab. User can customize the backup + frequency and the backup version time using the cron expression. The + version time must be in UTC timzeone. The backup will contain an + externally consistent copy of the database at the version time. Allowed + frequencies are 12 hour, 1 day, 1 week and 1 month. Examples of valid + cron specifications: * 0 2/12 * * * : every 12 hours at (2, 14) hours + past midnight in UTC. * 0 2,14 * * * : every 12 hours at (2,14) hours + past midnight in UTC. * 0 2 * * * : once a day at 2 past midnight in + UTC. * 0 2 * * 0 : once a week every Sunday at 2 past midnight in UTC. + * 0 2 8 * * : once a month on 8th day at 2 past midnight in UTC. + + --retention-duration=RETENTION_DURATION + The retention duration of a backup that must be at least 6 hours and at + most 366 days. The backup is eligible to be automatically deleted once + the retention period has elapsed. + +OPTIONAL FLAGS + --encryption-type=ENCRYPTION_TYPE + The encryption type of the backup. ENCRYPTION_TYPE must be one of: + + customer-managed-encryption + Use the provided Cloud KMS key for encryption. If this option is + selected, kms-key must be set. + google-default-encryption + Use Google default encryption. + use-database-encryption + Use the same encryption configuration as the database. + + KMS key name group + + At most one of these can be specified: + + Key resource - Cloud KMS key to be used to create the Cloud Spanner + backup. The arguments in this group can be used to specify the + attributes of this resource. + + --kms-key=KMS_KEY + ID of the key or fully qualified identifier for the key. + + To set the kms-key attribute: + ▫ provide the argument --kms-key on the command line. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --kms-keyring=KMS_KEYRING + KMS keyring id of the key. + + To set the kms-keyring attribute: + ▫ provide the argument --kms-key on the command line with a fully + specified name; + ▫ provide the argument --kms-keyring on the command line. + + --kms-location=KMS_LOCATION + Cloud location for the key. + + To set the kms-location attribute: + ▫ provide the argument --kms-key on the command line with a fully + specified name; + ▫ provide the argument --kms-location on the command line. + + --kms-project=KMS_PROJECT + Cloud project id for the key. + + To set the kms-project attribute: + ▫ provide the argument --kms-key on the command line with a fully + specified name; + ▫ provide the argument --kms-project on the command line. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. These variants are also available: + + $ gcloud spanner backup-schedules create + + $ gcloud beta spanner backup-schedules create + diff --git a/gcloud/alpha/spanner/backup-schedules/delete b/gcloud/alpha/spanner/backup-schedules/delete new file mode 100644 index 000000000..636090eeb --- /dev/null +++ b/gcloud/alpha/spanner/backup-schedules/delete @@ -0,0 +1,77 @@ +NAME + gcloud alpha spanner backup-schedules delete - delete a Cloud Spanner + backup schedule + +SYNOPSIS + gcloud alpha spanner backup-schedules delete + (BACKUP_SCHEDULE : --database=DATABASE --instance=INSTANCE) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Delete a Cloud Spanner backup schedule. + +EXAMPLES + To delete a Cloud Spanner backup schedule, run: + + $ gcloud alpha spanner backup-schedules delete backup-schedule-id \ + --instance=instance-id --database=database-id + +POSITIONAL ARGUMENTS + Backup schedule resource - The Cloud Spanner backup schedule 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 backup_schedule 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. + + BACKUP_SCHEDULE + ID of the backup-schedule or fully qualified identifier for the + backup-schedule. + + To set the backup-schedule attribute: + ▸ provide the argument backup_schedule on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --database=DATABASE + The Cloud Spanner database for the backup-schedule. + + To set the database attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --database on the command line. + + --instance=INSTANCE + The Cloud Spanner instance for the backup-schedule. + + To set the instance attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --instance on the command line; + ▸ set the property spanner/instance. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. These variants are also available: + + $ gcloud spanner backup-schedules delete + + $ gcloud beta spanner backup-schedules delete + diff --git a/gcloud/alpha/spanner/backup-schedules/describe b/gcloud/alpha/spanner/backup-schedules/describe new file mode 100644 index 000000000..b5f3f519a --- /dev/null +++ b/gcloud/alpha/spanner/backup-schedules/describe @@ -0,0 +1,77 @@ +NAME + gcloud alpha spanner backup-schedules describe - describe a Cloud Spanner + backup schedule + +SYNOPSIS + gcloud alpha spanner backup-schedules describe + (BACKUP_SCHEDULE : --database=DATABASE --instance=INSTANCE) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Describe a Cloud Spanner backup schedule. + +EXAMPLES + To describe a Cloud Spanner backup schedule, run: + + $ gcloud alpha spanner backup-schedules describe \ + backup-schedule-id --instance=instance-id --database=database-id + +POSITIONAL ARGUMENTS + Backup schedule resource - The Cloud Spanner backup schedule 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 backup_schedule 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. + + BACKUP_SCHEDULE + ID of the backup-schedule or fully qualified identifier for the + backup-schedule. + + To set the backup-schedule attribute: + ▸ provide the argument backup_schedule on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --database=DATABASE + The Cloud Spanner database for the backup-schedule. + + To set the database attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --database on the command line. + + --instance=INSTANCE + The Cloud Spanner instance for the backup-schedule. + + To set the instance attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --instance on the command line; + ▸ set the property spanner/instance. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. These variants are also available: + + $ gcloud spanner backup-schedules describe + + $ gcloud beta spanner backup-schedules describe + diff --git a/gcloud/alpha/spanner/backup-schedules/get-iam-policy b/gcloud/alpha/spanner/backup-schedules/get-iam-policy new file mode 100644 index 000000000..540838ca3 --- /dev/null +++ b/gcloud/alpha/spanner/backup-schedules/get-iam-policy @@ -0,0 +1,113 @@ +NAME + gcloud alpha spanner backup-schedules get-iam-policy - get the IAM policy + for a Cloud Spanner backup schedule + +SYNOPSIS + gcloud alpha spanner backup-schedules get-iam-policy + (BACKUP_SCHEDULE : --database=DATABASE --instance=INSTANCE) + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) gcloud alpha spanner backup-schedules get-iam-policy displays the + IAM policy associated with a Cloud Spanner backup schedule. 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; see $ {parent} + set-iam-policy for additional details. + +EXAMPLES + To print the IAM policy for a given Cloud Spanner backup schedule, run: + + $ gcloud alpha spanner backup-schedules get-iam-policy \ + backup-schedule-id --instance=instance-id --database=database-id + +POSITIONAL ARGUMENTS + BackupSchedule resource - The Cloud Spanner backup schedule for which to + display the IAM policy. 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 backup_schedule 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. + + BACKUP_SCHEDULE + ID of the backupSchedule or fully qualified identifier for the + backupSchedule. + + To set the backup_schedule attribute: + ▸ provide the argument backup_schedule on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --database=DATABASE + The name of the Cloud Spanner database. + + To set the database attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --database on the command line. + + --instance=INSTANCE + The name of the Cloud Spanner instance. + + To set the instance attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --instance on the command line; + ▸ set the property spanner/instance. + +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 spanner/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/spanner/ + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. These variants are also available: + + $ gcloud spanner backup-schedules get-iam-policy + + $ gcloud beta spanner backup-schedules get-iam-policy + diff --git a/gcloud/alpha/spanner/backup-schedules/help b/gcloud/alpha/spanner/backup-schedules/help new file mode 100644 index 000000000..82ba8614c --- /dev/null +++ b/gcloud/alpha/spanner/backup-schedules/help @@ -0,0 +1,55 @@ +NAME + gcloud alpha spanner backup-schedules - manage Cloud Spanner backup + schedules + +SYNOPSIS + gcloud alpha spanner backup-schedules COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Manage Cloud Spanner backup schedules. + +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 Cloud Spanner backup schedule. + + create + (ALPHA) Create a Cloud Spanner backup schedule. + + delete + (ALPHA) Delete a Cloud Spanner backup schedule. + + describe + (ALPHA) Describe a Cloud Spanner backup schedule. + + get-iam-policy + (ALPHA) Get the IAM policy for a Cloud Spanner backup schedule. + + list + (ALPHA) List Cloud Spanner backup schedules. + + remove-iam-policy-binding + (ALPHA) Remove IAM policy binding of a Cloud Spanner backup schedule. + + set-iam-policy + (ALPHA) Set the IAM policy for a Cloud Spanner backup schedule. + + update + (ALPHA) Update a Cloud Spanner backup schedule. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. These variants are also available: + + $ gcloud spanner backup-schedules + + $ gcloud beta spanner backup-schedules + diff --git a/gcloud/alpha/spanner/backup-schedules/list b/gcloud/alpha/spanner/backup-schedules/list new file mode 100644 index 000000000..87d07daef --- /dev/null +++ b/gcloud/alpha/spanner/backup-schedules/list @@ -0,0 +1,101 @@ +NAME + gcloud alpha spanner backup-schedules list - list Cloud Spanner backup + schedules + +SYNOPSIS + gcloud alpha spanner backup-schedules list + (--database=DATABASE : --instance=INSTANCE) [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List Cloud Spanner backup schedules. + +EXAMPLES + To list Cloud Spanner backup schedules, run: + + $ gcloud alpha spanner backup-schedules list \ + --instance=instance-id --database=database-id + +REQUIRED FLAGS + Database resource - The Cloud Spanner database in which to list schedules. + 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 --database 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. + + --database=DATABASE + ID of the database or fully qualified identifier for the database. + + To set the database attribute: + ▸ provide the argument --database on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --instance=INSTANCE + The Cloud Spanner instance for the database. + + To set the instance attribute: + ▸ provide the argument --database on the command line with a fully + specified name; + ▸ provide the argument --instance on the command line; + ▸ set the property spanner/instance. + +LIST COMMAND FLAGS + --filter=EXPRESSION + Apply a Boolean filter EXPRESSION to each resource item to be listed. + If the expression evaluates True, then that item is listed. For more + details and examples of filter expressions, run $ gcloud topic filters. + This flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --limit=LIMIT + Maximum number of resources to list. The default is unlimited. This + flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --page-size=PAGE_SIZE + Some services group resource list output into pages. This flag + specifies the maximum number of resources per page. The default is + determined by the service if it supports paging, otherwise it is + unlimited (no paging). Paging may be applied before or after --filter + and --limit depending on the service. + + --sort-by=[FIELD,...] + Comma-separated list of resource field key names to sort by. The + default order is ascending. Prefix a field with ``~'' for descending + order on that field. This flag interacts with other flags that are + applied in this order: --flatten, --sort-by, --filter, --limit. + + --uri + Print a list of resource URIs instead of the default output, and change + the command output to a list of URIs. If this flag is used with + --format, the formatting is applied on this URI list. To display URIs + alongside other keys instead, use the uri() transform. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. These variants are also available: + + $ gcloud spanner backup-schedules list + + $ gcloud beta spanner backup-schedules list + diff --git a/gcloud/alpha/spanner/backup-schedules/remove-iam-policy-binding b/gcloud/alpha/spanner/backup-schedules/remove-iam-policy-binding new file mode 100644 index 000000000..be712de43 --- /dev/null +++ b/gcloud/alpha/spanner/backup-schedules/remove-iam-policy-binding @@ -0,0 +1,166 @@ +NAME + gcloud alpha spanner backup-schedules remove-iam-policy-binding - remove + IAM policy binding of a Cloud Spanner backup schedule + +SYNOPSIS + gcloud alpha spanner backup-schedules remove-iam-policy-binding + (BACKUP_SCHEDULE : --database=DATABASE --instance=INSTANCE) + --member=PRINCIPAL --role=ROLE + [--all | --condition=[KEY=VALUE,...] + | --condition-from-file=PATH_TO_FILE] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Remove an IAM policy binding of a Cloud Spanner backup schedule. + One binding consists of a member, a role, and an optional condition. + +EXAMPLES + To remove an IAM policy binding for the role of 'roles/editor' for the user + 'test-user@gmail.com', run: + + $ gcloud alpha spanner backup-schedules remove-iam-policy-binding \ + backup-schedule-id --instance=instance-id \ + --database=database-id --member='user:test-user@gmail.com' \ + --role='roles/editor' + + To remove an IAM policy binding which expires at the end of the year 2025 + for the role of 'roles/editor' and the user 'test-user@gmail.com', run: + + $ gcloud alpha spanner backup-schedules remove-iam-policy-binding \ + backup-schedule-id --instance=instance-id \ + --database=database-id --member='user:test-user@gmail.com' \ + --role='roles/editor' \ + --condition='expression=request.time < + timestamp("2026-01-01T00:00:00Z"),title=expires_end_of_2025,descrip\ + tion=Expires at midnight on 2025-12-31' + + See https://cloud.google.com/iam/docs/managing-policies for details of + policy role and member types. + +POSITIONAL ARGUMENTS + BackupSchedule resource - The Cloud Spanner backup schedule to remove the + 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 backup_schedule 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. + + BACKUP_SCHEDULE + ID of the backupSchedule or fully qualified identifier for the + backupSchedule. + + To set the backup_schedule attribute: + ▸ provide the argument backup_schedule on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --database=DATABASE + The name of the Cloud Spanner database. + + To set the database attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --database on the command line. + + --instance=INSTANCE + The name of the Cloud Spanner instance. + + To set the instance attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --instance on the command line; + ▸ set the property spanner/instance. + +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. + +OPTIONAL FLAGS + At most one of these can be specified: + + --all + Remove all bindings with this role and principal, irrespective of any + conditions. + + --condition=[KEY=VALUE,...] + The condition of the binding that you want to remove. When the + condition is explicitly specified as None (--condition=None), a + binding without a condition is removed. Otherwise, only a binding + with a condition that exactly matches the specified condition + (including the optional description) is removed. For more on + conditions, refer to the conditions overview guide: + https://cloud.google.com/iam/docs/conditions-overview + + When using the --condition flag, include the following key-value + pairs: + + expression + (Required) Condition expression that evaluates to True or False. + This uses a subset of Common Expression Language syntax. + + If the condition expression includes a comma, use a different + delimiter to separate the key-value pairs. Specify the delimiter + before listing the key-value pairs. For example, to specify a + colon (:) as the delimiter, do the following: + --condition=^:^title=TITLE:expression=EXPRESSION. For more + information, see + https://cloud.google.com/sdk/gcloud/reference/topic/escaping. + + title + (Required) A short string describing the purpose of the + expression. + + description + (Optional) Additional description for the expression. + + --condition-from-file=PATH_TO_FILE + Path to a local JSON or YAML file that defines the condition. To see + available fields, see the help for --condition. Use a full or + relative path to a local file containing the value of condition. + +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 spanner/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/spanner/ + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. These variants are also available: + + $ gcloud spanner backup-schedules remove-iam-policy-binding + + $ gcloud beta spanner backup-schedules remove-iam-policy-binding + diff --git a/gcloud/alpha/spanner/backup-schedules/set-iam-policy b/gcloud/alpha/spanner/backup-schedules/set-iam-policy new file mode 100644 index 000000000..ce2c06584 --- /dev/null +++ b/gcloud/alpha/spanner/backup-schedules/set-iam-policy @@ -0,0 +1,95 @@ +NAME + gcloud alpha spanner backup-schedules set-iam-policy - set the IAM policy + for a Cloud Spanner backup schedule + +SYNOPSIS + gcloud alpha spanner backup-schedules set-iam-policy + (BACKUP_SCHEDULE : --database=DATABASE --instance=INSTANCE) POLICY_FILE + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Set the IAM policy for a Cloud Spanner backup schedule given a + backup schedule ID and a file encoded in JSON or YAML that contains the IAM + policy. + +EXAMPLES + The following command reads an IAM policy defined in a JSON file + policy.json and sets it for a Cloud Spanner backup schedule: + + $ gcloud alpha spanner backup-schedules set-iam-policy \ + backup-schedule-id --instance=instance-id \ + --database=database-id policy.json + + See https://cloud.google.com/iam/docs/managing-policies for details of the + policy file format and contents. + +POSITIONAL ARGUMENTS + BackupSchedule resource - The Cloud Spanner backup schedule to set the IAM + policy for. 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 backup_schedule 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. + + BACKUP_SCHEDULE + ID of the backupSchedule or fully qualified identifier for the + backupSchedule. + + To set the backup_schedule attribute: + ▸ provide the argument backup_schedule on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --database=DATABASE + The name of the Cloud Spanner database. + + To set the database attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --database on the command line. + + --instance=INSTANCE + The name of the Cloud Spanner instance. + + To set the instance attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --instance on the command line; + ▸ set the property spanner/instance. + + 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. + +API REFERENCE + This command uses the spanner/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/spanner/ + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. These variants are also available: + + $ gcloud spanner backup-schedules set-iam-policy + + $ gcloud beta spanner backup-schedules set-iam-policy + diff --git a/gcloud/alpha/spanner/backup-schedules/update b/gcloud/alpha/spanner/backup-schedules/update new file mode 100644 index 000000000..149ec1f63 --- /dev/null +++ b/gcloud/alpha/spanner/backup-schedules/update @@ -0,0 +1,156 @@ +NAME + gcloud alpha spanner backup-schedules update - update a Cloud Spanner + backup schedule + +SYNOPSIS + gcloud alpha spanner backup-schedules update + (BACKUP_SCHEDULE : --database=DATABASE --instance=INSTANCE) + (--cron=CRON --encryption-type=ENCRYPTION_TYPE + --retention-duration=RETENTION_DURATION [--kms-key=KMS_KEY + : --kms-keyring=KMS_KEYRING + --kms-location=KMS_LOCATION --kms-project=KMS_PROJECT]) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Update a Cloud Spanner backup schedule. + +EXAMPLES + To update a Cloud Spanner backup schedule, run: + + $ gcloud alpha spanner backup-schedules update backup-schedule-id \ + --instance=instance-id --database=database-id \ + --cron="0 2 * * *" --retention-duration=2w \ + --encryption-type=GOOGLE_DEFAULT_ENCRYPTION + +POSITIONAL ARGUMENTS + Backup schedule resource - The Cloud Spanner backup schedule 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 backup_schedule 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. + + BACKUP_SCHEDULE + ID of the backup-schedule or fully qualified identifier for the + backup-schedule. + + To set the backup-schedule attribute: + ▸ provide the argument backup_schedule on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --database=DATABASE + The Cloud Spanner database for the backup-schedule. + + To set the database attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --database on the command line. + + --instance=INSTANCE + The Cloud Spanner instance for the backup-schedule. + + To set the instance attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --instance on the command line; + ▸ set the property spanner/instance. + +REQUIRED FLAGS + At least one of these must be specified: + + --cron=CRON + Textual representation of the crontab. User can customize the backup + frequency and the backup version time using the cron expression. The + version time must be in UTC timzeone. The backup will contain an + externally consistent copy of the database at the version time. + Allowed frequencies are 12 hour, 1 day, 1 week and 1 month. Examples + of valid cron specifications: * 0 2/12 * * * : every 12 hours at (2, + 14) hours past midnight in UTC. * 0 2,14 * * * : every 12 hours at + (2,14) hours past midnight in UTC. * 0 2 * * * : once a day at 2 past + midnight in UTC. * 0 2 * * 0 : once a week every Sunday at 2 past + midnight in UTC. * 0 2 8 * * : once a month on 8th day at 2 past + midnight in UTC. + + --encryption-type=ENCRYPTION_TYPE + The encryption type of the backup. ENCRYPTION_TYPE must be one of: + + customer-managed-encryption + Use the provided Cloud KMS key for encryption. If this option is + selected, kms-key must be set. + google-default-encryption + Use Google default encryption. + use-database-encryption + Use the same encryption configuration as the database. + + --retention-duration=RETENTION_DURATION + The retention duration of a backup that must be at least 6 hours and + at most 366 days. The backup is eligible to be automatically deleted + once the retention period has elapsed. + + KMS key name group + + At most one of these can be specified: + + Key resource - Cloud KMS key to be used to create the Cloud Spanner + backup. The arguments in this group can be used to specify the + attributes of this resource. + + --kms-key=KMS_KEY + ID of the key or fully qualified identifier for the key. + + To set the kms-key attribute: + ◇ provide the argument --kms-key on the command line. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --kms-keyring=KMS_KEYRING + KMS keyring id of the key. + + To set the kms-keyring attribute: + ◇ provide the argument --kms-key on the command line with a + fully specified name; + ◇ provide the argument --kms-keyring on the command line. + + --kms-location=KMS_LOCATION + Cloud location for the key. + + To set the kms-location attribute: + ◇ provide the argument --kms-key on the command line with a + fully specified name; + ◇ provide the argument --kms-location on the command line. + + --kms-project=KMS_PROJECT + Cloud project id for the key. + + To set the kms-project attribute: + ◇ provide the argument --kms-key on the command line with a + fully specified name; + ◇ provide the argument --kms-project on the command line. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. These variants are also available: + + $ gcloud spanner backup-schedules update + + $ gcloud beta spanner backup-schedules update + diff --git a/gcloud/alpha/spanner/help b/gcloud/alpha/spanner/help index 8f1816336..50a7c8dee 100644 --- a/gcloud/alpha/spanner/help +++ b/gcloud/alpha/spanner/help @@ -15,6 +15,9 @@ GCLOUD WIDE FLAGS GROUPS GROUP is one of the following: + backup-schedules + (ALPHA) Manage Cloud Spanner backup schedules. + backups (ALPHA) Manage Cloud Spanner backups. diff --git a/gcloud/alpha/sql/instances/switchover b/gcloud/alpha/sql/instances/switchover index e1e49a260..c8d579eae 100644 --- a/gcloud/alpha/sql/instances/switchover +++ b/gcloud/alpha/sql/instances/switchover @@ -7,8 +7,7 @@ SYNOPSIS [--db-timeout=DB_TIMEOUT] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Switches over a Cloud SQL instance to one of its replicas. Only - supported on Cloud SQL for SQL Server and MySQL instances. + (ALPHA) Switches over a Cloud SQL instance to one of its replicas. EXAMPLES To switch over an instance to its replica called replica-instance: diff --git a/gcloud/alpha/sql/ssl/server-ca-certs/create b/gcloud/alpha/sql/ssl/server-ca-certs/create index 79749caa3..cb2fb275d 100644 --- a/gcloud/alpha/sql/ssl/server-ca-certs/create +++ b/gcloud/alpha/sql/ssl/server-ca-certs/create @@ -30,7 +30,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 ssl server-ca-certs create $ gcloud beta sql ssl server-ca-certs create diff --git a/gcloud/alpha/sql/ssl/server-ca-certs/help b/gcloud/alpha/sql/ssl/server-ca-certs/help index 88fe249a5..e42c78fe7 100644 --- a/gcloud/alpha/sql/ssl/server-ca-certs/help +++ b/gcloud/alpha/sql/ssl/server-ca-certs/help @@ -35,7 +35,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 ssl server-ca-certs $ gcloud beta sql ssl server-ca-certs diff --git a/gcloud/alpha/sql/ssl/server-ca-certs/list b/gcloud/alpha/sql/ssl/server-ca-certs/list index 652693744..336ecaaec 100644 --- a/gcloud/alpha/sql/ssl/server-ca-certs/list +++ b/gcloud/alpha/sql/ssl/server-ca-certs/list @@ -58,7 +58,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 ssl server-ca-certs list $ gcloud beta sql ssl server-ca-certs list diff --git a/gcloud/alpha/sql/ssl/server-ca-certs/rollback b/gcloud/alpha/sql/ssl/server-ca-certs/rollback index 7ec219a94..8fbf12aa8 100644 --- a/gcloud/alpha/sql/ssl/server-ca-certs/rollback +++ b/gcloud/alpha/sql/ssl/server-ca-certs/rollback @@ -30,7 +30,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 ssl server-ca-certs rollback $ gcloud beta sql ssl server-ca-certs rollback diff --git a/gcloud/alpha/sql/ssl/server-ca-certs/rotate b/gcloud/alpha/sql/ssl/server-ca-certs/rotate index 527731819..6651a5e9d 100644 --- a/gcloud/alpha/sql/ssl/server-ca-certs/rotate +++ b/gcloud/alpha/sql/ssl/server-ca-certs/rotate @@ -30,7 +30,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 ssl server-ca-certs rotate $ gcloud beta sql ssl server-ca-certs rotate diff --git a/gcloud/artifacts/attachments/create b/gcloud/artifacts/attachments/create new file mode 100644 index 000000000..0ad981929 --- /dev/null +++ b/gcloud/artifacts/attachments/create @@ -0,0 +1,85 @@ +NAME + gcloud artifacts attachments create - creates an Artifact registry + attachment in a repository + +SYNOPSIS + gcloud artifacts attachments create + (ATTACHMENT : --location=LOCATION --repository=REPOSITORY) + --attachment-type=ATTACHMENT_TYPE --files=[FILES,...] --target=TARGET + [--attachment-namespace=ATTACHMENT_NAMESPACE] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Creates an Artifact registry attachment in a repository. + +EXAMPLES + To create an attachment for target + projects/myproject/locations/us-central1/packages/mypackage/versions/sha256:123 + using a file located in /path/to/file/sbom.json: + + $ gcloud artifacts attachments create \ + --target=projects/myproject/locations/us-central1/packages/\ + mypackage/versions/sha256:123 --files=/path/to/file/sbom.json + +POSITIONAL ARGUMENTS + Attachment resource - The Artifact Registry attachment name. 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 attachment 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. + + ATTACHMENT + ID of the attachment or fully qualified identifier for the + attachment. + + To set the name attribute: + ▸ provide the argument attachment 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 attachment. + + To set the location attribute: + ▸ provide the argument attachment on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property artifacts/location. + + --repository=REPOSITORY + Repository of the attachment. + + To set the repository attribute: + ▸ provide the argument attachment on the command line with a fully + specified name; + ▸ provide the argument --repository on the command line; + ▸ set the property artifacts/repository. + +REQUIRED FLAGS + --attachment-type=ATTACHMENT_TYPE + Type of the attachment + + --files=[FILES,...] + Comma-seperated list of files that are part of this attachment + + --target=TARGET + Target of the attachment, should be fully qualified version name + +OPTIONAL FLAGS + --attachment-namespace=ATTACHMENT_NAMESPACE + Namespace of the attachment + +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. diff --git a/gcloud/artifacts/attachments/delete b/gcloud/artifacts/attachments/delete new file mode 100644 index 000000000..f2da9f765 --- /dev/null +++ b/gcloud/artifacts/attachments/delete @@ -0,0 +1,76 @@ +NAME + gcloud artifacts attachments delete - delete an Artifact Registry + attachment + +SYNOPSIS + gcloud artifacts attachments delete + (ATTACHMENT : --location=LOCATION --repository=REPOSITORY) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Delete an Artifact Registry attachment. + +EXAMPLES + To delete an attachment my-attachment under the current project, + repository, and location, run: + + $ gcloud artifacts attachments delete my-attachment + +POSITIONAL ARGUMENTS + Attachment resource - The Artifact Registry attachment 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 attachment 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. + + ATTACHMENT + ID of the attachment or fully qualified identifier for the + attachment. + + To set the attachment attribute: + ▸ provide the argument attachment 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 attachment. Overrides the default artifacts/location + property value for this command invocation. To configure the default + location, use the command: gcloud config set artifacts/location. + + To set the location attribute: + ▸ provide the argument attachment on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property artifacts/location. + + --repository=REPOSITORY + The repository associated with the attachment. Overrides the default + artifacts/repository property value for this command invocation. To + configure the default repository, use the command: gcloud config set + artifacts/repository. + + To set the repository attribute: + ▸ provide the argument attachment on the command line with a fully + specified name; + ▸ provide the argument --repository on the command line; + ▸ set the property artifacts/repository. + +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 artifactregistry/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/artifacts/docs/ diff --git a/gcloud/artifacts/attachments/download b/gcloud/artifacts/attachments/download new file mode 100644 index 000000000..c69036da9 --- /dev/null +++ b/gcloud/artifacts/attachments/download @@ -0,0 +1,84 @@ +NAME + gcloud artifacts attachments download - download an Artifact registry + attachment from a repository + +SYNOPSIS + gcloud artifacts attachments download + [ATTACHMENT : --location=LOCATION --repository=REPOSITORY] + --destination=DESTINATION [--chunk-size=CHUNK_SIZE] + [--oci-version-name=OCI_VERSION_NAME] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Download an Artifact registry attachment from a repository. + +EXAMPLES + To download the attachment my-attachment to /path/to/destination/: + + $ gcloud artifacts attachments download my-attachment \ + --destination=/path/to/destination/ + + To download the attachment my-attachment in 8000 byte chunks to + /path/to/destination/: + + $ gcloud artifacts attachments download my-attachment \ + --destination=/path/to/destination/ --chunk-size=8000 + +POSITIONAL ARGUMENTS + Attachment resource - The Artifact Registry attachment name. 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 attachment on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + ATTACHMENT + ID of the attachment or fully qualified identifier for the + attachment. + + To set the name attribute: + ▸ provide the argument attachment 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 attachment. + + To set the location attribute: + ▸ provide the argument attachment on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property artifacts/location. + + --repository=REPOSITORY + Repository of the attachment. + + To set the repository attribute: + ▸ provide the argument attachment on the command line with a fully + specified name; + ▸ provide the argument --repository on the command line; + ▸ set the property artifacts/repository. + +REQUIRED FLAGS + --destination=DESTINATION + Path where you want to save the downloaded attachment files. + +OPTIONAL FLAGS + --chunk-size=CHUNK_SIZE + If specified, the chunk size (bytes) to use for downloading the + package. + + --oci-version-name=OCI_VERSION_NAME + The version name of the OCI artifact to download. + +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. diff --git a/gcloud/artifacts/attachments/help b/gcloud/artifacts/attachments/help new file mode 100644 index 000000000..66d4b55b2 --- /dev/null +++ b/gcloud/artifacts/attachments/help @@ -0,0 +1,36 @@ +NAME + gcloud artifacts attachments - manage Artifact Registry attachments + +SYNOPSIS + gcloud artifacts attachments COMMAND [GCLOUD_WIDE_FLAG ...] + +EXAMPLES + To list all attachments in the current project, repository and location, + run: + + $ gcloud artifacts attachments list + + To list attachments under repository my-repo in the current project and + location, run: + + $ gcloud artifacts attachments list --repository=my-repo + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + Creates an Artifact registry attachment in a repository. + + delete + Delete an Artifact Registry attachment. + + download + Download an Artifact registry attachment from a repository. + + list + List Artifact Registry attachments. diff --git a/gcloud/artifacts/attachments/list b/gcloud/artifacts/attachments/list new file mode 100644 index 000000000..b4c0f2df7 --- /dev/null +++ b/gcloud/artifacts/attachments/list @@ -0,0 +1,94 @@ +NAME + gcloud artifacts attachments list - list Artifact Registry attachments + +SYNOPSIS + gcloud artifacts attachments list [--target=TARGET] + [--location=LOCATION --repository=REPOSITORY] [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List all Artifact Registry attachments in the specified repository and + project. + + To specify the maximum number of attachments to list, use the --limit flag. + +EXAMPLES + The following command lists a maximum of five attachments: + + $ gcloud artifacts attachments list --limit=5 + +FLAGS + --target=TARGET + Target for the list of attachments. + + Repository resource - Parent repository for the list of attachments. 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 --repository on the command line with a fully + specified name; + ◆ set the property artifacts/repository with a fully specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --location=LOCATION + Location of the repository. Overrides the default artifacts/location + property value for this command invocation. To configure the default + location, use the command: gcloud config set artifacts/location. + + To set the location attribute: + ▸ provide the argument --repository on the command line with a + fully specified name; + ▸ set the property artifacts/repository with a fully specified + name; + ▸ provide the argument --location on the command line; + ▸ set the property artifacts/location. + + --repository=REPOSITORY + ID of the repository or fully qualified identifier for the + repository. + + To set the repository attribute: + ▸ provide the argument --repository on the command line; + ▸ set the property artifacts/repository. + +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 artifactregistry/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/artifacts/docs/ diff --git a/gcloud/artifacts/help b/gcloud/artifacts/help index e3f603865..cefb025b0 100644 --- a/gcloud/artifacts/help +++ b/gcloud/artifacts/help @@ -18,6 +18,9 @@ GROUPS apt Manage Artifact Registry Debian packages. + attachments + Manage Artifact Registry attachments. + docker Manage Artifact Registry container images and tags. diff --git a/gcloud/artifacts/sbom/export b/gcloud/artifacts/sbom/export index 85084b382..e34e0615a 100644 --- a/gcloud/artifacts/sbom/export +++ b/gcloud/artifacts/sbom/export @@ -2,7 +2,8 @@ NAME gcloud artifacts sbom export - export SBOM files to Google Cloud Storage SYNOPSIS - gcloud artifacts sbom export --uri=URI [GCLOUD_WIDE_FLAG ...] + gcloud artifacts sbom export --uri=URI [--location=LOCATION] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION Export SBOM files to Google Cloud Storage. @@ -22,6 +23,11 @@ REQUIRED FLAGS Registry. Make sure 'artifactregistry.projectsettings.get' permission is granted to the current gcloud user to verify the redirection status. +OPTIONAL FLAGS + --location=LOCATION + If specified, all requests to Artifact Analysis for occurrences will go + to location specified + 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/artifacts/sbom/list b/gcloud/artifacts/sbom/list index 12949e276..847ca94b7 100644 --- a/gcloud/artifacts/sbom/list +++ b/gcloud/artifacts/sbom/list @@ -2,7 +2,7 @@ NAME gcloud artifacts sbom list - list SBOM file references SYNOPSIS - gcloud artifacts sbom list + gcloud artifacts sbom list [--location=LOCATION] [--dependency=DEPENDENCY | --resource=RESOURCE | --resource-prefix=RESOURCE_PREFIX] [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] @@ -42,6 +42,10 @@ EXAMPLES $ gcloud artifacts sbom list --dependency="perl" FLAGS + --location=LOCATION + If specified, all requests to Artifact Analysis for occurrences will go + to location specified + At most one of these can be specified: --dependency=DEPENDENCY diff --git a/gcloud/artifacts/sbom/load b/gcloud/artifacts/sbom/load index 5055274ea..6a93bc6be 100644 --- a/gcloud/artifacts/sbom/load +++ b/gcloud/artifacts/sbom/load @@ -5,7 +5,7 @@ NAME SYNOPSIS gcloud artifacts sbom load --source=SOURCE --uri=ARTIFACT_URI [--destination=DESTINATION] [--kms-key-version=KMS_KEY_VERSION] - [GCLOUD_WIDE_FLAG ...] + [--location=LOCATION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION Upload an SBOM file and create a reference occurrence. @@ -57,6 +57,10 @@ OPTIONAL FLAGS provided should be the resource ID in the format of projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]/cryptoKeyVersions/[KEY_VERSION]. + --location=LOCATION + If specified, all requests to Artifact Analysis for occurrences will go + to location specified + 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/artifacts/vulnerabilities/list b/gcloud/artifacts/vulnerabilities/list index 5b5cd7e9a..0c76bbee1 100644 --- a/gcloud/artifacts/vulnerabilities/list +++ b/gcloud/artifacts/vulnerabilities/list @@ -3,7 +3,7 @@ NAME vulnerabilities. To see all fields, use --format=json SYNOPSIS - gcloud artifacts vulnerabilities list URI + gcloud artifacts vulnerabilities list URI [--location=LOCATION] [--occurrence-filter=OCCURRENCE_FILTER] [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] @@ -24,6 +24,10 @@ POSITIONAL ARGUMENTS Google Cloud Registry. FLAGS + --location=LOCATION + If specified, all requests to Artifact Analysis for occurrences will go + to location specified + --occurrence-filter=OCCURRENCE_FILTER A filter for the occurrences which will be summarized. See link for officially supported filters: diff --git a/gcloud/artifacts/vulnerabilities/load-vex b/gcloud/artifacts/vulnerabilities/load-vex index 16630bc74..c4c390291 100644 --- a/gcloud/artifacts/vulnerabilities/load-vex +++ b/gcloud/artifacts/vulnerabilities/load-vex @@ -4,7 +4,7 @@ NAME SYNOPSIS gcloud artifacts vulnerabilities load-vex --source=SOURCE --uri=URI - [--project=PROJECT] [GCLOUD_WIDE_FLAG ...] + [--location=LOCATION] [--project=PROJECT] [GCLOUD_WIDE_FLAG ...] DESCRIPTION Command loads VEX data from a Common Security Advisory Framework (CSAF) @@ -37,6 +37,10 @@ REQUIRED FLAGS current gcloud user to verify the redirection status. OPTIONAL FLAGS + --location=LOCATION + If specified, all requests to Artifact Analysis for occurrences will go + to location specified + --project=PROJECT The parent project to load security advisory into. diff --git a/gcloud/beta/compute/scp b/gcloud/beta/compute/scp index 46df6952f..09921493e 100644 --- a/gcloud/beta/compute/scp +++ b/gcloud/beta/compute/scp @@ -31,6 +31,8 @@ DESCRIPTION be from the same virtual machine. ▪ When the destination of your transfer is remote instead, all sources must be local. + ▪ When the destination is Windows Server, the source must be using a + similar SSH version. Under the covers, scp(1) is used to facilitate the transfer. diff --git a/gcloud/beta/container/fleet/config-management/status b/gcloud/beta/container/fleet/config-management/status index 10971bc1c..69027928e 100644 --- a/gcloud/beta/container/fleet/config-management/status +++ b/gcloud/beta/container/fleet/config-management/status @@ -30,22 +30,25 @@ EXAMPLES View the status for the cluster named managed-cluster-a: $ gcloud beta container fleet config-management status \ + --flatten=acm_status \ --filter="acm_status.name:managed-cluster-a" Use a regular expression to list status for multiple clusters: $ gcloud beta container fleet config-management status \ + --flatten=acm_status \ --filter="acm_status.name ~ managed-cluster.*" List all clusters where current Config Sync Status is SYNCED: $ gcloud beta container fleet config-management status \ - --filter="acm_status.config_sync:SYNCED" + --flatten=acm_status --filter="acm_status.config_sync:SYNCED" List all the clusters where sync_branch is v1 and current Config Sync Status is not SYNCED: $ gcloud beta container fleet config-management status \ + --flatten=acm_status \ --filter="acm_status.sync_branch:v1 AND \ -acm_status.config_sync:SYNCED" diff --git a/gcloud/beta/container/hub/config-management/status b/gcloud/beta/container/hub/config-management/status index 9e94b5a5e..80db96c24 100644 --- a/gcloud/beta/container/hub/config-management/status +++ b/gcloud/beta/container/hub/config-management/status @@ -30,22 +30,25 @@ EXAMPLES View the status for the cluster named managed-cluster-a: $ gcloud beta container hub config-management status \ + --flatten=acm_status \ --filter="acm_status.name:managed-cluster-a" Use a regular expression to list status for multiple clusters: $ gcloud beta container hub config-management status \ + --flatten=acm_status \ --filter="acm_status.name ~ managed-cluster.*" List all clusters where current Config Sync Status is SYNCED: $ gcloud beta container hub config-management status \ - --filter="acm_status.config_sync:SYNCED" + --flatten=acm_status --filter="acm_status.config_sync:SYNCED" List all the clusters where sync_branch is v1 and current Config Sync Status is not SYNCED: $ gcloud beta container hub config-management status \ + --flatten=acm_status \ --filter="acm_status.sync_branch:v1 AND \ -acm_status.config_sync:SYNCED" diff --git a/gcloud/beta/deploy/deploy-policies/describe b/gcloud/beta/deploy/deploy-policies/describe index bc1e666c6..56c15e165 100644 --- a/gcloud/beta/deploy/deploy-policies/describe +++ b/gcloud/beta/deploy/deploy-policies/describe @@ -1,5 +1,5 @@ NAME - gcloud beta deploy deploy-policies describe - show details for a deploy + gcloud beta deploy deploy-policies describe - show details about a deploy policy SYNOPSIS @@ -7,18 +7,20 @@ SYNOPSIS (DEPLOY_POLICY : --region=REGION) [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Show details for a specified deploy policy. + (BETA) Show details about a deploy policy. EXAMPLES - To show details about a deploy policy test-policy in region us-central, - run: $ gcloud beta deploy deploy-policies describe test-policy \ + To describe a deploy policy called 'test-policy' in region 'us-central1', + run: + + $ gcloud beta deploy deploy-policies describe test-policy \ --region=us-central1 POSITIONAL ARGUMENTS - Deploy policy resource - The name of the deploy policy 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. + Deploy policy resource - The name of the Deploy Policy. 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 deploy_policy on the command line with a fully @@ -39,7 +41,8 @@ POSITIONAL ARGUMENTS arguments in this group are specified. --region=REGION - Location of the deploy policy. + The Cloud region for the deploy policy. Alternatively, set the + property [deploy/region]. To set the region attribute: ▸ provide the argument deploy_policy on the command line with a @@ -55,10 +58,6 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. -API REFERENCE - This command uses the clouddeploy/v1 API. The full documentation for this - API can be found at: https://cloud.google.com/deploy/ - NOTES This command is currently in beta and might change without notice. These variants are also available: diff --git a/gcloud/beta/deploy/deploy-policies/export b/gcloud/beta/deploy/deploy-policies/export index aa1e48666..47b5bfefe 100644 --- a/gcloud/beta/deploy/deploy-policies/export +++ b/gcloud/beta/deploy/deploy-policies/export @@ -31,8 +31,8 @@ POSITIONAL ARGUMENTS This must be specified. DEPLOY_POLICY - ID of the deploy_policy or fully qualified identifier for the - deploy_policy. + ID of the deploy policy or fully qualified identifier for the deploy + policy. To set the deploy_policy attribute: ▸ provide the argument deploy_policy on the command line. @@ -41,7 +41,7 @@ POSITIONAL ARGUMENTS arguments in this group are specified. --region=REGION - The Cloud region for the deploy_policy. Alternatively, set the + The Cloud region for the deploy policy. Alternatively, set the property [deploy/region]. To set the region attribute: diff --git a/gcloud/beta/deploy/deploy-policies/help b/gcloud/beta/deploy/deploy-policies/help index e509c7962..2999b371f 100644 --- a/gcloud/beta/deploy/deploy-policies/help +++ b/gcloud/beta/deploy/deploy-policies/help @@ -20,7 +20,7 @@ COMMANDS (BETA) Delete a deploy policy. describe - (BETA) Show details for a deploy policy. + (BETA) Show details about a deploy policy. export (BETA) Returns the .yaml definition of the specified deploy policy. diff --git a/gcloud/beta/filestore/instances/create b/gcloud/beta/filestore/instances/create index 1dc8a1ed5..4233f1552 100644 --- a/gcloud/beta/filestore/instances/create +++ b/gcloud/beta/filestore/instances/create @@ -31,9 +31,8 @@ EXAMPLES --file-share=name=VOLUME_NAME,capacity=CAPACITY \ --network=name=NETWORK_NAME,\ reserved-ip-range=RESERVED_IP_RANGE,connect-mode=CONNECT_MODE \ - --zone=ZONE --performance=PERFORMANCE --kms-key=KMS-KEY \ - --kms-keyring=KMS_KEYRING --kms-location=KMS_LOCATION \ - --kms-project=KMS_PROJECT \ + --zone=ZONE --kms-key=KMS-KEY --kms-keyring=KMS_KEYRING \ + --kms-location=KMS_LOCATION --kms-project=KMS_PROJECT \ --managed-ad=domain=DOMAIN,computer=COMPUTER \ --flags-file=FLAGS_FILE --source-instance=SOURCE_INSTANCE diff --git a/gcloud/beta/iap/settings/get b/gcloud/beta/iap/settings/get index 93f710284..d8eaa8153 100644 --- a/gcloud/beta/iap/settings/get +++ b/gcloud/beta/iap/settings/get @@ -73,9 +73,9 @@ FLAGS Project ID. --region=REGION - Region name. Not applicable for app-engine. Required when resource-type - is compute and regional scoped. Not applicable for compute when global - scoped. + Region name. Not applicable for app-engine. Required when + resource-type=compute and regional scoped. Not applicable for global + scoped compute. --resource-type=RESOURCE_TYPE Resource type of the IAP resource. RESOURCE_TYPE must be one of: @@ -85,8 +85,8 @@ FLAGS Service name. Optional when resource-type is compute or app-engine. --version=VERSION - Version name. Not applicable for compute. Optional when resource-type - is app-engine. + Version name. Not applicable for compute. Optional when + resource-type=app-engine. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/beta/iap/settings/set b/gcloud/beta/iap/settings/set index 33722fb4f..f1276b334 100644 --- a/gcloud/beta/iap/settings/set +++ b/gcloud/beta/iap/settings/set @@ -124,9 +124,9 @@ FLAGS Project ID. --region=REGION - Region name. Not applicable for app-engine. Required when resource-type - is compute and regional scoped. Not applicable for compute when global - scoped. + Region name. Not applicable for app-engine. Required when + resource-type=compute and regional scoped. Not applicable for global + scoped compute. --resource-type=RESOURCE_TYPE Resource type of the IAP resource. RESOURCE_TYPE must be one of: @@ -136,8 +136,8 @@ FLAGS Service name. Optional when resource-type is compute or app-engine. --version=VERSION - Version name. Not applicable for compute. Optional when resource-type - is app-engine. + Version name. Not applicable for compute. Optional when + resource-type=app-engine. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/beta/logging/settings/update b/gcloud/beta/logging/settings/update index e7ed750d1..48221eaab 100644 --- a/gcloud/beta/logging/settings/update +++ b/gcloud/beta/logging/settings/update @@ -63,7 +63,7 @@ EXAMPLES $ gcloud beta logging settings update \ --organization=[ORGANIZATION_ID] --disable-default-sink=false \ - --analytics-mode=enabled + --analytics-mode=required REQUIRED FLAGS Exactly one of these must be specified: diff --git a/gcloud/beta/netapp/volumes/replications/create b/gcloud/beta/netapp/volumes/replications/create index a92862ef5..0e2e8c3d2 100644 --- a/gcloud/beta/netapp/volumes/replications/create +++ b/gcloud/beta/netapp/volumes/replications/create @@ -9,8 +9,8 @@ SYNOPSIS [share_name=SHARE_NAME], [storage_pool=STORAGE_POOL],[volume_id=VOLUME_ID] --replication-schedule=REPLICATION_SCHEDULE [--async] - [--cluster-location=CLUSTER_LOCATION] [--description=DESCRIPTION] - [--labels=[KEY=VALUE,...]] [--volume=VOLUME] [GCLOUD_WIDE_FLAG ...] + [--description=DESCRIPTION] [--labels=[KEY=VALUE,...]] + [--volume=VOLUME] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Create a Cloud NetApp Volume Replication. @@ -73,9 +73,6 @@ OPTIONAL FLAGS Return immediately, without waiting for the operation in progress to complete. - --cluster-location=CLUSTER_LOCATION - Location of the user cluster. - --description=DESCRIPTION A description of the Cloud NetApp Replication diff --git a/gcloud/beta/netapp/volumes/replications/update b/gcloud/beta/netapp/volumes/replications/update index ffa746b9b..bc7ee1628 100644 --- a/gcloud/beta/netapp/volumes/replications/update +++ b/gcloud/beta/netapp/volumes/replications/update @@ -5,7 +5,7 @@ NAME SYNOPSIS gcloud beta netapp volumes replications update (REPLICATION : --location=LOCATION) [--async] - [--cluster-location=CLUSTER_LOCATION] [--description=DESCRIPTION] + [--description=DESCRIPTION] [--replication-schedule=REPLICATION_SCHEDULE] [--update-labels=[KEY=VALUE,...]] [--volume=VOLUME] [--clear-labels | --remove-labels=[KEY,...]] [GCLOUD_WIDE_FLAG ...] @@ -66,9 +66,6 @@ FLAGS Return immediately, without waiting for the operation in progress to complete. - --cluster-location=CLUSTER_LOCATION - Location of the user cluster. - --description=DESCRIPTION A description of the Cloud NetApp Replication diff --git a/gcloud/beta/notebook-executor/executions/create b/gcloud/beta/notebook-executor/executions/create new file mode 100644 index 000000000..21d6b4946 --- /dev/null +++ b/gcloud/beta/notebook-executor/executions/create @@ -0,0 +1,186 @@ +NAME + gcloud beta notebook-executor executions create - create an execution of a + Colab Enterprise notebook + +SYNOPSIS + gcloud beta notebook-executor executions create --region=REGION + (--display-name=DISPLAY_NAME --gcs-output-uri=GCS_OUTPUT_URI + --notebook-runtime-template=NOTEBOOK_RUNTIME_TEMPLATE + (--direct-content=DIRECT_CONTENT + | [--dataform-repository-name=DATAFORM_REPOSITORY_NAME + : --commit-sha=COMMIT_SHA] | [--gcs-notebook-uri=GCS_NOTEBOOK_URI + : --generation=GENERATION]) (--service-account=SERVICE_ACCOUNT + | --user-email=USER_EMAIL) + : --execution-timeout=EXECUTION_TIMEOUT; default="24h") [--async] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Creates a notebook execution to be used on a Colab Enterprise + runtime. + +EXAMPLES + To create an execution of a notebook file with Cloud Storage URI + gs://my-bucket/my-notebook.ipynb, with an execution job display name + my-execution, compute configured from runtime template + my-runtime-template-id, running with service account + my-service-account@my-project.iam.gserviceaccount.com, with results + uploaded to Cloud Storage bucket gs://my-bucket/results, and in region + us-central1 run: + + $ gcloud beta notebook-executor executions create \ + --display-name=my-execution \ + --runtime-template=my-runtime-template-id \ + --gcs-notebook-uri=gs://my-bucket/my-notebook.ipynb \ + --service-account=my-service-account@my-project.iam.gserviceacco\ + unt.com --gcs-output-uri=gs://my-bucket/results --region=us-central1 + +REQUIRED FLAGS + Region resource - Cloud region to create. This represents a Cloud + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. + + To set the project attribute: + ◆ provide the argument --region on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + --region=REGION + ID of the region or fully qualified identifier for the region. + + To set the region attribute: + ▸ provide the argument --region on the command line. + + Configuration of the execution job. + + This must be specified. + + --display-name=DISPLAY_NAME + The display name of the execution. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --gcs-output-uri=GCS_OUTPUT_URI + The Cloud Storage location to upload notebook execution results to. + Format: gs://bucket-name. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + Notebook runtime template resource - The runtime template specifying the + compute configuration for the notebook execution. The runtime template + should be in the same region as the execution. This represents a Cloud + resource. (NOTE) Some attributes are not given arguments in this group + but can be set in other ways. + + To set the project attribute: + ▸ provide the argument --notebook-runtime-template on the command + line with a fully specified name; + ▸ provide the argument --project on the command line; + ▸ set the property core/project. + + To set the region attribute: + ▸ provide the argument --notebook-runtime-template on the command + line with a fully specified name; + ▸ provide the argument --region on the command line. + + This must be specified. + + --notebook-runtime-template=NOTEBOOK_RUNTIME_TEMPLATE + ID of the notebook runtime template or fully qualified identifier + for the notebook runtime template. + + To set the name attribute: + ▫ provide the argument --notebook-runtime-template on the command + line. + + --execution-timeout=EXECUTION_TIMEOUT; default="24h" + The max running time of the execution job, as a duration. See '$ + gcloud topic datetimes' for details on formatting the input duration. + + Source of the notebook to execute. + + Exactly one of these must be specified: + + --direct-content=DIRECT_CONTENT + The direct notebook content as IPYNB. This can be a local filepath + to an .ipynb file or can be set to - to read content from stdin. + + The Dataform repository containing the notebook. Any notebook created + from the Colab UI is automatically stored in a Dataform repository. + The repository name can be found via the Dataform API by listing + repositories in the same project and region as the notebook. + + Dataform repository resource - Unique name of the Dataform + repository to source input notebook from. This represents a Cloud + resource. (NOTE) Some attributes are not given arguments in this + group but can be set in other ways. + + To set the project attribute: + ◇ provide the argument --dataform-repository-name on the command + line with a fully specified name; + ◇ provide the argument --project on the command line; + ◇ set the property core/project. + + To set the region attribute: + ◇ provide the argument --dataform-repository-name on the command + line with a fully specified name; + ◇ provide the argument --region on the command line. + + This must be specified. + + --dataform-repository-name=DATAFORM_REPOSITORY_NAME + ID of the dataform repository or fully qualified identifier for + the dataform repository. + + To set the name attribute: + ▹ provide the argument --dataform-repository-name on the + command line. + + --commit-sha=COMMIT_SHA + The commit SHA to read from the Dataform repository. If unset, + the file will be read from HEAD. + + The Cloud Storage notebook source. + + --gcs-notebook-uri=GCS_NOTEBOOK_URI + The Cloud Storage uri pointing to the notebook. Format: + gs://bucket/notebook_file.ipynb + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --generation=GENERATION + The version of the Cloud Storage object to read. If unset, the + current version of the object will be used. + + Identity to run the execution as. + + Exactly one of these must be specified: + + --service-account=SERVICE_ACCOUNT + The service account to run the execution as. + + --user-email=USER_EMAIL + The user email to run the execution as. This requires the provided + runtime template to have end user credentials enabled. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + +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. + diff --git a/gcloud/beta/notebook-executor/executions/delete b/gcloud/beta/notebook-executor/executions/delete new file mode 100644 index 000000000..baf44384a --- /dev/null +++ b/gcloud/beta/notebook-executor/executions/delete @@ -0,0 +1,65 @@ +NAME + gcloud beta notebook-executor executions delete - delete a notebook + execution + +SYNOPSIS + gcloud beta notebook-executor executions delete + (EXECUTION : --region=REGION) [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Deletes a notebook execution. + +EXAMPLES + To delete an execution with id my-execution, in region us-central1, run: + + $ gcloud beta notebook-executor executions delete my-execution \ + --region=us-central1 + +POSITIONAL ARGUMENTS + Notebook execution job resource - Unique resource name of the execution to + delete. The arguments in this group can be used to specify the attributes + of this resource. (NOTE) Some attributes are not given arguments in this + group but can be set in other ways. + + To set the project attribute: + ◆ provide the argument execution on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + EXECUTION + ID of the notebook execution job or fully qualified identifier for + the notebook execution job. + + To set the name attribute: + ▸ provide the argument execution on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --region=REGION + Cloud region for the notebook execution job. + + To set the region attribute: + ▸ provide the argument execution on the command line with a fully + specified name; + ▸ provide the argument --region on the command line. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This command is currently in beta and might change without notice. + diff --git a/gcloud/beta/notebook-executor/executions/describe b/gcloud/beta/notebook-executor/executions/describe new file mode 100644 index 000000000..b7da8a959 --- /dev/null +++ b/gcloud/beta/notebook-executor/executions/describe @@ -0,0 +1,60 @@ +NAME + gcloud beta notebook-executor executions describe - describe an execution + +SYNOPSIS + gcloud beta notebook-executor executions describe + (EXECUTION : --region=REGION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Describes a notebook execution. + +EXAMPLES + To describe a notebook execution with id my-execution in region + us-central1, run: + + $ gcloud beta notebook-executor executions describe my-execution \ + --region=us-central1 + +POSITIONAL ARGUMENTS + Notebook execution job resource - Unique resource name of the execution to + describe. The arguments in this group can be used to specify the + attributes of this resource. (NOTE) Some attributes are not given + arguments in this group but can be set in other ways. + + To set the project attribute: + ◆ provide the argument execution on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + EXECUTION + ID of the notebook execution job or fully qualified identifier for + the notebook execution job. + + To set the name attribute: + ▸ provide the argument execution on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --region=REGION + Cloud region for the notebook execution job. + + To set the region attribute: + ▸ provide the argument execution on the command line with a fully + specified name; + ▸ provide the argument --region on the command line. + +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. + diff --git a/gcloud/beta/notebook-executor/executions/help b/gcloud/beta/notebook-executor/executions/help new file mode 100644 index 000000000..eba0de2ac --- /dev/null +++ b/gcloud/beta/notebook-executor/executions/help @@ -0,0 +1,34 @@ +NAME + gcloud beta notebook-executor executions - notebook Executor Executions + command group + +SYNOPSIS + gcloud beta notebook-executor executions COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) For more information about executions, see + https://cloud.google.com/colab/docs/schedule-notebook-run. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + (BETA) Create an execution of a Colab Enterprise notebook. + + delete + (BETA) Delete a notebook execution. + + describe + (BETA) Describe an execution. + + list + (BETA) List your execution jobs. + +NOTES + This command is currently in beta and might change without notice. + diff --git a/gcloud/beta/notebook-executor/executions/list b/gcloud/beta/notebook-executor/executions/list new file mode 100644 index 000000000..09bb84123 --- /dev/null +++ b/gcloud/beta/notebook-executor/executions/list @@ -0,0 +1,78 @@ +NAME + gcloud beta notebook-executor executions list - list your execution jobs + +SYNOPSIS + gcloud beta notebook-executor executions list --region=REGION + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Lists your project's Notebook Executor executions in a given region. + +EXAMPLES + To list your executions in region us-central1, run: + + $ gcloud beta notebook-executor executions list --region=us-central1 + +REQUIRED FLAGS + Region resource - Cloud region for which to list all executions. This + represents a Cloud resource. (NOTE) Some attributes are not given + arguments in this group but can be set in other ways. + + To set the project attribute: + ◆ provide the argument --region on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + --region=REGION + ID of the region or fully qualified identifier for the region. + + To set the region attribute: + ▸ provide the argument --region on the command line. + +LIST COMMAND FLAGS + --filter=EXPRESSION + Apply a Boolean filter EXPRESSION to each resource item to be listed. + If the expression evaluates True, then that item is listed. For more + details and examples of filter expressions, run $ gcloud topic filters. + This flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --limit=LIMIT + Maximum number of resources to list. The default is unlimited. This + flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --page-size=PAGE_SIZE + Some services group resource list output into pages. This flag + specifies the maximum number of resources per page. The default is + determined by the service if it supports paging, otherwise it is + unlimited (no paging). Paging may be applied before or after --filter + and --limit depending on the service. + + --sort-by=[FIELD,...] + Comma-separated list of resource field key names to sort by. The + default order is ascending. Prefix a field with ``~'' for descending + order on that field. This flag interacts with other flags that are + applied in this order: --flatten, --sort-by, --filter, --limit. + + --uri + Print a list of resource URIs instead of the default output, and change + the command output to a list of URIs. If this flag is used with + --format, the formatting is applied on this URI list. To display URIs + alongside other keys instead, use the uri() transform. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This command is currently in beta and might change without notice. + diff --git a/gcloud/beta/notebook-executor/help b/gcloud/beta/notebook-executor/help new file mode 100644 index 000000000..754e8708d --- /dev/null +++ b/gcloud/beta/notebook-executor/help @@ -0,0 +1,23 @@ +NAME + gcloud beta notebook-executor - notebook Executor Command Group + +SYNOPSIS + gcloud beta notebook-executor GROUP [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Notebook Executor Command Group. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + executions + (BETA) Notebook Executor Executions command group. + +NOTES + This command is currently in beta and might change without notice. + diff --git a/gcloud/beta/pubsub/subscriptions/create b/gcloud/beta/pubsub/subscriptions/create index fe08c43ea..dd56cfe83 100644 --- a/gcloud/beta/pubsub/subscriptions/create +++ b/gcloud/beta/pubsub/subscriptions/create @@ -123,7 +123,7 @@ OPTIONAL FLAGS backlog, from the moment a message is published. If --retain-acked-messages is true, this also configures the retention of acknowledged messages. The default value is 7 days, the minimum is 10 - minutes, and the maximum is 7 days. Valid values are strings of the + minutes, and the maximum is 31 days. Valid values are strings of the form INTEGER[UNIT], where UNIT is one of "s", "m", "h", and "d" for seconds, minutes, hours, and days, respectively. If the unit is omitted, seconds is assumed. @@ -209,7 +209,7 @@ OPTIONAL FLAGS --cloud-storage-max-bytes=CLOUD_STORAGE_MAX_BYTES The maximum bytes that can be written to a Cloud Storage file - before a new file is created. The value must be between 1KB to + before a new file is created. The value must be between 1000B and 10GB. If the unit is omitted, KB is assumed. --cloud-storage-max-duration=CLOUD_STORAGE_MAX_DURATION diff --git a/gcloud/beta/pubsub/subscriptions/update b/gcloud/beta/pubsub/subscriptions/update index 77d47726d..bbbc6d067 100644 --- a/gcloud/beta/pubsub/subscriptions/update +++ b/gcloud/beta/pubsub/subscriptions/update @@ -77,7 +77,7 @@ FLAGS backlog, from the moment a message is published. If --retain-acked-messages is true, this also configures the retention of acknowledged messages. Specify "default" to use the default value of 7 - days. The minimum is 10 minutes, and the maximum is 7 days. Valid + days. The minimum is 10 minutes, and the maximum is 31 days. Valid values are strings of the form INTEGER[UNIT], where UNIT is one of "s", "m", "h", and "d" for seconds, minutes, hours, and days, respectively. If the unit is omitted, seconds is assumed. @@ -197,7 +197,7 @@ FLAGS --cloud-storage-max-bytes=CLOUD_STORAGE_MAX_BYTES The maximum bytes that can be written to a Cloud Storage file - before a new file is created. The value must be between 1KB to + before a new file is created. The value must be between 1000B and 10GB. If the unit is omitted, KB is assumed. --cloud-storage-max-duration=CLOUD_STORAGE_MAX_DURATION diff --git a/gcloud/beta/spanner/backup-schedules/add-iam-policy-binding b/gcloud/beta/spanner/backup-schedules/add-iam-policy-binding new file mode 100644 index 000000000..04a3a5dce --- /dev/null +++ b/gcloud/beta/spanner/backup-schedules/add-iam-policy-binding @@ -0,0 +1,159 @@ +NAME + gcloud beta spanner backup-schedules add-iam-policy-binding - add IAM + policy binding to a Cloud Spanner backup schedule + +SYNOPSIS + gcloud beta spanner backup-schedules add-iam-policy-binding + (BACKUP_SCHEDULE : --database=DATABASE --instance=INSTANCE) + --member=PRINCIPAL --role=ROLE + [--condition=[KEY=VALUE,...] | --condition-from-file=PATH_TO_FILE] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Add an IAM policy binding to a Cloud Spanner backup schedule. One + binding consists of a member, a role, and an optional condition. + +EXAMPLES + To add an IAM policy binding for the role of 'roles/editor' for the user + 'test-user@gmail.com', run: + + $ gcloud beta spanner backup-schedules add-iam-policy-binding \ + backup-schedule-id --instance=instance-id \ + --database=database-id --member='user:test-user@gmail.com' \ + --role='roles/editor' + + To add an IAM policy binding which expires at the end of the year 2025 for + the role of 'roles/editor' and the user 'test-user@gmail.com', run: + + $ gcloud beta spanner backup-schedules add-iam-policy-binding \ + backup-schedule-id --instance=instance-id \ + --database=database-id --member='user:test-user@gmail.com' \ + --role='roles/editor' \ + --condition='expression=request.time < + timestamp("2026-01-01T00:00:00Z"),title=expires_end_of_2025,descrip\ + tion=Expires at midnight on 2025-12-31' + + See https://cloud.google.com/iam/docs/managing-policies for details of + policy role and member types. + +POSITIONAL ARGUMENTS + BackupSchedule resource - The Cloud Spanner backup schedule to which to + add the IAM policy binding. 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 backup_schedule 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. + + BACKUP_SCHEDULE + ID of the backupSchedule or fully qualified identifier for the + backupSchedule. + + To set the backup_schedule attribute: + ▸ provide the argument backup_schedule on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --database=DATABASE + The name of the Cloud Spanner database. + + To set the database attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --database on the command line. + + --instance=INSTANCE + The name of the Cloud Spanner instance. + + To set the instance attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --instance on the command line; + ▸ set the property spanner/instance. + +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. + +OPTIONAL FLAGS + At most one of these can be specified: + + --condition=[KEY=VALUE,...] + A condition to include in the binding. When the condition is + explicitly specified as None (--condition=None), a binding without a + condition is added. When the condition is specified and is not None, + --role cannot be a basic role. Basic roles are roles/editor, + roles/owner, and roles/viewer. For more on conditions, refer to the + conditions overview guide: + https://cloud.google.com/iam/docs/conditions-overview + + When using the --condition flag, include the following key-value + pairs: + + expression + (Required) Condition expression that evaluates to True or False. + This uses a subset of Common Expression Language syntax. + + If the condition expression includes a comma, use a different + delimiter to separate the key-value pairs. Specify the delimiter + before listing the key-value pairs. For example, to specify a + colon (:) as the delimiter, do the following: + --condition=^:^title=TITLE:expression=EXPRESSION. For more + information, see + https://cloud.google.com/sdk/gcloud/reference/topic/escaping. + + title + (Required) A short string describing the purpose of the + expression. + + description + (Optional) Additional description for the expression. + + --condition-from-file=PATH_TO_FILE + Path to a local JSON or YAML file that defines the condition. To see + available fields, see the help for --condition. Use a full or + relative path to a local file containing the value of condition. + +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 spanner/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/spanner/ + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud spanner backup-schedules add-iam-policy-binding + + $ gcloud alpha spanner backup-schedules add-iam-policy-binding + diff --git a/gcloud/beta/spanner/backup-schedules/create b/gcloud/beta/spanner/backup-schedules/create new file mode 100644 index 000000000..50a1018ac --- /dev/null +++ b/gcloud/beta/spanner/backup-schedules/create @@ -0,0 +1,166 @@ +NAME + gcloud beta spanner backup-schedules create - create a Cloud Spanner backup + schedule + +SYNOPSIS + gcloud beta spanner backup-schedules create + (BACKUP_SCHEDULE : --database=DATABASE --instance=INSTANCE) + --backup-type=[BACKUP_TYPE] --cron=CRON + --retention-duration=RETENTION_DURATION + [--encryption-type=ENCRYPTION_TYPE [--kms-key=KMS_KEY + : --kms-keyring=KMS_KEYRING + --kms-location=KMS_LOCATION --kms-project=KMS_PROJECT]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Create a Cloud Spanner backup schedule. + +EXAMPLES + To create a Cloud Spanner backup schedule, run: + + $ gcloud beta spanner backup-schedules create backup-schedule-id \ + --instance=instance-id --database=database-id \ + --cron="0 2 * * *" --retention-duration=2w \ + --backup-type=full-backup + +POSITIONAL ARGUMENTS + Backup schedule resource - The Cloud Spanner backup schedule 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 backup_schedule 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. + + BACKUP_SCHEDULE + ID of the backup-schedule or fully qualified identifier for the + backup-schedule. + + To set the backup-schedule attribute: + ▸ provide the argument backup_schedule on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --database=DATABASE + The Cloud Spanner database for the backup-schedule. + + To set the database attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --database on the command line. + + --instance=INSTANCE + The Cloud Spanner instance for the backup-schedule. + + To set the instance attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --instance on the command line; + ▸ set the property spanner/instance. + +REQUIRED FLAGS + --backup-type=[BACKUP_TYPE] + Type of backups created by this schedule. + + Supported backup types: + + full-backup A full backup stores the entire contents of the database at + a given version time. + + incremental-backup An incremental backup contains only the data that + has changed since a previous backup. + + BACKUP_TYPE must be one of: full-backup, incremental-backup. + + --cron=CRON + Textual representation of the crontab. User can customize the backup + frequency and the backup version time using the cron expression. The + version time must be in UTC timzeone. The backup will contain an + externally consistent copy of the database at the version time. Allowed + frequencies are 12 hour, 1 day, 1 week and 1 month. Examples of valid + cron specifications: * 0 2/12 * * * : every 12 hours at (2, 14) hours + past midnight in UTC. * 0 2,14 * * * : every 12 hours at (2,14) hours + past midnight in UTC. * 0 2 * * * : once a day at 2 past midnight in + UTC. * 0 2 * * 0 : once a week every Sunday at 2 past midnight in UTC. + * 0 2 8 * * : once a month on 8th day at 2 past midnight in UTC. + + --retention-duration=RETENTION_DURATION + The retention duration of a backup that must be at least 6 hours and at + most 366 days. The backup is eligible to be automatically deleted once + the retention period has elapsed. + +OPTIONAL FLAGS + --encryption-type=ENCRYPTION_TYPE + The encryption type of the backup. ENCRYPTION_TYPE must be one of: + + customer-managed-encryption + Use the provided Cloud KMS key for encryption. If this option is + selected, kms-key must be set. + google-default-encryption + Use Google default encryption. + use-database-encryption + Use the same encryption configuration as the database. + + KMS key name group + + At most one of these can be specified: + + Key resource - Cloud KMS key to be used to create the Cloud Spanner + backup. The arguments in this group can be used to specify the + attributes of this resource. + + --kms-key=KMS_KEY + ID of the key or fully qualified identifier for the key. + + To set the kms-key attribute: + ▫ provide the argument --kms-key on the command line. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --kms-keyring=KMS_KEYRING + KMS keyring id of the key. + + To set the kms-keyring attribute: + ▫ provide the argument --kms-key on the command line with a fully + specified name; + ▫ provide the argument --kms-keyring on the command line. + + --kms-location=KMS_LOCATION + Cloud location for the key. + + To set the kms-location attribute: + ▫ provide the argument --kms-key on the command line with a fully + specified name; + ▫ provide the argument --kms-location on the command line. + + --kms-project=KMS_PROJECT + Cloud project id for the key. + + To set the kms-project attribute: + ▫ provide the argument --kms-key on the command line with a fully + specified name; + ▫ provide the argument --kms-project on the command line. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud spanner backup-schedules create + + $ gcloud alpha spanner backup-schedules create + diff --git a/gcloud/beta/spanner/backup-schedules/delete b/gcloud/beta/spanner/backup-schedules/delete new file mode 100644 index 000000000..0c6392516 --- /dev/null +++ b/gcloud/beta/spanner/backup-schedules/delete @@ -0,0 +1,75 @@ +NAME + gcloud beta spanner backup-schedules delete - delete a Cloud Spanner backup + schedule + +SYNOPSIS + gcloud beta spanner backup-schedules delete + (BACKUP_SCHEDULE : --database=DATABASE --instance=INSTANCE) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Delete a Cloud Spanner backup schedule. + +EXAMPLES + To delete a Cloud Spanner backup schedule, run: + + $ gcloud beta spanner backup-schedules delete backup-schedule-id \ + --instance=instance-id --database=database-id + +POSITIONAL ARGUMENTS + Backup schedule resource - The Cloud Spanner backup schedule 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 backup_schedule 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. + + BACKUP_SCHEDULE + ID of the backup-schedule or fully qualified identifier for the + backup-schedule. + + To set the backup-schedule attribute: + ▸ provide the argument backup_schedule on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --database=DATABASE + The Cloud Spanner database for the backup-schedule. + + To set the database attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --database on the command line. + + --instance=INSTANCE + The Cloud Spanner instance for the backup-schedule. + + To set the instance attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --instance on the command line; + ▸ set the property spanner/instance. + +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. These + variants are also available: + + $ gcloud spanner backup-schedules delete + + $ gcloud alpha spanner backup-schedules delete + diff --git a/gcloud/beta/spanner/backup-schedules/describe b/gcloud/beta/spanner/backup-schedules/describe new file mode 100644 index 000000000..562558637 --- /dev/null +++ b/gcloud/beta/spanner/backup-schedules/describe @@ -0,0 +1,75 @@ +NAME + gcloud beta spanner backup-schedules describe - describe a Cloud Spanner + backup schedule + +SYNOPSIS + gcloud beta spanner backup-schedules describe + (BACKUP_SCHEDULE : --database=DATABASE --instance=INSTANCE) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Describe a Cloud Spanner backup schedule. + +EXAMPLES + To describe a Cloud Spanner backup schedule, run: + + $ gcloud beta spanner backup-schedules describe backup-schedule-id \ + --instance=instance-id --database=database-id + +POSITIONAL ARGUMENTS + Backup schedule resource - The Cloud Spanner backup schedule 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 backup_schedule 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. + + BACKUP_SCHEDULE + ID of the backup-schedule or fully qualified identifier for the + backup-schedule. + + To set the backup-schedule attribute: + ▸ provide the argument backup_schedule on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --database=DATABASE + The Cloud Spanner database for the backup-schedule. + + To set the database attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --database on the command line. + + --instance=INSTANCE + The Cloud Spanner instance for the backup-schedule. + + To set the instance attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --instance on the command line; + ▸ set the property spanner/instance. + +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. These + variants are also available: + + $ gcloud spanner backup-schedules describe + + $ gcloud alpha spanner backup-schedules describe + diff --git a/gcloud/beta/spanner/backup-schedules/get-iam-policy b/gcloud/beta/spanner/backup-schedules/get-iam-policy new file mode 100644 index 000000000..a231bb4dd --- /dev/null +++ b/gcloud/beta/spanner/backup-schedules/get-iam-policy @@ -0,0 +1,111 @@ +NAME + gcloud beta spanner backup-schedules get-iam-policy - get the IAM policy + for a Cloud Spanner backup schedule + +SYNOPSIS + gcloud beta spanner backup-schedules get-iam-policy + (BACKUP_SCHEDULE : --database=DATABASE --instance=INSTANCE) + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) gcloud beta spanner backup-schedules get-iam-policy displays the IAM + policy associated with a Cloud Spanner backup schedule. 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; see $ {parent} + set-iam-policy for additional details. + +EXAMPLES + To print the IAM policy for a given Cloud Spanner backup schedule, run: + + $ gcloud beta spanner backup-schedules get-iam-policy \ + backup-schedule-id --instance=instance-id --database=database-id + +POSITIONAL ARGUMENTS + BackupSchedule resource - The Cloud Spanner backup schedule for which to + display the IAM policy. 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 backup_schedule 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. + + BACKUP_SCHEDULE + ID of the backupSchedule or fully qualified identifier for the + backupSchedule. + + To set the backup_schedule attribute: + ▸ provide the argument backup_schedule on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --database=DATABASE + The name of the Cloud Spanner database. + + To set the database attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --database on the command line. + + --instance=INSTANCE + The name of the Cloud Spanner instance. + + To set the instance attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --instance on the command line; + ▸ set the property spanner/instance. + +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 spanner/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/spanner/ + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud spanner backup-schedules get-iam-policy + + $ gcloud alpha spanner backup-schedules get-iam-policy + diff --git a/gcloud/beta/spanner/backup-schedules/help b/gcloud/beta/spanner/backup-schedules/help new file mode 100644 index 000000000..2457e92b0 --- /dev/null +++ b/gcloud/beta/spanner/backup-schedules/help @@ -0,0 +1,53 @@ +NAME + gcloud beta spanner backup-schedules - manage Cloud Spanner backup + schedules + +SYNOPSIS + gcloud beta spanner backup-schedules COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Manage Cloud Spanner backup schedules. + +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 + (BETA) Add IAM policy binding to a Cloud Spanner backup schedule. + + create + (BETA) Create a Cloud Spanner backup schedule. + + delete + (BETA) Delete a Cloud Spanner backup schedule. + + describe + (BETA) Describe a Cloud Spanner backup schedule. + + get-iam-policy + (BETA) Get the IAM policy for a Cloud Spanner backup schedule. + + list + (BETA) List Cloud Spanner backup schedules. + + remove-iam-policy-binding + (BETA) Remove IAM policy binding of a Cloud Spanner backup schedule. + + set-iam-policy + (BETA) Set the IAM policy for a Cloud Spanner backup schedule. + + update + (BETA) Update a Cloud Spanner backup schedule. + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud spanner backup-schedules + + $ gcloud alpha spanner backup-schedules + diff --git a/gcloud/beta/spanner/backup-schedules/list b/gcloud/beta/spanner/backup-schedules/list new file mode 100644 index 000000000..9203a2c03 --- /dev/null +++ b/gcloud/beta/spanner/backup-schedules/list @@ -0,0 +1,99 @@ +NAME + gcloud beta spanner backup-schedules list - list Cloud Spanner backup + schedules + +SYNOPSIS + gcloud beta spanner backup-schedules list + (--database=DATABASE : --instance=INSTANCE) [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) List Cloud Spanner backup schedules. + +EXAMPLES + To list Cloud Spanner backup schedules, run: + + $ gcloud beta spanner backup-schedules list --instance=instance-id \ + --database=database-id + +REQUIRED FLAGS + Database resource - The Cloud Spanner database in which to list schedules. + 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 --database 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. + + --database=DATABASE + ID of the database or fully qualified identifier for the database. + + To set the database attribute: + ▸ provide the argument --database on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --instance=INSTANCE + The Cloud Spanner instance for the database. + + To set the instance attribute: + ▸ provide the argument --database on the command line with a fully + specified name; + ▸ provide the argument --instance on the command line; + ▸ set the property spanner/instance. + +LIST COMMAND FLAGS + --filter=EXPRESSION + Apply a Boolean filter EXPRESSION to each resource item to be listed. + If the expression evaluates True, then that item is listed. For more + details and examples of filter expressions, run $ gcloud topic filters. + This flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --limit=LIMIT + Maximum number of resources to list. The default is unlimited. This + flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --page-size=PAGE_SIZE + Some services group resource list output into pages. This flag + specifies the maximum number of resources per page. The default is + determined by the service if it supports paging, otherwise it is + unlimited (no paging). Paging may be applied before or after --filter + and --limit depending on the service. + + --sort-by=[FIELD,...] + Comma-separated list of resource field key names to sort by. The + default order is ascending. Prefix a field with ``~'' for descending + order on that field. This flag interacts with other flags that are + applied in this order: --flatten, --sort-by, --filter, --limit. + + --uri + Print a list of resource URIs instead of the default output, and change + the command output to a list of URIs. If this flag is used with + --format, the formatting is applied on this URI list. To display URIs + alongside other keys instead, use the uri() transform. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud spanner backup-schedules list + + $ gcloud alpha spanner backup-schedules list + diff --git a/gcloud/beta/spanner/backup-schedules/remove-iam-policy-binding b/gcloud/beta/spanner/backup-schedules/remove-iam-policy-binding new file mode 100644 index 000000000..7510d5e38 --- /dev/null +++ b/gcloud/beta/spanner/backup-schedules/remove-iam-policy-binding @@ -0,0 +1,164 @@ +NAME + gcloud beta spanner backup-schedules remove-iam-policy-binding - remove IAM + policy binding of a Cloud Spanner backup schedule + +SYNOPSIS + gcloud beta spanner backup-schedules remove-iam-policy-binding + (BACKUP_SCHEDULE : --database=DATABASE --instance=INSTANCE) + --member=PRINCIPAL --role=ROLE + [--all | --condition=[KEY=VALUE,...] + | --condition-from-file=PATH_TO_FILE] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Remove an IAM policy binding of a Cloud Spanner backup schedule. One + binding consists of a member, a role, and an optional condition. + +EXAMPLES + To remove an IAM policy binding for the role of 'roles/editor' for the user + 'test-user@gmail.com', run: + + $ gcloud beta spanner backup-schedules remove-iam-policy-binding \ + backup-schedule-id --instance=instance-id \ + --database=database-id --member='user:test-user@gmail.com' \ + --role='roles/editor' + + To remove an IAM policy binding which expires at the end of the year 2025 + for the role of 'roles/editor' and the user 'test-user@gmail.com', run: + + $ gcloud beta spanner backup-schedules remove-iam-policy-binding \ + backup-schedule-id --instance=instance-id \ + --database=database-id --member='user:test-user@gmail.com' \ + --role='roles/editor' \ + --condition='expression=request.time < + timestamp("2026-01-01T00:00:00Z"),title=expires_end_of_2025,descrip\ + tion=Expires at midnight on 2025-12-31' + + See https://cloud.google.com/iam/docs/managing-policies for details of + policy role and member types. + +POSITIONAL ARGUMENTS + BackupSchedule resource - The Cloud Spanner backup schedule to remove the + 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 backup_schedule 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. + + BACKUP_SCHEDULE + ID of the backupSchedule or fully qualified identifier for the + backupSchedule. + + To set the backup_schedule attribute: + ▸ provide the argument backup_schedule on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --database=DATABASE + The name of the Cloud Spanner database. + + To set the database attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --database on the command line. + + --instance=INSTANCE + The name of the Cloud Spanner instance. + + To set the instance attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --instance on the command line; + ▸ set the property spanner/instance. + +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. + +OPTIONAL FLAGS + At most one of these can be specified: + + --all + Remove all bindings with this role and principal, irrespective of any + conditions. + + --condition=[KEY=VALUE,...] + The condition of the binding that you want to remove. When the + condition is explicitly specified as None (--condition=None), a + binding without a condition is removed. Otherwise, only a binding + with a condition that exactly matches the specified condition + (including the optional description) is removed. For more on + conditions, refer to the conditions overview guide: + https://cloud.google.com/iam/docs/conditions-overview + + When using the --condition flag, include the following key-value + pairs: + + expression + (Required) Condition expression that evaluates to True or False. + This uses a subset of Common Expression Language syntax. + + If the condition expression includes a comma, use a different + delimiter to separate the key-value pairs. Specify the delimiter + before listing the key-value pairs. For example, to specify a + colon (:) as the delimiter, do the following: + --condition=^:^title=TITLE:expression=EXPRESSION. For more + information, see + https://cloud.google.com/sdk/gcloud/reference/topic/escaping. + + title + (Required) A short string describing the purpose of the + expression. + + description + (Optional) Additional description for the expression. + + --condition-from-file=PATH_TO_FILE + Path to a local JSON or YAML file that defines the condition. To see + available fields, see the help for --condition. Use a full or + relative path to a local file containing the value of condition. + +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 spanner/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/spanner/ + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud spanner backup-schedules remove-iam-policy-binding + + $ gcloud alpha spanner backup-schedules remove-iam-policy-binding + diff --git a/gcloud/beta/spanner/backup-schedules/set-iam-policy b/gcloud/beta/spanner/backup-schedules/set-iam-policy new file mode 100644 index 000000000..0334cfaef --- /dev/null +++ b/gcloud/beta/spanner/backup-schedules/set-iam-policy @@ -0,0 +1,93 @@ +NAME + gcloud beta spanner backup-schedules set-iam-policy - set the IAM policy + for a Cloud Spanner backup schedule + +SYNOPSIS + gcloud beta spanner backup-schedules set-iam-policy + (BACKUP_SCHEDULE : --database=DATABASE --instance=INSTANCE) POLICY_FILE + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Set the IAM policy for a Cloud Spanner backup schedule given a + backup schedule ID and a file encoded in JSON or YAML that contains the IAM + policy. + +EXAMPLES + The following command reads an IAM policy defined in a JSON file + policy.json and sets it for a Cloud Spanner backup schedule: + + $ gcloud beta spanner backup-schedules set-iam-policy \ + backup-schedule-id --instance=instance-id \ + --database=database-id policy.json + + See https://cloud.google.com/iam/docs/managing-policies for details of the + policy file format and contents. + +POSITIONAL ARGUMENTS + BackupSchedule resource - The Cloud Spanner backup schedule to set the IAM + policy for. 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 backup_schedule 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. + + BACKUP_SCHEDULE + ID of the backupSchedule or fully qualified identifier for the + backupSchedule. + + To set the backup_schedule attribute: + ▸ provide the argument backup_schedule on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --database=DATABASE + The name of the Cloud Spanner database. + + To set the database attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --database on the command line. + + --instance=INSTANCE + The name of the Cloud Spanner instance. + + To set the instance attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --instance on the command line; + ▸ set the property spanner/instance. + + 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. + +API REFERENCE + This command uses the spanner/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/spanner/ + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud spanner backup-schedules set-iam-policy + + $ gcloud alpha spanner backup-schedules set-iam-policy + diff --git a/gcloud/beta/spanner/backup-schedules/update b/gcloud/beta/spanner/backup-schedules/update new file mode 100644 index 000000000..e7f70777c --- /dev/null +++ b/gcloud/beta/spanner/backup-schedules/update @@ -0,0 +1,154 @@ +NAME + gcloud beta spanner backup-schedules update - update a Cloud Spanner backup + schedule + +SYNOPSIS + gcloud beta spanner backup-schedules update + (BACKUP_SCHEDULE : --database=DATABASE --instance=INSTANCE) + (--cron=CRON --encryption-type=ENCRYPTION_TYPE + --retention-duration=RETENTION_DURATION [--kms-key=KMS_KEY + : --kms-keyring=KMS_KEYRING + --kms-location=KMS_LOCATION --kms-project=KMS_PROJECT]) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Update a Cloud Spanner backup schedule. + +EXAMPLES + To update a Cloud Spanner backup schedule, run: + + $ gcloud beta spanner backup-schedules update backup-schedule-id \ + --instance=instance-id --database=database-id \ + --cron="0 2 * * *" --retention-duration=2w \ + --encryption-type=GOOGLE_DEFAULT_ENCRYPTION + +POSITIONAL ARGUMENTS + Backup schedule resource - The Cloud Spanner backup schedule 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 backup_schedule 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. + + BACKUP_SCHEDULE + ID of the backup-schedule or fully qualified identifier for the + backup-schedule. + + To set the backup-schedule attribute: + ▸ provide the argument backup_schedule on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --database=DATABASE + The Cloud Spanner database for the backup-schedule. + + To set the database attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --database on the command line. + + --instance=INSTANCE + The Cloud Spanner instance for the backup-schedule. + + To set the instance attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --instance on the command line; + ▸ set the property spanner/instance. + +REQUIRED FLAGS + At least one of these must be specified: + + --cron=CRON + Textual representation of the crontab. User can customize the backup + frequency and the backup version time using the cron expression. The + version time must be in UTC timzeone. The backup will contain an + externally consistent copy of the database at the version time. + Allowed frequencies are 12 hour, 1 day, 1 week and 1 month. Examples + of valid cron specifications: * 0 2/12 * * * : every 12 hours at (2, + 14) hours past midnight in UTC. * 0 2,14 * * * : every 12 hours at + (2,14) hours past midnight in UTC. * 0 2 * * * : once a day at 2 past + midnight in UTC. * 0 2 * * 0 : once a week every Sunday at 2 past + midnight in UTC. * 0 2 8 * * : once a month on 8th day at 2 past + midnight in UTC. + + --encryption-type=ENCRYPTION_TYPE + The encryption type of the backup. ENCRYPTION_TYPE must be one of: + + customer-managed-encryption + Use the provided Cloud KMS key for encryption. If this option is + selected, kms-key must be set. + google-default-encryption + Use Google default encryption. + use-database-encryption + Use the same encryption configuration as the database. + + --retention-duration=RETENTION_DURATION + The retention duration of a backup that must be at least 6 hours and + at most 366 days. The backup is eligible to be automatically deleted + once the retention period has elapsed. + + KMS key name group + + At most one of these can be specified: + + Key resource - Cloud KMS key to be used to create the Cloud Spanner + backup. The arguments in this group can be used to specify the + attributes of this resource. + + --kms-key=KMS_KEY + ID of the key or fully qualified identifier for the key. + + To set the kms-key attribute: + ◇ provide the argument --kms-key on the command line. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --kms-keyring=KMS_KEYRING + KMS keyring id of the key. + + To set the kms-keyring attribute: + ◇ provide the argument --kms-key on the command line with a + fully specified name; + ◇ provide the argument --kms-keyring on the command line. + + --kms-location=KMS_LOCATION + Cloud location for the key. + + To set the kms-location attribute: + ◇ provide the argument --kms-key on the command line with a + fully specified name; + ◇ provide the argument --kms-location on the command line. + + --kms-project=KMS_PROJECT + Cloud project id for the key. + + To set the kms-project attribute: + ◇ provide the argument --kms-key on the command line with a + fully specified name; + ◇ provide the argument --kms-project on the command line. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud spanner backup-schedules update + + $ gcloud alpha spanner backup-schedules update + diff --git a/gcloud/beta/spanner/help b/gcloud/beta/spanner/help index cf25f0434..892eddbf8 100644 --- a/gcloud/beta/spanner/help +++ b/gcloud/beta/spanner/help @@ -15,6 +15,9 @@ GCLOUD WIDE FLAGS GROUPS GROUP is one of the following: + backup-schedules + (BETA) Manage Cloud Spanner backup schedules. + backups (BETA) Manage Cloud Spanner backups. diff --git a/gcloud/beta/sql/instances/switchover b/gcloud/beta/sql/instances/switchover index 10008f08b..b3cf8325f 100644 --- a/gcloud/beta/sql/instances/switchover +++ b/gcloud/beta/sql/instances/switchover @@ -7,8 +7,7 @@ SYNOPSIS [--db-timeout=DB_TIMEOUT] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Switches over a Cloud SQL instance to one of its replicas. Only - supported on Cloud SQL for SQL Server and MySQL instances. + (BETA) Switches over a Cloud SQL instance to one of its replicas. EXAMPLES To switch over an instance to its replica called replica-instance: diff --git a/gcloud/beta/sql/ssl/server-ca-certs/create b/gcloud/beta/sql/ssl/server-ca-certs/create index e511743ec..003de3d21 100644 --- a/gcloud/beta/sql/ssl/server-ca-certs/create +++ b/gcloud/beta/sql/ssl/server-ca-certs/create @@ -27,8 +27,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 ssl server-ca-certs create $ gcloud alpha sql ssl server-ca-certs create diff --git a/gcloud/beta/sql/ssl/server-ca-certs/help b/gcloud/beta/sql/ssl/server-ca-certs/help index 2ce017163..4b37c12b7 100644 --- a/gcloud/beta/sql/ssl/server-ca-certs/help +++ b/gcloud/beta/sql/ssl/server-ca-certs/help @@ -32,8 +32,10 @@ COMMANDS (BETA) Rotate in the upcoming server CA cert for a Cloud SQL instance. 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 ssl server-ca-certs $ gcloud alpha sql ssl server-ca-certs diff --git a/gcloud/beta/sql/ssl/server-ca-certs/list b/gcloud/beta/sql/ssl/server-ca-certs/list index 85943c0cc..e8a45e53c 100644 --- a/gcloud/beta/sql/ssl/server-ca-certs/list +++ b/gcloud/beta/sql/ssl/server-ca-certs/list @@ -55,8 +55,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 ssl server-ca-certs list $ gcloud alpha sql ssl server-ca-certs list diff --git a/gcloud/beta/sql/ssl/server-ca-certs/rollback b/gcloud/beta/sql/ssl/server-ca-certs/rollback index 51fe5567d..4ed03cb5b 100644 --- a/gcloud/beta/sql/ssl/server-ca-certs/rollback +++ b/gcloud/beta/sql/ssl/server-ca-certs/rollback @@ -27,8 +27,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 ssl server-ca-certs rollback $ gcloud alpha sql ssl server-ca-certs rollback diff --git a/gcloud/beta/sql/ssl/server-ca-certs/rotate b/gcloud/beta/sql/ssl/server-ca-certs/rotate index 7bfa71f32..4416188da 100644 --- a/gcloud/beta/sql/ssl/server-ca-certs/rotate +++ b/gcloud/beta/sql/ssl/server-ca-certs/rotate @@ -27,8 +27,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 ssl server-ca-certs rotate $ gcloud alpha sql ssl server-ca-certs rotate diff --git a/gcloud/compute/scp b/gcloud/compute/scp index 1eec19245..3ea6f1697 100644 --- a/gcloud/compute/scp +++ b/gcloud/compute/scp @@ -31,6 +31,8 @@ DESCRIPTION be from the same virtual machine. ▪ When the destination of your transfer is remote instead, all sources must be local. + ▪ When the destination is Windows Server, the source must be using a + similar SSH version. Under the covers, scp(1) is used to facilitate the transfer. diff --git a/gcloud/compute/tpus/queued-resources/create b/gcloud/compute/tpus/queued-resources/create index 9836934e1..069aa42c2 100644 --- a/gcloud/compute/tpus/queued-resources/create +++ b/gcloud/compute/tpus/queued-resources/create @@ -10,16 +10,17 @@ SYNOPSIS [--data-disk=[mode=MODE],[source=SOURCE]] [--description=DESCRIPTION] [--guaranteed] [--internal-ips] [--labels=[KEY=VALUE,...]] [--metadata=[KEY=VALUE,...]] [--metadata-from-file=[KEY=VALUE,...]] - [--network=NETWORK; default="default"] [--range=RANGE] - [--reservation-host-folder=RESERVATION_HOST_FOLDER] - [--reservation-host-organization=RESERVATION_HOST_ORGANIZATION] - [--reservation-host-project=RESERVATION_HOST_PROJECT] [--reserved] + [--network=NETWORK; default="default"] [--range=RANGE] [--reserved] [--scopes=[SCOPES,...]] [--service-account=SERVICE_ACCOUNT] [--shielded-secure-boot] [--spot] [--subnetwork=SUBNETWORK] [--tags=[TAGS,...]] [--valid-after-duration=VALID_AFTER_DURATION] [--valid-after-time=VALID_AFTER_TIME] [--valid-until-duration=VALID_UNTIL_DURATION] - [--valid-until-time=VALID_UNTIL_TIME] [GCLOUD_WIDE_FLAG ...] + [--valid-until-time=VALID_UNTIL_TIME] + [--reservation-host-folder=RESERVATION_HOST_FOLDER + --reservation-host-organization=RESERVATION_HOST_ORGANIZATION + --reservation-host-project=RESERVATION_HOST_PROJECT] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION Create a new Queued Resource with the specified attributes. @@ -195,18 +196,6 @@ OPTIONAL FLAGS network, or the provided network is peered with another network that is using that CIDR range. - --reservation-host-folder=RESERVATION_HOST_FOLDER - The folder hosting the reservation that the TPU should use. Only one - reservation host entity may be specified. - - --reservation-host-organization=RESERVATION_HOST_ORGANIZATION - The organization hosting the reservation that the TPU should use. Only - one reservation host entity may be specified. - - --reservation-host-project=RESERVATION_HOST_PROJECT - The project hosting the reservation that the TPU should use. Only one - reservation host entity may be specified. - --reserved Specifies the request should be scheduled on reserved capacity. @@ -256,6 +245,18 @@ OPTIONAL FLAGS An absolute time after which resources must not be created. See $ gcloud topic datetimes for information on duration formats. + --reservation-host-folder=RESERVATION_HOST_FOLDER + The folder hosting the reservation that the TPU should use. Only one + reservation host entity may be specified. + + --reservation-host-organization=RESERVATION_HOST_ORGANIZATION + The organization hosting the reservation that the TPU should use. Only + one reservation host entity may be specified. + + --reservation-host-project=RESERVATION_HOST_PROJECT + The project hosting the reservation that the TPU should use. Only one + reservation host entity may be specified. + 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/container/clusters/create b/gcloud/container/clusters/create index b0d0fb77e..713d490d5 100644 --- a/gcloud/container/clusters/create +++ b/gcloud/container/clusters/create @@ -26,10 +26,10 @@ SYNOPSIS [--disk-type=DISK_TYPE] [--enable-autorepair] [--no-enable-autoupgrade] [--enable-cilium-clusterwide-network-policy] [--enable-cloud-logging] [--enable-cloud-monitoring] [--enable-cloud-run-alpha] - [--enable-confidential-nodes] [--enable-cost-allocation] - [--enable-dataplane-v2] [--enable-fleet] [--enable-fqdn-network-policy] - [--enable-google-cloud-access] [--enable-gvnic] - [--enable-identity-service] [--enable-image-streaming] + [--enable-confidential-nodes] [--enable-confidential-storage] + [--enable-cost-allocation] [--enable-dataplane-v2] [--enable-fleet] + [--enable-fqdn-network-policy] [--enable-google-cloud-access] + [--enable-gvnic] [--enable-identity-service] [--enable-image-streaming] [--enable-insecure-kubelet-readonly-port] [--enable-intra-node-visibility] [--enable-ip-alias] [--enable-kubernetes-alpha] @@ -493,6 +493,10 @@ FLAGS will create nodes using Confidential VM https://cloud.google.com/compute/confidential-vm/docs/about-cvm. + --enable-confidential-storage + Enable confidential storage for the cluster. Enabling Confidential + Storage will create boot disk with confidential mode + --enable-cost-allocation Enable the cost management feature. diff --git a/gcloud/container/fleet/mesh/update b/gcloud/container/fleet/mesh/update index 28e765a2b..763343f2f 100644 --- a/gcloud/container/fleet/mesh/update +++ b/gcloud/container/fleet/mesh/update @@ -41,7 +41,7 @@ REQUIRED FLAGS The --control-plane flag is now deprecated. Please use --management instead. See https://cloud.google.com/service-mesh/docs/managed/provision-managed-anthos-service-mesh. - CONTROL_PLANE must be one of: automatic, manual. + CONTROL_PLANE must be one of: automatic, manual, unspecified. --management=MANAGEMENT The management mode to update to. MANAGEMENT must be one of: diff --git a/gcloud/container/hub/mesh/update b/gcloud/container/hub/mesh/update index 2861336b5..274688f07 100644 --- a/gcloud/container/hub/mesh/update +++ b/gcloud/container/hub/mesh/update @@ -41,7 +41,7 @@ REQUIRED FLAGS The --control-plane flag is now deprecated. Please use --management instead. See https://cloud.google.com/service-mesh/docs/managed/provision-managed-anthos-service-mesh. - CONTROL_PLANE must be one of: automatic, manual. + CONTROL_PLANE must be one of: automatic, manual, unspecified. --management=MANAGEMENT The management mode to update to. MANAGEMENT must be one of: diff --git a/gcloud/container/node-pools/create b/gcloud/container/node-pools/create index bc632ca82..929573550 100644 --- a/gcloud/container/node-pools/create +++ b/gcloud/container/node-pools/create @@ -19,8 +19,8 @@ SYNOPSIS [--disk-type=DISK_TYPE] [--enable-autoprovisioning] [--enable-autorepair] [--no-enable-autoupgrade] [--enable-blue-green-upgrade] [--enable-confidential-nodes] - [--enable-gvnic] [--enable-image-streaming] - [--enable-insecure-kubelet-readonly-port] + [--enable-confidential-storage] [--enable-gvnic] + [--enable-image-streaming] [--enable-insecure-kubelet-readonly-port] [--enable-nested-virtualization] [--enable-private-nodes] [--enable-queued-provisioning] [--enable-surge-upgrade] [--image-type=IMAGE_TYPE] [--labels=[KEY=VALUE,...]] @@ -247,6 +247,10 @@ FLAGS Nodes will create nodes using Confidential VM https://cloud.google.com/compute/confidential-vm/docs/about-cvm. + --enable-confidential-storage + Enable confidential storage for the node pool. Enabling Confidential + Storage will create boot disk with confidential mode + --enable-gvnic Enable the use of GVNIC for this cluster. Requires re-creation of nodes using either a node-pool upgrade or node-pool creation. diff --git a/gcloud/database-migration/connection-profiles/create/alloydb b/gcloud/database-migration/connection-profiles/create/alloydb index 8d53715b2..2d00b5190 100644 --- a/gcloud/database-migration/connection-profiles/create/alloydb +++ b/gcloud/database-migration/connection-profiles/create/alloydb @@ -6,8 +6,10 @@ SYNOPSIS gcloud database-migration connection-profiles create alloydb (CONNECTION_PROFILE : --region=REGION) --cpu-count=CPU_COUNT --password=PASSWORD --primary-id=PRIMARY_ID [--no-async] + [--authorized-network-cidr-ranges=[NETWORK,...]] [--cluster-labels=[KEY=VALUE,...]] [--database-flags=[FLAG=VALUE,...]] [--database-version=DATABASE_VERSION] [--display-name=DISPLAY_NAME] + [--enable-outbound-public-ip] [--enable-public-ip] [--labels=[KEY=VALUE,...]] [--network=NETWORK] [--primary-labels=[KEY=VALUE,...]] [--kms-key=KMS_KEY @@ -74,6 +76,10 @@ OPTIONAL FLAGS --no-async Waits for the operation in progress to complete before returning. + --authorized-network-cidr-ranges=[NETWORK,...] + Comma-separated list of CIDR ranges that can connect to the AlloyDB + instance. + --cluster-labels=[KEY=VALUE,...] The resource labels for an AlloyDB cluster. An object containing a list of "key": "value" pairs. @@ -95,6 +101,13 @@ OPTIONAL FLAGS include letters, numbers, spaces, and hyphens, and must start with a letter. + --enable-outbound-public-ip + If true, Enables an outbound public IP address to support a database + server sending requests out into the internet. + + --enable-public-ip + If true, the AlloyDB instance will be accessible via public IP. + --labels=[KEY=VALUE,...] List of label KEY=VALUE pairs to add. diff --git a/gcloud/deploy/deploy-policies/describe b/gcloud/deploy/deploy-policies/describe index b769642f2..b07c6787a 100644 --- a/gcloud/deploy/deploy-policies/describe +++ b/gcloud/deploy/deploy-policies/describe @@ -1,23 +1,25 @@ NAME - gcloud deploy deploy-policies describe - show details for a deploy policy + gcloud deploy deploy-policies describe - show details about a deploy policy SYNOPSIS gcloud deploy deploy-policies describe (DEPLOY_POLICY : --region=REGION) [GCLOUD_WIDE_FLAG ...] DESCRIPTION - Show details for a specified deploy policy. + Show details about a deploy policy. EXAMPLES - To show details about a deploy policy test-policy in region us-central, - run: $ gcloud deploy deploy-policies describe test-policy \ + To describe a deploy policy called 'test-policy' in region 'us-central1', + run: + + $ gcloud deploy deploy-policies describe test-policy \ --region=us-central1 POSITIONAL ARGUMENTS - Deploy policy resource - The name of the deploy policy 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. + Deploy policy resource - The name of the Deploy Policy. 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 deploy_policy on the command line with a fully @@ -38,7 +40,8 @@ POSITIONAL ARGUMENTS arguments in this group are specified. --region=REGION - Location of the deploy policy. + The Cloud region for the deploy policy. Alternatively, set the + property [deploy/region]. To set the region attribute: ▸ provide the argument deploy_policy on the command line with a @@ -54,10 +57,6 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. -API REFERENCE - This command uses the clouddeploy/v1 API. The full documentation for this - API can be found at: https://cloud.google.com/deploy/ - NOTES These variants are also available: diff --git a/gcloud/deploy/deploy-policies/export b/gcloud/deploy/deploy-policies/export index 8bbd17ef3..720f35387 100644 --- a/gcloud/deploy/deploy-policies/export +++ b/gcloud/deploy/deploy-policies/export @@ -31,8 +31,8 @@ POSITIONAL ARGUMENTS This must be specified. DEPLOY_POLICY - ID of the deploy_policy or fully qualified identifier for the - deploy_policy. + ID of the deploy policy or fully qualified identifier for the deploy + policy. To set the deploy_policy attribute: ▸ provide the argument deploy_policy on the command line. @@ -41,7 +41,7 @@ POSITIONAL ARGUMENTS arguments in this group are specified. --region=REGION - The Cloud region for the deploy_policy. Alternatively, set the + The Cloud region for the deploy policy. Alternatively, set the property [deploy/region]. To set the region attribute: diff --git a/gcloud/deploy/deploy-policies/help b/gcloud/deploy/deploy-policies/help index bcba28d4a..a4c8ea964 100644 --- a/gcloud/deploy/deploy-policies/help +++ b/gcloud/deploy/deploy-policies/help @@ -20,7 +20,7 @@ COMMANDS Delete a deploy policy. describe - Show details for a deploy policy. + Show details about a deploy policy. export Returns the .yaml definition of the specified deploy policy. diff --git a/gcloud/filestore/instances/create b/gcloud/filestore/instances/create index e71c33f5d..68ce57e5b 100644 --- a/gcloud/filestore/instances/create +++ b/gcloud/filestore/instances/create @@ -28,10 +28,9 @@ EXAMPLES --tier=TIER --file-share=name=VOLUME_NAME,capacity=CAPACITY \ --network=name=NETWORK_NAME,\ reserved-ip-range=RESERVED_IP_RANGE,connect-mode=CONNECT_MODE \ - --zone=ZONE --performance=PERFORMANCE --kms-key=KMS-KEY \ - --kms-keyring=KMS_KEYRING --kms-location=KMS_LOCATION \ - --kms-project=KMS_PROJECT --flags-file=FLAGS_FILE \ - --source-instance=SOURCE_INSTANCE + --zone=ZONE --kms-key=KMS-KEY --kms-keyring=KMS_KEYRING \ + --kms-location=KMS_LOCATION --kms-project=KMS_PROJECT \ + --flags-file=FLAGS_FILE --source-instance=SOURCE_INSTANCE Example json configuration file: { "--file-share": { "capacity": "61440", diff --git a/gcloud/iap/settings/get b/gcloud/iap/settings/get index 5c75c5f4a..5a6e8abfe 100644 --- a/gcloud/iap/settings/get +++ b/gcloud/iap/settings/get @@ -73,9 +73,9 @@ FLAGS Project ID. --region=REGION - Region name. Not applicable for app-engine. Required when resource-type - is compute and regional scoped. Not applicable for compute when global - scoped. + Region name. Not applicable for app-engine. Required when + resource-type=compute and regional scoped. Not applicable for global + scoped compute. --resource-type=RESOURCE_TYPE Resource type of the IAP resource. RESOURCE_TYPE must be one of: @@ -85,8 +85,8 @@ FLAGS Service name. Optional when resource-type is compute or app-engine. --version=VERSION - Version name. Not applicable for compute. Optional when resource-type - is app-engine. + Version name. Not applicable for compute. Optional when + resource-type=app-engine. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/iap/settings/set b/gcloud/iap/settings/set index 014047eda..dd097936c 100644 --- a/gcloud/iap/settings/set +++ b/gcloud/iap/settings/set @@ -121,9 +121,9 @@ FLAGS Project ID. --region=REGION - Region name. Not applicable for app-engine. Required when resource-type - is compute and regional scoped. Not applicable for compute when global - scoped. + Region name. Not applicable for app-engine. Required when + resource-type=compute and regional scoped. Not applicable for global + scoped compute. --resource-type=RESOURCE_TYPE Resource type of the IAP resource. RESOURCE_TYPE must be one of: @@ -133,8 +133,8 @@ FLAGS Service name. Optional when resource-type is compute or app-engine. --version=VERSION - Version name. Not applicable for compute. Optional when resource-type - is app-engine. + Version name. Not applicable for compute. Optional when + resource-type=app-engine. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/logging/settings/update b/gcloud/logging/settings/update index ba777ebbd..3866a9a75 100644 --- a/gcloud/logging/settings/update +++ b/gcloud/logging/settings/update @@ -60,7 +60,7 @@ EXAMPLES To enable analytics for the log buckets under an organization, run: $ gcloud logging settings update --organization=[ORGANIZATION_ID] \ - --disable-default-sink=false --analytics-mode=enabled + --disable-default-sink=false --analytics-mode=required REQUIRED FLAGS Exactly one of these must be specified: diff --git a/gcloud/netapp/volumes/replications/create b/gcloud/netapp/volumes/replications/create index 7bebb4729..8dcdde684 100644 --- a/gcloud/netapp/volumes/replications/create +++ b/gcloud/netapp/volumes/replications/create @@ -9,8 +9,8 @@ SYNOPSIS [share_name=SHARE_NAME], [storage_pool=STORAGE_POOL],[volume_id=VOLUME_ID] --replication-schedule=REPLICATION_SCHEDULE [--async] - [--cluster-location=CLUSTER_LOCATION] [--description=DESCRIPTION] - [--labels=[KEY=VALUE,...]] [--volume=VOLUME] [GCLOUD_WIDE_FLAG ...] + [--description=DESCRIPTION] [--labels=[KEY=VALUE,...]] + [--volume=VOLUME] [GCLOUD_WIDE_FLAG ...] DESCRIPTION Create a Cloud NetApp Volume Replication. @@ -73,9 +73,6 @@ OPTIONAL FLAGS Return immediately, without waiting for the operation in progress to complete. - --cluster-location=CLUSTER_LOCATION - Location of the user cluster. - --description=DESCRIPTION A description of the Cloud NetApp Replication diff --git a/gcloud/netapp/volumes/replications/update b/gcloud/netapp/volumes/replications/update index dc3f37153..490bb27b3 100644 --- a/gcloud/netapp/volumes/replications/update +++ b/gcloud/netapp/volumes/replications/update @@ -5,7 +5,7 @@ NAME SYNOPSIS gcloud netapp volumes replications update (REPLICATION : --location=LOCATION) [--async] - [--cluster-location=CLUSTER_LOCATION] [--description=DESCRIPTION] + [--description=DESCRIPTION] [--replication-schedule=REPLICATION_SCHEDULE] [--update-labels=[KEY=VALUE,...]] [--volume=VOLUME] [--clear-labels | --remove-labels=[KEY,...]] [GCLOUD_WIDE_FLAG ...] @@ -65,9 +65,6 @@ FLAGS Return immediately, without waiting for the operation in progress to complete. - --cluster-location=CLUSTER_LOCATION - Location of the user cluster. - --description=DESCRIPTION A description of the Cloud NetApp Replication diff --git a/gcloud/network-connectivity/internal-ranges/create b/gcloud/network-connectivity/internal-ranges/create index f873855ec..50f7c161b 100644 --- a/gcloud/network-connectivity/internal-ranges/create +++ b/gcloud/network-connectivity/internal-ranges/create @@ -9,7 +9,9 @@ SYNOPSIS : --target-cidr-range=[TARGET_CIDR_RANGE,...]]) [--async] [--description=DESCRIPTION] [--labels=[KEY=VALUE,...]] [--overlaps=[OVERLAPS,...]] [--peering=PEERING; default="for-self"] - [--usage=USAGE; default="for-vpc"] [GCLOUD_WIDE_FLAG ...] + [--usage=USAGE; default="for-vpc"] + [--migration-source=MIGRATION_SOURCE + --migration-target=MIGRATION_TARGET] [GCLOUD_WIDE_FLAG ...] DESCRIPTION Create a new internal range with the given name. @@ -155,6 +157,29 @@ OPTIONAL FLAGS A cloud resource can use the reserved CIDR block by associating it with the internal range resource if usage is set to FOR_VPC. + Endpoints of a for-migration internal range. This is only applicable when + --usage is set to for-migration. Both MIGRATION_SOURCE and + MIGRATION_TARGET must either belong to the same VPC or their VPCs must be + peered (they may then even belong to different projects). MIGRATION_SOURCE + must belong to the VPC network specifed by the --network flag. + MIGRATION_TARGET may name a subnetwork which does not exist yet; it must + be a valid resource path, and parent resources (network and project) and + their locations must exist. + + --migration-source=MIGRATION_SOURCE + The migration source subnetwork (of a for-migration internal range) + resource URI or resource ID. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --migration-target=MIGRATION_TARGET + The migration target subnetwork (of a for-migration internal range) + resource URI or resource ID. + + This flag argument must be specified if any of the other arguments in + this group are specified. + 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/policy-intelligence/help b/gcloud/policy-intelligence/help index 1769b82f6..27ba0fdaa 100644 --- a/gcloud/policy-intelligence/help +++ b/gcloud/policy-intelligence/help @@ -1,12 +1,12 @@ NAME - gcloud policy-intelligence - a platform to help better understand, use and + gcloud policy-intelligence - a platform to help better understand, use, and manage policies at scale SYNOPSIS gcloud policy-intelligence GROUP | COMMAND [GCLOUD_WIDE_FLAG ...] DESCRIPTION - A platform to help better understand, use and manage policies at scale. + A platform to help better understand, use, and manage policies at scale. GCLOUD WIDE FLAGS These flags are available to all commands: --help. diff --git a/gcloud/pubsub/subscriptions/create b/gcloud/pubsub/subscriptions/create index b48a65116..2acbcdf35 100644 --- a/gcloud/pubsub/subscriptions/create +++ b/gcloud/pubsub/subscriptions/create @@ -123,7 +123,7 @@ OPTIONAL FLAGS backlog, from the moment a message is published. If --retain-acked-messages is true, this also configures the retention of acknowledged messages. The default value is 7 days, the minimum is 10 - minutes, and the maximum is 7 days. Valid values are strings of the + minutes, and the maximum is 31 days. Valid values are strings of the form INTEGER[UNIT], where UNIT is one of "s", "m", "h", and "d" for seconds, minutes, hours, and days, respectively. If the unit is omitted, seconds is assumed. @@ -209,7 +209,7 @@ OPTIONAL FLAGS --cloud-storage-max-bytes=CLOUD_STORAGE_MAX_BYTES The maximum bytes that can be written to a Cloud Storage file - before a new file is created. The value must be between 1KB to + before a new file is created. The value must be between 1000B and 10GB. If the unit is omitted, KB is assumed. --cloud-storage-max-duration=CLOUD_STORAGE_MAX_DURATION diff --git a/gcloud/pubsub/subscriptions/update b/gcloud/pubsub/subscriptions/update index 4b4453e71..e2cb73f27 100644 --- a/gcloud/pubsub/subscriptions/update +++ b/gcloud/pubsub/subscriptions/update @@ -77,7 +77,7 @@ FLAGS backlog, from the moment a message is published. If --retain-acked-messages is true, this also configures the retention of acknowledged messages. Specify "default" to use the default value of 7 - days. The minimum is 10 minutes, and the maximum is 7 days. Valid + days. The minimum is 10 minutes, and the maximum is 31 days. Valid values are strings of the form INTEGER[UNIT], where UNIT is one of "s", "m", "h", and "d" for seconds, minutes, hours, and days, respectively. If the unit is omitted, seconds is assumed. @@ -197,7 +197,7 @@ FLAGS --cloud-storage-max-bytes=CLOUD_STORAGE_MAX_BYTES The maximum bytes that can be written to a Cloud Storage file - before a new file is created. The value must be between 1KB to + before a new file is created. The value must be between 1000B and 10GB. If the unit is omitted, KB is assumed. --cloud-storage-max-duration=CLOUD_STORAGE_MAX_DURATION diff --git a/gcloud/run/deploy b/gcloud/run/deploy index 59687c2ff..12c1737fc 100644 --- a/gcloud/run/deploy +++ b/gcloud/run/deploy @@ -28,8 +28,8 @@ SYNOPSIS --description=DESCRIPTION --execution-environment=EXECUTION_ENVIRONMENT --remove-containers=[CONTAINER,...] --revision-suffix=REVISION_SUFFIX - --[no-]session-affinity --vpc-connector=VPC_CONNECTOR - --vpc-egress=VPC_EGRESS + --service-min-instances=SERVICE_MIN_INSTANCES --[no-]session-affinity + --vpc-connector=VPC_CONNECTOR --vpc-egress=VPC_EGRESS --add-cloudsql-instances=[CLOUDSQL-INSTANCES,...] | --clear-cloudsql-instances | --remove-cloudsql-instances=[CLOUDSQL-INSTANCES,...] @@ -455,6 +455,11 @@ FLAGS to a revision named 'helloworld-v1'. Set empty string to clear the suffix and resume server-assigned naming. + --service-min-instances=SERVICE_MIN_INSTANCES + The minimum number of container instances for this Service to run or + 'default' to remove any minimum. These instances will be divided + among all Revisions receiving a percentage of traffic. + --[no-]session-affinity Whether to enable session affinity for connections to the service. Use --session-affinity to enable and --no-session-affinity to diff --git a/gcloud/run/services/update b/gcloud/run/services/update index 70ab3b888..e7cfbaa3d 100644 --- a/gcloud/run/services/update +++ b/gcloud/run/services/update @@ -22,8 +22,8 @@ SYNOPSIS [--breakglass=JUSTIFICATION --clear-vpc-connector --[no-]cpu-boost --[no-]cpu-throttling --execution-environment=EXECUTION_ENVIRONMENT --remove-containers=[CONTAINER,...] --revision-suffix=REVISION_SUFFIX - --[no-]session-affinity --vpc-connector=VPC_CONNECTOR - --vpc-egress=VPC_EGRESS + --service-min-instances=SERVICE_MIN_INSTANCES --[no-]session-affinity + --vpc-connector=VPC_CONNECTOR --vpc-egress=VPC_EGRESS --add-cloudsql-instances=[CLOUDSQL-INSTANCES,...] | --clear-cloudsql-instances | --remove-cloudsql-instances=[CLOUDSQL-INSTANCES,...] @@ -337,6 +337,11 @@ FLAGS to a revision named 'helloworld-v1'. Set empty string to clear the suffix and resume server-assigned naming. + --service-min-instances=SERVICE_MIN_INSTANCES + The minimum number of container instances for this Service to run or + 'default' to remove any minimum. These instances will be divided + among all Revisions receiving a percentage of traffic. + --[no-]session-affinity Whether to enable session affinity for connections to the service. Use --session-affinity to enable and --no-session-affinity to diff --git a/gcloud/spanner/backup-schedules/add-iam-policy-binding b/gcloud/spanner/backup-schedules/add-iam-policy-binding new file mode 100644 index 000000000..c82caad96 --- /dev/null +++ b/gcloud/spanner/backup-schedules/add-iam-policy-binding @@ -0,0 +1,158 @@ +NAME + gcloud spanner backup-schedules add-iam-policy-binding - add IAM policy + binding to a Cloud Spanner backup schedule + +SYNOPSIS + gcloud spanner backup-schedules add-iam-policy-binding + (BACKUP_SCHEDULE : --database=DATABASE --instance=INSTANCE) + --member=PRINCIPAL --role=ROLE + [--condition=[KEY=VALUE,...] | --condition-from-file=PATH_TO_FILE] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Add an IAM policy binding to a Cloud Spanner backup schedule. One binding + consists of a member, a role, and an optional condition. + +EXAMPLES + To add an IAM policy binding for the role of 'roles/editor' for the user + 'test-user@gmail.com', run: + + $ gcloud spanner backup-schedules add-iam-policy-binding \ + backup-schedule-id --instance=instance-id \ + --database=database-id --member='user:test-user@gmail.com' \ + --role='roles/editor' + + To add an IAM policy binding which expires at the end of the year 2025 for + the role of 'roles/editor' and the user 'test-user@gmail.com', run: + + $ gcloud spanner backup-schedules add-iam-policy-binding \ + backup-schedule-id --instance=instance-id \ + --database=database-id --member='user:test-user@gmail.com' \ + --role='roles/editor' \ + --condition='expression=request.time < + timestamp("2026-01-01T00:00:00Z"),title=expires_end_of_2025,descrip\ + tion=Expires at midnight on 2025-12-31' + + See https://cloud.google.com/iam/docs/managing-policies for details of + policy role and member types. + +POSITIONAL ARGUMENTS + BackupSchedule resource - The Cloud Spanner backup schedule to which to + add the IAM policy binding. 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 backup_schedule 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. + + BACKUP_SCHEDULE + ID of the backupSchedule or fully qualified identifier for the + backupSchedule. + + To set the backup_schedule attribute: + ▸ provide the argument backup_schedule on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --database=DATABASE + The name of the Cloud Spanner database. + + To set the database attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --database on the command line. + + --instance=INSTANCE + The name of the Cloud Spanner instance. + + To set the instance attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --instance on the command line; + ▸ set the property spanner/instance. + +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. + +OPTIONAL FLAGS + At most one of these can be specified: + + --condition=[KEY=VALUE,...] + A condition to include in the binding. When the condition is + explicitly specified as None (--condition=None), a binding without a + condition is added. When the condition is specified and is not None, + --role cannot be a basic role. Basic roles are roles/editor, + roles/owner, and roles/viewer. For more on conditions, refer to the + conditions overview guide: + https://cloud.google.com/iam/docs/conditions-overview + + When using the --condition flag, include the following key-value + pairs: + + expression + (Required) Condition expression that evaluates to True or False. + This uses a subset of Common Expression Language syntax. + + If the condition expression includes a comma, use a different + delimiter to separate the key-value pairs. Specify the delimiter + before listing the key-value pairs. For example, to specify a + colon (:) as the delimiter, do the following: + --condition=^:^title=TITLE:expression=EXPRESSION. For more + information, see + https://cloud.google.com/sdk/gcloud/reference/topic/escaping. + + title + (Required) A short string describing the purpose of the + expression. + + description + (Optional) Additional description for the expression. + + --condition-from-file=PATH_TO_FILE + Path to a local JSON or YAML file that defines the condition. To see + available fields, see the help for --condition. Use a full or + relative path to a local file containing the value of condition. + +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 spanner/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/spanner/ + +NOTES + These variants are also available: + + $ gcloud alpha spanner backup-schedules add-iam-policy-binding + + $ gcloud beta spanner backup-schedules add-iam-policy-binding + diff --git a/gcloud/spanner/backup-schedules/create b/gcloud/spanner/backup-schedules/create new file mode 100644 index 000000000..42c7ebc88 --- /dev/null +++ b/gcloud/spanner/backup-schedules/create @@ -0,0 +1,165 @@ +NAME + gcloud spanner backup-schedules create - create a Cloud Spanner backup + schedule + +SYNOPSIS + gcloud spanner backup-schedules create + (BACKUP_SCHEDULE : --database=DATABASE --instance=INSTANCE) + --backup-type=[BACKUP_TYPE] --cron=CRON + --retention-duration=RETENTION_DURATION + [--encryption-type=ENCRYPTION_TYPE [--kms-key=KMS_KEY + : --kms-keyring=KMS_KEYRING + --kms-location=KMS_LOCATION --kms-project=KMS_PROJECT]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a Cloud Spanner backup schedule. + +EXAMPLES + To create a Cloud Spanner backup schedule, run: + + $ gcloud spanner backup-schedules create backup-schedule-id \ + --instance=instance-id --database=database-id \ + --cron="0 2 * * *" --retention-duration=2w \ + --backup-type=full-backup + +POSITIONAL ARGUMENTS + Backup schedule resource - The Cloud Spanner backup schedule 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 backup_schedule 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. + + BACKUP_SCHEDULE + ID of the backup-schedule or fully qualified identifier for the + backup-schedule. + + To set the backup-schedule attribute: + ▸ provide the argument backup_schedule on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --database=DATABASE + The Cloud Spanner database for the backup-schedule. + + To set the database attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --database on the command line. + + --instance=INSTANCE + The Cloud Spanner instance for the backup-schedule. + + To set the instance attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --instance on the command line; + ▸ set the property spanner/instance. + +REQUIRED FLAGS + --backup-type=[BACKUP_TYPE] + Type of backups created by this schedule. + + Supported backup types: + + full-backup A full backup stores the entire contents of the database at + a given version time. + + incremental-backup An incremental backup contains only the data that + has changed since a previous backup. + + BACKUP_TYPE must be one of: full-backup, incremental-backup. + + --cron=CRON + Textual representation of the crontab. User can customize the backup + frequency and the backup version time using the cron expression. The + version time must be in UTC timzeone. The backup will contain an + externally consistent copy of the database at the version time. Allowed + frequencies are 12 hour, 1 day, 1 week and 1 month. Examples of valid + cron specifications: * 0 2/12 * * * : every 12 hours at (2, 14) hours + past midnight in UTC. * 0 2,14 * * * : every 12 hours at (2,14) hours + past midnight in UTC. * 0 2 * * * : once a day at 2 past midnight in + UTC. * 0 2 * * 0 : once a week every Sunday at 2 past midnight in UTC. + * 0 2 8 * * : once a month on 8th day at 2 past midnight in UTC. + + --retention-duration=RETENTION_DURATION + The retention duration of a backup that must be at least 6 hours and at + most 366 days. The backup is eligible to be automatically deleted once + the retention period has elapsed. + +OPTIONAL FLAGS + --encryption-type=ENCRYPTION_TYPE + The encryption type of the backup. ENCRYPTION_TYPE must be one of: + + customer-managed-encryption + Use the provided Cloud KMS key for encryption. If this option is + selected, kms-key must be set. + google-default-encryption + Use Google default encryption. + use-database-encryption + Use the same encryption configuration as the database. + + KMS key name group + + At most one of these can be specified: + + Key resource - Cloud KMS key to be used to create the Cloud Spanner + backup. The arguments in this group can be used to specify the + attributes of this resource. + + --kms-key=KMS_KEY + ID of the key or fully qualified identifier for the key. + + To set the kms-key attribute: + ▫ provide the argument --kms-key on the command line. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --kms-keyring=KMS_KEYRING + KMS keyring id of the key. + + To set the kms-keyring attribute: + ▫ provide the argument --kms-key on the command line with a fully + specified name; + ▫ provide the argument --kms-keyring on the command line. + + --kms-location=KMS_LOCATION + Cloud location for the key. + + To set the kms-location attribute: + ▫ provide the argument --kms-key on the command line with a fully + specified name; + ▫ provide the argument --kms-location on the command line. + + --kms-project=KMS_PROJECT + Cloud project id for the key. + + To set the kms-project attribute: + ▫ provide the argument --kms-key on the command line with a fully + specified name; + ▫ provide the argument --kms-project on the command line. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + These variants are also available: + + $ gcloud alpha spanner backup-schedules create + + $ gcloud beta spanner backup-schedules create + diff --git a/gcloud/spanner/backup-schedules/delete b/gcloud/spanner/backup-schedules/delete new file mode 100644 index 000000000..9fc0d87fb --- /dev/null +++ b/gcloud/spanner/backup-schedules/delete @@ -0,0 +1,74 @@ +NAME + gcloud spanner backup-schedules delete - delete a Cloud Spanner backup + schedule + +SYNOPSIS + gcloud spanner backup-schedules delete + (BACKUP_SCHEDULE : --database=DATABASE --instance=INSTANCE) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Delete a Cloud Spanner backup schedule. + +EXAMPLES + To delete a Cloud Spanner backup schedule, run: + + $ gcloud spanner backup-schedules delete backup-schedule-id \ + --instance=instance-id --database=database-id + +POSITIONAL ARGUMENTS + Backup schedule resource - The Cloud Spanner backup schedule 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 backup_schedule 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. + + BACKUP_SCHEDULE + ID of the backup-schedule or fully qualified identifier for the + backup-schedule. + + To set the backup-schedule attribute: + ▸ provide the argument backup_schedule on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --database=DATABASE + The Cloud Spanner database for the backup-schedule. + + To set the database attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --database on the command line. + + --instance=INSTANCE + The Cloud Spanner instance for the backup-schedule. + + To set the instance attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --instance on the command line; + ▸ set the property spanner/instance. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + These variants are also available: + + $ gcloud alpha spanner backup-schedules delete + + $ gcloud beta spanner backup-schedules delete + diff --git a/gcloud/spanner/backup-schedules/describe b/gcloud/spanner/backup-schedules/describe new file mode 100644 index 000000000..4ce91dab1 --- /dev/null +++ b/gcloud/spanner/backup-schedules/describe @@ -0,0 +1,74 @@ +NAME + gcloud spanner backup-schedules describe - describe a Cloud Spanner backup + schedule + +SYNOPSIS + gcloud spanner backup-schedules describe + (BACKUP_SCHEDULE : --database=DATABASE --instance=INSTANCE) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Describe a Cloud Spanner backup schedule. + +EXAMPLES + To describe a Cloud Spanner backup schedule, run: + + $ gcloud spanner backup-schedules describe backup-schedule-id \ + --instance=instance-id --database=database-id + +POSITIONAL ARGUMENTS + Backup schedule resource - The Cloud Spanner backup schedule 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 backup_schedule 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. + + BACKUP_SCHEDULE + ID of the backup-schedule or fully qualified identifier for the + backup-schedule. + + To set the backup-schedule attribute: + ▸ provide the argument backup_schedule on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --database=DATABASE + The Cloud Spanner database for the backup-schedule. + + To set the database attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --database on the command line. + + --instance=INSTANCE + The Cloud Spanner instance for the backup-schedule. + + To set the instance attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --instance on the command line; + ▸ set the property spanner/instance. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + These variants are also available: + + $ gcloud alpha spanner backup-schedules describe + + $ gcloud beta spanner backup-schedules describe + diff --git a/gcloud/spanner/backup-schedules/get-iam-policy b/gcloud/spanner/backup-schedules/get-iam-policy new file mode 100644 index 000000000..7be0b6ab7 --- /dev/null +++ b/gcloud/spanner/backup-schedules/get-iam-policy @@ -0,0 +1,110 @@ +NAME + gcloud spanner backup-schedules get-iam-policy - get the IAM policy for a + Cloud Spanner backup schedule + +SYNOPSIS + gcloud spanner backup-schedules get-iam-policy + (BACKUP_SCHEDULE : --database=DATABASE --instance=INSTANCE) + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + gcloud spanner backup-schedules get-iam-policy displays the IAM policy + associated with a Cloud Spanner backup schedule. 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; see $ {parent} + set-iam-policy for additional details. + +EXAMPLES + To print the IAM policy for a given Cloud Spanner backup schedule, run: + + $ gcloud spanner backup-schedules get-iam-policy \ + backup-schedule-id --instance=instance-id --database=database-id + +POSITIONAL ARGUMENTS + BackupSchedule resource - The Cloud Spanner backup schedule for which to + display the IAM policy. 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 backup_schedule 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. + + BACKUP_SCHEDULE + ID of the backupSchedule or fully qualified identifier for the + backupSchedule. + + To set the backup_schedule attribute: + ▸ provide the argument backup_schedule on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --database=DATABASE + The name of the Cloud Spanner database. + + To set the database attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --database on the command line. + + --instance=INSTANCE + The name of the Cloud Spanner instance. + + To set the instance attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --instance on the command line; + ▸ set the property spanner/instance. + +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 spanner/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/spanner/ + +NOTES + These variants are also available: + + $ gcloud alpha spanner backup-schedules get-iam-policy + + $ gcloud beta spanner backup-schedules get-iam-policy + diff --git a/gcloud/spanner/backup-schedules/help b/gcloud/spanner/backup-schedules/help new file mode 100644 index 000000000..b4cd86267 --- /dev/null +++ b/gcloud/spanner/backup-schedules/help @@ -0,0 +1,51 @@ +NAME + gcloud spanner backup-schedules - manage Cloud Spanner backup schedules + +SYNOPSIS + gcloud spanner backup-schedules COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage Cloud Spanner backup schedules. + +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 + Add IAM policy binding to a Cloud Spanner backup schedule. + + create + Create a Cloud Spanner backup schedule. + + delete + Delete a Cloud Spanner backup schedule. + + describe + Describe a Cloud Spanner backup schedule. + + get-iam-policy + Get the IAM policy for a Cloud Spanner backup schedule. + + list + List Cloud Spanner backup schedules. + + remove-iam-policy-binding + Remove IAM policy binding of a Cloud Spanner backup schedule. + + set-iam-policy + Set the IAM policy for a Cloud Spanner backup schedule. + + update + Update a Cloud Spanner backup schedule. + +NOTES + These variants are also available: + + $ gcloud alpha spanner backup-schedules + + $ gcloud beta spanner backup-schedules + diff --git a/gcloud/spanner/backup-schedules/list b/gcloud/spanner/backup-schedules/list new file mode 100644 index 000000000..6323c4428 --- /dev/null +++ b/gcloud/spanner/backup-schedules/list @@ -0,0 +1,97 @@ +NAME + gcloud spanner backup-schedules list - list Cloud Spanner backup schedules + +SYNOPSIS + gcloud spanner backup-schedules list + (--database=DATABASE : --instance=INSTANCE) [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List Cloud Spanner backup schedules. + +EXAMPLES + To list Cloud Spanner backup schedules, run: + + $ gcloud spanner backup-schedules list --instance=instance-id \ + --database=database-id + +REQUIRED FLAGS + Database resource - The Cloud Spanner database in which to list schedules. + 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 --database 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. + + --database=DATABASE + ID of the database or fully qualified identifier for the database. + + To set the database attribute: + ▸ provide the argument --database on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --instance=INSTANCE + The Cloud Spanner instance for the database. + + To set the instance attribute: + ▸ provide the argument --database on the command line with a fully + specified name; + ▸ provide the argument --instance on the command line; + ▸ set the property spanner/instance. + +LIST COMMAND FLAGS + --filter=EXPRESSION + Apply a Boolean filter EXPRESSION to each resource item to be listed. + If the expression evaluates True, then that item is listed. For more + details and examples of filter expressions, run $ gcloud topic filters. + This flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --limit=LIMIT + Maximum number of resources to list. The default is unlimited. This + flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --page-size=PAGE_SIZE + Some services group resource list output into pages. This flag + specifies the maximum number of resources per page. The default is + determined by the service if it supports paging, otherwise it is + unlimited (no paging). Paging may be applied before or after --filter + and --limit depending on the service. + + --sort-by=[FIELD,...] + Comma-separated list of resource field key names to sort by. The + default order is ascending. Prefix a field with ``~'' for descending + order on that field. This flag interacts with other flags that are + applied in this order: --flatten, --sort-by, --filter, --limit. + + --uri + Print a list of resource URIs instead of the default output, and change + the command output to a list of URIs. If this flag is used with + --format, the formatting is applied on this URI list. To display URIs + alongside other keys instead, use the uri() transform. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + These variants are also available: + + $ gcloud alpha spanner backup-schedules list + + $ gcloud beta spanner backup-schedules list + diff --git a/gcloud/spanner/backup-schedules/remove-iam-policy-binding b/gcloud/spanner/backup-schedules/remove-iam-policy-binding new file mode 100644 index 000000000..2bfa5069f --- /dev/null +++ b/gcloud/spanner/backup-schedules/remove-iam-policy-binding @@ -0,0 +1,163 @@ +NAME + gcloud spanner backup-schedules remove-iam-policy-binding - remove IAM + policy binding of a Cloud Spanner backup schedule + +SYNOPSIS + gcloud spanner backup-schedules remove-iam-policy-binding + (BACKUP_SCHEDULE : --database=DATABASE --instance=INSTANCE) + --member=PRINCIPAL --role=ROLE + [--all | --condition=[KEY=VALUE,...] + | --condition-from-file=PATH_TO_FILE] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Remove an IAM policy binding of a Cloud Spanner backup schedule. One + binding consists of a member, a role, and an optional condition. + +EXAMPLES + To remove an IAM policy binding for the role of 'roles/editor' for the user + 'test-user@gmail.com', run: + + $ gcloud spanner backup-schedules remove-iam-policy-binding \ + backup-schedule-id --instance=instance-id \ + --database=database-id --member='user:test-user@gmail.com' \ + --role='roles/editor' + + To remove an IAM policy binding which expires at the end of the year 2025 + for the role of 'roles/editor' and the user 'test-user@gmail.com', run: + + $ gcloud spanner backup-schedules remove-iam-policy-binding \ + backup-schedule-id --instance=instance-id \ + --database=database-id --member='user:test-user@gmail.com' \ + --role='roles/editor' \ + --condition='expression=request.time < + timestamp("2026-01-01T00:00:00Z"),title=expires_end_of_2025,descrip\ + tion=Expires at midnight on 2025-12-31' + + See https://cloud.google.com/iam/docs/managing-policies for details of + policy role and member types. + +POSITIONAL ARGUMENTS + BackupSchedule resource - The Cloud Spanner backup schedule to remove the + 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 backup_schedule 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. + + BACKUP_SCHEDULE + ID of the backupSchedule or fully qualified identifier for the + backupSchedule. + + To set the backup_schedule attribute: + ▸ provide the argument backup_schedule on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --database=DATABASE + The name of the Cloud Spanner database. + + To set the database attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --database on the command line. + + --instance=INSTANCE + The name of the Cloud Spanner instance. + + To set the instance attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --instance on the command line; + ▸ set the property spanner/instance. + +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. + +OPTIONAL FLAGS + At most one of these can be specified: + + --all + Remove all bindings with this role and principal, irrespective of any + conditions. + + --condition=[KEY=VALUE,...] + The condition of the binding that you want to remove. When the + condition is explicitly specified as None (--condition=None), a + binding without a condition is removed. Otherwise, only a binding + with a condition that exactly matches the specified condition + (including the optional description) is removed. For more on + conditions, refer to the conditions overview guide: + https://cloud.google.com/iam/docs/conditions-overview + + When using the --condition flag, include the following key-value + pairs: + + expression + (Required) Condition expression that evaluates to True or False. + This uses a subset of Common Expression Language syntax. + + If the condition expression includes a comma, use a different + delimiter to separate the key-value pairs. Specify the delimiter + before listing the key-value pairs. For example, to specify a + colon (:) as the delimiter, do the following: + --condition=^:^title=TITLE:expression=EXPRESSION. For more + information, see + https://cloud.google.com/sdk/gcloud/reference/topic/escaping. + + title + (Required) A short string describing the purpose of the + expression. + + description + (Optional) Additional description for the expression. + + --condition-from-file=PATH_TO_FILE + Path to a local JSON or YAML file that defines the condition. To see + available fields, see the help for --condition. Use a full or + relative path to a local file containing the value of condition. + +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 spanner/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/spanner/ + +NOTES + These variants are also available: + + $ gcloud alpha spanner backup-schedules remove-iam-policy-binding + + $ gcloud beta spanner backup-schedules remove-iam-policy-binding + diff --git a/gcloud/spanner/backup-schedules/set-iam-policy b/gcloud/spanner/backup-schedules/set-iam-policy new file mode 100644 index 000000000..8cadbc834 --- /dev/null +++ b/gcloud/spanner/backup-schedules/set-iam-policy @@ -0,0 +1,92 @@ +NAME + gcloud spanner backup-schedules set-iam-policy - set the IAM policy for a + Cloud Spanner backup schedule + +SYNOPSIS + gcloud spanner backup-schedules set-iam-policy + (BACKUP_SCHEDULE : --database=DATABASE --instance=INSTANCE) POLICY_FILE + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Set the IAM policy for a Cloud Spanner backup schedule given a backup + schedule ID and a file encoded in JSON or YAML that contains the IAM + policy. + +EXAMPLES + The following command reads an IAM policy defined in a JSON file + policy.json and sets it for a Cloud Spanner backup schedule: + + $ gcloud spanner backup-schedules set-iam-policy \ + backup-schedule-id --instance=instance-id \ + --database=database-id policy.json + + See https://cloud.google.com/iam/docs/managing-policies for details of the + policy file format and contents. + +POSITIONAL ARGUMENTS + BackupSchedule resource - The Cloud Spanner backup schedule to set the IAM + policy for. 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 backup_schedule 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. + + BACKUP_SCHEDULE + ID of the backupSchedule or fully qualified identifier for the + backupSchedule. + + To set the backup_schedule attribute: + ▸ provide the argument backup_schedule on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --database=DATABASE + The name of the Cloud Spanner database. + + To set the database attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --database on the command line. + + --instance=INSTANCE + The name of the Cloud Spanner instance. + + To set the instance attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --instance on the command line; + ▸ set the property spanner/instance. + + 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. + +API REFERENCE + This command uses the spanner/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/spanner/ + +NOTES + These variants are also available: + + $ gcloud alpha spanner backup-schedules set-iam-policy + + $ gcloud beta spanner backup-schedules set-iam-policy + diff --git a/gcloud/spanner/backup-schedules/update b/gcloud/spanner/backup-schedules/update new file mode 100644 index 000000000..d75fd6671 --- /dev/null +++ b/gcloud/spanner/backup-schedules/update @@ -0,0 +1,153 @@ +NAME + gcloud spanner backup-schedules update - update a Cloud Spanner backup + schedule + +SYNOPSIS + gcloud spanner backup-schedules update + (BACKUP_SCHEDULE : --database=DATABASE --instance=INSTANCE) + (--cron=CRON --encryption-type=ENCRYPTION_TYPE + --retention-duration=RETENTION_DURATION [--kms-key=KMS_KEY + : --kms-keyring=KMS_KEYRING + --kms-location=KMS_LOCATION --kms-project=KMS_PROJECT]) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Update a Cloud Spanner backup schedule. + +EXAMPLES + To update a Cloud Spanner backup schedule, run: + + $ gcloud spanner backup-schedules update backup-schedule-id \ + --instance=instance-id --database=database-id \ + --cron="0 2 * * *" --retention-duration=2w \ + --encryption-type=GOOGLE_DEFAULT_ENCRYPTION + +POSITIONAL ARGUMENTS + Backup schedule resource - The Cloud Spanner backup schedule 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 backup_schedule 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. + + BACKUP_SCHEDULE + ID of the backup-schedule or fully qualified identifier for the + backup-schedule. + + To set the backup-schedule attribute: + ▸ provide the argument backup_schedule on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --database=DATABASE + The Cloud Spanner database for the backup-schedule. + + To set the database attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --database on the command line. + + --instance=INSTANCE + The Cloud Spanner instance for the backup-schedule. + + To set the instance attribute: + ▸ provide the argument backup_schedule on the command line with a + fully specified name; + ▸ provide the argument --instance on the command line; + ▸ set the property spanner/instance. + +REQUIRED FLAGS + At least one of these must be specified: + + --cron=CRON + Textual representation of the crontab. User can customize the backup + frequency and the backup version time using the cron expression. The + version time must be in UTC timzeone. The backup will contain an + externally consistent copy of the database at the version time. + Allowed frequencies are 12 hour, 1 day, 1 week and 1 month. Examples + of valid cron specifications: * 0 2/12 * * * : every 12 hours at (2, + 14) hours past midnight in UTC. * 0 2,14 * * * : every 12 hours at + (2,14) hours past midnight in UTC. * 0 2 * * * : once a day at 2 past + midnight in UTC. * 0 2 * * 0 : once a week every Sunday at 2 past + midnight in UTC. * 0 2 8 * * : once a month on 8th day at 2 past + midnight in UTC. + + --encryption-type=ENCRYPTION_TYPE + The encryption type of the backup. ENCRYPTION_TYPE must be one of: + + customer-managed-encryption + Use the provided Cloud KMS key for encryption. If this option is + selected, kms-key must be set. + google-default-encryption + Use Google default encryption. + use-database-encryption + Use the same encryption configuration as the database. + + --retention-duration=RETENTION_DURATION + The retention duration of a backup that must be at least 6 hours and + at most 366 days. The backup is eligible to be automatically deleted + once the retention period has elapsed. + + KMS key name group + + At most one of these can be specified: + + Key resource - Cloud KMS key to be used to create the Cloud Spanner + backup. The arguments in this group can be used to specify the + attributes of this resource. + + --kms-key=KMS_KEY + ID of the key or fully qualified identifier for the key. + + To set the kms-key attribute: + ◇ provide the argument --kms-key on the command line. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --kms-keyring=KMS_KEYRING + KMS keyring id of the key. + + To set the kms-keyring attribute: + ◇ provide the argument --kms-key on the command line with a + fully specified name; + ◇ provide the argument --kms-keyring on the command line. + + --kms-location=KMS_LOCATION + Cloud location for the key. + + To set the kms-location attribute: + ◇ provide the argument --kms-key on the command line with a + fully specified name; + ◇ provide the argument --kms-location on the command line. + + --kms-project=KMS_PROJECT + Cloud project id for the key. + + To set the kms-project attribute: + ◇ provide the argument --kms-key on the command line with a + fully specified name; + ◇ provide the argument --kms-project on the command line. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + These variants are also available: + + $ gcloud alpha spanner backup-schedules update + + $ gcloud beta spanner backup-schedules update + diff --git a/gcloud/spanner/help b/gcloud/spanner/help index aba15d7e5..df9c43eaf 100644 --- a/gcloud/spanner/help +++ b/gcloud/spanner/help @@ -15,6 +15,9 @@ GCLOUD WIDE FLAGS GROUPS GROUP is one of the following: + backup-schedules + Manage Cloud Spanner backup schedules. + backups Manage Cloud Spanner backups. diff --git a/gcloud/sql/ssl/help b/gcloud/sql/ssl/help index 47a21610e..a73cef0af 100644 --- a/gcloud/sql/ssl/help +++ b/gcloud/sql/ssl/help @@ -21,6 +21,9 @@ GROUPS Provide commands for managing client certificates of Cloud SQL instances. + server-ca-certs + Provide commands for managing server CA certs of Cloud SQL instances. + NOTES These variants are also available: diff --git a/gcloud/sql/ssl/server-ca-certs/create b/gcloud/sql/ssl/server-ca-certs/create new file mode 100644 index 000000000..05f735259 --- /dev/null +++ b/gcloud/sql/ssl/server-ca-certs/create @@ -0,0 +1,35 @@ +NAME + gcloud sql ssl server-ca-certs create - create a server CA cert for a Cloud + SQL instance + +SYNOPSIS + gcloud sql ssl server-ca-certs create --instance=INSTANCE, -i INSTANCE + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a server CA cert for a Cloud SQL instance. + +REQUIRED FLAGS + --instance=INSTANCE, -i INSTANCE + Cloud SQL instance ID. + +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 + These variants are also available: + + $ gcloud alpha sql ssl server-ca-certs create + + $ gcloud beta sql ssl server-ca-certs create + diff --git a/gcloud/sql/ssl/server-ca-certs/help b/gcloud/sql/ssl/server-ca-certs/help new file mode 100644 index 000000000..df958ac7e --- /dev/null +++ b/gcloud/sql/ssl/server-ca-certs/help @@ -0,0 +1,38 @@ +NAME + gcloud sql ssl server-ca-certs - provide commands for managing server CA + certs of Cloud SQL instances + +SYNOPSIS + gcloud sql ssl server-ca-certs COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Provide commands for managing server CA certs of Cloud SQL instances, + including creating, listing, rotating in, and rolling back certs. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + Create a server CA cert for a Cloud SQL instance. + + list + List all server CA certs for a Cloud SQL instance. + + rollback + Roll back to the previous server CA cert for a Cloud SQL instance. + + rotate + Rotate in the upcoming server CA cert for a Cloud SQL instance. + +NOTES + These variants are also available: + + $ gcloud alpha sql ssl server-ca-certs + + $ gcloud beta sql ssl server-ca-certs + diff --git a/gcloud/sql/ssl/server-ca-certs/list b/gcloud/sql/ssl/server-ca-certs/list new file mode 100644 index 000000000..46e12a80e --- /dev/null +++ b/gcloud/sql/ssl/server-ca-certs/list @@ -0,0 +1,63 @@ +NAME + gcloud sql ssl server-ca-certs list - list all server CA certs for a Cloud + SQL instance + +SYNOPSIS + gcloud sql ssl server-ca-certs list --instance=INSTANCE, -i INSTANCE + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List all server CA certs for a Cloud SQL instance. + +REQUIRED FLAGS + --instance=INSTANCE, -i INSTANCE + Cloud SQL instance ID. + +LIST COMMAND FLAGS + --filter=EXPRESSION + Apply a Boolean filter EXPRESSION to each resource item to be listed. + If the expression evaluates True, then that item is listed. For more + details and examples of filter expressions, run $ gcloud topic filters. + This flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --limit=LIMIT + Maximum number of resources to list. The default is unlimited. This + flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --page-size=PAGE_SIZE + Some services group resource list output into pages. This flag + specifies the maximum number of resources per page. The default is + determined by the service if it supports paging, otherwise it is + unlimited (no paging). Paging may be applied before or after --filter + and --limit depending on the service. + + --sort-by=[FIELD,...] + Comma-separated list of resource field key names to sort by. The + default order is ascending. Prefix a field with ``~'' for descending + order on that field. This flag interacts with other flags that are + applied in this order: --flatten, --sort-by, --filter, --limit. + + --uri + Print a list of resource URIs instead of the default output, and change + the command output to a list of URIs. If this flag is used with + --format, the formatting is applied on this URI list. To display URIs + alongside other keys instead, use the uri() transform. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + These variants are also available: + + $ gcloud alpha sql ssl server-ca-certs list + + $ gcloud beta sql ssl server-ca-certs list + diff --git a/gcloud/sql/ssl/server-ca-certs/rollback b/gcloud/sql/ssl/server-ca-certs/rollback new file mode 100644 index 000000000..d154b2990 --- /dev/null +++ b/gcloud/sql/ssl/server-ca-certs/rollback @@ -0,0 +1,35 @@ +NAME + gcloud sql ssl server-ca-certs rollback - roll back to the previous server + CA cert for a Cloud SQL instance + +SYNOPSIS + gcloud sql ssl server-ca-certs rollback --instance=INSTANCE, -i INSTANCE + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Roll back to the previous server CA cert for a Cloud SQL instance. + +REQUIRED FLAGS + --instance=INSTANCE, -i INSTANCE + Cloud SQL instance ID. + +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 + These variants are also available: + + $ gcloud alpha sql ssl server-ca-certs rollback + + $ gcloud beta sql ssl server-ca-certs rollback + diff --git a/gcloud/sql/ssl/server-ca-certs/rotate b/gcloud/sql/ssl/server-ca-certs/rotate new file mode 100644 index 000000000..9cafed7e1 --- /dev/null +++ b/gcloud/sql/ssl/server-ca-certs/rotate @@ -0,0 +1,35 @@ +NAME + gcloud sql ssl server-ca-certs rotate - rotate in the upcoming server CA + cert for a Cloud SQL instance + +SYNOPSIS + gcloud sql ssl server-ca-certs rotate --instance=INSTANCE, -i INSTANCE + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Rotate in the upcoming server CA cert for a Cloud SQL instance. + +REQUIRED FLAGS + --instance=INSTANCE, -i INSTANCE + Cloud SQL instance ID. + +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 + These variants are also available: + + $ gcloud alpha sql ssl server-ca-certs rotate + + $ gcloud beta sql ssl server-ca-certs rotate +