Blame - docs/dyn/sqladmin_v1beta4.instances.html - platform/external/python/google-api-python-client

2019-06-14 16:50:42 -0700

[diff] [blame]

80

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

81

<code><a href="#clone">clone(project, instance, body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

82

<p class="firstline">Creates a Cloud SQL instance as a clone of the source instance. Using this operation might cause your instance to restart.</p>

83

84

<code><a href="#close">close()</a></code></p>

85

<p class="firstline">Close httplib2 connections.</p>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

86

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

87

<code><a href="#delete">delete(project, instance, x__xgafv=None)</a></code></p>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

88

<p class="firstline">Deletes a Cloud SQL instance.</p>

89

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

90

<code><a href="#demoteMaster">demoteMaster(project, instance, body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

91

<p class="firstline">Demotes the stand-alone instance to be a Cloud SQL read replica for an external database server.</p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

92

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

93

<code><a href="#export">export(project, instance, body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

94

<p class="firstline">Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL dump or CSV file.</p>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

95

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

96

<code><a href="#failover">failover(project, instance, body=None, x__xgafv=None)</a></code></p>

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

97

<p class="firstline">Initiates a manual failover of a high availability (HA) primary instance to a standby instance, which becomes the primary instance. Users are then rerouted to the new primary. For more information, see the Overview of high availability page in the Cloud SQL documentation. If using Legacy HA (MySQL only), this causes the instance to failover to its failover replica instance.</p>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

98

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

99

<code><a href="#get">get(project, instance, x__xgafv=None)</a></code></p>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

100

<p class="firstline">Retrieves a resource containing information about a Cloud SQL instance.</p>

101

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

102

<code><a href="#import_">import_(project, instance, body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

103

<p class="firstline">Imports data into a Cloud SQL instance from a SQL dump or CSV file in Cloud Storage.</p>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

104

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

105

<code><a href="#insert">insert(project, body=None, x__xgafv=None)</a></code></p>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

106

<p class="firstline">Creates a new Cloud SQL instance.</p>

107

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

108

<code><a href="#list">list(project, filter=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

109

<p class="firstline">Lists instances under a given project.</p>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

110

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

111

<code><a href="#listServerCas">listServerCas(project, instance, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

112

<p class="firstline">Lists all of the trusted Certificate Authorities (CAs) for the specified instance. There can be up to three CAs listed: the CA that was used to sign the certificate that is currently in use, a CA that has been added but not yet used to sign a certificate, and a CA used to sign a certificate that has previously rotated out.</p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

113

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

114

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

115

<p class="firstline">Retrieves the next page of results.</p>

116

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

117

<code><a href="#patch">patch(project, instance, body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

118

<p class="firstline">Updates settings of a Cloud SQL instance. This method supports patch semantics.</p>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

119

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

120

<code><a href="#promoteReplica">promoteReplica(project, instance, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

121

<p class="firstline">Promotes the read replica instance to be a stand-alone Cloud SQL instance. Using this operation might cause your instance to restart.</p>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

122

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

123

<code><a href="#resetSslConfig">resetSslConfig(project, instance, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

124

<p class="firstline">Deletes all client certificates and generates a new server SSL certificate for the instance.</p>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

125

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

126

<code><a href="#restart">restart(project, instance, x__xgafv=None)</a></code></p>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

127

<p class="firstline">Restarts a Cloud SQL instance.</p>

128

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

129

<code><a href="#restoreBackup">restoreBackup(project, instance, body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

130

<p class="firstline">Restores a backup of a Cloud SQL instance. Using this operation might cause your instance to restart.</p>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

131

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

132

<code><a href="#rotateServerCa">rotateServerCa(project, instance, body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

133

<p class="firstline">Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method.</p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

134

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

135

<code><a href="#startReplica">startReplica(project, instance, x__xgafv=None)</a></code></p>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

136

<p class="firstline">Starts the replication in the read replica instance.</p>

137

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

138

<code><a href="#stopReplica">stopReplica(project, instance, x__xgafv=None)</a></code></p>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

139

<p class="firstline">Stops the replication in the read replica instance.</p>

140

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

141

<code><a href="#truncateLog">truncateLog(project, instance, body=None, x__xgafv=None)</a></code></p>

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

142

<p class="firstline">Truncate MySQL general and slow query log tables MySQL only.</p>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

143

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

144

<code><a href="#update">update(project, instance, body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

145

<p class="firstline">Updates settings of a Cloud SQL instance. Using this operation might cause your instance to restart.</p>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

146

<h3>Method Details</h3>

147

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

148

<code class="details" id="addServerCa">addServerCa(project, instance, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

149

<pre>Add a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

150

151

Args:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

152

project: string, Project ID of the project that contains the instance. (required)

153

instance: string, Cloud SQL instance ID. This does not include the project ID. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

154

x__xgafv: string, V1 error format.

155

Allowed values

156

1 - v1 error format

157

2 - v2 error format

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

158

159

Returns:

160

An object of the form:

161

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

162

{ # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

163

"backupContext": { # Backup context. # The context for backup operation, if applicable.

164

"backupId": "A String", # The identifier of the backup.

165

"kind": "A String", # This is always *sql#backupContext*.

166

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

167

"endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

168

"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.

169

"errors": [ # The list of errors encountered while processing this operation.

170

{ # Database instance operation error.

171

"code": "A String", # Identifies the specific error that occurred.

172

"kind": "A String", # This is always *sql#operationError*.

173

"message": "A String", # Additional information about the error encountered.

174

},

175

],

176

"kind": "A String", # This is always *sql#operationErrors*.

177

},

178

"exportContext": { # Database instance export context. # The context for export operation, if applicable.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

179

"csvExportOptions": { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

180

"selectQuery": "A String", # The select query used to extract the data.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

181

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

182

"databases": [ # Databases to be exported. *MySQL instances:* If *fileType* is *SQL* and no database is specified, all databases are exported, except for the *mysql* system database. If *fileType* is *CSV*, you can specify one database, either by using this property or by using the *csvExportOptions.selectQuery* property, which takes precedence over this property. *PostgreSQL instances:* You must specify one database to be exported. If *fileType* is *CSV*, this database must match the one specified in the *csvExportOptions.selectQuery* property. *SQL Server instances:* You must specify one database to be exported, and the *fileType* must be *BAK*.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

183

"A String",

184

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

185

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. *BAK*: The file contains backup data for a SQL Server instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

186

"kind": "A String", # This is always *sql#exportContext*.

187

"offload": True or False, # Option for export offload.

188

"sqlExportOptions": { # Options for exporting data as SQL statements.

189

"mysqlExportOptions": { # Options for exporting from MySQL.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

190

"masterData": 42, # Option to include SQL statement required to set up replication. If set to *1*, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than *1*, --set-gtid-purged is set to OFF.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

191

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

192

"schemaOnly": True or False, # Export only schemas.

193

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

194

"A String",

195

],

196

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

197

"uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form *gs://bucketName/fileName*. If the file already exists, the request succeeds, but the operation fails. If *fileType* is *SQL* and the filename ends with .gz, the contents are compressed.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

198

},

199

"importContext": { # Database instance import context. # The context for import operation, if applicable.

200

"bakImportOptions": { # Import parameters specific to SQL Server .BAK files

201

"encryptionOptions": {

202

"certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

203

"pvkPassword": "A String", # Password that encrypts the private key

204

"pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

205

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

206

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

207

"csvImportOptions": { # Options for importing data as CSV.

208

"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.

209

"A String",

210

],

211

"table": "A String", # The table to which CSV data is imported.

212

},

213

"database": "A String", # The target database for the import. If *fileType* is *SQL*, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If *fileType* is *CSV*, one database must be specified.

214

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.

215

"importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.

216

"kind": "A String", # This is always *sql#importContext*.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

217

"uri": "A String", # Path to the import file in Cloud Storage, in the form *gs://bucketName/fileName*. Compressed gzip files (.gz) are supported when *fileType* is *SQL*. The instance must have write permissions to the bucket and read access to the file.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

218

},

219

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

220

"kind": "A String", # This is always *sql#operation*.

221

"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.

222

"operationType": "A String", # The type of the operation. Valid values are: *CREATE* *DELETE* *UPDATE* *RESTART* *IMPORT* *EXPORT* *BACKUP_VOLUME* *RESTORE_VOLUME* *CREATE_USER* *DELETE_USER* *CREATE_DATABASE* *DELETE_DATABASE*

223

"selfLink": "A String", # The URI of this resource.

224

"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

225

"status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*

226

"targetId": "A String", # Name of the database instance related to this operation.

227

"targetLink": "A String",

228

"targetProject": "A String", # The project ID of the target instance related to this operation.

229

"user": "A String", # The email address of the user who initiated this operation.

230

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

234

<code class="details" id="clone">clone(project, instance, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

235

<pre>Creates a Cloud SQL instance as a clone of the source instance. Using this operation might cause your instance to restart.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

236

237

Args:

238

project: string, Project ID of the source as well as the clone Cloud SQL instance. (required)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

239

instance: string, The ID of the Cloud SQL instance to be cloned (source). This does not include the project ID. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

240

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

241

The object takes the form of:

242

243

{ # Database instance clone request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

244

"cloneContext": { # Database instance clone context. # Contains details about the clone operation.

245

"binLogCoordinates": { # Binary log coordinates. # Binary log coordinates, if specified, identify the position up to which the source instance is cloned. If not specified, the source instance is cloned up to the most recent binary log coordinates.

246

"binLogFileName": "A String", # Name of the binary log file for a Cloud SQL instance.

247

"binLogPosition": "A String", # Position (offset) within the binary log file.

248

"kind": "A String", # This is always *sql#binLogCoordinates*.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

249

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

250

"destinationInstanceName": "A String", # Name of the Cloud SQL instance to be created as a clone.

251

"kind": "A String", # This is always *sql#cloneContext*.

252

"pitrTimestampMs": "A String", # Reserved for future use.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

253

"pointInTime": "A String", # Timestamp, if specified, identifies the time to which the source instance is cloned.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

254

},

255

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

256

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

257

x__xgafv: string, V1 error format.

258

Allowed values

259

1 - v1 error format

260

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

261

262

Returns:

263

An object of the form:

264

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

265

{ # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

266

"backupContext": { # Backup context. # The context for backup operation, if applicable.

267

"backupId": "A String", # The identifier of the backup.

268

"kind": "A String", # This is always *sql#backupContext*.

269

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

270

"endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

271

"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.

272

"errors": [ # The list of errors encountered while processing this operation.

273

{ # Database instance operation error.

274

"code": "A String", # Identifies the specific error that occurred.

275

"kind": "A String", # This is always *sql#operationError*.

276

"message": "A String", # Additional information about the error encountered.

277

},

278

],

279

"kind": "A String", # This is always *sql#operationErrors*.

280

},

281

"exportContext": { # Database instance export context. # The context for export operation, if applicable.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

282

"csvExportOptions": { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

283

"selectQuery": "A String", # The select query used to extract the data.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

284

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

285

"databases": [ # Databases to be exported. *MySQL instances:* If *fileType* is *SQL* and no database is specified, all databases are exported, except for the *mysql* system database. If *fileType* is *CSV*, you can specify one database, either by using this property or by using the *csvExportOptions.selectQuery* property, which takes precedence over this property. *PostgreSQL instances:* You must specify one database to be exported. If *fileType* is *CSV*, this database must match the one specified in the *csvExportOptions.selectQuery* property. *SQL Server instances:* You must specify one database to be exported, and the *fileType* must be *BAK*.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

286

"A String",

287

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

288

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. *BAK*: The file contains backup data for a SQL Server instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

289

"kind": "A String", # This is always *sql#exportContext*.

290

"offload": True or False, # Option for export offload.

291

"sqlExportOptions": { # Options for exporting data as SQL statements.

292

"mysqlExportOptions": { # Options for exporting from MySQL.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

293

"masterData": 42, # Option to include SQL statement required to set up replication. If set to *1*, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than *1*, --set-gtid-purged is set to OFF.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

294

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

295

"schemaOnly": True or False, # Export only schemas.

296

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

297

"A String",

298

],

299

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

300

"uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form *gs://bucketName/fileName*. If the file already exists, the request succeeds, but the operation fails. If *fileType* is *SQL* and the filename ends with .gz, the contents are compressed.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

301

},

302

"importContext": { # Database instance import context. # The context for import operation, if applicable.

303

"bakImportOptions": { # Import parameters specific to SQL Server .BAK files

304

"encryptionOptions": {

305

"certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

306

"pvkPassword": "A String", # Password that encrypts the private key

307

"pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

308

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

309

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

310

"csvImportOptions": { # Options for importing data as CSV.

311

"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.

312

"A String",

313

],

314

"table": "A String", # The table to which CSV data is imported.

315

},

316

"database": "A String", # The target database for the import. If *fileType* is *SQL*, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If *fileType* is *CSV*, one database must be specified.

317

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.

318

"importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.

319

"kind": "A String", # This is always *sql#importContext*.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

320

"uri": "A String", # Path to the import file in Cloud Storage, in the form *gs://bucketName/fileName*. Compressed gzip files (.gz) are supported when *fileType* is *SQL*. The instance must have write permissions to the bucket and read access to the file.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

321

},

322

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

323

"kind": "A String", # This is always *sql#operation*.

324

"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.

325

"operationType": "A String", # The type of the operation. Valid values are: *CREATE* *DELETE* *UPDATE* *RESTART* *IMPORT* *EXPORT* *BACKUP_VOLUME* *RESTORE_VOLUME* *CREATE_USER* *DELETE_USER* *CREATE_DATABASE* *DELETE_DATABASE*

326

"selfLink": "A String", # The URI of this resource.

327

"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

328

"status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*

329

"targetId": "A String", # Name of the database instance related to this operation.

330

"targetLink": "A String",

331

"targetProject": "A String", # The project ID of the target instance related to this operation.

332

"user": "A String", # The email address of the user who initiated this operation.

333

}</pre>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

337

<code class="details" id="close">close()</code>

338

<pre>Close httplib2 connections.</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

342

<code class="details" id="delete">delete(project, instance, x__xgafv=None)</code>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

343

<pre>Deletes a Cloud SQL instance.

344

345

Args:

346

project: string, Project ID of the project that contains the instance to be deleted. (required)

347

instance: string, Cloud SQL instance ID. This does not include the project ID. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

348

x__xgafv: string, V1 error format.

349

Allowed values

350

1 - v1 error format

351

2 - v2 error format

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

352

353

Returns:

354

An object of the form:

355

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

356

{ # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

357

"backupContext": { # Backup context. # The context for backup operation, if applicable.

358

"backupId": "A String", # The identifier of the backup.

359

"kind": "A String", # This is always *sql#backupContext*.

360

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

361

"endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

362

"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.

363

"errors": [ # The list of errors encountered while processing this operation.

364

{ # Database instance operation error.

365

"code": "A String", # Identifies the specific error that occurred.

366

"kind": "A String", # This is always *sql#operationError*.

367

"message": "A String", # Additional information about the error encountered.

368

},

369

],

370

"kind": "A String", # This is always *sql#operationErrors*.

371

},

372

"exportContext": { # Database instance export context. # The context for export operation, if applicable.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

373

"csvExportOptions": { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

374

"selectQuery": "A String", # The select query used to extract the data.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

375

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

376

"databases": [ # Databases to be exported. *MySQL instances:* If *fileType* is *SQL* and no database is specified, all databases are exported, except for the *mysql* system database. If *fileType* is *CSV*, you can specify one database, either by using this property or by using the *csvExportOptions.selectQuery* property, which takes precedence over this property. *PostgreSQL instances:* You must specify one database to be exported. If *fileType* is *CSV*, this database must match the one specified in the *csvExportOptions.selectQuery* property. *SQL Server instances:* You must specify one database to be exported, and the *fileType* must be *BAK*.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

377

"A String",

378

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

379

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. *BAK*: The file contains backup data for a SQL Server instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

380

"kind": "A String", # This is always *sql#exportContext*.

381

"offload": True or False, # Option for export offload.

382

"sqlExportOptions": { # Options for exporting data as SQL statements.

383

"mysqlExportOptions": { # Options for exporting from MySQL.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

384

"masterData": 42, # Option to include SQL statement required to set up replication. If set to *1*, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than *1*, --set-gtid-purged is set to OFF.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

385

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

386

"schemaOnly": True or False, # Export only schemas.

387

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

388

"A String",

389

],

390

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

391

"uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form *gs://bucketName/fileName*. If the file already exists, the request succeeds, but the operation fails. If *fileType* is *SQL* and the filename ends with .gz, the contents are compressed.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

392

},

393

"importContext": { # Database instance import context. # The context for import operation, if applicable.

394

"bakImportOptions": { # Import parameters specific to SQL Server .BAK files

395

"encryptionOptions": {

396

"certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

397

"pvkPassword": "A String", # Password that encrypts the private key

398

"pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

399

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

400

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

401

"csvImportOptions": { # Options for importing data as CSV.

402

"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.

403

"A String",

404

],

405

"table": "A String", # The table to which CSV data is imported.

406

},

407

"database": "A String", # The target database for the import. If *fileType* is *SQL*, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If *fileType* is *CSV*, one database must be specified.

408

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.

409

"importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.

410

"kind": "A String", # This is always *sql#importContext*.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

411

"uri": "A String", # Path to the import file in Cloud Storage, in the form *gs://bucketName/fileName*. Compressed gzip files (.gz) are supported when *fileType* is *SQL*. The instance must have write permissions to the bucket and read access to the file.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

412

},

413

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

414

"kind": "A String", # This is always *sql#operation*.

415

"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.

416

"operationType": "A String", # The type of the operation. Valid values are: *CREATE* *DELETE* *UPDATE* *RESTART* *IMPORT* *EXPORT* *BACKUP_VOLUME* *RESTORE_VOLUME* *CREATE_USER* *DELETE_USER* *CREATE_DATABASE* *DELETE_DATABASE*

417

"selfLink": "A String", # The URI of this resource.

418

"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

419

"status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*

420

"targetId": "A String", # Name of the database instance related to this operation.

421

"targetLink": "A String",

422

"targetProject": "A String", # The project ID of the target instance related to this operation.

423

"user": "A String", # The email address of the user who initiated this operation.

424

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

428

<code class="details" id="demoteMaster">demoteMaster(project, instance, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

429

<pre>Demotes the stand-alone instance to be a Cloud SQL read replica for an external database server.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

430

431

Args:

432

project: string, ID of the project that contains the instance. (required)

433

instance: string, Cloud SQL instance name. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

434

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

435

The object takes the form of:

436

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

437

{ # Database demote primary instance request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

438

"demoteMasterContext": { # Database instance demote primary instance context. # Contains details about the demoteMaster operation.

439

"kind": "A String", # This is always *sql#demoteMasterContext*.

440

"masterInstanceName": "A String", # The name of the instance which will act as on-premises primary instance in the replication setup.

441

"replicaConfiguration": { # Read-replica configuration for connecting to the on-premises primary instance. # Configuration specific to read-replicas replicating from the on-premises primary instance.

442

"kind": "A String", # This is always *sql#demoteMasterConfiguration*.

443

"mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # MySQL specific configuration when replicating from a MySQL on-premises primary instance. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named *master.info* in the data directory.

444

"caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.

445

"clientCertificate": "A String", # PEM representation of the replica's x509 certificate.

446

"clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate. The format of the replica's private key can be either PKCS #1 or PKCS #8.

447

"kind": "A String", # This is always *sql#demoteMasterMysqlReplicaConfiguration*.

448

"password": "A String", # The password for the replication connection.

449

"username": "A String", # The username for the replication connection.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

450

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

451

},

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

452

"skipReplicationSetup": True or False, # Flag to skip replication setup on the instance.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

453

"verifyGtidConsistency": True or False, # Verify GTID consistency for demote operation. Default value: *True*. Setting this flag to false enables you to bypass GTID consistency check between on-premises primary instance and Cloud SQL instance during the demotion operation but also exposes you to the risk of future replication failures. Change the value only if you know the reason for the GTID divergence and are confident that doing so will not cause any replication issues.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

454

},

455

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

456

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

457

x__xgafv: string, V1 error format.

458

Allowed values

459

1 - v1 error format

460

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

461

462

Returns:

463

An object of the form:

464

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

465

{ # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

466

"backupContext": { # Backup context. # The context for backup operation, if applicable.

467

"backupId": "A String", # The identifier of the backup.

468

"kind": "A String", # This is always *sql#backupContext*.

469

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

470

"endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

471

"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.

472

"errors": [ # The list of errors encountered while processing this operation.

473

{ # Database instance operation error.

474

"code": "A String", # Identifies the specific error that occurred.

475

"kind": "A String", # This is always *sql#operationError*.

476

"message": "A String", # Additional information about the error encountered.

477

},

478

],

479

"kind": "A String", # This is always *sql#operationErrors*.

480

},

481

"exportContext": { # Database instance export context. # The context for export operation, if applicable.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

482

"csvExportOptions": { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

483

"selectQuery": "A String", # The select query used to extract the data.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

484

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

485

"databases": [ # Databases to be exported. *MySQL instances:* If *fileType* is *SQL* and no database is specified, all databases are exported, except for the *mysql* system database. If *fileType* is *CSV*, you can specify one database, either by using this property or by using the *csvExportOptions.selectQuery* property, which takes precedence over this property. *PostgreSQL instances:* You must specify one database to be exported. If *fileType* is *CSV*, this database must match the one specified in the *csvExportOptions.selectQuery* property. *SQL Server instances:* You must specify one database to be exported, and the *fileType* must be *BAK*.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

486

"A String",

487

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

488

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. *BAK*: The file contains backup data for a SQL Server instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

489

"kind": "A String", # This is always *sql#exportContext*.

490

"offload": True or False, # Option for export offload.

491

"sqlExportOptions": { # Options for exporting data as SQL statements.

492

"mysqlExportOptions": { # Options for exporting from MySQL.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

493

"masterData": 42, # Option to include SQL statement required to set up replication. If set to *1*, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than *1*, --set-gtid-purged is set to OFF.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

494

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

495

"schemaOnly": True or False, # Export only schemas.

496

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

497

"A String",

498

],

499

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

500

"uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form *gs://bucketName/fileName*. If the file already exists, the request succeeds, but the operation fails. If *fileType* is *SQL* and the filename ends with .gz, the contents are compressed.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

501

},

502

"importContext": { # Database instance import context. # The context for import operation, if applicable.

503

"bakImportOptions": { # Import parameters specific to SQL Server .BAK files

504

"encryptionOptions": {

505

"certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

506

"pvkPassword": "A String", # Password that encrypts the private key

507

"pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

508

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

509

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

510

"csvImportOptions": { # Options for importing data as CSV.

511

"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.

512

"A String",

513

],

514

"table": "A String", # The table to which CSV data is imported.

515

},

516

"database": "A String", # The target database for the import. If *fileType* is *SQL*, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If *fileType* is *CSV*, one database must be specified.

517

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.

518

"importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.

519

"kind": "A String", # This is always *sql#importContext*.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

520

"uri": "A String", # Path to the import file in Cloud Storage, in the form *gs://bucketName/fileName*. Compressed gzip files (.gz) are supported when *fileType* is *SQL*. The instance must have write permissions to the bucket and read access to the file.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

521

},

522

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

523

"kind": "A String", # This is always *sql#operation*.

524

"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.

525

"operationType": "A String", # The type of the operation. Valid values are: *CREATE* *DELETE* *UPDATE* *RESTART* *IMPORT* *EXPORT* *BACKUP_VOLUME* *RESTORE_VOLUME* *CREATE_USER* *DELETE_USER* *CREATE_DATABASE* *DELETE_DATABASE*

526

"selfLink": "A String", # The URI of this resource.

527

"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

528

"status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*

529

"targetId": "A String", # Name of the database instance related to this operation.

530

"targetLink": "A String",

531

"targetProject": "A String", # The project ID of the target instance related to this operation.

532

"user": "A String", # The email address of the user who initiated this operation.

533

}</pre>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

537

<code class="details" id="export">export(project, instance, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

538

<pre>Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL dump or CSV file.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

539

540

Args:

541

project: string, Project ID of the project that contains the instance to be exported. (required)

542

instance: string, Cloud SQL instance ID. This does not include the project ID. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

543

body: object, The request body.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

544

The object takes the form of:

545

546

{ # Database instance export request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

547

"exportContext": { # Database instance export context. # Contains details about the export operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

548

"csvExportOptions": { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

549

"selectQuery": "A String", # The select query used to extract the data.

550

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

551

"databases": [ # Databases to be exported. *MySQL instances:* If *fileType* is *SQL* and no database is specified, all databases are exported, except for the *mysql* system database. If *fileType* is *CSV*, you can specify one database, either by using this property or by using the *csvExportOptions.selectQuery* property, which takes precedence over this property. *PostgreSQL instances:* You must specify one database to be exported. If *fileType* is *CSV*, this database must match the one specified in the *csvExportOptions.selectQuery* property. *SQL Server instances:* You must specify one database to be exported, and the *fileType* must be *BAK*.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

552

"A String",

553

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

554

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. *BAK*: The file contains backup data for a SQL Server instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

555

"kind": "A String", # This is always *sql#exportContext*.

556

"offload": True or False, # Option for export offload.

557

"sqlExportOptions": { # Options for exporting data as SQL statements.

558

"mysqlExportOptions": { # Options for exporting from MySQL.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

559

"masterData": 42, # Option to include SQL statement required to set up replication. If set to *1*, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than *1*, --set-gtid-purged is set to OFF.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

560

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

561

"schemaOnly": True or False, # Export only schemas.

562

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

563

"A String",

564

],

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

565

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

566

"uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form *gs://bucketName/fileName*. If the file already exists, the request succeeds, but the operation fails. If *fileType* is *SQL* and the filename ends with .gz, the contents are compressed.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

567

},

568

}

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

569

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

570

x__xgafv: string, V1 error format.

571

Allowed values

572

1 - v1 error format

573

2 - v2 error format

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

574

575

Returns:

576

An object of the form:

577

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

578

{ # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

579

"backupContext": { # Backup context. # The context for backup operation, if applicable.

580

"backupId": "A String", # The identifier of the backup.

581

"kind": "A String", # This is always *sql#backupContext*.

582

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

583

"endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

584

"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.

585

"errors": [ # The list of errors encountered while processing this operation.

586

{ # Database instance operation error.

587

"code": "A String", # Identifies the specific error that occurred.

588

"kind": "A String", # This is always *sql#operationError*.

589

"message": "A String", # Additional information about the error encountered.

590

},

591

],

592

"kind": "A String", # This is always *sql#operationErrors*.

593

},

594

"exportContext": { # Database instance export context. # The context for export operation, if applicable.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

595

"csvExportOptions": { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

596

"selectQuery": "A String", # The select query used to extract the data.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

597

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

598

"databases": [ # Databases to be exported. *MySQL instances:* If *fileType* is *SQL* and no database is specified, all databases are exported, except for the *mysql* system database. If *fileType* is *CSV*, you can specify one database, either by using this property or by using the *csvExportOptions.selectQuery* property, which takes precedence over this property. *PostgreSQL instances:* You must specify one database to be exported. If *fileType* is *CSV*, this database must match the one specified in the *csvExportOptions.selectQuery* property. *SQL Server instances:* You must specify one database to be exported, and the *fileType* must be *BAK*.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

599

"A String",

600

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

601

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. *BAK*: The file contains backup data for a SQL Server instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

602

"kind": "A String", # This is always *sql#exportContext*.

603

"offload": True or False, # Option for export offload.

604

"sqlExportOptions": { # Options for exporting data as SQL statements.

605

"mysqlExportOptions": { # Options for exporting from MySQL.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

606

"masterData": 42, # Option to include SQL statement required to set up replication. If set to *1*, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than *1*, --set-gtid-purged is set to OFF.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

607

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

608

"schemaOnly": True or False, # Export only schemas.

609

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

610

"A String",

611

],

612

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

613

"uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form *gs://bucketName/fileName*. If the file already exists, the request succeeds, but the operation fails. If *fileType* is *SQL* and the filename ends with .gz, the contents are compressed.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

614

},

615

"importContext": { # Database instance import context. # The context for import operation, if applicable.

616

"bakImportOptions": { # Import parameters specific to SQL Server .BAK files

617

"encryptionOptions": {

618

"certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

619

"pvkPassword": "A String", # Password that encrypts the private key

620

"pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

621

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

622

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

623

"csvImportOptions": { # Options for importing data as CSV.

624

"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.

625

"A String",

626

],

627

"table": "A String", # The table to which CSV data is imported.

628

},

629

"database": "A String", # The target database for the import. If *fileType* is *SQL*, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If *fileType* is *CSV*, one database must be specified.

630

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.

631

"importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.

632

"kind": "A String", # This is always *sql#importContext*.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

633

"uri": "A String", # Path to the import file in Cloud Storage, in the form *gs://bucketName/fileName*. Compressed gzip files (.gz) are supported when *fileType* is *SQL*. The instance must have write permissions to the bucket and read access to the file.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

634

},

635

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

636

"kind": "A String", # This is always *sql#operation*.

637

"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.

638

"operationType": "A String", # The type of the operation. Valid values are: *CREATE* *DELETE* *UPDATE* *RESTART* *IMPORT* *EXPORT* *BACKUP_VOLUME* *RESTORE_VOLUME* *CREATE_USER* *DELETE_USER* *CREATE_DATABASE* *DELETE_DATABASE*

639

"selfLink": "A String", # The URI of this resource.

640

"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

641

"status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*

642

"targetId": "A String", # Name of the database instance related to this operation.

643

"targetLink": "A String",

644

"targetProject": "A String", # The project ID of the target instance related to this operation.

645

"user": "A String", # The email address of the user who initiated this operation.

646

}</pre>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

650

<code class="details" id="failover">failover(project, instance, body=None, x__xgafv=None)</code>

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

651

<pre>Initiates a manual failover of a high availability (HA) primary instance to a standby instance, which becomes the primary instance. Users are then rerouted to the new primary. For more information, see the Overview of high availability page in the Cloud SQL documentation. If using Legacy HA (MySQL only), this causes the instance to failover to its failover replica instance.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

652

653

Args:

654

project: string, ID of the project that contains the read replica. (required)

655

instance: string, Cloud SQL instance ID. This does not include the project ID. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

656

body: object, The request body.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

657

The object takes the form of:

658

659

{ # Instance failover request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

660

"failoverContext": { # Database instance failover context. # Failover Context.

661

"kind": "A String", # This is always *sql#failoverContext*.

662

"settingsVersion": "A String", # The current settings version of this instance. Request will be rejected if this version doesn't match the current settings version.

663

},

664

}

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

665

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

666

x__xgafv: string, V1 error format.

667

Allowed values

668

1 - v1 error format

669

2 - v2 error format

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

670

671

Returns:

672

An object of the form:

673

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

674

{ # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

675

"backupContext": { # Backup context. # The context for backup operation, if applicable.

676

"backupId": "A String", # The identifier of the backup.

677

"kind": "A String", # This is always *sql#backupContext*.

678

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

679

"endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

680

"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.

681

"errors": [ # The list of errors encountered while processing this operation.

682

{ # Database instance operation error.

683

"code": "A String", # Identifies the specific error that occurred.

684

"kind": "A String", # This is always *sql#operationError*.

685

"message": "A String", # Additional information about the error encountered.

686

},

687

],

688

"kind": "A String", # This is always *sql#operationErrors*.

689

},

690

"exportContext": { # Database instance export context. # The context for export operation, if applicable.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

691

"csvExportOptions": { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

692

"selectQuery": "A String", # The select query used to extract the data.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

693

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

694

"databases": [ # Databases to be exported. *MySQL instances:* If *fileType* is *SQL* and no database is specified, all databases are exported, except for the *mysql* system database. If *fileType* is *CSV*, you can specify one database, either by using this property or by using the *csvExportOptions.selectQuery* property, which takes precedence over this property. *PostgreSQL instances:* You must specify one database to be exported. If *fileType* is *CSV*, this database must match the one specified in the *csvExportOptions.selectQuery* property. *SQL Server instances:* You must specify one database to be exported, and the *fileType* must be *BAK*.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

695

"A String",

696

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

697

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. *BAK*: The file contains backup data for a SQL Server instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

698

"kind": "A String", # This is always *sql#exportContext*.

699

"offload": True or False, # Option for export offload.

700

"sqlExportOptions": { # Options for exporting data as SQL statements.

701

"mysqlExportOptions": { # Options for exporting from MySQL.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

702

"masterData": 42, # Option to include SQL statement required to set up replication. If set to *1*, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than *1*, --set-gtid-purged is set to OFF.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

703

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

704

"schemaOnly": True or False, # Export only schemas.

705

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

706

"A String",

707

],

708

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

709

"uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form *gs://bucketName/fileName*. If the file already exists, the request succeeds, but the operation fails. If *fileType* is *SQL* and the filename ends with .gz, the contents are compressed.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

710

},

711

"importContext": { # Database instance import context. # The context for import operation, if applicable.

712

"bakImportOptions": { # Import parameters specific to SQL Server .BAK files

713

"encryptionOptions": {

714

"certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

715

"pvkPassword": "A String", # Password that encrypts the private key

716

"pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

717

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

718

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

719

"csvImportOptions": { # Options for importing data as CSV.

720

"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.

721

"A String",

722

],

723

"table": "A String", # The table to which CSV data is imported.

724

},

725

"database": "A String", # The target database for the import. If *fileType* is *SQL*, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If *fileType* is *CSV*, one database must be specified.

726

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.

727

"importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.

728

"kind": "A String", # This is always *sql#importContext*.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

729

"uri": "A String", # Path to the import file in Cloud Storage, in the form *gs://bucketName/fileName*. Compressed gzip files (.gz) are supported when *fileType* is *SQL*. The instance must have write permissions to the bucket and read access to the file.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

730

},

731

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

732

"kind": "A String", # This is always *sql#operation*.

733

"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.

734

"operationType": "A String", # The type of the operation. Valid values are: *CREATE* *DELETE* *UPDATE* *RESTART* *IMPORT* *EXPORT* *BACKUP_VOLUME* *RESTORE_VOLUME* *CREATE_USER* *DELETE_USER* *CREATE_DATABASE* *DELETE_DATABASE*

735

"selfLink": "A String", # The URI of this resource.

736

"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

737

"status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*

738

"targetId": "A String", # Name of the database instance related to this operation.

739

"targetLink": "A String",

740

"targetProject": "A String", # The project ID of the target instance related to this operation.

741

"user": "A String", # The email address of the user who initiated this operation.

742

}</pre>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

746

<code class="details" id="get">get(project, instance, x__xgafv=None)</code>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

747

<pre>Retrieves a resource containing information about a Cloud SQL instance.

748

749

Args:

750

project: string, Project ID of the project that contains the instance. (required)

751

instance: string, Database instance ID. This does not include the project ID. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

752

x__xgafv: string, V1 error format.

753

Allowed values

754

1 - v1 error format

755

2 - v2 error format

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

756

757

Returns:

758

An object of the form:

759

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

760

{ # A Cloud SQL instance resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

761

"backendType": "A String", # *SECOND_GEN*: Cloud SQL database instance. *EXTERNAL*: A database server that is not managed by Google. This property is read-only; use the *tier* property in the *settings* object to determine the database type.

762

"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

763

"createTime": "A String", # Output only. The time when the instance was created in RFC 3339 format (https://tools.ietf.org/html/rfc3339), for example 2012-11-15T16:19:00.094Z

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

764

"currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see this announcement for details.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

765

"databaseVersion": "A String", # The database engine type and version. The *databaseVersion* field cannot be changed after instance creation. MySQL instances: *MYSQL_8_0*, *MYSQL_5_7* (default), or *MYSQL_5_6*. PostgreSQL instances: *POSTGRES_9_6*, *POSTGRES_10*, *POSTGRES_11*, *POSTGRES_12*, *POSTGRES_13* (default). SQL Server instances: *SQLSERVER_2019_STANDARD*, *SQLSERVER_2019_ENTERPRISE*, *SQLSERVER_2019_EXPRESS*, or *SQLSERVER_2019_WEB*, *SQLSERVER_2017_STANDARD* (default), *SQLSERVER_2017_ENTERPRISE*, *SQLSERVER_2017_EXPRESS*, or *SQLSERVER_2017_WEB*.

766

"diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

767

"kind": "A String", # This is always *sql#diskEncryptionConfiguration*.

768

"kmsKeyName": "A String", # Resource name of KMS key for disk encryption

769

},

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

770

"diskEncryptionStatus": { # Disk encryption status for an instance. # Disk encryption status specific to an instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

771

"kind": "A String", # This is always *sql#diskEncryptionStatus*.

772

"kmsKeyVersionName": "A String", # KMS key version used to encrypt the Cloud SQL instance resource

773

},

774

"etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the *settings.settingsVersion* field instead.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

775

"failoverReplica": { # The name and status of the failover replica.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

776

"available": True or False, # The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only failover to the failover replica when the status is true.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

777

"name": "A String", # The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

778

},

779

"gceZone": "A String", # The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone.

780

"instanceType": "A String", # The instance type. This can be one of the following. *CLOUD_SQL_INSTANCE*: A Cloud SQL instance that is not replicating from a primary instance. *ON_PREMISES_INSTANCE*: An instance running on the customer's premises. *READ_REPLICA_INSTANCE*: A Cloud SQL instance configured as a read-replica.

781

"ipAddresses": [ # The assigned IP addresses for the instance.

782

{ # Database instance IP Mapping.

783

"ipAddress": "A String", # The IP address assigned.

784

"timeToRetire": "A String", # The due time for this IP to be retired in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*. This field is only available when the IP is scheduled to be retired.

785

"type": "A String", # The type of this IP address. A *PRIMARY* address is a public address that can accept incoming connections. A *PRIVATE* address is a private address that can accept incoming connections. An *OUTGOING* address is the source address of connections originating from the instance, if supported.

786

},

787

],

788

"ipv6Address": "A String", # The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances.

789

"kind": "A String", # This is always *sql#instance*.

790

"masterInstanceName": "A String", # The name of the instance which will act as primary in the replication setup.

791

"maxDiskSize": "A String", # The maximum disk size of the instance in bytes.

792

"name": "A String", # Name of the Cloud SQL instance. This does not include the project ID.

793

"onPremisesConfiguration": { # On-premises instance configuration. # Configuration specific to on-premises instances.

794

"caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.

795

"clientCertificate": "A String", # PEM representation of the replica's x509 certificate.

796

"clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.

797

"dumpFilePath": "A String", # The dump file to create the Cloud SQL replica.

798

"hostPort": "A String", # The host and port of the on-premises instance in host:port format

799

"kind": "A String", # This is always *sql#onPremisesConfiguration*.

800

"password": "A String", # The password for connecting to on-premises instance.

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

801

"sourceInstance": { # Reference to another Cloud SQL instance. # The reference to Cloud SQL instance if the source is Cloud SQL.

802

"name": "A String", # The name of the Cloud SQL instance being referenced. This does not include the project ID.

803

"project": "A String", # The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it.

804

"region": "A String", # The region of the Cloud SQL instance being referenced.

805

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

806

"username": "A String", # The username for connecting to on-premises instance.

807

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

808

"outOfDiskReport": { # This message wraps up the information written by out-of-disk detection job. # This field represents the report generated by the proactive database wellness job for OutOfDisk issues. Writers: -- the proactive database wellness job for OOD. Readers: -- the proactive database wellness job

809

"sqlMinRecommendedIncreaseSizeGb": 42, # The minimum recommended increase size in GigaBytes This field is consumed by the frontend Writers: -- the proactive database wellness job for OOD.

810

"sqlOutOfDiskState": "A String", # This field represents the state generated by the proactive database wellness job for OutOfDisk issues. Writers: -- the proactive database wellness job for OOD. Readers: -- the proactive database wellness job

yoshi-code-bot

2021-04-27 05:08:04 -0700

[diff] [blame]

811

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

812

"project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.

813

"region": "A String", # The geographical region. Can be *us-central* (*FIRST_GEN* instances only) *us-central1* (*SECOND_GEN* instances only) *asia-east1* or *europe-west1*. Defaults to *us-central* or *us-central1* depending on the instance type. The region cannot be changed after instance creation.

814

"replicaConfiguration": { # Read-replica configuration for connecting to the primary instance. # Configuration specific to failover replicas and read replicas.

815

"failoverTarget": True or False, # Specifies if the replica is the failover target. If the field is set to *true* the replica will be designated as a failover replica. In case the primary instance fails, the replica instance will be promoted as the new primary instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the primary instance.

816

"kind": "A String", # This is always *sql#replicaConfiguration*.

817

"mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # MySQL specific configuration when replicating from a MySQL on-premises primary instance. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named *master.info* in the data directory.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

818

"caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

819

"clientCertificate": "A String", # PEM representation of the replica's x509 certificate.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

820

"clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

821

"connectRetryInterval": 42, # Seconds to wait between connect retries. MySQL's default is 60 seconds.

822

"dumpFilePath": "A String", # Path to a SQL dump file in Google Cloud Storage from which the replica instance is to be created. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported. Dumps have the binlog co-ordinates from which replication begins. This can be accomplished by setting --master-data to 1 when using mysqldump.

823

"kind": "A String", # This is always *sql#mysqlReplicaConfiguration*.

824

"masterHeartbeatPeriod": "A String", # Interval in milliseconds between replication heartbeats.

825

"password": "A String", # The password for the replication connection.

826

"sslCipher": "A String", # A list of permissible ciphers to use for SSL encryption.

827

"username": "A String", # The username for the replication connection.

828

"verifyServerCertificate": True or False, # Whether or not to check the primary instance's Common Name value in the certificate that it sends during the SSL handshake.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

829

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

830

},

831

"replicaNames": [ # The replicas of the instance.

832

"A String",

833

],

834

"rootPassword": "A String", # Initial root password. Use only on creation.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

835

"satisfiesPzs": True or False, # The status indicating if instance satisfiesPzs. Reserved for future use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

836

"scheduledMaintenance": { # Any scheduled maintenancce for this instance. # The start time of any upcoming scheduled maintenance for this instance.

837

"canDefer": True or False,

838

"canReschedule": True or False, # If the scheduled maintenance can be rescheduled.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

839

"scheduleDeadlineTime": "A String", # Maintenance cannot be rescheduled to start beyond this deadline.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

840

"startTime": "A String", # The start time of any upcoming scheduled maintenance for this instance.

841

},

842

"secondaryGceZone": "A String", # The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone. Reserved for future use.

843

"selfLink": "A String", # The URI of this resource.

844

"serverCaCert": { # SslCerts Resource # SSL configuration.

845

"cert": "A String", # PEM representation.

846

"certSerialNumber": "A String", # Serial number, as extracted from the certificate.

847

"commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.

848

"createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*

849

"expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

850

"instance": "A String", # Name of the database instance.

851

"kind": "A String", # This is always *sql#sslCert*.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

852

"selfLink": "A String", # The URI of this resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

853

"sha1Fingerprint": "A String", # Sha1 Fingerprint.

854

},

yoshi-code-bot

2021-06-03 00:48:27 -0700

[diff] [blame]

855

"serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance. This property is read-only.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

856

"settings": { # Database instance settings. # The user settings.

857

"activationPolicy": "A String", # The activation policy specifies when the instance is activated; it is applicable only when the instance state is RUNNABLE. Valid values: *ALWAYS*: The instance is on, and remains so even in the absence of connection requests. *NEVER*: The instance is off; it is not activated, even if a connection request arrives.

858

"activeDirectoryConfig": { # Active Directory configuration, relevant only for Cloud SQL for SQL Server. # Active Directory configuration, relevant only for Cloud SQL for SQL Server.

859

"domain": "A String", # The name of the domain (e.g., mydomain.com).

860

"kind": "A String", # This is always sql#activeDirectoryConfig.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

861

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

862

"authorizedGaeApplications": [ # The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only.

863

"A String",

864

],

865

"availabilityType": "A String", # Availability type. Potential values: *ZONAL*: The instance serves data from only one zone. Outages in that zone affect data accessibility. *REGIONAL*: The instance can serve data from more than one zone in a region (it is highly available). For more information, see Overview of the High Availability Configuration.

866

"backupConfiguration": { # Database instance backup configuration. # The daily backup configuration for the instance.

867

"backupRetentionSettings": { # We currently only support backup retention by specifying the number of backups we will retain. # Backup retention settings.

868

"retainedBackups": 42, # Depending on the value of retention_unit, this is used to determine if a backup needs to be deleted. If retention_unit is 'COUNT', we will retain this many backups.

869

"retentionUnit": "A String", # The unit that 'retained_backups' represents.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

870

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

871

"binaryLogEnabled": True or False, # (MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well.

872

"enabled": True or False, # Whether this configuration is enabled.

873

"kind": "A String", # This is always *sql#backupConfiguration*.

874

"location": "A String", # Location of the backup

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

875

"pointInTimeRecoveryEnabled": True or False, # (Postgres only) Whether point in time recovery is enabled.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

876

"replicationLogArchivingEnabled": True or False, # Reserved for future use.

877

"startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - *HH:MM*.

878

"transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

879

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

880

"collation": "A String", # The name of server Instance collation.

881

"crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.

882

"dataDiskSizeGb": "A String", # The size of data disk, in GB. The data disk size minimum is 10GB.

883

"dataDiskType": "A String", # The type of data disk: PD_SSD (default) or PD_HDD. Not used for First Generation instances.

884

"databaseFlags": [ # The database flags passed to the instance at startup.

885

{ # Database flags for Cloud SQL instances.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

886

"name": "A String", # The name of the flag. These flags are passed at instance startup, so include both server options and system variables. Flags are specified with underscores, not hyphens. For more information, see Configuring Database Flags in the Cloud SQL documentation.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

887

"value": "A String", # The value of the flag. Booleans are set to *on* for true and *off* for false. This field must be omitted if the flag doesn't take a value.

888

},

889

],

890

"databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not.

891

"denyMaintenancePeriods": [ # Deny maintenance periods

892

{ # Deny Maintenance Periods. This specifies a date range during when all CSA rollout will be denied.

893

"endDate": "A String", # "deny maintenance period" end date. If the year of the end date is empty, the year of the start date also must be empty. In this case, it means the deny maintenance period recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01

894

"startDate": "A String", # "deny maintenance period" start date. If the year of the start date is empty, the year of the end date also must be empty. In this case, it means the deny maintenance period recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01

895

"time": "A String", # Time in UTC when the "deny maintenance period" starts on start_date and ends on end_date. The time is in format: HH:mm:SS, i.e., 00:00:00

896

},

897

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

898

"insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres.

899

"queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

900

"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. Default is 5.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

901

"queryStringLength": 42, # Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query length more than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

902

"recordApplicationTags": True or False, # Whether Query Insights will record application tags from query when enabled.

903

"recordClientAddress": True or False, # Whether Query Insights will record client address when enabled.

904

},

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

905

"ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled.

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

906

"allocatedIpRange": "A String", # The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with [RFC 1035](https://tools.ietf.org/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?.` Reserved for future use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

907

"authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: *192.168.100.0/24*).

908

{ # An entry for an Access Control list.

909

"expirationTime": "A String", # The time when this access control entry expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

910

"kind": "A String", # This is always *sql#aclEntry*.

911

"name": "A String", # Optional. A label to identify this entry.

912

"value": "A String", # The allowlisted value for the access control list.

913

},

914

],

915

"ipv4Enabled": True or False, # Whether the instance is assigned a public IP address or not.

916

"privateNetwork": "A String", # The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, */projects/myProject/global/networks/default*. This setting can be updated, but it cannot be removed after it is set.

917

"requireSsl": True or False, # Whether SSL connections over IP are enforced or not.

918

},

919

"kind": "A String", # This is always *sql#settings*.

920

"locationPreference": { # Preferred location. This specifies where a Cloud SQL instance is located, either in a specific Compute Engine zone, or co-located with an App Engine application. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or Compute Engine zone for better performance. App Engine co-location was only applicable to First Generation instances.

921

"followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance.

922

"kind": "A String", # This is always *sql#locationPreference*.

923

"secondaryZone": "A String", # The preferred Compute Engine zone for the secondary/failover (for example: us-central1-a, us-central1-b, etc.). Reserved for future use.

924

"zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.).

925

},

926

"maintenanceWindow": { # Maintenance window. This specifies when a Cloud SQL instance is restarted for system maintenance purposes. # The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes.

927

"day": 42, # day of week (1-7), starting on Monday.

928

"hour": 42, # hour of day - 0 to 23.

929

"kind": "A String", # This is always *sql#maintenanceWindow*.

930

"updateTrack": "A String", # Maintenance timing setting: *canary* (Earlier) or *stable* (Later). Learn more.

931

},

932

"pricingPlan": "A String", # The pricing plan for this instance. This can be either *PER_USE* or *PACKAGE*. Only *PER_USE* is supported for Second Generation instances.

933

"replicationType": "A String", # The type of replication this instance uses. This can be either *ASYNCHRONOUS* or *SYNCHRONOUS*. (Deprecated_ This property was only applicable to First Generation instances.

934

"settingsVersion": "A String", # The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.

935

"storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is true.

936

"storageAutoResizeLimit": "A String", # The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

937

"tier": "A String", # The tier (or machine type) for this instance, for example *db-custom-1-3840* .

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

938

"userLabels": { # User-provided labels, represented as a dictionary where each label is a single key value pair.

939

"a_key": "A String",

940

},

941

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

942

"state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following. *SQL_INSTANCE_STATE_UNSPECIFIED*: The state of the instance is unknown. *RUNNABLE*: The instance is running, or has been stopped by owner. *SUSPENDED*: The instance is not available, for example due to problems with billing. *PENDING_DELETE*: The instance is being deleted. *PENDING_CREATE*: The instance is being created. *MAINTENANCE*: The instance is down for maintenance. *FAILED*: The instance creation failed.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

943

"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension.

944

"A String",

945

],

946

}</pre>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

950

<code class="details" id="import_">import_(project, instance, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

951

<pre>Imports data into a Cloud SQL instance from a SQL dump or CSV file in Cloud Storage.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

952

953

Args:

954

project: string, Project ID of the project that contains the instance. (required)

955

instance: string, Cloud SQL instance ID. This does not include the project ID. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

956

body: object, The request body.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

957

The object takes the form of:

958

959

{ # Database instance import request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

960

"importContext": { # Database instance import context. # Contains details about the import operation.

961

"bakImportOptions": { # Import parameters specific to SQL Server .BAK files

962

"encryptionOptions": {

963

"certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

964

"pvkPassword": "A String", # Password that encrypts the private key

965

"pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

966

},

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

967

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

968

"csvImportOptions": { # Options for importing data as CSV.

969

"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.

970

"A String",

971

],

972

"table": "A String", # The table to which CSV data is imported.

973

},

974

"database": "A String", # The target database for the import. If *fileType* is *SQL*, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If *fileType* is *CSV*, one database must be specified.

975

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.

976

"importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.

977

"kind": "A String", # This is always *sql#importContext*.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

978

"uri": "A String", # Path to the import file in Cloud Storage, in the form *gs://bucketName/fileName*. Compressed gzip files (.gz) are supported when *fileType* is *SQL*. The instance must have write permissions to the bucket and read access to the file.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

979

},

980

}

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

981

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

982

x__xgafv: string, V1 error format.

983

Allowed values

984

1 - v1 error format

985

2 - v2 error format

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

986

987

Returns:

988

An object of the form:

989

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

990

{ # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

991

"backupContext": { # Backup context. # The context for backup operation, if applicable.

992

"backupId": "A String", # The identifier of the backup.

993

"kind": "A String", # This is always *sql#backupContext*.

994

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

995

"endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

996

"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.

997

"errors": [ # The list of errors encountered while processing this operation.

998

{ # Database instance operation error.

999

"code": "A String", # Identifies the specific error that occurred.

1000

"kind": "A String", # This is always *sql#operationError*.

1001

"message": "A String", # Additional information about the error encountered.

1002

},

1003

],

1004

"kind": "A String", # This is always *sql#operationErrors*.

1005

},

1006

"exportContext": { # Database instance export context. # The context for export operation, if applicable.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1007

"csvExportOptions": { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1008

"selectQuery": "A String", # The select query used to extract the data.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1009

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1010

"databases": [ # Databases to be exported. *MySQL instances:* If *fileType* is *SQL* and no database is specified, all databases are exported, except for the *mysql* system database. If *fileType* is *CSV*, you can specify one database, either by using this property or by using the *csvExportOptions.selectQuery* property, which takes precedence over this property. *PostgreSQL instances:* You must specify one database to be exported. If *fileType* is *CSV*, this database must match the one specified in the *csvExportOptions.selectQuery* property. *SQL Server instances:* You must specify one database to be exported, and the *fileType* must be *BAK*.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1011

"A String",

1012

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1013

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. *BAK*: The file contains backup data for a SQL Server instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1014

"kind": "A String", # This is always *sql#exportContext*.

1015

"offload": True or False, # Option for export offload.

1016

"sqlExportOptions": { # Options for exporting data as SQL statements.

1017

"mysqlExportOptions": { # Options for exporting from MySQL.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1018

"masterData": 42, # Option to include SQL statement required to set up replication. If set to *1*, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than *1*, --set-gtid-purged is set to OFF.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1019

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1020

"schemaOnly": True or False, # Export only schemas.

1021

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1022

"A String",

1023

],

1024

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1025

"uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form *gs://bucketName/fileName*. If the file already exists, the request succeeds, but the operation fails. If *fileType* is *SQL* and the filename ends with .gz, the contents are compressed.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1026

},

1027

"importContext": { # Database instance import context. # The context for import operation, if applicable.

1028

"bakImportOptions": { # Import parameters specific to SQL Server .BAK files

1029

"encryptionOptions": {

1030

"certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

1031

"pvkPassword": "A String", # Password that encrypts the private key

1032

"pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1033

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1034

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1035

"csvImportOptions": { # Options for importing data as CSV.

1036

"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.

1037

"A String",

1038

],

1039

"table": "A String", # The table to which CSV data is imported.

1040

},

1041

"database": "A String", # The target database for the import. If *fileType* is *SQL*, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If *fileType* is *CSV*, one database must be specified.

1042

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.

1043

"importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.

1044

"kind": "A String", # This is always *sql#importContext*.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1045

"uri": "A String", # Path to the import file in Cloud Storage, in the form *gs://bucketName/fileName*. Compressed gzip files (.gz) are supported when *fileType* is *SQL*. The instance must have write permissions to the bucket and read access to the file.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1046

},

1047

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

1048

"kind": "A String", # This is always *sql#operation*.

1049

"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.

1050

"operationType": "A String", # The type of the operation. Valid values are: *CREATE* *DELETE* *UPDATE* *RESTART* *IMPORT* *EXPORT* *BACKUP_VOLUME* *RESTORE_VOLUME* *CREATE_USER* *DELETE_USER* *CREATE_DATABASE* *DELETE_DATABASE*

1051

"selfLink": "A String", # The URI of this resource.

1052

"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

1053

"status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*

1054

"targetId": "A String", # Name of the database instance related to this operation.

1055

"targetLink": "A String",

1056

"targetProject": "A String", # The project ID of the target instance related to this operation.

1057

"user": "A String", # The email address of the user who initiated this operation.

1058

}</pre>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1062

<code class="details" id="insert">insert(project, body=None, x__xgafv=None)</code>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

1063

<pre>Creates a new Cloud SQL instance.

1064

1065

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1066

project: string, Project ID of the project to which the newly created Cloud SQL instances should belong. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1067

body: object, The request body.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

1068

The object takes the form of:

1069

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1070

{ # A Cloud SQL instance resource.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1071

"backendType": "A String", # *SECOND_GEN*: Cloud SQL database instance. *EXTERNAL*: A database server that is not managed by Google. This property is read-only; use the *tier* property in the *settings* object to determine the database type.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1072

"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

1073

"createTime": "A String", # Output only. The time when the instance was created in RFC 3339 format (https://tools.ietf.org/html/rfc3339), for example 2012-11-15T16:19:00.094Z

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1074

"currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see this announcement for details.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

1075

"databaseVersion": "A String", # The database engine type and version. The *databaseVersion* field cannot be changed after instance creation. MySQL instances: *MYSQL_8_0*, *MYSQL_5_7* (default), or *MYSQL_5_6*. PostgreSQL instances: *POSTGRES_9_6*, *POSTGRES_10*, *POSTGRES_11*, *POSTGRES_12*, *POSTGRES_13* (default). SQL Server instances: *SQLSERVER_2019_STANDARD*, *SQLSERVER_2019_ENTERPRISE*, *SQLSERVER_2019_EXPRESS*, or *SQLSERVER_2019_WEB*, *SQLSERVER_2017_STANDARD* (default), *SQLSERVER_2017_ENTERPRISE*, *SQLSERVER_2017_EXPRESS*, or *SQLSERVER_2017_WEB*.

1076

"diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1077

"kind": "A String", # This is always *sql#diskEncryptionConfiguration*.

1078

"kmsKeyName": "A String", # Resource name of KMS key for disk encryption

1079

},

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

1080

"diskEncryptionStatus": { # Disk encryption status for an instance. # Disk encryption status specific to an instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1081

"kind": "A String", # This is always *sql#diskEncryptionStatus*.

1082

"kmsKeyVersionName": "A String", # KMS key version used to encrypt the Cloud SQL instance resource

1083

},

1084

"etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the *settings.settingsVersion* field instead.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

1085

"failoverReplica": { # The name and status of the failover replica.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1086

"available": True or False, # The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only failover to the failover replica when the status is true.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

1087

"name": "A String", # The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1088

},

1089

"gceZone": "A String", # The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone.

1090

"instanceType": "A String", # The instance type. This can be one of the following. *CLOUD_SQL_INSTANCE*: A Cloud SQL instance that is not replicating from a primary instance. *ON_PREMISES_INSTANCE*: An instance running on the customer's premises. *READ_REPLICA_INSTANCE*: A Cloud SQL instance configured as a read-replica.

1091

"ipAddresses": [ # The assigned IP addresses for the instance.

1092

{ # Database instance IP Mapping.

1093

"ipAddress": "A String", # The IP address assigned.

1094

"timeToRetire": "A String", # The due time for this IP to be retired in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*. This field is only available when the IP is scheduled to be retired.

1095

"type": "A String", # The type of this IP address. A *PRIMARY* address is a public address that can accept incoming connections. A *PRIVATE* address is a private address that can accept incoming connections. An *OUTGOING* address is the source address of connections originating from the instance, if supported.

1096

},

1097

],

1098

"ipv6Address": "A String", # The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances.

1099

"kind": "A String", # This is always *sql#instance*.

1100

"masterInstanceName": "A String", # The name of the instance which will act as primary in the replication setup.

1101

"maxDiskSize": "A String", # The maximum disk size of the instance in bytes.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1102

"name": "A String", # Name of the Cloud SQL instance. This does not include the project ID.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1103

"onPremisesConfiguration": { # On-premises instance configuration. # Configuration specific to on-premises instances.

1104

"caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.

1105

"clientCertificate": "A String", # PEM representation of the replica's x509 certificate.

1106

"clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.

1107

"dumpFilePath": "A String", # The dump file to create the Cloud SQL replica.

1108

"hostPort": "A String", # The host and port of the on-premises instance in host:port format

1109

"kind": "A String", # This is always *sql#onPremisesConfiguration*.

1110

"password": "A String", # The password for connecting to on-premises instance.

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

1111

"sourceInstance": { # Reference to another Cloud SQL instance. # The reference to Cloud SQL instance if the source is Cloud SQL.

1112

"name": "A String", # The name of the Cloud SQL instance being referenced. This does not include the project ID.

1113

"project": "A String", # The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it.

1114

"region": "A String", # The region of the Cloud SQL instance being referenced.

1115

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1116

"username": "A String", # The username for connecting to on-premises instance.

1117

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1118

"outOfDiskReport": { # This message wraps up the information written by out-of-disk detection job. # This field represents the report generated by the proactive database wellness job for OutOfDisk issues. Writers: -- the proactive database wellness job for OOD. Readers: -- the proactive database wellness job

1119

"sqlMinRecommendedIncreaseSizeGb": 42, # The minimum recommended increase size in GigaBytes This field is consumed by the frontend Writers: -- the proactive database wellness job for OOD.

1120

"sqlOutOfDiskState": "A String", # This field represents the state generated by the proactive database wellness job for OutOfDisk issues. Writers: -- the proactive database wellness job for OOD. Readers: -- the proactive database wellness job

yoshi-code-bot

2021-04-27 05:08:04 -0700

[diff] [blame]

1121

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1122

"project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.

1123

"region": "A String", # The geographical region. Can be *us-central* (*FIRST_GEN* instances only) *us-central1* (*SECOND_GEN* instances only) *asia-east1* or *europe-west1*. Defaults to *us-central* or *us-central1* depending on the instance type. The region cannot be changed after instance creation.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1124

"replicaConfiguration": { # Read-replica configuration for connecting to the primary instance. # Configuration specific to failover replicas and read replicas.

1125

"failoverTarget": True or False, # Specifies if the replica is the failover target. If the field is set to *true* the replica will be designated as a failover replica. In case the primary instance fails, the replica instance will be promoted as the new primary instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the primary instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1126

"kind": "A String", # This is always *sql#replicaConfiguration*.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1127

"mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # MySQL specific configuration when replicating from a MySQL on-premises primary instance. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named *master.info* in the data directory.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1128

"caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1129

"clientCertificate": "A String", # PEM representation of the replica's x509 certificate.

1130

"clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1131

"connectRetryInterval": 42, # Seconds to wait between connect retries. MySQL's default is 60 seconds.

1132

"dumpFilePath": "A String", # Path to a SQL dump file in Google Cloud Storage from which the replica instance is to be created. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported. Dumps have the binlog co-ordinates from which replication begins. This can be accomplished by setting --master-data to 1 when using mysqldump.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1133

"kind": "A String", # This is always *sql#mysqlReplicaConfiguration*.

1134

"masterHeartbeatPeriod": "A String", # Interval in milliseconds between replication heartbeats.

1135

"password": "A String", # The password for the replication connection.

1136

"sslCipher": "A String", # A list of permissible ciphers to use for SSL encryption.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1137

"username": "A String", # The username for the replication connection.

1138

"verifyServerCertificate": True or False, # Whether or not to check the primary instance's Common Name value in the certificate that it sends during the SSL handshake.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1139

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1140

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1141

"replicaNames": [ # The replicas of the instance.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1142

"A String",

1143

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1144

"rootPassword": "A String", # Initial root password. Use only on creation.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1145

"satisfiesPzs": True or False, # The status indicating if instance satisfiesPzs. Reserved for future use.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1146

"scheduledMaintenance": { # Any scheduled maintenancce for this instance. # The start time of any upcoming scheduled maintenance for this instance.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1147

"canDefer": True or False,

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1148

"canReschedule": True or False, # If the scheduled maintenance can be rescheduled.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

1149

"scheduleDeadlineTime": "A String", # Maintenance cannot be rescheduled to start beyond this deadline.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1150

"startTime": "A String", # The start time of any upcoming scheduled maintenance for this instance.

1151

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1152

"secondaryGceZone": "A String", # The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone. Reserved for future use.

1153

"selfLink": "A String", # The URI of this resource.

1154

"serverCaCert": { # SslCerts Resource # SSL configuration.

1155

"cert": "A String", # PEM representation.

1156

"certSerialNumber": "A String", # Serial number, as extracted from the certificate.

1157

"commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.

1158

"createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*

1159

"expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

1160

"instance": "A String", # Name of the database instance.

1161

"kind": "A String", # This is always *sql#sslCert*.

1162

"selfLink": "A String", # The URI of this resource.

1163

"sha1Fingerprint": "A String", # Sha1 Fingerprint.

1164

},

yoshi-code-bot

2021-06-03 00:48:27 -0700

[diff] [blame]

1165

"serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance. This property is read-only.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1166

"settings": { # Database instance settings. # The user settings.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1167

"activationPolicy": "A String", # The activation policy specifies when the instance is activated; it is applicable only when the instance state is RUNNABLE. Valid values: *ALWAYS*: The instance is on, and remains so even in the absence of connection requests. *NEVER*: The instance is off; it is not activated, even if a connection request arrives.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1168

"activeDirectoryConfig": { # Active Directory configuration, relevant only for Cloud SQL for SQL Server. # Active Directory configuration, relevant only for Cloud SQL for SQL Server.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1169

"domain": "A String", # The name of the domain (e.g., mydomain.com).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1170

"kind": "A String", # This is always sql#activeDirectoryConfig.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1171

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1172

"authorizedGaeApplications": [ # The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1173

"A String",

1174

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1175

"availabilityType": "A String", # Availability type. Potential values: *ZONAL*: The instance serves data from only one zone. Outages in that zone affect data accessibility. *REGIONAL*: The instance can serve data from more than one zone in a region (it is highly available). For more information, see Overview of the High Availability Configuration.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1176

"backupConfiguration": { # Database instance backup configuration. # The daily backup configuration for the instance.

1177

"backupRetentionSettings": { # We currently only support backup retention by specifying the number of backups we will retain. # Backup retention settings.

1178

"retainedBackups": 42, # Depending on the value of retention_unit, this is used to determine if a backup needs to be deleted. If retention_unit is 'COUNT', we will retain this many backups.

1179

"retentionUnit": "A String", # The unit that 'retained_backups' represents.

1180

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1181

"binaryLogEnabled": True or False, # (MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1182

"enabled": True or False, # Whether this configuration is enabled.

1183

"kind": "A String", # This is always *sql#backupConfiguration*.

1184

"location": "A String", # Location of the backup

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

1185

"pointInTimeRecoveryEnabled": True or False, # (Postgres only) Whether point in time recovery is enabled.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1186

"replicationLogArchivingEnabled": True or False, # Reserved for future use.

1187

"startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - *HH:MM*.

1188

"transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7.

1189

},

1190

"collation": "A String", # The name of server Instance collation.

1191

"crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.

1192

"dataDiskSizeGb": "A String", # The size of data disk, in GB. The data disk size minimum is 10GB.

1193

"dataDiskType": "A String", # The type of data disk: PD_SSD (default) or PD_HDD. Not used for First Generation instances.

1194

"databaseFlags": [ # The database flags passed to the instance at startup.

1195

{ # Database flags for Cloud SQL instances.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

1196

"name": "A String", # The name of the flag. These flags are passed at instance startup, so include both server options and system variables. Flags are specified with underscores, not hyphens. For more information, see Configuring Database Flags in the Cloud SQL documentation.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1197

"value": "A String", # The value of the flag. Booleans are set to *on* for true and *off* for false. This field must be omitted if the flag doesn't take a value.

1198

},

1199

],

1200

"databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not.

1201

"denyMaintenancePeriods": [ # Deny maintenance periods

1202

{ # Deny Maintenance Periods. This specifies a date range during when all CSA rollout will be denied.

1203

"endDate": "A String", # "deny maintenance period" end date. If the year of the end date is empty, the year of the start date also must be empty. In this case, it means the deny maintenance period recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01

1204

"startDate": "A String", # "deny maintenance period" start date. If the year of the start date is empty, the year of the end date also must be empty. In this case, it means the deny maintenance period recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01

1205

"time": "A String", # Time in UTC when the "deny maintenance period" starts on start_date and ends on end_date. The time is in format: HH:mm:SS, i.e., 00:00:00

1206

},

1207

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1208

"insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres.

1209

"queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

1210

"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. Default is 5.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1211

"queryStringLength": 42, # Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query length more than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1212

"recordApplicationTags": True or False, # Whether Query Insights will record application tags from query when enabled.

1213

"recordClientAddress": True or False, # Whether Query Insights will record client address when enabled.

1214

},

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

1215

"ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled.

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

1216

"allocatedIpRange": "A String", # The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with [RFC 1035](https://tools.ietf.org/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?.` Reserved for future use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1217

"authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: *192.168.100.0/24*).

1218

{ # An entry for an Access Control list.

1219

"expirationTime": "A String", # The time when this access control entry expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

1220

"kind": "A String", # This is always *sql#aclEntry*.

1221

"name": "A String", # Optional. A label to identify this entry.

1222

"value": "A String", # The allowlisted value for the access control list.

1223

},

1224

],

1225

"ipv4Enabled": True or False, # Whether the instance is assigned a public IP address or not.

1226

"privateNetwork": "A String", # The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, */projects/myProject/global/networks/default*. This setting can be updated, but it cannot be removed after it is set.

1227

"requireSsl": True or False, # Whether SSL connections over IP are enforced or not.

1228

},

1229

"kind": "A String", # This is always *sql#settings*.

1230

"locationPreference": { # Preferred location. This specifies where a Cloud SQL instance is located, either in a specific Compute Engine zone, or co-located with an App Engine application. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or Compute Engine zone for better performance. App Engine co-location was only applicable to First Generation instances.

1231

"followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance.

1232

"kind": "A String", # This is always *sql#locationPreference*.

1233

"secondaryZone": "A String", # The preferred Compute Engine zone for the secondary/failover (for example: us-central1-a, us-central1-b, etc.). Reserved for future use.

1234

"zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.).

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1235

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1236

"maintenanceWindow": { # Maintenance window. This specifies when a Cloud SQL instance is restarted for system maintenance purposes. # The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes.

1237

"day": 42, # day of week (1-7), starting on Monday.

1238

"hour": 42, # hour of day - 0 to 23.

1239

"kind": "A String", # This is always *sql#maintenanceWindow*.

1240

"updateTrack": "A String", # Maintenance timing setting: *canary* (Earlier) or *stable* (Later). Learn more.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1241

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1242

"pricingPlan": "A String", # The pricing plan for this instance. This can be either *PER_USE* or *PACKAGE*. Only *PER_USE* is supported for Second Generation instances.

1243

"replicationType": "A String", # The type of replication this instance uses. This can be either *ASYNCHRONOUS* or *SYNCHRONOUS*. (Deprecated_ This property was only applicable to First Generation instances.

1244

"settingsVersion": "A String", # The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.

1245

"storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is true.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1246

"storageAutoResizeLimit": "A String", # The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

1247

"tier": "A String", # The tier (or machine type) for this instance, for example *db-custom-1-3840* .

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1248

"userLabels": { # User-provided labels, represented as a dictionary where each label is a single key value pair.

1249

"a_key": "A String",

1250

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1251

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1252

"state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following. *SQL_INSTANCE_STATE_UNSPECIFIED*: The state of the instance is unknown. *RUNNABLE*: The instance is running, or has been stopped by owner. *SUSPENDED*: The instance is not available, for example due to problems with billing. *PENDING_DELETE*: The instance is being deleted. *PENDING_CREATE*: The instance is being created. *MAINTENANCE*: The instance is down for maintenance. *FAILED*: The instance creation failed.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1253

"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension.

1254

"A String",

1255

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1256

}

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

1257

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1258

x__xgafv: string, V1 error format.

1259

Allowed values

1260

1 - v1 error format

1261

2 - v2 error format

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

1262

1263

Returns:

1264

An object of the form:

1265

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1266

{ # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1267

"backupContext": { # Backup context. # The context for backup operation, if applicable.

1268

"backupId": "A String", # The identifier of the backup.

1269

"kind": "A String", # This is always *sql#backupContext*.

1270

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1271

"endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

1272

"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.

1273

"errors": [ # The list of errors encountered while processing this operation.

1274

{ # Database instance operation error.

1275

"code": "A String", # Identifies the specific error that occurred.

1276

"kind": "A String", # This is always *sql#operationError*.

1277

"message": "A String", # Additional information about the error encountered.

1278

},

1279

],

1280

"kind": "A String", # This is always *sql#operationErrors*.

1281

},

1282

"exportContext": { # Database instance export context. # The context for export operation, if applicable.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1283

"csvExportOptions": { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1284

"selectQuery": "A String", # The select query used to extract the data.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1285

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1286

"databases": [ # Databases to be exported. *MySQL instances:* If *fileType* is *SQL* and no database is specified, all databases are exported, except for the *mysql* system database. If *fileType* is *CSV*, you can specify one database, either by using this property or by using the *csvExportOptions.selectQuery* property, which takes precedence over this property. *PostgreSQL instances:* You must specify one database to be exported. If *fileType* is *CSV*, this database must match the one specified in the *csvExportOptions.selectQuery* property. *SQL Server instances:* You must specify one database to be exported, and the *fileType* must be *BAK*.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1287

"A String",

1288

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1289

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. *BAK*: The file contains backup data for a SQL Server instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1290

"kind": "A String", # This is always *sql#exportContext*.

1291

"offload": True or False, # Option for export offload.

1292

"sqlExportOptions": { # Options for exporting data as SQL statements.

1293

"mysqlExportOptions": { # Options for exporting from MySQL.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1294

"masterData": 42, # Option to include SQL statement required to set up replication. If set to *1*, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than *1*, --set-gtid-purged is set to OFF.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1295

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1296

"schemaOnly": True or False, # Export only schemas.

1297

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1298

"A String",

1299

],

1300

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1301

"uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form *gs://bucketName/fileName*. If the file already exists, the request succeeds, but the operation fails. If *fileType* is *SQL* and the filename ends with .gz, the contents are compressed.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1302

},

1303

"importContext": { # Database instance import context. # The context for import operation, if applicable.

1304

"bakImportOptions": { # Import parameters specific to SQL Server .BAK files

1305

"encryptionOptions": {

1306

"certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

1307

"pvkPassword": "A String", # Password that encrypts the private key

1308

"pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1309

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1310

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1311

"csvImportOptions": { # Options for importing data as CSV.

1312

"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.

1313

"A String",

1314

],

1315

"table": "A String", # The table to which CSV data is imported.

1316

},

1317

"database": "A String", # The target database for the import. If *fileType* is *SQL*, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If *fileType* is *CSV*, one database must be specified.

1318

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.

1319

"importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.

1320

"kind": "A String", # This is always *sql#importContext*.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1321

"uri": "A String", # Path to the import file in Cloud Storage, in the form *gs://bucketName/fileName*. Compressed gzip files (.gz) are supported when *fileType* is *SQL*. The instance must have write permissions to the bucket and read access to the file.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1322

},

1323

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

1324

"kind": "A String", # This is always *sql#operation*.

1325

"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.

1326

"operationType": "A String", # The type of the operation. Valid values are: *CREATE* *DELETE* *UPDATE* *RESTART* *IMPORT* *EXPORT* *BACKUP_VOLUME* *RESTORE_VOLUME* *CREATE_USER* *DELETE_USER* *CREATE_DATABASE* *DELETE_DATABASE*

1327

"selfLink": "A String", # The URI of this resource.

1328

"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

1329

"status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*

1330

"targetId": "A String", # Name of the database instance related to this operation.

1331

"targetLink": "A String",

1332

"targetProject": "A String", # The project ID of the target instance related to this operation.

1333

"user": "A String", # The email address of the user who initiated this operation.

1334

}</pre>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

</div>

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1338

<code class="details" id="list">list(project, filter=None, maxResults=None, pageToken=None, x__xgafv=None)</code>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1339

<pre>Lists instances under a given project.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

1340

1341

Args:

1342

project: string, Project ID of the project for which to list Cloud SQL instances. (required)

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame]

1343

filter: string, A filter expression that filters resources listed in the response. The expression is in the form of field:value. For example, 'instanceType:CLOUD_SQL_INSTANCE'. Fields can be nested as needed as per their JSON representation, such as 'settings.userLabels.auto_start:true'. Multiple filter queries are space-separated. For example. 'state:RUNNABLE instanceType:CLOUD_SQL_INSTANCE'. By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1344

maxResults: integer, The maximum number of results to return per response.

1345

pageToken: string, A previously-returned page token representing part of the larger set of results to view.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1346

x__xgafv: string, V1 error format.

1347

Allowed values

1348

1 - v1 error format

1349

2 - v2 error format

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

1350

1351

Returns:

1352

An object of the form:

1353

1354

{ # Database instances list response.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1355

"items": [ # List of database instance resources.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1356

{ # A Cloud SQL instance resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1357

"backendType": "A String", # *SECOND_GEN*: Cloud SQL database instance. *EXTERNAL*: A database server that is not managed by Google. This property is read-only; use the *tier* property in the *settings* object to determine the database type.

1358

"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

1359

"createTime": "A String", # Output only. The time when the instance was created in RFC 3339 format (https://tools.ietf.org/html/rfc3339), for example 2012-11-15T16:19:00.094Z

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1360

"currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see this announcement for details.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

1361

"databaseVersion": "A String", # The database engine type and version. The *databaseVersion* field cannot be changed after instance creation. MySQL instances: *MYSQL_8_0*, *MYSQL_5_7* (default), or *MYSQL_5_6*. PostgreSQL instances: *POSTGRES_9_6*, *POSTGRES_10*, *POSTGRES_11*, *POSTGRES_12*, *POSTGRES_13* (default). SQL Server instances: *SQLSERVER_2019_STANDARD*, *SQLSERVER_2019_ENTERPRISE*, *SQLSERVER_2019_EXPRESS*, or *SQLSERVER_2019_WEB*, *SQLSERVER_2017_STANDARD* (default), *SQLSERVER_2017_ENTERPRISE*, *SQLSERVER_2017_EXPRESS*, or *SQLSERVER_2017_WEB*.

1362

"diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1363

"kind": "A String", # This is always *sql#diskEncryptionConfiguration*.

1364

"kmsKeyName": "A String", # Resource name of KMS key for disk encryption

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

1365

},

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

1366

"diskEncryptionStatus": { # Disk encryption status for an instance. # Disk encryption status specific to an instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1367

"kind": "A String", # This is always *sql#diskEncryptionStatus*.

1368

"kmsKeyVersionName": "A String", # KMS key version used to encrypt the Cloud SQL instance resource

1369

},

1370

"etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the *settings.settingsVersion* field instead.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

1371

"failoverReplica": { # The name and status of the failover replica.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1372

"available": True or False, # The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only failover to the failover replica when the status is true.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

1373

"name": "A String", # The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1374

},

1375

"gceZone": "A String", # The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone.

1376

"instanceType": "A String", # The instance type. This can be one of the following. *CLOUD_SQL_INSTANCE*: A Cloud SQL instance that is not replicating from a primary instance. *ON_PREMISES_INSTANCE*: An instance running on the customer's premises. *READ_REPLICA_INSTANCE*: A Cloud SQL instance configured as a read-replica.

1377

"ipAddresses": [ # The assigned IP addresses for the instance.

1378

{ # Database instance IP Mapping.

1379

"ipAddress": "A String", # The IP address assigned.

1380

"timeToRetire": "A String", # The due time for this IP to be retired in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*. This field is only available when the IP is scheduled to be retired.

1381

"type": "A String", # The type of this IP address. A *PRIMARY* address is a public address that can accept incoming connections. A *PRIVATE* address is a private address that can accept incoming connections. An *OUTGOING* address is the source address of connections originating from the instance, if supported.

1382

},

1383

],

1384

"ipv6Address": "A String", # The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances.

1385

"kind": "A String", # This is always *sql#instance*.

1386

"masterInstanceName": "A String", # The name of the instance which will act as primary in the replication setup.

1387

"maxDiskSize": "A String", # The maximum disk size of the instance in bytes.

1388

"name": "A String", # Name of the Cloud SQL instance. This does not include the project ID.

1389

"onPremisesConfiguration": { # On-premises instance configuration. # Configuration specific to on-premises instances.

1390

"caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.

1391

"clientCertificate": "A String", # PEM representation of the replica's x509 certificate.

1392

"clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.

1393

"dumpFilePath": "A String", # The dump file to create the Cloud SQL replica.

1394

"hostPort": "A String", # The host and port of the on-premises instance in host:port format

1395

"kind": "A String", # This is always *sql#onPremisesConfiguration*.

1396

"password": "A String", # The password for connecting to on-premises instance.

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

1397

"sourceInstance": { # Reference to another Cloud SQL instance. # The reference to Cloud SQL instance if the source is Cloud SQL.

1398

"name": "A String", # The name of the Cloud SQL instance being referenced. This does not include the project ID.

1399

"project": "A String", # The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it.

1400

"region": "A String", # The region of the Cloud SQL instance being referenced.

1401

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1402

"username": "A String", # The username for connecting to on-premises instance.

1403

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1404

"outOfDiskReport": { # This message wraps up the information written by out-of-disk detection job. # This field represents the report generated by the proactive database wellness job for OutOfDisk issues. Writers: -- the proactive database wellness job for OOD. Readers: -- the proactive database wellness job

1405

"sqlMinRecommendedIncreaseSizeGb": 42, # The minimum recommended increase size in GigaBytes This field is consumed by the frontend Writers: -- the proactive database wellness job for OOD.

1406

"sqlOutOfDiskState": "A String", # This field represents the state generated by the proactive database wellness job for OutOfDisk issues. Writers: -- the proactive database wellness job for OOD. Readers: -- the proactive database wellness job

yoshi-code-bot

2021-04-27 05:08:04 -0700

[diff] [blame]

1407

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1408

"project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.

1409

"region": "A String", # The geographical region. Can be *us-central* (*FIRST_GEN* instances only) *us-central1* (*SECOND_GEN* instances only) *asia-east1* or *europe-west1*. Defaults to *us-central* or *us-central1* depending on the instance type. The region cannot be changed after instance creation.

1410

"replicaConfiguration": { # Read-replica configuration for connecting to the primary instance. # Configuration specific to failover replicas and read replicas.

1411

"failoverTarget": True or False, # Specifies if the replica is the failover target. If the field is set to *true* the replica will be designated as a failover replica. In case the primary instance fails, the replica instance will be promoted as the new primary instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the primary instance.

1412

"kind": "A String", # This is always *sql#replicaConfiguration*.

1413

"mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # MySQL specific configuration when replicating from a MySQL on-premises primary instance. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named *master.info* in the data directory.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1414

"caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1415

"clientCertificate": "A String", # PEM representation of the replica's x509 certificate.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1416

"clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1417

"connectRetryInterval": 42, # Seconds to wait between connect retries. MySQL's default is 60 seconds.

1418

"dumpFilePath": "A String", # Path to a SQL dump file in Google Cloud Storage from which the replica instance is to be created. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported. Dumps have the binlog co-ordinates from which replication begins. This can be accomplished by setting --master-data to 1 when using mysqldump.

1419

"kind": "A String", # This is always *sql#mysqlReplicaConfiguration*.

1420

"masterHeartbeatPeriod": "A String", # Interval in milliseconds between replication heartbeats.

1421

"password": "A String", # The password for the replication connection.

1422

"sslCipher": "A String", # A list of permissible ciphers to use for SSL encryption.

1423

"username": "A String", # The username for the replication connection.

1424

"verifyServerCertificate": True or False, # Whether or not to check the primary instance's Common Name value in the certificate that it sends during the SSL handshake.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1425

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1426

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1427

"replicaNames": [ # The replicas of the instance.

1428

"A String",

1429

],

1430

"rootPassword": "A String", # Initial root password. Use only on creation.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1431

"satisfiesPzs": True or False, # The status indicating if instance satisfiesPzs. Reserved for future use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1432

"scheduledMaintenance": { # Any scheduled maintenancce for this instance. # The start time of any upcoming scheduled maintenance for this instance.

1433

"canDefer": True or False,

1434

"canReschedule": True or False, # If the scheduled maintenance can be rescheduled.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

1435

"scheduleDeadlineTime": "A String", # Maintenance cannot be rescheduled to start beyond this deadline.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1436

"startTime": "A String", # The start time of any upcoming scheduled maintenance for this instance.

1437

},

1438

"secondaryGceZone": "A String", # The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone. Reserved for future use.

1439

"selfLink": "A String", # The URI of this resource.

1440

"serverCaCert": { # SslCerts Resource # SSL configuration.

1441

"cert": "A String", # PEM representation.

1442

"certSerialNumber": "A String", # Serial number, as extracted from the certificate.

1443

"commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.

1444

"createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*

1445

"expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

1446

"instance": "A String", # Name of the database instance.

1447

"kind": "A String", # This is always *sql#sslCert*.

1448

"selfLink": "A String", # The URI of this resource.

1449

"sha1Fingerprint": "A String", # Sha1 Fingerprint.

1450

},

yoshi-code-bot

2021-06-03 00:48:27 -0700

[diff] [blame]

1451

"serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance. This property is read-only.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1452

"settings": { # Database instance settings. # The user settings.

1453

"activationPolicy": "A String", # The activation policy specifies when the instance is activated; it is applicable only when the instance state is RUNNABLE. Valid values: *ALWAYS*: The instance is on, and remains so even in the absence of connection requests. *NEVER*: The instance is off; it is not activated, even if a connection request arrives.

1454

"activeDirectoryConfig": { # Active Directory configuration, relevant only for Cloud SQL for SQL Server. # Active Directory configuration, relevant only for Cloud SQL for SQL Server.

1455

"domain": "A String", # The name of the domain (e.g., mydomain.com).

1456

"kind": "A String", # This is always sql#activeDirectoryConfig.

1457

},

1458

"authorizedGaeApplications": [ # The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only.

1459

"A String",

1460

],

1461

"availabilityType": "A String", # Availability type. Potential values: *ZONAL*: The instance serves data from only one zone. Outages in that zone affect data accessibility. *REGIONAL*: The instance can serve data from more than one zone in a region (it is highly available). For more information, see Overview of the High Availability Configuration.

1462

"backupConfiguration": { # Database instance backup configuration. # The daily backup configuration for the instance.

1463

"backupRetentionSettings": { # We currently only support backup retention by specifying the number of backups we will retain. # Backup retention settings.

1464

"retainedBackups": 42, # Depending on the value of retention_unit, this is used to determine if a backup needs to be deleted. If retention_unit is 'COUNT', we will retain this many backups.

1465

"retentionUnit": "A String", # The unit that 'retained_backups' represents.

1466

},

1467

"binaryLogEnabled": True or False, # (MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well.

1468

"enabled": True or False, # Whether this configuration is enabled.

1469

"kind": "A String", # This is always *sql#backupConfiguration*.

1470

"location": "A String", # Location of the backup

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

1471

"pointInTimeRecoveryEnabled": True or False, # (Postgres only) Whether point in time recovery is enabled.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1472

"replicationLogArchivingEnabled": True or False, # Reserved for future use.

1473

"startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - *HH:MM*.

1474

"transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7.

1475

},

1476

"collation": "A String", # The name of server Instance collation.

1477

"crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.

1478

"dataDiskSizeGb": "A String", # The size of data disk, in GB. The data disk size minimum is 10GB.

1479

"dataDiskType": "A String", # The type of data disk: PD_SSD (default) or PD_HDD. Not used for First Generation instances.

1480

"databaseFlags": [ # The database flags passed to the instance at startup.

1481

{ # Database flags for Cloud SQL instances.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

1482

"name": "A String", # The name of the flag. These flags are passed at instance startup, so include both server options and system variables. Flags are specified with underscores, not hyphens. For more information, see Configuring Database Flags in the Cloud SQL documentation.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1483

"value": "A String", # The value of the flag. Booleans are set to *on* for true and *off* for false. This field must be omitted if the flag doesn't take a value.

1484

},

1485

],

1486

"databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not.

1487

"denyMaintenancePeriods": [ # Deny maintenance periods

1488

{ # Deny Maintenance Periods. This specifies a date range during when all CSA rollout will be denied.

1489

"endDate": "A String", # "deny maintenance period" end date. If the year of the end date is empty, the year of the start date also must be empty. In this case, it means the deny maintenance period recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01

1490

"startDate": "A String", # "deny maintenance period" start date. If the year of the start date is empty, the year of the end date also must be empty. In this case, it means the deny maintenance period recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01

1491

"time": "A String", # Time in UTC when the "deny maintenance period" starts on start_date and ends on end_date. The time is in format: HH:mm:SS, i.e., 00:00:00

1492

},

1493

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1494

"insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres.

1495

"queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

1496

"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. Default is 5.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1497

"queryStringLength": 42, # Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query length more than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1498

"recordApplicationTags": True or False, # Whether Query Insights will record application tags from query when enabled.

1499

"recordClientAddress": True or False, # Whether Query Insights will record client address when enabled.

1500

},

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

1501

"ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled.

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

1502

"allocatedIpRange": "A String", # The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with [RFC 1035](https://tools.ietf.org/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?.` Reserved for future use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1503

"authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: *192.168.100.0/24*).

1504

{ # An entry for an Access Control list.

1505

"expirationTime": "A String", # The time when this access control entry expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

1506

"kind": "A String", # This is always *sql#aclEntry*.

1507

"name": "A String", # Optional. A label to identify this entry.

1508

"value": "A String", # The allowlisted value for the access control list.

1509

},

1510

],

1511

"ipv4Enabled": True or False, # Whether the instance is assigned a public IP address or not.

1512

"privateNetwork": "A String", # The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, */projects/myProject/global/networks/default*. This setting can be updated, but it cannot be removed after it is set.

1513

"requireSsl": True or False, # Whether SSL connections over IP are enforced or not.

1514

},

1515

"kind": "A String", # This is always *sql#settings*.

1516

"locationPreference": { # Preferred location. This specifies where a Cloud SQL instance is located, either in a specific Compute Engine zone, or co-located with an App Engine application. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or Compute Engine zone for better performance. App Engine co-location was only applicable to First Generation instances.

1517

"followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance.

1518

"kind": "A String", # This is always *sql#locationPreference*.

1519

"secondaryZone": "A String", # The preferred Compute Engine zone for the secondary/failover (for example: us-central1-a, us-central1-b, etc.). Reserved for future use.

1520

"zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.).

1521

},

1522

"maintenanceWindow": { # Maintenance window. This specifies when a Cloud SQL instance is restarted for system maintenance purposes. # The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes.

1523

"day": 42, # day of week (1-7), starting on Monday.

1524

"hour": 42, # hour of day - 0 to 23.

1525

"kind": "A String", # This is always *sql#maintenanceWindow*.

1526

"updateTrack": "A String", # Maintenance timing setting: *canary* (Earlier) or *stable* (Later). Learn more.

1527

},

1528

"pricingPlan": "A String", # The pricing plan for this instance. This can be either *PER_USE* or *PACKAGE*. Only *PER_USE* is supported for Second Generation instances.

1529

"replicationType": "A String", # The type of replication this instance uses. This can be either *ASYNCHRONOUS* or *SYNCHRONOUS*. (Deprecated_ This property was only applicable to First Generation instances.

1530

"settingsVersion": "A String", # The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.

1531

"storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is true.

1532

"storageAutoResizeLimit": "A String", # The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

1533

"tier": "A String", # The tier (or machine type) for this instance, for example *db-custom-1-3840* .

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1534

"userLabels": { # User-provided labels, represented as a dictionary where each label is a single key value pair.

1535

"a_key": "A String",

1536

},

1537

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1538

"state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following. *SQL_INSTANCE_STATE_UNSPECIFIED*: The state of the instance is unknown. *RUNNABLE*: The instance is running, or has been stopped by owner. *SUSPENDED*: The instance is not available, for example due to problems with billing. *PENDING_DELETE*: The instance is being deleted. *PENDING_CREATE*: The instance is being created. *MAINTENANCE*: The instance is down for maintenance. *FAILED*: The instance creation failed.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1539

"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension.

"A String",

],

},

],

"kind": "A String", # This is always *sql#instancesList*.

1545

"nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.

1546

"warnings": [ # List of warnings that occurred while handling the request.

1547

{ # An Admin API warning message.

1548

"code": "A String", # Code to uniquely identify the warning type.

1549

"message": "A String", # The warning message.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1550

"region": "A String", # The region name for REGION_UNREACHABLE warning.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1551

},

1552

],

1553

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1557

<code class="details" id="listServerCas">listServerCas(project, instance, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1558

<pre>Lists all of the trusted Certificate Authorities (CAs) for the specified instance. There can be up to three CAs listed: the CA that was used to sign the certificate that is currently in use, a CA that has been added but not yet used to sign a certificate, and a CA used to sign a certificate that has previously rotated out.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1559

1560

Args:

1561

project: string, Project ID of the project that contains the instance. (required)

1562

instance: string, Cloud SQL instance ID. This does not include the project ID. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1563

x__xgafv: string, V1 error format.

1564

Allowed values

1565

1 - v1 error format

1566

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1567

1568

Returns:

1569

An object of the form:

1570

1571

{ # Instances ListServerCas response.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1572

"activeVersion": "A String",

1573

"certs": [ # List of server CA certificates for the instance.

1574

{ # SslCerts Resource

1575

"cert": "A String", # PEM representation.

1576

"certSerialNumber": "A String", # Serial number, as extracted from the certificate.

1577

"commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.

1578

"createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*

1579

"expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

1580

"instance": "A String", # Name of the database instance.

1581

"kind": "A String", # This is always *sql#sslCert*.

1582

"selfLink": "A String", # The URI of this resource.

1583

"sha1Fingerprint": "A String", # Sha1 Fingerprint.

1584

},

1585

],

1586

"kind": "A String", # This is always *sql#instancesListServerCas*.

1587

}</pre>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

1592

<pre>Retrieves the next page of results.

1593

1594

Args:

1595

previous_request: The request for the previous page. (required)

1596

previous_response: The response from the request for the previous page. (required)

1597

1598

Returns:

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1599

A request object that you can call 'execute()' on to request the next

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

1600

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1605

<code class="details" id="patch">patch(project, instance, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1606

<pre>Updates settings of a Cloud SQL instance. This method supports patch semantics.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

1607

1608

Args:

1609

project: string, Project ID of the project that contains the instance. (required)

1610

instance: string, Cloud SQL instance ID. This does not include the project ID. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1611

body: object, The request body.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

1612

The object takes the form of:

1613

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1614

{ # A Cloud SQL instance resource.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1615

"backendType": "A String", # *SECOND_GEN*: Cloud SQL database instance. *EXTERNAL*: A database server that is not managed by Google. This property is read-only; use the *tier* property in the *settings* object to determine the database type.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1616

"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

1617

"createTime": "A String", # Output only. The time when the instance was created in RFC 3339 format (https://tools.ietf.org/html/rfc3339), for example 2012-11-15T16:19:00.094Z

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1618

"currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see this announcement for details.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

1619

"databaseVersion": "A String", # The database engine type and version. The *databaseVersion* field cannot be changed after instance creation. MySQL instances: *MYSQL_8_0*, *MYSQL_5_7* (default), or *MYSQL_5_6*. PostgreSQL instances: *POSTGRES_9_6*, *POSTGRES_10*, *POSTGRES_11*, *POSTGRES_12*, *POSTGRES_13* (default). SQL Server instances: *SQLSERVER_2019_STANDARD*, *SQLSERVER_2019_ENTERPRISE*, *SQLSERVER_2019_EXPRESS*, or *SQLSERVER_2019_WEB*, *SQLSERVER_2017_STANDARD* (default), *SQLSERVER_2017_ENTERPRISE*, *SQLSERVER_2017_EXPRESS*, or *SQLSERVER_2017_WEB*.

1620

"diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1621

"kind": "A String", # This is always *sql#diskEncryptionConfiguration*.

1622

"kmsKeyName": "A String", # Resource name of KMS key for disk encryption

1623

},

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

1624

"diskEncryptionStatus": { # Disk encryption status for an instance. # Disk encryption status specific to an instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1625

"kind": "A String", # This is always *sql#diskEncryptionStatus*.

1626

"kmsKeyVersionName": "A String", # KMS key version used to encrypt the Cloud SQL instance resource

1627

},

1628

"etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the *settings.settingsVersion* field instead.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

1629

"failoverReplica": { # The name and status of the failover replica.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1630

"available": True or False, # The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only failover to the failover replica when the status is true.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

1631

"name": "A String", # The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1632

},

1633

"gceZone": "A String", # The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone.

1634

"instanceType": "A String", # The instance type. This can be one of the following. *CLOUD_SQL_INSTANCE*: A Cloud SQL instance that is not replicating from a primary instance. *ON_PREMISES_INSTANCE*: An instance running on the customer's premises. *READ_REPLICA_INSTANCE*: A Cloud SQL instance configured as a read-replica.

1635

"ipAddresses": [ # The assigned IP addresses for the instance.

1636

{ # Database instance IP Mapping.

1637

"ipAddress": "A String", # The IP address assigned.

1638

"timeToRetire": "A String", # The due time for this IP to be retired in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*. This field is only available when the IP is scheduled to be retired.

1639

"type": "A String", # The type of this IP address. A *PRIMARY* address is a public address that can accept incoming connections. A *PRIVATE* address is a private address that can accept incoming connections. An *OUTGOING* address is the source address of connections originating from the instance, if supported.

1640

},

1641

],

1642

"ipv6Address": "A String", # The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances.

1643

"kind": "A String", # This is always *sql#instance*.

1644

"masterInstanceName": "A String", # The name of the instance which will act as primary in the replication setup.

1645

"maxDiskSize": "A String", # The maximum disk size of the instance in bytes.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1646

"name": "A String", # Name of the Cloud SQL instance. This does not include the project ID.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1647

"onPremisesConfiguration": { # On-premises instance configuration. # Configuration specific to on-premises instances.

1648

"caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.

1649

"clientCertificate": "A String", # PEM representation of the replica's x509 certificate.

1650

"clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.

1651

"dumpFilePath": "A String", # The dump file to create the Cloud SQL replica.

1652

"hostPort": "A String", # The host and port of the on-premises instance in host:port format

1653

"kind": "A String", # This is always *sql#onPremisesConfiguration*.

1654

"password": "A String", # The password for connecting to on-premises instance.

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

1655

"sourceInstance": { # Reference to another Cloud SQL instance. # The reference to Cloud SQL instance if the source is Cloud SQL.

1656

"name": "A String", # The name of the Cloud SQL instance being referenced. This does not include the project ID.

1657

"project": "A String", # The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it.

1658

"region": "A String", # The region of the Cloud SQL instance being referenced.

1659

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1660

"username": "A String", # The username for connecting to on-premises instance.

1661

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1662

"outOfDiskReport": { # This message wraps up the information written by out-of-disk detection job. # This field represents the report generated by the proactive database wellness job for OutOfDisk issues. Writers: -- the proactive database wellness job for OOD. Readers: -- the proactive database wellness job

1663

"sqlMinRecommendedIncreaseSizeGb": 42, # The minimum recommended increase size in GigaBytes This field is consumed by the frontend Writers: -- the proactive database wellness job for OOD.

1664

"sqlOutOfDiskState": "A String", # This field represents the state generated by the proactive database wellness job for OutOfDisk issues. Writers: -- the proactive database wellness job for OOD. Readers: -- the proactive database wellness job

yoshi-code-bot

2021-04-27 05:08:04 -0700

[diff] [blame]

1665

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1666

"project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.

1667

"region": "A String", # The geographical region. Can be *us-central* (*FIRST_GEN* instances only) *us-central1* (*SECOND_GEN* instances only) *asia-east1* or *europe-west1*. Defaults to *us-central* or *us-central1* depending on the instance type. The region cannot be changed after instance creation.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1668

"replicaConfiguration": { # Read-replica configuration for connecting to the primary instance. # Configuration specific to failover replicas and read replicas.

1669

"failoverTarget": True or False, # Specifies if the replica is the failover target. If the field is set to *true* the replica will be designated as a failover replica. In case the primary instance fails, the replica instance will be promoted as the new primary instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the primary instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1670

"kind": "A String", # This is always *sql#replicaConfiguration*.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1671

"mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # MySQL specific configuration when replicating from a MySQL on-premises primary instance. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named *master.info* in the data directory.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1672

"caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1673

"clientCertificate": "A String", # PEM representation of the replica's x509 certificate.

1674

"clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1675

"connectRetryInterval": 42, # Seconds to wait between connect retries. MySQL's default is 60 seconds.

1676

"dumpFilePath": "A String", # Path to a SQL dump file in Google Cloud Storage from which the replica instance is to be created. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported. Dumps have the binlog co-ordinates from which replication begins. This can be accomplished by setting --master-data to 1 when using mysqldump.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1677

"kind": "A String", # This is always *sql#mysqlReplicaConfiguration*.

1678

"masterHeartbeatPeriod": "A String", # Interval in milliseconds between replication heartbeats.

1679

"password": "A String", # The password for the replication connection.

1680

"sslCipher": "A String", # A list of permissible ciphers to use for SSL encryption.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1681

"username": "A String", # The username for the replication connection.

1682

"verifyServerCertificate": True or False, # Whether or not to check the primary instance's Common Name value in the certificate that it sends during the SSL handshake.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1683

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1684

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1685

"replicaNames": [ # The replicas of the instance.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1686

"A String",

1687

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1688

"rootPassword": "A String", # Initial root password. Use only on creation.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1689

"satisfiesPzs": True or False, # The status indicating if instance satisfiesPzs. Reserved for future use.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1690

"scheduledMaintenance": { # Any scheduled maintenancce for this instance. # The start time of any upcoming scheduled maintenance for this instance.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1691

"canDefer": True or False,

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1692

"canReschedule": True or False, # If the scheduled maintenance can be rescheduled.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

1693

"scheduleDeadlineTime": "A String", # Maintenance cannot be rescheduled to start beyond this deadline.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1694

"startTime": "A String", # The start time of any upcoming scheduled maintenance for this instance.

1695

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1696

"secondaryGceZone": "A String", # The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone. Reserved for future use.

1697

"selfLink": "A String", # The URI of this resource.

1698

"serverCaCert": { # SslCerts Resource # SSL configuration.

1699

"cert": "A String", # PEM representation.

1700

"certSerialNumber": "A String", # Serial number, as extracted from the certificate.

1701

"commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.

1702

"createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*

1703

"expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

1704

"instance": "A String", # Name of the database instance.

1705

"kind": "A String", # This is always *sql#sslCert*.

1706

"selfLink": "A String", # The URI of this resource.

1707

"sha1Fingerprint": "A String", # Sha1 Fingerprint.

1708

},

yoshi-code-bot

2021-06-03 00:48:27 -0700

[diff] [blame]

1709

"serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance. This property is read-only.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1710

"settings": { # Database instance settings. # The user settings.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1711

"activationPolicy": "A String", # The activation policy specifies when the instance is activated; it is applicable only when the instance state is RUNNABLE. Valid values: *ALWAYS*: The instance is on, and remains so even in the absence of connection requests. *NEVER*: The instance is off; it is not activated, even if a connection request arrives.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1712

"activeDirectoryConfig": { # Active Directory configuration, relevant only for Cloud SQL for SQL Server. # Active Directory configuration, relevant only for Cloud SQL for SQL Server.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1713

"domain": "A String", # The name of the domain (e.g., mydomain.com).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1714

"kind": "A String", # This is always sql#activeDirectoryConfig.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1715

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1716

"authorizedGaeApplications": [ # The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1717

"A String",

1718

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1719

"availabilityType": "A String", # Availability type. Potential values: *ZONAL*: The instance serves data from only one zone. Outages in that zone affect data accessibility. *REGIONAL*: The instance can serve data from more than one zone in a region (it is highly available). For more information, see Overview of the High Availability Configuration.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1720

"backupConfiguration": { # Database instance backup configuration. # The daily backup configuration for the instance.

1721

"backupRetentionSettings": { # We currently only support backup retention by specifying the number of backups we will retain. # Backup retention settings.

1722

"retainedBackups": 42, # Depending on the value of retention_unit, this is used to determine if a backup needs to be deleted. If retention_unit is 'COUNT', we will retain this many backups.

1723

"retentionUnit": "A String", # The unit that 'retained_backups' represents.

1724

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1725

"binaryLogEnabled": True or False, # (MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1726

"enabled": True or False, # Whether this configuration is enabled.

1727

"kind": "A String", # This is always *sql#backupConfiguration*.

1728

"location": "A String", # Location of the backup

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

1729

"pointInTimeRecoveryEnabled": True or False, # (Postgres only) Whether point in time recovery is enabled.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1730

"replicationLogArchivingEnabled": True or False, # Reserved for future use.

1731

"startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - *HH:MM*.

1732

"transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7.

1733

},

1734

"collation": "A String", # The name of server Instance collation.

1735

"crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.

1736

"dataDiskSizeGb": "A String", # The size of data disk, in GB. The data disk size minimum is 10GB.

1737

"dataDiskType": "A String", # The type of data disk: PD_SSD (default) or PD_HDD. Not used for First Generation instances.

1738

"databaseFlags": [ # The database flags passed to the instance at startup.

1739

{ # Database flags for Cloud SQL instances.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

1740

"name": "A String", # The name of the flag. These flags are passed at instance startup, so include both server options and system variables. Flags are specified with underscores, not hyphens. For more information, see Configuring Database Flags in the Cloud SQL documentation.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1741

"value": "A String", # The value of the flag. Booleans are set to *on* for true and *off* for false. This field must be omitted if the flag doesn't take a value.

1742

},

1743

],

1744

"databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not.

1745

"denyMaintenancePeriods": [ # Deny maintenance periods

1746

{ # Deny Maintenance Periods. This specifies a date range during when all CSA rollout will be denied.

1747

"endDate": "A String", # "deny maintenance period" end date. If the year of the end date is empty, the year of the start date also must be empty. In this case, it means the deny maintenance period recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01

1748

"startDate": "A String", # "deny maintenance period" start date. If the year of the start date is empty, the year of the end date also must be empty. In this case, it means the deny maintenance period recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01

1749

"time": "A String", # Time in UTC when the "deny maintenance period" starts on start_date and ends on end_date. The time is in format: HH:mm:SS, i.e., 00:00:00

1750

},

1751

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1752

"insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres.

1753

"queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

1754

"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. Default is 5.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1755

"queryStringLength": 42, # Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query length more than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1756

"recordApplicationTags": True or False, # Whether Query Insights will record application tags from query when enabled.

1757

"recordClientAddress": True or False, # Whether Query Insights will record client address when enabled.

1758

},

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

1759

"ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled.

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

1760

"allocatedIpRange": "A String", # The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with [RFC 1035](https://tools.ietf.org/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?.` Reserved for future use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1761

"authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: *192.168.100.0/24*).

1762

{ # An entry for an Access Control list.

1763

"expirationTime": "A String", # The time when this access control entry expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

1764

"kind": "A String", # This is always *sql#aclEntry*.

1765

"name": "A String", # Optional. A label to identify this entry.

1766

"value": "A String", # The allowlisted value for the access control list.

1767

},

1768

],

1769

"ipv4Enabled": True or False, # Whether the instance is assigned a public IP address or not.

1770

"privateNetwork": "A String", # The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, */projects/myProject/global/networks/default*. This setting can be updated, but it cannot be removed after it is set.

1771

"requireSsl": True or False, # Whether SSL connections over IP are enforced or not.

1772

},

1773

"kind": "A String", # This is always *sql#settings*.

1774

"locationPreference": { # Preferred location. This specifies where a Cloud SQL instance is located, either in a specific Compute Engine zone, or co-located with an App Engine application. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or Compute Engine zone for better performance. App Engine co-location was only applicable to First Generation instances.

1775

"followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance.

1776

"kind": "A String", # This is always *sql#locationPreference*.

1777

"secondaryZone": "A String", # The preferred Compute Engine zone for the secondary/failover (for example: us-central1-a, us-central1-b, etc.). Reserved for future use.

1778

"zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.).

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1779

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1780

"maintenanceWindow": { # Maintenance window. This specifies when a Cloud SQL instance is restarted for system maintenance purposes. # The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes.

1781

"day": 42, # day of week (1-7), starting on Monday.

1782

"hour": 42, # hour of day - 0 to 23.

1783

"kind": "A String", # This is always *sql#maintenanceWindow*.

1784

"updateTrack": "A String", # Maintenance timing setting: *canary* (Earlier) or *stable* (Later). Learn more.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1785

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1786

"pricingPlan": "A String", # The pricing plan for this instance. This can be either *PER_USE* or *PACKAGE*. Only *PER_USE* is supported for Second Generation instances.

1787

"replicationType": "A String", # The type of replication this instance uses. This can be either *ASYNCHRONOUS* or *SYNCHRONOUS*. (Deprecated_ This property was only applicable to First Generation instances.

1788

"settingsVersion": "A String", # The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.

1789

"storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is true.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1790

"storageAutoResizeLimit": "A String", # The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

1791

"tier": "A String", # The tier (or machine type) for this instance, for example *db-custom-1-3840* .

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1792

"userLabels": { # User-provided labels, represented as a dictionary where each label is a single key value pair.

1793

"a_key": "A String",

1794

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1795

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1796

"state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following. *SQL_INSTANCE_STATE_UNSPECIFIED*: The state of the instance is unknown. *RUNNABLE*: The instance is running, or has been stopped by owner. *SUSPENDED*: The instance is not available, for example due to problems with billing. *PENDING_DELETE*: The instance is being deleted. *PENDING_CREATE*: The instance is being created. *MAINTENANCE*: The instance is down for maintenance. *FAILED*: The instance creation failed.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1797

"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension.

1798

"A String",

1799

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1800

}

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

1801

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1802

x__xgafv: string, V1 error format.

1803

Allowed values

1804

1 - v1 error format

1805

2 - v2 error format

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

1806

1807

Returns:

1808

An object of the form:

1809

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1810

{ # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1811

"backupContext": { # Backup context. # The context for backup operation, if applicable.

1812

"backupId": "A String", # The identifier of the backup.

1813

"kind": "A String", # This is always *sql#backupContext*.

1814

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1815

"endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

1816

"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.

1817

"errors": [ # The list of errors encountered while processing this operation.

1818

{ # Database instance operation error.

1819

"code": "A String", # Identifies the specific error that occurred.

1820

"kind": "A String", # This is always *sql#operationError*.

1821

"message": "A String", # Additional information about the error encountered.

1822

},

1823

],

1824

"kind": "A String", # This is always *sql#operationErrors*.

1825

},

1826

"exportContext": { # Database instance export context. # The context for export operation, if applicable.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1827

"csvExportOptions": { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1828

"selectQuery": "A String", # The select query used to extract the data.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1829

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1830

"databases": [ # Databases to be exported. *MySQL instances:* If *fileType* is *SQL* and no database is specified, all databases are exported, except for the *mysql* system database. If *fileType* is *CSV*, you can specify one database, either by using this property or by using the *csvExportOptions.selectQuery* property, which takes precedence over this property. *PostgreSQL instances:* You must specify one database to be exported. If *fileType* is *CSV*, this database must match the one specified in the *csvExportOptions.selectQuery* property. *SQL Server instances:* You must specify one database to be exported, and the *fileType* must be *BAK*.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1831

"A String",

1832

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1833

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. *BAK*: The file contains backup data for a SQL Server instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1834

"kind": "A String", # This is always *sql#exportContext*.

1835

"offload": True or False, # Option for export offload.

1836

"sqlExportOptions": { # Options for exporting data as SQL statements.

1837

"mysqlExportOptions": { # Options for exporting from MySQL.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1838

"masterData": 42, # Option to include SQL statement required to set up replication. If set to *1*, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than *1*, --set-gtid-purged is set to OFF.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1839

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1840

"schemaOnly": True or False, # Export only schemas.

1841

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1842

"A String",

1843

],

1844

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1845

"uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form *gs://bucketName/fileName*. If the file already exists, the request succeeds, but the operation fails. If *fileType* is *SQL* and the filename ends with .gz, the contents are compressed.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1846

},

1847

"importContext": { # Database instance import context. # The context for import operation, if applicable.

1848

"bakImportOptions": { # Import parameters specific to SQL Server .BAK files

1849

"encryptionOptions": {

1850

"certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

1851

"pvkPassword": "A String", # Password that encrypts the private key

1852

"pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1853

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1854

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1855

"csvImportOptions": { # Options for importing data as CSV.

1856

"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.

1857

"A String",

1858

],

1859

"table": "A String", # The table to which CSV data is imported.

1860

},

1861

"database": "A String", # The target database for the import. If *fileType* is *SQL*, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If *fileType* is *CSV*, one database must be specified.

1862

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.

1863

"importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.

1864

"kind": "A String", # This is always *sql#importContext*.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1865

"uri": "A String", # Path to the import file in Cloud Storage, in the form *gs://bucketName/fileName*. Compressed gzip files (.gz) are supported when *fileType* is *SQL*. The instance must have write permissions to the bucket and read access to the file.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1866

},

1867

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

1868

"kind": "A String", # This is always *sql#operation*.

1869

"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.

1870

"operationType": "A String", # The type of the operation. Valid values are: *CREATE* *DELETE* *UPDATE* *RESTART* *IMPORT* *EXPORT* *BACKUP_VOLUME* *RESTORE_VOLUME* *CREATE_USER* *DELETE_USER* *CREATE_DATABASE* *DELETE_DATABASE*

1871

"selfLink": "A String", # The URI of this resource.

1872

"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

1873

"status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*

1874

"targetId": "A String", # Name of the database instance related to this operation.

1875

"targetLink": "A String",

1876

"targetProject": "A String", # The project ID of the target instance related to this operation.

1877

"user": "A String", # The email address of the user who initiated this operation.

1878

}</pre>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1882

<code class="details" id="promoteReplica">promoteReplica(project, instance, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1883

<pre>Promotes the read replica instance to be a stand-alone Cloud SQL instance. Using this operation might cause your instance to restart.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

1884

1885

Args:

1886

project: string, ID of the project that contains the read replica. (required)

1887

instance: string, Cloud SQL read replica instance name. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1888

x__xgafv: string, V1 error format.

1889

Allowed values

1890

1 - v1 error format

1891

2 - v2 error format

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

1892

1893

Returns:

1894

An object of the form:

1895

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1896

{ # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1897

"backupContext": { # Backup context. # The context for backup operation, if applicable.

1898

"backupId": "A String", # The identifier of the backup.

1899

"kind": "A String", # This is always *sql#backupContext*.

1900

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1901

"endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

1902

"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.

1903

"errors": [ # The list of errors encountered while processing this operation.

1904

{ # Database instance operation error.

1905

"code": "A String", # Identifies the specific error that occurred.

1906

"kind": "A String", # This is always *sql#operationError*.

1907

"message": "A String", # Additional information about the error encountered.

1908

},

1909

],

1910

"kind": "A String", # This is always *sql#operationErrors*.

1911

},

1912

"exportContext": { # Database instance export context. # The context for export operation, if applicable.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1913

"csvExportOptions": { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1914

"selectQuery": "A String", # The select query used to extract the data.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1915

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1916

"databases": [ # Databases to be exported. *MySQL instances:* If *fileType* is *SQL* and no database is specified, all databases are exported, except for the *mysql* system database. If *fileType* is *CSV*, you can specify one database, either by using this property or by using the *csvExportOptions.selectQuery* property, which takes precedence over this property. *PostgreSQL instances:* You must specify one database to be exported. If *fileType* is *CSV*, this database must match the one specified in the *csvExportOptions.selectQuery* property. *SQL Server instances:* You must specify one database to be exported, and the *fileType* must be *BAK*.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1917

"A String",

1918

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1919

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. *BAK*: The file contains backup data for a SQL Server instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1920

"kind": "A String", # This is always *sql#exportContext*.

1921

"offload": True or False, # Option for export offload.

1922

"sqlExportOptions": { # Options for exporting data as SQL statements.

1923

"mysqlExportOptions": { # Options for exporting from MySQL.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1924

"masterData": 42, # Option to include SQL statement required to set up replication. If set to *1*, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than *1*, --set-gtid-purged is set to OFF.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1925

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1926

"schemaOnly": True or False, # Export only schemas.

1927

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1928

"A String",

1929

],

1930

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1931

"uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form *gs://bucketName/fileName*. If the file already exists, the request succeeds, but the operation fails. If *fileType* is *SQL* and the filename ends with .gz, the contents are compressed.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1932

},

1933

"importContext": { # Database instance import context. # The context for import operation, if applicable.

1934

"bakImportOptions": { # Import parameters specific to SQL Server .BAK files

1935

"encryptionOptions": {

1936

"certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

1937

"pvkPassword": "A String", # Password that encrypts the private key

1938

"pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1939

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1940

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1941

"csvImportOptions": { # Options for importing data as CSV.

1942

"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.

1943

"A String",

1944

],

1945

"table": "A String", # The table to which CSV data is imported.

1946

},

1947

"database": "A String", # The target database for the import. If *fileType* is *SQL*, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If *fileType* is *CSV*, one database must be specified.

1948

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.

1949

"importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.

1950

"kind": "A String", # This is always *sql#importContext*.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1951

"uri": "A String", # Path to the import file in Cloud Storage, in the form *gs://bucketName/fileName*. Compressed gzip files (.gz) are supported when *fileType* is *SQL*. The instance must have write permissions to the bucket and read access to the file.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1952

},

1953

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

1954

"kind": "A String", # This is always *sql#operation*.

1955

"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.

1956

"operationType": "A String", # The type of the operation. Valid values are: *CREATE* *DELETE* *UPDATE* *RESTART* *IMPORT* *EXPORT* *BACKUP_VOLUME* *RESTORE_VOLUME* *CREATE_USER* *DELETE_USER* *CREATE_DATABASE* *DELETE_DATABASE*

1957

"selfLink": "A String", # The URI of this resource.

1958

"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

1959

"status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*

1960

"targetId": "A String", # Name of the database instance related to this operation.

1961

"targetLink": "A String",

1962

"targetProject": "A String", # The project ID of the target instance related to this operation.

1963

"user": "A String", # The email address of the user who initiated this operation.

1964

}</pre>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1968

<code class="details" id="resetSslConfig">resetSslConfig(project, instance, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1969

<pre>Deletes all client certificates and generates a new server SSL certificate for the instance.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

1970

1971

Args:

1972

project: string, Project ID of the project that contains the instance. (required)

1973

instance: string, Cloud SQL instance ID. This does not include the project ID. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1974

x__xgafv: string, V1 error format.

1975

Allowed values

1976

1 - v1 error format

1977

2 - v2 error format

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

1978

1979

Returns:

1980

An object of the form:

1981

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1982

{ # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1983

"backupContext": { # Backup context. # The context for backup operation, if applicable.

1984

"backupId": "A String", # The identifier of the backup.

1985

"kind": "A String", # This is always *sql#backupContext*.

1986

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1987

"endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

1988

"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.

1989

"errors": [ # The list of errors encountered while processing this operation.

1990

{ # Database instance operation error.

1991

"code": "A String", # Identifies the specific error that occurred.

1992

"kind": "A String", # This is always *sql#operationError*.

1993

"message": "A String", # Additional information about the error encountered.

1994

},

1995

],

1996

"kind": "A String", # This is always *sql#operationErrors*.

1997

},

1998

"exportContext": { # Database instance export context. # The context for export operation, if applicable.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1999

"csvExportOptions": { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2000

"selectQuery": "A String", # The select query used to extract the data.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2001

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2002

"databases": [ # Databases to be exported. *MySQL instances:* If *fileType* is *SQL* and no database is specified, all databases are exported, except for the *mysql* system database. If *fileType* is *CSV*, you can specify one database, either by using this property or by using the *csvExportOptions.selectQuery* property, which takes precedence over this property. *PostgreSQL instances:* You must specify one database to be exported. If *fileType* is *CSV*, this database must match the one specified in the *csvExportOptions.selectQuery* property. *SQL Server instances:* You must specify one database to be exported, and the *fileType* must be *BAK*.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2003

"A String",

2004

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2005

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. *BAK*: The file contains backup data for a SQL Server instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2006

"kind": "A String", # This is always *sql#exportContext*.

2007

"offload": True or False, # Option for export offload.

2008

"sqlExportOptions": { # Options for exporting data as SQL statements.

2009

"mysqlExportOptions": { # Options for exporting from MySQL.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2010

"masterData": 42, # Option to include SQL statement required to set up replication. If set to *1*, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than *1*, --set-gtid-purged is set to OFF.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2011

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2012

"schemaOnly": True or False, # Export only schemas.

2013

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2014

"A String",

2015

],

2016

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2017

"uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form *gs://bucketName/fileName*. If the file already exists, the request succeeds, but the operation fails. If *fileType* is *SQL* and the filename ends with .gz, the contents are compressed.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2018

},

2019

"importContext": { # Database instance import context. # The context for import operation, if applicable.

2020

"bakImportOptions": { # Import parameters specific to SQL Server .BAK files

2021

"encryptionOptions": {

2022

"certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

2023

"pvkPassword": "A String", # Password that encrypts the private key

2024

"pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2025

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2026

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2027

"csvImportOptions": { # Options for importing data as CSV.

2028

"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.

2029

"A String",

2030

],

2031

"table": "A String", # The table to which CSV data is imported.

2032

},

2033

"database": "A String", # The target database for the import. If *fileType* is *SQL*, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If *fileType* is *CSV*, one database must be specified.

2034

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.

2035

"importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.

2036

"kind": "A String", # This is always *sql#importContext*.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2037

"uri": "A String", # Path to the import file in Cloud Storage, in the form *gs://bucketName/fileName*. Compressed gzip files (.gz) are supported when *fileType* is *SQL*. The instance must have write permissions to the bucket and read access to the file.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2038

},

2039

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

2040

"kind": "A String", # This is always *sql#operation*.

2041

"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.

2042

"operationType": "A String", # The type of the operation. Valid values are: *CREATE* *DELETE* *UPDATE* *RESTART* *IMPORT* *EXPORT* *BACKUP_VOLUME* *RESTORE_VOLUME* *CREATE_USER* *DELETE_USER* *CREATE_DATABASE* *DELETE_DATABASE*

2043

"selfLink": "A String", # The URI of this resource.

2044

"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

2045

"status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*

2046

"targetId": "A String", # Name of the database instance related to this operation.

2047

"targetLink": "A String",

2048

"targetProject": "A String", # The project ID of the target instance related to this operation.

2049

"user": "A String", # The email address of the user who initiated this operation.

2050

}</pre>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2054

<code class="details" id="restart">restart(project, instance, x__xgafv=None)</code>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

2055

<pre>Restarts a Cloud SQL instance.

2056

2057

Args:

2058

project: string, Project ID of the project that contains the instance to be restarted. (required)

2059

instance: string, Cloud SQL instance ID. This does not include the project ID. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2060

x__xgafv: string, V1 error format.

2061

Allowed values

2062

1 - v1 error format

2063

2 - v2 error format

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

2064

2065

Returns:

2066

An object of the form:

2067

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2068

{ # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2069

"backupContext": { # Backup context. # The context for backup operation, if applicable.

2070

"backupId": "A String", # The identifier of the backup.

2071

"kind": "A String", # This is always *sql#backupContext*.

2072

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2073

"endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

2074

"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.

2075

"errors": [ # The list of errors encountered while processing this operation.

2076

{ # Database instance operation error.

2077

"code": "A String", # Identifies the specific error that occurred.

2078

"kind": "A String", # This is always *sql#operationError*.

2079

"message": "A String", # Additional information about the error encountered.

2080

},

2081

],

2082

"kind": "A String", # This is always *sql#operationErrors*.

2083

},

2084

"exportContext": { # Database instance export context. # The context for export operation, if applicable.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2085

"csvExportOptions": { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2086

"selectQuery": "A String", # The select query used to extract the data.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2087

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2088

"databases": [ # Databases to be exported. *MySQL instances:* If *fileType* is *SQL* and no database is specified, all databases are exported, except for the *mysql* system database. If *fileType* is *CSV*, you can specify one database, either by using this property or by using the *csvExportOptions.selectQuery* property, which takes precedence over this property. *PostgreSQL instances:* You must specify one database to be exported. If *fileType* is *CSV*, this database must match the one specified in the *csvExportOptions.selectQuery* property. *SQL Server instances:* You must specify one database to be exported, and the *fileType* must be *BAK*.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2089

"A String",

2090

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2091

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. *BAK*: The file contains backup data for a SQL Server instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2092

"kind": "A String", # This is always *sql#exportContext*.

2093

"offload": True or False, # Option for export offload.

2094

"sqlExportOptions": { # Options for exporting data as SQL statements.

2095

"mysqlExportOptions": { # Options for exporting from MySQL.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2096

"masterData": 42, # Option to include SQL statement required to set up replication. If set to *1*, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than *1*, --set-gtid-purged is set to OFF.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2097

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2098

"schemaOnly": True or False, # Export only schemas.

2099

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2100

"A String",

2101

],

2102

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2103

"uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form *gs://bucketName/fileName*. If the file already exists, the request succeeds, but the operation fails. If *fileType* is *SQL* and the filename ends with .gz, the contents are compressed.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2104

},

2105

"importContext": { # Database instance import context. # The context for import operation, if applicable.

2106

"bakImportOptions": { # Import parameters specific to SQL Server .BAK files

2107

"encryptionOptions": {

2108

"certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

2109

"pvkPassword": "A String", # Password that encrypts the private key

2110

"pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2111

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2112

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2113

"csvImportOptions": { # Options for importing data as CSV.

2114

"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.

2115

"A String",

2116

],

2117

"table": "A String", # The table to which CSV data is imported.

2118

},

2119

"database": "A String", # The target database for the import. If *fileType* is *SQL*, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If *fileType* is *CSV*, one database must be specified.

2120

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.

2121

"importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.

2122

"kind": "A String", # This is always *sql#importContext*.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2123

"uri": "A String", # Path to the import file in Cloud Storage, in the form *gs://bucketName/fileName*. Compressed gzip files (.gz) are supported when *fileType* is *SQL*. The instance must have write permissions to the bucket and read access to the file.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2124

},

2125

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

2126

"kind": "A String", # This is always *sql#operation*.

2127

"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.

2128

"operationType": "A String", # The type of the operation. Valid values are: *CREATE* *DELETE* *UPDATE* *RESTART* *IMPORT* *EXPORT* *BACKUP_VOLUME* *RESTORE_VOLUME* *CREATE_USER* *DELETE_USER* *CREATE_DATABASE* *DELETE_DATABASE*

2129

"selfLink": "A String", # The URI of this resource.

2130

"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

2131

"status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*

2132

"targetId": "A String", # Name of the database instance related to this operation.

2133

"targetLink": "A String",

2134

"targetProject": "A String", # The project ID of the target instance related to this operation.

2135

"user": "A String", # The email address of the user who initiated this operation.

2136

}</pre>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2140

<code class="details" id="restoreBackup">restoreBackup(project, instance, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2141

<pre>Restores a backup of a Cloud SQL instance. Using this operation might cause your instance to restart.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

2142

2143

Args:

2144

project: string, Project ID of the project that contains the instance. (required)

2145

instance: string, Cloud SQL instance ID. This does not include the project ID. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2146

body: object, The request body.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

2147

The object takes the form of:

2148

2149

{ # Database instance restore backup request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2150

"restoreBackupContext": { # Database instance restore from backup context. Backup context contains source instance id and project id. # Parameters required to perform the restore backup operation.

2151

"backupRunId": "A String", # The ID of the backup run to restore from.

2152

"instanceId": "A String", # The ID of the instance that the backup was taken from.

2153

"kind": "A String", # This is always *sql#restoreBackupContext*.

2154

"project": "A String", # The full project ID of the source instance.

2155

},

2156

}

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

2157

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2158

x__xgafv: string, V1 error format.

2159

Allowed values

2160

1 - v1 error format

2161

2 - v2 error format

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

2162

2163

Returns:

2164

An object of the form:

2165

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2166

{ # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2167

"backupContext": { # Backup context. # The context for backup operation, if applicable.

2168

"backupId": "A String", # The identifier of the backup.

2169

"kind": "A String", # This is always *sql#backupContext*.

2170

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2171

"endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

2172

"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.

2173

"errors": [ # The list of errors encountered while processing this operation.

2174

{ # Database instance operation error.

2175

"code": "A String", # Identifies the specific error that occurred.

2176

"kind": "A String", # This is always *sql#operationError*.

2177

"message": "A String", # Additional information about the error encountered.

2178

},

2179

],

2180

"kind": "A String", # This is always *sql#operationErrors*.

2181

},

2182

"exportContext": { # Database instance export context. # The context for export operation, if applicable.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2183

"csvExportOptions": { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2184

"selectQuery": "A String", # The select query used to extract the data.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2185

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2186

"databases": [ # Databases to be exported. *MySQL instances:* If *fileType* is *SQL* and no database is specified, all databases are exported, except for the *mysql* system database. If *fileType* is *CSV*, you can specify one database, either by using this property or by using the *csvExportOptions.selectQuery* property, which takes precedence over this property. *PostgreSQL instances:* You must specify one database to be exported. If *fileType* is *CSV*, this database must match the one specified in the *csvExportOptions.selectQuery* property. *SQL Server instances:* You must specify one database to be exported, and the *fileType* must be *BAK*.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2187

"A String",

2188

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2189

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. *BAK*: The file contains backup data for a SQL Server instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2190

"kind": "A String", # This is always *sql#exportContext*.

2191

"offload": True or False, # Option for export offload.

2192

"sqlExportOptions": { # Options for exporting data as SQL statements.

2193

"mysqlExportOptions": { # Options for exporting from MySQL.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2194

"masterData": 42, # Option to include SQL statement required to set up replication. If set to *1*, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than *1*, --set-gtid-purged is set to OFF.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2195

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2196

"schemaOnly": True or False, # Export only schemas.

2197

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2198

"A String",

2199

],

2200

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2201

"uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form *gs://bucketName/fileName*. If the file already exists, the request succeeds, but the operation fails. If *fileType* is *SQL* and the filename ends with .gz, the contents are compressed.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2202

},

2203

"importContext": { # Database instance import context. # The context for import operation, if applicable.

2204

"bakImportOptions": { # Import parameters specific to SQL Server .BAK files

2205

"encryptionOptions": {

2206

"certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

2207

"pvkPassword": "A String", # Password that encrypts the private key

2208

"pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2209

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2210

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2211

"csvImportOptions": { # Options for importing data as CSV.

2212

"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.

2213

"A String",

2214

],

2215

"table": "A String", # The table to which CSV data is imported.

2216

},

2217

"database": "A String", # The target database for the import. If *fileType* is *SQL*, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If *fileType* is *CSV*, one database must be specified.

2218

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.

2219

"importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.

2220

"kind": "A String", # This is always *sql#importContext*.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2221

"uri": "A String", # Path to the import file in Cloud Storage, in the form *gs://bucketName/fileName*. Compressed gzip files (.gz) are supported when *fileType* is *SQL*. The instance must have write permissions to the bucket and read access to the file.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2222

},

2223

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

2224

"kind": "A String", # This is always *sql#operation*.

2225

"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.

2226

"operationType": "A String", # The type of the operation. Valid values are: *CREATE* *DELETE* *UPDATE* *RESTART* *IMPORT* *EXPORT* *BACKUP_VOLUME* *RESTORE_VOLUME* *CREATE_USER* *DELETE_USER* *CREATE_DATABASE* *DELETE_DATABASE*

2227

"selfLink": "A String", # The URI of this resource.

2228

"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

2229

"status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*

2230

"targetId": "A String", # Name of the database instance related to this operation.

2231

"targetLink": "A String",

2232

"targetProject": "A String", # The project ID of the target instance related to this operation.

2233

"user": "A String", # The email address of the user who initiated this operation.

2234

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2238

<code class="details" id="rotateServerCa">rotateServerCa(project, instance, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2239

<pre>Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2240

2241

Args:

2242

project: string, Project ID of the project that contains the instance. (required)

2243

instance: string, Cloud SQL instance ID. This does not include the project ID. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2244

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2245

The object takes the form of:

2246

2247

{ # Rotate Server CA request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2248

"rotateServerCaContext": { # Instance rotate server CA context. # Contains details about the rotate server CA operation.

2249

"kind": "A String", # This is always *sql#rotateServerCaContext*.

2250

"nextVersion": "A String", # The fingerprint of the next version to be rotated to. If left unspecified, will be rotated to the most recently added server CA version.

2251

},

2252

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2253

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2254

x__xgafv: string, V1 error format.

2255

Allowed values

2256

1 - v1 error format

2257

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2258

2259

Returns:

2260

An object of the form:

2261

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2262

{ # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2263

"backupContext": { # Backup context. # The context for backup operation, if applicable.

2264

"backupId": "A String", # The identifier of the backup.

2265

"kind": "A String", # This is always *sql#backupContext*.

2266

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2267

"endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

2268

"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.

2269

"errors": [ # The list of errors encountered while processing this operation.

2270

{ # Database instance operation error.

2271

"code": "A String", # Identifies the specific error that occurred.

2272

"kind": "A String", # This is always *sql#operationError*.

2273

"message": "A String", # Additional information about the error encountered.

2274

},

2275

],

2276

"kind": "A String", # This is always *sql#operationErrors*.

2277

},

2278

"exportContext": { # Database instance export context. # The context for export operation, if applicable.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2279

"csvExportOptions": { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2280

"selectQuery": "A String", # The select query used to extract the data.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2281

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2282

"databases": [ # Databases to be exported. *MySQL instances:* If *fileType* is *SQL* and no database is specified, all databases are exported, except for the *mysql* system database. If *fileType* is *CSV*, you can specify one database, either by using this property or by using the *csvExportOptions.selectQuery* property, which takes precedence over this property. *PostgreSQL instances:* You must specify one database to be exported. If *fileType* is *CSV*, this database must match the one specified in the *csvExportOptions.selectQuery* property. *SQL Server instances:* You must specify one database to be exported, and the *fileType* must be *BAK*.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2283

"A String",

2284

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2285

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. *BAK*: The file contains backup data for a SQL Server instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2286

"kind": "A String", # This is always *sql#exportContext*.

2287

"offload": True or False, # Option for export offload.

2288

"sqlExportOptions": { # Options for exporting data as SQL statements.

2289

"mysqlExportOptions": { # Options for exporting from MySQL.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2290

"masterData": 42, # Option to include SQL statement required to set up replication. If set to *1*, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than *1*, --set-gtid-purged is set to OFF.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2291

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2292

"schemaOnly": True or False, # Export only schemas.

2293

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2294

"A String",

2295

],

2296

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2297

"uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form *gs://bucketName/fileName*. If the file already exists, the request succeeds, but the operation fails. If *fileType* is *SQL* and the filename ends with .gz, the contents are compressed.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2298

},

2299

"importContext": { # Database instance import context. # The context for import operation, if applicable.

2300

"bakImportOptions": { # Import parameters specific to SQL Server .BAK files

2301

"encryptionOptions": {

2302

"certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

2303

"pvkPassword": "A String", # Password that encrypts the private key

2304

"pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2305

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2306

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2307

"csvImportOptions": { # Options for importing data as CSV.

2308

"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.

2309

"A String",

2310

],

2311

"table": "A String", # The table to which CSV data is imported.

2312

},

2313

"database": "A String", # The target database for the import. If *fileType* is *SQL*, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If *fileType* is *CSV*, one database must be specified.

2314

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.

2315

"importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.

2316

"kind": "A String", # This is always *sql#importContext*.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2317

"uri": "A String", # Path to the import file in Cloud Storage, in the form *gs://bucketName/fileName*. Compressed gzip files (.gz) are supported when *fileType* is *SQL*. The instance must have write permissions to the bucket and read access to the file.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2318

},

2319

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

2320

"kind": "A String", # This is always *sql#operation*.

2321

"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.

2322

"operationType": "A String", # The type of the operation. Valid values are: *CREATE* *DELETE* *UPDATE* *RESTART* *IMPORT* *EXPORT* *BACKUP_VOLUME* *RESTORE_VOLUME* *CREATE_USER* *DELETE_USER* *CREATE_DATABASE* *DELETE_DATABASE*

2323

"selfLink": "A String", # The URI of this resource.

2324

"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

2325

"status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*

2326

"targetId": "A String", # Name of the database instance related to this operation.

2327

"targetLink": "A String",

2328

"targetProject": "A String", # The project ID of the target instance related to this operation.

2329

"user": "A String", # The email address of the user who initiated this operation.

2330

}</pre>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2334

<code class="details" id="startReplica">startReplica(project, instance, x__xgafv=None)</code>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

2335

<pre>Starts the replication in the read replica instance.

2336

2337

Args:

2338

project: string, ID of the project that contains the read replica. (required)

2339

instance: string, Cloud SQL read replica instance name. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2340

x__xgafv: string, V1 error format.

2341

Allowed values

2342

1 - v1 error format

2343

2 - v2 error format

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

2344

2345

Returns:

2346

An object of the form:

2347

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2348

{ # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2349

"backupContext": { # Backup context. # The context for backup operation, if applicable.

2350

"backupId": "A String", # The identifier of the backup.

2351

"kind": "A String", # This is always *sql#backupContext*.

2352

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2353

"endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

2354

"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.

2355

"errors": [ # The list of errors encountered while processing this operation.

2356

{ # Database instance operation error.

2357

"code": "A String", # Identifies the specific error that occurred.

2358

"kind": "A String", # This is always *sql#operationError*.

2359

"message": "A String", # Additional information about the error encountered.

2360

},

2361

],

2362

"kind": "A String", # This is always *sql#operationErrors*.

2363

},

2364

"exportContext": { # Database instance export context. # The context for export operation, if applicable.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2365

"csvExportOptions": { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2366

"selectQuery": "A String", # The select query used to extract the data.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2367

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2368

"databases": [ # Databases to be exported. *MySQL instances:* If *fileType* is *SQL* and no database is specified, all databases are exported, except for the *mysql* system database. If *fileType* is *CSV*, you can specify one database, either by using this property or by using the *csvExportOptions.selectQuery* property, which takes precedence over this property. *PostgreSQL instances:* You must specify one database to be exported. If *fileType* is *CSV*, this database must match the one specified in the *csvExportOptions.selectQuery* property. *SQL Server instances:* You must specify one database to be exported, and the *fileType* must be *BAK*.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2369

"A String",

2370

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2371

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. *BAK*: The file contains backup data for a SQL Server instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2372

"kind": "A String", # This is always *sql#exportContext*.

2373

"offload": True or False, # Option for export offload.

2374

"sqlExportOptions": { # Options for exporting data as SQL statements.

2375

"mysqlExportOptions": { # Options for exporting from MySQL.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2376

"masterData": 42, # Option to include SQL statement required to set up replication. If set to *1*, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than *1*, --set-gtid-purged is set to OFF.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2377

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2378

"schemaOnly": True or False, # Export only schemas.

2379

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2380

"A String",

2381

],

2382

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2383

"uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form *gs://bucketName/fileName*. If the file already exists, the request succeeds, but the operation fails. If *fileType* is *SQL* and the filename ends with .gz, the contents are compressed.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2384

},

2385

"importContext": { # Database instance import context. # The context for import operation, if applicable.

2386

"bakImportOptions": { # Import parameters specific to SQL Server .BAK files

2387

"encryptionOptions": {

2388

"certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

2389

"pvkPassword": "A String", # Password that encrypts the private key

2390

"pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2391

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2392

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2393

"csvImportOptions": { # Options for importing data as CSV.

2394

"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.

2395

"A String",

2396

],

2397

"table": "A String", # The table to which CSV data is imported.

2398

},

2399

"database": "A String", # The target database for the import. If *fileType* is *SQL*, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If *fileType* is *CSV*, one database must be specified.

2400

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.

2401

"importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.

2402

"kind": "A String", # This is always *sql#importContext*.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2403

"uri": "A String", # Path to the import file in Cloud Storage, in the form *gs://bucketName/fileName*. Compressed gzip files (.gz) are supported when *fileType* is *SQL*. The instance must have write permissions to the bucket and read access to the file.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2404

},

2405

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

2406

"kind": "A String", # This is always *sql#operation*.

2407

"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.

2408

"operationType": "A String", # The type of the operation. Valid values are: *CREATE* *DELETE* *UPDATE* *RESTART* *IMPORT* *EXPORT* *BACKUP_VOLUME* *RESTORE_VOLUME* *CREATE_USER* *DELETE_USER* *CREATE_DATABASE* *DELETE_DATABASE*

2409

"selfLink": "A String", # The URI of this resource.

2410

"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

2411

"status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*

2412

"targetId": "A String", # Name of the database instance related to this operation.

2413

"targetLink": "A String",

2414

"targetProject": "A String", # The project ID of the target instance related to this operation.

2415

"user": "A String", # The email address of the user who initiated this operation.

2416

}</pre>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2420

<code class="details" id="stopReplica">stopReplica(project, instance, x__xgafv=None)</code>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

2421

<pre>Stops the replication in the read replica instance.

2422

2423

Args:

2424

project: string, ID of the project that contains the read replica. (required)

2425

instance: string, Cloud SQL read replica instance name. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2426

x__xgafv: string, V1 error format.

2427

Allowed values

2428

1 - v1 error format

2429

2 - v2 error format

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

2430

2431

Returns:

2432

An object of the form:

2433

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2434

{ # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2435

"backupContext": { # Backup context. # The context for backup operation, if applicable.

2436

"backupId": "A String", # The identifier of the backup.

2437

"kind": "A String", # This is always *sql#backupContext*.

2438

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2439

"endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

2440

"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.

2441

"errors": [ # The list of errors encountered while processing this operation.

2442

{ # Database instance operation error.

2443

"code": "A String", # Identifies the specific error that occurred.

2444

"kind": "A String", # This is always *sql#operationError*.

2445

"message": "A String", # Additional information about the error encountered.

2446

},

2447

],

2448

"kind": "A String", # This is always *sql#operationErrors*.

2449

},

2450

"exportContext": { # Database instance export context. # The context for export operation, if applicable.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2451

"csvExportOptions": { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2452

"selectQuery": "A String", # The select query used to extract the data.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2453

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2454

"databases": [ # Databases to be exported. *MySQL instances:* If *fileType* is *SQL* and no database is specified, all databases are exported, except for the *mysql* system database. If *fileType* is *CSV*, you can specify one database, either by using this property or by using the *csvExportOptions.selectQuery* property, which takes precedence over this property. *PostgreSQL instances:* You must specify one database to be exported. If *fileType* is *CSV*, this database must match the one specified in the *csvExportOptions.selectQuery* property. *SQL Server instances:* You must specify one database to be exported, and the *fileType* must be *BAK*.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2455

"A String",

2456

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2457

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. *BAK*: The file contains backup data for a SQL Server instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2458

"kind": "A String", # This is always *sql#exportContext*.

2459

"offload": True or False, # Option for export offload.

2460

"sqlExportOptions": { # Options for exporting data as SQL statements.

2461

"mysqlExportOptions": { # Options for exporting from MySQL.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2462

"masterData": 42, # Option to include SQL statement required to set up replication. If set to *1*, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than *1*, --set-gtid-purged is set to OFF.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2463

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2464

"schemaOnly": True or False, # Export only schemas.

2465

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2466

"A String",

2467

],

2468

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2469

"uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form *gs://bucketName/fileName*. If the file already exists, the request succeeds, but the operation fails. If *fileType* is *SQL* and the filename ends with .gz, the contents are compressed.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2470

},

2471

"importContext": { # Database instance import context. # The context for import operation, if applicable.

2472

"bakImportOptions": { # Import parameters specific to SQL Server .BAK files

2473

"encryptionOptions": {

2474

"certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

2475

"pvkPassword": "A String", # Password that encrypts the private key

2476

"pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2477

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2478

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2479

"csvImportOptions": { # Options for importing data as CSV.

2480

"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.

2481

"A String",

2482

],

2483

"table": "A String", # The table to which CSV data is imported.

2484

},

2485

"database": "A String", # The target database for the import. If *fileType* is *SQL*, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If *fileType* is *CSV*, one database must be specified.

2486

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.

2487

"importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.

2488

"kind": "A String", # This is always *sql#importContext*.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2489

"uri": "A String", # Path to the import file in Cloud Storage, in the form *gs://bucketName/fileName*. Compressed gzip files (.gz) are supported when *fileType* is *SQL*. The instance must have write permissions to the bucket and read access to the file.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2490

},

2491

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

2492

"kind": "A String", # This is always *sql#operation*.

2493

"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.

2494

"operationType": "A String", # The type of the operation. Valid values are: *CREATE* *DELETE* *UPDATE* *RESTART* *IMPORT* *EXPORT* *BACKUP_VOLUME* *RESTORE_VOLUME* *CREATE_USER* *DELETE_USER* *CREATE_DATABASE* *DELETE_DATABASE*

2495

"selfLink": "A String", # The URI of this resource.

2496

"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

2497

"status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*

2498

"targetId": "A String", # Name of the database instance related to this operation.

2499

"targetLink": "A String",

2500

"targetProject": "A String", # The project ID of the target instance related to this operation.

2501

"user": "A String", # The email address of the user who initiated this operation.

2502

}</pre>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2506

<code class="details" id="truncateLog">truncateLog(project, instance, body=None, x__xgafv=None)</code>

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2507

<pre>Truncate MySQL general and slow query log tables MySQL only.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2508

2509

Args:

2510

project: string, Project ID of the Cloud SQL project. (required)

2511

instance: string, Cloud SQL instance ID. This does not include the project ID. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2512

body: object, The request body.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2513

The object takes the form of:

2514

2515

{ # Instance truncate log request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2516

"truncateLogContext": { # Database Instance truncate log context. # Contains details about the truncate log operation.

2517

"kind": "A String", # This is always *sql#truncateLogContext*.

2518

"logType": "A String", # The type of log to truncate. Valid values are *MYSQL_GENERAL_TABLE* and *MYSQL_SLOW_TABLE*.

2519

},

2520

}

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2521

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2522

x__xgafv: string, V1 error format.

2523

Allowed values

2524

1 - v1 error format

2525

2 - v2 error format

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2526

2527

Returns:

2528

An object of the form:

2529

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2530

{ # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2531

"backupContext": { # Backup context. # The context for backup operation, if applicable.

2532

"backupId": "A String", # The identifier of the backup.

2533

"kind": "A String", # This is always *sql#backupContext*.

2534

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2535

"endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

2536

"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.

2537

"errors": [ # The list of errors encountered while processing this operation.

2538

{ # Database instance operation error.

2539

"code": "A String", # Identifies the specific error that occurred.

2540

"kind": "A String", # This is always *sql#operationError*.

2541

"message": "A String", # Additional information about the error encountered.

2542

},

2543

],

2544

"kind": "A String", # This is always *sql#operationErrors*.

2545

},

2546

"exportContext": { # Database instance export context. # The context for export operation, if applicable.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2547

"csvExportOptions": { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2548

"selectQuery": "A String", # The select query used to extract the data.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2549

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2550

"databases": [ # Databases to be exported. *MySQL instances:* If *fileType* is *SQL* and no database is specified, all databases are exported, except for the *mysql* system database. If *fileType* is *CSV*, you can specify one database, either by using this property or by using the *csvExportOptions.selectQuery* property, which takes precedence over this property. *PostgreSQL instances:* You must specify one database to be exported. If *fileType* is *CSV*, this database must match the one specified in the *csvExportOptions.selectQuery* property. *SQL Server instances:* You must specify one database to be exported, and the *fileType* must be *BAK*.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2551

"A String",

2552

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2553

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. *BAK*: The file contains backup data for a SQL Server instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2554

"kind": "A String", # This is always *sql#exportContext*.

2555

"offload": True or False, # Option for export offload.

2556

"sqlExportOptions": { # Options for exporting data as SQL statements.

2557

"mysqlExportOptions": { # Options for exporting from MySQL.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2558

"masterData": 42, # Option to include SQL statement required to set up replication. If set to *1*, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than *1*, --set-gtid-purged is set to OFF.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2559

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2560

"schemaOnly": True or False, # Export only schemas.

2561

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2562

"A String",

2563

],

2564

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2565

"uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form *gs://bucketName/fileName*. If the file already exists, the request succeeds, but the operation fails. If *fileType* is *SQL* and the filename ends with .gz, the contents are compressed.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2566

},

2567

"importContext": { # Database instance import context. # The context for import operation, if applicable.

2568

"bakImportOptions": { # Import parameters specific to SQL Server .BAK files

2569

"encryptionOptions": {

2570

"certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

2571

"pvkPassword": "A String", # Password that encrypts the private key

2572

"pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2573

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2574

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2575

"csvImportOptions": { # Options for importing data as CSV.

2576

"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.

2577

"A String",

2578

],

2579

"table": "A String", # The table to which CSV data is imported.

2580

},

2581

"database": "A String", # The target database for the import. If *fileType* is *SQL*, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If *fileType* is *CSV*, one database must be specified.

2582

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.

2583

"importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.

2584

"kind": "A String", # This is always *sql#importContext*.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2585

"uri": "A String", # Path to the import file in Cloud Storage, in the form *gs://bucketName/fileName*. Compressed gzip files (.gz) are supported when *fileType* is *SQL*. The instance must have write permissions to the bucket and read access to the file.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2586

},

2587

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

2588

"kind": "A String", # This is always *sql#operation*.

2589

"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.

2590

"operationType": "A String", # The type of the operation. Valid values are: *CREATE* *DELETE* *UPDATE* *RESTART* *IMPORT* *EXPORT* *BACKUP_VOLUME* *RESTORE_VOLUME* *CREATE_USER* *DELETE_USER* *CREATE_DATABASE* *DELETE_DATABASE*

2591

"selfLink": "A String", # The URI of this resource.

2592

"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

2593

"status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*

2594

"targetId": "A String", # Name of the database instance related to this operation.

2595

"targetLink": "A String",

2596

"targetProject": "A String", # The project ID of the target instance related to this operation.

2597

"user": "A String", # The email address of the user who initiated this operation.

2598

}</pre>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2602

<code class="details" id="update">update(project, instance, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2603

<pre>Updates settings of a Cloud SQL instance. Using this operation might cause your instance to restart.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

2604

2605

Args:

2606

project: string, Project ID of the project that contains the instance. (required)

2607

instance: string, Cloud SQL instance ID. This does not include the project ID. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2608

body: object, The request body.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

2609

The object takes the form of:

2610

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2611

{ # A Cloud SQL instance resource.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2612

"backendType": "A String", # *SECOND_GEN*: Cloud SQL database instance. *EXTERNAL*: A database server that is not managed by Google. This property is read-only; use the *tier* property in the *settings* object to determine the database type.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2613

"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

2614

"createTime": "A String", # Output only. The time when the instance was created in RFC 3339 format (https://tools.ietf.org/html/rfc3339), for example 2012-11-15T16:19:00.094Z

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2615

"currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see this announcement for details.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

2616

"databaseVersion": "A String", # The database engine type and version. The *databaseVersion* field cannot be changed after instance creation. MySQL instances: *MYSQL_8_0*, *MYSQL_5_7* (default), or *MYSQL_5_6*. PostgreSQL instances: *POSTGRES_9_6*, *POSTGRES_10*, *POSTGRES_11*, *POSTGRES_12*, *POSTGRES_13* (default). SQL Server instances: *SQLSERVER_2019_STANDARD*, *SQLSERVER_2019_ENTERPRISE*, *SQLSERVER_2019_EXPRESS*, or *SQLSERVER_2019_WEB*, *SQLSERVER_2017_STANDARD* (default), *SQLSERVER_2017_ENTERPRISE*, *SQLSERVER_2017_EXPRESS*, or *SQLSERVER_2017_WEB*.

2617

"diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2618

"kind": "A String", # This is always *sql#diskEncryptionConfiguration*.

2619

"kmsKeyName": "A String", # Resource name of KMS key for disk encryption

2620

},

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

2621

"diskEncryptionStatus": { # Disk encryption status for an instance. # Disk encryption status specific to an instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2622

"kind": "A String", # This is always *sql#diskEncryptionStatus*.

2623

"kmsKeyVersionName": "A String", # KMS key version used to encrypt the Cloud SQL instance resource

2624

},

2625

"etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the *settings.settingsVersion* field instead.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

2626

"failoverReplica": { # The name and status of the failover replica.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2627

"available": True or False, # The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only failover to the failover replica when the status is true.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

2628

"name": "A String", # The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2629

},

2630

"gceZone": "A String", # The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone.

2631

"instanceType": "A String", # The instance type. This can be one of the following. *CLOUD_SQL_INSTANCE*: A Cloud SQL instance that is not replicating from a primary instance. *ON_PREMISES_INSTANCE*: An instance running on the customer's premises. *READ_REPLICA_INSTANCE*: A Cloud SQL instance configured as a read-replica.

2632

"ipAddresses": [ # The assigned IP addresses for the instance.

2633

{ # Database instance IP Mapping.

2634

"ipAddress": "A String", # The IP address assigned.

2635

"timeToRetire": "A String", # The due time for this IP to be retired in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*. This field is only available when the IP is scheduled to be retired.

2636

"type": "A String", # The type of this IP address. A *PRIMARY* address is a public address that can accept incoming connections. A *PRIVATE* address is a private address that can accept incoming connections. An *OUTGOING* address is the source address of connections originating from the instance, if supported.

2637

},

2638

],

2639

"ipv6Address": "A String", # The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances.

2640

"kind": "A String", # This is always *sql#instance*.

2641

"masterInstanceName": "A String", # The name of the instance which will act as primary in the replication setup.

2642

"maxDiskSize": "A String", # The maximum disk size of the instance in bytes.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2643

"name": "A String", # Name of the Cloud SQL instance. This does not include the project ID.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2644

"onPremisesConfiguration": { # On-premises instance configuration. # Configuration specific to on-premises instances.

2645

"caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.

2646

"clientCertificate": "A String", # PEM representation of the replica's x509 certificate.

2647

"clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.

2648

"dumpFilePath": "A String", # The dump file to create the Cloud SQL replica.

2649

"hostPort": "A String", # The host and port of the on-premises instance in host:port format

2650

"kind": "A String", # This is always *sql#onPremisesConfiguration*.

2651

"password": "A String", # The password for connecting to on-premises instance.

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

2652

"sourceInstance": { # Reference to another Cloud SQL instance. # The reference to Cloud SQL instance if the source is Cloud SQL.

2653

"name": "A String", # The name of the Cloud SQL instance being referenced. This does not include the project ID.

2654

"project": "A String", # The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it.

2655

"region": "A String", # The region of the Cloud SQL instance being referenced.

2656

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2657

"username": "A String", # The username for connecting to on-premises instance.

2658

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2659

"outOfDiskReport": { # This message wraps up the information written by out-of-disk detection job. # This field represents the report generated by the proactive database wellness job for OutOfDisk issues. Writers: -- the proactive database wellness job for OOD. Readers: -- the proactive database wellness job

2660

"sqlMinRecommendedIncreaseSizeGb": 42, # The minimum recommended increase size in GigaBytes This field is consumed by the frontend Writers: -- the proactive database wellness job for OOD.

2661

"sqlOutOfDiskState": "A String", # This field represents the state generated by the proactive database wellness job for OutOfDisk issues. Writers: -- the proactive database wellness job for OOD. Readers: -- the proactive database wellness job

yoshi-code-bot

2021-04-27 05:08:04 -0700

[diff] [blame]

2662

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2663

"project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.

2664

"region": "A String", # The geographical region. Can be *us-central* (*FIRST_GEN* instances only) *us-central1* (*SECOND_GEN* instances only) *asia-east1* or *europe-west1*. Defaults to *us-central* or *us-central1* depending on the instance type. The region cannot be changed after instance creation.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2665

"replicaConfiguration": { # Read-replica configuration for connecting to the primary instance. # Configuration specific to failover replicas and read replicas.

2666

"failoverTarget": True or False, # Specifies if the replica is the failover target. If the field is set to *true* the replica will be designated as a failover replica. In case the primary instance fails, the replica instance will be promoted as the new primary instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the primary instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2667

"kind": "A String", # This is always *sql#replicaConfiguration*.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2668

"mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # MySQL specific configuration when replicating from a MySQL on-premises primary instance. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named *master.info* in the data directory.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2669

"caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2670

"clientCertificate": "A String", # PEM representation of the replica's x509 certificate.

2671

"clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2672

"connectRetryInterval": 42, # Seconds to wait between connect retries. MySQL's default is 60 seconds.

2673

"dumpFilePath": "A String", # Path to a SQL dump file in Google Cloud Storage from which the replica instance is to be created. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported. Dumps have the binlog co-ordinates from which replication begins. This can be accomplished by setting --master-data to 1 when using mysqldump.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2674

"kind": "A String", # This is always *sql#mysqlReplicaConfiguration*.

2675

"masterHeartbeatPeriod": "A String", # Interval in milliseconds between replication heartbeats.

2676

"password": "A String", # The password for the replication connection.

2677

"sslCipher": "A String", # A list of permissible ciphers to use for SSL encryption.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2678

"username": "A String", # The username for the replication connection.

2679

"verifyServerCertificate": True or False, # Whether or not to check the primary instance's Common Name value in the certificate that it sends during the SSL handshake.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2680

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2681

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2682

"replicaNames": [ # The replicas of the instance.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2683

"A String",

2684

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2685

"rootPassword": "A String", # Initial root password. Use only on creation.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2686

"satisfiesPzs": True or False, # The status indicating if instance satisfiesPzs. Reserved for future use.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2687

"scheduledMaintenance": { # Any scheduled maintenancce for this instance. # The start time of any upcoming scheduled maintenance for this instance.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2688

"canDefer": True or False,

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2689

"canReschedule": True or False, # If the scheduled maintenance can be rescheduled.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

2690

"scheduleDeadlineTime": "A String", # Maintenance cannot be rescheduled to start beyond this deadline.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2691

"startTime": "A String", # The start time of any upcoming scheduled maintenance for this instance.

2692

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2693

"secondaryGceZone": "A String", # The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone. Reserved for future use.

2694

"selfLink": "A String", # The URI of this resource.

2695

"serverCaCert": { # SslCerts Resource # SSL configuration.

2696

"cert": "A String", # PEM representation.

2697

"certSerialNumber": "A String", # Serial number, as extracted from the certificate.

2698

"commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.

2699

"createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*

2700

"expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

2701

"instance": "A String", # Name of the database instance.

2702

"kind": "A String", # This is always *sql#sslCert*.

2703

"selfLink": "A String", # The URI of this resource.

2704

"sha1Fingerprint": "A String", # Sha1 Fingerprint.

2705

},

yoshi-code-bot

2021-06-03 00:48:27 -0700

[diff] [blame]

2706

"serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance. This property is read-only.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2707

"settings": { # Database instance settings. # The user settings.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2708

"activationPolicy": "A String", # The activation policy specifies when the instance is activated; it is applicable only when the instance state is RUNNABLE. Valid values: *ALWAYS*: The instance is on, and remains so even in the absence of connection requests. *NEVER*: The instance is off; it is not activated, even if a connection request arrives.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2709

"activeDirectoryConfig": { # Active Directory configuration, relevant only for Cloud SQL for SQL Server. # Active Directory configuration, relevant only for Cloud SQL for SQL Server.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2710

"domain": "A String", # The name of the domain (e.g., mydomain.com).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2711

"kind": "A String", # This is always sql#activeDirectoryConfig.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2712

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2713

"authorizedGaeApplications": [ # The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2714

"A String",

2715

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2716

"availabilityType": "A String", # Availability type. Potential values: *ZONAL*: The instance serves data from only one zone. Outages in that zone affect data accessibility. *REGIONAL*: The instance can serve data from more than one zone in a region (it is highly available). For more information, see Overview of the High Availability Configuration.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2717

"backupConfiguration": { # Database instance backup configuration. # The daily backup configuration for the instance.

2718

"backupRetentionSettings": { # We currently only support backup retention by specifying the number of backups we will retain. # Backup retention settings.

2719

"retainedBackups": 42, # Depending on the value of retention_unit, this is used to determine if a backup needs to be deleted. If retention_unit is 'COUNT', we will retain this many backups.

2720

"retentionUnit": "A String", # The unit that 'retained_backups' represents.

2721

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2722

"binaryLogEnabled": True or False, # (MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2723

"enabled": True or False, # Whether this configuration is enabled.

2724

"kind": "A String", # This is always *sql#backupConfiguration*.

2725

"location": "A String", # Location of the backup

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

2726

"pointInTimeRecoveryEnabled": True or False, # (Postgres only) Whether point in time recovery is enabled.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2727

"replicationLogArchivingEnabled": True or False, # Reserved for future use.

2728

"startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - *HH:MM*.

2729

"transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7.

2730

},

2731

"collation": "A String", # The name of server Instance collation.

2732

"crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.

2733

"dataDiskSizeGb": "A String", # The size of data disk, in GB. The data disk size minimum is 10GB.

2734

"dataDiskType": "A String", # The type of data disk: PD_SSD (default) or PD_HDD. Not used for First Generation instances.

2735

"databaseFlags": [ # The database flags passed to the instance at startup.

2736

{ # Database flags for Cloud SQL instances.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

2737

"name": "A String", # The name of the flag. These flags are passed at instance startup, so include both server options and system variables. Flags are specified with underscores, not hyphens. For more information, see Configuring Database Flags in the Cloud SQL documentation.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2738

"value": "A String", # The value of the flag. Booleans are set to *on* for true and *off* for false. This field must be omitted if the flag doesn't take a value.

2739

},

2740

],

2741

"databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not.

2742

"denyMaintenancePeriods": [ # Deny maintenance periods

2743

{ # Deny Maintenance Periods. This specifies a date range during when all CSA rollout will be denied.

2744

"endDate": "A String", # "deny maintenance period" end date. If the year of the end date is empty, the year of the start date also must be empty. In this case, it means the deny maintenance period recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01

2745

"startDate": "A String", # "deny maintenance period" start date. If the year of the start date is empty, the year of the end date also must be empty. In this case, it means the deny maintenance period recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01

2746

"time": "A String", # Time in UTC when the "deny maintenance period" starts on start_date and ends on end_date. The time is in format: HH:mm:SS, i.e., 00:00:00

2747

},

2748

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2749

"insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres.

2750

"queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

2751

"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. Default is 5.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2752

"queryStringLength": 42, # Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query length more than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2753

"recordApplicationTags": True or False, # Whether Query Insights will record application tags from query when enabled.

2754

"recordClientAddress": True or False, # Whether Query Insights will record client address when enabled.

2755

},

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

2756

"ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled.

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

2757

"allocatedIpRange": "A String", # The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with [RFC 1035](https://tools.ietf.org/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?.` Reserved for future use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2758

"authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: *192.168.100.0/24*).

2759

{ # An entry for an Access Control list.

2760

"expirationTime": "A String", # The time when this access control entry expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

2761

"kind": "A String", # This is always *sql#aclEntry*.

2762

"name": "A String", # Optional. A label to identify this entry.

2763

"value": "A String", # The allowlisted value for the access control list.

2764

},

2765

],

2766

"ipv4Enabled": True or False, # Whether the instance is assigned a public IP address or not.

2767

"privateNetwork": "A String", # The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, */projects/myProject/global/networks/default*. This setting can be updated, but it cannot be removed after it is set.

2768

"requireSsl": True or False, # Whether SSL connections over IP are enforced or not.

2769

},

2770

"kind": "A String", # This is always *sql#settings*.

2771

"locationPreference": { # Preferred location. This specifies where a Cloud SQL instance is located, either in a specific Compute Engine zone, or co-located with an App Engine application. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or Compute Engine zone for better performance. App Engine co-location was only applicable to First Generation instances.

2772

"followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance.

2773

"kind": "A String", # This is always *sql#locationPreference*.

2774

"secondaryZone": "A String", # The preferred Compute Engine zone for the secondary/failover (for example: us-central1-a, us-central1-b, etc.). Reserved for future use.

2775

"zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.).

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2776

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2777

"maintenanceWindow": { # Maintenance window. This specifies when a Cloud SQL instance is restarted for system maintenance purposes. # The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes.

2778

"day": 42, # day of week (1-7), starting on Monday.

2779

"hour": 42, # hour of day - 0 to 23.

2780

"kind": "A String", # This is always *sql#maintenanceWindow*.

2781

"updateTrack": "A String", # Maintenance timing setting: *canary* (Earlier) or *stable* (Later). Learn more.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2782

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2783

"pricingPlan": "A String", # The pricing plan for this instance. This can be either *PER_USE* or *PACKAGE*. Only *PER_USE* is supported for Second Generation instances.

2784

"replicationType": "A String", # The type of replication this instance uses. This can be either *ASYNCHRONOUS* or *SYNCHRONOUS*. (Deprecated_ This property was only applicable to First Generation instances.

2785

"settingsVersion": "A String", # The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.

2786

"storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is true.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2787

"storageAutoResizeLimit": "A String", # The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

2788

"tier": "A String", # The tier (or machine type) for this instance, for example *db-custom-1-3840* .

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2789

"userLabels": { # User-provided labels, represented as a dictionary where each label is a single key value pair.

2790

"a_key": "A String",

2791

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2792

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2793

"state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following. *SQL_INSTANCE_STATE_UNSPECIFIED*: The state of the instance is unknown. *RUNNABLE*: The instance is running, or has been stopped by owner. *SUSPENDED*: The instance is not available, for example due to problems with billing. *PENDING_DELETE*: The instance is being deleted. *PENDING_CREATE*: The instance is being created. *MAINTENANCE*: The instance is down for maintenance. *FAILED*: The instance creation failed.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2794

"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension.

2795

"A String",

2796

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2797

}

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

2798

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2799

x__xgafv: string, V1 error format.

2800

Allowed values

2801

1 - v1 error format

2802

2 - v2 error format

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

2803

2804

Returns:

2805

An object of the form:

2806

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2807

{ # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2808

"backupContext": { # Backup context. # The context for backup operation, if applicable.

2809

"backupId": "A String", # The identifier of the backup.

2810

"kind": "A String", # This is always *sql#backupContext*.

2811

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2812

"endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

2813

"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.

2814

"errors": [ # The list of errors encountered while processing this operation.

2815

{ # Database instance operation error.

2816

"code": "A String", # Identifies the specific error that occurred.

2817

"kind": "A String", # This is always *sql#operationError*.

2818

"message": "A String", # Additional information about the error encountered.

2819

},

2820

],

2821

"kind": "A String", # This is always *sql#operationErrors*.

2822

},

2823

"exportContext": { # Database instance export context. # The context for export operation, if applicable.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2824

"csvExportOptions": { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2825

"selectQuery": "A String", # The select query used to extract the data.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2826

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2827

"databases": [ # Databases to be exported. *MySQL instances:* If *fileType* is *SQL* and no database is specified, all databases are exported, except for the *mysql* system database. If *fileType* is *CSV*, you can specify one database, either by using this property or by using the *csvExportOptions.selectQuery* property, which takes precedence over this property. *PostgreSQL instances:* You must specify one database to be exported. If *fileType* is *CSV*, this database must match the one specified in the *csvExportOptions.selectQuery* property. *SQL Server instances:* You must specify one database to be exported, and the *fileType* must be *BAK*.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2828

"A String",

2829

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2830

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. *BAK*: The file contains backup data for a SQL Server instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2831

"kind": "A String", # This is always *sql#exportContext*.

2832

"offload": True or False, # Option for export offload.

2833

"sqlExportOptions": { # Options for exporting data as SQL statements.

2834

"mysqlExportOptions": { # Options for exporting from MySQL.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2835

"masterData": 42, # Option to include SQL statement required to set up replication. If set to *1*, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than *1*, --set-gtid-purged is set to OFF.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2836

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2837

"schemaOnly": True or False, # Export only schemas.

2838

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2839

"A String",

2840

],

2841

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2842

"uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form *gs://bucketName/fileName*. If the file already exists, the request succeeds, but the operation fails. If *fileType* is *SQL* and the filename ends with .gz, the contents are compressed.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2843

},

2844

"importContext": { # Database instance import context. # The context for import operation, if applicable.

2845

"bakImportOptions": { # Import parameters specific to SQL Server .BAK files

2846

"encryptionOptions": {

2847

"certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

2848

"pvkPassword": "A String", # Password that encrypts the private key

2849

"pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2850

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2851

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2852

"csvImportOptions": { # Options for importing data as CSV.

2853

"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.

2854

"A String",

2855

],

2856

"table": "A String", # The table to which CSV data is imported.

2857

},

2858

"database": "A String", # The target database for the import. If *fileType* is *SQL*, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If *fileType* is *CSV*, one database must be specified.

2859

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.

2860

"importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.

2861

"kind": "A String", # This is always *sql#importContext*.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2862

"uri": "A String", # Path to the import file in Cloud Storage, in the form *gs://bucketName/fileName*. Compressed gzip files (.gz) are supported when *fileType* is *SQL*. The instance must have write permissions to the bucket and read access to the file.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2863

},

2864

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

2865

"kind": "A String", # This is always *sql#operation*.

2866

"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.

2867

"operationType": "A String", # The type of the operation. Valid values are: *CREATE* *DELETE* *UPDATE* *RESTART* *IMPORT* *EXPORT* *BACKUP_VOLUME* *RESTORE_VOLUME* *CREATE_USER* *DELETE_USER* *CREATE_DATABASE* *DELETE_DATABASE*

2868

"selfLink": "A String", # The URI of this resource.

2869

"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

2870

"status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*

2871

"targetId": "A String", # Name of the database instance related to this operation.

2872

"targetLink": "A String",

2873

"targetProject": "A String", # The project ID of the target instance related to this operation.

2874

"user": "A String", # The email address of the user who initiated this operation.

2875

}</pre>

Craig Citro