google-apis-rs/google_sql1_beta4_cli/search/search_index.json

{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"The sql1-beta4 command-line interface (CLI) allows to use most features of the Google SQL Admin service from the comfort of your terminal. By default all output is printed to standard out, but flags can be set to direct it into a file independent of your shell's capabilities. Errors will be printed to standard error, and cause the program's exit code to be non-zero. If data-structures are requested, these will be returned as pretty-printed JSON, to be useful as input to other tools. Everything else about the SQL Admin API can be found at the official documentation site . Installation and Source Code Install the command-line interface with cargo using: cargo install google-sql1_beta4-cli Find the source code on github . Usage This documentation was generated from the SQL Admin API at revision 20200331 . The CLI is at version 5.0.4 . sql1-beta4 [options] backup-runs delete <project> <instance> <id> [-p <v>]... [-o <out>] get <project> <instance> <id> [-p <v>]... [-o <out>] insert <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>] list <project> <instance> [-p <v>]... [-o <out>] databases delete <project> <instance> <database> [-p <v>]... [-o <out>] get <project> <instance> <database> [-p <v>]... [-o <out>] insert <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>] list <project> <instance> [-p <v>]... [-o <out>] patch <project> <instance> <database> (-r <kv>)... [-p <v>]... [-o <out>] update <project> <instance> <database> (-r <kv>)... [-p <v>]... [-o <out>] flags list [-p <v>]... [-o <out>] instances add-server-ca <project> <instance> [-p <v>]... [-o <out>] clone <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>] delete <project> <instance> [-p <v>]... [-o <out>] demote-master <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>] export <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>] failover <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>] get <project> <instance> [-p <v>]... [-o <out>] import <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>] insert <project> (-r <kv>)... [-p <v>]... [-o <out>] list <project> [-p <v>]... [-o <out>] list-server-cas <project> <instance> [-p <v>]... [-o <out>] patch <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>] promote-replica <project> <instance> [-p <v>]... [-o <out>] reset-ssl-config <project> <instance> [-p <v>]... [-o <out>] restart <project> <instance> [-p <v>]... [-o <out>] restore-backup <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>] rotate-server-ca <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>] start-replica <project> <instance> [-p <v>]... [-o <out>] stop-replica <project> <instance> [-p <v>]... [-o <out>] truncate-log <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>] update <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>] operations get <project> <operation> [-p <v>]... [-o <out>] list <project> [-p <v>]... [-o <out>] projects instances-reschedule-maintenance <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>] instances-start-external-sync <project> <instance> [-p <v>]... [-o <out>] instances-verify-external-sync-settings <project> <instance> [-p <v>]... [-o <out>] ssl-certs create-ephemeral <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>] delete <project> <instance> <sha1-fingerprint> [-p <v>]... [-o <out>] get <project> <instance> <sha1-fingerprint> [-p <v>]... [-o <out>] insert <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>] list <project> <instance> [-p <v>]... [-o <out>] tiers list <project> [-p <v>]... [-o <out>] users delete <project> <instance> [-p <v>]... [-o <out>] insert <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>] list <project> <instance> [-p <v>]... [-o <out>] update <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>] sql1-beta4 --help Configuration: [--scope <url>]... Specify the authentication a method should be executed in. Each scope requires the user to grant this application permission to use it. If unset, it defaults to the shortest scope url for a particular method. --config-dir <folder> A directory into which we will store our persistent data. Defaults to a user-writable directory that we will create during the first invocation. [default: ~/.google-service-cli] Configuration The program will store all persistent data in the ~/.google-service-cli directory in JSON files prefixed with sql1-beta4- . You can change the directory used to store configuration with the --config-dir flag on a per-invocation basis. More information about the various kinds of persistent data are given in the following paragraphs. Authentication Most APIs require a user to authenticate any request. If this is the case, the scope determines the set of permissions granted. The granularity of these is usually no more than read-only or full-access . If not set, the system will automatically select the smallest feasible scope, e.g. when invoking a method that is read-only, it will ask only for a read-only scope. You may use the --scope flag to specify a scope directly. All applicable scopes are documented in the respective method's CLI documentation. The first time a scope is used, the user is asked for permission. Follow the instructions given by the CLI to grant permissions, or to decline. If a scope was authenticated by the user, the respective information will be stored as JSON in the configuration directory, e.g. ~/.google-service-cli/sql1-beta4-token-<scope-hash>.json . No manual management of these tokens is necessary. To revoke granted authentication, please refer to the official documentation . Application Secrets In order to allow any application to use Google services, it will need to be registered using the Google Developer Console . APIs the application may use are then enabled for it one by one. Most APIs can be used for free and have a daily quota. To allow more comfortable usage of the CLI without forcing anyone to register an own application, the CLI comes with a default application secret that is configured accordingly. This also means that heavy usage all around the world may deplete the daily quota. You can workaround this limitation by putting your own secrets file at this location: ~/.google-service-cli/sql1-beta4-secret.json , assuming that the required sql API was enabled for it. Such a secret file can be downloaded in the Google Developer Console at APIs & auth -> Credentials -> Download JSON and used as is. Learn more about how to setup Google projects and enable APIs using the official documentation . Debugging Even though the CLI does its best to provide usable error messages, sometimes it might be desirable to know what exactly led to a particular issue. This is done by allowing all client-server communication to be output to standard error as-is . The --debug flag will print errors using the Debug representation to standard error. You may consider redirecting standard error into a file for ease of use, e.g. sql1-beta4 --debug <resource> <method> [options] 2>debug.txt .","title":"Home"},{"location":"#installation-and-source-code","text":"Install the command-line interface with cargo using: cargo install google-sql1_beta4-cli Find the source code on github .","title":"Installation and Source Code"},{"location":"#usage","text":"This documentation was generated from the SQL Admin API at revision 20200331 . The CLI is at version 5.0.4 . sql1-beta4 [options] backup-runs delete <project> <instance> <id> [-p <v>]... [-o <out>] get <project> <instance> <id> [-p <v>]... [-o <out>] insert <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>] list <project> <instance> [-p <v>]... [-o <out>] databases delete <project> <instance> <database> [-p <v>]... [-o <out>] get <project> <instance> <database> [-p <v>]... [-o <out>] insert <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>] list <project> <instance> [-p <v>]... [-o <out>] patch <project> <instance> <database> (-r <kv>)... [-p <v>]... [-o <out>] update <project> <instance> <database> (-r <kv>)... [-p <v>]... [-o <out>] flags list [-p <v>]... [-o <out>] instances add-server-ca <project> <instance> [-p <v>]... [-o <out>] clone <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>] delete <project> <instance> [-p <v>]... [-o <out>] demote-master <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>] export <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>] failover <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>] get <project> <instance> [-p <v>]... [-o <out>] import <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>] insert <project> (-r <kv>)... [-p <v>]... [-o <out>] list <project> [-p <v>]... [-o <out>] list-server-cas <project> <instance> [-p <v>]... [-o <out>] patch <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>] promote-replica <project> <instance> [-p <v>]... [-o <out>] reset-ssl-config <project> <instance> [-p <v>]... [-o <out>] restart <project> <instance> [-p <v>]... [-o <out>] restore-backup <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>] rotate-server-ca <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>] start-replica <project> <instance> [-p <v>]... [-o <out>] stop-replica <project> <instance> [-p <v>]... [-o <out>] truncate-log <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>] update <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>] operations get <project> <operation> [-p <v>]... [-o <out>] list <project> [-p <v>]... [-o <out>] projects instances-reschedule-maintenance <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>] instances-start-external-sync <project> <instance> [-p <v>]... [-o <out>] instances-verify-external-sync-settings <project> <instance> [-p <v>]... [-o <out>] ssl-certs create-ephemeral <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>] delete <project> <instance> <sha1-fingerprint> [-p <v>]... [-o <out>] get <project> <instance> <sha1-fingerprint> [-p <v>]... [-o <out>] insert <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>] list <project> <instance> [-p <v>]... [-o <out>] tiers list <project> [-p <v>]... [-o <out>] users delete <project> <instance> [-p <v>]... [-o <out>] insert <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>] list <project> <instance> [-p <v>]... [-o <out>] update <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>] sql1-beta4 --help Configuration: [--scope <url>]... Specify the authentication a method should be executed in. Each scope requires the user to grant this application permission to use it. If unset, it defaults to the shortest scope url for a particular method. --config-dir <folder> A directory into which we will store our persistent data. Defaults to a user-writable directory that we will create during the first invocation. [default: ~/.google-service-cli]","title":"Usage"},{"location":"#configuration","text":"The program will store all persistent data in the ~/.google-service-cli directory in JSON files prefixed with sql1-beta4- . You can change the directory used to store configuration with the --config-dir flag on a per-invocation basis. More information about the various kinds of persistent data are given in the following paragraphs.","title":"Configuration"},{"location":"#authentication","text":"Most APIs require a user to authenticate any request. If this is the case, the scope determines the set of permissions granted. The granularity of these is usually no more than read-only or full-access . If not set, the system will automatically select the smallest feasible scope, e.g. when invoking a method that is read-only, it will ask only for a read-only scope. You may use the --scope flag to specify a scope directly. All applicable scopes are documented in the respective method's CLI documentation. The first time a scope is used, the user is asked for permission. Follow the instructions given by the CLI to grant permissions, or to decline. If a scope was authenticated by the user, the respective information will be stored as JSON in the configuration directory, e.g. ~/.google-service-cli/sql1-beta4-token-<scope-hash>.json . No manual management of these tokens is necessary. To revoke granted authentication, please refer to the official documentation .","title":"Authentication"},{"location":"#application-secrets","text":"In order to allow any application to use Google services, it will need to be registered using the Google Developer Console . APIs the application may use are then enabled for it one by one. Most APIs can be used for free and have a daily quota. To allow more comfortable usage of the CLI without forcing anyone to register an own application, the CLI comes with a default application secret that is configured accordingly. This also means that heavy usage all around the world may deplete the daily quota. You can workaround this limitation by putting your own secrets file at this location: ~/.google-service-cli/sql1-beta4-secret.json , assuming that the required sql API was enabled for it. Such a secret file can be downloaded in the Google Developer Console at APIs & auth -> Credentials -> Download JSON and used as is. Learn more about how to setup Google projects and enable APIs using the official documentation .","title":"Application Secrets"},{"location":"#debugging","text":"Even though the CLI does its best to provide usable error messages, sometimes it might be desirable to know what exactly led to a particular issue. This is done by allowing all client-server communication to be output to standard error as-is . The --debug flag will print errors using the Debug representation to standard error. You may consider redirecting standard error into a file for ease of use, e.g. sql1-beta4 --debug <resource> <method> [options] 2>debug.txt .","title":"Debugging"},{"location":"backup-runs_delete/","text":"Deletes the backup taken by a backup run. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> backup-runs delete ... Required Scalar Arguments <project> (string) Project ID of the project that contains the instance. <instance> (string) Cloud SQL instance ID. This does not include the project ID. <id> (string) The ID of the Backup Run to delete. To find a Backup Run ID, use the <a href=\"/sql/docs/db_path/admin-api/rest/v1beta4/backupRuns/list\">list</a> method. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Delete"},{"location":"backup-runs_delete/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> backup-runs delete ...","title":"Scopes"},{"location":"backup-runs_delete/#required-scalar-arguments","text":"<project> (string) Project ID of the project that contains the instance. <instance> (string) Cloud SQL instance ID. This does not include the project ID. <id> (string) The ID of the Backup Run to delete. To find a Backup Run ID, use the <a href=\"/sql/docs/db_path/admin-api/rest/v1beta4/backupRuns/list\">list</a> method.","title":"Required Scalar Arguments"},{"location":"backup-runs_delete/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"backup-runs_delete/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"backup-runs_get/","text":"Retrieves a resource containing information about a backup run. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> backup-runs get ... Required Scalar Arguments <project> (string) Project ID of the project that contains the instance. <instance> (string) Cloud SQL instance ID. This does not include the project ID. <id> (string) The ID of this Backup Run. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Get"},{"location":"backup-runs_get/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> backup-runs get ...","title":"Scopes"},{"location":"backup-runs_get/#required-scalar-arguments","text":"<project> (string) Project ID of the project that contains the instance. <instance> (string) Cloud SQL instance ID. This does not include the project ID. <id> (string) The ID of this Backup Run.","title":"Required Scalar Arguments"},{"location":"backup-runs_get/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"backup-runs_get/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"backup-runs_insert/","text":"Creates a new backup run on demand. This method is applicable only to Second Generation instances. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> backup-runs insert ... Required Scalar Arguments <project> (string) Project ID of the project that contains the instance. <instance> (string) Cloud SQL instance ID. This does not include the project ID. Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: BackupRun: description: string disk-encryption-configuration: kind: string kms-key-name: string disk-encryption-status: kind: string kms-key-version-name: string end-time: string enqueued-time: string error: code: string kind: string message: string id: string instance: string kind: string location: string self-link: string start-time: string status: string type: string window-start-time: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . description=et The description of this run, only applicable to on-demand backups. disk-encryption-configuration kind=magna This is always <code>sql#diskEncryptionConfiguration</code>. kms-key-name=no Resource name of KMS key for disk encryption ..disk-encryption-status kind=ipsum This is always <code>sql#diskEncryptionStatus</code>. kms-key-version-name=voluptua. KMS key version used to encrypt the Cloud SQL instance resource .. end-time=at The time the backup operation completed in UTC timezone in <a href=\"https://tools.ietf.org/html/rfc3339\">RFC 3339</a> format, for example <code>2012-11-15T16:19:00.094Z</code>. enqueued-time=sanctus The time the run was enqueued in UTC timezone in <a href=\"https://tools.ietf.org/html/rfc3339\">RFC 3339</a> format, for example <code>2012-11-15T16:19:00.094Z</code>. error code=sed Identifies the specific error that occurred. kind=amet. This is always <code>sql#operationError</code>. message=takimata Additional information about the error encountered. .. id=amet. The identifier for this backup run. Unique only for a specific Cloud SQL instance. instance=duo Name of the database instance. kind=ipsum This is always <code>sql#backupRun</code>. location=gubergren Location of the backups. self-link=lorem The URI of this resource. start-time=gubergren The time the backup operation actually started in UTC timezone in <a href=\"https://tools.ietf.org/html/rfc3339\">RFC 3339</a> format, for example <code>2012-11-15T16:19:00.094Z</code>. status=eos The status of this run. type=dolor The type of this run; can be either \"AUTOMATED\" or \"ON_DEMAND\". window-start-time=ea The start time of the backup window during which this the backup was attempted in <a href=\"https://tools.ietf.org/html/rfc3339\">RFC 3339</a> format, for example <code>2012-11-15T16:19:00.094Z</code>. About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Insert"},{"location":"backup-runs_insert/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> backup-runs insert ...","title":"Scopes"},{"location":"backup-runs_insert/#required-scalar-arguments","text":"<project> (string) Project ID of the project that contains the instance. <instance> (string) Cloud SQL instance ID. This does not include the project ID.","title":"Required Scalar Arguments"},{"location":"backup-runs_insert/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: BackupRun: description: string disk-encryption-configuration: kind: string kms-key-name: string disk-encryption-status: kind: string kms-key-version-name: string end-time: string enqueued-time: string error: code: string kind: string message: string id: string instance: string kind: string location: string self-link: string start-time: string status: string type: string window-start-time: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . description=et The description of this run, only applicable to on-demand backups. disk-encryption-configuration kind=magna This is always <code>sql#diskEncryptionConfiguration</code>. kms-key-name=no Resource name of KMS key for disk encryption ..disk-encryption-status kind=ipsum This is always <code>sql#diskEncryptionStatus</code>. kms-key-version-name=voluptua. KMS key version used to encrypt the Cloud SQL instance resource .. end-time=at The time the backup operation completed in UTC timezone in <a href=\"https://tools.ietf.org/html/rfc3339\">RFC 3339</a> format, for example <code>2012-11-15T16:19:00.094Z</code>. enqueued-time=sanctus The time the run was enqueued in UTC timezone in <a href=\"https://tools.ietf.org/html/rfc3339\">RFC 3339</a> format, for example <code>2012-11-15T16:19:00.094Z</code>. error code=sed Identifies the specific error that occurred. kind=amet. This is always <code>sql#operationError</code>. message=takimata Additional information about the error encountered. .. id=amet. The identifier for this backup run. Unique only for a specific Cloud SQL instance. instance=duo Name of the database instance. kind=ipsum This is always <code>sql#backupRun</code>. location=gubergren Location of the backups. self-link=lorem The URI of this resource. start-time=gubergren The time the backup operation actually started in UTC timezone in <a href=\"https://tools.ietf.org/html/rfc3339\">RFC 3339</a> format, for example <code>2012-11-15T16:19:00.094Z</code>. status=eos The status of this run. type=dolor The type of this run; can be either \"AUTOMATED\" or \"ON_DEMAND\". window-start-time=ea The start time of the backup window during which this the backup was attempted in <a href=\"https://tools.ietf.org/html/rfc3339\">RFC 3339</a> format, for example <code>2012-11-15T16:19:00.094Z</code>.","title":"Required Request Value"},{"location":"backup-runs_insert/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"backup-runs_insert/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"backup-runs_insert/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"backup-runs_list/","text":"Lists all backup runs associated with a given instance and configuration in the reverse chronological order of the backup initiation time. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> backup-runs list ... Required Scalar Arguments <project> (string) Project ID of the project that contains the instance. <instance> (string) Cloud SQL instance ID. This does not include the project ID. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional Method Properties You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p max-results=integer Maximum number of backup runs per response. -p page-token=string A previously-returned page token representing part of the larger set of results to view. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"List"},{"location":"backup-runs_list/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> backup-runs list ...","title":"Scopes"},{"location":"backup-runs_list/#required-scalar-arguments","text":"<project> (string) Project ID of the project that contains the instance. <instance> (string) Cloud SQL instance ID. This does not include the project ID.","title":"Required Scalar Arguments"},{"location":"backup-runs_list/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"backup-runs_list/#optional-method-properties","text":"You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p max-results=integer Maximum number of backup runs per response. -p page-token=string A previously-returned page token representing part of the larger set of results to view.","title":"Optional Method Properties"},{"location":"backup-runs_list/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"databases_delete/","text":"Deletes a database from a Cloud SQL instance. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> databases delete ... Required Scalar Arguments <project> (string) Project ID of the project that contains the instance. <instance> (string) Database instance ID. This does not include the project ID. <database> (string) Name of the database to be deleted in the instance. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Delete"},{"location":"databases_delete/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> databases delete ...","title":"Scopes"},{"location":"databases_delete/#required-scalar-arguments","text":"<project> (string) Project ID of the project that contains the instance. <instance> (string) Database instance ID. This does not include the project ID. <database> (string) Name of the database to be deleted in the instance.","title":"Required Scalar Arguments"},{"location":"databases_delete/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"databases_delete/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"databases_get/","text":"Retrieves a resource containing information about a database inside a Cloud SQL instance. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> databases get ... Required Scalar Arguments <project> (string) Project ID of the project that contains the instance. <instance> (string) Database instance ID. This does not include the project ID. <database> (string) Name of the database in the instance. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Get"},{"location":"databases_get/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> databases get ...","title":"Scopes"},{"location":"databases_get/#required-scalar-arguments","text":"<project> (string) Project ID of the project that contains the instance. <instance> (string) Database instance ID. This does not include the project ID. <database> (string) Name of the database in the instance.","title":"Required Scalar Arguments"},{"location":"databases_get/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"databases_get/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"databases_insert/","text":"Inserts a resource containing information about a database inside a Cloud SQL instance. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> databases insert ... Required Scalar Arguments <project> (string) Project ID of the project that contains the instance. <instance> (string) Database instance ID. This does not include the project ID. Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: Database: charset: string collation: string etag: string instance: string kind: string name: string project: string self-link: string sqlserver-database-details: compatibility-level: integer recovery-model: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . charset=ipsum The MySQL charset value. collation=invidunt The MySQL collation value. etag=amet This field is deprecated and will be removed from a future version of the API. instance=duo The name of the Cloud SQL instance. This does not include the project ID. kind=ipsum This is always <code>sql#database</code>. name=sed The name of the database in the Cloud SQL instance. This does not include the project ID or instance name. project=ut The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. self-link=gubergren The URI of this resource. sqlserver-database-details compatibility-level=85 The version of SQL Server with which the database is to be made compatible recovery-model=est The recovery model of a SQL Server database About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Insert"},{"location":"databases_insert/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> databases insert ...","title":"Scopes"},{"location":"databases_insert/#required-scalar-arguments","text":"<project> (string) Project ID of the project that contains the instance. <instance> (string) Database instance ID. This does not include the project ID.","title":"Required Scalar Arguments"},{"location":"databases_insert/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: Database: charset: string collation: string etag: string instance: string kind: string name: string project: string self-link: string sqlserver-database-details: compatibility-level: integer recovery-model: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . charset=ipsum The MySQL charset value. collation=invidunt The MySQL collation value. etag=amet This field is deprecated and will be removed from a future version of the API. instance=duo The name of the Cloud SQL instance. This does not include the project ID. kind=ipsum This is always <code>sql#database</code>. name=sed The name of the database in the Cloud SQL instance. This does not include the project ID or instance name. project=ut The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. self-link=gubergren The URI of this resource. sqlserver-database-details compatibility-level=85 The version of SQL Server with which the database is to be made compatible recovery-model=est The recovery model of a SQL Server database","title":"Required Request Value"},{"location":"databases_insert/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"databases_insert/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"databases_insert/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"databases_list/","text":"Lists databases in the specified Cloud SQL instance. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> databases list ... Required Scalar Arguments <project> (string) Project ID of the project that contains the instance. <instance> (string) Cloud SQL instance ID. This does not include the project ID. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"List"},{"location":"databases_list/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> databases list ...","title":"Scopes"},{"location":"databases_list/#required-scalar-arguments","text":"<project> (string) Project ID of the project that contains the instance. <instance> (string) Cloud SQL instance ID. This does not include the project ID.","title":"Required Scalar Arguments"},{"location":"databases_list/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"databases_list/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"databases_patch/","text":"Partially updates a resource containing information about a database inside a Cloud SQL instance. This method supports patch semantics. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> databases patch ... Required Scalar Arguments <project> (string) Project ID of the project that contains the instance. <instance> (string) Database instance ID. This does not include the project ID. <database> (string) Name of the database to be updated in the instance. Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: Database: charset: string collation: string etag: string instance: string kind: string name: string project: string self-link: string sqlserver-database-details: compatibility-level: integer recovery-model: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . charset=ipsum The MySQL charset value. collation=ipsum The MySQL collation value. etag=est This field is deprecated and will be removed from a future version of the API. instance=gubergren The name of the Cloud SQL instance. This does not include the project ID. kind=ea This is always <code>sql#database</code>. name=dolor The name of the database in the Cloud SQL instance. This does not include the project ID or instance name. project=lorem The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. self-link=eos The URI of this resource. sqlserver-database-details compatibility-level=15 The version of SQL Server with which the database is to be made compatible recovery-model=sed The recovery model of a SQL Server database About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Patch"},{"location":"databases_patch/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> databases patch ...","title":"Scopes"},{"location":"databases_patch/#required-scalar-arguments","text":"<project> (string) Project ID of the project that contains the instance. <instance> (string) Database instance ID. This does not include the project ID. <database> (string) Name of the database to be updated in the instance.","title":"Required Scalar Arguments"},{"location":"databases_patch/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: Database: charset: string collation: string etag: string instance: string kind: string name: string project: string self-link: string sqlserver-database-details: compatibility-level: integer recovery-model: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . charset=ipsum The MySQL charset value. collation=ipsum The MySQL collation value. etag=est This field is deprecated and will be removed from a future version of the API. instance=gubergren The name of the Cloud SQL instance. This does not include the project ID. kind=ea This is always <code>sql#database</code>. name=dolor The name of the database in the Cloud SQL instance. This does not include the project ID or instance name. project=lorem The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. self-link=eos The URI of this resource. sqlserver-database-details compatibility-level=15 The version of SQL Server with which the database is to be made compatible recovery-model=sed The recovery model of a SQL Server database","title":"Required Request Value"},{"location":"databases_patch/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"databases_patch/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"databases_patch/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"databases_update/","text":"Updates a resource containing information about a database inside a Cloud SQL instance. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> databases update ... Required Scalar Arguments <project> (string) Project ID of the project that contains the instance. <instance> (string) Database instance ID. This does not include the project ID. <database> (string) Name of the database to be updated in the instance. Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: Database: charset: string collation: string etag: string instance: string kind: string name: string project: string self-link: string sqlserver-database-details: compatibility-level: integer recovery-model: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . charset=duo The MySQL charset value. collation=sed The MySQL collation value. etag=no This field is deprecated and will be removed from a future version of the API. instance=stet The name of the Cloud SQL instance. This does not include the project ID. kind=kasd This is always <code>sql#database</code>. name=et The name of the database in the Cloud SQL instance. This does not include the project ID or instance name. project=sed The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. self-link=et The URI of this resource. sqlserver-database-details compatibility-level=33 The version of SQL Server with which the database is to be made compatible recovery-model=vero The recovery model of a SQL Server database About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Update"},{"location":"databases_update/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> databases update ...","title":"Scopes"},{"location":"databases_update/#required-scalar-arguments","text":"<project> (string) Project ID of the project that contains the instance. <instance> (string) Database instance ID. This does not include the project ID. <database> (string) Name of the database to be updated in the instance.","title":"Required Scalar Arguments"},{"location":"databases_update/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: Database: charset: string collation: string etag: string instance: string kind: string name: string project: string self-link: string sqlserver-database-details: compatibility-level: integer recovery-model: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . charset=duo The MySQL charset value. collation=sed The MySQL collation value. etag=no This field is deprecated and will be removed from a future version of the API. instance=stet The name of the Cloud SQL instance. This does not include the project ID. kind=kasd This is always <code>sql#database</code>. name=et The name of the database in the Cloud SQL instance. This does not include the project ID or instance name. project=sed The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. self-link=et The URI of this resource. sqlserver-database-details compatibility-level=33 The version of SQL Server with which the database is to be made compatible recovery-model=vero The recovery model of a SQL Server database","title":"Required Request Value"},{"location":"databases_update/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"databases_update/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"databases_update/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"flags_list/","text":"List all available database flags for Cloud SQL instances. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> flags list ... Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional Method Properties You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p database-version=string Database type and version you want to retrieve flags for. By default, this method returns flags for all database types and versions. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"List"},{"location":"flags_list/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> flags list ...","title":"Scopes"},{"location":"flags_list/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"flags_list/#optional-method-properties","text":"You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p database-version=string Database type and version you want to retrieve flags for. By default, this method returns flags for all database types and versions.","title":"Optional Method Properties"},{"location":"flags_list/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"instances_add-server-ca/","text":"Add a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> instances add-server-ca ... Required Scalar Arguments <project> (string) Project ID of the project that contains the instance. <instance> (string) Cloud SQL instance ID. This does not include the project ID. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Add Server Ca"},{"location":"instances_add-server-ca/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> instances add-server-ca ...","title":"Scopes"},{"location":"instances_add-server-ca/#required-scalar-arguments","text":"<project> (string) Project ID of the project that contains the instance. <instance> (string) Cloud SQL instance ID. This does not include the project ID.","title":"Required Scalar Arguments"},{"location":"instances_add-server-ca/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"instances_add-server-ca/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"instances_clone/","text":"Creates a Cloud SQL instance as a clone of the source instance. Using this operation might cause your instance to restart. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> instances clone ... Required Scalar Arguments <project> (string) Project ID of the source as well as the clone Cloud SQL instance. <instance> (string) The ID of the Cloud SQL instance to be cloned (source). This does not include the project ID. Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: InstancesCloneRequest: clone-context: bin-log-coordinates: bin-log-file-name: string bin-log-position: string kind: string destination-instance-name: string kind: string pitr-timestamp-ms: string point-in-time: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .clone-context.bin-log-coordinates bin-log-file-name=erat Name of the binary log file for a Cloud SQL instance. bin-log-position=sed Position (offset) within the binary log file. kind=duo This is always <code>sql#binLogCoordinates</code>. .. destination-instance-name=dolore Name of the Cloud SQL instance to be created as a clone. kind=et This is always <code>sql#cloneContext</code>. pitr-timestamp-ms=voluptua. Reserved for future use. point-in-time=amet. Reserved for future use. About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Clone"},{"location":"instances_clone/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> instances clone ...","title":"Scopes"},{"location":"instances_clone/#required-scalar-arguments","text":"<project> (string) Project ID of the source as well as the clone Cloud SQL instance. <instance> (string) The ID of the Cloud SQL instance to be cloned (source). This does not include the project ID.","title":"Required Scalar Arguments"},{"location":"instances_clone/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: InstancesCloneRequest: clone-context: bin-log-coordinates: bin-log-file-name: string bin-log-position: string kind: string destination-instance-name: string kind: string pitr-timestamp-ms: string point-in-time: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .clone-context.bin-log-coordinates bin-log-file-name=erat Name of the binary log file for a Cloud SQL instance. bin-log-position=sed Position (offset) within the binary log file. kind=duo This is always <code>sql#binLogCoordinates</code>. .. destination-instance-name=dolore Name of the Cloud SQL instance to be created as a clone. kind=et This is always <code>sql#cloneContext</code>. pitr-timestamp-ms=voluptua. Reserved for future use. point-in-time=amet. Reserved for future use.","title":"Required Request Value"},{"location":"instances_clone/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"instances_clone/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"instances_clone/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"instances_delete/","text":"Deletes a Cloud SQL instance. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> instances delete ... Required Scalar Arguments <project> (string) Project ID of the project that contains the instance to be deleted. <instance> (string) Cloud SQL instance ID. This does not include the project ID. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Delete"},{"location":"instances_delete/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> instances delete ...","title":"Scopes"},{"location":"instances_delete/#required-scalar-arguments","text":"<project> (string) Project ID of the project that contains the instance to be deleted. <instance> (string) Cloud SQL instance ID. This does not include the project ID.","title":"Required Scalar Arguments"},{"location":"instances_delete/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"instances_delete/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"instances_demote-master/","text":"Demotes the stand-alone instance to be a Cloud SQL read replica for an external database server. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> instances demote-master ... Required Scalar Arguments <project> (string) ID of the project that contains the instance. <instance> (string) Cloud SQL instance name. Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: InstancesDemoteMasterRequest: demote-master-context: kind: string master-instance-name: string replica-configuration: kind: string mysql-replica-configuration: ca-certificate: string client-certificate: string client-key: string kind: string password: string username: string verify-gtid-consistency: boolean can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .demote-master-context kind=consetetur This is always <code>sql#demoteMasterContext</code>. master-instance-name=diam The name of the instance which will act as on-premises master in the replication setup. replica-configuration kind=dolor This is always <code>sql#demoteMasterConfiguration</code>. mysql-replica-configuration ca-certificate=et PEM representation of the trusted CA's x509 certificate. client-certificate=et PEM representation of the slave's x509 certificate. client-key=sadipscing PEM representation of the slave's private key. The corresponsing public key is encoded in the client's certificate. The format of the slave's private key can be either PKCS #1 or PKCS #8. kind=stet This is always <code>sql#demoteMasterMysqlReplicaConfiguration</code>. password=dolor The password for the replication connection. username=duo The username for the replication connection. ... verify-gtid-consistency=false Verify GTID consistency for demote operation. Default value: <code>True</code>. Second Generation instances only. Setting this flag to false enables you to bypass GTID consistency check between on-premises master and Cloud SQL instance during the demotion operation but also exposes you to the risk of future replication failures. Change the value only if you know the reason for the GTID divergence and are confident that doing so will not cause any replication issues. About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Demote Master"},{"location":"instances_demote-master/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> instances demote-master ...","title":"Scopes"},{"location":"instances_demote-master/#required-scalar-arguments","text":"<project> (string) ID of the project that contains the instance. <instance> (string) Cloud SQL instance name.","title":"Required Scalar Arguments"},{"location":"instances_demote-master/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: InstancesDemoteMasterRequest: demote-master-context: kind: string master-instance-name: string replica-configuration: kind: string mysql-replica-configuration: ca-certificate: string client-certificate: string client-key: string kind: string password: string username: string verify-gtid-consistency: boolean can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .demote-master-context kind=consetetur This is always <code>sql#demoteMasterContext</code>. master-instance-name=diam The name of the instance which will act as on-premises master in the replication setup. replica-configuration kind=dolor This is always <code>sql#demoteMasterConfiguration</code>. mysql-replica-configuration ca-certificate=et PEM representation of the trusted CA's x509 certificate. client-certificate=et PEM representation of the slave's x509 certificate. client-key=sadipscing PEM representation of the slave's private key. The corresponsing public key is encoded in the client's certificate. The format of the slave's private key can be either PKCS #1 or PKCS #8. kind=stet This is always <code>sql#demoteMasterMysqlReplicaConfiguration</code>. password=dolor The password for the replication connection. username=duo The username for the replication connection. ... verify-gtid-consistency=false Verify GTID consistency for demote operation. Default value: <code>True</code>. Second Generation instances only. Setting this flag to false enables you to bypass GTID consistency check between on-premises master and Cloud SQL instance during the demotion operation but also exposes you to the risk of future replication failures. Change the value only if you know the reason for the GTID divergence and are confident that doing so will not cause any replication issues.","title":"Required Request Value"},{"location":"instances_demote-master/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"instances_demote-master/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"instances_demote-master/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"instances_export/","text":"Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL dump or CSV file. Scopes You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call. If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> instances export ... Required Scalar Arguments <project> (string) Project ID of the project that contains the instance to be exported. <instance> (string) Cloud SQL instance ID. This does not include the project ID. Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: InstancesExportRequest: export-context: csv-export-options: select-query: string databases: [string] file-type: string kind: string sql-export-options: mysql-export-options: master-data: integer schema-only: boolean tables: [string] uri: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .export-context.csv-export-options select-query=vero The select query used to extract the data. .. databases=invidunt Databases to be exported. <br /> <b>MySQL instances:</b> If <code>fileType</code> is <code>SQL</code> and no database is specified, all databases are exported, except for the <code>mysql</code> system database. If <code>fileType</code> is <code>CSV</code>, you can specify one database, either by using this property or by using the <code>csvExportOptions.selectQuery</code> property, which takes precedence over this property. <br /> <b>PostgreSQL instances:</b> You must specify one database to be exported. If <code>fileType</code> is <code>CSV</code>, this database must match the one specified in the <code>csvExportOptions.selectQuery</code> property. Each invocation of this argument appends the given value to the array. file-type=stet The file type for the specified uri. <br><code>SQL</code>: The file contains SQL statements. <br><code>CSV</code>: The file contains CSV data. kind=vero This is always <code>sql#exportContext</code>. sql-export-options.mysql-export-options master-data=57 Option to include SQL statement required to set up replication. If set to <code>1</code>, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates. If set to <code>2</code>, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored. .. schema-only=true Export only schemas. tables=ipsum Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table. Each invocation of this argument appends the given value to the array. .. uri=accusam The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form <code>gs: //bucketName/fileName</code>. If the file already exists, the requests // succeeds, but the operation fails. If <code>fileType</code> is // <code>SQL</code> and the filename ends with .gz, the contents are // compressed. About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Export"},{"location":"instances_export/#scopes","text":"You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call. If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> instances export ...","title":"Scopes"},{"location":"instances_export/#required-scalar-arguments","text":"<project> (string) Project ID of the project that contains the instance to be exported. <instance> (string) Cloud SQL instance ID. This does not include the project ID.","title":"Required Scalar Arguments"},{"location":"instances_export/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: InstancesExportRequest: export-context: csv-export-options: select-query: string databases: [string] file-type: string kind: string sql-export-options: mysql-export-options: master-data: integer schema-only: boolean tables: [string] uri: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .export-context.csv-export-options select-query=vero The select query used to extract the data. .. databases=invidunt Databases to be exported. <br /> <b>MySQL instances:</b> If <code>fileType</code> is <code>SQL</code> and no database is specified, all databases are exported, except for the <code>mysql</code> system database. If <code>fileType</code> is <code>CSV</code>, you can specify one database, either by using this property or by using the <code>csvExportOptions.selectQuery</code> property, which takes precedence over this property. <br /> <b>PostgreSQL instances:</b> You must specify one database to be exported. If <code>fileType</code> is <code>CSV</code>, this database must match the one specified in the <code>csvExportOptions.selectQuery</code> property. Each invocation of this argument appends the given value to the array. file-type=stet The file type for the specified uri. <br><code>SQL</code>: The file contains SQL statements. <br><code>CSV</code>: The file contains CSV data. kind=vero This is always <code>sql#exportContext</code>. sql-export-options.mysql-export-options master-data=57 Option to include SQL statement required to set up replication. If set to <code>1</code>, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates. If set to <code>2</code>, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored. .. schema-only=true Export only schemas. tables=ipsum Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table. Each invocation of this argument appends the given value to the array. .. uri=accusam The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form <code>gs: //bucketName/fileName</code>. If the file already exists, the requests // succeeds, but the operation fails. If <code>fileType</code> is // <code>SQL</code> and the filename ends with .gz, the contents are // compressed.","title":"Required Request Value"},{"location":"instances_export/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"instances_export/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"instances_export/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"instances_failover/","text":"Failover the instance to its failover replica instance. Using this operation might cause your instance to restart. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> instances failover ... Required Scalar Arguments <project> (string) ID of the project that contains the read replica. <instance> (string) Cloud SQL instance ID. This does not include the project ID. Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: InstancesFailoverRequest: failover-context: kind: string settings-version: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .failover-context kind=takimata This is always <code>sql#failoverContext</code>. settings-version=consetetur The current settings version of this instance. Request will be rejected if this version doesn't match the current settings version. About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Failover"},{"location":"instances_failover/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> instances failover ...","title":"Scopes"},{"location":"instances_failover/#required-scalar-arguments","text":"<project> (string) ID of the project that contains the read replica. <instance> (string) Cloud SQL instance ID. This does not include the project ID.","title":"Required Scalar Arguments"},{"location":"instances_failover/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: InstancesFailoverRequest: failover-context: kind: string settings-version: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .failover-context kind=takimata This is always <code>sql#failoverContext</code>. settings-version=consetetur The current settings version of this instance. Request will be rejected if this version doesn't match the current settings version.","title":"Required Request Value"},{"location":"instances_failover/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"instances_failover/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"instances_failover/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"instances_get/","text":"Retrieves a resource containing information about a Cloud SQL instance. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> instances get ... Required Scalar Arguments <project> (string) Project ID of the project that contains the instance. <instance> (string) Database instance ID. This does not include the project ID. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Get"},{"location":"instances_get/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> instances get ...","title":"Scopes"},{"location":"instances_get/#required-scalar-arguments","text":"<project> (string) Project ID of the project that contains the instance. <instance> (string) Database instance ID. This does not include the project ID.","title":"Required Scalar Arguments"},{"location":"instances_get/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"instances_get/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"instances_import/","text":"Imports data into a Cloud SQL instance from a SQL dump or CSV file in Cloud Storage. Scopes You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call. If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> instances import ... Required Scalar Arguments <project> (string) Project ID of the project that contains the instance. <instance> (string) Cloud SQL instance ID. This does not include the project ID. Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: InstancesImportRequest: import-context: bak-import-options: encryption-options: cert-path: string pvk-password: string pvk-path: string csv-import-options: columns: [string] table: string database: string file-type: string import-user: string kind: string uri: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .import-context.bak-import-options.encryption-options cert-path=voluptua. Path to the Certificate (.cer) in Cloud Storage, in the form <code>gs://bucketName/fileName</code>. The instance must have write permissions to the bucket and read access to the file. pvk-password=et Password that encrypts the private key pvk-path=erat Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form <code>gs://bucketName/fileName</code>. The instance must have write permissions to the bucket and read access to the file. ...csv-import-options columns=consetetur The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. Each invocation of this argument appends the given value to the array. table=amet. The table to which CSV data is imported. .. database=sed The target database for the import. If <code>fileType</code> is <code>SQL</code>, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If <code>fileType</code> is <code>CSV</code>, one database must be specified. file-type=takimata The file type for the specified uri. <br><code>SQL</code>: The file contains SQL statements. <br><code>CSV</code>: The file contains CSV data. import-user=dolores The PostgreSQL user for this import operation. PostgreSQL instances only. kind=gubergren This is always <code>sql#importContext</code>. uri=et Path to the import file in Cloud Storage, in the form <code>gs: //bucketName/fileName</code>. Compressed gzip files (.gz) are supported // when <code>fileType</code> is <code>SQL</code>. The instance must have // write permissions to the bucket and read access to the file. About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Import"},{"location":"instances_import/#scopes","text":"You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call. If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> instances import ...","title":"Scopes"},{"location":"instances_import/#required-scalar-arguments","text":"<project> (string) Project ID of the project that contains the instance. <instance> (string) Cloud SQL instance ID. This does not include the project ID.","title":"Required Scalar Arguments"},{"location":"instances_import/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: InstancesImportRequest: import-context: bak-import-options: encryption-options: cert-path: string pvk-password: string pvk-path: string csv-import-options: columns: [string] table: string database: string file-type: string import-user: string kind: string uri: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .import-context.bak-import-options.encryption-options cert-path=voluptua. Path to the Certificate (.cer) in Cloud Storage, in the form <code>gs://bucketName/fileName</code>. The instance must have write permissions to the bucket and read access to the file. pvk-password=et Password that encrypts the private key pvk-path=erat Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form <code>gs://bucketName/fileName</code>. The instance must have write permissions to the bucket and read access to the file. ...csv-import-options columns=consetetur The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. Each invocation of this argument appends the given value to the array. table=amet. The table to which CSV data is imported. .. database=sed The target database for the import. If <code>fileType</code> is <code>SQL</code>, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If <code>fileType</code> is <code>CSV</code>, one database must be specified. file-type=takimata The file type for the specified uri. <br><code>SQL</code>: The file contains SQL statements. <br><code>CSV</code>: The file contains CSV data. import-user=dolores The PostgreSQL user for this import operation. PostgreSQL instances only. kind=gubergren This is always <code>sql#importContext</code>. uri=et Path to the import file in Cloud Storage, in the form <code>gs: //bucketName/fileName</code>. Compressed gzip files (.gz) are supported // when <code>fileType</code> is <code>SQL</code>. The instance must have // write permissions to the bucket and read access to the file.","title":"Required Request Value"},{"location":"instances_import/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"instances_import/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"instances_import/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"instances_insert/","text":"Creates a new Cloud SQL instance. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> instances insert ... Required Scalar Argument <project> (string) Project ID of the project to which the newly created Cloud SQL instances should belong. Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: DatabaseInstance: backend-type: string connection-name: string current-disk-size: string database-version: string disk-encryption-configuration: kind: string kms-key-name: string disk-encryption-status: kind: string kms-key-version-name: string etag: string failover-replica: available: boolean name: string gce-zone: string instance-type: string ipv6-address: string kind: string master-instance-name: string max-disk-size: string name: string on-premises-configuration: ca-certificate: string client-certificate: string client-key: string dump-file-path: string host-port: string kind: string password: string username: string project: string region: string replica-configuration: failover-target: boolean kind: string mysql-replica-configuration: ca-certificate: string client-certificate: string client-key: string connect-retry-interval: integer dump-file-path: string kind: string master-heartbeat-period: string password: string ssl-cipher: string username: string verify-server-certificate: boolean replica-names: [string] root-password: string scheduled-maintenance: can-defer: boolean can-reschedule: boolean start-time: string self-link: string server-ca-cert: cert: string cert-serial-number: string common-name: string create-time: string expiration-time: string instance: string kind: string self-link: string sha1-fingerprint: string service-account-email-address: string settings: activation-policy: string authorized-gae-applications: [string] availability-type: string backup-configuration: binary-log-enabled: boolean enabled: boolean kind: string location: string point-in-time-recovery-enabled: boolean replication-log-archiving-enabled: boolean start-time: string crash-safe-replication-enabled: boolean data-disk-size-gb: string data-disk-type: string database-replication-enabled: boolean ip-configuration: ipv4-enabled: boolean private-network: string require-ssl: boolean kind: string location-preference: follow-gae-application: string kind: string zone: string maintenance-window: day: integer hour: integer kind: string update-track: string pricing-plan: string replication-type: string settings-version: string storage-auto-resize: boolean storage-auto-resize-limit: string tier: string user-labels: { string: string } state: string suspension-reason: [string] can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . backend-type=accusam <code>FIRST_GEN</code>: First Generation instance. MySQL only. <br /><code>SECOND_GEN</code>: Second Generation instance or PostgreSQL instance. <br /><code>EXTERNAL</code>: A database server that is not managed by Google. <br>This property is read-only; use the <code>tier</code> property in the <code>settings</code> object to determine the database type and Second or First Generation. connection-name=voluptua. Connection name of the Cloud SQL instance used in connection strings. current-disk-size=dolore The current disk usage of the instance in bytes. This property has been deprecated. Users should use the \"cloudsql.googleapis.com/database/disk/bytes_used\" metric in Cloud Monitoring API instead. Please see <a href=\"https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ\">this announcement</a> for details. database-version=dolore The database engine type and version. The <code>databaseVersion</code> field can not be changed after instance creation. MySQL Second Generation instances: <code>MYSQL_5_7</code> (default) or <code>MYSQL_5_6</code>. PostgreSQL instances: <code>POSTGRES_9_6</code> (default) or <code>POSTGRES_11 Beta</code> MySQL First Generation instances: <code>MYSQL_5_6</code> (default) or <code>MYSQL_5_5</code> disk-encryption-configuration kind=dolore This is always <code>sql#diskEncryptionConfiguration</code>. kms-key-name=voluptua. Resource name of KMS key for disk encryption ..disk-encryption-status kind=amet. This is always <code>sql#diskEncryptionStatus</code>. kms-key-version-name=ea KMS key version used to encrypt the Cloud SQL instance resource .. etag=sadipscing This field is deprecated and will be removed from a future version of the API. Use the <code>settings.settingsVersion</code> field instead. failover-replica available=true The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The master can only failover to the failover replica when the status is true. name=no The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID. This property is applicable only to Second Generation instances. .. gce-zone=est The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. instance-type=at The instance type. This can be one of the following. <br><code>CLOUD_SQL_INSTANCE</code>: A Cloud SQL instance that is not replicating from a master. <br><code>ON_PREMISES_INSTANCE</code>: An instance running on the customer's premises. <br><code>READ_REPLICA_INSTANCE</code>: A Cloud SQL instance configured as a read-replica. ipv6-address=sed The IPv6 address assigned to the instance. This property is applicable only to First Generation instances. kind=sit This is always <code>sql#instance</code>. master-instance-name=et The name of the instance which will act as master in the replication setup. max-disk-size=tempor The maximum disk size of the instance in bytes. name=aliquyam Name of the Cloud SQL instance. This does not include the project ID. on-premises-configuration ca-certificate=ipsum PEM representation of the trusted CA's x509 certificate. client-certificate=et PEM representation of the slave's x509 certificate. client-key=sanctus PEM representation of the slave's private key. The corresponsing public key is encoded in the client's certificate. dump-file-path=lorem The dump file to create the Cloud SQL replica. host-port=est The host and port of the on-premises instance in host:port format kind=sed This is always <code>sql#onPremisesConfiguration</code>. password=diam The password for connecting to on-premises instance. username=dolores The username for connecting to on-premises instance. .. project=dolores The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable. region=et The geographical region. Can be <code>us-central</code> (<code>FIRST_GEN</code> instances only), <code>us-central1</code> (<code>SECOND_GEN</code> instances only), <code>asia-east1</code> or <code>europe-west1</code>. Defaults to <code>us-central</code> or <code>us-central1</code> depending on the instance type (First Generation or Second Generation). The region can not be changed after instance creation. replica-configuration failover-target=false Specifies if the replica is the failover target. If the field is set to <code>true</code> the replica will be designated as a failover replica. In case the master instance fails, the replica instance will be promoted as the new master instance. <p>Only one replica can be specified as failover target, and the replica has to be in different zone with the master instance. kind=no This is always <code>sql#replicaConfiguration</code>. mysql-replica-configuration ca-certificate=et PEM representation of the trusted CA's x509 certificate. client-certificate=elitr PEM representation of the slave's x509 certificate. client-key=sed PEM representation of the slave's private key. The corresponsing public key is encoded in the client's certificate. connect-retry-interval=40 Seconds to wait between connect retries. MySQL's default is 60 seconds. dump-file-path=nonumy Path to a SQL dump file in Google Cloud Storage from which the slave instance is to be created. The URI is in the form gs: //bucketName/fileName. Compressed gzip files (.gz) are also supported. // Dumps should have the binlog co-ordinates from which replication should // begin. This can be accomplished by setting --master-data to 1 when using // mysqldump. kind=at This is always <code>sql#mysqlReplicaConfiguration</code>. master-heartbeat-period=sadipscing Interval in milliseconds between replication heartbeats. password=aliquyam The password for the replication connection. ssl-cipher=dolores A list of permissible ciphers to use for SSL encryption. username=sadipscing The username for the replication connection. verify-server-certificate=false Whether or not to check the master's Common Name value in the certificate that it sends during the SSL handshake. ... replica-names=amet The replicas of the instance. Each invocation of this argument appends the given value to the array. root-password=est Initial root password. Use only on creation. scheduled-maintenance can-defer=false No description provided. can-reschedule=true If the scheduled maintenance can be rescheduled. start-time=stet The start time of any upcoming scheduled maintenance for this instance. .. self-link=est The URI of this resource. server-ca-cert cert=aliquyam PEM representation. cert-serial-number=elitr Serial number, as extracted from the certificate. common-name=duo User supplied name. Constrained to [a-zA-Z.-_ ]+. create-time=diam The time when the certificate was created in <a href=\"https://tools.ietf.org/html/rfc3339\">RFC 3339</a> format, for example <code>2012-11-15T16:19:00.094Z</code> expiration-time=est The time when the certificate expires in <a href=\"https://tools.ietf.org/html/rfc3339\">RFC 3339</a> format, for example <code>2012-11-15T16:19:00.094Z</code>. instance=sit Name of the database instance. kind=sed This is always <code>sql#sslCert</code>. self-link=eos The URI of this resource. sha1-fingerprint=lorem Sha1 Fingerprint. .. service-account-email-address=ea The service account email address assigned to the instance. This property is applicable only to Second Generation instances. settings activation-policy=stet The activation policy specifies when the instance is activated; it is applicable only when the instance state is <code>RUNNABLE</code>. Valid values: <br><code>ALWAYS</code>: The instance is on, and remains so even in the absence of connection requests. <br><code>NEVER</code>: The instance is off; it is not activated, even if a connection request arrives. <br><code>ON_DEMAND</code>: First Generation instances only. The instance responds to incoming requests, and turns itself off when not in use. Instances with <code>PER_USE</code> pricing turn off after 15 minutes of inactivity. Instances with <code>PER_PACKAGE</code> pricing turn off after 12 hours of inactivity. authorized-gae-applications=dolores The App Engine app IDs that can access this instance. First Generation instances only. Each invocation of this argument appends the given value to the array. availability-type=eos Availability type (PostgreSQL and MySQL instances only). Potential values: <br><code>ZONAL</code>: The instance serves data from only one zone. Outages in that zone affect data accessibility. <br><code>REGIONAL</code>: The instance can serve data from more than one zone in a region (it is highly available). <br>For more information, see <a href=\"https://cloud.google.com/sql/docs/postgres/high-availability\">Overview of the High Availability Configuration</a>. backup-configuration binary-log-enabled=true (MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well. enabled=false Whether this configuration is enabled. kind=at This is always <code>sql#backupConfiguration</code>. location=dolore Location of the backup point-in-time-recovery-enabled=true Reserved for future use. replication-log-archiving-enabled=true Reserved for future use. start-time=accusam Start time for the daily backup configuration in UTC timezone in the 24 hour format - <code>HH:MM</code>. .. crash-safe-replication-enabled=true Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property is only applicable to First Generation instances. data-disk-size-gb=erat The size of data disk, in GB. The data disk size minimum is 10GB. Not used for First Generation instances. data-disk-type=dolores The type of data disk: <code>PD_SSD</code> (default) or <code>PD_HDD</code>. Not used for First Generation instances. database-replication-enabled=false Configuration specific to read replica instances. Indicates whether replication is enabled or not. ip-configuration ipv4-enabled=false Whether the instance should be assigned an IP address or not. private-network=sea The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, <code>/projects/myProject/global/networks/default</code>. This setting can be updated, but it cannot be removed after it is set. require-ssl=true Whether SSL connections over IP should be enforced or not. .. kind=lorem This is always <code>sql#settings</code>. location-preference follow-gae-application=et The AppEngine application to follow, it must be in the same region as the Cloud SQL instance. kind=at This is always <code>sql#locationPreference</code>. zone=dolor The preferred Compute Engine zone (e.g. us-central1-a, us-central1-b, etc.). ..maintenance-window day=79 day of week (1-7), starting on Monday. hour=53 hour of day - 0 to 23. kind=erat This is always <code>sql#maintenanceWindow</code>. update-track=sea Maintenance timing setting: <code>canary</code> (Earlier) or <code>stable</code> (Later). <br /><a href=\"/sql/docs/db_path/instance-settings#maintenance-timing-2ndgen\"> Learn more</a>. .. pricing-plan=nonumy The pricing plan for this instance. This can be either <code>PER_USE</code> or <code>PACKAGE</code>. Only <code>PER_USE</code> is supported for Second Generation instances. replication-type=et The type of replication this instance uses. This can be either <code>ASYNCHRONOUS</code> or <code>SYNCHRONOUS</code>. This property is only applicable to First Generation instances. settings-version=gubergren The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value. storage-auto-resize=true Configuration to increase storage size automatically. The default value is true. Not used for First Generation instances. storage-auto-resize-limit=consetetur The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit. Not used for First Generation instances. tier=sit The tier (or machine type) for this instance, for example <code>db-n1-standard-1</code> (MySQL instances) or <code>db-custom-1-3840</code> (PostgreSQL instances). For MySQL instances, this property determines whether the instance is First or Second Generation. For more information, see <a href=\"/sql/docs/db_path/instance-settings\">Instance Settings</a>. user-labels=key=aliquyam User-provided labels, represented as a dictionary where each label is a single key value pair. the value will be associated with the given key .. state=eos The current serving state of the Cloud SQL instance. This can be one of the following. <br><code>RUNNABLE</code>: The instance is running, or is ready to run when accessed. <br><code>SUSPENDED</code>: The instance is not available, for example due to problems with billing. <br><code>PENDING_CREATE</code>: The instance is being created. <br><code>MAINTENANCE</code>: The instance is down for maintenance. <br><code>FAILED</code>: The instance creation failed. <br><code>UNKNOWN_STATE</code>: The state of the instance is unknown. suspension-reason=at If the instance state is SUSPENDED, the reason for the suspension. Each invocation of this argument appends the given value to the array. About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Insert"},{"location":"instances_insert/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> instances insert ...","title":"Scopes"},{"location":"instances_insert/#required-scalar-argument","text":"<project> (string) Project ID of the project to which the newly created Cloud SQL instances should belong.","title":"Required Scalar Argument"},{"location":"instances_insert/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: DatabaseInstance: backend-type: string connection-name: string current-disk-size: string database-version: string disk-encryption-configuration: kind: string kms-key-name: string disk-encryption-status: kind: string kms-key-version-name: string etag: string failover-replica: available: boolean name: string gce-zone: string instance-type: string ipv6-address: string kind: string master-instance-name: string max-disk-size: string name: string on-premises-configuration: ca-certificate: string client-certificate: string client-key: string dump-file-path: string host-port: string kind: string password: string username: string project: string region: string replica-configuration: failover-target: boolean kind: string mysql-replica-configuration: ca-certificate: string client-certificate: string client-key: string connect-retry-interval: integer dump-file-path: string kind: string master-heartbeat-period: string password: string ssl-cipher: string username: string verify-server-certificate: boolean replica-names: [string] root-password: string scheduled-maintenance: can-defer: boolean can-reschedule: boolean start-time: string self-link: string server-ca-cert: cert: string cert-serial-number: string common-name: string create-time: string expiration-time: string instance: string kind: string self-link: string sha1-fingerprint: string service-account-email-address: string settings: activation-policy: string authorized-gae-applications: [string] availability-type: string backup-configuration: binary-log-enabled: boolean enabled: boolean kind: string location: string point-in-time-recovery-enabled: boolean replication-log-archiving-enabled: boolean start-time: string crash-safe-replication-enabled: boolean data-disk-size-gb: string data-disk-type: string database-replication-enabled: boolean ip-configuration: ipv4-enabled: boolean private-network: string require-ssl: boolean kind: string location-preference: follow-gae-application: string kind: string zone: string maintenance-window: day: integer hour: integer kind: string update-track: string pricing-plan: string replication-type: string settings-version: string storage-auto-resize: boolean storage-auto-resize-limit: string tier: string user-labels: { string: string } state: string suspension-reason: [string] can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . backend-type=accusam <code>FIRST_GEN</code>: First Generation instance. MySQL only. <br /><code>SECOND_GEN</code>: Second Generation instance or PostgreSQL instance. <br /><code>EXTERNAL</code>: A database server that is not managed by Google. <br>This property is read-only; use the <code>tier</code> property in the <code>settings</code> object to determine the database type and Second or First Generation. connection-name=voluptua. Connection name of the Cloud SQL instance used in connection strings. current-disk-size=dolore The current disk usage of the instance in bytes. This property has been deprecated. Users should use the \"cloudsql.googleapis.com/database/disk/bytes_used\" metric in Cloud Monitoring API instead. Please see <a href=\"https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ\">this announcement</a> for details. database-version=dolore The database engine type and version. The <code>databaseVersion</code> field can not be changed after instance creation. MySQL Second Generation instances: <code>MYSQL_5_7</code> (default) or <code>MYSQL_5_6</code>. PostgreSQL instances: <code>POSTGRES_9_6</code> (default) or <code>POSTGRES_11 Beta</code> MySQL First Generation instances: <code>MYSQL_5_6</code> (default) or <code>MYSQL_5_5</code> disk-encryption-configuration kind=dolore This is always <code>sql#diskEncryptionConfiguration</code>. kms-key-name=voluptua. Resource name of KMS key for disk encryption ..disk-encryption-status kind=amet. This is always <code>sql#diskEncryptionStatus</code>. kms-key-version-name=ea KMS key version used to encrypt the Cloud SQL instance resource .. etag=sadipscing This field is deprecated and will be removed from a future version of the API. Use the <code>settings.settingsVersion</code> field instead. failover-replica available=true The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The master can only failover to the failover replica when the status is true. name=no The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID. This property is applicable only to Second Generation instances. .. gce-zone=est The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. instance-type=at The instance type. This can be one of the following. <br><code>CLOUD_SQL_INSTANCE</code>: A Cloud SQL instance that is not replicating from a master. <br><code>ON_PREMISES_INSTANCE</code>: An instance running on the customer's premises. <br><code>READ_REPLICA_INSTANCE</code>: A Cloud SQL instance configured as a read-replica. ipv6-address=sed The IPv6 address assigned to the instance. This property is applicable only to First Generation instances. kind=sit This is always <code>sql#instance</code>. master-instance-name=et The name of the instance which will act as master in the replication setup. max-disk-size=tempor The maximum disk size of the instance in bytes. name=aliquyam Name of the Cloud SQL instance. This does not include the project ID. on-premises-configuration ca-certificate=ipsum PEM representation of the trusted CA's x509 certificate. client-certificate=et PEM representation of the slave's x509 certificate. client-key=sanctus PEM representation of the slave's private key. The corresponsing public key is encoded in the client's certificate. dump-file-path=lorem The dump file to create the Cloud SQL replica. host-port=est The host and port of the on-premises instance in host:port format kind=sed This is always <code>sql#onPremisesConfiguration</code>. password=diam The password for connecting to on-premises instance. username=dolores The username for connecting to on-premises instance. .. project=dolores The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable. region=et The geographical region. Can be <code>us-central</code> (<code>FIRST_GEN</code> instances only), <code>us-central1</code> (<code>SECOND_GEN</code> instances only), <code>asia-east1</code> or <code>europe-west1</code>. Defaults to <code>us-central</code> or <code>us-central1</code> depending on the instance type (First Generation or Second Generation). The region can not be changed after instance creation. replica-configuration failover-target=false Specifies if the replica is the failover target. If the field is set to <code>true</code> the replica will be designated as a failover replica. In case the master instance fails, the replica instance will be promoted as the new master instance. <p>Only one replica can be specified as failover target, and the replica has to be in different zone with the master instance. kind=no This is always <code>sql#replicaConfiguration</code>. mysql-replica-configuration ca-certificate=et PEM representation of the trusted CA's x509 certificate. client-certificate=elitr PEM representation of the slave's x509 certificate. client-key=sed PEM representation of the slave's private key. The corresponsing public key is encoded in the client's certificate. connect-retry-interval=40 Seconds to wait between connect retries. MySQL's default is 60 seconds. dump-file-path=nonumy Path to a SQL dump file in Google Cloud Storage from which the slave instance is to be created. The URI is in the form gs: //bucketName/fileName. Compressed gzip files (.gz) are also supported. // Dumps should have the binlog co-ordinates from which replication should // begin. This can be accomplished by setting --master-data to 1 when using // mysqldump. kind=at This is always <code>sql#mysqlReplicaConfiguration</code>. master-heartbeat-period=sadipscing Interval in milliseconds between replication heartbeats. password=aliquyam The password for the replication connection. ssl-cipher=dolores A list of permissible ciphers to use for SSL encryption. username=sadipscing The username for the replication connection. verify-server-certificate=false Whether or not to check the master's Common Name value in the certificate that it sends during the SSL handshake. ... replica-names=amet The replicas of the instance. Each invocation of this argument appends the given value to the array. root-password=est Initial root password. Use only on creation. scheduled-maintenance can-defer=false No description provided. can-reschedule=true If the scheduled maintenance can be rescheduled. start-time=stet The start time of any upcoming scheduled maintenance for this instance. .. self-link=est The URI of this resource. server-ca-cert cert=aliquyam PEM representation. cert-serial-number=elitr Serial number, as extracted from the certificate. common-name=duo User supplied name. Constrained to [a-zA-Z.-_ ]+. create-time=diam The time when the certificate was created in <a href=\"https://tools.ietf.org/html/rfc3339\">RFC 3339</a> format, for example <code>2012-11-15T16:19:00.094Z</code> expiration-time=est The time when the certificate expires in <a href=\"https://tools.ietf.org/html/rfc3339\">RFC 3339</a> format, for example <code>2012-11-15T16:19:00.094Z</code>. instance=sit Name of the database instance. kind=sed This is always <code>sql#sslCert</code>. self-link=eos The URI of this resource. sha1-fingerprint=lorem Sha1 Fingerprint. .. service-account-email-address=ea The service account email address assigned to the instance. This property is applicable only to Second Generation instances. settings activation-policy=stet The activation policy specifies when the instance is activated; it is applicable only when the instance state is <code>RUNNABLE</code>. Valid values: <br><code>ALWAYS</code>: The instance is on, and remains so even in the absence of connection requests. <br><code>NEVER</code>: The instance is off; it is not activated, even if a connection request arrives. <br><code>ON_DEMAND</code>: First Generation instances only. The instance responds to incoming requests, and turns itself off when not in use. Instances with <code>PER_USE</code> pricing turn off after 15 minutes of inactivity. Instances with <code>PER_PACKAGE</code> pricing turn off after 12 hours of inactivity. authorized-gae-applications=dolores The App Engine app IDs that can access this instance. First Generation instances only. Each invocation of this argument appends the given value to the array. availability-type=eos Availability type (PostgreSQL and MySQL instances only). Potential values: <br><code>ZONAL</code>: The instance serves data from only one zone. Outages in that zone affect data accessibility. <br><code>REGIONAL</code>: The instance can serve data from more than one zone in a region (it is highly available). <br>For more information, see <a href=\"https://cloud.google.com/sql/docs/postgres/high-availability\">Overview of the High Availability Configuration</a>. backup-configuration binary-log-enabled=true (MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well. enabled=false Whether this configuration is enabled. kind=at This is always <code>sql#backupConfiguration</code>. location=dolore Location of the backup point-in-time-recovery-enabled=true Reserved for future use. replication-log-archiving-enabled=true Reserved for future use. start-time=accusam Start time for the daily backup configuration in UTC timezone in the 24 hour format - <code>HH:MM</code>. .. crash-safe-replication-enabled=true Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property is only applicable to First Generation instances. data-disk-size-gb=erat The size of data disk, in GB. The data disk size minimum is 10GB. Not used for First Generation instances. data-disk-type=dolores The type of data disk: <code>PD_SSD</code> (default) or <code>PD_HDD</code>. Not used for First Generation instances. database-replication-enabled=false Configuration specific to read replica instances. Indicates whether replication is enabled or not. ip-configuration ipv4-enabled=false Whether the instance should be assigned an IP address or not. private-network=sea The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, <code>/projects/myProject/global/networks/default</code>. This setting can be updated, but it cannot be removed after it is set. require-ssl=true Whether SSL connections over IP should be enforced or not. .. kind=lorem This is always <code>sql#settings</code>. location-preference follow-gae-application=et The AppEngine application to follow, it must be in the same region as the Cloud SQL instance. kind=at This is always <code>sql#locationPreference</code>. zone=dolor The preferred Compute Engine zone (e.g. us-central1-a, us-central1-b, etc.). ..maintenance-window day=79 day of week (1-7), starting on Monday. hour=53 hour of day - 0 to 23. kind=erat This is always <code>sql#maintenanceWindow</code>. update-track=sea Maintenance timing setting: <code>canary</code> (Earlier) or <code>stable</code> (Later). <br /><a href=\"/sql/docs/db_path/instance-settings#maintenance-timing-2ndgen\"> Learn more</a>. .. pricing-plan=nonumy The pricing plan for this instance. This can be either <code>PER_USE</code> or <code>PACKAGE</code>. Only <code>PER_USE</code> is supported for Second Generation instances. replication-type=et The type of replication this instance uses. This can be either <code>ASYNCHRONOUS</code> or <code>SYNCHRONOUS</code>. This property is only applicable to First Generation instances. settings-version=gubergren The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value. storage-auto-resize=true Configuration to increase storage size automatically. The default value is true. Not used for First Generation instances. storage-auto-resize-limit=consetetur The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit. Not used for First Generation instances. tier=sit The tier (or machine type) for this instance, for example <code>db-n1-standard-1</code> (MySQL instances) or <code>db-custom-1-3840</code> (PostgreSQL instances). For MySQL instances, this property determines whether the instance is First or Second Generation. For more information, see <a href=\"/sql/docs/db_path/instance-settings\">Instance Settings</a>. user-labels=key=aliquyam User-provided labels, represented as a dictionary where each label is a single key value pair. the value will be associated with the given key .. state=eos The current serving state of the Cloud SQL instance. This can be one of the following. <br><code>RUNNABLE</code>: The instance is running, or is ready to run when accessed. <br><code>SUSPENDED</code>: The instance is not available, for example due to problems with billing. <br><code>PENDING_CREATE</code>: The instance is being created. <br><code>MAINTENANCE</code>: The instance is down for maintenance. <br><code>FAILED</code>: The instance creation failed. <br><code>UNKNOWN_STATE</code>: The state of the instance is unknown. suspension-reason=at If the instance state is SUSPENDED, the reason for the suspension. Each invocation of this argument appends the given value to the array.","title":"Required Request Value"},{"location":"instances_insert/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"instances_insert/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"instances_insert/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"instances_list-server-cas/","text":"Lists all of the trusted Certificate Authorities (CAs) for the specified instance. There can be up to three CAs listed: the CA that was used to sign the certificate that is currently in use, a CA that has been added but not yet used to sign a certificate, and a CA used to sign a certificate that has previously rotated out. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> instances list-server-cas ... Required Scalar Arguments <project> (string) Project ID of the project that contains the instance. <instance> (string) Cloud SQL instance ID. This does not include the project ID. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"List Server Cas"},{"location":"instances_list-server-cas/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> instances list-server-cas ...","title":"Scopes"},{"location":"instances_list-server-cas/#required-scalar-arguments","text":"<project> (string) Project ID of the project that contains the instance. <instance> (string) Cloud SQL instance ID. This does not include the project ID.","title":"Required Scalar Arguments"},{"location":"instances_list-server-cas/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"instances_list-server-cas/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"instances_list/","text":"Lists instances under a given project. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> instances list ... Required Scalar Argument <project> (string) Project ID of the project for which to list Cloud SQL instances. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional Method Properties You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p filter=string A filter expression that filters resources listed in the response. The expression is in the form of field:value. For example, 'instanceType:CLOUD_SQL_INSTANCE'. Fields can be nested as needed as per their JSON representation, such as 'settings.userLabels.auto_start:true'. Multiple filter queries are space-separated. For example. 'state:RUNNABLE instanceType:CLOUD_SQL_INSTANCE'. By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. -p max-results=integer The maximum number of results to return per response. -p page-token=string A previously-returned page token representing part of the larger set of results to view. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"List"},{"location":"instances_list/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> instances list ...","title":"Scopes"},{"location":"instances_list/#required-scalar-argument","text":"<project> (string) Project ID of the project for which to list Cloud SQL instances.","title":"Required Scalar Argument"},{"location":"instances_list/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"instances_list/#optional-method-properties","text":"You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p filter=string A filter expression that filters resources listed in the response. The expression is in the form of field:value. For example, 'instanceType:CLOUD_SQL_INSTANCE'. Fields can be nested as needed as per their JSON representation, such as 'settings.userLabels.auto_start:true'. Multiple filter queries are space-separated. For example. 'state:RUNNABLE instanceType:CLOUD_SQL_INSTANCE'. By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. -p max-results=integer The maximum number of results to return per response. -p page-token=string A previously-returned page token representing part of the larger set of results to view.","title":"Optional Method Properties"},{"location":"instances_list/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"instances_patch/","text":"Updates settings of a Cloud SQL instance. This method supports patch semantics. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> instances patch ... Required Scalar Arguments <project> (string) Project ID of the project that contains the instance. <instance> (string) Cloud SQL instance ID. This does not include the project ID. Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: DatabaseInstance: backend-type: string connection-name: string current-disk-size: string database-version: string disk-encryption-configuration: kind: string kms-key-name: string disk-encryption-status: kind: string kms-key-version-name: string etag: string failover-replica: available: boolean name: string gce-zone: string instance-type: string ipv6-address: string kind: string master-instance-name: string max-disk-size: string name: string on-premises-configuration: ca-certificate: string client-certificate: string client-key: string dump-file-path: string host-port: string kind: string password: string username: string project: string region: string replica-configuration: failover-target: boolean kind: string mysql-replica-configuration: ca-certificate: string client-certificate: string client-key: string connect-retry-interval: integer dump-file-path: string kind: string master-heartbeat-period: string password: string ssl-cipher: string username: string verify-server-certificate: boolean replica-names: [string] root-password: string scheduled-maintenance: can-defer: boolean can-reschedule: boolean start-time: string self-link: string server-ca-cert: cert: string cert-serial-number: string common-name: string create-time: string expiration-time: string instance: string kind: string self-link: string sha1-fingerprint: string service-account-email-address: string settings: activation-policy: string authorized-gae-applications: [string] availability-type: string backup-configuration: binary-log-enabled: boolean enabled: boolean kind: string location: string point-in-time-recovery-enabled: boolean replication-log-archiving-enabled: boolean start-time: string crash-safe-replication-enabled: boolean data-disk-size-gb: string data-disk-type: string database-replication-enabled: boolean ip-configuration: ipv4-enabled: boolean private-network: string require-ssl: boolean kind: string location-preference: follow-gae-application: string kind: string zone: string maintenance-window: day: integer hour: integer kind: string update-track: string pricing-plan: string replication-type: string settings-version: string storage-auto-resize: boolean storage-auto-resize-limit: string tier: string user-labels: { string: string } state: string suspension-reason: [string] can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . backend-type=dolores <code>FIRST_GEN</code>: First Generation instance. MySQL only. <br /><code>SECOND_GEN</code>: Second Generation instance or PostgreSQL instance. <br /><code>EXTERNAL</code>: A database server that is not managed by Google. <br>This property is read-only; use the <code>tier</code> property in the <code>settings</code> object to determine the database type and Second or First Generation. connection-name=consetetur Connection name of the Cloud SQL instance used in connection strings. current-disk-size=gubergren The current disk usage of the instance in bytes. This property has been deprecated. Users should use the \"cloudsql.googleapis.com/database/disk/bytes_used\" metric in Cloud Monitoring API instead. Please see <a href=\"https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ\">this announcement</a> for details. database-version=dolor The database engine type and version. The <code>databaseVersion</code> field can not be changed after instance creation. MySQL Second Generation instances: <code>MYSQL_5_7</code> (default) or <code>MYSQL_5_6</code>. PostgreSQL instances: <code>POSTGRES_9_6</code> (default) or <code>POSTGRES_11 Beta</code> MySQL First Generation instances: <code>MYSQL_5_6</code> (default) or <code>MYSQL_5_5</code> disk-encryption-configuration kind=aliquyam This is always <code>sql#diskEncryptionConfiguration</code>. kms-key-name=no Resource name of KMS key for disk encryption ..disk-encryption-status kind=amet. This is always <code>sql#diskEncryptionStatus</code>. kms-key-version-name=ipsum KMS key version used to encrypt the Cloud SQL instance resource .. etag=lorem This field is deprecated and will be removed from a future version of the API. Use the <code>settings.settingsVersion</code> field instead. failover-replica available=false The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The master can only failover to the failover replica when the status is true. name=gubergren The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID. This property is applicable only to Second Generation instances. .. gce-zone=sadipscing The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. instance-type=at The instance type. This can be one of the following. <br><code>CLOUD_SQL_INSTANCE</code>: A Cloud SQL instance that is not replicating from a master. <br><code>ON_PREMISES_INSTANCE</code>: An instance running on the customer's premises. <br><code>READ_REPLICA_INSTANCE</code>: A Cloud SQL instance configured as a read-replica. ipv6-address=sit The IPv6 address assigned to the instance. This property is applicable only to First Generation instances. kind=duo This is always <code>sql#instance</code>. master-instance-name=sit The name of the instance which will act as master in the replication setup. max-disk-size=magna The maximum disk size of the instance in bytes. name=et Name of the Cloud SQL instance. This does not include the project ID. on-premises-configuration ca-certificate=rebum. PEM representation of the trusted CA's x509 certificate. client-certificate=dolor PEM representation of the slave's x509 certificate. client-key=lorem PEM representation of the slave's private key. The corresponsing public key is encoded in the client's certificate. dump-file-path=justo The dump file to create the Cloud SQL replica. host-port=amet. The host and port of the on-premises instance in host:port format kind=no This is always <code>sql#onPremisesConfiguration</code>. password=nonumy The password for connecting to on-premises instance. username=sed The username for connecting to on-premises instance. .. project=kasd The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable. region=lorem The geographical region. Can be <code>us-central</code> (<code>FIRST_GEN</code> instances only), <code>us-central1</code> (<code>SECOND_GEN</code> instances only), <code>asia-east1</code> or <code>europe-west1</code>. Defaults to <code>us-central</code> or <code>us-central1</code> depending on the instance type (First Generation or Second Generation). The region can not be changed after instance creation. replica-configuration failover-target=true Specifies if the replica is the failover target. If the field is set to <code>true</code> the replica will be designated as a failover replica. In case the master instance fails, the replica instance will be promoted as the new master instance. <p>Only one replica can be specified as failover target, and the replica has to be in different zone with the master instance. kind=nonumy This is always <code>sql#replicaConfiguration</code>. mysql-replica-configuration ca-certificate=rebum. PEM representation of the trusted CA's x509 certificate. client-certificate=tempor PEM representation of the slave's x509 certificate. client-key=dolore PEM representation of the slave's private key. The corresponsing public key is encoded in the client's certificate. connect-retry-interval=76 Seconds to wait between connect retries. MySQL's default is 60 seconds. dump-file-path=amet. Path to a SQL dump file in Google Cloud Storage from which the slave instance is to be created. The URI is in the form gs: //bucketName/fileName. Compressed gzip files (.gz) are also supported. // Dumps should have the binlog co-ordinates from which replication should // begin. This can be accomplished by setting --master-data to 1 when using // mysqldump. kind=dolore This is always <code>sql#mysqlReplicaConfiguration</code>. master-heartbeat-period=amet Interval in milliseconds between replication heartbeats. password=ut The password for the replication connection. ssl-cipher=at A list of permissible ciphers to use for SSL encryption. username=sit The username for the replication connection. verify-server-certificate=false Whether or not to check the master's Common Name value in the certificate that it sends during the SSL handshake. ... replica-names=duo The replicas of the instance. Each invocation of this argument appends the given value to the array. root-password=sadipscing Initial root password. Use only on creation. scheduled-maintenance can-defer=false No description provided. can-reschedule=false If the scheduled maintenance can be rescheduled. start-time=kasd The start time of any upcoming scheduled maintenance for this instance. .. self-link=sadipscing The URI of this resource. server-ca-cert cert=tempor PEM representation. cert-serial-number=sea Serial number, as extracted from the certificate. common-name=et User supplied name. Constrained to [a-zA-Z.-_ ]+. create-time=lorem The time when the certificate was created in <a href=\"https://tools.ietf.org/html/rfc3339\">RFC 3339</a> format, for example <code>2012-11-15T16:19:00.094Z</code> expiration-time=magna The time when the certificate expires in <a href=\"https://tools.ietf.org/html/rfc3339\">RFC 3339</a> format, for example <code>2012-11-15T16:19:00.094Z</code>. instance=takimata Name of the database instance. kind=rebum. This is always <code>sql#sslCert</code>. self-link=at The URI of this resource. sha1-fingerprint=invidunt Sha1 Fingerprint. .. service-account-email-address=clita The service account email address assigned to the instance. This property is applicable only to Second Generation instances. settings activation-policy=stet The activation policy specifies when the instance is activated; it is applicable only when the instance state is <code>RUNNABLE</code>. Valid values: <br><code>ALWAYS</code>: The instance is on, and remains so even in the absence of connection requests. <br><code>NEVER</code>: The instance is off; it is not activated, even if a connection request arrives. <br><code>ON_DEMAND</code>: First Generation instances only. The instance responds to incoming requests, and turns itself off when not in use. Instances with <code>PER_USE</code> pricing turn off after 15 minutes of inactivity. Instances with <code>PER_PACKAGE</code> pricing turn off after 12 hours of inactivity. authorized-gae-applications=aliquyam The App Engine app IDs that can access this instance. First Generation instances only. Each invocation of this argument appends the given value to the array. availability-type=ut Availability type (PostgreSQL and MySQL instances only). Potential values: <br><code>ZONAL</code>: The instance serves data from only one zone. Outages in that zone affect data accessibility. <br><code>REGIONAL</code>: The instance can serve data from more than one zone in a region (it is highly available). <br>For more information, see <a href=\"https://cloud.google.com/sql/docs/postgres/high-availability\">Overview of the High Availability Configuration</a>. backup-configuration binary-log-enabled=false (MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well. enabled=true Whether this configuration is enabled. kind=clita This is always <code>sql#backupConfiguration</code>. location=dolor Location of the backup point-in-time-recovery-enabled=false Reserved for future use. replication-log-archiving-enabled=false Reserved for future use. start-time=diam Start time for the daily backup configuration in UTC timezone in the 24 hour format - <code>HH:MM</code>. .. crash-safe-replication-enabled=false Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property is only applicable to First Generation instances. data-disk-size-gb=et The size of data disk, in GB. The data disk size minimum is 10GB. Not used for First Generation instances. data-disk-type=sanctus The type of data disk: <code>PD_SSD</code> (default) or <code>PD_HDD</code>. Not used for First Generation instances. database-replication-enabled=true Configuration specific to read replica instances. Indicates whether replication is enabled or not. ip-configuration ipv4-enabled=true Whether the instance should be assigned an IP address or not. private-network=est The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, <code>/projects/myProject/global/networks/default</code>. This setting can be updated, but it cannot be removed after it is set. require-ssl=false Whether SSL connections over IP should be enforced or not. .. kind=diam This is always <code>sql#settings</code>. location-preference follow-gae-application=at The AppEngine application to follow, it must be in the same region as the Cloud SQL instance. kind=erat This is always <code>sql#locationPreference</code>. zone=justo The preferred Compute Engine zone (e.g. us-central1-a, us-central1-b, etc.). ..maintenance-window day=96 day of week (1-7), starting on Monday. hour=28 hour of day - 0 to 23. kind=dolores This is always <code>sql#maintenanceWindow</code>. update-track=consetetur Maintenance timing setting: <code>canary</code> (Earlier) or <code>stable</code> (Later). <br /><a href=\"/sql/docs/db_path/instance-settings#maintenance-timing-2ndgen\"> Learn more</a>. .. pricing-plan=no The pricing plan for this instance. This can be either <code>PER_USE</code> or <code>PACKAGE</code>. Only <code>PER_USE</code> is supported for Second Generation instances. replication-type=justo The type of replication this instance uses. This can be either <code>ASYNCHRONOUS</code> or <code>SYNCHRONOUS</code>. This property is only applicable to First Generation instances. settings-version=sadipscing The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value. storage-auto-resize=true Configuration to increase storage size automatically. The default value is true. Not used for First Generation instances. storage-auto-resize-limit=sea The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit. Not used for First Generation instances. tier=ipsum The tier (or machine type) for this instance, for example <code>db-n1-standard-1</code> (MySQL instances) or <code>db-custom-1-3840</code> (PostgreSQL instances). For MySQL instances, this property determines whether the instance is First or Second Generation. For more information, see <a href=\"/sql/docs/db_path/instance-settings\">Instance Settings</a>. user-labels=key=stet User-provided labels, represented as a dictionary where each label is a single key value pair. the value will be associated with the given key .. state=gubergren The current serving state of the Cloud SQL instance. This can be one of the following. <br><code>RUNNABLE</code>: The instance is running, or is ready to run when accessed. <br><code>SUSPENDED</code>: The instance is not available, for example due to problems with billing. <br><code>PENDING_CREATE</code>: The instance is being created. <br><code>MAINTENANCE</code>: The instance is down for maintenance. <br><code>FAILED</code>: The instance creation failed. <br><code>UNKNOWN_STATE</code>: The state of the instance is unknown. suspension-reason=ipsum If the instance state is SUSPENDED, the reason for the suspension. Each invocation of this argument appends the given value to the array. About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Patch"},{"location":"instances_patch/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> instances patch ...","title":"Scopes"},{"location":"instances_patch/#required-scalar-arguments","text":"<project> (string) Project ID of the project that contains the instance. <instance> (string) Cloud SQL instance ID. This does not include the project ID.","title":"Required Scalar Arguments"},{"location":"instances_patch/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: DatabaseInstance: backend-type: string connection-name: string current-disk-size: string database-version: string disk-encryption-configuration: kind: string kms-key-name: string disk-encryption-status: kind: string kms-key-version-name: string etag: string failover-replica: available: boolean name: string gce-zone: string instance-type: string ipv6-address: string kind: string master-instance-name: string max-disk-size: string name: string on-premises-configuration: ca-certificate: string client-certificate: string client-key: string dump-file-path: string host-port: string kind: string password: string username: string project: string region: string replica-configuration: failover-target: boolean kind: string mysql-replica-configuration: ca-certificate: string client-certificate: string client-key: string connect-retry-interval: integer dump-file-path: string kind: string master-heartbeat-period: string password: string ssl-cipher: string username: string verify-server-certificate: boolean replica-names: [string] root-password: string scheduled-maintenance: can-defer: boolean can-reschedule: boolean start-time: string self-link: string server-ca-cert: cert: string cert-serial-number: string common-name: string create-time: string expiration-time: string instance: string kind: string self-link: string sha1-fingerprint: string service-account-email-address: string settings: activation-policy: string authorized-gae-applications: [string] availability-type: string backup-configuration: binary-log-enabled: boolean enabled: boolean kind: string location: string point-in-time-recovery-enabled: boolean replication-log-archiving-enabled: boolean start-time: string crash-safe-replication-enabled: boolean data-disk-size-gb: string data-disk-type: string database-replication-enabled: boolean ip-configuration: ipv4-enabled: boolean private-network: string require-ssl: boolean kind: string location-preference: follow-gae-application: string kind: string zone: string maintenance-window: day: integer hour: integer kind: string update-track: string pricing-plan: string replication-type: string settings-version: string storage-auto-resize: boolean storage-auto-resize-limit: string tier: string user-labels: { string: string } state: string suspension-reason: [string] can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . backend-type=dolores <code>FIRST_GEN</code>: First Generation instance. MySQL only. <br /><code>SECOND_GEN</code>: Second Generation instance or PostgreSQL instance. <br /><code>EXTERNAL</code>: A database server that is not managed by Google. <br>This property is read-only; use the <code>tier</code> property in the <code>settings</code> object to determine the database type and Second or First Generation. connection-name=consetetur Connection name of the Cloud SQL instance used in connection strings. current-disk-size=gubergren The current disk usage of the instance in bytes. This property has been deprecated. Users should use the \"cloudsql.googleapis.com/database/disk/bytes_used\" metric in Cloud Monitoring API instead. Please see <a href=\"https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ\">this announcement</a> for details. database-version=dolor The database engine type and version. The <code>databaseVersion</code> field can not be changed after instance creation. MySQL Second Generation instances: <code>MYSQL_5_7</code> (default) or <code>MYSQL_5_6</code>. PostgreSQL instances: <code>POSTGRES_9_6</code> (default) or <code>POSTGRES_11 Beta</code> MySQL First Generation instances: <code>MYSQL_5_6</code> (default) or <code>MYSQL_5_5</code> disk-encryption-configuration kind=aliquyam This is always <code>sql#diskEncryptionConfiguration</code>. kms-key-name=no Resource name of KMS key for disk encryption ..disk-encryption-status kind=amet. This is always <code>sql#diskEncryptionStatus</code>. kms-key-version-name=ipsum KMS key version used to encrypt the Cloud SQL instance resource .. etag=lorem This field is deprecated and will be removed from a future version of the API. Use the <code>settings.settingsVersion</code> field instead. failover-replica available=false The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The master can only failover to the failover replica when the status is true. name=gubergren The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID. This property is applicable only to Second Generation instances. .. gce-zone=sadipscing The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. instance-type=at The instance type. This can be one of the following. <br><code>CLOUD_SQL_INSTANCE</code>: A Cloud SQL instance that is not replicating from a master. <br><code>ON_PREMISES_INSTANCE</code>: An instance running on the customer's premises. <br><code>READ_REPLICA_INSTANCE</code>: A Cloud SQL instance configured as a read-replica. ipv6-address=sit The IPv6 address assigned to the instance. This property is applicable only to First Generation instances. kind=duo This is always <code>sql#instance</code>. master-instance-name=sit The name of the instance which will act as master in the replication setup. max-disk-size=magna The maximum disk size of the instance in bytes. name=et Name of the Cloud SQL instance. This does not include the project ID. on-premises-configuration ca-certificate=rebum. PEM representation of the trusted CA's x509 certificate. client-certificate=dolor PEM representation of the slave's x509 certificate. client-key=lorem PEM representation of the slave's private key. The corresponsing public key is encoded in the client's certificate. dump-file-path=justo The dump file to create the Cloud SQL replica. host-port=amet. The host and port of the on-premises instance in host:port format kind=no This is always <code>sql#onPremisesConfiguration</code>. password=nonumy The password for connecting to on-premises instance. username=sed The username for connecting to on-premises instance. .. project=kasd The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable. region=lorem The geographical region. Can be <code>us-central</code> (<code>FIRST_GEN</code> instances only), <code>us-central1</code> (<code>SECOND_GEN</code> instances only), <code>asia-east1</code> or <code>europe-west1</code>. Defaults to <code>us-central</code> or <code>us-central1</code> depending on the instance type (First Generation or Second Generation). The region can not be changed after instance creation. replica-configuration failover-target=true Specifies if the replica is the failover target. If the field is set to <code>true</code> the replica will be designated as a failover replica. In case the master instance fails, the replica instance will be promoted as the new master instance. <p>Only one replica can be specified as failover target, and the replica has to be in different zone with the master instance. kind=nonumy This is always <code>sql#replicaConfiguration</code>. mysql-replica-configuration ca-certificate=rebum. PEM representation of the trusted CA's x509 certificate. client-certificate=tempor PEM representation of the slave's x509 certificate. client-key=dolore PEM representation of the slave's private key. The corresponsing public key is encoded in the client's certificate. connect-retry-interval=76 Seconds to wait between connect retries. MySQL's default is 60 seconds. dump-file-path=amet. Path to a SQL dump file in Google Cloud Storage from which the slave instance is to be created. The URI is in the form gs: //bucketName/fileName. Compressed gzip files (.gz) are also supported. // Dumps should have the binlog co-ordinates from which replication should // begin. This can be accomplished by setting --master-data to 1 when using // mysqldump. kind=dolore This is always <code>sql#mysqlReplicaConfiguration</code>. master-heartbeat-period=amet Interval in milliseconds between replication heartbeats. password=ut The password for the replication connection. ssl-cipher=at A list of permissible ciphers to use for SSL encryption. username=sit The username for the replication connection. verify-server-certificate=false Whether or not to check the master's Common Name value in the certificate that it sends during the SSL handshake. ... replica-names=duo The replicas of the instance. Each invocation of this argument appends the given value to the array. root-password=sadipscing Initial root password. Use only on creation. scheduled-maintenance can-defer=false No description provided. can-reschedule=false If the scheduled maintenance can be rescheduled. start-time=kasd The start time of any upcoming scheduled maintenance for this instance. .. self-link=sadipscing The URI of this resource. server-ca-cert cert=tempor PEM representation. cert-serial-number=sea Serial number, as extracted from the certificate. common-name=et User supplied name. Constrained to [a-zA-Z.-_ ]+. create-time=lorem The time when the certificate was created in <a href=\"https://tools.ietf.org/html/rfc3339\">RFC 3339</a> format, for example <code>2012-11-15T16:19:00.094Z</code> expiration-time=magna The time when the certificate expires in <a href=\"https://tools.ietf.org/html/rfc3339\">RFC 3339</a> format, for example <code>2012-11-15T16:19:00.094Z</code>. instance=takimata Name of the database instance. kind=rebum. This is always <code>sql#sslCert</code>. self-link=at The URI of this resource. sha1-fingerprint=invidunt Sha1 Fingerprint. .. service-account-email-address=clita The service account email address assigned to the instance. This property is applicable only to Second Generation instances. settings activation-policy=stet The activation policy specifies when the instance is activated; it is applicable only when the instance state is <code>RUNNABLE</code>. Valid values: <br><code>ALWAYS</code>: The instance is on, and remains so even in the absence of connection requests. <br><code>NEVER</code>: The instance is off; it is not activated, even if a connection request arrives. <br><code>ON_DEMAND</code>: First Generation instances only. The instance responds to incoming requests, and turns itself off when not in use. Instances with <code>PER_USE</code> pricing turn off after 15 minutes of inactivity. Instances with <code>PER_PACKAGE</code> pricing turn off after 12 hours of inactivity. authorized-gae-applications=aliquyam The App Engine app IDs that can access this instance. First Generation instances only. Each invocation of this argument appends the given value to the array. availability-type=ut Availability type (PostgreSQL and MySQL instances only). Potential values: <br><code>ZONAL</code>: The instance serves data from only one zone. Outages in that zone affect data accessibility. <br><code>REGIONAL</code>: The instance can serve data from more than one zone in a region (it is highly available). <br>For more information, see <a href=\"https://cloud.google.com/sql/docs/postgres/high-availability\">Overview of the High Availability Configuration</a>. backup-configuration binary-log-enabled=false (MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well. enabled=true Whether this configuration is enabled. kind=clita This is always <code>sql#backupConfiguration</code>. location=dolor Location of the backup point-in-time-recovery-enabled=false Reserved for future use. replication-log-archiving-enabled=false Reserved for future use. start-time=diam Start time for the daily backup configuration in UTC timezone in the 24 hour format - <code>HH:MM</code>. .. crash-safe-replication-enabled=false Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property is only applicable to First Generation instances. data-disk-size-gb=et The size of data disk, in GB. The data disk size minimum is 10GB. Not used for First Generation instances. data-disk-type=sanctus The type of data disk: <code>PD_SSD</code> (default) or <code>PD_HDD</code>. Not used for First Generation instances. database-replication-enabled=true Configuration specific to read replica instances. Indicates whether replication is enabled or not. ip-configuration ipv4-enabled=true Whether the instance should be assigned an IP address or not. private-network=est The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, <code>/projects/myProject/global/networks/default</code>. This setting can be updated, but it cannot be removed after it is set. require-ssl=false Whether SSL connections over IP should be enforced or not. .. kind=diam This is always <code>sql#settings</code>. location-preference follow-gae-application=at The AppEngine application to follow, it must be in the same region as the Cloud SQL instance. kind=erat This is always <code>sql#locationPreference</code>. zone=justo The preferred Compute Engine zone (e.g. us-central1-a, us-central1-b, etc.). ..maintenance-window day=96 day of week (1-7), starting on Monday. hour=28 hour of day - 0 to 23. kind=dolores This is always <code>sql#maintenanceWindow</code>. update-track=consetetur Maintenance timing setting: <code>canary</code> (Earlier) or <code>stable</code> (Later). <br /><a href=\"/sql/docs/db_path/instance-settings#maintenance-timing-2ndgen\"> Learn more</a>. .. pricing-plan=no The pricing plan for this instance. This can be either <code>PER_USE</code> or <code>PACKAGE</code>. Only <code>PER_USE</code> is supported for Second Generation instances. replication-type=justo The type of replication this instance uses. This can be either <code>ASYNCHRONOUS</code> or <code>SYNCHRONOUS</code>. This property is only applicable to First Generation instances. settings-version=sadipscing The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value. storage-auto-resize=true Configuration to increase storage size automatically. The default value is true. Not used for First Generation instances. storage-auto-resize-limit=sea The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit. Not used for First Generation instances. tier=ipsum The tier (or machine type) for this instance, for example <code>db-n1-standard-1</code> (MySQL instances) or <code>db-custom-1-3840</code> (PostgreSQL instances). For MySQL instances, this property determines whether the instance is First or Second Generation. For more information, see <a href=\"/sql/docs/db_path/instance-settings\">Instance Settings</a>. user-labels=key=stet User-provided labels, represented as a dictionary where each label is a single key value pair. the value will be associated with the given key .. state=gubergren The current serving state of the Cloud SQL instance. This can be one of the following. <br><code>RUNNABLE</code>: The instance is running, or is ready to run when accessed. <br><code>SUSPENDED</code>: The instance is not available, for example due to problems with billing. <br><code>PENDING_CREATE</code>: The instance is being created. <br><code>MAINTENANCE</code>: The instance is down for maintenance. <br><code>FAILED</code>: The instance creation failed. <br><code>UNKNOWN_STATE</code>: The state of the instance is unknown. suspension-reason=ipsum If the instance state is SUSPENDED, the reason for the suspension. Each invocation of this argument appends the given value to the array.","title":"Required Request Value"},{"location":"instances_patch/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"instances_patch/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"instances_patch/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"instances_promote-replica/","text":"Promotes the read replica instance to be a stand-alone Cloud SQL instance. Using this operation might cause your instance to restart. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> instances promote-replica ... Required Scalar Arguments <project> (string) ID of the project that contains the read replica. <instance> (string) Cloud SQL read replica instance name. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Promote Replica"},{"location":"instances_promote-replica/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> instances promote-replica ...","title":"Scopes"},{"location":"instances_promote-replica/#required-scalar-arguments","text":"<project> (string) ID of the project that contains the read replica. <instance> (string) Cloud SQL read replica instance name.","title":"Required Scalar Arguments"},{"location":"instances_promote-replica/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"instances_promote-replica/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"instances_reset-ssl-config/","text":"Deletes all client certificates and generates a new server SSL certificate for the instance. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> instances reset-ssl-config ... Required Scalar Arguments <project> (string) Project ID of the project that contains the instance. <instance> (string) Cloud SQL instance ID. This does not include the project ID. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Reset Ssl Config"},{"location":"instances_reset-ssl-config/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> instances reset-ssl-config ...","title":"Scopes"},{"location":"instances_reset-ssl-config/#required-scalar-arguments","text":"<project> (string) Project ID of the project that contains the instance. <instance> (string) Cloud SQL instance ID. This does not include the project ID.","title":"Required Scalar Arguments"},{"location":"instances_reset-ssl-config/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"instances_reset-ssl-config/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"instances_restart/","text":"Restarts a Cloud SQL instance. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> instances restart ... Required Scalar Arguments <project> (string) Project ID of the project that contains the instance to be restarted. <instance> (string) Cloud SQL instance ID. This does not include the project ID. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Restart"},{"location":"instances_restart/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> instances restart ...","title":"Scopes"},{"location":"instances_restart/#required-scalar-arguments","text":"<project> (string) Project ID of the project that contains the instance to be restarted. <instance> (string) Cloud SQL instance ID. This does not include the project ID.","title":"Required Scalar Arguments"},{"location":"instances_restart/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"instances_restart/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"instances_restore-backup/","text":"Restores a backup of a Cloud SQL instance. Using this operation might cause your instance to restart. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> instances restore-backup ... Required Scalar Arguments <project> (string) Project ID of the project that contains the instance. <instance> (string) Cloud SQL instance ID. This does not include the project ID. Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: InstancesRestoreBackupRequest: restore-backup-context: backup-run-id: string instance-id: string kind: string project: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .restore-backup-context backup-run-id=no The ID of the backup run to restore from. instance-id=sit The ID of the instance that the backup was taken from. kind=kasd This is always <code>sql#restoreBackupContext</code>. project=amet The full project ID of the source instance. About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Restore Backup"},{"location":"instances_restore-backup/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> instances restore-backup ...","title":"Scopes"},{"location":"instances_restore-backup/#required-scalar-arguments","text":"<project> (string) Project ID of the project that contains the instance. <instance> (string) Cloud SQL instance ID. This does not include the project ID.","title":"Required Scalar Arguments"},{"location":"instances_restore-backup/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: InstancesRestoreBackupRequest: restore-backup-context: backup-run-id: string instance-id: string kind: string project: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .restore-backup-context backup-run-id=no The ID of the backup run to restore from. instance-id=sit The ID of the instance that the backup was taken from. kind=kasd This is always <code>sql#restoreBackupContext</code>. project=amet The full project ID of the source instance.","title":"Required Request Value"},{"location":"instances_restore-backup/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"instances_restore-backup/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"instances_restore-backup/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"instances_rotate-server-ca/","text":"Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> instances rotate-server-ca ... Required Scalar Arguments <project> (string) Project ID of the project that contains the instance. <instance> (string) Cloud SQL instance ID. This does not include the project ID. Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: InstancesRotateServerCaRequest: rotate-server-ca-context: kind: string next-version: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .rotate-server-ca-context kind=lorem This is always <code>sql#rotateServerCaContext</code>. next-version=justo The fingerprint of the next version to be rotated to. If left unspecified, will be rotated to the most recently added server CA version. About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Rotate Server Ca"},{"location":"instances_rotate-server-ca/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> instances rotate-server-ca ...","title":"Scopes"},{"location":"instances_rotate-server-ca/#required-scalar-arguments","text":"<project> (string) Project ID of the project that contains the instance. <instance> (string) Cloud SQL instance ID. This does not include the project ID.","title":"Required Scalar Arguments"},{"location":"instances_rotate-server-ca/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: InstancesRotateServerCaRequest: rotate-server-ca-context: kind: string next-version: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .rotate-server-ca-context kind=lorem This is always <code>sql#rotateServerCaContext</code>. next-version=justo The fingerprint of the next version to be rotated to. If left unspecified, will be rotated to the most recently added server CA version.","title":"Required Request Value"},{"location":"instances_rotate-server-ca/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"instances_rotate-server-ca/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"instances_rotate-server-ca/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"instances_start-replica/","text":"Starts the replication in the read replica instance. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> instances start-replica ... Required Scalar Arguments <project> (string) ID of the project that contains the read replica. <instance> (string) Cloud SQL read replica instance name. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Start Replica"},{"location":"instances_start-replica/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> instances start-replica ...","title":"Scopes"},{"location":"instances_start-replica/#required-scalar-arguments","text":"<project> (string) ID of the project that contains the read replica. <instance> (string) Cloud SQL read replica instance name.","title":"Required Scalar Arguments"},{"location":"instances_start-replica/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"instances_start-replica/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"instances_stop-replica/","text":"Stops the replication in the read replica instance. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> instances stop-replica ... Required Scalar Arguments <project> (string) ID of the project that contains the read replica. <instance> (string) Cloud SQL read replica instance name. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Stop Replica"},{"location":"instances_stop-replica/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> instances stop-replica ...","title":"Scopes"},{"location":"instances_stop-replica/#required-scalar-arguments","text":"<project> (string) ID of the project that contains the read replica. <instance> (string) Cloud SQL read replica instance name.","title":"Required Scalar Arguments"},{"location":"instances_stop-replica/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"instances_stop-replica/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"instances_truncate-log/","text":"Truncate MySQL general and slow query log tables Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> instances truncate-log ... Required Scalar Arguments <project> (string) Project ID of the Cloud SQL project. <instance> (string) Cloud SQL instance ID. This does not include the project ID. Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: InstancesTruncateLogRequest: truncate-log-context: kind: string log-type: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .truncate-log-context kind=invidunt This is always <code>sql#truncateLogContext</code>. log-type=sed The type of log to truncate. Valid values are <code>MYSQL_GENERAL_TABLE</code> and <code>MYSQL_SLOW_TABLE</code>. About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Truncate Log"},{"location":"instances_truncate-log/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> instances truncate-log ...","title":"Scopes"},{"location":"instances_truncate-log/#required-scalar-arguments","text":"<project> (string) Project ID of the Cloud SQL project. <instance> (string) Cloud SQL instance ID. This does not include the project ID.","title":"Required Scalar Arguments"},{"location":"instances_truncate-log/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: InstancesTruncateLogRequest: truncate-log-context: kind: string log-type: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .truncate-log-context kind=invidunt This is always <code>sql#truncateLogContext</code>. log-type=sed The type of log to truncate. Valid values are <code>MYSQL_GENERAL_TABLE</code> and <code>MYSQL_SLOW_TABLE</code>.","title":"Required Request Value"},{"location":"instances_truncate-log/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"instances_truncate-log/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"instances_truncate-log/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"instances_update/","text":"Updates settings of a Cloud SQL instance. Using this operation might cause your instance to restart. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> instances update ... Required Scalar Arguments <project> (string) Project ID of the project that contains the instance. <instance> (string) Cloud SQL instance ID. This does not include the project ID. Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: DatabaseInstance: backend-type: string connection-name: string current-disk-size: string database-version: string disk-encryption-configuration: kind: string kms-key-name: string disk-encryption-status: kind: string kms-key-version-name: string etag: string failover-replica: available: boolean name: string gce-zone: string instance-type: string ipv6-address: string kind: string master-instance-name: string max-disk-size: string name: string on-premises-configuration: ca-certificate: string client-certificate: string client-key: string dump-file-path: string host-port: string kind: string password: string username: string project: string region: string replica-configuration: failover-target: boolean kind: string mysql-replica-configuration: ca-certificate: string client-certificate: string client-key: string connect-retry-interval: integer dump-file-path: string kind: string master-heartbeat-period: string password: string ssl-cipher: string username: string verify-server-certificate: boolean replica-names: [string] root-password: string scheduled-maintenance: can-defer: boolean can-reschedule: boolean start-time: string self-link: string server-ca-cert: cert: string cert-serial-number: string common-name: string create-time: string expiration-time: string instance: string kind: string self-link: string sha1-fingerprint: string service-account-email-address: string settings: activation-policy: string authorized-gae-applications: [string] availability-type: string backup-configuration: binary-log-enabled: boolean enabled: boolean kind: string location: string point-in-time-recovery-enabled: boolean replication-log-archiving-enabled: boolean start-time: string crash-safe-replication-enabled: boolean data-disk-size-gb: string data-disk-type: string database-replication-enabled: boolean ip-configuration: ipv4-enabled: boolean private-network: string require-ssl: boolean kind: string location-preference: follow-gae-application: string kind: string zone: string maintenance-window: day: integer hour: integer kind: string update-track: string pricing-plan: string replication-type: string settings-version: string storage-auto-resize: boolean storage-auto-resize-limit: string tier: string user-labels: { string: string } state: string suspension-reason: [string] can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . backend-type=nonumy <code>FIRST_GEN</code>: First Generation instance. MySQL only. <br /><code>SECOND_GEN</code>: Second Generation instance or PostgreSQL instance. <br /><code>EXTERNAL</code>: A database server that is not managed by Google. <br>This property is read-only; use the <code>tier</code> property in the <code>settings</code> object to determine the database type and Second or First Generation. connection-name=sea Connection name of the Cloud SQL instance used in connection strings. current-disk-size=ipsum The current disk usage of the instance in bytes. This property has been deprecated. Users should use the \"cloudsql.googleapis.com/database/disk/bytes_used\" metric in Cloud Monitoring API instead. Please see <a href=\"https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ\">this announcement</a> for details. database-version=kasd The database engine type and version. The <code>databaseVersion</code> field can not be changed after instance creation. MySQL Second Generation instances: <code>MYSQL_5_7</code> (default) or <code>MYSQL_5_6</code>. PostgreSQL instances: <code>POSTGRES_9_6</code> (default) or <code>POSTGRES_11 Beta</code> MySQL First Generation instances: <code>MYSQL_5_6</code> (default) or <code>MYSQL_5_5</code> disk-encryption-configuration kind=justo This is always <code>sql#diskEncryptionConfiguration</code>. kms-key-name=ea Resource name of KMS key for disk encryption ..disk-encryption-status kind=at This is always <code>sql#diskEncryptionStatus</code>. kms-key-version-name=erat KMS key version used to encrypt the Cloud SQL instance resource .. etag=clita This field is deprecated and will be removed from a future version of the API. Use the <code>settings.settingsVersion</code> field instead. failover-replica available=false The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The master can only failover to the failover replica when the status is true. name=invidunt The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID. This property is applicable only to Second Generation instances. .. gce-zone=nonumy The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. instance-type=erat The instance type. This can be one of the following. <br><code>CLOUD_SQL_INSTANCE</code>: A Cloud SQL instance that is not replicating from a master. <br><code>ON_PREMISES_INSTANCE</code>: An instance running on the customer's premises. <br><code>READ_REPLICA_INSTANCE</code>: A Cloud SQL instance configured as a read-replica. ipv6-address=erat The IPv6 address assigned to the instance. This property is applicable only to First Generation instances. kind=dolores This is always <code>sql#instance</code>. master-instance-name=ipsum The name of the instance which will act as master in the replication setup. max-disk-size=voluptua. The maximum disk size of the instance in bytes. name=eos Name of the Cloud SQL instance. This does not include the project ID. on-premises-configuration ca-certificate=duo PEM representation of the trusted CA's x509 certificate. client-certificate=elitr PEM representation of the slave's x509 certificate. client-key=consetetur PEM representation of the slave's private key. The corresponsing public key is encoded in the client's certificate. dump-file-path=et The dump file to create the Cloud SQL replica. host-port=clita The host and port of the on-premises instance in host:port format kind=sit This is always <code>sql#onPremisesConfiguration</code>. password=takimata The password for connecting to on-premises instance. username=erat The username for connecting to on-premises instance. .. project=diam The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable. region=nonumy The geographical region. Can be <code>us-central</code> (<code>FIRST_GEN</code> instances only), <code>us-central1</code> (<code>SECOND_GEN</code> instances only), <code>asia-east1</code> or <code>europe-west1</code>. Defaults to <code>us-central</code> or <code>us-central1</code> depending on the instance type (First Generation or Second Generation). The region can not be changed after instance creation. replica-configuration failover-target=false Specifies if the replica is the failover target. If the field is set to <code>true</code> the replica will be designated as a failover replica. In case the master instance fails, the replica instance will be promoted as the new master instance. <p>Only one replica can be specified as failover target, and the replica has to be in different zone with the master instance. kind=diam This is always <code>sql#replicaConfiguration</code>. mysql-replica-configuration ca-certificate=diam PEM representation of the trusted CA's x509 certificate. client-certificate=sed PEM representation of the slave's x509 certificate. client-key=et PEM representation of the slave's private key. The corresponsing public key is encoded in the client's certificate. connect-retry-interval=84 Seconds to wait between connect retries. MySQL's default is 60 seconds. dump-file-path=dolore Path to a SQL dump file in Google Cloud Storage from which the slave instance is to be created. The URI is in the form gs: //bucketName/fileName. Compressed gzip files (.gz) are also supported. // Dumps should have the binlog co-ordinates from which replication should // begin. This can be accomplished by setting --master-data to 1 when using // mysqldump. kind=ipsum This is always <code>sql#mysqlReplicaConfiguration</code>. master-heartbeat-period=ea Interval in milliseconds between replication heartbeats. password=at The password for the replication connection. ssl-cipher=sit A list of permissible ciphers to use for SSL encryption. username=sit The username for the replication connection. verify-server-certificate=false Whether or not to check the master's Common Name value in the certificate that it sends during the SSL handshake. ... replica-names=stet The replicas of the instance. Each invocation of this argument appends the given value to the array. root-password=duo Initial root password. Use only on creation. scheduled-maintenance can-defer=false No description provided. can-reschedule=false If the scheduled maintenance can be rescheduled. start-time=et The start time of any upcoming scheduled maintenance for this instance. .. self-link=lorem The URI of this resource. server-ca-cert cert=rebum. PEM representation. cert-serial-number=et Serial number, as extracted from the certificate. common-name=sed User supplied name. Constrained to [a-zA-Z.-_ ]+. create-time=stet The time when the certificate was created in <a href=\"https://tools.ietf.org/html/rfc3339\">RFC 3339</a> format, for example <code>2012-11-15T16:19:00.094Z</code> expiration-time=aliquyam The time when the certificate expires in <a href=\"https://tools.ietf.org/html/rfc3339\">RFC 3339</a> format, for example <code>2012-11-15T16:19:00.094Z</code>. instance=kasd Name of the database instance. kind=lorem This is always <code>sql#sslCert</code>. self-link=sit The URI of this resource. sha1-fingerprint=kasd Sha1 Fingerprint. .. service-account-email-address=tempor The service account email address assigned to the instance. This property is applicable only to Second Generation instances. settings activation-policy=dolor The activation policy specifies when the instance is activated; it is applicable only when the instance state is <code>RUNNABLE</code>. Valid values: <br><code>ALWAYS</code>: The instance is on, and remains so even in the absence of connection requests. <br><code>NEVER</code>: The instance is off; it is not activated, even if a connection request arrives. <br><code>ON_DEMAND</code>: First Generation instances only. The instance responds to incoming requests, and turns itself off when not in use. Instances with <code>PER_USE</code> pricing turn off after 15 minutes of inactivity. Instances with <code>PER_PACKAGE</code> pricing turn off after 12 hours of inactivity. authorized-gae-applications=amet The App Engine app IDs that can access this instance. First Generation instances only. Each invocation of this argument appends the given value to the array. availability-type=sit Availability type (PostgreSQL and MySQL instances only). Potential values: <br><code>ZONAL</code>: The instance serves data from only one zone. Outages in that zone affect data accessibility. <br><code>REGIONAL</code>: The instance can serve data from more than one zone in a region (it is highly available). <br>For more information, see <a href=\"https://cloud.google.com/sql/docs/postgres/high-availability\">Overview of the High Availability Configuration</a>. backup-configuration binary-log-enabled=true (MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well. enabled=false Whether this configuration is enabled. kind=ipsum This is always <code>sql#backupConfiguration</code>. location=et Location of the backup point-in-time-recovery-enabled=false Reserved for future use. replication-log-archiving-enabled=false Reserved for future use. start-time=dolor Start time for the daily backup configuration in UTC timezone in the 24 hour format - <code>HH:MM</code>. .. crash-safe-replication-enabled=false Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property is only applicable to First Generation instances. data-disk-size-gb=dolor The size of data disk, in GB. The data disk size minimum is 10GB. Not used for First Generation instances. data-disk-type=dolor The type of data disk: <code>PD_SSD</code> (default) or <code>PD_HDD</code>. Not used for First Generation instances. database-replication-enabled=true Configuration specific to read replica instances. Indicates whether replication is enabled or not. ip-configuration ipv4-enabled=true Whether the instance should be assigned an IP address or not. private-network=lorem The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, <code>/projects/myProject/global/networks/default</code>. This setting can be updated, but it cannot be removed after it is set. require-ssl=true Whether SSL connections over IP should be enforced or not. .. kind=diam This is always <code>sql#settings</code>. location-preference follow-gae-application=ipsum The AppEngine application to follow, it must be in the same region as the Cloud SQL instance. kind=invidunt This is always <code>sql#locationPreference</code>. zone=stet The preferred Compute Engine zone (e.g. us-central1-a, us-central1-b, etc.). ..maintenance-window day=23 day of week (1-7), starting on Monday. hour=24 hour of day - 0 to 23. kind=diam This is always <code>sql#maintenanceWindow</code>. update-track=amet Maintenance timing setting: <code>canary</code> (Earlier) or <code>stable</code> (Later). <br /><a href=\"/sql/docs/db_path/instance-settings#maintenance-timing-2ndgen\"> Learn more</a>. .. pricing-plan=at The pricing plan for this instance. This can be either <code>PER_USE</code> or <code>PACKAGE</code>. Only <code>PER_USE</code> is supported for Second Generation instances. replication-type=eirmod The type of replication this instance uses. This can be either <code>ASYNCHRONOUS</code> or <code>SYNCHRONOUS</code>. This property is only applicable to First Generation instances. settings-version=erat The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value. storage-auto-resize=false Configuration to increase storage size automatically. The default value is true. Not used for First Generation instances. storage-auto-resize-limit=sit The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit. Not used for First Generation instances. tier=accusam The tier (or machine type) for this instance, for example <code>db-n1-standard-1</code> (MySQL instances) or <code>db-custom-1-3840</code> (PostgreSQL instances). For MySQL instances, this property determines whether the instance is First or Second Generation. For more information, see <a href=\"/sql/docs/db_path/instance-settings\">Instance Settings</a>. user-labels=key=et User-provided labels, represented as a dictionary where each label is a single key value pair. the value will be associated with the given key .. state=nonumy The current serving state of the Cloud SQL instance. This can be one of the following. <br><code>RUNNABLE</code>: The instance is running, or is ready to run when accessed. <br><code>SUSPENDED</code>: The instance is not available, for example due to problems with billing. <br><code>PENDING_CREATE</code>: The instance is being created. <br><code>MAINTENANCE</code>: The instance is down for maintenance. <br><code>FAILED</code>: The instance creation failed. <br><code>UNKNOWN_STATE</code>: The state of the instance is unknown. suspension-reason=accusam If the instance state is SUSPENDED, the reason for the suspension. Each invocation of this argument appends the given value to the array. About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Update"},{"location":"instances_update/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> instances update ...","title":"Scopes"},{"location":"instances_update/#required-scalar-arguments","text":"<project> (string) Project ID of the project that contains the instance. <instance> (string) Cloud SQL instance ID. This does not include the project ID.","title":"Required Scalar Arguments"},{"location":"instances_update/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: DatabaseInstance: backend-type: string connection-name: string current-disk-size: string database-version: string disk-encryption-configuration: kind: string kms-key-name: string disk-encryption-status: kind: string kms-key-version-name: string etag: string failover-replica: available: boolean name: string gce-zone: string instance-type: string ipv6-address: string kind: string master-instance-name: string max-disk-size: string name: string on-premises-configuration: ca-certificate: string client-certificate: string client-key: string dump-file-path: string host-port: string kind: string password: string username: string project: string region: string replica-configuration: failover-target: boolean kind: string mysql-replica-configuration: ca-certificate: string client-certificate: string client-key: string connect-retry-interval: integer dump-file-path: string kind: string master-heartbeat-period: string password: string ssl-cipher: string username: string verify-server-certificate: boolean replica-names: [string] root-password: string scheduled-maintenance: can-defer: boolean can-reschedule: boolean start-time: string self-link: string server-ca-cert: cert: string cert-serial-number: string common-name: string create-time: string expiration-time: string instance: string kind: string self-link: string sha1-fingerprint: string service-account-email-address: string settings: activation-policy: string authorized-gae-applications: [string] availability-type: string backup-configuration: binary-log-enabled: boolean enabled: boolean kind: string location: string point-in-time-recovery-enabled: boolean replication-log-archiving-enabled: boolean start-time: string crash-safe-replication-enabled: boolean data-disk-size-gb: string data-disk-type: string database-replication-enabled: boolean ip-configuration: ipv4-enabled: boolean private-network: string require-ssl: boolean kind: string location-preference: follow-gae-application: string kind: string zone: string maintenance-window: day: integer hour: integer kind: string update-track: string pricing-plan: string replication-type: string settings-version: string storage-auto-resize: boolean storage-auto-resize-limit: string tier: string user-labels: { string: string } state: string suspension-reason: [string] can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . backend-type=nonumy <code>FIRST_GEN</code>: First Generation instance. MySQL only. <br /><code>SECOND_GEN</code>: Second Generation instance or PostgreSQL instance. <br /><code>EXTERNAL</code>: A database server that is not managed by Google. <br>This property is read-only; use the <code>tier</code> property in the <code>settings</code> object to determine the database type and Second or First Generation. connection-name=sea Connection name of the Cloud SQL instance used in connection strings. current-disk-size=ipsum The current disk usage of the instance in bytes. This property has been deprecated. Users should use the \"cloudsql.googleapis.com/database/disk/bytes_used\" metric in Cloud Monitoring API instead. Please see <a href=\"https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ\">this announcement</a> for details. database-version=kasd The database engine type and version. The <code>databaseVersion</code> field can not be changed after instance creation. MySQL Second Generation instances: <code>MYSQL_5_7</code> (default) or <code>MYSQL_5_6</code>. PostgreSQL instances: <code>POSTGRES_9_6</code> (default) or <code>POSTGRES_11 Beta</code> MySQL First Generation instances: <code>MYSQL_5_6</code> (default) or <code>MYSQL_5_5</code> disk-encryption-configuration kind=justo This is always <code>sql#diskEncryptionConfiguration</code>. kms-key-name=ea Resource name of KMS key for disk encryption ..disk-encryption-status kind=at This is always <code>sql#diskEncryptionStatus</code>. kms-key-version-name=erat KMS key version used to encrypt the Cloud SQL instance resource .. etag=clita This field is deprecated and will be removed from a future version of the API. Use the <code>settings.settingsVersion</code> field instead. failover-replica available=false The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The master can only failover to the failover replica when the status is true. name=invidunt The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID. This property is applicable only to Second Generation instances. .. gce-zone=nonumy The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. instance-type=erat The instance type. This can be one of the following. <br><code>CLOUD_SQL_INSTANCE</code>: A Cloud SQL instance that is not replicating from a master. <br><code>ON_PREMISES_INSTANCE</code>: An instance running on the customer's premises. <br><code>READ_REPLICA_INSTANCE</code>: A Cloud SQL instance configured as a read-replica. ipv6-address=erat The IPv6 address assigned to the instance. This property is applicable only to First Generation instances. kind=dolores This is always <code>sql#instance</code>. master-instance-name=ipsum The name of the instance which will act as master in the replication setup. max-disk-size=voluptua. The maximum disk size of the instance in bytes. name=eos Name of the Cloud SQL instance. This does not include the project ID. on-premises-configuration ca-certificate=duo PEM representation of the trusted CA's x509 certificate. client-certificate=elitr PEM representation of the slave's x509 certificate. client-key=consetetur PEM representation of the slave's private key. The corresponsing public key is encoded in the client's certificate. dump-file-path=et The dump file to create the Cloud SQL replica. host-port=clita The host and port of the on-premises instance in host:port format kind=sit This is always <code>sql#onPremisesConfiguration</code>. password=takimata The password for connecting to on-premises instance. username=erat The username for connecting to on-premises instance. .. project=diam The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable. region=nonumy The geographical region. Can be <code>us-central</code> (<code>FIRST_GEN</code> instances only), <code>us-central1</code> (<code>SECOND_GEN</code> instances only), <code>asia-east1</code> or <code>europe-west1</code>. Defaults to <code>us-central</code> or <code>us-central1</code> depending on the instance type (First Generation or Second Generation). The region can not be changed after instance creation. replica-configuration failover-target=false Specifies if the replica is the failover target. If the field is set to <code>true</code> the replica will be designated as a failover replica. In case the master instance fails, the replica instance will be promoted as the new master instance. <p>Only one replica can be specified as failover target, and the replica has to be in different zone with the master instance. kind=diam This is always <code>sql#replicaConfiguration</code>. mysql-replica-configuration ca-certificate=diam PEM representation of the trusted CA's x509 certificate. client-certificate=sed PEM representation of the slave's x509 certificate. client-key=et PEM representation of the slave's private key. The corresponsing public key is encoded in the client's certificate. connect-retry-interval=84 Seconds to wait between connect retries. MySQL's default is 60 seconds. dump-file-path=dolore Path to a SQL dump file in Google Cloud Storage from which the slave instance is to be created. The URI is in the form gs: //bucketName/fileName. Compressed gzip files (.gz) are also supported. // Dumps should have the binlog co-ordinates from which replication should // begin. This can be accomplished by setting --master-data to 1 when using // mysqldump. kind=ipsum This is always <code>sql#mysqlReplicaConfiguration</code>. master-heartbeat-period=ea Interval in milliseconds between replication heartbeats. password=at The password for the replication connection. ssl-cipher=sit A list of permissible ciphers to use for SSL encryption. username=sit The username for the replication connection. verify-server-certificate=false Whether or not to check the master's Common Name value in the certificate that it sends during the SSL handshake. ... replica-names=stet The replicas of the instance. Each invocation of this argument appends the given value to the array. root-password=duo Initial root password. Use only on creation. scheduled-maintenance can-defer=false No description provided. can-reschedule=false If the scheduled maintenance can be rescheduled. start-time=et The start time of any upcoming scheduled maintenance for this instance. .. self-link=lorem The URI of this resource. server-ca-cert cert=rebum. PEM representation. cert-serial-number=et Serial number, as extracted from the certificate. common-name=sed User supplied name. Constrained to [a-zA-Z.-_ ]+. create-time=stet The time when the certificate was created in <a href=\"https://tools.ietf.org/html/rfc3339\">RFC 3339</a> format, for example <code>2012-11-15T16:19:00.094Z</code> expiration-time=aliquyam The time when the certificate expires in <a href=\"https://tools.ietf.org/html/rfc3339\">RFC 3339</a> format, for example <code>2012-11-15T16:19:00.094Z</code>. instance=kasd Name of the database instance. kind=lorem This is always <code>sql#sslCert</code>. self-link=sit The URI of this resource. sha1-fingerprint=kasd Sha1 Fingerprint. .. service-account-email-address=tempor The service account email address assigned to the instance. This property is applicable only to Second Generation instances. settings activation-policy=dolor The activation policy specifies when the instance is activated; it is applicable only when the instance state is <code>RUNNABLE</code>. Valid values: <br><code>ALWAYS</code>: The instance is on, and remains so even in the absence of connection requests. <br><code>NEVER</code>: The instance is off; it is not activated, even if a connection request arrives. <br><code>ON_DEMAND</code>: First Generation instances only. The instance responds to incoming requests, and turns itself off when not in use. Instances with <code>PER_USE</code> pricing turn off after 15 minutes of inactivity. Instances with <code>PER_PACKAGE</code> pricing turn off after 12 hours of inactivity. authorized-gae-applications=amet The App Engine app IDs that can access this instance. First Generation instances only. Each invocation of this argument appends the given value to the array. availability-type=sit Availability type (PostgreSQL and MySQL instances only). Potential values: <br><code>ZONAL</code>: The instance serves data from only one zone. Outages in that zone affect data accessibility. <br><code>REGIONAL</code>: The instance can serve data from more than one zone in a region (it is highly available). <br>For more information, see <a href=\"https://cloud.google.com/sql/docs/postgres/high-availability\">Overview of the High Availability Configuration</a>. backup-configuration binary-log-enabled=true (MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well. enabled=false Whether this configuration is enabled. kind=ipsum This is always <code>sql#backupConfiguration</code>. location=et Location of the backup point-in-time-recovery-enabled=false Reserved for future use. replication-log-archiving-enabled=false Reserved for future use. start-time=dolor Start time for the daily backup configuration in UTC timezone in the 24 hour format - <code>HH:MM</code>. .. crash-safe-replication-enabled=false Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property is only applicable to First Generation instances. data-disk-size-gb=dolor The size of data disk, in GB. The data disk size minimum is 10GB. Not used for First Generation instances. data-disk-type=dolor The type of data disk: <code>PD_SSD</code> (default) or <code>PD_HDD</code>. Not used for First Generation instances. database-replication-enabled=true Configuration specific to read replica instances. Indicates whether replication is enabled or not. ip-configuration ipv4-enabled=true Whether the instance should be assigned an IP address or not. private-network=lorem The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, <code>/projects/myProject/global/networks/default</code>. This setting can be updated, but it cannot be removed after it is set. require-ssl=true Whether SSL connections over IP should be enforced or not. .. kind=diam This is always <code>sql#settings</code>. location-preference follow-gae-application=ipsum The AppEngine application to follow, it must be in the same region as the Cloud SQL instance. kind=invidunt This is always <code>sql#locationPreference</code>. zone=stet The preferred Compute Engine zone (e.g. us-central1-a, us-central1-b, etc.). ..maintenance-window day=23 day of week (1-7), starting on Monday. hour=24 hour of day - 0 to 23. kind=diam This is always <code>sql#maintenanceWindow</code>. update-track=amet Maintenance timing setting: <code>canary</code> (Earlier) or <code>stable</code> (Later). <br /><a href=\"/sql/docs/db_path/instance-settings#maintenance-timing-2ndgen\"> Learn more</a>. .. pricing-plan=at The pricing plan for this instance. This can be either <code>PER_USE</code> or <code>PACKAGE</code>. Only <code>PER_USE</code> is supported for Second Generation instances. replication-type=eirmod The type of replication this instance uses. This can be either <code>ASYNCHRONOUS</code> or <code>SYNCHRONOUS</code>. This property is only applicable to First Generation instances. settings-version=erat The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value. storage-auto-resize=false Configuration to increase storage size automatically. The default value is true. Not used for First Generation instances. storage-auto-resize-limit=sit The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit. Not used for First Generation instances. tier=accusam The tier (or machine type) for this instance, for example <code>db-n1-standard-1</code> (MySQL instances) or <code>db-custom-1-3840</code> (PostgreSQL instances). For MySQL instances, this property determines whether the instance is First or Second Generation. For more information, see <a href=\"/sql/docs/db_path/instance-settings\">Instance Settings</a>. user-labels=key=et User-provided labels, represented as a dictionary where each label is a single key value pair. the value will be associated with the given key .. state=nonumy The current serving state of the Cloud SQL instance. This can be one of the following. <br><code>RUNNABLE</code>: The instance is running, or is ready to run when accessed. <br><code>SUSPENDED</code>: The instance is not available, for example due to problems with billing. <br><code>PENDING_CREATE</code>: The instance is being created. <br><code>MAINTENANCE</code>: The instance is down for maintenance. <br><code>FAILED</code>: The instance creation failed. <br><code>UNKNOWN_STATE</code>: The state of the instance is unknown. suspension-reason=accusam If the instance state is SUSPENDED, the reason for the suspension. Each invocation of this argument appends the given value to the array.","title":"Required Request Value"},{"location":"instances_update/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"instances_update/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"instances_update/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"operations_get/","text":"Retrieves an instance operation that has been performed on an instance. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> operations get ... Required Scalar Arguments <project> (string) Project ID of the project that contains the instance. <operation> (string) Instance operation ID. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Get"},{"location":"operations_get/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> operations get ...","title":"Scopes"},{"location":"operations_get/#required-scalar-arguments","text":"<project> (string) Project ID of the project that contains the instance. <operation> (string) Instance operation ID.","title":"Required Scalar Arguments"},{"location":"operations_get/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"operations_get/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"operations_list/","text":"Lists all instance operations that have been performed on the given Cloud SQL instance in the reverse chronological order of the start time. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> operations list ... Required Scalar Argument <project> (string) Project ID of the project that contains the instance. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional Method Properties You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p instance=string Cloud SQL instance ID. This does not include the project ID. -p max-results=integer Maximum number of operations per response. -p page-token=string A previously-returned page token representing part of the larger set of results to view. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"List"},{"location":"operations_list/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> operations list ...","title":"Scopes"},{"location":"operations_list/#required-scalar-argument","text":"<project> (string) Project ID of the project that contains the instance.","title":"Required Scalar Argument"},{"location":"operations_list/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"operations_list/#optional-method-properties","text":"You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p instance=string Cloud SQL instance ID. This does not include the project ID. -p max-results=integer Maximum number of operations per response. -p page-token=string A previously-returned page token representing part of the larger set of results to view.","title":"Optional Method Properties"},{"location":"operations_list/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-reschedule-maintenance/","text":"Reschedules the maintenance on the given instance. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> projects instances-reschedule-maintenance ... Required Scalar Arguments <project> (string) ID of the project that contains the instance. <instance> (string) Cloud SQL instance ID. This does not include the project ID. Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: SqlInstancesRescheduleMaintenanceRequestBody: reschedule: reschedule-type: string schedule-time: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .reschedule reschedule-type=ut Required. The type of the reschedule. schedule-time=voluptua. Optional. Timestamp when the maintenance shall be rescheduled to if reschedule_type=SPECIFIC_TIME, in <a href=\"https://tools.ietf.org/html/rfc3339\">RFC 3339</a> format, for example <code>2012-11-15T16:19:00.094Z</code>. About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances Reschedule Maintenance"},{"location":"projects_instances-reschedule-maintenance/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> projects instances-reschedule-maintenance ...","title":"Scopes"},{"location":"projects_instances-reschedule-maintenance/#required-scalar-arguments","text":"<project> (string) ID of the project that contains the instance. <instance> (string) Cloud SQL instance ID. This does not include the project ID.","title":"Required Scalar Arguments"},{"location":"projects_instances-reschedule-maintenance/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: SqlInstancesRescheduleMaintenanceRequestBody: reschedule: reschedule-type: string schedule-time: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .reschedule reschedule-type=ut Required. The type of the reschedule. schedule-time=voluptua. Optional. Timestamp when the maintenance shall be rescheduled to if reschedule_type=SPECIFIC_TIME, in <a href=\"https://tools.ietf.org/html/rfc3339\">RFC 3339</a> format, for example <code>2012-11-15T16:19:00.094Z</code>.","title":"Required Request Value"},{"location":"projects_instances-reschedule-maintenance/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"projects_instances-reschedule-maintenance/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-reschedule-maintenance/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-start-external-sync/","text":"Start External master migration. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> projects instances-start-external-sync ... Required Scalar Arguments <project> (string) ID of the project that contains the first generation instance. <instance> (string) Cloud SQL instance ID. This does not include the project ID. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional Method Properties You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p sync-mode=string External sync mode Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances Start External Sync"},{"location":"projects_instances-start-external-sync/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> projects instances-start-external-sync ...","title":"Scopes"},{"location":"projects_instances-start-external-sync/#required-scalar-arguments","text":"<project> (string) ID of the project that contains the first generation instance. <instance> (string) Cloud SQL instance ID. This does not include the project ID.","title":"Required Scalar Arguments"},{"location":"projects_instances-start-external-sync/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-start-external-sync/#optional-method-properties","text":"You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p sync-mode=string External sync mode","title":"Optional Method Properties"},{"location":"projects_instances-start-external-sync/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-verify-external-sync-settings/","text":"Verify External master external sync settings. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> projects instances-verify-external-sync-settings ... Required Scalar Arguments <project> (string) Project ID of the project that contains the instance. <instance> (string) Cloud SQL instance ID. This does not include the project ID. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional Method Properties You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p sync-mode=string External sync mode -p verify-connection-only=boolean Flag to enable verifying connection only Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances Verify External Sync Settings"},{"location":"projects_instances-verify-external-sync-settings/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> projects instances-verify-external-sync-settings ...","title":"Scopes"},{"location":"projects_instances-verify-external-sync-settings/#required-scalar-arguments","text":"<project> (string) Project ID of the project that contains the instance. <instance> (string) Cloud SQL instance ID. This does not include the project ID.","title":"Required Scalar Arguments"},{"location":"projects_instances-verify-external-sync-settings/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-verify-external-sync-settings/#optional-method-properties","text":"You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p sync-mode=string External sync mode -p verify-connection-only=boolean Flag to enable verifying connection only","title":"Optional Method Properties"},{"location":"projects_instances-verify-external-sync-settings/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"ssl-certs_create-ephemeral/","text":"Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> ssl-certs create-ephemeral ... Required Scalar Arguments <project> (string) Project ID of the Cloud SQL project. <instance> (string) Cloud SQL instance ID. This does not include the project ID. Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: SslCertsCreateEphemeralRequest: public-key: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . public-key=consetetur PEM encoded public key to include in the signed certificate. About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Create Ephemeral"},{"location":"ssl-certs_create-ephemeral/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> ssl-certs create-ephemeral ...","title":"Scopes"},{"location":"ssl-certs_create-ephemeral/#required-scalar-arguments","text":"<project> (string) Project ID of the Cloud SQL project. <instance> (string) Cloud SQL instance ID. This does not include the project ID.","title":"Required Scalar Arguments"},{"location":"ssl-certs_create-ephemeral/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: SslCertsCreateEphemeralRequest: public-key: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . public-key=consetetur PEM encoded public key to include in the signed certificate.","title":"Required Request Value"},{"location":"ssl-certs_create-ephemeral/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"ssl-certs_create-ephemeral/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"ssl-certs_create-ephemeral/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"ssl-certs_delete/","text":"Deletes the SSL certificate. For First Generation instances, the certificate remains valid until the instance is restarted. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> ssl-certs delete ... Required Scalar Arguments <project> (string) Project ID of the project that contains the instance. <instance> (string) Cloud SQL instance ID. This does not include the project ID. <sha1-fingerprint> (string) Sha1 FingerPrint. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Delete"},{"location":"ssl-certs_delete/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> ssl-certs delete ...","title":"Scopes"},{"location":"ssl-certs_delete/#required-scalar-arguments","text":"<project> (string) Project ID of the project that contains the instance. <instance> (string) Cloud SQL instance ID. This does not include the project ID. <sha1-fingerprint> (string) Sha1 FingerPrint.","title":"Required Scalar Arguments"},{"location":"ssl-certs_delete/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"ssl-certs_delete/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"ssl-certs_get/","text":"Retrieves a particular SSL certificate. Does not include the private key (required for usage). The private key must be saved from the response to initial creation. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> ssl-certs get ... Required Scalar Arguments <project> (string) Project ID of the project that contains the instance. <instance> (string) Cloud SQL instance ID. This does not include the project ID. <sha1-fingerprint> (string) Sha1 FingerPrint. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Get"},{"location":"ssl-certs_get/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> ssl-certs get ...","title":"Scopes"},{"location":"ssl-certs_get/#required-scalar-arguments","text":"<project> (string) Project ID of the project that contains the instance. <instance> (string) Cloud SQL instance ID. This does not include the project ID. <sha1-fingerprint> (string) Sha1 FingerPrint.","title":"Required Scalar Arguments"},{"location":"ssl-certs_get/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"ssl-certs_get/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"ssl-certs_insert/","text":"Creates an SSL certificate and returns it along with the private key and server certificate authority. The new certificate will not be usable until the instance is restarted. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> ssl-certs insert ... Required Scalar Arguments <project> (string) Project ID of the project that contains the instance. <instance> (string) Cloud SQL instance ID. This does not include the project ID. Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: SslCertsInsertRequest: common-name: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . common-name=dolor User supplied name. Must be a distinct name from the other certificates for this instance. About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Insert"},{"location":"ssl-certs_insert/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> ssl-certs insert ...","title":"Scopes"},{"location":"ssl-certs_insert/#required-scalar-arguments","text":"<project> (string) Project ID of the project that contains the instance. <instance> (string) Cloud SQL instance ID. This does not include the project ID.","title":"Required Scalar Arguments"},{"location":"ssl-certs_insert/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: SslCertsInsertRequest: common-name: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . common-name=dolor User supplied name. Must be a distinct name from the other certificates for this instance.","title":"Required Request Value"},{"location":"ssl-certs_insert/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"ssl-certs_insert/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"ssl-certs_insert/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"ssl-certs_list/","text":"Lists all of the current SSL certificates for the instance. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> ssl-certs list ... Required Scalar Arguments <project> (string) Project ID of the project that contains the instance. <instance> (string) Cloud SQL instance ID. This does not include the project ID. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"List"},{"location":"ssl-certs_list/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> ssl-certs list ...","title":"Scopes"},{"location":"ssl-certs_list/#required-scalar-arguments","text":"<project> (string) Project ID of the project that contains the instance. <instance> (string) Cloud SQL instance ID. This does not include the project ID.","title":"Required Scalar Arguments"},{"location":"ssl-certs_list/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"ssl-certs_list/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"tiers_list/","text":"Lists all available machine types (tiers) for Cloud SQL, for example, db-n1-standard-1. For related information, see <a href=\"/sql/pricing\">Pricing</a>. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> tiers list ... Required Scalar Argument <project> (string) Project ID of the project for which to list tiers. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"List"},{"location":"tiers_list/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> tiers list ...","title":"Scopes"},{"location":"tiers_list/#required-scalar-argument","text":"<project> (string) Project ID of the project for which to list tiers.","title":"Required Scalar Argument"},{"location":"tiers_list/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"tiers_list/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"users_delete/","text":"Deletes a user from a Cloud SQL instance. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> users delete ... Required Scalar Arguments <project> (string) Project ID of the project that contains the instance. <instance> (string) Database instance ID. This does not include the project ID. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional Method Properties You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p host=string Host of the user in the instance. -p name=string Name of the user in the instance. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Delete"},{"location":"users_delete/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> users delete ...","title":"Scopes"},{"location":"users_delete/#required-scalar-arguments","text":"<project> (string) Project ID of the project that contains the instance. <instance> (string) Database instance ID. This does not include the project ID.","title":"Required Scalar Arguments"},{"location":"users_delete/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"users_delete/#optional-method-properties","text":"You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p host=string Host of the user in the instance. -p name=string Name of the user in the instance.","title":"Optional Method Properties"},{"location":"users_delete/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"users_insert/","text":"Creates a new user in a Cloud SQL instance. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> users insert ... Required Scalar Arguments <project> (string) Project ID of the project that contains the instance. <instance> (string) Database instance ID. This does not include the project ID. Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: User: etag: string host: string instance: string kind: string name: string password: string project: string sqlserver-user-details: disabled: boolean server-roles: [string] can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . etag=amet This field is deprecated and will be removed from a future version of the API. host=et The host name from which the user can connect. For <code>insert</code> operations, host defaults to an empty string. For <code>update</code> operations, host is specified as part of the request URL. The host name cannot be updated after insertion. instance=aliquyam The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for <code>update</code> since it is already specified on the URL. kind=ipsum This is always <code>sql#user</code>. name=gubergren The name of the user in the Cloud SQL instance. Can be omitted for <code>update</code> since it is already specified in the URL. password=invidunt The password for the user. project=sea The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for <code>update</code> since it is already specified on the URL. sqlserver-user-details disabled=true If the user has been disabled server-roles=stet The server roles for this user Each invocation of this argument appends the given value to the array. About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Insert"},{"location":"users_insert/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> users insert ...","title":"Scopes"},{"location":"users_insert/#required-scalar-arguments","text":"<project> (string) Project ID of the project that contains the instance. <instance> (string) Database instance ID. This does not include the project ID.","title":"Required Scalar Arguments"},{"location":"users_insert/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: User: etag: string host: string instance: string kind: string name: string password: string project: string sqlserver-user-details: disabled: boolean server-roles: [string] can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . etag=amet This field is deprecated and will be removed from a future version of the API. host=et The host name from which the user can connect. For <code>insert</code> operations, host defaults to an empty string. For <code>update</code> operations, host is specified as part of the request URL. The host name cannot be updated after insertion. instance=aliquyam The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for <code>update</code> since it is already specified on the URL. kind=ipsum This is always <code>sql#user</code>. name=gubergren The name of the user in the Cloud SQL instance. Can be omitted for <code>update</code> since it is already specified in the URL. password=invidunt The password for the user. project=sea The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for <code>update</code> since it is already specified on the URL. sqlserver-user-details disabled=true If the user has been disabled server-roles=stet The server roles for this user Each invocation of this argument appends the given value to the array.","title":"Required Request Value"},{"location":"users_insert/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"users_insert/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"users_insert/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"users_list/","text":"Lists users in the specified Cloud SQL instance. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> users list ... Required Scalar Arguments <project> (string) Project ID of the project that contains the instance. <instance> (string) Database instance ID. This does not include the project ID. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"List"},{"location":"users_list/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> users list ...","title":"Scopes"},{"location":"users_list/#required-scalar-arguments","text":"<project> (string) Project ID of the project that contains the instance. <instance> (string) Database instance ID. This does not include the project ID.","title":"Required Scalar Arguments"},{"location":"users_list/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"users_list/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"users_update/","text":"Updates an existing user in a Cloud SQL instance. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> users update ... Required Scalar Arguments <project> (string) Project ID of the project that contains the instance. <instance> (string) Database instance ID. This does not include the project ID. Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: User: etag: string host: string instance: string kind: string name: string password: string project: string sqlserver-user-details: disabled: boolean server-roles: [string] can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . etag=sadipscing This field is deprecated and will be removed from a future version of the API. host=no The host name from which the user can connect. For <code>insert</code> operations, host defaults to an empty string. For <code>update</code> operations, host is specified as part of the request URL. The host name cannot be updated after insertion. instance=tempor The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for <code>update</code> since it is already specified on the URL. kind=ipsum This is always <code>sql#user</code>. name=sea The name of the user in the Cloud SQL instance. Can be omitted for <code>update</code> since it is already specified in the URL. password=sit The password for the user. project=amet. The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for <code>update</code> since it is already specified on the URL. sqlserver-user-details disabled=true If the user has been disabled server-roles=at The server roles for this user Each invocation of this argument appends the given value to the array. About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional Method Properties You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p host=string Optional. Host of the user in the instance. -p name=string Name of the user in the instance. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Update"},{"location":"users_update/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform . You can set the scope for this method like this: sql1-beta4 --scope <scope> users update ...","title":"Scopes"},{"location":"users_update/#required-scalar-arguments","text":"<project> (string) Project ID of the project that contains the instance. <instance> (string) Database instance ID. This does not include the project ID.","title":"Required Scalar Arguments"},{"location":"users_update/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: User: etag: string host: string instance: string kind: string name: string password: string project: string sqlserver-user-details: disabled: boolean server-roles: [string] can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . etag=sadipscing This field is deprecated and will be removed from a future version of the API. host=no The host name from which the user can connect. For <code>insert</code> operations, host defaults to an empty string. For <code>update</code> operations, host is specified as part of the request URL. The host name cannot be updated after insertion. instance=tempor The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for <code>update</code> since it is already specified on the URL. kind=ipsum This is always <code>sql#user</code>. name=sea The name of the user in the Cloud SQL instance. Can be omitted for <code>update</code> since it is already specified in the URL. password=sit The password for the user. project=amet. The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for <code>update</code> since it is already specified on the URL. sqlserver-user-details disabled=true If the user has been disabled server-roles=at The server roles for this user Each invocation of this argument appends the given value to the array.","title":"Required Request Value"},{"location":"users_update/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"users_update/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"users_update/#optional-method-properties","text":"You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p host=string Optional. Host of the user in the instance. -p name=string Name of the user in the instance.","title":"Optional Method Properties"},{"location":"users_update/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"}]}