gcloud preview config - view and edit Google Cloud CLI properties

gcloud preview configGROUP |COMMAND[GCLOUD_WIDE_FLAG …]

A configuration is a set of properties that govern the behavior ofgcloud and other Google Cloud CLI tools.The initialdefault configuration is set whengcloud init is run. You can createadditional named configurations usinggcloud init orgcloud previewconfig configurations create.

To display the path of the active configuration along with information about thecurrentgcloud environment, run$gcloud info.

To switch between configurations, usegcloudpreview config configurations activate.

gcloud supports several flags that have the same effect as properties in aconfiguration (for example, gcloud supports both the--project flagandproject property). Properties differ from flags in that flagsaffect command behavior on a per-invocation basis. Properties allow you tomaintain the same settings across command executions.

In addition to setting properties in a configuration, and the use of flags, itis possible to override the value of a property with an environment variable.The matching environment variable for a property is of the form'CLOUDSDK_CATEGORY_PROPERTY'. For example, to demonstrate overriding theproject property in thecore category tomy-project, use a command like:

CLOUDSDK_CORE_PROJECT=my-projectgcloudconfiggetcore/project

For more information on configurations, seegcloud topicconfigurations.

Run$gcloud help for details.

configurations

(PREVIEW) Manage the set of gcloud named configurations.

get

(PREVIEW) Print the value of a Google Cloud CLI property.

list

(PREVIEW) List Google Cloud CLI properties for the currently activeconfiguration.

set

(PREVIEW) Set a Google Cloud CLI property.

unset

(PREVIEW) Unset a Google Cloud CLI property.

core

account

Accountgcloud should use forauthentication. Rungcloud authlist to see your currently available accounts.

console_log_format

Control the format used to display log messages to the console.

Valid values are:

• standard - Simplified log messages are displayed on the console.
• detailed - More detailed messages are displayed on the console.

If unset, default isstandard.

custom_ca_certs_file

Absolute path to a custom CA cert file.

default_format

Sets the default format for printing command resources.core/default_format overrides the default yaml format. If thecommand contains a command-specific output format, it takes precedence over thecore/default_format value. Use--verbosity=debug flagto view the command-specific format. Bothcore/format and--format also take precedence overcore/default_format. The supported formats are limited to:config,default,disable,flattened,json,list,none,object,text. For more details run $gcloud topic formats. Run$gcloud config set --help to see moreinformation aboutcore/default_format

default_regional_backend_service

If True, backend services ingcloud computebackend-services will be regional by default. Setting the--global flag is required for global backend services.

disable_color

If True, color will not be used when printing messages in the terminal.

disable_file_logging

If True,gcloud will not storelogs to a file. This may be useful if disk space is limited.

disable_prompts

If True, the default answer will be assumed for all user prompts. However, forany prompts that require user input, an error will be raised. This is equivalentto either using the global--quiet flag or setting the environmentvariableCLOUDSDK_CORE_DISABLE_PROMPTS to 1. Setting this propertyis useful when scripting withgcloud.

disable_usage_reporting

If True, anonymous statistics on SDK usage will not be collected. This value isset by your choices during installation, but can be changed at any time. Formore information, seeUsagestatistics.

format

Sets the format for printing all command resources. This overrides the defaultcommand-specific human-friendly output format. Use--verbosity=debug flag to view the command-specific format. If bothcore/default_format andcore/format are specified,core/format takes precedence. If bothcore/format and--format are specified,--format takes precedence. Thesupported formats are limited to:config,default,disable,flattened,json,list,none,object,text.For more details run $gcloudtopic formats. Run$gcloudconfig set --help to see more information aboutcore/format

log_http

If True, log HTTP requests and responses to the logs. To see logs in theterminal, adjustverbosity settings. Otherwise, logs are availablein their respective log files.

max_log_days

Maximum number of days to retain log files before deleting. If set to 0, turnsoff log garbage collection and does not delete log files. If unset, the defaultis 30 days.

parse_error_details

If True,gcloud will attempt toparse and interpret error details in API originating errors. If False,gcloud will write flush error details asis to stderr/log.

pass_credentials_to_gsutil

If True, pass the configured Google Cloud CLI authentication to gsutil.

project

Project ID of the Cloud Platform project to operate on by default. This can beoverridden by using the global--project flag.

show_structured_logs

Control when JSON-structured log messages for the current verbosity level (andabove) will be written to standard error. If this property is disabled, logs areformatted astext by default.

Valid values are:

• never - Log messages as text
• always - Always log messages as JSON
• log - Only log messages as JSON if stderr is a file
• terminal - Only log messages as JSON if stderr is a terminal

If unset, default isnever.

trace_token

Token used to route traces of service requests for investigation of issues. Thistoken will be provided by Google support.

universe_domain

Sets the domain of the universe to use for API requests.

user_output_enabled

True, by default. If False, messages to the user and command output on bothstandard output and standard error will be suppressed.

verbosity

Default logging verbosity forgcloud commands. This is the equivalentof using the global--verbosity flag. Supported verbosity levels:debug,info,warning,error,critical, andnone.

accessibility

screen_reader

Make gcloud more screen reader friendly.

ai

region

Default region to use when working with AI Platform resources. When a--region flag is required but not provided, the command will fallback to this value, if set.

ai_platform

region

Default region to use when working with AI Platform Training and Predictionresources (currently for Prediction only). It is ignored for training resourcesfor now. The value should be eitherglobal or one of the supportedregions. When a--region flag is required but not provided, thecommand will fall back to this value, if set.

api_endpoint_overrides

accessapproval

Overrides API endpoint forgcloud access-approvalcommand group. Defaults tohttps://accessapproval.googleapis.com/

accesscontextmanager

Overrides API endpoint forgcloudaccess-context-manager command group. Defaults tohttps://accesscontextmanager.googleapis.com/

ai

Overrides API endpoint forgcloudai command group.

aiplatform

Overrides API endpoint forgcloud ai-platform commandgroup. Defaults tohttps://aiplatform.googleapis.com/

anthosevents

Overrides API endpoint forgcloudanthos command group. Defaults tohttps://anthosevents.googleapis.com/

anthospolicycontrollerstatus_pa

Overrides API endpoint forgcloud containerfleet policycontroller command group. Defaults tohttps://anthospolicycontrollerstatus-pa.googleapis.com/

apigateway

Overrides API endpoint forgcloud api-gateway commandgroup. Defaults tohttps://apigateway.googleapis.com/

apigee

Overrides API endpoint forgcloudapigee command group. Defaults tohttps://apigee.googleapis.com/

appengine

Overrides API endpoint forgcloudapp command group. Defaults tohttps://appengine.googleapis.com/

apphub

Overrides API endpoint forgcloudapphub command group. Defaults tohttps://apphub.googleapis.com/

artifactregistry

Overrides API endpoint forgcloud artifacts commandgroup. Defaults tohttps://artifactregistry.googleapis.com/

assuredworkloads

Overrides API endpoint forgcloudassured command group. Defaults tohttps://assuredworkloads.googleapis.com/

auditmanager

Overrides API endpoint forgcloud audit-managercommand group. Defaults tohttps://auditmanager.googleapis.com/

baremetalsolution

Overrides API endpoint forgcloudbms command group. Defaults tohttps://baremetalsolution.googleapis.com/

bigtableadmin

Overrides API endpoint forgcloudbigtable command group. Defaults tohttps://bigtableadmin.googleapis.com/

certificatemanager

Overrides API endpoint forgcloudcertificate-manager command group. Defaults tohttps://certificatemanager.googleapis.com/

cloudasset

Overrides API endpoint forgcloudasset command group. Defaults tohttps://cloudasset.googleapis.com/

cloudbilling

Overrides API endpoint forgcloudbilling command group. Defaults tohttps://cloudbilling.googleapis.com/

cloudbuild

Overrides API endpoint forgcloudbuilds command group. Defaults tohttps://cloudbuild.googleapis.com/

cloudcommerceconsumerprocurement

Overrides API endpoint forgcloud commerce-procurement commandgroup. Defaults tohttps://cloudcommerceconsumerprocurement.googleapis.com/

clouddebugger

Overrides API endpoint forgcloud debug command group. Defaults tohttps://clouddebugger.googleapis.com/

clouddeploy

Overrides API endpoint forgclouddeploy command group. Defaults tohttps://clouddeploy.googleapis.com/

clouderrorreporting

Overrides API endpoint forgcloud error-reporting command group.Defaults tohttps://clouderrorreporting.googleapis.com/

cloudfunctions

Overrides API endpoint forgcloud functions commandgroup. Defaults tohttps://cloudfunctions.googleapis.com/

cloudidentity

Overrides API endpoint forgcloudidentity command group. Defaults tohttps://cloudidentity.googleapis.com/

cloudkms

Overrides API endpoint forgcloudkms command group. Defaults tohttps://cloudkms.googleapis.com/

cloudlocationfinder

Overrides API endpoint forgcloudcloudlocationfinder command group. Defaults tohttps://cloudlocationfinder.googleapis.com/

cloudresourcemanager

Overrides API endpoint forgcloudprojects command group. Defaults tohttps://cloudresourcemanager.googleapis.com/

cloudscheduler

Overrides API endpoint forgcloud scheduler commandgroup. Defaults tohttps://cloudscheduler.googleapis.com/

cloudsecuritycompliance

Overrides API endpoint forgcloudcompliance-manager command group. Defaults tohttps://cloudsecuritycompliance.googleapis.com/

cloudtasks

Overrides API endpoint forgcloudtasks command group. Defaults tohttps://cloudtasks.googleapis.com/

cloudtrace

Overrides API endpoint forgcloud trace command group. Defaults tohttps://cloudtrace.googleapis.com/

composer

Overrides API endpoint forgcloudcomposer command group. Defaults tohttps://composer.googleapis.com/

compute

Overrides API endpoint forgcloudcompute command group. For Private Service Connect usage, seehttps://cloud.google.com/vpc/docs/configure-private-service-connect-apis#using-endpoints

config

Overrides API endpoint forgcloud infra-managercommand group. Defaults tohttps://config.googleapis.com/

container

Overrides API endpoint forgcloud container commandgroup. Defaults tohttps://container.googleapis.com/

datacatalog

Overrides API endpoint forgcloud data-catalog commandgroup. Defaults tohttps://datacatalog.googleapis.com/

dataflow

Overrides API endpoint forgclouddataflow command group. Defaults tohttps://dataflow.googleapis.com/

datafusion

Overrides API endpoint forgcloud data-fusion command group.Defaults tohttps://datafusion.googleapis.com/

datamigration

Overrides API endpoint forgclouddatabase-migration command group. Defaults tohttps://datamigration.googleapis.com/

datapipelines

Overrides API endpoint forgcloud datapipelines command group.Defaults tohttps://datapipelines.googleapis.com/

dataplex

Overrides API endpoint forgclouddataplex command group. Defaults tohttps://dataplex.googleapis.com/

dataproc

Overrides API endpoint forgclouddataproc command group. Defaults tohttps://dataproc.googleapis.com/

datastore

Overrides API endpoint forgcloud datastore commandgroup. Defaults tohttps://datastore.googleapis.com/

datastream

Overrides API endpoint forgcloud datastream commandgroup. Defaults tohttps://datastream.googleapis.com/

deploymentmanager

Overrides API endpoint forgclouddeployment-manager command group. Defaults tohttps://deploymentmanager.googleapis.com/

developerconnect

Overrides API endpoint forgclouddeveloper-connect command group. Defaults tohttps://developerconnect.googleapis.com/

dns

Overrides API endpoint forgclouddns command group. Defaults tohttps://dns.googleapis.com/dns/v1/

domains

Overrides API endpoint forgclouddomains command group. Defaults tohttps://domains.googleapis.com/

edgecontainer

Overrides API endpoint forgcloud edge-container command group.Defaults tohttps://edgecontainer.googleapis.com/

eventarc

Overrides API endpoint forgcloudeventarc command group. Defaults tohttps://eventarc.googleapis.com/

eventarcpublishing

Overrides API endpoint forgcloud eventarc publish command group.Defaults tohttps://eventarcpublishing.googleapis.com/

faultinjectiontesting

Overrides API endpoint forgcloud fault-injection command group.Defaults tohttps://faultinjectiontesting.googleapis.com/

faulttesting

Overrides API endpoint forgcloud fault-testing command group.Defaults tohttps://faulttesting.googleapis.com/

file

Overrides API endpoint forgcloud filestore commandgroup. Defaults tohttps://file.googleapis.com/

firebasedataconnect

Overrides API endpoint forgcloud firebase-data-connect commandgroup. Defaults tohttps://firebasedataconnect.googleapis.com/

firestore

Overrides API endpoint forgcloud firestore commandgroup. Defaults tohttps://firestore.googleapis.com/

genomics

Overrides API endpoint forgcloud genomics command group. Defaultstohttps://genomics.googleapis.com/

gkemulticloud

Overrides API endpoint forgcloud container aws,gcloud containerazure andgcloud containerattached command groups.

healthcare

Overrides API endpoint forgcloud healthcare commandgroup. Defaults tohttps://healthcare.googleapis.com/

hypercomputecluster

Overrides API endpoint forgcloud cluster-director command group.Defaults tohttps://hypercomputecluster.googleapis.com/

iam

Overrides API endpoint forgcloudiam command group. Defaults tohttps://iam.googleapis.com/

iamcredentials

Overrides API endpoint forgcloudiam command group. Defaults tohttps://iamcredentials.googleapis.com/

iap

Overrides API endpoint forgcloudiap command group. Defaults tohttps://iap.googleapis.com/

ids

Overrides API endpoint forgcloudids command group. Defaults tohttps://ids.googleapis.com/

krmapihosting

Overrides API endpoint forgcloud anthos configcontroller command group. Defaults tohttps://krmapihosting.googleapis.com/

language

Overrides API endpoint forgcloud ml language commandgroup. Defaults tohttps://language.googleapis.com/

lifesciences

Overrides API endpoint forgcloud lifesciences command group.Defaults tohttps://lifesciences.googleapis.com/

logging

Overrides API endpoint forgcloudlogging command group. Defaults tohttps://logging.googleapis.com/

looker

Overrides API endpoint forgcloudlooker command group. Defaults tohttps://looker.googleapis.com/

managedidentities

Overrides API endpoint forgcloud active-directorycommand group. Defaults tohttps://managedidentities.googleapis.com/

marketplacesolutions

Overrides API endpoint forgcloud mps command group. Defaults tohttps://marketplacesolutions.googleapis.com/

mediaasset

Overrides API endpoint forgcloud media command group. Defaults tohttps://mediaasset.googleapis.com/

memcache

Overrides API endpoint forgcloudmemcache command group. Defaults tohttps://memcache.googleapis.com/

metastore

Overrides API endpoint forgcloud metastore commandgroup. Defaults tohttps://metastore.googleapis.com/

monitoring

Overrides API endpoint forgcloud monitoring commandgroup. Defaults tohttps://monitoring.googleapis.com/

netapp

Overrides API endpoint forgcloudnetapp command group. Defaults tohttps://netapp.googleapis.com/

networkconnectivity

Overrides API endpoint forgcloudnetwork-connectivity command group. Defaults tohttps://networkconnectivity.googleapis.com/

networkmanagement

Overrides API endpoint forgcloudnetwork-management command group. Defaults tohttps://networkmanagement.googleapis.com/

networksecurity

Overrides API endpoint forgcloud network-securitycommand group. Defaults tohttps://networksecurity.googleapis.com/

networkservices

Overrides API endpoint forgcloud network-servicescommand group. Defaults tohttps://networkservices.googleapis.com/

notebooks

Overrides API endpoint forgcloud notebooks commandgroup. Defaults tohttps://notebooks.googleapis.com/

observability

Overrides API endpoint forgcloud observabilitycommand group. Defaults tohttps://observability.googleapis.com/

orgpolicy

Overrides API endpoint forgcloud org-policies commandgroup. Defaults tohttps://orgpolicy.googleapis.com/

policyanalyzer

Overrides API endpoint forpolicy-intelligence command group.Defaults tohttps://policyanalyzer.googleapis.com/

privateca

Overrides API endpoint forgcloud privateca commandgroup. Defaults tohttps://privateca.googleapis.com/

privilegedaccessmanager

Overrides API endpoint forgcloudpam command group. Defaults tohttps://privilegedaccessmanager.googleapis.com/

publicca

Overrides API endpoint forgcloudpublicca command group. Defaults tohttps://publicca.googleapis.com/

pubsub

Overrides API endpoint forgcloudpubsub command group. Defaults tohttps://pubsub.googleapis.com/

recaptchaenterprise

Overrides API endpoint forgcloud recaptcha commandgroup. Defaults tohttps://recaptchaenterprise.googleapis.com/

recommender

Overrides API endpoint forgcloud recommender commandgroup. Defaults tohttps://recommender.googleapis.com/

redis

Overrides API endpoint forgcloudredis command group. Defaults tohttps://redis.googleapis.com/

run

Overrides API endpoint forgcloudrun command group. Defaults tohttps://run.googleapis.com/

runtimeconfig

Overrides API endpoint forgcloud runtime-config command group.Defaults tohttps://runtimeconfig.googleapis.com/

sddc

Overrides API endpoint forgcloud vmware sddc command group.Defaults tohttps://sddc.googleapis.com/

secretmanager

Overrides API endpoint forgcloudsecrets command group. Defaults tohttps://secretmanager.googleapis.com/

securitycenter

Overrides API endpoint forgcloudscc command group. Defaults tohttps://securitycenter.googleapis.com/

servicedirectory

Overrides API endpoint forgcloudservice-directory command group. Defaults tohttps://servicedirectory.googleapis.com/

servicemanagement

Overrides API endpoint forgcloud endpoints commandgroup. Defaults tohttps://servicemanagement.googleapis.com/

sourcerepo

Overrides API endpoint forgcloudsource command group. Defaults tohttps://sourcerepo.googleapis.com/

spanner

Overrides API endpoint forgcloudspanner command group. For spanner emulator usage, seehttps://cloud.google.com/spanner/docs/emulator#using_the_gcloud_cli_with_the_emulator

speech

Overrides API endpoint forgcloud ml speech commandgroup. Defaults tohttps://speech.googleapis.com/

sql

Overrides API endpoint forgcloudsql command group.

storage

Overrides API endpoint forgcloudstorage command group. Defaults tohttps://storage.googleapis.com/storage/v1/

testing

Overrides API endpoint forgcloud firebase testcommand group. Defaults tohttps://testing.googleapis.com/

transfer

Overrides API endpoint forgcloudtransfer command group.

transferappliance

Overrides API endpoint forgcloud transfer appliances commandgroup. Defaults tohttps://transferappliance.googleapis.com/

vision

Overrides API endpoint forgcloud ml vision commandgroup. Defaults tohttps://vision.googleapis.com/

vmmigration

Overrides API endpoint forgcloud migration vmscommand group. Defaults tohttps://vmmigration.googleapis.com/

vmwareengine

Overrides API endpoint forgcloudvmware command group. Defaults tohttps://vmwareengine.googleapis.com/

workflowexecutions

Overrides API endpoint forgcloud workflowsexecutions command group. Defaults tohttps://workflowexecutions.googleapis.com/

workflows

Overrides API endpoint forgcloud workflows commandgroup. Defaults tohttps://workflows.googleapis.com/

workstations

Overrides API endpoint forgcloud workstations commandgroup. Defaults tohttps://workstations.googleapis.com/

app

cloud_build_timeout

Timeout, in seconds, to wait for Docker builds to complete during deployments.All Docker builds now use the Cloud Build API.

promote_by_default

If True, when deploying a new version of a service, that version will bepromoted to receive all traffic for the service. This property can be overriddenwith the--promote-by-default or--no-promote-by-default flags.

stop_previous_version

If True, when deploying a new version of a service, the previously deployedversion is stopped. If False, older versions must be stopped manually.

use_runtime_builders

If set, opt in/out to a new code path for building applications usingpre-fabricated runtimes that can be updated independently of client tooling. Ifnot set, the default path for each runtime is used.

artifacts

location

Default location to use when working with Artifact Registry resources. When alocation value is required but not provided, the command will fallback to this value, if set. If this value is unset, the default location isglobal whenlocation value is optional.

repository

Default repository to use when working with Artifact Registry resources. When arepository value is required but not provided, the command willfall back to this value, if set.

auth

access_token_file

A file path to read the access token. Use this property to authenticate gcloudwith an access token. The credentials of the active account (if it exists) willbe ignored. The file should contain an access token with no other information.

disable_credentials

If True,gcloud will notattempt to load any credentials or authenticate any requests. This is usefulwhen behind a proxy that adds authentication to requests.

impersonate_service_account

While set, all API requests will be made as the given service account or targetservice account in an impersonation delegation chain instead of the currentlyselected account. You can specify either a single service account as theimpersonator, or a comma-separated list of service accounts to create animpersonation delegation chain. This is done without needing to create,download, or activate a key for the service account or accounts.

In order to make API requests as a service account, your currently selectedaccount must have an IAM role that includes theiam.serviceAccounts.getAccessToken permission for the serviceaccount or accounts.

Theroles/iam.serviceAccountTokenCreator role has theiam.serviceAccounts.getAccessToken permission. You can also createa custom role.

You can specify a list of service accounts, separated with commas. This createsan impersonation delegation chain in which each service account delegates itspermissions to the next service account in the chain. Each service account inthe list must have theroles/iam.serviceAccountTokenCreator role onthe next service account in the list. For example, when the property is setthroughgcloud config set auth/impersonate_service_account=SERVICE_ACCOUNT_1,SERVICE_ACCOUNT_2,the active account must have theroles/iam.serviceAccountTokenCreator role onSERVICE_ACCOUNT_1, which must have theroles/iam.serviceAccountTokenCreator role onSERVICE_ACCOUNT_2.SERVICE_ACCOUNT_1 is the impersonatedservice account andSERVICE_ACCOUNT_2 isthe delegate.

login_config_file

Sets the created login configuration file in auth/login_config_file. Callinggcloud auth loginwill automatically use this login configuration unless it is explicitly unset.

service_account_disable_id_token_refresh

If True, disable ID token refresh for service account.

service_account_use_self_signed_jwt

If True, use self signed jwt flow to get service account credentials accesstoken. This only applies to service account json file and not to the legacy .p12file.

token_host

Overrides the token endpoint to provision access tokens. It can be used withPrivate Service Connect.

batch

location

Default location to use when working with Batch resources. When alocation value is required but not provided, the command will fallback to this value, if set.

billing

quota_project

The Google Cloud project that is billed and charged quota for operationsperformed ingcloud. Whenunset, the default is [CURRENT_PROJECT]. This default bills and charges quotaagainst the current project. If you need to operate on one project, but need tobill your usage against or use quota from a different project, you can use thisflag to specify the billing project. If bothbilling/quota_projectand--billing-project are specified,--billing-projecttakes precedence.

builds

kaniko_cache_ttl

TTL, in hours, of cached layers when using Kaniko. If zero, layer caching isdisabled.

region

Default region to use when working with Cloud Build resources. When a--region flag is required but not provided, the command will fallback to this value, if set.

timeout

Timeout, in seconds, to wait for builds to complete. If unset, defaults to 10minutes.

use_kaniko

If True, kaniko will be used to build images described by a Dockerfile, insteadofdocker build.

colab

region

Default region to use when working with Colab Enterprise resources. When a--region flag is required but not provided, the command will fallback to this value, if set. Please seehttps://cloud.google.com/colab/docs/locationsfor a list of supported regions.

component_manager

additional_repositories

Comma separated list of additional repositories to check for components. Thisproperty is automatically managed by thegcloud componentsrepositories commands.

disable_update_check

If True, Google Cloud CLI will not automatically check for updates.

composer

location

Composer location to use. Each Composer location constitutes an independentresource namespace constrained to deploying environments into Compute Engineregions inside this location. This parameter corresponds to the/locations/<location> segment of the Composer resource URIs beingreferenced.

compute

image_family_scope

Sets how images are selected with image families for disk and instance creation.By default, zonal image resources are used when using an image family in apublic image project, and global image resources are used for all otherprojects. To override the default behavior, set this property tozonal orglobal.

region

Default region to use when working with regional Compute Engine resources. Whena--region flag is required but not provided, the command will fallback to this value, if set. To see valid choices, rungcloud compute regionslist.

use_new_list_usable_subnets_api

If True, use the new API for listing usable subnets which only returns subnetsin the current project.

zone

Default zone to use when working with zonal Compute Engine resources. When a--zone flag is required but not provided, the command will fallback to this value, if set. To see valid choices, rungcloud compute zoneslist.

container

build_timeout

Timeout, in seconds, to wait for container builds to complete.

cluster

Name of the cluster to use by default when working with Kubernetes Engine.

use_application_default_credentials

If True, use application default credentials to authenticate to the cluster APIserver.

use_client_certificate

If True, use the cluster's client certificate to authenticate to the cluster APIserver.

container_attached

location

Default Google Cloud location to use for Attached clusters.

container_aws

location

Default Google Cloud location to use for Anthos clusters on AWS.

container_azure

location

Default Google Cloud location to use for Anthos clusters on Azure.

container_bare_metal

location

Default Google Cloud location to use for Anthos clusters on Bare Metal.

container_vmware

location

Default Google Cloud location to use for Anthos clusters on VMware.

context_aware

use_client_certificate

If True, use client certificate to authorize user device using Context-awareaccess. This includes user login as well. Some services may not support clientcertificate authorization. If a command sends requests to such services, theclient certificate will not be validated. Rungcloud topicclient-certificate for list of services supporting this feature.

dataflow

disable_public_ips

Specifies that Cloud Dataflow workers must not use public IP addresses.

enable_streaming_engine

Set this to true to enable Streaming Engine for the job.

print_only

Prints the container spec to stdout. Does not save in Google Cloud Storage.

datafusion

location

Datafusion location to use. Each Datafusion location constitutes an independentresource namespace constrained to deploying environments into Compute Engineregions inside this location. This parameter corresponds to the/locations/<location> segment of the Datafusion resource URIs beingreferenced.

datapipelines

disable_public_ips

Specifies that Cloud Dataflow workers must not use public IP addresses.

enable_streaming_engine

Set this to true to enable Streaming Engine for the job.

dataplex

asset

Dataplex asset to use. When anasset is required but not providedby a flag, the command will fall back to this value, if set.

lake

Dataplex lake to use. When alake is required but not provided by aflag, the command will fall back to this value, if set.

location

Dataplex location to use. When alocation is required but notprovided by a flag, the command will fall back to this value, if set.

zone

Dataplex zone to use. When azone is required but not provided by aflag, the command will fall back to this value, if set.

dataproc

location

Dataproc location to use. Each Dataproc location constitutes an independentresource namespace constrained to deploying instances into Compute Engine zonesinside the location.

region

Dataproc region to use. Each Dataproc region constitutes an independent resourcenamespace constrained to deploying instances into Compute Engine zones insidethe region.

deploy

delivery_pipeline

Delivery Pipeline being managed by Cloud Deploy.

region

Cloud Deploy region to use. Each Cloud Deploy region constitutes an independentresource namespace constrained to deploying instances into Compute Engine zonesinside the region.

deployment_manager

glob_imports

Enable import path globbing. Uses glob patterns to match multiple imports in aconfig file.

eventarc

location

The default location to use when working with Eventarc resources. This should beeitherglobal or one of the supportedregions. When a--location flag is required but not provided, thecommand will fall back to this value, if set.

filestore

location

Please use the--location flag or set the filestore/zone orfilestore/region property.

region

Default region to use when working with Cloud Filestore regions. When a--region flag is required but not provided, the command will fallback to this value, if set.

zone

Default zone to use when working with Cloud Filestore zones. When a--zone flag is required but not provided, the command will fallback to this value, if set.

functions

gen2

Default environment to use when working with Cloud Functions resources. Whenneither--gen2 nor--no-gen2 is provided, the decisionof whether to use Generation 2 falls back to this value if set.

region

Default region to use when working with Cloud Functions resources. When a--region flag is required but not provided, the command will fallback to this value, if set. To see valid choices, rungcloud beta functionsregions list.

gcloudignore

enabled

If True, do not upload.gcloudignore files (see$gcloud topicgcloudignore). If False, turn off the gcloudignore mechanism entirelyand upload all files.

gkebackup

backup

Default backup ID to use when working with Backup for GKE Services resources.When a--backup flag is required but not provided, the command willfall back to this value.

backup_plan

Default backup plan ID to use when working with Backup for GKE Servicesresources. When a--backup-plan flag is required but not provided,the command will fall back to this value.

location

Default location to use when working with Backup for GKE Services resources.When a--location flag is required but not provided, the commandwill fall back to this value.

restore

Default restore ID to use when working with Backup for GKE Services resources.When a--restore flag is required but not provided, the commandwill fall back to this value.

restore_plan

Default restore plan ID to use when working with Backup for GKE Servicesresources. When a--restore-plan flag is required but not provided,the command will fall back to this value.

healthcare

dataset

Default dataset to use when working with Cloud Healthcare resources. When a--dataset flag is required but not provided, the command will fallback to this value, if set.

location

Default location to use when working with Cloud Healthcare resources. When a--location flag is required but not provided, the command will fallback to this value.

interactive

bottom_bindings_line

If True, display the bottom key bindings line.

bottom_status_line

If True, display the bottom status line.

completion_menu_lines

Number of lines in the completion menu.

context

Command context string.

fixed_prompt_position

If True, display the prompt at the same position.

help_lines

Maximum number of help snippet lines.

hidden

If True, expose hidden commands/flags.

justify_bottom_lines

If True, left- and right-justify bottom toolbar lines.

manpage_generator

If True, use the manpage CLI tree generator for unsupported commands.

multi_column_completion_menu

If True, display the completions as a multi-column menu.

prompt

Command prompt string.

show_help

If True, show help as command args are being entered.

suggest

If True, add command line suggestions based on history.

lifesciences

location

Default location to use when working with Cloud Life Sciences resources. When a--location flag is required but not provided, the command will fallback to this value.

looker

region

Default region to use when working with Cloud Looker resources. When aregion is required but not provided by a flag, the command willfall back to this value, if set.

lustre

location

Default location to use when working with Cloud Lustre resources. When alocation value is required but not provided, the command will fallback to this value, if set.

media_asset

location

Default location to use when working with Cloud Media Asset resources. When a--location flag is required but not provided, the command will fallback to this value.

memcache

region

Default region to use when working with Cloud Memorystore for Memcachedresources. When aregion is required but not provided by a flag,the command will fall back to this value, if set.

metastore

location

Default location to use when working with Dataproc Metastore. When alocation is required but not provided by a flag, the command willfall back to this value, if set.

tier

Default tier to use when creating Dataproc Metastore services. When atier is required but not provided by a flag, the command will fallback to this value, if set.

Valid values are:

• developer - The developer tier provides limited scalability and nofault tolerance. Good for low-cost proof-of-concept.
• enterprise - The enterprise tier provides multi-zone highavailability, and sufficient scalability for enterprise-level Dataproc Metastoreworkloads.

ml_engine

local_python

Full path to the Python interpreter to use for Cloud ML Engine localpredict/train jobs. If not specified, the default path is the one to the Pythoninterpreter found on systemPATH.

polling_interval

Interval (in seconds) at which to poll logs from your Cloud ML Engine jobs. Notethat making it much faster than the default (60) will quickly use all of yourquota.

mps

product

Id for Marketplace Solutions Product.

netapp

location

Default location to use when working with Cloud NetApp Files resources. When alocation value is required but not provided, the command will fallback to this value, if set.

notebooks

location

Default location to use when working with Notebook resources. When alocation value is required but not provided, the command will fallback to this value, if set.

privateca

location

Default location to use when working with Private CA resources. When a--location flag is required but not provided, the command will fallback to this value, if set.

proxy

address

Hostname or IP address of proxy server.

password

Password to use when connecting, if the proxy requires authentication.

port

Port to use when connected to the proxy server.

rdns

If True, DNS queries will not be performed locally, and instead, handed to theproxy to resolve. This is default behavior.

type

Type of proxy being used. Supported proxy types are: [http, http_no_tunnel,socks4, socks5].

username

Username to use when connecting, if the proxy requires authentication.

redis

region

Default region to use when working with Cloud Memorystore for Redis resources.When aregion is required but not provided by a flag, the commandwill fall back to this value, if set.

run

cluster

ID of the cluster or fully qualified identifier for the cluster

cluster_location

Zone or region in which the cluster is located.

platform

Target platform for running commands.

region

Default region to use when working with Cloud Run resources. When a--region flag is required but not provided, the command will fallback to this value, if set.

runapps

deployment_service_account

Service account to use when deploying integrations.

scc

organization

Default organizationgcloudshould use for scc surface.

parent

Default parentgcloud shoulduse for scc surface.

secrets

locations

A comma separated list of the locations to replicate secrets to. Only applies tosecrets with a user-managed policy.

replication-policy

The type of replication policy to apply to secrets. Allowed values are"automatic" and "user-managed". If user-managed then locations must also beprovided.

spanner

instance

Default instance to use when working with Cloud Spanner resources. When aninstance is required but not provided by a flag, the command will fall back tothis value, if set.

ssh

putty_force_connect

Whether or notgcloud shouldautomatically accept new or changed host keys when executing plink/pscp commandson Windows. Defaults to True, but can be set to False to present theseinteractive prompts to the user for host key checking.

verify_internal_ip

Whether or notgcloud shouldperform an initial SSH connection to verify an instance ID is correct whenconnecting via its internal IP. Without this check,gcloud will simply connect to theinternal IP of the desired instance, which may be wrong if the desired instanceis in a different subnet but happens to share the same internal IP as aninstance in the current subnet. Defaults to True.

storage

additional_headers

Includes arbitrary headers in storage API calls. Accepts a comma separated listof key=value pairs, e.g.header1=value1,header2=value2.

base_retry_delay

Second delay between retrying operations. May be multiplied byexponential_sleep_multiplier.

check_hashes

'check_hashes' specifies how strictly to require integrity checking fordownloaded data. Legal values are:

• 'if_fast_else_fail' - (default) Only integrity check if the digest will runefficiently (using compiled code), else fail the download.

• 'if_fast_else_skip' - Only integrity check if the server supplies a hash and thelocal digest computation will run quickly, else skip the check.

• 'always' - Always check download integrity regardless of possible performancecosts.

• 'never' - Don't perform download integrity checks. This setting is notrecommended except for special cases such as measuring download performanceexcluding time for integrity checking.

This option exists to assist users who wish to download a composite object andare unable to install crcmod with the C-extension. CRC32c is the only availableintegrity check for composite objects, and without the C-extension, downloadperformance can be significantly degraded by the digest computation. This optionis ignored for daisy-chain copies, which don't compute hashes but instead(inexpensively) compare the cloud source and destination hashes.

check_mv_early_deletion_fee

Block mv commands that may incur an early deletion fee (the source object in amv is deleted).

convert_incompatible_windows_path_characters

Allows automatic conversion of invalid path characters on Windows. If notenabled, Windows will raise an OSError if an invalid character is encountered.

copy_chunk_size

Chunk size used for copying to in clouds or on disk.

download_chunk_size

Chunk size used for downloading to clouds.

exponential_sleep_multiplier

Used in exponential backoff for retrying operations.

key_store_path

Path to a yaml file containing an encryption key, and multiple decryption keysfor use in storage commands. The file must be formatted as follows:

encryption_key:{Acustomer-suppliedorcustomer-managedkey.}decryption_keys:-{Acustomer-suppliedkey}…

Customer-supplied encryption keys must be RFC 4648 section 4 base64-encodedAES256 strings. Customer-managed encryption keys must be of the formprojects/{project}/locations/{location}/keyRings/{key-ring}/cryptoKeys/{crypto-key}.

max_retries

Max number of retries for operations like copy.

max_retry_delay

Max second delay between retriable operations.

multipart_chunksize

Specifies partition size in bytes of each part of a multipart upload made by theBoto3 client. To calculate the maximum size of a Boto3 client multipart upload,multiply the multipart_chunk value by the maximum number of parts the APIallows. For AWS S3 this limit is 10000. Values can be provided either in bytesor as human-readable values (e.g., "150M" to represent 150 mebibytes).

multipart_threshold

Files larger than this threshold will be partitioned into parts, uploadedseparately by the Boto3 client, and then combined into a single object.Otherwise, files smaller than this threshold will be uploaded by the Boto3client in a single stream.

parallel_composite_upload_compatibility_check

Determines if the GET bucket call should be performed to check if the defaultstorage class and retention period for the destination bucket meet the criteriafor parallel composite upload.

parallel_composite_upload_component_prefix

The prefix used when naming temporary components created by composite uploads.If the prefix begins with a/, the temporary components areuploaded relative to the bucket name. If the prefix does not begin with a/, the temporary components are uploaded relative to the prefixportion of the destination object name. For example, consider an upload thatwill create a final object namedgs://bucket/dir1/dir2/object.Using a prefix of/prefix means temporary components use names likegs://bucket/prefix/COMPONENT_NAME. Using a prefix ofprefix means temporary components use names likegs://bucket/dir1/dir2/prefix/COMPONENT_NAME. Note that this cancomplicate cleaning up temporary components, as they will not all share a commonprefix. If this property is not specified, gcloud storage uses the prefix/gcloud/tmp/parallel_composite_uploads/see_gcloud_storage_cp_help_for_details/.If a chosen prefix results in temporary component names longer than the maximumlength Cloud Storage allows, gcloud storage performs a non-composite upload.

parallel_composite_upload_component_size

Specifies the ideal size of a component in bytes, which will act as an upperbound to the size of the components if ceil(file_size /parallel_composite_upload_component_size) is less than the maximum number ofobjects the API allows composing at once. Values can be provided either in bytesor as human-readable values (e.g., "150M" to represent 150 mebibytes).

parallel_composite_upload_enabled

Determines whether parallel composite upload should be used. Default value isNone which will use parallel composite upload and log an appropriate warning forthe user explaining that parallel composite upload is being used by default.

parallel_composite_upload_threshold

Specifies the maximum size of a file to upload in a single stream. Files largerthan this threshold will be partitioned into component parts, uploaded inparallel, then composed into a single object. The number of components will bethe smaller of ceil(file_size / parallel_composite_upload_component_size) andthe maximum number of objects the API allows composing at once. For CloudStorage this limit is 32. This property has no effect ifparallel_composite_upload_enabled is set to False.

process_count

The maximum number of processes parallel execution should use. Whenprocess_count and thread_count are both 1, commands use sequential execution.

resumable_threshold

File operations above this size in bytes will use resumable instead of one-shotstrategies. For example, a resumable download.

rsync_files_directory

Directory path to intermediary files created by rsync.

rsync_list_chunk_size

Number of files processed at a time by the rsync command when it builds andcompares the list of files at the source and destination.

s3_endpoint_url

If set, boto3 client will connect to this endpoint. Otherwise, boto3 selects adefault endpoint based on the AWS service used.

sliced_object_download_component_size

Target size and upper bound for files to be sliced into. Analogous toparallel_composite_upload_component_size.

sliced_object_download_max_components

Specifies the maximum number of slices to be used when performing a slicedobject download. Set None for automatic optimization based on system resources.

sliced_object_download_threshold

Slice files larger than this value. Zero will block sliced downloads. Analogousto parallel_composite_upload_threshold.

suggest_transfer

If True, logs messages about when Storage Transfer Service might be a bettertool than gcloud storage.

thread_count

The number of threads parallel execution should use per process. Whenprocess_count and thread_count are both 1, commands use sequential execution.

tracker_files_directory

Directory path to tracker files for resumable operations.

upload_chunk_size

Chunk size used for uploading to clouds.

use_gcloud_crc32c

If True, data integrity checks use a binary subprocess to calculate CRC32Chashes with the included gcloud-crc32c tool rather than the google-crc32c Pythonlibrary. This behavior is also triggered when the google-crc32c Python libraryis unavailable even if this property is False.

use_gsutil

If True, use the deprecated upload implementation which uses gsutil.

use_gsutil_rsync_delete_unmatched_destination_objects_behavior

If True, rsync will preserve unmatched destination objects while using--delete-unmatched-destination-objects flag along with other flags such as--no-clobber, --skip-unsupported and --skip-if-dest-has-newer-mtime just as itwould with gsutil.

use_magicfile

If True, uses thefile --mime <filename> command to guesscontent types instead of the default filename extension-based mechanism.Available on UNIX and macOS (and possibly on Windows, if you're running Cygwinor some other package that provides implementations of UNIX-like commands). Whenavailable and enabled use_magicfile should be more robust because it analyzesfile contents in addition to extensions.

use_threading_local

If True, reuses some resource if they are already declared on a thread. IfFalse, creates duplicates of resources like API clients on the same thread.Turning off can help with some bugs but will hurt performance.

survey

disable_prompts

If True, gcloud will not prompt you to take periodic usage experience surveys.

vmware

region

Default region to use when working with VMware Engine resources. When a--region flag is required but not provided, the command will fallback to this value, if set.

workstations

cluster

Default cluster to use when working with Workstations resources. When a--cluster flag is required but not provided, the command will fallback to this value, if set.

config

Default configuration to use when working with Workstations resources. When a--config flag is required but not provided, the command will fallback to this value, if set.

region

Default region to use when working with Workstations resources. When a--region flag is required but not provided, the command will fallback to this value, if set.