Google Git
Sign in
code / google-api-go-client / aaf7193ea9c397b5b60ab9749b85f36955d3b2be / . / sql / v1beta4 / sql-api.json
blob: fb70a6f575d9b13bc383769a9886f6997dd94221 [file] [log] [blame]
{
"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"
}
}
}
},
"basePath": "",
"baseUrl": "https://sqladmin.googleapis.com/",
"batchPath": "batch",
"canonicalName": "SQL Admin",
"description": "API for Cloud SQL database instance management",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/cloud-sql/",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "sql:v1beta4",
"kind": "discovery#restDescription",
"name": "sql",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"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",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"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.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"backupRuns": {
"methods": {
"delete": {
"description": "Deletes the backup taken by a backup run.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/backupRuns/{id}",
"httpMethod": "DELETE",
"id": "sql.backupRuns.delete",
"parameterOrder": [
"project",
"instance",
"id"
],
"parameters": {
"id": {
"description": "The ID of the Backup Run to delete. To find a Backup Run ID, use the \u003ca\nhref=\"/sql/docs/db_path/admin-api/rest/v1beta4/backupRuns/list\"\u003elist\u003c/a\u003e\nmethod.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
},
"resourceName": {
"description": "The name of the backupRun to delete.\nFormat:\nprojects/{project}/locations/{location}/instances/{instance}/backupRuns/{backupRun}",
"location": "query",
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/backupRuns/{id}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"get": {
"description": "Retrieves a resource containing information about a backup run.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/backupRuns/{id}",
"httpMethod": "GET",
"id": "sql.backupRuns.get",
"parameterOrder": [
"project",
"instance",
"id"
],
"parameters": {
"id": {
"description": "The ID of this Backup Run.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
},
"resourceName": {
"description": "Name of the resource backupRun.\nFormat:\nprojects/{project}/locations/{location}/instances/{instance}/backupRuns/{backupRun}",
"location": "query",
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/backupRuns/{id}",
"response": {
"$ref": "BackupRun"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"insert": {
"description": "Creates a new backup run on demand. This method is applicable only to\nSecond Generation instances.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/backupRuns",
"httpMethod": "POST",
"id": "sql.backupRuns.insert",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent resource where Cloud SQL should create this backupRun.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/backupRuns",
"request": {
"$ref": "BackupRun"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"list": {
"description": "Lists all backup runs associated with a given instance and configuration in\nthe reverse chronological order of the backup initiation time.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/backupRuns",
"httpMethod": "GET",
"id": "sql.backupRuns.list",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"maxResults": {
"description": "Maximum number of backup runs per response.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A previously-returned page token representing part of the larger set of\nresults to view.",
"location": "query",
"type": "string"
},
"parent": {
"description": "The parent, which owns this collection of backupRuns.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/backupRuns",
"response": {
"$ref": "BackupRunsListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
}
}
},
"databases": {
"methods": {
"delete": {
"description": "Deletes a database from a Cloud SQL instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/databases/{database}",
"httpMethod": "DELETE",
"id": "sql.databases.delete",
"parameterOrder": [
"project",
"instance",
"database"
],
"parameters": {
"database": {
"description": "Name of the database to be deleted in the instance.",
"location": "path",
"required": true,
"type": "string"
},
"instance": {
"description": "Database instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
},
"resourceName": {
"description": "The name of the database to delete.\nFormat:\nprojects/{project}/locations/{location}/instances/{instance}/databases/{database}",
"location": "query",
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/databases/{database}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"get": {
"description": "Retrieves a resource containing information about a database inside a Cloud\nSQL instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/databases/{database}",
"httpMethod": "GET",
"id": "sql.databases.get",
"parameterOrder": [
"project",
"instance",
"database"
],
"parameters": {
"database": {
"description": "Name of the database in the instance.",
"location": "path",
"required": true,
"type": "string"
},
"instance": {
"description": "Database instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
},
"resourceName": {
"description": "Name of the resource database.\nFormat:\nprojects/{project}/locations/{location}/instances/{instance}/databases/{database}",
"location": "query",
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/databases/{database}",
"response": {
"$ref": "Database"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"insert": {
"description": "Inserts a resource containing information about a database inside a Cloud\nSQL instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/databases",
"httpMethod": "POST",
"id": "sql.databases.insert",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Database instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent resource where Cloud SQL should add this database.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/databases",
"request": {
"$ref": "Database"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"list": {
"description": "Lists databases in the specified Cloud SQL instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/databases",
"httpMethod": "GET",
"id": "sql.databases.list",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent, which owns this collection of databases.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/databases",
"response": {
"$ref": "DatabasesListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"patch": {
"description": "Partially updates a resource containing information about a database inside\na Cloud SQL instance. This method supports patch semantics.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/databases/{database}",
"httpMethod": "PATCH",
"id": "sql.databases.patch",
"parameterOrder": [
"project",
"instance",
"database"
],
"parameters": {
"database": {
"description": "Name of the database to be updated in the instance.",
"location": "path",
"required": true,
"type": "string"
},
"instance": {
"description": "Database instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
},
"resourceName": {
"description": "The name of the database for Cloud SQL to update.\nFormat:\nprojects/{project}/locations/{location}/instances/{instance}/databases/{database}",
"location": "query",
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/databases/{database}",
"request": {
"$ref": "Database"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"update": {
"description": "Updates a resource containing information about a database inside a Cloud\nSQL instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/databases/{database}",
"httpMethod": "PUT",
"id": "sql.databases.update",
"parameterOrder": [
"project",
"instance",
"database"
],
"parameters": {
"database": {
"description": "Name of the database to be updated in the instance.",
"location": "path",
"required": true,
"type": "string"
},
"instance": {
"description": "Database instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
},
"resourceName": {
"description": "The name of the database for Cloud SQL to update.\nFormat:\nprojects/{project}/locations/{location}/instances/{instance}/databases/{database}",
"location": "query",
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/databases/{database}",
"request": {
"$ref": "Database"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
}
}
},
"flags": {
"methods": {
"list": {
"description": "List all available database flags for Cloud SQL instances.",
"flatPath": "sql/v1beta4/flags",
"httpMethod": "GET",
"id": "sql.flags.list",
"parameterOrder": [],
"parameters": {
"databaseVersion": {
"description": "Database type and version you want to retrieve flags for. By default, this\nmethod returns flags for all database types and versions.",
"location": "query",
"type": "string"
}
},
"path": "sql/v1beta4/flags",
"response": {
"$ref": "FlagsListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
}
}
},
"instances": {
"methods": {
"addServerCa": {
"description": "Add a new trusted Certificate Authority (CA) version for the specified\ninstance. Required to prepare for a certificate rotation. If a CA version\nwas previously added but never used in a certificate rotation, this\noperation replaces that version. There cannot be more than one CA version\nwaiting to be rotated in.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/addServerCa",
"httpMethod": "POST",
"id": "sql.instances.addServerCa",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent resource where Cloud SQL should add this server CA.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/addServerCa",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"clone": {
"description": "Creates a Cloud SQL instance as a clone of the source instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/clone",
"httpMethod": "POST",
"id": "sql.instances.clone",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "The ID of the Cloud SQL instance to be cloned (source). This does not\ninclude the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent resource where Cloud SQL should clone this instance.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the source as well as the clone Cloud SQL instance.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/clone",
"request": {
"$ref": "InstancesCloneRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"delete": {
"description": "Deletes a Cloud SQL instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}",
"httpMethod": "DELETE",
"id": "sql.instances.delete",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance to be deleted.",
"location": "path",
"required": true,
"type": "string"
},
"resourceName": {
"description": "The name of database instance to delete.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"demoteMaster": {
"description": "Demotes the stand-alone instance to be a Cloud SQL read replica for an\nexternal database server.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/demoteMaster",
"httpMethod": "POST",
"id": "sql.instances.demoteMaster",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance name.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent resource where Cloud SQL demotes this master database instance.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/demoteMaster",
"request": {
"$ref": "InstancesDemoteMasterRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"export": {
"description": "Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL\ndump or CSV file.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/export",
"httpMethod": "POST",
"id": "sql.instances.export",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent resource where Cloud SQL exports this database instance.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance to be exported.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/export",
"request": {
"$ref": "InstancesExportRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"failover": {
"description": "Failover the instance to its failover replica instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/failover",
"httpMethod": "POST",
"id": "sql.instances.failover",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent resource where Cloud SQL sends this database instance during a\nfailover. Format:\nprojects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "ID of the project that contains the read replica.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/failover",
"request": {
"$ref": "InstancesFailoverRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"get": {
"description": "Retrieves a resource containing information about a Cloud SQL instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}",
"httpMethod": "GET",
"id": "sql.instances.get",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Database instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
},
"resourceName": {
"description": "Name of the resource database instance.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}",
"response": {
"$ref": "DatabaseInstance"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"import": {
"description": "Imports data into a Cloud SQL instance from a SQL dump or CSV file in\nCloud Storage.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/import",
"httpMethod": "POST",
"id": "sql.instances.import",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent resource where Cloud SQL imports this database instance.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/import",
"request": {
"$ref": "InstancesImportRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"insert": {
"description": "Creates a new Cloud SQL instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances",
"httpMethod": "POST",
"id": "sql.instances.insert",
"parameterOrder": [
"project"
],
"parameters": {
"parent": {
"description": "The parent resource where Cloud SQL creates this database instance.\nFormat: projects/{project}/locations/{location}",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the project to which the newly created Cloud SQL instances\nshould belong.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances",
"request": {
"$ref": "DatabaseInstance"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"list": {
"description": "Lists instances under a given project in the alphabetical order of the\ninstance name.",
"flatPath": "sql/v1beta4/projects/{project}/instances",
"httpMethod": "GET",
"id": "sql.instances.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "An expression for filtering the results of the request, such as by name or\nlabel.",
"location": "query",
"type": "string"
},
"maxResults": {
"description": "The maximum number of results to return per response.",
"format": "uint32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A previously-returned page token representing part of the larger set of\nresults to view.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the project for which to list Cloud SQL instances.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances",
"response": {
"$ref": "InstancesListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"listServerCas": {
"description": "Lists all of the trusted Certificate Authorities (CAs) for the specified\ninstance. There can be up to three CAs listed: the CA that was used to sign\nthe certificate that is currently in use, a CA that has been added but not\nyet used to sign a certificate, and a CA used to sign a certificate that\nhas previously rotated out.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/listServerCas",
"httpMethod": "GET",
"id": "sql.instances.listServerCas",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent, which owns this collection of server CAs.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/listServerCas",
"response": {
"$ref": "InstancesListServerCasResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"patch": {
"description": "Updates settings of a Cloud SQL instance.\nThis method supports patch semantics.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}",
"httpMethod": "PATCH",
"id": "sql.instances.patch",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
},
"resourceName": {
"description": "The name of the database instance for Cloud SQL to update.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}",
"request": {
"$ref": "DatabaseInstance"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"promoteReplica": {
"description": "Promotes the read replica instance to be a stand-alone Cloud SQL instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/promoteReplica",
"httpMethod": "POST",
"id": "sql.instances.promoteReplica",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL read replica instance name.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent resource where Cloud SQL promotes this replica database\ninstance. Format: projects/{project}/locations/{location}",
"location": "query",
"type": "string"
},
"project": {
"description": "ID of the project that contains the read replica.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/promoteReplica",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"resetSslConfig": {
"description": "Deletes all client certificates and generates a new server SSL certificate\nfor the instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/resetSslConfig",
"httpMethod": "POST",
"id": "sql.instances.resetSslConfig",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent resource where Cloud SQL resets this SSL config.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/resetSslConfig",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"restart": {
"description": "Restarts a Cloud SQL instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/restart",
"httpMethod": "POST",
"id": "sql.instances.restart",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent resource where Cloud SQL restarts this database instance.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance to be restarted.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/restart",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"restoreBackup": {
"description": "Restores a backup of a Cloud SQL instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/restoreBackup",
"httpMethod": "POST",
"id": "sql.instances.restoreBackup",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent resource where Cloud SQL restores this database instance from\nbackup. Format:\nprojects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/restoreBackup",
"request": {
"$ref": "InstancesRestoreBackupRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"rotateServerCa": {
"description": "Rotates the server certificate to one signed by the Certificate Authority\n(CA) version previously added with the addServerCA method.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/rotateServerCa",
"httpMethod": "POST",
"id": "sql.instances.rotateServerCa",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent resource where Cloud SQL rotates these server CAs.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/rotateServerCa",
"request": {
"$ref": "InstancesRotateServerCaRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"startReplica": {
"description": "Starts the replication in the read replica instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/startReplica",
"httpMethod": "POST",
"id": "sql.instances.startReplica",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL read replica instance name.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent resource where Cloud SQL starts this database instance\nreplication. Format:\nprojects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "ID of the project that contains the read replica.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/startReplica",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"stopReplica": {
"description": "Stops the replication in the read replica instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/stopReplica",
"httpMethod": "POST",
"id": "sql.instances.stopReplica",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL read replica instance name.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent resource where Cloud SQL stops this database instance\nreplication. Format:\nprojects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "ID of the project that contains the read replica.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/stopReplica",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"truncateLog": {
"description": "Truncate MySQL general and slow query log tables",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/truncateLog",
"httpMethod": "POST",
"id": "sql.instances.truncateLog",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent resource where Cloud SQL truncates this log.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the Cloud SQL project.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/truncateLog",
"request": {
"$ref": "InstancesTruncateLogRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"update": {
"description": "Updates settings of a Cloud SQL instance. \u003caside\nclass=\"caution\"\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e This is not a partial update, so\nyou must include values for all the settings that you want to retain. For\npartial updates, use \u003ca\nhref=\"/sql/docs/db_path/admin-api/rest/v1beta4/instances/patch\"\u003epatch\u003c/a\u003e.\u003c/aside\u003e",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}",
"httpMethod": "PUT",
"id": "sql.instances.update",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
},
"resourceName": {
"description": "The name of the database instance for Cloud SQL to update.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}",
"request": {
"$ref": "DatabaseInstance"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
}
}
},
"operations": {
"methods": {
"get": {
"description": "Retrieves an instance operation that has been performed on an instance.",
"flatPath": "sql/v1beta4/projects/{project}/operations/{operation}",
"httpMethod": "GET",
"id": "sql.operations.get",
"parameterOrder": [
"project",
"operation"
],
"parameters": {
"operation": {
"description": "Instance operation ID.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/operations/{operation}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"list": {
"description": "Lists all instance operations that have been performed on the given Cloud\nSQL instance in the reverse chronological order of the start time.",
"flatPath": "sql/v1beta4/projects/{project}/operations",
"httpMethod": "GET",
"id": "sql.operations.list",
"parameterOrder": [
"project"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "query",
"type": "string"
},
"maxResults": {
"description": "Maximum number of operations per response.",
"format": "uint32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A previously-returned page token representing part of the larger set of\nresults to view.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Indirect parent. The direct parent should combine with the instance name,\nwhich owns this collection of operations.\nFormat:\nprojects/{project}/locations/{location}",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/operations",
"response": {
"$ref": "OperationsListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
}
}
},
"sslCerts": {
"methods": {
"createEphemeral": {
"description": "Generates a short-lived X509 certificate containing the provided public key\nand signed by a private key specific to the target instance. Users may use\nthe certificate to authenticate as themselves when connecting to the\ndatabase.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/createEphemeral",
"httpMethod": "POST",
"id": "sql.sslCerts.createEphemeral",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent resource where Cloud SQL creates this ephemeral certificate.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the Cloud SQL project.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/createEphemeral",
"request": {
"$ref": "SslCertsCreateEphemeralRequest"
},
"response": {
"$ref": "SslCert"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"delete": {
"description": "Deletes the SSL certificate. For First Generation instances, the\ncertificate remains valid until the instance is restarted.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/sslCerts/{sha1Fingerprint}",
"httpMethod": "DELETE",
"id": "sql.sslCerts.delete",
"parameterOrder": [
"project",
"instance",
"sha1Fingerprint"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
},
"resourceName": {
"description": "The name of SSL certificate to delete.\nFormat:\nprojects/{project}/locations/{location}/instances/{instance}/sslCerts/{sslCert}",
"location": "query",
"type": "string"
},
"sha1Fingerprint": {
"description": "Sha1 FingerPrint.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/sslCerts/{sha1Fingerprint}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"get": {
"description": "Retrieves a particular SSL certificate. Does not include the private key\n(required for usage). The private key must be saved from the response to\ninitial creation.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/sslCerts/{sha1Fingerprint}",
"httpMethod": "GET",
"id": "sql.sslCerts.get",
"parameterOrder": [
"project",
"instance",
"sha1Fingerprint"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
},
"resourceName": {
"description": "Name of the resource ssl certificate.\nFormat:\nprojects/{project}/locations/{location}/instances/{instance}/sslCerts/{sslCert}",
"location": "query",
"type": "string"
},
"sha1Fingerprint": {
"description": "Sha1 FingerPrint.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/sslCerts/{sha1Fingerprint}",
"response": {
"$ref": "SslCert"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"insert": {
"description": "Creates an SSL certificate and returns it along with the private key and\nserver certificate authority. The new certificate will not be usable until\nthe instance is restarted.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/sslCerts",
"httpMethod": "POST",
"id": "sql.sslCerts.insert",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent resource where Cloud SQL creates this SSL certificate.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/sslCerts",
"request": {
"$ref": "SslCertsInsertRequest"
},
"response": {
"$ref": "SslCertsInsertResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"list": {
"description": "Lists all of the current SSL certificates for the instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/sslCerts",
"httpMethod": "GET",
"id": "sql.sslCerts.list",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent, which owns this collection of SSL certificates.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/sslCerts",
"response": {
"$ref": "SslCertsListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
}
}
},
"tiers": {
"methods": {
"list": {
"description": "Lists all available machine types (tiers) for Cloud SQL, for example,\ndb-n1-standard-1. For related information, see \u003ca\nhref=\"/sql/pricing\"\u003ePricing\u003c/a\u003e.",
"flatPath": "sql/v1beta4/projects/{project}/tiers",
"httpMethod": "GET",
"id": "sql.tiers.list",
"parameterOrder": [
"project"
],
"parameters": {
"project": {
"description": "Project ID of the project for which to list tiers.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/tiers",
"response": {
"$ref": "TiersListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
}
}
},
"users": {
"methods": {
"delete": {
"description": "Deletes a user from a Cloud SQL instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/users",
"httpMethod": "DELETE",
"id": "sql.users.delete",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"host": {
"description": "Host of the user in the instance.",
"location": "query",
"type": "string"
},
"instance": {
"description": "Database instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"name": {
"description": "Name of the user in the instance.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
},
"resourceName": {
"description": "The name of the user to delete.\nFormat: projects/{project}/locations/{location}/instances/{instance}/users",
"location": "query",
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/users",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"insert": {
"description": "Creates a new user in a Cloud SQL instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/users",
"httpMethod": "POST",
"id": "sql.users.insert",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Database instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent resource where Cloud SQL creates this user.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/users",
"request": {
"$ref": "User"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"list": {
"description": "Lists users in the specified Cloud SQL instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/users",
"httpMethod": "GET",
"id": "sql.users.list",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Database instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent, which owns this collection of users.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/users",
"response": {
"$ref": "UsersListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"update": {
"description": "Updates an existing user in a Cloud SQL instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/users",
"httpMethod": "PUT",
"id": "sql.users.update",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"host": {
"description": "Host of the user in the instance. For a MySQL instance, it's required; For\na PostgreSQL instance, it's optional.",
"location": "query",
"type": "string"
},
"instance": {
"description": "Database instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"name": {
"description": "Name of the user in the instance.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
},
"resourceName": {
"description": "The name of the user for Cloud SQL to update.\nFormat: projects/{project}/locations/{location}/instances/{instance}/users",
"location": "query",
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/users",
"request": {
"$ref": "User"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
}
}
}
},
"revision": "20191029",
"rootUrl": "https://sqladmin.googleapis.com/",
"schemas": {
"AclEntry": {
"description": "An entry for an Access Control list.",
"id": "AclEntry",
"properties": {
"expirationTime": {
"description": "The time when this access control entry expires in \u003ca\nhref=\"https://tools.ietf.org/html/rfc3339\"\u003eRFC 3339\u003c/a\u003e format, for example\n\u003ccode\u003e2012-11-15T16:19:00.094Z\u003c/code\u003e.",
"format": "google-datetime",
"type": "string"
},
"kind": {
"description": "This is always \u003ccode\u003esql#aclEntry\u003c/code\u003e.",
"type": "string"
},
"name": {
"description": "An optional label to identify this entry.",
"type": "string"
},
"value": {
"description": "The whitelisted value for the access control list.",
"type": "string"
}
},
"type": "object"
},
"ApiWarning": {
"description": "An Admin API warning message.",
"id": "ApiWarning",
"properties": {
"code": {
"description": "Code to uniquely identify the warning type.",
"enum": [
"SQL_API_WARNING_CODE_UNSPECIFIED",
"REGION_UNREACHABLE"
],
"enumDescriptions": [
"An unknown or unset warning type from Cloud SQL API.",
"Warning when one or more regions are not reachable. The returned result\nset may be incomplete."
],
"type": "string"
},
"message": {
"description": "The warning message.",
"type": "string"
}
},
"type": "object"
},
"BackupConfiguration": {
"description": "Database instance backup configuration.",
"id": "BackupConfiguration",
"properties": {
"binaryLogEnabled": {
"description": "Whether binary log is enabled. If backup configuration is disabled, binary\nlog must be disabled as well.",
"type": "boolean"
},
"enabled": {
"description": "Whether this configuration is enabled.",
"type": "boolean"
},
"kind": {
"description": "This is always \u003ccode\u003esql#backupConfiguration\u003c/code\u003e.",
"type": "string"
},
"location": {
"description": "Location of the backup",
"type": "string"
},
"replicationLogArchivingEnabled": {
"description": "Reserved for future use.",
"type": "boolean"
},
"startTime": {
"description": "Start time for the daily backup configuration in UTC timezone in the 24\nhour format - \u003ccode\u003eHH:MM\u003c/code\u003e.",
"type": "string"
}
},
"type": "object"
},
"BackupRun": {
"description": "A BackupRun resource.",
"id": "BackupRun",
"properties": {
"description": {
"description": "The description of this run, only applicable to on-demand backups.",
"type": "string"
},
"diskEncryptionConfiguration": {
"$ref": "DiskEncryptionConfiguration",
"description": "Encryption configuration specific to a backup.\nApplies only to Second Generation instances."
},
"diskEncryptionStatus": {
"$ref": "DiskEncryptionStatus",
"description": "Encryption status specific to a backup.\nApplies only to Second Generation instances."
},
"endTime": {
"description": "The time the backup operation completed in UTC timezone in \u003ca\nhref=\"https://tools.ietf.org/html/rfc3339\"\u003eRFC 3339\u003c/a\u003e format, for example\n\u003ccode\u003e2012-11-15T16:19:00.094Z\u003c/code\u003e.",
"format": "google-datetime",
"type": "string"
},
"enqueuedTime": {
"description": "The time the run was enqueued in UTC timezone in \u003ca\nhref=\"https://tools.ietf.org/html/rfc3339\"\u003eRFC 3339\u003c/a\u003e format, for example\n\u003ccode\u003e2012-11-15T16:19:00.094Z\u003c/code\u003e.",
"format": "google-datetime",
"type": "string"
},
"error": {
"$ref": "OperationError",
"description": "Information about why the backup operation failed. This is only present if\nthe run has the FAILED status."
},
"id": {
"description": "The identifier for this backup run. Unique only for a specific Cloud SQL\ninstance.",
"format": "int64",
"type": "string"
},
"instance": {
"description": "Name of the database instance.",
"type": "string"
},
"kind": {
"description": "This is always \u003ccode\u003esql#backupRun\u003c/code\u003e.",
"type": "string"
},
"location": {
"description": "Location of the backups.",
"type": "string"
},
"selfLink": {
"description": "The URI of this resource.",
"type": "string"
},
"startTime": {
"description": "The time the backup operation actually started in UTC timezone in \u003ca\nhref=\"https://tools.ietf.org/html/rfc3339\"\u003eRFC 3339\u003c/a\u003e format, for example\n\u003ccode\u003e2012-11-15T16:19:00.094Z\u003c/code\u003e.",
"format": "google-datetime",
"type": "string"
},
"status": {
"description": "The status of this run.",
"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\nproblem. Example: Long-running operation in progress during\nthe whole window.",
"The backup is in progress.",
"The backup failed.",
"The backup was successful.",
"The backup was skipped (without problems) for a given backup\nwindow. Example: Instance was idle.",
"The backup is about to be deleted.",
"The backup deletion failed.",
"The backup has been deleted."
],
"type": "string"
},
"type": {
"description": "The type of this run; can be either \"AUTOMATED\" or \"ON_DEMAND\".",
"enum": [
"SQL_BACKUP_RUN_TYPE_UNSPECIFIED",
"AUTOMATED",
"ON_DEMAND"
],
"enumDescriptions": [
"This is an unknown BackupRun type.",
"The backup schedule automatically triggers a backup.",
"The user manually triggers a backup."
],
"type": "string"
},
"windowStartTime": {
"description": "The start time of the backup window during which this the backup was\nattempted in \u003ca href=\"https://tools.ietf.org/html/rfc3339\"\u003eRFC 3339\u003c/a\u003e\nformat, for example \u003ccode\u003e2012-11-15T16:19:00.094Z\u003c/code\u003e.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"BackupRunsListResponse": {
"description": "Backup run list results.",
"id": "BackupRunsListResponse",
"properties": {
"items": {
"description": "A list of backup runs in reverse chronological order of the enqueued time.",
"items": {
"$ref": "BackupRun"
},
"type": "array"
},
"kind": {
"description": "This is always \u003ccode\u003esql#backupRunsList\u003c/code\u003e.",
"type": "string"
},
"nextPageToken": {
"description": "The continuation token, used to page through large result sets. Provide\nthis value in a subsequent request to return the next page of results.",
"type": "string"
}
},
"type": "object"
},
"BinLogCoordinates": {
"description": "Binary log coordinates.",
"id": "BinLogCoordinates",
"properties": {
"binLogFileName": {
"description": "Name of the binary log file for a Cloud SQL instance.",
"type": "string"
},
"binLogPosition": {
"description": "Position (offset) within the binary log file.",
"format": "int64",
"type": "string"
},
"kind": {
"description": "This is always \u003ccode\u003esql#binLogCoordinates\u003c/code\u003e.",
"type": "string"
}
},
"type": "object"
},
"CloneContext": {
"description": "Database instance clone context.",
"id": "CloneContext",
"properties": {
"binLogCoordinates": {
"$ref": "BinLogCoordinates",
"description": "Binary log coordinates, if specified, identify the position up to which the\nsource instance should be cloned. If not specified, the source instance is\ncloned up to the most recent binary log coordinates."
},
"destinationInstanceName": {
"description": "Name of the Cloud SQL instance to be created as a clone.",
"type": "string"
},
"kind": {
"description": "This is always \u003ccode\u003esql#cloneContext\u003c/code\u003e.",
"type": "string"
},
"pitrTimestampMs": {
"description": "Reserved for future use.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"Database": {
"description": "Represents a SQL database on the Cloud SQL instance.",
"id": "Database",
"properties": {
"charset": {
"description": "The MySQL charset value.",
"type": "string"
},
"collation": {
"description": "The MySQL collation value.",
"type": "string"
},
"etag": {
"description": "This field is deprecated and will be removed from a future version of the\nAPI.",
"type": "string"
},
"instance": {
"description": "The name of the Cloud SQL instance. This does not include the project ID.",
"type": "string"
},
"kind": {
"description": "This is always \u003ccode\u003esql#database\u003c/code\u003e.",
"type": "string"
},
"name": {
"description": "The name of the database in the Cloud SQL instance. This does not include\nthe project ID or instance name.",
"type": "string"
},
"project": {
"description": "The project ID of the project containing the Cloud SQL database. The Google\napps domain is prefixed if applicable.",
"type": "string"
},
"selfLink": {
"description": "The URI of this resource.",
"type": "string"
},
"sqlserverDatabaseDetails": {
"$ref": "SqlServerDatabaseDetails"
}
},
"type": "object"
},
"DatabaseFlags": {
"description": "Database flags for Cloud SQL instances.",
"id": "DatabaseFlags",
"properties": {
"name": {
"description": "The name of the flag. These flags are passed at instance startup, so\ninclude both server options and system variables for MySQL. Flags should be\nspecified with underscores, not hyphens. For more information, see \u003ca\nhref=\"/sql/docs/mysql/flags\"\u003eConfiguring Database Flags\u003c/a\u003e in the Cloud\nSQL documentation.",
"type": "string"
},
"value": {
"description": "The value of the flag. Booleans should be set to \u003ccode\u003eon\u003c/code\u003e for true\nand \u003ccode\u003eoff\u003c/code\u003e for false. This field must be omitted if the flag\ndoesn't take a value.",
"type": "string"
}
},
"type": "object"
},
"DatabaseInstance": {
"description": "A Cloud SQL instance resource.\nIf you change this, also change SqlDatabaseInstance",
"id": "DatabaseInstance",
"properties": {
"backendType": {
"description": "\u003ccode\u003eFIRST_GEN\u003c/code\u003e: First Generation instance. MySQL only. \u003cbr\n/\u003e\u003ccode\u003eSECOND_GEN\u003c/code\u003e: Second Generation instance or PostgreSQL\ninstance. \u003cbr /\u003e\u003ccode\u003eEXTERNAL\u003c/code\u003e: A database server that is not\nmanaged by Google. \u003cbr\u003eThis property is read-only; use the\n\u003ccode\u003etier\u003c/code\u003e property in the \u003ccode\u003esettings\u003c/code\u003e object to determine\nthe database type and Second or First Generation.",
"enum": [
"SQL_BACKEND_TYPE_UNSPECIFIED",
"FIRST_GEN",
"SECOND_GEN",
"EXTERNAL"
],
"enumDescriptions": [
"This is an unknown backend type for instance.",
"V1 speckle instance.",
"V2 speckle instance.",
"On premises instance."
],
"type": "string"
},
"connectionName": {
"description": "Connection name of the Cloud SQL instance used in connection strings.",
"type": "string"
},
"currentDiskSize": {
"description": "The current disk usage of the instance in bytes. This property has been\ndeprecated. Users should use the\n\"cloudsql.googleapis.com/database/disk/bytes_used\" metric in Cloud\nMonitoring API instead. Please see \u003ca\nhref=\"https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ\"\u003ethis\nannouncement\u003c/a\u003e for details.",
"format": "int64",
"type": "string"
},
"databaseVersion": {
"description": "The database engine type and version. The \u003ccode\u003edatabaseVersion\u003c/code\u003e\nfield can not be changed after instance creation. MySQL Second Generation\ninstances: \u003ccode\u003eMYSQL_5_7\u003c/code\u003e (default) or \u003ccode\u003eMYSQL_5_6\u003c/code\u003e.\nPostgreSQL instances: \u003ccode\u003ePOSTGRES_9_6\u003c/code\u003e (default) or\n\u003ccode\u003ePOSTGRES_11 Beta\u003c/code\u003e MySQL First Generation\ninstances: \u003ccode\u003eMYSQL_5_6\u003c/code\u003e (default) or \u003ccode\u003eMYSQL_5_5\u003c/code\u003e",
"enum": [
"SQL_DATABASE_VERSION_UNSPECIFIED",
"OBSOLETE_MYSQL_5_0",
"MYSQL_5_1",
"MYSQL_5_5",
"MARIADB_10_0",
"MYSQL_5_6",
"MYSQL_5_7",
"OBSOLETE_POSTGRES_9_5",
"SQLSERVER_ENTERPRISE_2016",
"POSTGRES_9_6",
"POSTGRES_11",
"SQLSERVER_2017_STANDARD",
"SQLSERVER_2017_ENTERPRISE",
"SQLSERVER_2017_EXPRESS",
"SQLSERVER_2017_WEB"
],
"enumDescriptions": [
"This is an unknown database version.",
"The database version is MySQL 5.0.",
"The database version is MySQL 5.1.",
"The database version is MySQL 5.5.",
"The database version is MariaDB 10.0.",
"The database version is MySQL 5.6.",
"The database version is MySQL 5.7.",
"The database version is PostgreSQL 9.5.",
"The database version is SQL Server 2016.",
"The database version is PostgreSQL 9.6.",
"The database version is PostgreSQL 11.",
"The database version is SQL Server 2017.",
"",
"",
""
],
"type": "string"
},
"diskEncryptionConfiguration": {
"$ref": "DiskEncryptionConfiguration",
"description": "Disk encryption configuration specific to an instance.\nApplies only to Second Generation instances."
},
"diskEncryptionStatus": {
"$ref": "DiskEncryptionStatus",
"description": "Disk encryption status specific to an instance.\nApplies only to Second Generation instances."
},
"etag": {
"description": "This field is deprecated and will be removed from a future version of the\nAPI. Use the \u003ccode\u003esettings.settingsVersion\u003c/code\u003e field instead.",
"type": "string"
},
"failoverReplica": {
"description": "The name and status of the failover replica. This property is applicable\nonly to Second Generation instances.",
"properties": {
"available": {
"description": "The availability status of the failover replica. A false status indicates\nthat the failover replica is out of sync. The master can only failover to\nthe failover replica when the status is true.",
"type": "boolean"
},
"name": {
"description": "The name of the failover replica. If specified at instance creation, a\nfailover replica is created for the instance. The name\ndoesn't include the project ID. This property is applicable only to\nSecond Generation instances.",
"type": "string"
}
},
"type": "object"
},
"gceZone": {
"description": "The Compute Engine zone that the instance is currently serving from. This\nvalue could be different from the zone that was specified when the instance\nwas created if the instance has failed over to its secondary zone.",
"type": "string"
},
"instanceType": {
"description": "The instance type. This can be one of the following.\n\u003cbr\u003e\u003ccode\u003eCLOUD_SQL_INSTANCE\u003c/code\u003e: A Cloud SQL instance that is not\nreplicating from a master. \u003cbr\u003e\u003ccode\u003eON_PREMISES_INSTANCE\u003c/code\u003e: An\ninstance running on the\ncustomer's premises. \u003cbr\u003e\u003ccode\u003eREAD_REPLICA_INSTANCE\u003c/code\u003e: A Cloud SQL\ninstance configured as a read-replica.",
"enum": [
"SQL_INSTANCE_TYPE_UNSPECIFIED",
"CLOUD_SQL_INSTANCE",
"ON_PREMISES_INSTANCE",
"READ_REPLICA_INSTANCE"
],
"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\nCloud SQL.",
"A Cloud SQL instance acting as a read-replica."
],
"type": "string"
},
"ipAddresses": {
"description": "The assigned IP addresses for the instance.",
"items": {
"$ref": "IpMapping"
},
"type": "array"
},
"ipv6Address": {
"description": "The IPv6 address assigned to the instance. This property is applicable only\nto First Generation instances.",
"type": "string"
},
"kind": {
"description": "This is always \u003ccode\u003esql#instance\u003c/code\u003e.",
"type": "string"
},
"masterInstanceName": {
"description": "The name of the instance which will act as master in the replication setup.",
"type": "string"
},
"maxDiskSize": {
"description": "The maximum disk size of the instance in bytes.",
"format": "int64",
"type": "string"
},
"name": {
"description": "Name of the Cloud SQL instance. This does not include the project ID.",
"type": "string"
},
"onPremisesConfiguration": {
"$ref": "OnPremisesConfiguration",
"description": "Configuration specific to on-premises instances."
},
"project": {
"description": "The project ID of the project containing the Cloud SQL instance. The Google\napps domain is prefixed if applicable.",
"type": "string"
},
"region": {
"description": "The geographical region. Can be \u003ccode\u003eus-central\u003c/code\u003e\n(\u003ccode\u003eFIRST_GEN\u003c/code\u003e instances only), \u003ccode\u003eus-central1\u003c/code\u003e\n(\u003ccode\u003eSECOND_GEN\u003c/code\u003e instances only), \u003ccode\u003easia-east1\u003c/code\u003e or\n\u003ccode\u003eeurope-west1\u003c/code\u003e. Defaults to \u003ccode\u003eus-central\u003c/code\u003e or\n\u003ccode\u003eus-central1\u003c/code\u003e depending on the instance type (First Generation\nor Second Generation). The region can not be changed after instance\ncreation.",
"type": "string"
},
"replicaConfiguration": {
"$ref": "ReplicaConfiguration",
"description": "Configuration specific to failover replicas and read replicas."
},
"replicaNames": {
"description": "The replicas of the instance.",
"items": {
"type": "string"
},
"type": "array"
},
"rootPassword": {
"description": "Initial root password. Use only on creation.",
"type": "string"
},
"scheduledMaintenance": {
"$ref": "SqlScheduledMaintenance",
"description": "The start time of any upcoming scheduled maintenance for this instance."
},
"selfLink": {
"description": "The URI of this resource.",
"type": "string"
},
"serverCaCert": {
"$ref": "SslCert",
"description": "SSL configuration."
},
"serviceAccountEmailAddress": {
"description": "The service account email address assigned to the instance. This property\nis applicable only to Second Generation instances.",
"type": "string"
},
"settings": {
"$ref": "Settings",
"description": "The user settings."
},
"state": {
"description": "The current serving state of the Cloud SQL instance. This can be one of the\nfollowing. \u003cbr\u003e\u003ccode\u003eRUNNABLE\u003c/code\u003e: The instance is running, or is ready\nto run when accessed. \u003cbr\u003e\u003ccode\u003eSUSPENDED\u003c/code\u003e: The instance is not\navailable, for example due to problems with billing.\n\u003cbr\u003e\u003ccode\u003ePENDING_CREATE\u003c/code\u003e: The instance is being created.\n\u003cbr\u003e\u003ccode\u003eMAINTENANCE\u003c/code\u003e: The instance is down for maintenance.\n\u003cbr\u003e\u003ccode\u003eFAILED\u003c/code\u003e: The instance creation failed.\n\u003cbr\u003e\u003ccode\u003eUNKNOWN_STATE\u003c/code\u003e: The state of the instance is unknown.",
"enum": [
"SQL_INSTANCE_STATE_UNSPECIFIED",
"RUNNABLE",
"SUSPENDED",
"PENDING_DELETE",
"PENDING_CREATE",
"MAINTENANCE",
"FAILED"
],
"enumDescriptions": [
"The state of the instance is unknown.",
"The instance is running.",
"The instance is currently offline, but it may run again in the future.",
"The instance is being deleted.",
"The instance is being created.",
"The instance is down for maintenance.",
"The instance failed to be created."
],
"type": "string"
},
"suspensionReason": {
"description": "If the instance state is SUSPENDED, the reason for the suspension.",
"enumDescriptions": [
"This is an unknown suspension reason.",
"The instance is suspended due to billing issues (e.g., GCP account issue)",
"The instance is suspended due to illegal content (e.g., child pornography,\ncopyrighted material, etc.).",
"The instance is causing operational issues (e.g., causing the database\nto crash).",
"The KMS key used by the instance is either revoked or denied access to"
],
"items": {
"enum": [
"SQL_SUSPENSION_REASON_UNSPECIFIED",
"BILLING_ISSUE",
"LEGAL_ISSUE",
"OPERATIONAL_ISSUE",
"KMS_KEY_ISSUE"
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"DatabasesListResponse": {
"description": "Database list response.",
"id": "DatabasesListResponse",
"properties": {
"items": {
"description": "List of database resources in the instance.",
"items": {
"$ref": "Database"
},
"type": "array"
},
"kind": {
"description": "This is always \u003ccode\u003esql#databasesList\u003c/code\u003e.",
"type": "string"
}
},
"type": "object"
},
"DemoteMasterConfiguration": {
"description": "Read-replica configuration for connecting to the on-premises master.",
"id": "DemoteMasterConfiguration",
"properties": {
"kind": {
"description": "This is always \u003ccode\u003esql#demoteMasterConfiguration\u003c/code\u003e.",
"type": "string"
},
"mysqlReplicaConfiguration": {
"$ref": "DemoteMasterMySqlReplicaConfiguration",
"description": "MySQL specific configuration when replicating from a MySQL on-premises\nmaster. Replication configuration information such as the username,\npassword, certificates, and keys are not stored in the instance metadata.\nThe configuration information is used only to set up the replication\nconnection and is stored by MySQL in a file named \u003ccode\u003emaster.info\u003c/code\u003e\nin the data directory."
}
},
"type": "object"
},
"DemoteMasterContext": {
"description": "Database instance demote master context.",
"id": "DemoteMasterContext",
"properties": {
"kind": {
"description": "This is always \u003ccode\u003esql#demoteMasterContext\u003c/code\u003e.",
"type": "string"
},
"masterInstanceName": {
"description": "The name of the instance which will act as on-premises master in the\nreplication setup.",
"type": "string"
},
"replicaConfiguration": {
"$ref": "DemoteMasterConfiguration",
"description": "Configuration specific to read-replicas replicating from the on-premises\nmaster."
},
"verifyGtidConsistency": {
"description": "Verify GTID consistency for demote operation. Default value:\n\u003ccode\u003eTrue\u003c/code\u003e. Second Generation instances only. Setting this flag to\nfalse enables you to bypass GTID consistency check between on-premises\nmaster and Cloud SQL instance during the demotion operation but also\nexposes you to the risk of future replication failures. Change the value\nonly if you know the reason for the GTID divergence and are confident that\ndoing so will not cause any replication issues.",
"type": "boolean"
}
},
"type": "object"
},
"DemoteMasterMySqlReplicaConfiguration": {
"description": "Read-replica configuration specific to MySQL databases.",
"id": "DemoteMasterMySqlReplicaConfiguration",
"properties": {
"caCertificate": {
"description": "PEM representation of the trusted CA's x509 certificate.",
"type": "string"
},
"clientCertificate": {
"description": "PEM representation of the slave's x509 certificate.",
"type": "string"
},
"clientKey": {
"description": "PEM representation of the slave's private key. The corresponsing public key\nis encoded in the client's certificate. The format of the slave's private\nkey can be either PKCS #1 or PKCS #8.",
"type": "string"
},
"kind": {
"description": "This is always \u003ccode\u003esql#demoteMasterMysqlReplicaConfiguration\u003c/code\u003e.",
"type": "string"
},
"password": {
"description": "The password for the replication connection.",
"type": "string"
},
"username": {
"description": "The username for the replication connection.",
"type": "string"
}
},
"type": "object"
},
"DiskEncryptionConfiguration": {
"description": "Disk encryption configuration for an instance.",
"id": "DiskEncryptionConfiguration",
"properties": {
"kind": {
"description": "This is always \u003ccode\u003esql#diskEncryptionConfiguration\u003c/code\u003e.",
"type": "string"
},
"kmsKeyName": {
"description": "Resource name of KMS key for disk encryption",
"type": "string"
}
},
"type": "object"
},
"DiskEncryptionStatus": {
"description": "Disk encryption status for an instance.",
"id": "DiskEncryptionStatus",
"properties": {
"kind": {
"description": "This is always \u003ccode\u003esql#diskEncryptionStatus\u003c/code\u003e.",
"type": "string"
},
"kmsKeyVersionName": {
"description": "KMS key version used to encrypt the Cloud SQL instance resource",
"type": "string"
}
},
"type": "object"
},
"ExportContext": {
"description": "Database instance export context.",
"id": "ExportContext",
"properties": {
"csvExportOptions": {
"description": "Options for exporting data as CSV.",
"properties": {
"selectQuery": {
"description": "The select query used to extract the data.",
"type": "string"
}
},
"type": "object"
},
"databases": {
"description": "Databases to be exported. \u003cbr /\u003e \u003cb\u003eMySQL instances:\u003c/b\u003e If\n\u003ccode\u003efileType\u003c/code\u003e is \u003ccode\u003eSQL\u003c/code\u003e and no database is specified, all\ndatabases are exported, except for the \u003ccode\u003emysql\u003c/code\u003e system database.\nIf \u003ccode\u003efileType\u003c/code\u003e is \u003ccode\u003eCSV\u003c/code\u003e, you can specify one database,\neither by using this property or by using the\n\u003ccode\u003ecsvExportOptions.selectQuery\u003c/code\u003e property, which takes precedence\nover this property. \u003cbr /\u003e \u003cb\u003ePostgreSQL instances:\u003c/b\u003e You must specify\none database to be exported. If \u003ccode\u003efileType\u003c/code\u003e is \u003ccode\u003eCSV\u003c/code\u003e,\nthis database must match the one specified in the\n\u003ccode\u003ecsvExportOptions.selectQuery\u003c/code\u003e property.",
"items": {
"type": "string"
},
"type": "array"
},
"fileType": {
"description": "The file type for the specified uri. \u003cbr\u003e\u003ccode\u003eSQL\u003c/code\u003e: The file\ncontains SQL statements. \u003cbr\u003e\u003ccode\u003eCSV\u003c/code\u003e: The file contains CSV data.",
"enum": [
"SQL_FILE_TYPE_UNSPECIFIED",
"SQL",
"CSV",
"BAK"
],
"enumDescriptions": [
"Unknown file type.",
"File containing SQL statements.",
"File in CSV format.",
""
],
"type": "string"
},
"kind": {
"description": "This is always \u003ccode\u003esql#exportContext\u003c/code\u003e.",
"type": "string"
},
"sqlExportOptions": {
"description": "Options for exporting data as SQL statements.",
"properties": {
"mysqlExportOptions": {
"description": "Options for exporting from MySQL.",
"properties": {
"masterData": {
"description": "Option to include SQL statement required to set up replication.\nIf set to \u003ccode\u003e1\u003c/code\u003e, the dump file includes\n a CHANGE MASTER TO statement with the binary log coordinates.\nIf set to \u003ccode\u003e2\u003c/code\u003e, the CHANGE MASTER TO statement is written as\n a SQL comment, and has no effect.\nAll other values are ignored.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"schemaOnly": {
"description": "Export only schemas.",
"type": "boolean"
},
"tables": {
"description": "Tables to export, or that were exported, from the specified database. If\nyou specify tables, specify one and only one database. For PostgreSQL\ninstances, you can specify only one table.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"uri": {
"description": "The path to the file in Google Cloud Storage where the export will be\nstored. The URI is in the form \u003ccode\u003egs:\n//bucketName/fileName\u003c/code\u003e. If the file already exists, the requests\n// succeeds, but the operation fails. If \u003ccode\u003efileType\u003c/code\u003e is\n// \u003ccode\u003eSQL\u003c/code\u003e and the filename ends with .gz, the contents are\n// compressed.",
"type": "string"
}
},
"type": "object"
},
"FailoverContext": {
"description": "Database instance failover context.",
"id": "FailoverContext",
"properties": {
"kind": {
"description": "This is always \u003ccode\u003esql#failoverContext\u003c/code\u003e.",
"type": "string"
},
"settingsVersion": {
"description": "The current settings version of this instance. Request will be rejected if\nthis version doesn't match the current settings version.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"Flag": {
"description": "A flag resource.",
"id": "Flag",
"properties": {
"allowedStringValues": {
"description": "For \u003ccode\u003eSTRING\u003c/code\u003e flags, a list of strings that the value can be set\nto.",
"items": {
"type": "string"
},
"type": "array"
},
"appliesTo": {
"description": "The database version this flag applies to. Can be \u003ccode\u003eMYSQL_5_5\u003c/code\u003e,\n\u003ccode\u003eMYSQL_5_6\u003c/code\u003e, or \u003ccode\u003eMYSQL_5_7\u003c/code\u003e. \u003ccode\u003eMYSQL_5_7\u003c/code\u003e\nis applicable only to Second Generation instances.",
"enumDescriptions": [
"This is an unknown database version.",
"The database version is MySQL 5.0.",
"The database version is MySQL 5.1.",
"The database version is MySQL 5.5.",
"The database version is MariaDB 10.0.",
"The database version is MySQL 5.6.",
"The database version is MySQL 5.7.",
"The database version is PostgreSQL 9.5.",
"The database version is SQL Server 2016.",
"The database version is PostgreSQL 9.6.",
"The database version is PostgreSQL 11.",
"The database version is SQL Server 2017.",
"",
"",
""
],
"items": {
"enum": [
"SQL_DATABASE_VERSION_UNSPECIFIED",
"OBSOLETE_MYSQL_5_0",
"MYSQL_5_1",
"MYSQL_5_5",
"MARIADB_10_0",
"MYSQL_5_6",
"MYSQL_5_7",
"OBSOLETE_POSTGRES_9_5",
"SQLSERVER_ENTERPRISE_2016",
"POSTGRES_9_6",
"POSTGRES_11",
"SQLSERVER_2017_STANDARD",
"SQLSERVER_2017_ENTERPRISE",
"SQLSERVER_2017_EXPRESS",
"SQLSERVER_2017_WEB"
],
"type": "string"
},
"type": "array"
},
"inBeta": {
"description": "Whether or not the flag is considered in beta.",
"type": "boolean"
},
"kind": {
"description": "This is always \u003ccode\u003esql#flag\u003c/code\u003e.",
"type": "string"
},
"maxValue": {
"description": "For \u003ccode\u003eINTEGER\u003c/code\u003e flags, the maximum allowed value.",
"format": "int64",
"type": "string"
},
"minValue": {
"description": "For \u003ccode\u003eINTEGER\u003c/code\u003e flags, the minimum allowed value.",
"format": "int64",
"type": "string"
},
"name": {
"description": "This is the name of the flag. Flag names always use underscores, not\nhyphens, e.g. \u003ccode\u003emax_allowed_packet\u003c/code\u003e",
"type": "string"
},
"requiresRestart": {
"description": "Indicates whether changing this flag will trigger a database restart. Only\napplicable to Second Generation instances.",
"type": "boolean"
},
"type": {
"description": "The type of the flag. Flags are typed to being \u003ccode\u003eBOOLEAN\u003c/code\u003e,\n\u003ccode\u003eSTRING\u003c/code\u003e, \u003ccode\u003eINTEGER\u003c/code\u003e or \u003ccode\u003eNONE\u003c/code\u003e.\n\u003ccode\u003eNONE\u003c/code\u003e is used for flags which do not take a value, such as\n\u003ccode\u003eskip_grant_tables\u003c/code\u003e.",
"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\nwith the format [-12:59, 13:00].",
"Float type flag.",
"Comma-separated list of the strings in a SqlFlagType enum."
],
"type": "string"
}
},
"type": "object"
},
"FlagsListResponse": {
"description": "Flags list response.",
"id": "FlagsListResponse",
"properties": {
"items": {
"description": "List of flags.",
"items": {
"$ref": "Flag"
},
"type": "array"
},
"kind": {
"description": "This is always \u003ccode\u003esql#flagsList\u003c/code\u003e.",
"type": "string"
}
},
"type": "object"
},
"ImportContext": {
"description": "Database instance import context.",
"id": "ImportContext",
"properties": {
"bakImportOptions": {
"description": "Import parameters specific to SQL Server .BAK files",
"properties": {
"encryptionOptions": {
"properties": {
"certPath": {
"description": "Path to the Certificate (.cer) in Cloud Storage, in the form\n\u003ccode\u003egs://bucketName/fileName\u003c/code\u003e. The instance must have\nwrite permissions to the bucket and read access to the file.",
"type": "string"
},
"pvkPassword": {
"description": "Password that encrypts the private key",
"type": "string"
},
"pvkPath": {
"description": "Path to the Certificate Private Key (.pvk) in Cloud Storage, in the\nform \u003ccode\u003egs://bucketName/fileName\u003c/code\u003e. The instance must have\nwrite permissions to the bucket and read access to the file.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"csvImportOptions": {
"description": "Options for importing data as CSV.",
"properties": {
"columns": {
"description": "The columns to which CSV data is imported. If not specified, all columns\nof the database table are loaded with CSV data.",
"items": {
"type": "string"
},
"type": "array"
},
"table": {
"description": "The table to which CSV data is imported.",
"type": "string"
}
},
"type": "object"
},
"database": {
"description": "The target database for the import. If \u003ccode\u003efileType\u003c/code\u003e is\n\u003ccode\u003eSQL\u003c/code\u003e, this field is required only if the import file does not\nspecify a database, and is overridden by any database specification in the\nimport file. If \u003ccode\u003efileType\u003c/code\u003e is \u003ccode\u003eCSV\u003c/code\u003e, one database\nmust be specified.",
"type": "string"
},
"fileType": {
"description": "The file type for the specified uri. \u003cbr\u003e\u003ccode\u003eSQL\u003c/code\u003e: The file\ncontains SQL statements. \u003cbr\u003e\u003ccode\u003eCSV\u003c/code\u003e: The file contains CSV data.",
"enum": [
"SQL_FILE_TYPE_UNSPECIFIED",
"SQL",
"CSV",
"BAK"
],
"enumDescriptions": [
"Unknown file type.",
"File containing SQL statements.",
"File in CSV format.",
""
],
"type": "string"
},
"importUser": {
"description": "The PostgreSQL user for this import operation. PostgreSQL instances only.",
"type": "string"
},
"kind": {
"description": "This is always \u003ccode\u003esql#importContext\u003c/code\u003e.",
"type": "string"
},
"uri": {
"description": "Path to the import file in Cloud Storage, in the form\n\u003ccode\u003egs:\n//bucketName/fileName\u003c/code\u003e. Compressed gzip files (.gz) are supported\n// when \u003ccode\u003efileType\u003c/code\u003e is \u003ccode\u003eSQL\u003c/code\u003e. The instance must have\n// write permissions to the bucket and read access to the file.",
"type": "string"
}
},
"type": "object"
},
"InstancesCloneRequest": {
"description": "Database instance clone request.",
"id": "InstancesCloneRequest",
"properties": {
"cloneContext": {
"$ref": "CloneContext",
"description": "Contains details about the clone operation."
}
},
"type": "object"
},
"InstancesDemoteMasterRequest": {
"description": "Database demote master request.",
"id": "InstancesDemoteMasterRequest",
"properties": {
"demoteMasterContext": {
"$ref": "DemoteMasterContext",
"description": "Contains details about the demoteMaster operation."
}
},
"type": "object"
},
"InstancesExportRequest": {
"description": "Database instance export request.",
"id": "InstancesExportRequest",
"properties": {
"exportContext": {
"$ref": "ExportContext",
"description": "Contains details about the export operation."
}
},
"type": "object"
},
"InstancesFailoverRequest": {
"description": "Instance failover request.",
"id": "InstancesFailoverRequest",
"properties": {
"failoverContext": {
"$ref": "FailoverContext",
"description": "Failover Context."
}
},
"type": "object"
},
"InstancesImportRequest": {
"description": "Database instance import request.",
"id": "InstancesImportRequest",
"properties": {
"importContext": {
"$ref": "ImportContext",
"description": "Contains details about the import operation."
}
},
"type": "object"
},
"InstancesListResponse": {
"description": "Database instances list response.",
"id": "InstancesListResponse",
"properties": {
"items": {
"description": "List of database instance resources.",
"items": {
"$ref": "DatabaseInstance"
},
"type": "array"
},
"kind": {
"description": "This is always \u003ccode\u003esql#instancesList\u003c/code\u003e.",
"type": "string"
},
"nextPageToken": {
"description": "The continuation token, used to page through large result sets. Provide\nthis value in a subsequent request to return the next page of results.",
"type": "string"
},
"warnings": {
"description": "List of warnings that ocurred while handling the request.",
"items": {
"$ref": "ApiWarning"
},
"type": "array"
}
},
"type": "object"
},
"InstancesListServerCasResponse": {
"description": "Instances ListServerCas response.",
"id": "InstancesListServerCasResponse",
"properties": {
"activeVersion": {
"type": "string"
},
"certs": {
"description": "List of server CA certificates for the instance.",
"items": {
"$ref": "SslCert"
},
"type": "array"
},
"kind": {
"description": "This is always \u003ccode\u003esql#instancesListServerCas\u003c/code\u003e.",
"type": "string"
}
},
"type": "object"
},
"InstancesRestoreBackupRequest": {
"description": "Database instance restore backup request.",
"id": "InstancesRestoreBackupRequest",
"properties": {
"restoreBackupContext": {
"$ref": "RestoreBackupContext",
"description": "Parameters required to perform the restore backup operation."
}
},
"type": "object"
},
"InstancesRotateServerCaRequest": {
"description": "Rotate Server CA request.",
"id": "InstancesRotateServerCaRequest",
"properties": {
"rotateServerCaContext": {
"$ref": "RotateServerCaContext",
"description": "Contains details about the rotate server CA operation."
}
},
"type": "object"
},
"InstancesTruncateLogRequest": {
"description": "Instance truncate log request.",
"id": "InstancesTruncateLogRequest",
"properties": {
"truncateLogContext": {
"$ref": "TruncateLogContext",
"description": "Contains details about the truncate log operation."
}
},
"type": "object"
},
"IpConfiguration": {
"description": "IP Management configuration.",
"id": "IpConfiguration",
"properties": {
"authorizedNetworks": {
"description": "The list of external networks that are allowed to connect to the instance\nusing the IP. In \u003ca\nhref=\"http://en.wikipedia.org/wiki/CIDR_notation#CIDR_notation\"\u003eCIDR\nnotation\u003c/a\u003e, also known as 'slash' notation (e.g.\n\u003ccode\u003e192.168.100.0/24\u003c/code\u003e).",
"items": {
"$ref": "AclEntry"
},
"type": "array"
},
"ipv4Enabled": {
"description": "Whether the instance should be assigned an IP address or not.",
"type": "boolean"
},
"privateNetwork": {
"description": "The resource link for the VPC network from which the Cloud SQL instance is\naccessible for private IP. For example,\n\u003ccode\u003e/projects/myProject/global/networks/default\u003c/code\u003e. This setting can\nbe updated, but it cannot be removed after it is set.",
"type": "string"
},
"requireSsl": {
"description": "Whether SSL connections over IP should be enforced or not.",
"type": "boolean"
}
},
"type": "object"
},
"IpMapping": {
"description": "Database instance IP Mapping.",
"id": "IpMapping",
"properties": {
"ipAddress": {
"description": "The IP address assigned.",
"type": "string"
},
"timeToRetire": {
"description": "The due time for this IP to be retired in \u003ca\nhref=\"https://tools.ietf.org/html/rfc3339\"\u003eRFC 3339\u003c/a\u003e format, for example\n\u003ccode\u003e2012-11-15T16:19:00.094Z\u003c/code\u003e. This field is only available when\nthe IP is scheduled to be retired.",
"format": "google-datetime",
"type": "string"
},
"type": {
"description": "The type of this IP address. A \u003ccode\u003ePRIMARY\u003c/code\u003e address is a public\naddress that can accept incoming connections. A \u003ccode\u003ePRIVATE\u003c/code\u003e\naddress is a private address that can accept incoming connections. An\n\u003ccode\u003eOUTGOING\u003c/code\u003e address is the source address of connections\noriginating from the instance, if supported.",
"enum": [
"SQL_IP_ADDRESS_TYPE_UNSPECIFIED",
"PRIMARY",
"OUTGOING",
"PRIVATE",
"MIGRATED_1ST_GEN"
],
"enumDescriptions": [
"This is an unknown IP address type.",
"IP address the customer is supposed to connect to. Usually this is the\nload balancer's IP address",
"Source IP address of the connection a read replica establishes to its\nexternal master. This IP address can be whitelisted by the customer\nin case it has a firewall that filters incoming connection to its\non premises master.",
"Private IP used when using private IPs and network peering.",
"V1 IP of a migrated instance. We want the user to\ndecommission this IP as soon as the migration is complete.\nNote: V1 instances with V1 ip addresses will be counted as PRIMARY."
],
"type": "string"
}
},
"type": "object"
},
"LocationPreference": {
"description": "Preferred location. This specifies where a Cloud SQL instance should\npreferably be located, either in a specific Compute Engine zone, or\nco-located with an App Engine application. Note that if the preferred\nlocation is not available, the instance will be located as close as possible\nwithin the region. Only one location may be specified.",
"id": "LocationPreference",
"properties": {
"followGaeApplication": {
"description": "The AppEngine application to follow, it must be in the same region as the\nCloud SQL instance.",
"type": "string"
},
"kind": {
"description": "This is always \u003ccode\u003esql#locationPreference\u003c/code\u003e.",
"type": "string"
},
"zone": {
"description": "The preferred Compute Engine zone (e.g. us-central1-a, us-central1-b,\netc.).",
"type": "string"
}
},
"type": "object"
},
"MaintenanceWindow": {
"description": "Maintenance window. This specifies when a v2 Cloud SQL instance should\npreferably be restarted for system maintenance purposes.",
"id": "MaintenanceWindow",
"properties": {
"day": {
"description": "day of week (1-7), starting on Monday.",
"format": "int32",
"type": "integer"
},
"hour": {
"description": "hour of day - 0 to 23.",
"format": "int32",
"type": "integer"
},
"kind": {
"description": "This is always \u003ccode\u003esql#maintenanceWindow\u003c/code\u003e.",
"type": "string"
},
"updateTrack": {
"description": "Maintenance timing setting: \u003ccode\u003ecanary\u003c/code\u003e (Earlier) or\n\u003ccode\u003estable\u003c/code\u003e (Later). \u003cbr /\u003e\u003ca\nhref=\"/sql/docs/db_path/instance-settings#maintenance-timing-2ndgen\"\u003e\nLearn more\u003c/a\u003e.",
"enum": [
"SQL_UPDATE_TRACK_UNSPECIFIED",
"canary",
"stable"
],
"enumDescriptions": [
"This is an unknown maintenance timing preference.",
"For instance update that requires a restart, this update track indicates\nyour instance prefer to restart for new version early in maintenance\nwindow.",
"For instance update that requires a restart, this update track indicates\nyour instance prefer to let Cloud SQL choose the timing of restart (within\nits Maintenance window, if applicable)."
],
"type": "string"
}
},
"type": "object"
},
"MySqlReplicaConfiguration": {
"description": "Read-replica configuration specific to MySQL databases.",
"id": "MySqlReplicaConfiguration",
"properties": {
"caCertificate": {
"description": "PEM representation of the trusted CA's x509 certificate.",
"type": "string"
},
"clientCertificate": {
"description": "PEM representation of the slave's x509 certificate.",
"type": "string"
},
"clientKey": {
"description": "PEM representation of the slave's private key. The corresponsing public key\nis encoded in the client's certificate.",
"type": "string"
},
"connectRetryInterval": {
"description": "Seconds to wait between connect retries. MySQL's default is 60 seconds.",
"format": "int32",
"type": "integer"
},
"dumpFilePath": {
"description": "Path to a SQL dump file in Google Cloud Storage from which the slave\ninstance is to be created. The URI is in the form gs:\n//bucketName/fileName. Compressed gzip files (.gz) are also supported.\n// Dumps should have the binlog co-ordinates from which replication should\n// begin. This can be accomplished by setting --master-data to 1 when using\n// mysqldump.",
"type": "string"
},
"kind": {
"description": "This is always \u003ccode\u003esql#mysqlReplicaConfiguration\u003c/code\u003e.",
"type": "string"
},
"masterHeartbeatPeriod": {
"description": "Interval in milliseconds between replication heartbeats.",
"format": "int64",
"type": "string"
},
"password": {
"description": "The password for the replication connection.",
"type": "string"
},
"sslCipher": {
"description": "A list of permissible ciphers to use for SSL encryption.",
"type": "string"
},
"username": {
"description": "The username for the replication connection.",
"type": "string"
},
"verifyServerCertificate": {
"description": "Whether or not to check the master's Common Name value in the certificate\nthat it sends during the SSL handshake.",
"type": "boolean"
}
},
"type": "object"
},
"OnPremisesConfiguration": {
"description": "On-premises instance configuration.",
"id": "OnPremisesConfiguration",
"properties": {
"hostPort": {
"description": "The host and port of the on-premises instance in host:port format",
"type": "string"
},
"kind": {
"description": "This is always \u003ccode\u003esql#onPremisesConfiguration\u003c/code\u003e.",
"type": "string"
}
},
"type": "object"
},
"Operation": {
"description": "An Operation resource.\u0026nbsp;For successful operations that return an\nOperation resource, only the fields relevant to the operation are populated\nin the resource.",
"id": "Operation",
"properties": {
"endTime": {
"description": "The time this operation finished in UTC timezone in \u003ca\nhref=\"https://tools.ietf.org/html/rfc3339\"\u003eRFC 3339\u003c/a\u003e format, for example\n\u003ccode\u003e2012-11-15T16:19:00.094Z\u003c/code\u003e.",
"format": "google-datetime",
"type": "string"
},
"error": {
"$ref": "OperationErrors",
"description": "If errors occurred during processing of this operation, this field will be\npopulated."
},
"exportContext": {
"$ref": "ExportContext",
"description": "The context for export operation, if applicable."
},
"importContext": {
"$ref": "ImportContext",
"description": "The context for import operation, if applicable."
},
"insertTime": {
"description": "The time this operation was enqueued in UTC timezone in \u003ca\nhref=\"https://tools.ietf.org/html/rfc3339\"\u003eRFC 3339\u003c/a\u003e format, for example\n\u003ccode\u003e2012-11-15T16:19:00.094Z\u003c/code\u003e.",
"format": "google-datetime",
"type": "string"
},
"kind": {
"description": "This is always \u003ccode\u003esql#operation\u003c/code\u003e.",
"type": "string"
},
"name": {
"description": "An identifier that uniquely identifies the operation. You can use this\nidentifier to retrieve the Operations resource that has information about\nthe operation.",
"type": "string"
},
"operationType": {
"description": "The type of the operation. Valid values are \u003ccode\u003eCREATE\u003c/code\u003e,\n\u003ccode\u003eDELETE\u003c/code\u003e, \u003ccode\u003eUPDATE\u003c/code\u003e, \u003ccode\u003eRESTART\u003c/code\u003e,\n\u003ccode\u003eIMPORT\u003c/code\u003e, \u003ccode\u003eEXPORT\u003c/code\u003e, \u003ccode\u003eBACKUP_VOLUME\u003c/code\u003e,\n\u003ccode\u003eRESTORE_VOLUME\u003c/code\u003e, \u003ccode\u003eCREATE_USER\u003c/code\u003e,\n\u003ccode\u003eDELETE_USER\u003c/code\u003e, \u003ccode\u003eCREATE_DATABASE\u003c/code\u003e,\n\u003ccode\u003eDELETE_DATABASE\u003c/code\u003e .",
"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"
],
"enumDescriptions": [
"Unknown operation type.",
"Imports data into a Cloud SQL instance.",
"Exports data from a Cloud SQL instance to a Cloud Storage\nbucket.",
"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\nfailover 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\nread replica for an external database server.",
"Indicates that the instance is currently in maintenance. Maintenance\ntypically causes the instance to be unavailable for 1-3 minutes.",
"This field is deprecated, and will be removed in future version of API.",
"Defer scheduled maintenance to another time.",
"Creates clone instance."
],
"type": "string"
},
"selfLink": {
"description": "The URI of this resource.",
"type": "string"
},
"startTime": {
"description": "The time this operation actually started in UTC timezone in \u003ca\nhref=\"https://tools.ietf.org/html/rfc3339\"\u003eRFC 3339\u003c/a\u003e format, for example\n\u003ccode\u003e2012-11-15T16:19:00.094Z\u003c/code\u003e.",
"format": "google-datetime",
"type": "string"
},
"status": {
"description": "The status of an operation. Valid values are \u003ccode\u003ePENDING\u003c/code\u003e,\n\u003ccode\u003eRUNNING\u003c/code\u003e, \u003ccode\u003eDONE\u003c/code\u003e, \u003ccode\u003eUNKNOWN\u003c/code\u003e.",
"enum": [
"SQL_OPERATION_STATUS_UNSPECIFIED",
"PENDING",
"RUNNING",
"DONE"
],
"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."
],
"type": "string"
},
"targetId": {
"description": "Name of the database instance related to this operation.",
"type": "string"
},
"targetLink": {
"type": "string"
},
"targetProject": {
"description": "The project ID of the target instance related to this operation.",
"type": "string"
},
"user": {
"description": "The email address of the user who initiated this operation.",
"type": "string"
}
},
"type": "object"
},
"OperationError": {
"description": "Database instance operation error.",
"id": "OperationError",
"properties": {
"code": {
"description": "Identifies the specific error that occurred.",
"type": "string"
},
"kind": {
"description": "This is always \u003ccode\u003esql#operationError\u003c/code\u003e.",
"type": "string"
},
"message": {
"description": "Additional information about the error encountered.",
"type": "string"
}
},
"type": "object"
},
"OperationErrors": {
"description": "Database instance operation errors list wrapper.",
"id": "OperationErrors",
"properties": {
"errors": {
"description": "The list of errors encountered while processing this operation.",
"items": {
"$ref": "OperationError"
},
"type": "array"
},
"kind": {
"description": "This is always \u003ccode\u003esql#operationErrors\u003c/code\u003e.",
"type": "string"
}
},
"type": "object"
},
"OperationsListResponse": {
"description": "Database instance list operations response.",
"id": "OperationsListResponse",
"properties": {
"items": {
"description": "List of operation resources.",
"items": {
"$ref": "Operation"
},
"type": "array"
},
"kind": {
"description": "This is always \u003ccode\u003esql#operationsList\u003c/code\u003e.",
"type": "string"
},
"nextPageToken": {
"description": "The continuation token, used to page through large result sets. Provide\nthis value in a subsequent request to return the next page of results.",
"type": "string"
}
},
"type": "object"
},
"ReplicaConfiguration": {
"description": "Read-replica configuration for connecting to the master.",
"id": "ReplicaConfiguration",
"properties": {
"failoverTarget": {
"description": "Specifies if the replica is the failover target. If the field is set to\n\u003ccode\u003etrue\u003c/code\u003e the replica will be designated as a failover replica. In\ncase the master instance fails, the replica instance will be promoted as\nthe new master instance. \u003cp\u003eOnly one replica can be specified as failover\ntarget, and the replica has to be in different zone with the master\ninstance.",
"type": "boolean"
},
"kind": {
"description": "This is always \u003ccode\u003esql#replicaConfiguration\u003c/code\u003e.",
"type": "string"
},
"mysqlReplicaConfiguration": {
"$ref": "MySqlReplicaConfiguration",
"description": "MySQL specific configuration when replicating from a MySQL on-premises\nmaster. Replication configuration information such as the username,\npassword, certificates, and keys are not stored in the instance metadata.\nThe configuration information is used only to set up the replication\nconnection and is stored by MySQL in a file named \u003ccode\u003emaster.info\u003c/code\u003e\nin the data directory."
}
},
"type": "object"
},
"RestoreBackupContext": {
"description": "Database instance restore from backup context.\nBackup context contains source instance id and project id.",
"id": "RestoreBackupContext",
"properties": {
"backupRunId": {
"description": "The ID of the backup run to restore from.",
"format": "int64",
"type": "string"
},
"instanceId": {
"description": "The ID of the instance that the backup was taken from.",
"type": "string"
},
"kind": {
"description": "This is always \u003ccode\u003esql#restoreBackupContext\u003c/code\u003e.",
"type": "string"
},
"project": {
"description": "The full project ID of the source instance.",
"type": "string"
}
},
"type": "object"
},
"RotateServerCaContext": {
"description": "Instance rotate server CA context.",
"id": "RotateServerCaContext",
"properties": {
"kind": {
"description": "This is always \u003ccode\u003esql#rotateServerCaContext\u003c/code\u003e.",
"type": "string"
},
"nextVersion": {
"description": "The fingerprint of the next version to be rotated to. If left unspecified,\nwill be rotated to the most recently added server CA version.",
"type": "string"
}
},
"type": "object"
},
"Settings": {
"description": "Database instance settings.",
"id": "Settings",
"properties": {
"activationPolicy": {
"description": "The activation policy specifies when the instance is activated; it is\napplicable only when the instance state is \u003ccode\u003eRUNNABLE\u003c/code\u003e. Valid\nvalues: \u003cbr\u003e\u003ccode\u003eALWAYS\u003c/code\u003e: The instance is on, and remains so even in\nthe absence of connection requests. \u003cbr\u003e\u003ccode\u003eNEVER\u003c/code\u003e: The instance is\noff; it is not activated, even if a connection request arrives.\n\u003cbr\u003e\u003ccode\u003eON_DEMAND\u003c/code\u003e: First Generation instances only. The instance\nresponds to incoming requests, and turns itself off when not in use.\nInstances with \u003ccode\u003ePER_USE\u003c/code\u003e pricing turn off after 15 minutes of\ninactivity. Instances with \u003ccode\u003ePER_PACKAGE\u003c/code\u003e pricing turn off after\n12 hours of inactivity.",
"enum": [
"SQL_ACTIVATION_POLICY_UNSPECIFIED",
"ALWAYS",
"NEVER",
"ON_DEMAND"
],
"enumDescriptions": [
"Unknown activation plan.",
"The instance is always up and running.",
"The instance should never spin up.",
"The instance spins up upon receiving requests."
],
"type": "string"
},
"authorizedGaeApplications": {
"description": "The App Engine app IDs that can access this instance. First Generation\ninstances only.",
"items": {
"type": "string"
},
"type": "array"
},
"availabilityType": {
"description": "Availability type (PostgreSQL instances only). Potential values:\n\u003cbr\u003e\u003ccode\u003eZONAL\u003c/code\u003e: The instance serves data from only one zone.\nOutages in that zone affect data accessibility. \u003cbr\u003e\u003ccode\u003eREGIONAL\u003c/code\u003e:\nThe instance can serve data from more than one zone in a region (it is\nhighly available). \u003cbr\u003eFor more information, see \u003ca\nhref=\"https://cloud.google.com/sql/docs/postgres/high-availability\"\u003eOverview\nof the High Availability Configuration\u003c/a\u003e.",
"enum": [
"SQL_AVAILABILITY_TYPE_UNSPECIFIED",
"ZONAL",
"REGIONAL"
],
"enumDescriptions": [
"This is an unknown Availability type.",
"Zonal available instance.",
"Regional available instance."
],
"type": "string"
},
"backupConfiguration": {
"$ref": "BackupConfiguration",
"description": "The daily backup configuration for the instance."
},
"crashSafeReplicationEnabled": {
"description": "Configuration specific to read replica instances. Indicates whether\ndatabase flags for crash-safe replication are enabled. This property is\nonly applicable to First Generation instances.",
"type": "boolean"
},
"dataDiskSizeGb": {
"description": "The size of data disk, in GB. The data disk size minimum is 10GB. Not used\nfor First Generation instances.",
"format": "int64",
"type": "string"
},
"dataDiskType": {
"description": "The type of data disk: \u003ccode\u003ePD_SSD\u003c/code\u003e (default) or\n\u003ccode\u003ePD_HDD\u003c/code\u003e. Not used for First Generation instances.",
"enum": [
"SQL_DATA_DISK_TYPE_UNSPECIFIED",
"PD_SSD",
"PD_HDD",
"OBSOLETE_LOCAL_SSD"
],
"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\nAPI."
],
"type": "string"
},
"databaseFlags": {
"description": "The database flags passed to the instance at startup.",
"items": {
"$ref": "DatabaseFlags"
},
"type": "array"
},
"databaseReplicationEnabled": {
"description": "Configuration specific to read replica instances. Indicates whether\nreplication is enabled or not.",
"type": "boolean"
},
"ipConfiguration": {
"$ref": "IpConfiguration",
"description": "The settings for IP Management. This allows to enable or disable the\ninstance IP and manage which external networks can connect to the instance.\nThe IPv4 address cannot be disabled for Second Generation instances."
},
"kind": {
"description": "This is always \u003ccode\u003esql#settings\u003c/code\u003e.",
"type": "string"
},
"locationPreference": {
"$ref": "LocationPreference",
"description": "The location preference settings. This allows the instance to be located as\nnear as possible to either an App Engine app or Compute Engine zone for\nbetter performance. App Engine co-location is only applicable to First\nGeneration instances."
},
"maintenanceWindow": {
"$ref": "MaintenanceWindow",
"description": "The maintenance window for this instance. This specifies when the instance\ncan be restarted for maintenance purposes. Not used for First Generation\ninstances."
},
"pricingPlan": {
"description": "The pricing plan for this instance. This can be either \u003ccode\u003ePER_USE\u003c/code\u003e\nor \u003ccode\u003ePACKAGE\u003c/code\u003e. Only \u003ccode\u003ePER_USE\u003c/code\u003e is supported for Second\nGeneration instances.",
"enum": [
"SQL_PRICING_PLAN_UNSPECIFIED",
"PACKAGE",
"PER_USE"
],
"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"
},
"replicationType": {
"description": "The type of replication this instance uses. This can be either\n\u003ccode\u003eASYNCHRONOUS\u003c/code\u003e or \u003ccode\u003eSYNCHRONOUS\u003c/code\u003e. This property is\nonly applicable to First Generation instances.",
"enum": [
"SQL_REPLICATION_TYPE_UNSPECIFIED",
"SYNCHRONOUS",
"ASYNCHRONOUS"
],
"enumDescriptions": [
"This is an unknown replication type for a Cloud SQL instance.",
"The synchronous replication mode for First Generation instances. It is the\ndefault value.",
"The asynchronous replication mode for First Generation instances. It\nprovides a slight performance gain, but if an outage occurs while this\noption is set to asynchronous, you can lose up to a few seconds of updates\nto your data."
],
"type": "string"
},
"settingsVersion": {
"description": "The version of instance settings. This is a required field for update\nmethod to make sure concurrent updates are handled properly. During update,\nuse the most recent settingsVersion value for this instance and do not try\nto update this value.",
"format": "int64",
"type": "string"
},
"storageAutoResize": {
"description": "Configuration to increase storage size automatically. The default value is\ntrue. Not used for First Generation instances.",
"type": "boolean"
},
"storageAutoResizeLimit": {
"description": "The maximum size to which storage capacity can be automatically increased.\nThe default value is 0, which specifies that there is no limit. Not used\nfor First Generation instances.",
"format": "int64",
"type": "string"
},
"tier": {
"description": "The tier (or machine type) for this instance, for example\n\u003ccode\u003edb-n1-standard-1\u003c/code\u003e (MySQL instances) or\n\u003ccode\u003edb-custom-1-3840\u003c/code\u003e (PostgreSQL instances). For MySQL instances,\nthis property determines whether the instance is First or Second\nGeneration. For more information, see \u003ca\nhref=\"/sql/docs/db_path/instance-settings\"\u003eInstance Settings\u003c/a\u003e.",
"type": "string"
},
"userLabels": {
"additionalProperties": {
"type": "string"
},
"description": "User-provided labels, represented as a dictionary where each label is a\nsingle key value pair.",
"type": "object"
}
},
"type": "object"
},
"SqlScheduledMaintenance": {
"description": "Any scheduled maintenancce for this instance.",
"id": "SqlScheduledMaintenance",
"properties": {
"canDefer": {
"description": "If the scheduled maintenance can be deferred.",
"type": "boolean"
},
"startTime": {
"description": "The start time of any upcoming scheduled maintenance for this instance.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"SqlServerDatabaseDetails": {
"description": "Represents a Sql Server database on the Cloud SQL instance.",
"id": "SqlServerDatabaseDetails",
"properties": {
"compatibilityLevel": {
"description": "The version of SQL Server with which the database is to be made compatible",
"format": "int32",
"type": "integer"
},
"recoveryModel": {
"description": "The recovery model of a SQL Server database",
"type": "string"
}
},
"type": "object"
},
"SslCert": {
"description": "SslCerts Resource",
"id": "SslCert",
"properties": {
"cert": {
"description": "PEM representation.",
"type": "string"
},
"certSerialNumber": {
"description": "Serial number, as extracted from the certificate.",
"type": "string"
},
"commonName": {
"description": "User supplied name. Constrained to [a-zA-Z.-_ ]+.",
"type": "string"
},
"createTime": {
"description": "The time when the certificate was created in \u003ca\nhref=\"https://tools.ietf.org/html/rfc3339\"\u003eRFC 3339\u003c/a\u003e format, for example\n\u003ccode\u003e2012-11-15T16:19:00.094Z\u003c/code\u003e",
"format": "google-datetime",
"type": "string"
},
"expirationTime": {
"description": "The time when the certificate expires in \u003ca\nhref=\"https://tools.ietf.org/html/rfc3339\"\u003eRFC 3339\u003c/a\u003e format, for example\n\u003ccode\u003e2012-11-15T16:19:00.094Z\u003c/code\u003e.",
"format": "google-datetime",
"type": "string"
},
"instance": {
"description": "Name of the database instance.",
"type": "string"
},
"kind": {
"description": "This is always \u003ccode\u003esql#sslCert\u003c/code\u003e.",
"type": "string"
},
"selfLink": {
"description": "The URI of this resource.",
"type": "string"
},
"sha1Fingerprint": {
"description": "Sha1 Fingerprint.",
"type": "string"
}
},
"type": "object"
},
"SslCertDetail": {
"description": "SslCertDetail.",
"id": "SslCertDetail",
"properties": {
"certInfo": {
"$ref": "SslCert",
"description": "The public information about the cert."
},
"certPrivateKey": {
"description": "The private key for the client cert, in pem format. Keep private in order\nto protect your security.",
"type": "string"
}
},
"type": "object"
},
"SslCertsCreateEphemeralRequest": {
"description": "SslCerts create ephemeral certificate request.",
"id": "SslCertsCreateEphemeralRequest",
"properties": {
"public_key": {
"description": "PEM encoded public key to include in the signed certificate.",
"type": "string"
}
},
"type": "object"
},
"SslCertsInsertRequest": {
"description": "SslCerts insert request.",
"id": "SslCertsInsertRequest",
"properties": {
"commonName": {
"description": "User supplied name. Must be a distinct name from the other certificates\nfor this instance.",
"type": "string"
}
},
"type": "object"
},
"SslCertsInsertResponse": {
"description": "SslCert insert response.",
"id": "SslCertsInsertResponse",
"properties": {
"clientCert": {
"$ref": "SslCertDetail",
"description": "The new client certificate and private key. For First Generation\ninstances, the new certificate does not take effect until the instance is\nrestarted."
},
"kind": {
"description": "This is always \u003ccode\u003esql#sslCertsInsert\u003c/code\u003e.",
"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\nforce a new one to be generated by calling resetSslConfig method on\ninstances resource."
}
},
"type": "object"
},
"SslCertsListResponse": {
"description": "SslCerts list response.",
"id": "SslCertsListResponse",
"properties": {
"items": {
"description": "List of client certificates for the instance.",
"items": {
"$ref": "SslCert"
},
"type": "array"
},
"kind": {
"description": "This is always \u003ccode\u003esql#sslCertsList\u003c/code\u003e.",
"type": "string"
}
},
"type": "object"
},
"Tier": {
"description": "A Google Cloud SQL service tier resource.",
"id": "Tier",
"properties": {
"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.",
"format": "int64",
"type": "string"
},
"kind": {
"description": "This is always \u003ccode\u003esql#tier\u003c/code\u003e.",
"type": "string"
},
"region": {
"description": "The applicable regions for this tier.",
"items": {
"type": "string"
},
"type": "array"
},
"tier": {
"description": "An identifier for the machine type, for example, db-n1-standard-1. For\nrelated information, see \u003ca href=\"/sql/pricing\"\u003ePricing\u003c/a\u003e.",
"type": "string"
}
},
"type": "object"
},
"TiersListResponse": {
"description": "Tiers list response.",
"id": "TiersListResponse",
"properties": {
"items": {
"description": "List of tiers.",
"items": {
"$ref": "Tier"
},
"type": "array"
},
"kind": {
"description": "This is always \u003ccode\u003esql#tiersList\u003c/code\u003e.",
"type": "string"
}
},
"type": "object"
},
"TruncateLogContext": {
"description": "Database Instance truncate log context.",
"id": "TruncateLogContext",
"properties": {
"kind": {
"description": "This is always \u003ccode\u003esql#truncateLogContext\u003c/code\u003e.",
"type": "string"
},
"logType": {
"description": "The type of log to truncate. Valid values are\n\u003ccode\u003eMYSQL_GENERAL_TABLE\u003c/code\u003e and \u003ccode\u003eMYSQL_SLOW_TABLE\u003c/code\u003e.",
"type": "string"
}
},
"type": "object"
},
"User": {
"description": "A Cloud SQL user resource.",
"id": "User",
"properties": {
"etag": {
"description": "This field is deprecated and will be removed from a future version of the\nAPI.",
"type": "string"
},
"host": {
"description": "The host name from which the user can connect. For \u003ccode\u003einsert\u003c/code\u003e\noperations, host defaults to an empty string. For \u003ccode\u003eupdate\u003c/code\u003e\noperations, host is specified as part of the request URL. The host name\ncannot be updated after insertion.",
"type": "string"
},
"instance": {
"description": "The name of the Cloud SQL instance. This does not include the project ID.\nCan be omitted for \u003ccode\u003eupdate\u003c/code\u003e since it is already specified on the\nURL.",
"type": "string"
},
"kind": {
"description": "This is always \u003ccode\u003esql#user\u003c/code\u003e.",
"type": "string"
},
"name": {
"description": "The name of the user in the Cloud SQL instance. Can be omitted for\n\u003ccode\u003eupdate\u003c/code\u003e since it is already specified in 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\napps domain is prefixed if applicable. Can be omitted for\n\u003ccode\u003eupdate\u003c/code\u003e since it is already specified on the URL.",
"type": "string"
}
},
"type": "object"
},
"UsersListResponse": {
"description": "User list response.",
"id": "UsersListResponse",
"properties": {
"items": {
"description": "List of user resources in the instance.",
"items": {
"$ref": "User"
},
"type": "array"
},
"kind": {
"description": "This is always \u003ccode\u003esql#usersList\u003c/code\u003e.",
"type": "string"
},
"nextPageToken": {
"description": "An identifier that uniquely identifies the operation. You can use this\nidentifier to retrieve the Operations resource that has information about\nthe operation.",
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Cloud SQL Admin API",
"version": "v1beta4"
}