Google Git
Sign in
chromium/external/github.com/google/google-api-python-client/refs/heads/add-constraints-file/./googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json
blob: f13aaadccb5f84e1a163db277300c8e018785759 [file] [edit]
{
"description": "API for Cloud SQL database instance management",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"rootUrl": "https://sqladmin.googleapis.com/",
"id": "sqladmin:v1beta4",
"baseUrl": "https://sqladmin.googleapis.com/",
"batchPath": "batch",
"parameters": {
"prettyPrint": {
"default": "true",
"type": "boolean",
"description": "Returns response with indentations and line breaks.",
"location": "query"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
},
"access_token": {
"location": "query",
"description": "OAuth access token.",
"type": "string"
},
"uploadType": {
"location": "query",
"type": "string",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
"location": "query"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"type": "string",
"description": "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.",
"location": "query"
},
"alt": {
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"default": "json",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"type": "string",
"location": "query"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"quotaUser": {
"location": "query",
"type": "string",
"description": "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."
},
"$.xgafv": {
"description": "V1 error format.",
"type": "string",
"location": "query",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
]
}
},
"ownerName": "Google",
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
},
"https://www.googleapis.com/auth/sqlservice.admin": {
"description": "Manage your Google SQL Service instances"
}
}
}
},
"ownerDomain": "google.com",
"protocol": "rest",
"revision": "20201022",
"resources": {
"operations": {
"methods": {
"list": {
"flatPath": "sql/v1beta4/projects/{project}/operations",
"path": "sql/v1beta4/projects/{project}/operations",
"id": "sql.operations.list",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
],
"response": {
"$ref": "OperationsListResponse"
},
"description": "Lists all instance operations that have been performed on the given Cloud SQL instance in the reverse chronological order of the start time.",
"parameterOrder": [
"project"
],
"httpMethod": "GET",
"parameters": {
"pageToken": {
"type": "string",
"description": "A previously-returned page token representing part of the larger set of results to view.",
"location": "query"
},
"instance": {
"type": "string",
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "query"
},
"maxResults": {
"location": "query",
"format": "uint32",
"description": "Maximum number of operations per response.",
"type": "integer"
},
"project": {
"location": "path",
"type": "string",
"required": true,
"description": "Project ID of the project that contains the instance."
}
}
},
"get": {
"id": "sql.operations.get",
"parameters": {
"operation": {
"location": "path",
"description": "Instance operation ID.",
"type": "string",
"required": true
},
"project": {
"type": "string",
"required": true,
"description": "Project ID of the project that contains the instance.",
"location": "path"
}
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
],
"description": "Retrieves an instance operation that has been performed on an instance.",
"httpMethod": "GET",
"path": "sql/v1beta4/projects/{project}/operations/{operation}",
"parameterOrder": [
"project",
"operation"
],
"flatPath": "sql/v1beta4/projects/{project}/operations/{operation}"
}
}
},
"flags": {
"methods": {
"list": {
"httpMethod": "GET",
"parameterOrder": [],
"path": "sql/v1beta4/flags",
"id": "sql.flags.list",
"description": "List all available database flags for Cloud SQL instances.",
"flatPath": "sql/v1beta4/flags",
"parameters": {
"databaseVersion": {
"location": "query",
"description": "Database type and version you want to retrieve flags for. By default, this method returns flags for all database types and versions.",
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
],
"response": {
"$ref": "FlagsListResponse"
}
}
}
},
"tiers": {
"methods": {
"list": {
"description": "Lists all available machine types (tiers) for Cloud SQL, for example, db-n1-standard-1. For related information, see Pricing.",
"id": "sql.tiers.list",
"flatPath": "sql/v1beta4/projects/{project}/tiers",
"parameterOrder": [
"project"
],
"parameters": {
"project": {
"description": "Project ID of the project for which to list tiers.",
"type": "string",
"location": "path",
"required": true
}
},
"response": {
"$ref": "TiersListResponse"
},
"path": "sql/v1beta4/projects/{project}/tiers",
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
}
}
},
"sslCerts": {
"methods": {
"get": {
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/sslCerts/{sha1Fingerprint}",
"response": {
"$ref": "SslCert"
},
"parameterOrder": [
"project",
"instance",
"sha1Fingerprint"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
],
"parameters": {
"project": {
"description": "Project ID of the project that contains the instance.",
"type": "string",
"location": "path",
"required": true
},
"instance": {
"type": "string",
"location": "path",
"description": "Cloud SQL instance ID. This does not include the project ID.",
"required": true
},
"sha1Fingerprint": {
"location": "path",
"required": true,
"description": "Sha1 FingerPrint.",
"type": "string"
}
},
"httpMethod": "GET",
"path": "sql/v1beta4/projects/{project}/instances/{instance}/sslCerts/{sha1Fingerprint}",
"id": "sql.sslCerts.get",
"description": "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."
},
"list": {
"response": {
"$ref": "SslCertsListResponse"
},
"description": "Lists all of the current SSL certificates for the instance.",
"id": "sql.sslCerts.list",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/sslCerts",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
],
"httpMethod": "GET",
"path": "sql/v1beta4/projects/{project}/instances/{instance}/sslCerts",
"parameters": {
"instance": {
"location": "path",
"required": true,
"type": "string",
"description": "Cloud SQL instance ID. This does not include the project ID."
},
"project": {
"description": "Project ID of the project that contains the instance.",
"type": "string",
"required": true,
"location": "path"
}
},
"parameterOrder": [
"project",
"instance"
]
},
"createEphemeral": {
"parameterOrder": [
"project",
"instance"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
],
"parameters": {
"project": {
"type": "string",
"required": true,
"description": "Project ID of the Cloud SQL project.",
"location": "path"
},
"instance": {
"location": "path",
"required": true,
"description": "Cloud SQL instance ID. This does not include the project ID.",
"type": "string"
}
},
"request": {
"$ref": "SslCertsCreateEphemeralRequest"
},
"httpMethod": "POST",
"response": {
"$ref": "SslCert"
},
"id": "sql.sslCerts.createEphemeral",
"path": "sql/v1beta4/projects/{project}/instances/{instance}/createEphemeral",
"description": "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.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/createEphemeral"
},
"delete": {
"parameters": {
"project": {
"location": "path",
"type": "string",
"description": "Project ID of the project that contains the instance.",
"required": true
},
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"sha1Fingerprint": {
"location": "path",
"required": true,
"description": "Sha1 FingerPrint.",
"type": "string"
}
},
"description": "Deletes the SSL certificate. For First Generation instances, the certificate remains valid until the instance is restarted.",
"httpMethod": "DELETE",
"id": "sql.sslCerts.delete",
"response": {
"$ref": "Operation"
},
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/sslCerts/{sha1Fingerprint}",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
],
"parameterOrder": [
"project",
"instance",
"sha1Fingerprint"
],
"path": "sql/v1beta4/projects/{project}/instances/{instance}/sslCerts/{sha1Fingerprint}"
},
"insert": {
"httpMethod": "POST",
"description": "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.",
"response": {
"$ref": "SslCertsInsertResponse"
},
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/sslCerts",
"path": "sql/v1beta4/projects/{project}/instances/{instance}/sslCerts",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
],
"parameters": {
"project": {
"location": "path",
"description": "Project ID of the project that contains the instance.",
"type": "string",
"required": true
},
"instance": {
"location": "path",
"description": "Cloud SQL instance ID. This does not include the project ID.",
"type": "string",
"required": true
}
},
"parameterOrder": [
"project",
"instance"
],
"id": "sql.sslCerts.insert",
"request": {
"$ref": "SslCertsInsertRequest"
}
}
}
},
"databases": {
"methods": {
"patch": {
"description": "Partially updates a resource containing information about a database inside a Cloud SQL instance. This method supports patch semantics.",
"parameters": {
"project": {
"required": true,
"location": "path",
"description": "Project ID of the project that contains the instance.",
"type": "string"
},
"database": {
"location": "path",
"description": "Name of the database to be updated in the instance.",
"type": "string",
"required": true
},
"instance": {
"type": "string",
"description": "Database instance ID. This does not include the project ID.",
"required": true,
"location": "path"
}
},
"httpMethod": "PATCH",
"request": {
"$ref": "Database"
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/databases/{database}",
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"project",
"instance",
"database"
],
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/databases/{database}",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
],
"id": "sql.databases.patch"
},
"update": {
"description": "Updates a resource containing information about a database inside a Cloud SQL instance.",
"httpMethod": "PUT",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
],
"id": "sql.databases.update",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/databases/{database}",
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"project",
"instance",
"database"
],
"parameters": {
"instance": {
"location": "path",
"type": "string",
"required": true,
"description": "Database instance ID. This does not include the project ID."
},
"database": {
"location": "path",
"description": "Name of the database to be updated in the instance.",
"type": "string",
"required": true
},
"project": {
"location": "path",
"description": "Project ID of the project that contains the instance.",
"type": "string",
"required": true
}
},
"request": {
"$ref": "Database"
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/databases/{database}"
},
"insert": {
"httpMethod": "POST",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/databases",
"parameterOrder": [
"project",
"instance"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
],
"id": "sql.databases.insert",
"description": "Inserts a resource containing information about a database inside a Cloud SQL instance.",
"path": "sql/v1beta4/projects/{project}/instances/{instance}/databases",
"response": {
"$ref": "Operation"
},
"parameters": {
"project": {
"location": "path",
"required": true,
"type": "string",
"description": "Project ID of the project that contains the instance."
},
"instance": {
"required": true,
"type": "string",
"description": "Database instance ID. This does not include the project ID.",
"location": "path"
}
},
"request": {
"$ref": "Database"
}
},
"list": {
"path": "sql/v1beta4/projects/{project}/instances/{instance}/databases",
"parameterOrder": [
"project",
"instance"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
],
"httpMethod": "GET",
"id": "sql.databases.list",
"parameters": {
"instance": {
"type": "string",
"location": "path",
"required": true,
"description": "Cloud SQL instance ID. This does not include the project ID."
},
"project": {
"location": "path",
"type": "string",
"description": "Project ID of the project that contains the instance.",
"required": true
}
},
"description": "Lists databases in the specified Cloud SQL instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/databases",
"response": {
"$ref": "DatabasesListResponse"
}
},
"delete": {
"httpMethod": "DELETE",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/databases/{database}",
"description": "Deletes a database from a Cloud SQL instance.",
"parameterOrder": [
"project",
"instance",
"database"
],
"parameters": {
"project": {
"required": true,
"location": "path",
"description": "Project ID of the project that contains the instance.",
"type": "string"
},
"database": {
"description": "Name of the database to be deleted in the instance.",
"required": true,
"location": "path",
"type": "string"
},
"instance": {
"type": "string",
"required": true,
"description": "Database instance ID. This does not include the project ID.",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
],
"id": "sql.databases.delete",
"path": "sql/v1beta4/projects/{project}/instances/{instance}/databases/{database}",
"response": {
"$ref": "Operation"
}
},
"get": {
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
],
"parameters": {
"instance": {
"required": true,
"location": "path",
"description": "Database instance ID. This does not include the project ID.",
"type": "string"
},
"project": {
"location": "path",
"required": true,
"description": "Project ID of the project that contains the instance.",
"type": "string"
},
"database": {
"type": "string",
"required": true,
"description": "Name of the database in the instance.",
"location": "path"
}
},
"id": "sql.databases.get",
"response": {
"$ref": "Database"
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/databases/{database}",
"description": "Retrieves a resource containing information about a database inside a Cloud SQL instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/databases/{database}",
"parameterOrder": [
"project",
"instance",
"database"
]
}
}
},
"projects": {
"resources": {
"instances": {
"methods": {
"startExternalSync": {
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/startExternalSync",
"parameterOrder": [
"project",
"instance"
],
"id": "sql.projects.instances.startExternalSync",
"httpMethod": "POST",
"description": "Start External primary instance migration.",
"response": {
"$ref": "Operation"
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/startExternalSync",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
],
"parameters": {
"project": {
"description": "ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
},
"syncMode": {
"enumDescriptions": [
"Unknown external sync mode, will be defaulted to ONLINE mode",
"Online external sync will set up replication after initial data external sync",
"Offline external sync only dumps and loads a one-time snapshot of the primary instance's data"
],
"enum": [
"EXTERNAL_SYNC_MODE_UNSPECIFIED",
"ONLINE",
"OFFLINE"
],
"location": "query",
"description": "External sync mode",
"type": "string"
},
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"type": "string",
"location": "path",
"required": true
}
}
},
"verifyExternalSyncSettings": {
"parameters": {
"syncMode": {
"type": "string",
"location": "query",
"enum": [
"EXTERNAL_SYNC_MODE_UNSPECIFIED",
"ONLINE",
"OFFLINE"
],
"enumDescriptions": [
"Unknown external sync mode, will be defaulted to ONLINE mode",
"Online external sync will set up replication after initial data external sync",
"Offline external sync only dumps and loads a one-time snapshot of the primary instance's data"
],
"description": "External sync mode"
},
"project": {
"location": "path",
"description": "Project ID of the project that contains the instance.",
"required": true,
"type": "string"
},
"verifyConnectionOnly": {
"description": "Flag to enable verifying connection only",
"location": "query",
"type": "boolean"
},
"instance": {
"type": "string",
"required": true,
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path"
}
},
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/verifyExternalSyncSettings",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
],
"httpMethod": "POST",
"description": "Verify External primary instance external sync settings.",
"parameterOrder": [
"project",
"instance"
],
"path": "sql/v1beta4/projects/{project}/instances/{instance}/verifyExternalSyncSettings",
"id": "sql.projects.instances.verifyExternalSyncSettings",
"response": {
"$ref": "SqlInstancesVerifyExternalSyncSettingsResponse"
}
},
"rescheduleMaintenance": {
"response": {
"$ref": "Operation"
},
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/rescheduleMaintenance",
"parameterOrder": [
"project",
"instance"
],
"id": "sql.projects.instances.rescheduleMaintenance",
"parameters": {
"instance": {
"location": "path",
"required": true,
"description": "Cloud SQL instance ID. This does not include the project ID.",
"type": "string"
},
"project": {
"description": "ID of the project that contains the instance.",
"type": "string",
"location": "path",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
],
"path": "sql/v1beta4/projects/{project}/instances/{instance}/rescheduleMaintenance",
"description": "Reschedules the maintenance on the given instance.",
"request": {
"$ref": "SqlInstancesRescheduleMaintenanceRequestBody"
},
"httpMethod": "POST"
}
}
}
}
},
"backupRuns": {
"methods": {
"list": {
"httpMethod": "GET",
"path": "sql/v1beta4/projects/{project}/instances/{instance}/backupRuns",
"response": {
"$ref": "BackupRunsListResponse"
},
"description": "Lists all backup runs associated with a given instance and configuration in the reverse chronological order of the backup initiation time.",
"parameterOrder": [
"project",
"instance"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
],
"id": "sql.backupRuns.list",
"parameters": {
"pageToken": {
"type": "string",
"description": "A previously-returned page token representing part of the larger set of results to view.",
"location": "query"
},
"instance": {
"type": "string",
"required": true,
"location": "path",
"description": "Cloud SQL instance ID. This does not include the project ID."
},
"project": {
"type": "string",
"required": true,
"location": "path",
"description": "Project ID of the project that contains the instance."
},
"maxResults": {
"format": "int32",
"location": "query",
"description": "Maximum number of backup runs per response.",
"type": "integer"
}
},
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/backupRuns"
},
"insert": {
"parameterOrder": [
"project",
"instance"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
],
"description": "Creates a new backup run on demand. This method is applicable only to Second Generation instances.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/backupRuns",
"parameters": {
"project": {
"location": "path",
"type": "string",
"required": true,
"description": "Project ID of the project that contains the instance."
},
"instance": {
"required": true,
"type": "string",
"location": "path",
"description": "Cloud SQL instance ID. This does not include the project ID."
}
},
"httpMethod": "POST",
"response": {
"$ref": "Operation"
},
"id": "sql.backupRuns.insert",
"request": {
"$ref": "BackupRun"
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/backupRuns"
},
"get": {
"path": "sql/v1beta4/projects/{project}/instances/{instance}/backupRuns/{id}",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
],
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/backupRuns/{id}",
"parameters": {
"instance": {
"type": "string",
"location": "path",
"description": "Cloud SQL instance ID. This does not include the project ID.",
"required": true
},
"id": {
"required": true,
"location": "path",
"type": "string",
"format": "int64",
"description": "The ID of this Backup Run."
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"type": "string",
"required": true
}
},
"response": {
"$ref": "BackupRun"
},
"httpMethod": "GET",
"description": "Retrieves a resource containing information about a backup run.",
"id": "sql.backupRuns.get",
"parameterOrder": [
"project",
"instance",
"id"
]
},
"delete": {
"httpMethod": "DELETE",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/backupRuns/{id}",
"id": "sql.backupRuns.delete",
"path": "sql/v1beta4/projects/{project}/instances/{instance}/backupRuns/{id}",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
],
"response": {
"$ref": "Operation"
},
"parameters": {
"instance": {
"location": "path",
"description": "Cloud SQL instance ID. This does not include the project ID.",
"type": "string",
"required": true
},
"id": {
"description": "The ID of the Backup Run to delete. To find a Backup Run ID, use the list method.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"location": "path",
"description": "Project ID of the project that contains the instance.",
"type": "string",
"required": true
}
},
"parameterOrder": [
"project",
"instance",
"id"
],
"description": "Deletes the backup taken by a backup run."
}
}
},
"users": {
"methods": {
"list": {
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/users",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
],
"httpMethod": "GET",
"response": {
"$ref": "UsersListResponse"
},
"description": "Lists users in the specified Cloud SQL instance.",
"parameters": {
"instance": {
"description": "Database instance ID. This does not include the project ID.",
"type": "string",
"required": true,
"location": "path"
},
"project": {
"location": "path",
"type": "string",
"description": "Project ID of the project that contains the instance.",
"required": true
}
},
"parameterOrder": [
"project",
"instance"
],
"path": "sql/v1beta4/projects/{project}/instances/{instance}/users",
"id": "sql.users.list"
},
"update": {
"path": "sql/v1beta4/projects/{project}/instances/{instance}/users",
"httpMethod": "PUT",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/users",
"parameters": {
"project": {
"description": "Project ID of the project that contains the instance.",
"type": "string",
"location": "path",
"required": true
},
"instance": {
"location": "path",
"description": "Database instance ID. This does not include the project ID.",
"required": true,
"type": "string"
},
"name": {
"location": "query",
"description": "Name of the user in the instance.",
"type": "string"
},
"host": {
"location": "query",
"type": "string",
"description": "Optional. Host of the user in the instance."
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
],
"description": "Updates an existing user in a Cloud SQL instance.",
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"project",
"instance"
],
"id": "sql.users.update",
"request": {
"$ref": "User"
}
},
"delete": {
"path": "sql/v1beta4/projects/{project}/instances/{instance}/users",
"response": {
"$ref": "Operation"
},
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/users",
"httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
],
"parameters": {
"host": {
"type": "string",
"description": "Host of the user in the instance.",
"location": "query"
},
"name": {
"location": "query",
"description": "Name of the user in the instance.",
"type": "string"
},
"project": {
"location": "path",
"type": "string",
"description": "Project ID of the project that contains the instance.",
"required": true
},
"instance": {
"description": "Database instance ID. This does not include the project ID.",
"type": "string",
"required": true,
"location": "path"
}
},
"description": "Deletes a user from a Cloud SQL instance.",
"id": "sql.users.delete",
"parameterOrder": [
"project",
"instance"
]
},
"insert": {
"request": {
"$ref": "User"
},
"response": {
"$ref": "Operation"
},
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/users",
"description": "Creates a new user in a Cloud SQL instance.",
"parameters": {
"project": {
"type": "string",
"required": true,
"description": "Project ID of the project that contains the instance.",
"location": "path"
},
"instance": {
"location": "path",
"description": "Database instance ID. This does not include the project ID.",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
],
"parameterOrder": [
"project",
"instance"
],
"id": "sql.users.insert",
"path": "sql/v1beta4/projects/{project}/instances/{instance}/users",
"httpMethod": "POST"
}
}
},
"instances": {
"methods": {
"demoteMaster": {
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/demoteMaster",
"path": "sql/v1beta4/projects/{project}/instances/{instance}/demoteMaster",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
],
"parameters": {
"project": {
"required": true,
"location": "path",
"description": "ID of the project that contains the instance.",
"type": "string"
},
"instance": {
"location": "path",
"required": true,
"type": "string",
"description": "Cloud SQL instance name."
}
},
"id": "sql.instances.demoteMaster",
"parameterOrder": [
"project",
"instance"
],
"description": "Demotes the stand-alone instance to be a Cloud SQL read replica for an external database server.",
"response": {
"$ref": "Operation"
},
"httpMethod": "POST",
"request": {
"$ref": "InstancesDemoteMasterRequest"
}
},
"list": {
"id": "sql.instances.list",
"parameterOrder": [
"project"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
],
"parameters": {
"project": {
"required": true,
"location": "path",
"type": "string",
"description": "Project ID of the project for which to list Cloud SQL instances."
},
"filter": {
"location": "query",
"description": "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.",
"type": "string"
},
"maxResults": {
"format": "uint32",
"location": "query",
"description": "The maximum number of results to return per response.",
"type": "integer"
},
"pageToken": {
"location": "query",
"type": "string",
"description": "A previously-returned page token representing part of the larger set of results to view."
}
},
"response": {
"$ref": "InstancesListResponse"
},
"httpMethod": "GET",
"flatPath": "sql/v1beta4/projects/{project}/instances",
"description": "Lists instances under a given project.",
"path": "sql/v1beta4/projects/{project}/instances"
},
"clone": {
"description": "Creates a Cloud SQL instance as a clone of the source instance. Using this operation might cause your instance to restart.",
"parameters": {
"project": {
"location": "path",
"type": "string",
"description": "Project ID of the source as well as the clone Cloud SQL instance.",
"required": true
},
"instance": {
"required": true,
"location": "path",
"type": "string",
"description": "The ID of the Cloud SQL instance to be cloned (source). This does not include the project ID."
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
],
"parameterOrder": [
"project",
"instance"
],
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/clone",
"path": "sql/v1beta4/projects/{project}/instances/{instance}/clone",
"id": "sql.instances.clone",
"response": {
"$ref": "Operation"
},
"request": {
"$ref": "InstancesCloneRequest"
},
"httpMethod": "POST"
},
"export": {
"request": {
"$ref": "InstancesExportRequest"
},
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/export",
"httpMethod": "POST",
"path": "sql/v1beta4/projects/{project}/instances/{instance}/export",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"description": "Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL dump or CSV file.",
"id": "sql.instances.export",
"parameters": {
"project": {
"description": "Project ID of the project that contains the instance to be exported.",
"type": "string",
"location": "path",
"required": true
},
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"required": true,
"location": "path",
"type": "string"
}
},
"parameterOrder": [
"project",
"instance"
]
},
"import": {
"parameterOrder": [
"project",
"instance"
],
"httpMethod": "POST",
"description": "Imports data into a Cloud SQL instance from a SQL dump or CSV file in Cloud Storage.",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"path": "sql/v1beta4/projects/{project}/instances/{instance}/import",
"id": "sql.instances.import",
"request": {
"$ref": "InstancesImportRequest"
},
"parameters": {
"project": {
"type": "string",
"location": "path",
"required": true,
"description": "Project ID of the project that contains the instance."
},
"instance": {
"required": true,
"description": "Cloud SQL instance ID. This does not include the project ID.",
"type": "string",
"location": "path"
}
},
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/import"
},
"get": {
"parameterOrder": [
"project",
"instance"
],
"response": {
"$ref": "DatabaseInstance"
},
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}",
"httpMethod": "GET",
"path": "sql/v1beta4/projects/{project}/instances/{instance}",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
],
"parameters": {
"instance": {
"description": "Database instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"type": "string",
"location": "path",
"required": true,
"description": "Project ID of the project that contains the instance."
}
},
"description": "Retrieves a resource containing information about a Cloud SQL instance.",
"id": "sql.instances.get"
},
"insert": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
],
"httpMethod": "POST",
"description": "Creates a new Cloud SQL instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances",
"request": {
"$ref": "DatabaseInstance"
},
"parameters": {
"project": {
"type": "string",
"location": "path",
"description": "Project ID of the project to which the newly created Cloud SQL instances should belong.",
"required": true
}
},
"path": "sql/v1beta4/projects/{project}/instances",
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"project"
],
"id": "sql.instances.insert"
},
"promoteReplica": {
"response": {
"$ref": "Operation"
},
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/promoteReplica",
"description": "Promotes the read replica instance to be a stand-alone Cloud SQL instance. Using this operation might cause your instance to restart.",
"path": "sql/v1beta4/projects/{project}/instances/{instance}/promoteReplica",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL read replica instance name.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"required": true,
"description": "ID of the project that contains the read replica.",
"type": "string",
"location": "path"
}
},
"id": "sql.instances.promoteReplica",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
],
"httpMethod": "POST"
},
"startReplica": {
"path": "sql/v1beta4/projects/{project}/instances/{instance}/startReplica",
"description": "Starts the replication in the read replica instance.",
"httpMethod": "POST",
"response": {
"$ref": "Operation"
},
"id": "sql.instances.startReplica",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
],
"parameters": {
"instance": {
"location": "path",
"description": "Cloud SQL read replica instance name.",
"type": "string",
"required": true
},
"project": {
"required": true,
"description": "ID of the project that contains the read replica.",
"location": "path",
"type": "string"
}
},
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/startReplica",
"parameterOrder": [
"project",
"instance"
]
},
"restoreBackup": {
"parameterOrder": [
"project",
"instance"
],
"id": "sql.instances.restoreBackup",
"response": {
"$ref": "Operation"
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/restoreBackup",
"httpMethod": "POST",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/restoreBackup",
"description": "Restores a backup of a Cloud SQL instance. Using this operation might cause your instance to restart.",
"request": {
"$ref": "InstancesRestoreBackupRequest"
},
"parameters": {
"project": {
"location": "path",
"description": "Project ID of the project that contains the instance.",
"type": "string",
"required": true
},
"instance": {
"required": true,
"description": "Cloud SQL instance ID. This does not include the project ID.",
"type": "string",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"restart": {
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/restart",
"description": "Restarts a Cloud SQL instance.",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
],
"id": "sql.instances.restart",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"project": {
"description": "Project ID of the project that contains the instance to be restarted.",
"location": "path",
"required": true,
"type": "string"
},
"instance": {
"required": true,
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"type": "string"
}
},
"httpMethod": "POST",
"path": "sql/v1beta4/projects/{project}/instances/{instance}/restart"
},
"delete": {
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}",
"parameterOrder": [
"project",
"instance"
],
"id": "sql.instances.delete",
"path": "sql/v1beta4/projects/{project}/instances/{instance}",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
],
"description": "Deletes a Cloud SQL instance.",
"response": {
"$ref": "Operation"
},
"httpMethod": "DELETE",
"parameters": {
"project": {
"description": "Project ID of the project that contains the instance to be deleted.",
"type": "string",
"location": "path",
"required": true
},
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"type": "string",
"location": "path",
"required": true
}
}
},
"listServerCas": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
],
"parameters": {
"instance": {
"location": "path",
"type": "string",
"required": true,
"description": "Cloud SQL instance ID. This does not include the project ID."
},
"project": {
"description": "Project ID of the project that contains the instance.",
"type": "string",
"required": true,
"location": "path"
}
},
"httpMethod": "GET",
"description": "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.",
"parameterOrder": [
"project",
"instance"
],
"id": "sql.instances.listServerCas",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/listServerCas",
"path": "sql/v1beta4/projects/{project}/instances/{instance}/listServerCas",
"response": {
"$ref": "InstancesListServerCasResponse"
}
},
"addServerCa": {
"parameters": {
"project": {
"required": true,
"location": "path",
"type": "string",
"description": "Project ID of the project that contains the instance."
},
"instance": {
"location": "path",
"description": "Cloud SQL instance ID. This does not include the project ID.",
"type": "string",
"required": true
}
},
"httpMethod": "POST",
"description": "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.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/addServerCa",
"path": "sql/v1beta4/projects/{project}/instances/{instance}/addServerCa",
"id": "sql.instances.addServerCa",
"parameterOrder": [
"project",
"instance"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
],
"response": {
"$ref": "Operation"
}
},
"stopReplica": {
"httpMethod": "POST",
"path": "sql/v1beta4/projects/{project}/instances/{instance}/stopReplica",
"id": "sql.instances.stopReplica",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/stopReplica",
"description": "Stops the replication in the read replica instance.",
"parameterOrder": [
"project",
"instance"
],
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
],
"parameters": {
"project": {
"required": true,
"description": "ID of the project that contains the read replica.",
"location": "path",
"type": "string"
},
"instance": {
"type": "string",
"required": true,
"description": "Cloud SQL read replica instance name.",
"location": "path"
}
}
},
"update": {
"description": "Updates settings of a Cloud SQL instance. Using this operation might cause your instance to restart.",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
],
"response": {
"$ref": "Operation"
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}",
"httpMethod": "PUT",
"request": {
"$ref": "DatabaseInstance"
},
"id": "sql.instances.update",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}",
"parameters": {
"project": {
"type": "string",
"required": true,
"description": "Project ID of the project that contains the instance.",
"location": "path"
},
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"type": "string",
"required": true
}
},
"parameterOrder": [
"project",
"instance"
]
},
"resetSslConfig": {
"path": "sql/v1beta4/projects/{project}/instances/{instance}/resetSslConfig",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
],
"response": {
"$ref": "Operation"
},
"httpMethod": "POST",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/resetSslConfig",
"parameterOrder": [
"project",
"instance"
],
"description": "Deletes all client certificates and generates a new server SSL certificate for the instance.",
"id": "sql.instances.resetSslConfig",
"parameters": {
"project": {
"location": "path",
"required": true,
"description": "Project ID of the project that contains the instance.",
"type": "string"
},
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
}
}
},
"truncateLog": {
"id": "sql.instances.truncateLog",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
],
"parameterOrder": [
"project",
"instance"
],
"description": "Truncate MySQL general and slow query log tables",
"request": {
"$ref": "InstancesTruncateLogRequest"
},
"parameters": {
"project": {
"required": true,
"location": "path",
"type": "string",
"description": "Project ID of the Cloud SQL project."
},
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"required": true,
"location": "path",
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/truncateLog",
"httpMethod": "POST",
"response": {
"$ref": "Operation"
},
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/truncateLog"
},
"patch": {
"parameterOrder": [
"project",
"instance"
],
"id": "sql.instances.patch",
"description": "Updates settings of a Cloud SQL instance. This method supports patch semantics.",
"request": {
"$ref": "DatabaseInstance"
},
"httpMethod": "PATCH",
"parameters": {
"instance": {
"location": "path",
"description": "Cloud SQL instance ID. This does not include the project ID.",
"required": true,
"type": "string"
},
"project": {
"location": "path",
"required": true,
"description": "Project ID of the project that contains the instance.",
"type": "string"
}
},
"response": {
"$ref": "Operation"
},
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}",
"path": "sql/v1beta4/projects/{project}/instances/{instance}",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"rotateServerCa": {
"httpMethod": "POST",
"request": {
"$ref": "InstancesRotateServerCaRequest"
},
"response": {
"$ref": "Operation"
},
"description": "Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method.",
"parameterOrder": [
"project",
"instance"
],
"id": "sql.instances.rotateServerCa",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/rotateServerCa",
"path": "sql/v1beta4/projects/{project}/instances/{instance}/rotateServerCa",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
],
"parameters": {
"instance": {
"type": "string",
"required": true,
"location": "path",
"description": "Cloud SQL instance ID. This does not include the project ID."
},
"project": {
"required": true,
"type": "string",
"location": "path",
"description": "Project ID of the project that contains the instance."
}
}
},
"failover": {
"parameters": {
"instance": {
"required": true,
"location": "path",
"description": "Cloud SQL instance ID. This does not include the project ID.",
"type": "string"
},
"project": {
"required": true,
"type": "string",
"location": "path",
"description": "ID of the project that contains the read replica."
}
},
"parameterOrder": [
"project",
"instance"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
],
"path": "sql/v1beta4/projects/{project}/instances/{instance}/failover",
"httpMethod": "POST",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/failover",
"request": {
"$ref": "InstancesFailoverRequest"
},
"description": "Failover the instance to its failover replica instance. Using this operation might cause your instance to restart.",
"response": {
"$ref": "Operation"
},
"id": "sql.instances.failover"
}
}
}
},
"documentationLink": "https://developers.google.com/cloud-sql/",
"mtlsRootUrl": "https://sqladmin.mtls.googleapis.com/",
"servicePath": "",
"schemas": {
"DiskEncryptionConfiguration": {
"description": "Disk encryption configuration for an instance.",
"properties": {
"kind": {
"description": "This is always *sql#diskEncryptionConfiguration*.",
"type": "string"
},
"kmsKeyName": {
"type": "string",
"description": "Resource name of KMS key for disk encryption"
}
},
"type": "object",
"id": "DiskEncryptionConfiguration"
},
"OnPremisesConfiguration": {
"type": "object",
"id": "OnPremisesConfiguration",
"properties": {
"dumpFilePath": {
"type": "string",
"description": "The dump file to create the Cloud SQL replica."
},
"clientKey": {
"type": "string",
"description": "PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate."
},
"caCertificate": {
"description": "PEM representation of the trusted CA's x509 certificate.",
"type": "string"
},
"hostPort": {
"description": "The host and port of the on-premises instance in host:port format",
"type": "string"
},
"kind": {
"description": "This is always *sql#onPremisesConfiguration*.",
"type": "string"
},
"clientCertificate": {
"description": "PEM representation of the replica's x509 certificate.",
"type": "string"
},
"password": {
"type": "string",
"description": "The password for connecting to on-premises instance."
},
"username": {
"description": "The username for connecting to on-premises instance.",
"type": "string"
}
},
"description": "On-premises instance configuration."
},
"UsersListResponse": {
"id": "UsersListResponse",
"properties": {
"items": {
"description": "List of user resources in the instance.",
"type": "array",
"items": {
"$ref": "User"
}
},
"kind": {
"type": "string",
"description": "This is always *sql#usersList*."
},
"nextPageToken": {
"description": "An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.",
"type": "string"
}
},
"description": "User list response.",
"type": "object"
},
"SslCertDetail": {
"description": "SslCertDetail.",
"properties": {
"certPrivateKey": {
"type": "string",
"description": "The private key for the client cert, in pem format. Keep private in order to protect your security."
},
"certInfo": {
"$ref": "SslCert",
"description": "The public information about the cert."
}
},
"id": "SslCertDetail",
"type": "object"
},
"SqlExternalSyncSettingError": {
"properties": {
"type": {
"enum": [
"SQL_EXTERNAL_SYNC_SETTING_ERROR_TYPE_UNSPECIFIED",
"CONNECTION_FAILURE",
"BINLOG_NOT_ENABLED",
"INCOMPATIBLE_DATABASE_VERSION",
"REPLICA_ALREADY_SETUP",
"INSUFFICIENT_PRIVILEGE",
"UNSUPPORTED_MIGRATION_TYPE",
"NO_PGLOGICAL_INSTALLED",
"PGLOGICAL_NODE_ALREADY_EXISTS",
"INVALID_WAL_LEVEL",
"INVALID_SHARED_PRELOAD_LIBRARY",
"INSUFFICIENT_MAX_REPLICATION_SLOTS",
"INSUFFICIENT_MAX_WAL_SENDERS",
"INSUFFICIENT_MAX_WORKER_PROCESSES",
"UNSUPPORTED_EXTENSIONS",
"INVALID_RDS_LOGICAL_REPLICATION",
"INVALID_LOGGING_SETUP",
"INVALID_DB_PARAM",
"UNSUPPORTED_GTID_MODE",
"SQLSERVER_AGENT_NOT_RUNNING",
"UNSUPPORTED_TABLE_DEFINITION"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"Unsupported migration type.",
"No pglogical extension installed on databases, applicable for postgres.",
"pglogical node already exists on databases, applicable for postgres.",
"The value of parameter wal_level is not set to logical.",
"The value of parameter shared_preload_libraries does not include pglogical.",
"The value of parameter max_replication_slots is not sufficient.",
"The value of parameter max_wal_senders is not sufficient.",
"The value of parameter max_worker_processes is not sufficient.",
"Extensions installed are either not supported or having unsupported versions",
"The value of parameter rds.logical_replication is not set to 1.",
"The primary instance logging setup doesn't allow EM sync.",
"The primary instance database parameter setup doesn't allow EM sync.",
"The gtid_mode is not supported, applicable for MySQL.",
"SQL Server Agent is not running.",
"The table definition is not support due to missing primary key or replica identity, applicable for postgres."
],
"description": "Identifies the specific error that occurred.",
"type": "string"
},
"detail": {
"type": "string",
"description": "Additional information about the error encountered."
},
"kind": {
"description": "This is always *sql#migrationSettingError*.",
"type": "string"
}
},
"description": "External primary instance migration setting error.",
"id": "SqlExternalSyncSettingError",
"type": "object"
},
"DatabasesListResponse": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "This is always *sql#databasesList*."
},
"items": {
"description": "List of database resources in the instance.",
"items": {
"$ref": "Database"
},
"type": "array"
}
},
"id": "DatabasesListResponse",
"description": "Database list response."
},
"FailoverContext": {
"description": "Database instance failover context.",
"properties": {
"settingsVersion": {
"type": "string",
"description": "The current settings version of this instance. Request will be rejected if this version doesn't match the current settings version.",
"format": "int64"
},
"kind": {
"description": "This is always *sql#failoverContext*.",
"type": "string"
}
},
"id": "FailoverContext",
"type": "object"
},
"DenyMaintenancePeriod": {
"description": "Deny Maintenance Periods. This specifies a date range during when all CSA rollout will be denied.",
"properties": {
"endDate": {
"description": "\"deny maintenance period\" end date. If the year of the end date is empty, the year of the start date also must be empty. In this case, it means the deny maintenance period recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01",
"type": "string"
},
"time": {
"type": "string",
"description": "Time in UTC when the \"deny maintenance period\" starts on start_date and ends on end_date. The time is in format: HH:mm:SS, i.e., 00:00:00"
},
"startDate": {
"description": "\"deny maintenance period\" start date. If the year of the start date is empty, the year of the end date also must be empty. In this case, it means the deny maintenance period recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01",
"type": "string"
}
},
"id": "DenyMaintenancePeriod",
"type": "object"
},
"FlagsListResponse": {
"properties": {
"items": {
"description": "List of flags.",
"items": {
"$ref": "Flag"
},
"type": "array"
},
"kind": {
"type": "string",
"description": "This is always *sql#flagsList*."
}
},
"type": "object",
"description": "Flags list response.",
"id": "FlagsListResponse"
},
"InstancesTruncateLogRequest": {
"type": "object",
"description": "Instance truncate log request.",
"id": "InstancesTruncateLogRequest",
"properties": {
"truncateLogContext": {
"$ref": "TruncateLogContext",
"description": "Contains details about the truncate log operation."
}
}
},
"SslCertsCreateEphemeralRequest": {
"properties": {
"public_key": {
"type": "string",
"description": "PEM encoded public key to include in the signed certificate."
}
},
"type": "object",
"id": "SslCertsCreateEphemeralRequest",
"description": "SslCerts create ephemeral certificate request."
},
"SslCertsInsertResponse": {
"description": "SslCert insert response.",
"type": "object",
"id": "SslCertsInsertResponse",
"properties": {
"clientCert": {
"$ref": "SslCertDetail",
"description": "The new client certificate and private key."
},
"kind": {
"description": "This is always *sql#sslCertsInsert*.",
"type": "string"
},
"operation": {
"$ref": "Operation",
"description": "The operation to track the ssl certs insert request."
},
"serverCaCert": {
"$ref": "SslCert",
"description": "The server Certificate Authority's certificate. If this is missing you can force a new one to be generated by calling resetSslConfig method on instances resource."
}
}
},
"TruncateLogContext": {
"id": "TruncateLogContext",
"properties": {
"logType": {
"type": "string",
"description": "The type of log to truncate. Valid values are *MYSQL_GENERAL_TABLE* and *MYSQL_SLOW_TABLE*."
},
"kind": {
"description": "This is always *sql#truncateLogContext*.",
"type": "string"
}
},
"type": "object",
"description": "Database Instance truncate log context."
},
"BackupRunsListResponse": {
"type": "object",
"id": "BackupRunsListResponse",
"description": "Backup run list results.",
"properties": {
"kind": {
"description": "This is always *sql#backupRunsList*.",
"type": "string"
},
"nextPageToken": {
"type": "string",
"description": "The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results."
},
"items": {
"items": {
"$ref": "BackupRun"
},
"type": "array",
"description": "A list of backup runs in reverse chronological order of the enqueued time."
}
}
},
"User": {
"properties": {
"instance": {
"description": "The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for *update* since it is already specified on the URL.",
"type": "string"
},
"password": {
"description": "The password for the user.",
"type": "string"
},
"project": {
"description": "The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for *update* since it is already specified on the URL.",
"type": "string"
},
"type": {
"enumDescriptions": [
"The database's built-in user type.",
"Cloud IAM user.",
"Cloud IAM service account."
],
"enum": [
"BUILT_IN",
"CLOUD_IAM_USER",
"CLOUD_IAM_SERVICE_ACCOUNT"
],
"type": "string",
"description": "The user type. It determines the method to authenticate the user during login. The default is the database's built-in user type."
},
"kind": {
"type": "string",
"description": "This is always *sql#user*."
},
"name": {
"type": "string",
"description": "The name of the user in the Cloud SQL instance. Can be omitted for *update* since it is already specified in the URL."
},
"host": {
"description": "The host name from which the user can connect. For *insert* operations, host defaults to an empty string. For *update* operations, host is specified as part of the request URL. The host name cannot be updated after insertion.",
"type": "string"
},
"sqlserverUserDetails": {
"$ref": "SqlServerUserDetails"
},
"etag": {
"description": "This field is deprecated and will be removed from a future version of the API.",
"type": "string"
}
},
"type": "object",
"id": "User",
"description": "A Cloud SQL user resource."
},
"RestoreBackupContext": {
"type": "object",
"description": "Database instance restore from backup context. Backup context contains source instance id and project id.",
"id": "RestoreBackupContext",
"properties": {
"instanceId": {
"type": "string",
"description": "The ID of the instance that the backup was taken from."
},
"backupRunId": {
"type": "string",
"description": "The ID of the backup run to restore from.",
"format": "int64"
},
"kind": {
"type": "string",
"description": "This is always *sql#restoreBackupContext*."
},
"project": {
"type": "string",
"description": "The full project ID of the source instance."
}
}
},
"InstancesFailoverRequest": {
"id": "InstancesFailoverRequest",
"properties": {
"failoverContext": {
"$ref": "FailoverContext",
"description": "Failover Context."
}
},
"type": "object",
"description": "Instance failover request."
},
"DemoteMasterContext": {
"id": "DemoteMasterContext",
"properties": {
"masterInstanceName": {
"description": "The name of the instance which will act as on-premises primary instance in the replication setup.",
"type": "string"
},
"kind": {
"type": "string",
"description": "This is always *sql#demoteMasterContext*."
},
"verifyGtidConsistency": {
"description": "Verify GTID consistency for demote operation. Default value: *True*. Second Generation instances only. Setting this flag to false enables you to bypass GTID consistency check between on-premises primary instance 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.",
"type": "boolean"
},
"replicaConfiguration": {
"description": "Configuration specific to read-replicas replicating from the on-premises primary instance.",
"$ref": "DemoteMasterConfiguration"
}
},
"description": "Database instance demote primary instance context.",
"type": "object"
},
"BackupRun": {
"properties": {
"selfLink": {
"description": "The URI of this resource.",
"type": "string"
},
"windowStartTime": {
"format": "google-datetime",
"description": "The start time of the backup window during which this the backup was attempted in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.",
"type": "string"
},
"location": {
"description": "Location of the backups.",
"type": "string"
},
"instance": {
"description": "Name of the database instance.",
"type": "string"
},
"startTime": {
"type": "string",
"format": "google-datetime",
"description": "The time the backup operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*."
},
"endTime": {
"format": "google-datetime",
"type": "string",
"description": "The time the backup operation completed in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*."
},
"kind": {
"description": "This is always *sql#backupRun*.",
"type": "string"
},
"description": {
"description": "The description of this run, only applicable to on-demand backups.",
"type": "string"
},
"diskEncryptionStatus": {
"description": "Encryption status specific to a backup. Applies only to Second Generation instances.",
"$ref": "DiskEncryptionStatus"
},
"status": {
"enum": [
"SQL_BACKUP_RUN_STATUS_UNSPECIFIED",
"ENQUEUED",
"OVERDUE",
"RUNNING",
"FAILED",
"SUCCESSFUL",
"SKIPPED",
"DELETION_PENDING",
"DELETION_FAILED",
"DELETED"
],
"enumDescriptions": [
"The status of the run is unknown.",
"The backup operation was enqueued.",
"The backup is overdue across a given backup window. Indicates a problem. Example: Long-running operation in progress during the whole window.",
"The backup is in progress.",
"The backup failed.",
"The backup was successful.",
"The backup was skipped (without problems) for a given backup window. Example: Instance was idle.",
"The backup is about to be deleted.",
"The backup deletion failed.",
"The backup has been deleted."
],
"description": "The status of this run.",
"type": "string"
},
"diskEncryptionConfiguration": {
"description": "Encryption configuration specific to a backup. Applies only to Second Generation instances.",
"$ref": "DiskEncryptionConfiguration"
},
"type": {
"enum": [
"SQL_BACKUP_RUN_TYPE_UNSPECIFIED",
"AUTOMATED",
"ON_DEMAND"
],
"description": "The type of this run; can be either \"AUTOMATED\" or \"ON_DEMAND\".",
"type": "string",
"enumDescriptions": [
"This is an unknown BackupRun type.",
"The backup schedule automatically triggers a backup.",
"The user manually triggers a backup."
]
},
"error": {
"description": "Information about why the backup operation failed. This is only present if the run has the FAILED status.",
"$ref": "OperationError"
},
"backupKind": {
"enum": [
"SQL_BACKUP_KIND_UNSPECIFIED",
"SNAPSHOT",
"PHYSICAL"
],
"description": "Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.",
"enumDescriptions": [
"This is an unknown BackupKind.",
"The snapshot based backups",
"Physical backups"
],
"type": "string"
},
"id": {
"type": "string",
"description": "The identifier for this backup run. Unique only for a specific Cloud SQL instance.",
"format": "int64"
},
"enqueuedTime": {
"description": "The time the run was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.",
"type": "string",
"format": "google-datetime"
}
},
"type": "object",
"id": "BackupRun",
"description": "A BackupRun resource."
},
"IpMapping": {
"properties": {
"type": {
"enum": [
"SQL_IP_ADDRESS_TYPE_UNSPECIFIED",
"PRIMARY",
"OUTGOING",
"PRIVATE",
"MIGRATED_1ST_GEN"
],
"description": "The type of this IP address. A *PRIMARY* address is a public address that can accept incoming connections. A *PRIVATE* address is a private address that can accept incoming connections. An *OUTGOING* address is the source address of connections originating from the instance, if supported.",
"type": "string",
"enumDescriptions": [
"This is an unknown IP address type.",
"IP address the customer is supposed to connect to. Usually this is the load balancer's IP address",
"Source IP address of the connection a read replica establishes to its external primary instance. This IP address can be allowlisted by the customer in case it has a firewall that filters incoming connection to its on premises primary instance.",
"Private IP used when using private IPs and network peering.",
"V1 IP of a migrated instance. We want the user to decommission this IP as soon as the migration is complete. Note: V1 instances with V1 ip addresses will be counted as PRIMARY."
]
},
"ipAddress": {
"description": "The IP address assigned.",
"type": "string"
},
"timeToRetire": {
"description": "The due time for this IP to be retired in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*. This field is only available when the IP is scheduled to be retired.",
"type": "string",
"format": "google-datetime"
}
},
"id": "IpMapping",
"type": "object",
"description": "Database instance IP Mapping."
},
"SqlInstancesVerifyExternalSyncSettingsResponse": {
"id": "SqlInstancesVerifyExternalSyncSettingsResponse",
"type": "object",
"description": "Instance verify external sync settings response.",
"properties": {
"kind": {
"type": "string",
"description": "This is always *sql#migrationSettingErrorList*."
},
"errors": {
"type": "array",
"items": {
"$ref": "SqlExternalSyncSettingError"
},
"description": "List of migration violations."
}
}
},
"DatabaseInstance": {
"description": "A Cloud SQL instance resource. Next field: 36",
"properties": {
"scheduledMaintenance": {
"description": "The start time of any upcoming scheduled maintenance for this instance.",
"$ref": "SqlScheduledMaintenance"
},
"replicaConfiguration": {
"description": "Configuration specific to failover replicas and read replicas.",
"$ref": "ReplicaConfiguration"
},
"project": {
"type": "string",
"description": "The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable."
},
"rootPassword": {
"type": "string",
"description": "Initial root password. Use only on creation."
},
"instanceType": {
"enumDescriptions": [
"This is an unknown Cloud SQL instance type.",
"A regular Cloud SQL instance.",
"An instance running on the customer's premises that is not managed by Cloud SQL.",
"A Cloud SQL instance acting as a read-replica."
],
"enum": [
"SQL_INSTANCE_TYPE_UNSPECIFIED",
"CLOUD_SQL_INSTANCE",
"ON_PREMISES_INSTANCE",
"READ_REPLICA_INSTANCE"
],
"description": "The instance type. This can be one of the following. *CLOUD_SQL_INSTANCE*: A Cloud SQL instance that is not replicating from a primary instance. *ON_PREMISES_INSTANCE*: An instance running on the customer's premises. *READ_REPLICA_INSTANCE*: A Cloud SQL instance configured as a read-replica.",
"type": "string"
},
"masterInstanceName": {
"description": "The name of the instance which will act as primary in the replication setup.",
"type": "string"
},
"ipAddresses": {
"description": "The assigned IP addresses for the instance.",
"items": {
"$ref": "IpMapping"
},
"type": "array"
},
"suspensionReason": {
"description": "If the instance state is SUSPENDED, the reason for the suspension.",
"items": {
"enum": [
"SQL_SUSPENSION_REASON_UNSPECIFIED",
"BILLING_ISSUE",
"LEGAL_ISSUE",
"OPERATIONAL_ISSUE",
"KMS_KEY_ISSUE"
],
"type": "string",
"enumDescriptions": [
"This is an unknown suspension reason.",
"The instance is suspended due to billing issues (for example:, GCP account issue)",
"The instance is suspended due to illegal content (for example:, child pornography, copyrighted material, etc.).",
"The instance is causing operational issues (for example:, causing the database to crash).",
"The KMS key used by the instance is either revoked or denied access to"
]
},
"type": "array"
},
"failoverReplica": {
"description": "The name and status of the failover replica. This property is applicable only to Second Generation instances.",
"properties": {
"available": {
"type": "boolean",
"description": "The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only failover to the failover replica when the status is true."
},
"name": {
"type": "string",
"description": "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."
}
},
"type": "object"
},
"replicaNames": {
"description": "The replicas of the instance.",
"items": {
"type": "string"
},
"type": "array"
},
"onPremisesConfiguration": {
"$ref": "OnPremisesConfiguration",
"description": "Configuration specific to on-premises instances."
},
"backendType": {
"enumDescriptions": [
"This is an unknown backend type for instance.",
"V1 speckle instance.",
"V2 speckle instance.",
"On premises instance."
],
"description": " *SECOND_GEN*: Cloud SQL database instance. *EXTERNAL*: A database server that is not managed by Google. This property is read-only; use the *tier* property in the *settings* object to determine the database type.",
"type": "string",
"enum": [
"SQL_BACKEND_TYPE_UNSPECIFIED",
"FIRST_GEN",
"SECOND_GEN",
"EXTERNAL"
]
},
"region": {
"type": "string",
"description": "The geographical region. Can be *us-central* (*FIRST_GEN* instances only) *us-central1* (*SECOND_GEN* instances only) *asia-east1* or *europe-west1*. Defaults to *us-central* or *us-central1* depending on the instance type. The region cannot be changed after instance creation."
},
"currentDiskSize": {
"format": "int64",
"description": "The current disk usage of the instance in bytes. This property has been deprecated. Use the \"cloudsql.googleapis.com/database/disk/bytes_used\" metric in Cloud Monitoring API instead. Please see this announcement for details.",
"type": "string"
},
"gceZone": {
"type": "string",
"description": "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."
},
"connectionName": {
"type": "string",
"description": "Connection name of the Cloud SQL instance used in connection strings."
},
"selfLink": {
"description": "The URI of this resource.",
"type": "string"
},
"satisfiesPzs": {
"type": "boolean",
"description": "The status indicating if instance satisfies physical zone separation. Reserved for future use."
},
"serverCaCert": {
"$ref": "SslCert",
"description": "SSL configuration."
},
"state": {
"enumDescriptions": [
"The state of the instance is unknown.",
"The instance has been stopped by owner. It is not currently running, but it's ready to be restarted.",
"The instance is not available, for example due to problems with billing.",
"The instance is being deleted.",
"The instance is being created.",
"The instance is down for maintenance.",
"The creation of the instance failed or a fatal error occurred during maintenance."
],
"type": "string",
"enum": [
"SQL_INSTANCE_STATE_UNSPECIFIED",
"RUNNABLE",
"SUSPENDED",
"PENDING_DELETE",
"PENDING_CREATE",
"MAINTENANCE",
"FAILED"
],
"description": "The current serving state of the Cloud SQL instance. This can be one of the following. *SQL_INSTANCE_STATE_UNSPECIFIED*: The state of the instance is unknown. *RUNNABLE*: The instance has been stopped by owner. It is not currently running, but it's ready to be restarted. *SUSPENDED*: The instance is not available, for example due to problems with billing. for example due to problems with billing. *PENDING_DELETE*: The instance is being deleted. *PENDING_CREATE*: The instance is being created. *MAINTENANCE*: The instance is down for maintenance. *FAILED*: The instance creation failed."
},
"maxDiskSize": {
"format": "int64",
"type": "string",
"description": "The maximum disk size of the instance in bytes."
},
"diskEncryptionStatus": {
"$ref": "DiskEncryptionStatus",
"description": "Disk encryption status specific to an instance. Applies only to Second Generation instances."
},
"secondaryGceZone": {
"type": "string",
"description": "The Compute Engine zone that the failover instance is currently serving from for a regional instance. 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/failover zone. Reserved for future use."
},
"etag": {
"description": "This field is deprecated and will be removed from a future version of the API. Use the *settings.settingsVersion* field instead.",
"type": "string"
},
"kind": {
"type": "string",
"description": "This is always *sql#instance*."
},
"serviceAccountEmailAddress": {
"type": "string",
"description": "The service account email address assigned to the instance. This property is applicable only to Second Generation instances."
},
"databaseVersion": {
"enumDescriptions": [
"This is an unknown database version.",
"The database version is MySQL 5.1.",
"The database version is MySQL 5.5.",
"The database version is MySQL 5.6.",
"The database version is MySQL 5.7.",
"The database version is PostgreSQL 9.6.",
"The database version is PostgreSQL 11.",
"The database version is SQL Server 2017 Standard.",
"The database version is SQL Server 2017 Enterprise.",
"The database version is SQL Server 2017 Express.",
"The database version is SQL Server 2017 Web.",
"The database version is PostgreSQL 10.",
"The database version is PostgreSQL 12.",
"The database version is MySQL 8.",
"The database version is PostgreSQL 13."
],
"enum": [
"SQL_DATABASE_VERSION_UNSPECIFIED",
"MYSQL_5_1",
"MYSQL_5_5",
"MYSQL_5_6",
"MYSQL_5_7",
"POSTGRES_9_6",
"POSTGRES_11",
"SQLSERVER_2017_STANDARD",
"SQLSERVER_2017_ENTERPRISE",
"SQLSERVER_2017_EXPRESS",
"SQLSERVER_2017_WEB",
"POSTGRES_10",
"POSTGRES_12",
"MYSQL_8_0",
"POSTGRES_13"
],
"description": "The database engine type and version. The *databaseVersion* field cannot be changed after instance creation. MySQL instances: *MYSQL_8_0*, *MYSQL_5_7* (default), or *MYSQL_5_6*. PostgreSQL instances: *POSTGRES_9_6*, *POSTGRES_10*, *POSTGRES_11* or *POSTGRES_12* (default). SQL Server instances: *SQLSERVER_2017_STANDARD* (default), *SQLSERVER_2017_ENTERPRISE*, *SQLSERVER_2017_EXPRESS*, or *SQLSERVER_2017_WEB*.",
"type": "string"
},
"name": {
"description": "Name of the Cloud SQL instance. This does not include the project ID.",
"type": "string"
},
"ipv6Address": {
"description": "The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances.",
"type": "string"
},
"settings": {
"$ref": "Settings",
"description": "The user settings."
},
"diskEncryptionConfiguration": {
"$ref": "DiskEncryptionConfiguration",
"description": "Disk encryption configuration specific to an instance. Applies only to Second Generation instances."
}
},
"id": "DatabaseInstance",
"type": "object"
},
"InstancesRestoreBackupRequest": {
"id": "InstancesRestoreBackupRequest",
"properties": {
"restoreBackupContext": {
"$ref": "RestoreBackupContext",
"description": "Parameters required to perform the restore backup operation."
}
},
"type": "object",
"description": "Database instance restore backup request."
},
"Flag": {
"description": "A flag resource.",
"type": "object",
"properties": {
"appliesTo": {
"type": "array",
"description": "The database version this flag applies to. Can be *MYSQL_8_0*, *MYSQL_5_6*, or *MYSQL_5_7*.",
"items": {
"type": "string",
"enumDescriptions": [
"This is an unknown database version.",
"The database version is MySQL 5.1.",
"The database version is MySQL 5.5.",
"The database version is MySQL 5.6.",
"The database version is MySQL 5.7.",
"The database version is PostgreSQL 9.6.",
"The database version is PostgreSQL 11.",
"The database version is SQL Server 2017 Standard.",
"The database version is SQL Server 2017 Enterprise.",
"The database version is SQL Server 2017 Express.",
"The database version is SQL Server 2017 Web.",
"The database version is PostgreSQL 10.",
"The database version is PostgreSQL 12.",
"The database version is MySQL 8.",
"The database version is PostgreSQL 13."
],
"enum": [
"SQL_DATABASE_VERSION_UNSPECIFIED",
"MYSQL_5_1",
"MYSQL_5_5",
"MYSQL_5_6",
"MYSQL_5_7",
"POSTGRES_9_6",
"POSTGRES_11",
"SQLSERVER_2017_STANDARD",
"SQLSERVER_2017_ENTERPRISE",
"SQLSERVER_2017_EXPRESS",
"SQLSERVER_2017_WEB",
"POSTGRES_10",
"POSTGRES_12",
"MYSQL_8_0",
"POSTGRES_13"
]
}
},
"maxValue": {
"description": "For *INTEGER* flags, the maximum allowed value.",
"type": "string",
"format": "int64"
},
"minValue": {
"type": "string",
"format": "int64",
"description": "For *INTEGER* flags, the minimum allowed value."
},
"allowedStringValues": {
"type": "array",
"items": {
"type": "string"
},
"description": "For *STRING* flags, a list of strings that the value can be set to."
},
"inBeta": {
"type": "boolean",
"description": "Whether or not the flag is considered in beta."
},
"allowedIntValues": {
"description": "Use this field if only certain integers are accepted. Can be combined with min_value and max_value to add additional values.",
"items": {
"type": "string",
"format": "int64"
},
"type": "array"
},
"type": {
"type": "string",
"enum": [
"SQL_FLAG_TYPE_UNSPECIFIED",
"BOOLEAN",
"STRING",
"INTEGER",
"NONE",
"MYSQL_TIMEZONE_OFFSET",
"FLOAT",
"REPEATED_STRING"
],
"enumDescriptions": [
"This is an unknown flag type.",
"Boolean type flag.",
"String type flag.",
"Integer type flag.",
"Flag type used for a server startup option.",
"Type introduced specically for MySQL TimeZone offset. Accept a string value with the format [-12:59, 13:00].",
"Float type flag.",
"Comma-separated list of the strings in a SqlFlagType enum."
],
"description": "The type of the flag. Flags are typed to being *BOOLEAN*, *STRING*, *INTEGER* or *NONE*. *NONE* is used for flags which do not take a value, such as *skip_grant_tables*."
},
"kind": {
"type": "string",
"description": "This is always *sql#flag*."
},
"name": {
"description": "This is the name of the flag. Flag names always use underscores, not hyphens, for example: *max_allowed_packet*",
"type": "string"
},
"requiresRestart": {
"description": "Indicates whether changing this flag will trigger a database restart. Only applicable to Second Generation instances.",
"type": "boolean"
}
},
"id": "Flag"
},
"MySqlReplicaConfiguration": {
"properties": {
"sslCipher": {
"type": "string",
"description": "A list of permissible ciphers to use for SSL encryption."
},
"masterHeartbeatPeriod": {
"description": "Interval in milliseconds between replication heartbeats.",
"format": "int64",
"type": "string"
},
"connectRetryInterval": {
"format": "int32",
"type": "integer",
"description": "Seconds to wait between connect retries. MySQL's default is 60 seconds."
},
"clientCertificate": {
"description": "PEM representation of the replica's x509 certificate.",
"type": "string"
},
"password": {
"type": "string",
"description": "The password for the replication connection."
},
"username": {
"description": "The username for the replication connection.",
"type": "string"
},
"kind": {
"description": "This is always *sql#mysqlReplicaConfiguration*.",
"type": "string"
},
"verifyServerCertificate": {
"description": "Whether or not to check the primary instance's Common Name value in the certificate that it sends during the SSL handshake.",
"type": "boolean"
},
"dumpFilePath": {
"type": "string",
"description": "Path to a SQL dump file in Google Cloud Storage from which the replica instance is to be created. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported. Dumps have the binlog co-ordinates from which replication begins. This can be accomplished by setting --master-data to 1 when using mysqldump."
},
"caCertificate": {
"type": "string",
"description": "PEM representation of the trusted CA's x509 certificate."
},
"clientKey": {
"type": "string",
"description": "PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate."
}
},
"type": "object",
"id": "MySqlReplicaConfiguration",
"description": "Read-replica configuration specific to MySQL databases."
},
"SqlInstancesRescheduleMaintenanceRequestBody": {
"type": "object",
"properties": {
"reschedule": {
"$ref": "Reschedule",
"description": "Required. The type of the reschedule the user wants."
}
},
"id": "SqlInstancesRescheduleMaintenanceRequestBody",
"description": "Reschedule options for maintenance windows."
},
"SqlServerUserDetails": {
"description": "Represents a Sql Server user on the Cloud SQL instance.",
"properties": {
"disabled": {
"description": "If the user has been disabled",
"type": "boolean"
},
"serverRoles": {
"type": "array",
"description": "The server roles for this user",
"items": {
"type": "string"
}
}
},
"id": "SqlServerUserDetails",
"type": "object"
},
"Operation": {
"description": "An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.",
"properties": {
"user": {
"type": "string",
"description": "The email address of the user who initiated this operation."
},
"error": {
"description": "If errors occurred during processing of this operation, this field will be populated.",
"$ref": "OperationErrors"
},
"status": {
"enum": [
"SQL_OPERATION_STATUS_UNSPECIFIED",
"PENDING",
"RUNNING",
"DONE"
],
"type": "string",
"description": "The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*",
"enumDescriptions": [
"The state of the operation is unknown.",
"The operation has been queued, but has not started yet.",
"The operation is running.",
"The operation completed."
]
},
"kind": {
"description": "This is always *sql#operation*.",
"type": "string"
},
"name": {
"description": "An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.",
"type": "string"
},
"targetId": {
"description": "Name of the database instance related to this operation.",
"type": "string"
},
"startTime": {
"description": "The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.",
"format": "google-datetime",
"type": "string"
},
"operationType": {
"enum": [
"SQL_OPERATION_TYPE_UNSPECIFIED",
"IMPORT",
"EXPORT",
"CREATE",
"UPDATE",
"DELETE",
"RESTART",
"BACKUP",
"SNAPSHOT",
"BACKUP_VOLUME",
"DELETE_VOLUME",
"RESTORE_VOLUME",
"INJECT_USER",
"CLONE",
"STOP_REPLICA",
"START_REPLICA",
"PROMOTE_REPLICA",
"CREATE_REPLICA",
"CREATE_USER",
"DELETE_USER",
"UPDATE_USER",
"CREATE_DATABASE",
"DELETE_DATABASE",
"UPDATE_DATABASE",
"FAILOVER",
"DELETE_BACKUP",
"RECREATE_REPLICA",
"TRUNCATE_LOG",
"DEMOTE_MASTER",
"MAINTENANCE",
"ENABLE_PRIVATE_IP",
"DEFER_MAINTENANCE",
"CREATE_CLONE",
"RESCHEDULE_MAINTENANCE",
"START_EXTERNAL_SYNC"
],
"type": "string",
"enumDescriptions": [
"Unknown operation type.",
"Imports data into a Cloud SQL instance.",
"Exports data from a Cloud SQL instance to a Cloud Storage bucket.",
"Creates a new Cloud SQL instance.",
"Updates the settings of a Cloud SQL instance.",
"Deletes a Cloud SQL instance.",
"Restarts the Cloud SQL instance.",
"",
"",
"Performs instance backup.",
"Deletes an instance backup.",
"Restores an instance backup.",
"Injects a privileged user in mysql for MOB instances.",
"Clones a Cloud SQL instance.",
"Stops replication on a Cloud SQL read replica instance.",
"Starts replication on a Cloud SQL read replica instance.",
"Promotes a Cloud SQL replica instance.",
"Creates a Cloud SQL replica instance.",
"Creates a new user in a Cloud SQL instance.",
"Deletes a user from a Cloud SQL instance.",
"Updates an existing user in a Cloud SQL instance.",
"Creates a database in the Cloud SQL instance.",
"Deletes a database in the Cloud SQL instance.",
"Updates a database in the Cloud SQL instance.",
"Performs failover of an HA-enabled Cloud SQL failover replica.",
"Deletes the backup taken by a backup run.",
"",
"Truncates a general or slow log table in MySQL.",
"Demotes the stand-alone instance to be a Cloud SQL read replica for an external database server.",
"Indicates that the instance is currently in maintenance. Maintenance typically causes the instance to be unavailable for 1-3 minutes.",
"This field is deprecated, and will be removed in future version of API.",
"",
"Creates clone instance.",
"Reschedule maintenance to another time.",
"Starts external sync of a Cloud SQL EM replica to an external primary instance."
],
"description": "The type of the operation. Valid values are: *CREATE* *DELETE* *UPDATE* *RESTART* *IMPORT* *EXPORT* *BACKUP_VOLUME* *RESTORE_VOLUME* *CREATE_USER* *DELETE_USER* *CREATE_DATABASE* *DELETE_DATABASE*"
},
"targetProject": {
"type": "string",
"description": "The project ID of the target instance related to this operation."
},
"importContext": {
"description": "The context for import operation, if applicable.",
"$ref": "ImportContext"
},
"insertTime": {
"format": "google-datetime",
"type": "string",
"description": "The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*."
},
"targetLink": {
"type": "string"
},
"endTime": {
"description": "The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.",
"format": "google-datetime",
"type": "string"
},
"selfLink": {
"type": "string",
"description": "The URI of this resource."
},
"exportContext": {
"description": "The context for export operation, if applicable.",
"$ref": "ExportContext"
}
},
"type": "object",
"id": "Operation"
},
"DemoteMasterMySqlReplicaConfiguration": {
"type": "object",
"description": "Read-replica configuration specific to MySQL databases.",
"properties": {
"clientCertificate": {
"description": "PEM representation of the replica's x509 certificate.",
"type": "string"
},
"password": {
"type": "string",
"description": "The password for the replication connection."
},
"kind": {
"description": "This is always *sql#demoteMasterMysqlReplicaConfiguration*.",
"type": "string"
},
"caCertificate": {
"type": "string",
"description": "PEM representation of the trusted CA's x509 certificate."
},
"username": {
"type": "string",
"description": "The username for the replication connection."
},
"clientKey": {
"type": "string",
"description": "PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate. The format of the replica's private key can be either PKCS #1 or PKCS #8."
}
},
"id": "DemoteMasterMySqlReplicaConfiguration"
},
"AclEntry": {
"properties": {
"value": {
"description": "The allowlisted value for the access control list.",
"type": "string"
},
"expirationTime": {
"type": "string",
"description": "The time when this access control entry expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.",
"format": "google-datetime"
},
"kind": {
"description": "This is always *sql#aclEntry*.",
"type": "string"
},
"name": {
"type": "string",
"description": "Optional. A label to identify this entry."
}
},
"id": "AclEntry",
"description": "An entry for an Access Control list.",
"type": "object"
},
"ImportContext": {
"type": "object",
"properties": {
"fileType": {
"enum": [
"SQL_FILE_TYPE_UNSPECIFIED",
"SQL",
"CSV",
"BAK"
],
"description": "The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.",
"enumDescriptions": [
"Unknown file type.",
"File containing SQL statements.",
"File in CSV format.",
""
],
"type": "string"
},
"uri": {
"description": "Path to the import file in Cloud Storage, in the form *gs: //bucketName/fileName*. Compressed gzip files (.gz) are supported // when *fileType* is *SQL*. The instance must have // write permissions to the bucket and read access to the file.",
"type": "string"
},
"bakImportOptions": {
"type": "object",
"properties": {
"encryptionOptions": {
"properties": {
"pvkPath": {
"type": "string",
"description": "Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file."
},
"certPath": {
"description": "Path to the Certificate (.cer) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.",
"type": "string"
},
"pvkPassword": {
"type": "string",
"description": "Password that encrypts the private key"
}
},
"type": "object"
}
},
"description": "Import parameters specific to SQL Server .BAK files"
},
"csvImportOptions": {
"properties": {
"columns": {
"items": {
"type": "string"
},
"description": "The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.",
"type": "array"
},
"table": {
"type": "string",
"description": "The table to which CSV data is imported."
}
},
"description": "Options for importing data as CSV.",
"type": "object"
},
"kind": {
"description": "This is always *sql#importContext*.",
"type": "string"
},
"importUser": {
"description": "The PostgreSQL user for this import operation. PostgreSQL instances only.",
"type": "string"
},
"database": {
"type": "string",
"description": "The target database for the import. If *fileType* is *SQL*, 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 *fileType* is *CSV*, one database must be specified."
}
},
"description": "Database instance import context.",
"id": "ImportContext"
},
"SslCertsInsertRequest": {
"properties": {
"commonName": {
"type": "string",
"description": "User supplied name. Must be a distinct name from the other certificates for this instance."
}
},
"type": "object",
"id": "SslCertsInsertRequest",
"description": "SslCerts insert request."
},
"InstancesDemoteMasterRequest": {
"id": "InstancesDemoteMasterRequest",
"properties": {
"demoteMasterContext": {
"$ref": "DemoteMasterContext",
"description": "Contains details about the demoteMaster operation."
}
},
"description": "Database demote primary instance request.",
"type": "object"
},
"SslCert": {
"properties": {
"expirationTime": {
"description": "The time when the certificate expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.",
"format": "google-datetime",
"type": "string"
},
"commonName": {
"description": "User supplied name. Constrained to [a-zA-Z.-_ ]+.",
"type": "string"
},
"createTime": {
"format": "google-datetime",
"description": "The time when the certificate was created in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*",
"type": "string"
},
"sha1Fingerprint": {
"type": "string",
"description": "Sha1 Fingerprint."
},
"cert": {
"type": "string",
"description": "PEM representation."
},
"selfLink": {
"type": "string",
"description": "The URI of this resource."
},
"certSerialNumber": {
"description": "Serial number, as extracted from the certificate.",
"type": "string"
},
"instance": {
"type": "string",
"description": "Name of the database instance."
},
"kind": {
"type": "string",
"description": "This is always *sql#sslCert*."
}
},
"id": "SslCert",
"type": "object",
"description": "SslCerts Resource"
},
"ExportContext": {
"description": "Database instance export context.",
"properties": {
"sqlExportOptions": {
"description": "Options for exporting data as SQL statements.",
"type": "object",
"properties": {
"tables": {
"type": "array",
"description": "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.",
"items": {
"type": "string"
}
},
"mysqlExportOptions": {
"type": "object",
"description": "Options for exporting from MySQL.",
"properties": {
"masterData": {
"type": "integer",
"format": "int32",
"description": "Option to include SQL statement required to set up replication. If set to *1*, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored."
}
}
},
"schemaOnly": {
"type": "boolean",
"description": "Export only schemas."
}
}
},
"uri": {
"type": "string",
"description": "The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form *gs: //bucketName/fileName*. If the file already exists, the requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed."
},
"fileType": {
"description": "The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.",
"type": "string",
"enum": [
"SQL_FILE_TYPE_UNSPECIFIED",
"SQL",
"CSV",
"BAK"
],
"enumDescriptions": [
"Unknown file type.",
"File containing SQL statements.",
"File in CSV format.",
""
]
},
"csvExportOptions": {
"type": "object",
"description": "Options for exporting data as CSV.",
"properties": {
"selectQuery": {
"description": "The select query used to extract the data.",
"type": "string"
}
}
},
"offload": {
"type": "boolean",
"description": "Option for export offload."
},
"kind": {
"description": "This is always *sql#exportContext*.",
"type": "string"
},
"databases": {
"type": "array",
"items": {
"type": "string"
},
"description": "Databases to be exported. *MySQL instances:* If *fileType* is *SQL* and no database is specified, all databases are exported, except for the *mysql* system database. If *fileType* is *CSV*, you can specify one database, either by using this property or by using the *csvExportOptions.selectQuery* property, which takes precedence over this property. *PostgreSQL instances:* You must specify one database to be exported. If *fileType* is *CSV*, this database must match the one specified in the *csvExportOptions.selectQuery* property."
}
},
"id": "ExportContext",
"type": "object"
},
"BackupConfiguration": {
"id": "BackupConfiguration",
"type": "object",
"properties": {
"location": {
"type": "string",
"description": "Location of the backup"
},
"kind": {
"description": "This is always *sql#backupConfiguration*.",
"type": "string"
},
"binaryLogEnabled": {
"type": "boolean",
"description": "(MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well."
},
"transactionLogRetentionDays": {
"format": "int32",
"type": "integer",
"description": "The number of days of transaction logs we retain for point in time restore, from 1-7."
},
"replicationLogArchivingEnabled": {
"type": "boolean",
"description": "Reserved for future use."
},
"pointInTimeRecoveryEnabled": {
"description": "Reserved for future use.",
"type": "boolean"
},
"backupRetentionSettings": {
"$ref": "BackupRetentionSettings",
"description": "Backup retention settings."
},
"enabled": {
"description": "Whether this configuration is enabled.",
"type": "boolean"
},
"startTime": {
"description": "Start time for the daily backup configuration in UTC timezone in the 24 hour format - *HH:MM*.",
"type": "string"
}
},
"description": "Database instance backup configuration."
},
"OperationErrors": {
"id": "OperationErrors",
"type": "object",
"description": "Database instance operation errors list wrapper.",
"properties": {
"errors": {
"items": {
"$ref": "OperationError"
},
"description": "The list of errors encountered while processing this operation.",
"type": "array"
},
"kind": {
"type": "string",
"description": "This is always *sql#operationErrors*."
}
}
},
"OperationError": {
"type": "object",
"id": "OperationError",
"properties": {
"message": {
"description": "Additional information about the error encountered.",
"type": "string"
},
"kind": {
"description": "This is always *sql#operationError*.",
"type": "string"
},
"code": {
"description": "Identifies the specific error that occurred.",
"type": "string"
}
},
"description": "Database instance operation error."
},
"InstancesListServerCasResponse": {
"id": "InstancesListServerCasResponse",
"type": "object",
"description": "Instances ListServerCas response.",
"properties": {
"activeVersion": {
"type": "string"
},
"kind": {
"type": "string",
"description": "This is always *sql#instancesListServerCas*."
},
"certs": {
"items": {
"$ref": "SslCert"
},
"description": "List of server CA certificates for the instance.",
"type": "array"
}
}
},
"OperationsListResponse": {
"id": "OperationsListResponse",
"type": "object",
"description": "Database instance list operations response.",
"properties": {
"nextPageToken": {
"type": "string",
"description": "The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results."
},
"items": {
"items": {
"$ref": "Operation"
},
"type": "array",
"description": "List of operation resources."
},
"kind": {
"description": "This is always *sql#operationsList*.",
"type": "string"
}
}
},
"LocationPreference": {
"properties": {
"zone": {
"description": "The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.).",
"type": "string"
},
"followGaeApplication": {
"description": "The App Engine application to follow, it must be in the same region as the Cloud SQL instance.",
"type": "string"
},
"kind": {
"description": "This is always *sql#locationPreference*.",
"type": "string"
},
"secondaryZone": {
"description": "The preferred Compute Engine zone for the secondary/failover (for example: us-central1-a, us-central1-b, etc.). Reserved for future use.",
"type": "string"
}
},
"type": "object",
"id": "LocationPreference",
"description": "Preferred location. This specifies where a Cloud SQL instance is located, either in a specific Compute Engine zone, or co-located with an App Engine application. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified."
},
"DiskEncryptionStatus": {
"id": "DiskEncryptionStatus",
"type": "object",
"description": "Disk encryption status for an instance.",
"properties": {
"kmsKeyVersionName": {
"type": "string",
"description": "KMS key version used to encrypt the Cloud SQL instance resource"
},
"kind": {
"type": "string",
"description": "This is always *sql#diskEncryptionStatus*."
}
}
},
"Settings": {
"id": "Settings",
"type": "object",
"properties": {
"authorizedGaeApplications": {
"items": {
"type": "string"
},
"type": "array",
"description": "The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only."
},
"locationPreference": {
"$ref": "LocationPreference",
"description": "The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or Compute Engine zone for better performance. App Engine co-location was only applicable to First Generation instances."
},
"crashSafeReplicationEnabled": {
"description": "Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.",
"type": "boolean"
},
"storageAutoResize": {
"description": "Configuration to increase storage size automatically. The default value is true.",
"type": "boolean"
},
"settingsVersion": {
"type": "string",
"format": "int64",
"description": "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."
},
"userLabels": {
"description": "User-provided labels, represented as a dictionary where each label is a single key value pair.",
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"maintenanceWindow": {
"$ref": "MaintenanceWindow",
"description": "The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes."
},
"backupConfiguration": {
"$ref": "BackupConfiguration",
"description": "The daily backup configuration for the instance."
},
"activationPolicy": {
"description": "The activation policy specifies when the instance is activated; it is applicable only when the instance state is RUNNABLE. Valid values: *ALWAYS*: The instance is on, and remains so even in the absence of connection requests. *NEVER*: The instance is off; it is not activated, even if a connection request arrives.",
"enumDescriptions": [
"Unknown activation plan.",
"The instance is always up and running.",
"The instance never starts.",
"The instance starts upon receiving requests."
],
"type": "string",
"enum": [
"SQL_ACTIVATION_POLICY_UNSPECIFIED",
"ALWAYS",
"NEVER",
"ON_DEMAND"
]
},
"replicationType": {
"description": "The type of replication this instance uses. This can be either *ASYNCHRONOUS* or *SYNCHRONOUS*. (Deprecated_ This property was only applicable to First Generation instances.",
"enumDescriptions": [
"This is an unknown replication type for a Cloud SQL instance.",
"The synchronous replication mode for First Generation instances. It is the default value.",
"The asynchronous replication mode for First Generation instances. It provides a slight performance gain, but if an outage occurs while this option is set to asynchronous, you can lose up to a few seconds of updates to your data."
],
"enum": [
"SQL_REPLICATION_TYPE_UNSPECIFIED",
"SYNCHRONOUS",
"ASYNCHRONOUS"
],
"type": "string"
},
"databaseReplicationEnabled": {
"type": "boolean",
"description": "Configuration specific to read replica instances. Indicates whether replication is enabled or not."
},
"denyMaintenancePeriods": {
"description": "Deny maintenance periods",
"type": "array",
"items": {
"$ref": "DenyMaintenancePeriod"
}
},
"kind": {
"type": "string",
"description": "This is always *sql#settings*."
},
"ipConfiguration": {
"description": "The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled for Second Generation instances.",
"$ref": "IpConfiguration"
},
"storageAutoResizeLimit": {
"description": "The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.",
"type": "string",
"format": "int64"
},
"databaseFlags": {
"items": {
"$ref": "DatabaseFlags"
},
"type": "array",
"description": "The database flags passed to the instance at startup."
},
"availabilityType": {
"enumDescriptions": [
"This is an unknown Availability type.",
"Zonal available instance.",
"Regional available instance."
],
"enum": [
"SQL_AVAILABILITY_TYPE_UNSPECIFIED",
"ZONAL",
"REGIONAL"
],
"description": "Availability type. Potential values: *ZONAL*: The instance serves data from only one zone. Outages in that zone affect data accessibility. *REGIONAL*: The instance can serve data from more than one zone in a region (it is highly available). For more information, see Overview of the High Availability Configuration.",
"type": "string"
},
"tier": {
"type": "string",
"description": "The tier (or machine type) for this instance, for example *db-n1-standard-1* (MySQL instances) or *db-custom-1-3840* (PostgreSQL instances)."
},
"dataDiskType": {
"enumDescriptions": [
"This is an unknown data disk type.",
"An SSD data disk.",
"An HDD data disk.",
"This field is deprecated and will be removed from a future version of the API."
],
"description": "The type of data disk: PD_SSD (default) or PD_HDD. Not used for First Generation instances.",
"type": "string",
"enum": [
"SQL_DATA_DISK_TYPE_UNSPECIFIED",
"PD_SSD",
"PD_HDD",
"OBSOLETE_LOCAL_SSD"
]
},
"collation": {
"description": "The name of server Instance collation.",
"type": "string"
},
"pricingPlan": {
"description": "The pricing plan for this instance. This can be either *PER_USE* or *PACKAGE*. Only *PER_USE* is supported for Second Generation instances.",
"enumDescriptions": [
"This is an unknown pricing plan for this instance.",
"The instance is billed at a monthly flat rate.",
"The instance is billed per usage."
],
"type": "string",
"enum": [
"SQL_PRICING_PLAN_UNSPECIFIED",
"PACKAGE",
"PER_USE"
]
},
"activeDirectoryConfig": {
"description": "Active Directory configuration, relevant only for Cloud SQL for SQL Server.",
"$ref": "SqlActiveDirectoryConfig"
},
"dataDiskSizeGb": {
"format": "int64",
"type": "string",
"description": "The size of data disk, in GB. The data disk size minimum is 10GB."
}
},
"description": "Database instance settings."
},
"Tier": {
"properties": {
"tier": {
"description": "An identifier for the machine type, for example, db-n1-standard-1. For related information, see Pricing.",
"type": "string"
},
"kind": {
"type": "string",
"description": "This is always *sql#tier*."
},
"DiskQuota": {
"description": "The maximum disk size of this tier in bytes.",
"format": "int64",
"type": "string"
},
"RAM": {
"description": "The maximum RAM usage of this tier in bytes.",
"type": "string",
"format": "int64"
},
"region": {
"description": "The applicable regions for this tier.",
"items": {
"type": "string"
},
"type": "array"
}
},
"description": "A Google Cloud SQL service tier resource.",
"id": "Tier",
"type": "object"
},
"ReplicaConfiguration": {
"type": "object",
"description": "Read-replica configuration for connecting to the primary instance.",
"id": "ReplicaConfiguration",
"properties": {
"mysqlReplicaConfiguration": {
"$ref": "MySqlReplicaConfiguration",
"description": "MySQL specific configuration when replicating from a MySQL on-premises primary instance. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named *master.info* in the data directory."
},
"failoverTarget": {
"description": "Specifies if the replica is the failover target. If the field is set to *true* the replica will be designated as a failover replica. In case the primary instance fails, the replica instance will be promoted as the new primary instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the primary instance.",
"type": "boolean"
},
"kind": {
"description": "This is always *sql#replicaConfiguration*.",
"type": "string"
}
}
},
"BackupRetentionSettings": {
"type": "object",
"id": "BackupRetentionSettings",
"properties": {
"retentionUnit": {
"type": "string",
"enumDescriptions": [
"Backup retention unit is unspecified, will be treated as COUNT.",
"Retention will be by count, eg. \"retain the most recent 7 backups\"."
],
"description": "The unit that 'retained_backups' represents.",
"enum": [
"RETENTION_UNIT_UNSPECIFIED",
"COUNT"
]
},
"retainedBackups": {
"description": "Depending on the value of retention_unit, this is used to determine if a backup needs to be deleted. If retention_unit is 'COUNT', we will retain this many backups.",
"format": "int32",
"type": "integer"
}
},
"description": "We currently only support backup retention by specifying the number of backups we will retain."
},
"ApiWarning": {
"id": "ApiWarning",
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "The warning message."
},
"code": {
"description": "Code to uniquely identify the warning type.",
"enum": [
"SQL_API_WARNING_CODE_UNSPECIFIED",
"REGION_UNREACHABLE"
],
"type": "string",
"enumDescriptions": [
"An unknown or unset warning type from Cloud SQL API.",
"Warning when one or more regions are not reachable. The returned result set may be incomplete."
]
}
},
"description": "An Admin API warning message."
},
"IpConfiguration": {
"properties": {
"ipv4Enabled": {
"description": "Whether the instance is assigned a public IP address or not.",
"type": "boolean"
},
"requireSsl": {
"description": "Whether SSL connections over IP are enforced or not.",
"type": "boolean"
},
"authorizedNetworks": {
"description": "The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: *192.168.100.0/24*).",
"type": "array",
"items": {
"$ref": "AclEntry"
}
},
"privateNetwork": {
"type": "string",
"description": "The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, */projects/myProject/global/networks/default*. This setting can be updated, but it cannot be removed after it is set."
}
},
"description": "IP Management configuration.",
"type": "object",
"id": "IpConfiguration"
},
"SqlServerDatabaseDetails": {
"id": "SqlServerDatabaseDetails",
"description": "Represents a Sql Server database on the Cloud SQL instance.",
"properties": {
"compatibilityLevel": {
"format": "int32",
"description": "The version of SQL Server with which the database is to be made compatible",
"type": "integer"
},
"recoveryModel": {
"type": "string",
"description": "The recovery model of a SQL Server database"
}
},
"type": "object"
},
"RotateServerCaContext": {
"properties": {
"nextVersion": {
"description": "The fingerprint of the next version to be rotated to. If left unspecified, will be rotated to the most recently added server CA version.",
"type": "string"
},
"kind": {
"type": "string",
"description": "This is always *sql#rotateServerCaContext*."
}
},
"type": "object",
"description": "Instance rotate server CA context.",
"id": "RotateServerCaContext"
},
"InstancesExportRequest": {
"properties": {
"exportContext": {
"description": "Contains details about the export operation.",
"$ref": "ExportContext"
}
},
"id": "InstancesExportRequest",
"type": "object",
"description": "Database instance export request."
},
"InstancesImportRequest": {
"id": "InstancesImportRequest",
"type": "object",
"properties": {
"importContext": {
"$ref": "ImportContext",
"description": "Contains details about the import operation."
}
},
"description": "Database instance import request."
},
"DatabaseFlags": {
"properties": {
"value": {
"type": "string",
"description": "The value of the flag. Booleans are set to *on* for true and *off* for false. This field must be omitted if the flag doesn't take a value."
},
"name": {
"type": "string",
"description": "The name of the flag. These flags are passed at instance startup, so include both server options and system variables for MySQL. Flags are specified with underscores, not hyphens. For more information, see Configuring Database Flags in the Cloud SQL documentation."
}
},
"description": "Database flags for Cloud SQL instances.",
"id": "DatabaseFlags",
"type": "object"
},
"SslCertsListResponse": {
"description": "SslCerts list response.",
"properties": {
"kind": {
"type": "string",
"description": "This is always *sql#sslCertsList*."
},
"items": {
"type": "array",
"description": "List of client certificates for the instance.",
"items": {
"$ref": "SslCert"
}
}
},
"id": "SslCertsListResponse",
"type": "object"
},
"BinLogCoordinates": {
"type": "object",
"properties": {
"binLogPosition": {
"format": "int64",
"type": "string",
"description": "Position (offset) within the binary log file."
},
"kind": {
"description": "This is always *sql#binLogCoordinates*.",
"type": "string"
},
"binLogFileName": {
"description": "Name of the binary log file for a Cloud SQL instance.",
"type": "string"
}
},
"description": "Binary log coordinates.",
"id": "BinLogCoordinates"
},
"MaintenanceWindow": {
"type": "object",
"id": "MaintenanceWindow",
"properties": {
"kind": {
"type": "string",
"description": "This is always *sql#maintenanceWindow*."
},
"hour": {
"description": "hour of day - 0 to 23.",
"format": "int32",
"type": "integer"
},
"day": {
"description": "day of week (1-7), starting on Monday.",
"type": "integer",
"format": "int32"
},
"updateTrack": {
"type": "string",
"enumDescriptions": [
"This is an unknown maintenance timing preference.",
"For instance update that requires a restart, this update track indicates your instance prefer to restart for new version early in maintenance window.",
"For instance update that requires a restart, this update track indicates your instance prefer to let Cloud SQL choose the timing of restart (within its Maintenance window, if applicable)."
],
"enum": [
"SQL_UPDATE_TRACK_UNSPECIFIED",
"canary",
"stable"
],
"description": "Maintenance timing setting: *canary* (Earlier) or *stable* (Later). Learn more."
}
},
"description": "Maintenance window. This specifies when a Cloud SQL instance is restarted for system maintenance purposes."
},
"InstancesListResponse": {
"id": "InstancesListResponse",
"description": "Database instances list response.",
"type": "object",
"properties": {
"items": {
"items": {
"$ref": "DatabaseInstance"
},
"type": "array",
"description": "List of database instance resources."
},
"kind": {
"type": "string",
"description": "This is always *sql#instancesList*."
},
"nextPageToken": {
"description": "The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.",
"type": "string"
},
"warnings": {
"description": "List of warnings that occurred while handling the request.",
"type": "array",
"items": {
"$ref": "ApiWarning"
}
}
}
},
"TiersListResponse": {
"id": "TiersListResponse",
"type": "object",
"properties": {
"kind": {
"description": "This is always *sql#tiersList*.",
"type": "string"
},
"items": {
"items": {
"$ref": "Tier"
},
"type": "array",
"description": "List of tiers."
}
},
"description": "Tiers list response."
},
"Reschedule": {
"type": "object",
"properties": {
"scheduleTime": {
"description": "Optional. Timestamp when the maintenance shall be rescheduled to if reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.",
"type": "string",
"format": "google-datetime"
},
"rescheduleType": {
"type": "string",
"enumDescriptions": [
"",
"If the user wants to schedule the maintenance to happen now.",
"If the user wants to use the existing maintenance policy to find the next available window.",
"If the user wants to reschedule the maintenance to a specific time."
],
"enum": [
"RESCHEDULE_TYPE_UNSPECIFIED",
"IMMEDIATE",
"NEXT_AVAILABLE_WINDOW",
"SPECIFIC_TIME"
],
"description": "Required. The type of the reschedule."
}
},
"id": "Reschedule"
},
"CloneContext": {
"id": "CloneContext",
"description": "Database instance clone context.",
"properties": {
"binLogCoordinates": {
"$ref": "BinLogCoordinates",
"description": "Binary log coordinates, if specified, identify the position up to which the source instance is cloned. If not specified, the source instance is cloned up to the most recent binary log coordinates."
},
"destinationInstanceName": {
"description": "Name of the Cloud SQL instance to be created as a clone.",
"type": "string"
},
"pointInTime": {
"type": "string",
"description": "Reserved for future use.",
"format": "google-datetime"
},
"pitrTimestampMs": {
"type": "string",
"description": "Reserved for future use.",
"format": "int64"
},
"kind": {
"type": "string",
"description": "This is always *sql#cloneContext*."
}
},
"type": "object"
},
"DemoteMasterConfiguration": {
"description": "Read-replica configuration for connecting to the on-premises primary instance.",
"id": "DemoteMasterConfiguration",
"type": "object",
"properties": {
"mysqlReplicaConfiguration": {
"$ref": "DemoteMasterMySqlReplicaConfiguration",
"description": "MySQL specific configuration when replicating from a MySQL on-premises primary instance. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named *master.info* in the data directory."
},
"kind": {
"type": "string",
"description": "This is always *sql#demoteMasterConfiguration*."
}
}
},
"Database": {
"description": "Represents a SQL database on the Cloud SQL instance.",
"type": "object",
"id": "Database",
"properties": {
"etag": {
"description": "This field is deprecated and will be removed from a future version of the API.",
"type": "string"
},
"name": {
"type": "string",
"description": "The name of the database in the Cloud SQL instance. This does not include the project ID or instance name."
},
"charset": {
"description": "The Cloud SQL charset value.",
"type": "string"
},
"collation": {
"description": "The Cloud SQL collation value.",
"type": "string"
},
"project": {
"type": "string",
"description": "The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable."
},
"sqlserverDatabaseDetails": {
"$ref": "SqlServerDatabaseDetails"
},
"instance": {
"description": "The name of the Cloud SQL instance. This does not include the project ID.",
"type": "string"
},
"kind": {
"description": "This is always *sql#database*.",
"type": "string"
},
"selfLink": {
"description": "The URI of this resource.",
"type": "string"
}
}
},
"SqlScheduledMaintenance": {
"description": "Any scheduled maintenancce for this instance.",
"type": "object",
"id": "SqlScheduledMaintenance",
"properties": {
"canReschedule": {
"type": "boolean",
"description": "If the scheduled maintenance can be rescheduled."
},
"canDefer": {
"type": "boolean"
},
"startTime": {
"type": "string",
"format": "google-datetime",
"description": "The start time of any upcoming scheduled maintenance for this instance."
}
}
},
"SqlActiveDirectoryConfig": {
"description": "Active Directory configuration, relevant only for Cloud SQL for SQL Server.",
"id": "SqlActiveDirectoryConfig",
"type": "object",
"properties": {
"kind": {
"description": "This is always sql#activeDirectoryConfig.",
"type": "string"
},
"domain": {
"description": "The name of the domain (e.g., mydomain.com).",
"type": "string"
}
}
},
"InstancesCloneRequest": {
"type": "object",
"id": "InstancesCloneRequest",
"properties": {
"cloneContext": {
"description": "Contains details about the clone operation.",
"$ref": "CloneContext"
}
},
"description": "Database instance clone request."
},
"InstancesRotateServerCaRequest": {
"description": "Rotate Server CA request.",
"type": "object",
"properties": {
"rotateServerCaContext": {
"description": "Contains details about the rotate server CA operation.",
"$ref": "RotateServerCaContext"
}
},
"id": "InstancesRotateServerCaRequest"
}
},
"canonicalName": "SQL Admin",
"name": "sqladmin",
"kind": "discovery#restDescription",
"title": "Cloud SQL Admin API",
"basePath": "",
"discoveryVersion": "v1",
"version": "v1beta4"
}