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

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

[diff] [blame]

84

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

85

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

86

yoshi-code-bot

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

[diff] [blame]

87

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

88

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

89

90

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

91

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

92

93

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

94

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

95

96

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

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>

98

99

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

100

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

101

102

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

103

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

104

105

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

106

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

107

yoshi-code-bot

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

[diff] [blame]

108

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

109

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

110

yoshi-code-bot

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

[diff] [blame]

111

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

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>

113

yoshi-code-bot

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

[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>

yoshi-code-bot

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

[diff] [blame]

116

117

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

118

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

119

120

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

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>

122

123

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

124

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

125

126

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

127

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

128

129

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

130

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

131

132

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

133

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

134

135

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

136

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

137

138

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

139

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

140

141

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

142

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

143

144

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

145

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

yoshi-code-bot

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

[diff] [blame]

146

<h3>Method Details</h3>

147

yoshi-code-bot

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

[diff] [blame]

148

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

149

<pre>Adds 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.

150

151

Args:

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)

154

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

161

162

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

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

},

167

"endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) 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.

179

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

yoshi-code-bot

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

[diff] [blame^]

180

"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.

181

"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.

182

"linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.

183

"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.

yoshi-code-bot

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

[diff] [blame]

184

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

185

},

186

"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**.

187

"A String",

188

],

189

"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.

190

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

191

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

192

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

193

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

194

"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.

195

},

196

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

197

"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.

"A String",

],

},

"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.

202

},

203

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

204

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

205

"encryptionOptions": {

206

"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.

207

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

208

"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.

209

},

210

},

211

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

212

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

213

"A String",

214

],

yoshi-code-bot

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

[diff] [blame^]

215

"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.

216

"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.

217

"linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.

218

"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.

yoshi-code-bot

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

[diff] [blame]

219

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

220

},

221

"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.

222

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

223

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

224

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

225

"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.

226

},

227

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

228

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

229

"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.

230

"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**

231

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

232

"startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

233

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

234

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

235

"targetLink": "A String",

236

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

237

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

}</pre>

</div>

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

243

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

244

245

Args:

246

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

247

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

248

body: object, The request body.

249

The object takes the form of:

250

251

{ # Database instance clone request.

252

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

253

"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.

254

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

255

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

256

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

257

},

258

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

259

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

260

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

261

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

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

272

273

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

274

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

275

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

276

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

277

},

278

"endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

279

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

280

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

281

{ # Database instance operation error.

282

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

283

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

284

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

285

},

286

],

287

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

288

},

289

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

290

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

yoshi-code-bot

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

[diff] [blame^]

291

"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.

292

"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.

293

"linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.

294

"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.

yoshi-code-bot

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

[diff] [blame]

295

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

296

},

297

"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**.

298

"A String",

299

],

300

"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.

301

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

302

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

303

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

304

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

305

"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.

306

},

307

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

308

"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.

"A String",

],

},

"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.

313

},

314

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

315

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

316

"encryptionOptions": {

317

"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.

318

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

319

"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.

320

},

321

},

322

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

323

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

324

"A String",

325

],

yoshi-code-bot

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

[diff] [blame^]

326

"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.

327

"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.

328

"linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.

329

"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.

yoshi-code-bot

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

[diff] [blame]

330

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

331

},

332

"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.

333

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

334

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

335

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

336

"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.

337

},

338

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

339

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

340

"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.

341

"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**

342

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

343

"startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

344

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

345

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

346

"targetLink": "A String",

347

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

348

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

}</pre>

</div>

yoshi-code-bot

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

[diff] [blame]

353

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

354

<pre>Close httplib2 connections.</pre>

</div>

yoshi-code-bot

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

[diff] [blame]

358

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

359

<pre>Deletes a Cloud SQL instance.

360

361

Args:

362

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

363

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

364

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

371

372

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

373

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

374

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

375

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

376

},

377

"endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

378

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

379

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

380

{ # Database instance operation error.

381

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

382

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

383

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

384

},

385

],

386

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

387

},

388

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

389

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

yoshi-code-bot

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

[diff] [blame^]

390

"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.

391

"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.

392

"linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.

393

"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.

yoshi-code-bot

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

[diff] [blame]

394

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

395

},

396

"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**.

397

"A String",

398

],

399

"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.

400

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

401

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

402

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

403

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

404

"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.

405

},

406

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

407

"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.

"A String",

],

},

"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.

412

},

413

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

414

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

415

"encryptionOptions": {

416

"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.

417

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

418

"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.

419

},

420

},

421

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

422

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

423

"A String",

424

],

yoshi-code-bot

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

[diff] [blame^]

425

"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.

426

"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.

427

"linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.

428

"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.

yoshi-code-bot

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

[diff] [blame]

429

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

430

},

431

"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.

432

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

433

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

434

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

435

"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.

436

},

437

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

438

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

439

"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.

440

"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**

441

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

442

"startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

443

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

444

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

445

"targetLink": "A String",

446

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

447

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

}</pre>

</div>

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

453

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

454

455

Args:

456

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

457

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

458

body: object, The request body.

459

The object takes the form of:

460

461

{ # Database demote primary instance request.

462

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

463

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

464

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

465

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

466

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

467

"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.

468

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

469

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

470

"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.

471

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

472

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

473

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

474

},

475

},

yoshi-code-bot

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

[diff] [blame]

476

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

yoshi-code-bot

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

[diff] [blame]

477

"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 value only if you know the reason for the GTID divergence and are confident that doing so will not cause any replication issues.

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

488

489

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

490

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

491

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

492

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

493

},

494

"endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

495

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

496

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

497

{ # Database instance operation error.

498

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

499

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

500

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

501

},

502

],

503

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

504

},

505

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

506

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

yoshi-code-bot

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

[diff] [blame^]

507

"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.

508

"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.

509

"linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.

510

"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.

yoshi-code-bot

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

[diff] [blame]

511

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

512

},

513

"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**.

514

"A String",

515

],

516

"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.

517

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

518

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

519

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

520

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

521

"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.

522

},

523

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

524

"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.

"A String",

],

},

"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.

529

},

530

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

531

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

532

"encryptionOptions": {

533

"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.

534

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

535

"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.

536

},

537

},

538

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

539

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

540

"A String",

541

],

yoshi-code-bot

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

[diff] [blame^]

542

"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.

543

"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.

544

"linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.

545

"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.

yoshi-code-bot

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

[diff] [blame]

546

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

547

},

548

"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.

549

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

550

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

551

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

552

"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.

553

},

554

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

555

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

556

"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.

557

"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**

558

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

559

"startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

560

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

561

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

562

"targetLink": "A String",

563

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

564

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

}</pre>

</div>

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

570

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

571

572

Args:

573

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

574

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

575

body: object, The request body.

576

The object takes the form of:

577

578

{ # Database instance export request.

579

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

580

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

yoshi-code-bot

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

[diff] [blame^]

581

"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.

582

"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.

583

"linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.

584

"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.

yoshi-code-bot

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

[diff] [blame]

585

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

586

},

587

"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**.

588

"A String",

589

],

590

"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.

591

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

592

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

593

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

594

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

595

"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.

596

},

597

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

598

"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.

"A String",

],

},

"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.

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

613

614

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

615

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

616

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

617

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

618

},

619

"endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

620

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

621

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

622

{ # Database instance operation error.

623

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

624

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

625

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

626

},

627

],

628

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

629

},

630

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

631

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

yoshi-code-bot

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

[diff] [blame^]

632

"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.

633

"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.

634

"linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.

635

"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.

yoshi-code-bot

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

[diff] [blame]

636

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

637

},

638

"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**.

639

"A String",

640

],

641

"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.

642

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

643

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

644

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

645

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

646

"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.

647

},

648

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

649

"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.

"A String",

],

},

"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.

654

},

655

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

656

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

657

"encryptionOptions": {

658

"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.

659

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

660

"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.

661

},

662

},

663

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

664

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

665

"A String",

666

],

yoshi-code-bot

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

[diff] [blame^]

667

"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.

668

"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.

669

"linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.

670

"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.

yoshi-code-bot

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

[diff] [blame]

671

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

672

},

673

"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.

674

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

675

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

676

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

677

"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.

678

},

679

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

680

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

681

"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.

682

"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**

683

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

684

"startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

685

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

686

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

687

"targetLink": "A String",

688

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

689

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

}</pre>

</div>

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

695

<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.

696

697

Args:

698

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

699

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

700

body: object, The request body.

701

The object takes the form of:

702

703

{ # Instance failover request.

704

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

705

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

706

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

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

717

718

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

719

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

720

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

721

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

722

},

723

"endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

724

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

725

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

726

{ # Database instance operation error.

727

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

728

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

729

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

730

},

731

],

732

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

733

},

734

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

735

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

yoshi-code-bot

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

[diff] [blame^]

736

"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.

737

"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.

738

"linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.

739

"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.

yoshi-code-bot

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

[diff] [blame]

740

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

741

},

742

"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**.

743

"A String",

744

],

745

"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.

746

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

747

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

748

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

749

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

750

"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.

751

},

752

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

753

"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.

"A String",

],

},

"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.

758

},

759

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

760

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

761

"encryptionOptions": {

762

"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.

763

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

764

"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.

765

},

766

},

767

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

768

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

769

"A String",

770

],

yoshi-code-bot

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

[diff] [blame^]

771

"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.

772

"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.

773

"linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.

774

"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.

yoshi-code-bot

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

[diff] [blame]

775

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

776

},

777

"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.

778

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

779

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

780

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

781

"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.

782

},

783

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

784

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

785

"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.

786

"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**

787

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

788

"startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

789

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

790

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

791

"targetLink": "A String",

792

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

793

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

}</pre>

</div>

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

799

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

800

801

Args:

802

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

803

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

804

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

811

812

{ # A Cloud SQL instance resource.

813

"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.

814

"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]

815

"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-code-bot

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

[diff] [blame]

816

"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.

817

"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*.

818

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

819

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

820

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

821

},

822

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

823

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

824

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

825

},

826

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

827

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

828

"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.

829

"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.

830

},

831

"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.

832

"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.

833

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

834

{ # Database instance IP Mapping.

835

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

836

"timeToRetire": "A String", # The due time for this IP to be retired in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. This field is only available when the IP is scheduled to be retired.

837

"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.

838

},

839

],

840

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

841

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

842

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

843

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

844

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

845

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

846

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

847

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

848

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

849

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

850

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

851

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

852

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

yoshi-code-bot

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

[diff] [blame]

853

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

854

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

855

"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.

856

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

857

},

yoshi-code-bot

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

[diff] [blame]

858

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

859

},

860

"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 Pantheon frontend -- the proactive database wellness job

861

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

862

"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 Pantheon frontend -- the proactive database wellness job

863

},

864

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

865

"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.

866

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

867

"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.

868

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

869

"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.

870

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

871

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

872

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

873

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

874

"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.

875

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

876

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

877

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

878

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

879

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

880

"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.

881

},

882

},

883

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

884

"A String",

885

],

886

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

887

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

888

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

889

"canDefer": True or False,

890

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

891

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

892

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

893

},

894

"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.

895

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

896

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

897

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

898

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

899

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

900

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

901

"expirationTime": "A String", # The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

902

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

903

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

904

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

905

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

906

},

907

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

908

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

909

"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.

910

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

911

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

912

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

913

},

914

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

915

"A String",

916

],

917

"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](https://cloud.google.com/sql/docs/mysql/high-availability).

918

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

919

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

920

"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.

921

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

922

},

923

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

924

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

925

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

926

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

927

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

928

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

929

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

930

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

931

},

932

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

933

"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.

934

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

935

"dataDiskType": "A String", # The type of data disk: **PD_SSD** (default) or **PD_HDD**.

936

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

937

{ # Database flags for Cloud SQL instances.

938

"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](https://cloud.google.com/sql/docs/mysql/flags) in the Cloud SQL documentation.

939

"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.

940

},

941

],

942

"databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not.

943

"denyMaintenancePeriods": [ # Deny maintenance periods

944

{ # Deny maintenance Periods. This specifies a date range during when all CSA rollout will be denied.

945

"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 no maintenance interval recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01

946

"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 no maintenance interval recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01

947

"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

948

},

949

],

950

"insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres.

951

"queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled.

952

"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. Default is 5.

953

"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.

954

"recordApplicationTags": True or False, # Whether Query Insights will record application tags from query when enabled.

955

"recordClientAddress": True or False, # Whether Query Insights will record client address when enabled.

956

},

957

"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 for Second Generation instances.

yoshi-code-bot

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

[diff] [blame]

958

"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-code-bot

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

[diff] [blame]

959

"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**).

960

{ # An entry for an Access Control list.

961

"expirationTime": "A String", # The time when this access control entry expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

962

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

963

"name": "A String", # Optional. A label to identify this entry.

964

"value": "A String", # The allowlisted value for the access control list.

965

},

966

],

967

"ipv4Enabled": True or False, # Whether the instance is assigned a public IP address or not.

968

"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.

969

"requireSsl": True or False, # Whether SSL connections over IP are enforced or not.

970

},

971

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

972

"locationPreference": { # Preferred location. This specifies where a Cloud SQL instance is located. 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 Compute Engine zone for better performance.

973

"followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance.

974

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

975

"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.

976

"zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.).

977

},

978

"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.

979

"day": 42, # day of week (1-7), starting on Monday.

980

"hour": 42, # hour of day - 0 to 23.

981

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

982

"updateTrack": "A String", # Maintenance timing setting: **canary** (Earlier) or **stable** (Later). [Learn more] (https://cloud.google.com/sql/docs/mysql/instance-settings#maintenance-timing-2ndgen).

983

},

984

"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.

985

"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.

986

"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.

yoshi-code-bot

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

[diff] [blame^]

987

"sqlServerAuditConfig": { # SQL Server specific audit configuration. # SQL Server specific audit configuration.

988

"bucket": "A String", # The name of the destination bucket (e.g., gs://mybucket).

989

"kind": "A String", # This is always sql#sqlServerAuditConfig

990

},

yoshi-code-bot

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

[diff] [blame]

991

"storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is true.

992

"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.

993

"tier": "A String", # The tier (or machine type) for this instance, for example **db-custom-1-3840**.

994

"userLabels": { # User-provided labels, represented as a dictionary where each label is a single key value pair.

"a_key": "A String",

},

},

"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.

999

"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension.

"A String",

],

}</pre>

</div>

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

1007

<pre>Imports data into a Cloud SQL instance from a SQL dump or CSV file in Cloud Storage.

1008

1009

Args:

1010

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

1011

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

1012

body: object, The request body.

1013

The object takes the form of:

1014

1015

{ # Database instance import request.

1016

"importContext": { # Database instance import context. # Contains details about the import operation.

1017

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

1018

"encryptionOptions": {

1019

"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.

1020

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

1021

"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.

1022

},

1023

},

1024

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

1025

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

1026

"A String",

1027

],

yoshi-code-bot

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

[diff] [blame^]

1028

"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.

1029

"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.

1030

"linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.

1031

"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.

yoshi-code-bot

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

[diff] [blame]

1032

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

1033

},

1034

"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.

1035

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

1036

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

1037

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

1038

"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.

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1049

1050

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

1051

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

1052

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

1053

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

1054

},

1055

"endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

1056

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

1057

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

1058

{ # Database instance operation error.

1059

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

1060

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

1061

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

1062

},

1063

],

1064

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

1065

},

1066

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

1067

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

yoshi-code-bot

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

[diff] [blame^]

1068

"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.

1069

"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.

1070

"linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.

1071

"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.

yoshi-code-bot

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

[diff] [blame]

1072

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

1073

},

1074

"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**.

1075

"A String",

1076

],

1077

"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.

1078

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

1079

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

1080

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

1081

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

1082

"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.

1083

},

1084

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

1085

"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.

"A String",

],

},

"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.

1090

},

1091

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

1092

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

1093

"encryptionOptions": {

1094

"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.

1095

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

1096

"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.

1097

},

1098

},

1099

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

1100

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

1101

"A String",

1102

],

yoshi-code-bot

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

[diff] [blame^]

1103

"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.

1104

"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.

1105

"linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.

1106

"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.

yoshi-code-bot

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

[diff] [blame]

1107

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

1108

},

1109

"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.

1110

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

1111

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

1112

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

1113

"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.

1114

},

1115

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

1116

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

1117

"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.

1118

"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**

1119

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

1120

"startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

1121

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

1122

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

1123

"targetLink": "A String",

1124

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

1125

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

}</pre>

</div>

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

1131

<pre>Creates a new Cloud SQL instance.

1132

1133

Args:

1134

project: string, Project ID of the project to which the newly created Cloud SQL instances should belong. (required)

1135

body: object, The request body.

1136

The object takes the form of:

1137

1138

{ # A Cloud SQL instance resource.

1139

"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.

1140

"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]

1141

"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-code-bot

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

[diff] [blame]

1142

"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.

1143

"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*.

1144

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

1145

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

1146

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

1147

},

1148

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

1149

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

1150

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

1151

},

1152

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

1153

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

1154

"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.

1155

"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.

1156

},

1157

"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.

1158

"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.

1159

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

1160

{ # Database instance IP Mapping.

1161

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

1162

"timeToRetire": "A String", # The due time for this IP to be retired in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. This field is only available when the IP is scheduled to be retired.

1163

"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.

1164

},

1165

],

1166

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

1167

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

1168

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

1169

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

1170

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

1171

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

1172

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

1173

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

1174

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

1175

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

1176

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

1177

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

1178

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

yoshi-code-bot

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

[diff] [blame]

1179

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

1180

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

1181

"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.

1182

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

1183

},

yoshi-code-bot

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

[diff] [blame]

1184

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

1185

},

1186

"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 Pantheon frontend -- the proactive database wellness job

1187

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

1188

"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 Pantheon frontend -- the proactive database wellness job

1189

},

1190

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

1191

"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.

1192

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

1193

"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.

1194

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

1195

"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.

1196

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

1197

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

1198

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

1199

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

1200

"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.

1201

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

1202

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

1203

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

1204

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

1205

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

1206

"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.

1207

},

1208

},

1209

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

1210

"A String",

1211

],

1212

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

1213

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

1214

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

1215

"canDefer": True or False,

1216

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

1217

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

1218

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

1219

},

1220

"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.

1221

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

1222

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

1223

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

1224

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

1225

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

1226

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

1227

"expirationTime": "A String", # The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

1228

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

1229

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

1230

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

1231

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

1232

},

1233

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

1234

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

1235

"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.

1236

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

1237

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

1238

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

1239

},

1240

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

1241

"A String",

1242

],

1243

"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](https://cloud.google.com/sql/docs/mysql/high-availability).

1244

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

1245

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

1246

"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.

1247

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

1248

},

1249

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

1250

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

1251

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

1252

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

1253

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

1254

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

1255

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

1256

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

1257

},

1258

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

1259

"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.

1260

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

1261

"dataDiskType": "A String", # The type of data disk: **PD_SSD** (default) or **PD_HDD**.

1262

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

1263

{ # Database flags for Cloud SQL instances.

1264

"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](https://cloud.google.com/sql/docs/mysql/flags) in the Cloud SQL documentation.

1265

"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.

1266

},

1267

],

1268

"databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not.

1269

"denyMaintenancePeriods": [ # Deny maintenance periods

1270

{ # Deny maintenance Periods. This specifies a date range during when all CSA rollout will be denied.

1271

"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 no maintenance interval recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01

1272

"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 no maintenance interval recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01

1273

"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

1274

},

1275

],

1276

"insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres.

1277

"queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled.

1278

"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. Default is 5.

1279

"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.

1280

"recordApplicationTags": True or False, # Whether Query Insights will record application tags from query when enabled.

1281

"recordClientAddress": True or False, # Whether Query Insights will record client address when enabled.

1282

},

1283

"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 for Second Generation instances.

yoshi-code-bot

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

[diff] [blame]

1284

"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-code-bot

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

[diff] [blame]

1285

"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**).

1286

{ # An entry for an Access Control list.

1287

"expirationTime": "A String", # The time when this access control entry expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

1288

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

1289

"name": "A String", # Optional. A label to identify this entry.

1290

"value": "A String", # The allowlisted value for the access control list.

1291

},

1292

],

1293

"ipv4Enabled": True or False, # Whether the instance is assigned a public IP address or not.

1294

"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.

1295

"requireSsl": True or False, # Whether SSL connections over IP are enforced or not.

1296

},

1297

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

1298

"locationPreference": { # Preferred location. This specifies where a Cloud SQL instance is located. 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 Compute Engine zone for better performance.

1299

"followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance.

1300

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

1301

"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.

1302

"zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.).

1303

},

1304

"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.

1305

"day": 42, # day of week (1-7), starting on Monday.

1306

"hour": 42, # hour of day - 0 to 23.

1307

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

1308

"updateTrack": "A String", # Maintenance timing setting: **canary** (Earlier) or **stable** (Later). [Learn more] (https://cloud.google.com/sql/docs/mysql/instance-settings#maintenance-timing-2ndgen).

1309

},

1310

"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.

1311

"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.

1312

"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.

yoshi-code-bot

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

[diff] [blame^]

1313

"sqlServerAuditConfig": { # SQL Server specific audit configuration. # SQL Server specific audit configuration.

1314

"bucket": "A String", # The name of the destination bucket (e.g., gs://mybucket).

1315

"kind": "A String", # This is always sql#sqlServerAuditConfig

1316

},

yoshi-code-bot

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

[diff] [blame]

1317

"storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is true.

1318

"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.

1319

"tier": "A String", # The tier (or machine type) for this instance, for example **db-custom-1-3840**.

1320

"userLabels": { # User-provided labels, represented as a dictionary where each label is a single key value pair.

"a_key": "A String",

},

},

"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.

1325

"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension.

"A String",

],

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1337

1338

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

1339

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

1340

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

1341

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

1342

},

1343

"endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

1344

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

1345

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

1346

{ # Database instance operation error.

1347

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

1348

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

1349

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

1350

},

1351

],

1352

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

1353

},

1354

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

1355

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

yoshi-code-bot

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

[diff] [blame^]

1356

"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.

1357

"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.

1358

"linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.

1359

"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.

yoshi-code-bot

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

[diff] [blame]

1360

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

1361

},

1362

"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**.

1363

"A String",

1364

],

1365

"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.

1366

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

1367

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

1368

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

1369

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

1370

"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.

1371

},

1372

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

1373

"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.

"A String",

],

},

"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.

1378

},

1379

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

1380

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

1381

"encryptionOptions": {

1382

"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.

1383

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

1384

"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.

1385

},

1386

},

1387

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

1388

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

1389

"A String",

1390

],

yoshi-code-bot

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

[diff] [blame^]

1391

"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.

1392

"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.

1393

"linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.

1394

"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.

yoshi-code-bot

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

[diff] [blame]

1395

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

1396

},

1397

"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.

1398

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

1399

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

1400

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

1401

"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.

1402

},

1403

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

1404

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

1405

"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.

1406

"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**

1407

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

1408

"startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

1409

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

1410

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

1411

"targetLink": "A String",

1412

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

1413

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

}</pre>

</div>

yoshi-code-bot

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

[diff] [blame]

1418

<code class="details" id="list">list(project, filter=None, maxResults=None, pageToken=None, x__xgafv=None)</code>

1419

<pre>Lists instances under a given project.

1420

1421

Args:

1422

project: string, Project ID of the project for which to list Cloud SQL instances. (required)

1423

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.

1424

maxResults: integer, The maximum number of results to return per response.

1425

pageToken: string, A previously-returned page token representing part of the larger set of results to view.

1426

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1433

1434

{ # Database instances list response.

1435

"items": [ # List of database instance resources.

1436

{ # A Cloud SQL instance resource.

1437

"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.

1438

"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]

1439

"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-code-bot

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

[diff] [blame]

1440

"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]

1441

"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*.

1442

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

yoshi-code-bot

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

[diff] [blame]

1443

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

1444

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

1445

},

yoshi-code-bot

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

[diff] [blame]

1446

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

yoshi-code-bot

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

[diff] [blame]

1447

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

1448

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

1449

},

yoshi-code-bot

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

[diff] [blame]

1450

"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]

1451

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

yoshi-code-bot

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

[diff] [blame]

1452

"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]

1453

"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-code-bot

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

[diff] [blame]

1454

},

1455

"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.

yoshi-code-bot

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

[diff] [blame]

1456

"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.

yoshi-code-bot

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

[diff] [blame]

1457

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

1458

{ # Database instance IP Mapping.

1459

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

1460

"timeToRetire": "A String", # The due time for this IP to be retired in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. This field is only available when the IP is scheduled to be retired.

1461

"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.

1462

},

1463

],

1464

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

1465

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

yoshi-code-bot

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

[diff] [blame]

1466

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

1467

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

1468

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

1469

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

1470

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

1471

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

1472

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

1473

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

1474

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

1475

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

1476

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

yoshi-code-bot

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

[diff] [blame]

1477

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

1478

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

1479

"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.

1480

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

1481

},

yoshi-code-bot

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

[diff] [blame]

1482

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

1483

},

1484

"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 Pantheon frontend -- the proactive database wellness job

1485

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

1486

"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 Pantheon frontend -- the proactive database wellness job

1487

},

1488

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

1489

"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.

1490

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

1491

"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.

1492

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

1493

"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.

1494

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

1495

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

1496

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

1497

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

1498

"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.

1499

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

1500

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

1501

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

1502

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

1503

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

1504

"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.

1505

},

1506

},

yoshi-code-bot

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

[diff] [blame]

1507

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

1508

"A String",

1509

],

1510

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

1511

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

1512

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

1513

"canDefer": True or False,

1514

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

1515

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

1516

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

1517

},

1518

"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.

1519

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

1520

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

1521

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

1522

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

1523

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

1524

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

1525

"expirationTime": "A String", # The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

1526

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

1527

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

yoshi-code-bot

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

[diff] [blame]

1528

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

yoshi-code-bot

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

[diff] [blame]

1529

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

1530

},

1531

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

1532

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

1533

"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.

1534

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

1535

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

1536

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

1537

},

yoshi-code-bot

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

[diff] [blame]

1538

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

1539

"A String",

1540

],

1541

"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](https://cloud.google.com/sql/docs/mysql/high-availability).

yoshi-code-bot

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

[diff] [blame]

1542

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

1543

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

1544

"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.

1545

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

1546

},

1547

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

1548

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

1549

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

1550

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

1551

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

1552

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

1553

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

1554

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

1555

},

1556

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

1557

"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.

1558

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

1559

"dataDiskType": "A String", # The type of data disk: **PD_SSD** (default) or **PD_HDD**.

1560

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

1561

{ # Database flags for Cloud SQL instances.

yoshi-code-bot

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

[diff] [blame]

1562

"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](https://cloud.google.com/sql/docs/mysql/flags) in the Cloud SQL documentation.

yoshi-code-bot

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

[diff] [blame]

1563

"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.

1564

},

1565

],

1566

"databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not.

1567

"denyMaintenancePeriods": [ # Deny maintenance periods

1568

{ # Deny maintenance Periods. This specifies a date range during when all CSA rollout will be denied.

1569

"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 no maintenance interval recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01

1570

"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 no maintenance interval recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01

1571

"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

1572

},

1573

],

1574

"insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres.

1575

"queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled.

yoshi-code-bot

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

[diff] [blame]

1576

"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. Default is 5.

yoshi-code-bot

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

[diff] [blame]

1577

"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.

1578

"recordApplicationTags": True or False, # Whether Query Insights will record application tags from query when enabled.

1579

"recordClientAddress": True or False, # Whether Query Insights will record client address when enabled.

1580

},

1581

"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 for Second Generation instances.

yoshi-code-bot

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

[diff] [blame]

1582

"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-code-bot

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

[diff] [blame]

1583

"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**).

1584

{ # An entry for an Access Control list.

1585

"expirationTime": "A String", # The time when this access control entry expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

1586

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

1587

"name": "A String", # Optional. A label to identify this entry.

1588

"value": "A String", # The allowlisted value for the access control list.

1589

},

1590

],

1591

"ipv4Enabled": True or False, # Whether the instance is assigned a public IP address or not.

1592

"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.

1593

"requireSsl": True or False, # Whether SSL connections over IP are enforced or not.

1594

},

1595

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

1596

"locationPreference": { # Preferred location. This specifies where a Cloud SQL instance is located. 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 Compute Engine zone for better performance.

yoshi-code-bot

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

[diff] [blame]

1597

"followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance.

yoshi-code-bot

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

[diff] [blame]

1598

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

1599

"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.

1600

"zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.).

1601

},

1602

"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.

1603

"day": 42, # day of week (1-7), starting on Monday.

1604

"hour": 42, # hour of day - 0 to 23.

1605

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

yoshi-code-bot

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

[diff] [blame]

1606

"updateTrack": "A String", # Maintenance timing setting: **canary** (Earlier) or **stable** (Later). [Learn more] (https://cloud.google.com/sql/docs/mysql/instance-settings#maintenance-timing-2ndgen).

yoshi-code-bot

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

[diff] [blame]

1607

},

1608

"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.

1609

"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.

1610

"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.

yoshi-code-bot

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

[diff] [blame^]

1611

"sqlServerAuditConfig": { # SQL Server specific audit configuration. # SQL Server specific audit configuration.

1612

"bucket": "A String", # The name of the destination bucket (e.g., gs://mybucket).

1613

"kind": "A String", # This is always sql#sqlServerAuditConfig

1614

},

yoshi-code-bot

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

[diff] [blame]

1615

"storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is true.

1616

"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.

1617

"tier": "A String", # The tier (or machine type) for this instance, for example **db-custom-1-3840**.

1618

"userLabels": { # User-provided labels, represented as a dictionary where each label is a single key value pair.

"a_key": "A String",

},

},

"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.

1623

"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension.

"A String",

],

},

],

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

1629

"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.

1630

"warnings": [ # List of warnings that occurred while handling the request.

1631

{ # An Admin API warning message.

1632

"code": "A String", # Code to uniquely identify the warning type.

1633

"message": "A String", # The warning message.

1634

"region": "A String", # The region name for REGION_UNREACHABLE warning.

},

],

}</pre>

</div>

yoshi-code-bot

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

[diff] [blame]

1641

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

1642

<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.

1643

1644

Args:

1645

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

1646

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

1647

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1654

1655

{ # Instances ListServerCas response.

1656

"activeVersion": "A String",

1657

"certs": [ # List of server CA certificates for the instance.

1658

{ # SslCerts Resource

1659

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

1660

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

1661

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

1662

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

1663

"expirationTime": "A String", # The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

1664

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

1665

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

1666

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

1667

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

1668

},

1669

],

1670

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

}</pre>

</div>

yoshi-code-bot

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

[diff] [blame]

1675

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

1676

<pre>Retrieves the next page of results.

1677

1678

Args:

1679

previous_request: The request for the previous page. (required)

1680

previous_response: The response from the request for the previous page. (required)

1681

1682

Returns:

1683

A request object that you can call 'execute()' on to request the next

1684

page. Returns None if there are no more items in the collection.

</pre>

</div>

yoshi-code-bot

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

[diff] [blame]

1688

1689

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

1690

<pre>Updates settings of a Cloud SQL instance. This method supports patch semantics.

1691

1692

Args:

1693

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

1694

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

1695

body: object, The request body.

1696

The object takes the form of:

1697

1698

{ # A Cloud SQL instance resource.

1699

"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.

1700

"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]

1701

"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-code-bot

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

[diff] [blame]

1702

"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.

1703

"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*.

1704

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

1705

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

1706

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

1707

},

1708

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

1709

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

1710

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

1711

},

1712

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

1713

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

1714

"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.

1715

"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.

1716

},

1717

"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.

1718

"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.

1719

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

1720

{ # Database instance IP Mapping.

1721

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

1722

"timeToRetire": "A String", # The due time for this IP to be retired in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. This field is only available when the IP is scheduled to be retired.

1723

"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.

1724

},

1725

],

1726

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

1727

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

1728

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

1729

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

1730

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

1731

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

1732

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

1733

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

1734

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

1735

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

1736

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

1737

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

1738

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

yoshi-code-bot

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

[diff] [blame]

1739

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

1740

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

1741

"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.

1742

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

1743

},

yoshi-code-bot

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

[diff] [blame]

1744

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

1745

},

1746

"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 Pantheon frontend -- the proactive database wellness job

1747

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

1748

"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 Pantheon frontend -- the proactive database wellness job

1749

},

1750

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

1751

"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.

1752

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

1753

"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.

1754

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

1755

"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.

1756

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

1757

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

1758

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

1759

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

1760

"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.

1761

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

1762

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

1763

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

1764

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

1765

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

1766

"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.

1767

},

1768

},

1769

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

1770

"A String",

1771

],

1772

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

1773

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

1774

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

1775

"canDefer": True or False,

1776

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

1777

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

1778

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

1779

},

1780

"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.

1781

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

1782

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

1783

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

1784

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

1785

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

1786

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

1787

"expirationTime": "A String", # The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

1788

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

1789

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

1790

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

1791

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

1792

},

1793

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

1794

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

1795

"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.

1796

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

1797

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

1798

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

1799

},

1800

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

1801

"A String",

1802

],

1803

"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](https://cloud.google.com/sql/docs/mysql/high-availability).

1804

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

1805

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

1806

"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.

1807

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

1808

},

1809

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

1810

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

1811

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

1812

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

1813

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

1814

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

1815

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

1816

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

1817

},

1818

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

1819

"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.

1820

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

1821

"dataDiskType": "A String", # The type of data disk: **PD_SSD** (default) or **PD_HDD**.

1822

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

1823

{ # Database flags for Cloud SQL instances.

1824

"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](https://cloud.google.com/sql/docs/mysql/flags) in the Cloud SQL documentation.

1825

"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.

1826

},

1827

],

1828

"databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not.

1829

"denyMaintenancePeriods": [ # Deny maintenance periods

1830

{ # Deny maintenance Periods. This specifies a date range during when all CSA rollout will be denied.

1831

"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 no maintenance interval recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01

1832

"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 no maintenance interval recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01

1833

"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

1834

},

1835

],

1836

"insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres.

1837

"queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled.

1838

"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. Default is 5.

1839

"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.

1840

"recordApplicationTags": True or False, # Whether Query Insights will record application tags from query when enabled.

1841

"recordClientAddress": True or False, # Whether Query Insights will record client address when enabled.

1842

},

1843

"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 for Second Generation instances.

yoshi-code-bot

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

[diff] [blame]

1844

"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-code-bot

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

[diff] [blame]

1845

"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**).

1846

{ # An entry for an Access Control list.

1847

"expirationTime": "A String", # The time when this access control entry expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

1848

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

1849

"name": "A String", # Optional. A label to identify this entry.

1850

"value": "A String", # The allowlisted value for the access control list.

1851

},

1852

],

1853

"ipv4Enabled": True or False, # Whether the instance is assigned a public IP address or not.

1854

"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.

1855

"requireSsl": True or False, # Whether SSL connections over IP are enforced or not.

1856

},

1857

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

1858

"locationPreference": { # Preferred location. This specifies where a Cloud SQL instance is located. 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 Compute Engine zone for better performance.

1859

"followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance.

1860

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

1861

"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.

1862

"zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.).

1863

},

1864

"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.

1865

"day": 42, # day of week (1-7), starting on Monday.

1866

"hour": 42, # hour of day - 0 to 23.

1867

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

1868

"updateTrack": "A String", # Maintenance timing setting: **canary** (Earlier) or **stable** (Later). [Learn more] (https://cloud.google.com/sql/docs/mysql/instance-settings#maintenance-timing-2ndgen).

1869

},

1870

"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.

1871

"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.

1872

"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.

yoshi-code-bot

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

[diff] [blame^]

1873

"sqlServerAuditConfig": { # SQL Server specific audit configuration. # SQL Server specific audit configuration.

1874

"bucket": "A String", # The name of the destination bucket (e.g., gs://mybucket).

1875

"kind": "A String", # This is always sql#sqlServerAuditConfig

1876

},

yoshi-code-bot

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

[diff] [blame]

1877

"storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is true.

1878

"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.

1879

"tier": "A String", # The tier (or machine type) for this instance, for example **db-custom-1-3840**.

1880

"userLabels": { # User-provided labels, represented as a dictionary where each label is a single key value pair.

"a_key": "A String",

},

},

"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.

1885

"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension.

"A String",

],

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1897

1898

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

1899

"backupContext": { # Backup context. # The context for backup operation, if applicable.

1900

"backupId": "A String", # The identifier of the backup.

1901

"kind": "A String", # This is always **sql#backupContext**.

1902

},

1903

"endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

1904

"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.

1905

"errors": [ # The list of errors encountered while processing this operation.

1906

{ # Database instance operation error.

1907

"code": "A String", # Identifies the specific error that occurred.

1908

"kind": "A String", # This is always **sql#operationError**.

1909

"message": "A String", # Additional information about the error encountered.

1910

},

1911

],

1912

"kind": "A String", # This is always **sql#operationErrors**.

1913

},

1914

"exportContext": { # Database instance export context. # The context for export operation, if applicable.

1915

"csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only.

yoshi-code-bot

2021-09-07 00:20:27 -0700

[diff] [blame^]

1916

"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.

1917

"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.

1918

"linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.

1919

"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

1920

"selectQuery": "A String", # The select query used to extract the data.

1921

},

1922

"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**.

1923

"A String",

1924

],

1925

"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.

1926

"kind": "A String", # This is always **sql#exportContext**.

1927

"offload": True or False, # Option for export offload.

1928

"sqlExportOptions": { # Options for exporting data as SQL statements.

1929

"mysqlExportOptions": { # Options for exporting from MySQL.

1930

"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.

1931

},

1932

"schemaOnly": True or False, # Export only schemas.

1933

"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.

"A String",

],

},

"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.

1938

},

1939

"importContext": { # Database instance import context. # The context for import operation, if applicable.

1940

"bakImportOptions": { # Import parameters specific to SQL Server .BAK files

1941

"encryptionOptions": {

1942

"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.

1943

"pvkPassword": "A String", # Password that encrypts the private key

1944

"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.

1945

},

1946

},

1947

"csvImportOptions": { # Options for importing data as CSV.

1948

"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.

1949

"A String",

1950

],

yoshi-code-bot

2021-09-07 00:20:27 -0700

[diff] [blame^]

1951

"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.

1952

"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.

1953

"linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.

1954

"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

1955

"table": "A String", # The table to which CSV data is imported.

1956

},

1957

"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.

1958

"fileType": "A String", # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data.

1959

"importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.

1960

"kind": "A String", # This is always **sql#importContext**.

1961

"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.

1962

},

1963

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

1964

"kind": "A String", # This is always **sql#operation**.

1965

"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.

1966

"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**

1967

"selfLink": "A String", # The URI of this resource.

1968

"startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

1969

"status": "A String", # The status of an operation. Valid values are: **PENDING** **RUNNING** **DONE** **SQL_OPERATION_STATUS_UNSPECIFIED**

1970

"targetId": "A String", # Name of the database instance related to this operation.

1971

"targetLink": "A String",

1972

"targetProject": "A String", # The project ID of the target instance related to this operation.

1973

"user": "A String", # The email address of the user who initiated this operation.

}</pre>

</div>

<code class="details" id="promoteReplica">promoteReplica(project, instance, x__xgafv=None)</code>

1979

<pre>Promotes the read replica instance to be a stand-alone Cloud SQL instance. Using this operation might cause your instance to restart.

1980

1981

Args:

1982

project: string, ID of the project that contains the read replica. (required)

1983

instance: string, Cloud SQL read replica instance name. (required)

1984

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1991

1992

{ # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.

1993

"backupContext": { # Backup context. # The context for backup operation, if applicable.

1994

"backupId": "A String", # The identifier of the backup.

1995

"kind": "A String", # This is always **sql#backupContext**.

1996

},

1997

"endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

1998

"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.

1999

"errors": [ # The list of errors encountered while processing this operation.

2000

{ # Database instance operation error.

2001

"code": "A String", # Identifies the specific error that occurred.

2002

"kind": "A String", # This is always **sql#operationError**.

2003

"message": "A String", # Additional information about the error encountered.

2004

},

2005

],

2006

"kind": "A String", # This is always **sql#operationErrors**.

2007

},

2008

"exportContext": { # Database instance export context. # The context for export operation, if applicable.

2009

"csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only.

yoshi-code-bot

2021-09-07 00:20:27 -0700

[diff] [blame^]

2010

"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.

2011

"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.

2012

"linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.

2013

"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

2014

"selectQuery": "A String", # The select query used to extract the data.

2015

},

2016

"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**.

2017

"A String",

2018

],

2019

"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.

2020

"kind": "A String", # This is always **sql#exportContext**.

2021

"offload": True or False, # Option for export offload.

2022

"sqlExportOptions": { # Options for exporting data as SQL statements.

2023

"mysqlExportOptions": { # Options for exporting from MySQL.

2024

"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.

2025

},

2026

"schemaOnly": True or False, # Export only schemas.

2027

"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.

"A String",

],

},

"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.

2032

},

2033

"importContext": { # Database instance import context. # The context for import operation, if applicable.

2034

"bakImportOptions": { # Import parameters specific to SQL Server .BAK files

2035

"encryptionOptions": {

2036

"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.

2037

"pvkPassword": "A String", # Password that encrypts the private key

2038

"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.

2039

},

2040

},

2041

"csvImportOptions": { # Options for importing data as CSV.

2042

"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.

2043

"A String",

2044

],

yoshi-code-bot

2021-09-07 00:20:27 -0700

[diff] [blame^]

2045

"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.

2046

"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.

2047

"linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.

2048

"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

2049

"table": "A String", # The table to which CSV data is imported.

2050

},

2051

"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.

2052

"fileType": "A String", # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data.

2053

"importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.

2054

"kind": "A String", # This is always **sql#importContext**.

2055

"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.

2056

},

2057

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

2058

"kind": "A String", # This is always **sql#operation**.

2059

"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.

2060

"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**

2061

"selfLink": "A String", # The URI of this resource.

2062

"startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

2063

"status": "A String", # The status of an operation. Valid values are: **PENDING** **RUNNING** **DONE** **SQL_OPERATION_STATUS_UNSPECIFIED**

2064

"targetId": "A String", # Name of the database instance related to this operation.

2065

"targetLink": "A String",

2066

"targetProject": "A String", # The project ID of the target instance related to this operation.

2067

"user": "A String", # The email address of the user who initiated this operation.

}</pre>

</div>

<code class="details" id="resetSslConfig">resetSslConfig(project, instance, x__xgafv=None)</code>

2073

<pre>Deletes all client certificates and generates a new server SSL certificate for the instance.

2074

2075

Args:

2076

project: string, Project ID of the project that contains the instance. (required)

2077

instance: string, Cloud SQL instance ID. This does not include the project ID. (required)

2078

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2085

2086

{ # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.

2087

"backupContext": { # Backup context. # The context for backup operation, if applicable.

2088

"backupId": "A String", # The identifier of the backup.

2089

"kind": "A String", # This is always **sql#backupContext**.

2090

},

2091

"endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

2092

"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.

2093

"errors": [ # The list of errors encountered while processing this operation.

2094

{ # Database instance operation error.

2095

"code": "A String", # Identifies the specific error that occurred.

2096

"kind": "A String", # This is always **sql#operationError**.

2097

"message": "A String", # Additional information about the error encountered.

2098

},

2099

],

2100

"kind": "A String", # This is always **sql#operationErrors**.

2101

},

2102

"exportContext": { # Database instance export context. # The context for export operation, if applicable.

2103

"csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only.

yoshi-code-bot

2021-09-07 00:20:27 -0700

[diff] [blame^]

2104

"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.

2105

"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.

2106

"linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.

2107

"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

2108

"selectQuery": "A String", # The select query used to extract the data.

2109

},

2110

"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**.

2111

"A String",

2112

],

2113

"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.

2114

"kind": "A String", # This is always **sql#exportContext**.

2115

"offload": True or False, # Option for export offload.

2116

"sqlExportOptions": { # Options for exporting data as SQL statements.

2117

"mysqlExportOptions": { # Options for exporting from MySQL.

2118

"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.

2119

},

2120

"schemaOnly": True or False, # Export only schemas.

2121

"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.

"A String",

],

},

"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.

2126

},

2127

"importContext": { # Database instance import context. # The context for import operation, if applicable.

2128

"bakImportOptions": { # Import parameters specific to SQL Server .BAK files

2129

"encryptionOptions": {

2130

"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.

2131

"pvkPassword": "A String", # Password that encrypts the private key

2132

"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.

2133

},

2134

},

2135

"csvImportOptions": { # Options for importing data as CSV.

2136

"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.

2137

"A String",

2138

],

yoshi-code-bot

2021-09-07 00:20:27 -0700

[diff] [blame^]

2139

"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.

2140

"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.

2141

"linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.

2142

"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

2143

"table": "A String", # The table to which CSV data is imported.

2144

},

2145

"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.

2146

"fileType": "A String", # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data.

2147

"importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.

2148

"kind": "A String", # This is always **sql#importContext**.

2149

"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.

2150

},

2151

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

2152

"kind": "A String", # This is always **sql#operation**.

2153

"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.

2154

"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**

2155

"selfLink": "A String", # The URI of this resource.

2156

"startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

2157

"status": "A String", # The status of an operation. Valid values are: **PENDING** **RUNNING** **DONE** **SQL_OPERATION_STATUS_UNSPECIFIED**

2158

"targetId": "A String", # Name of the database instance related to this operation.

2159

"targetLink": "A String",

2160

"targetProject": "A String", # The project ID of the target instance related to this operation.

2161

"user": "A String", # The email address of the user who initiated this operation.

}</pre>

</div>

<code class="details" id="restart">restart(project, instance, x__xgafv=None)</code>

2167

<pre>Restarts a Cloud SQL instance.

2168

2169

Args:

2170

project: string, Project ID of the project that contains the instance to be restarted. (required)

2171

instance: string, Cloud SQL instance ID. This does not include the project ID. (required)

2172

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2179

2180

{ # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.

2181

"backupContext": { # Backup context. # The context for backup operation, if applicable.

2182

"backupId": "A String", # The identifier of the backup.

2183

"kind": "A String", # This is always **sql#backupContext**.

2184

},

2185

"endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

2186

"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.

2187

"errors": [ # The list of errors encountered while processing this operation.

2188

{ # Database instance operation error.

2189

"code": "A String", # Identifies the specific error that occurred.

2190

"kind": "A String", # This is always **sql#operationError**.

2191

"message": "A String", # Additional information about the error encountered.

2192

},

2193

],

2194

"kind": "A String", # This is always **sql#operationErrors**.

2195

},

2196

"exportContext": { # Database instance export context. # The context for export operation, if applicable.

2197

"csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only.

yoshi-code-bot

2021-09-07 00:20:27 -0700

[diff] [blame^]

2198

"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.

2199

"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.

2200

"linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.

2201

"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

2202

"selectQuery": "A String", # The select query used to extract the data.

2203

},

2204

"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**.

2205

"A String",

2206

],

2207

"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.

2208

"kind": "A String", # This is always **sql#exportContext**.

2209

"offload": True or False, # Option for export offload.

2210

"sqlExportOptions": { # Options for exporting data as SQL statements.

2211

"mysqlExportOptions": { # Options for exporting from MySQL.

2212

"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.

2213

},

2214

"schemaOnly": True or False, # Export only schemas.

2215

"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.

"A String",

],

},

"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.

2220

},

2221

"importContext": { # Database instance import context. # The context for import operation, if applicable.

2222

"bakImportOptions": { # Import parameters specific to SQL Server .BAK files

2223

"encryptionOptions": {

2224

"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.

2225

"pvkPassword": "A String", # Password that encrypts the private key

2226

"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.

2227

},

2228

},

2229

"csvImportOptions": { # Options for importing data as CSV.

2230

"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.

2231

"A String",

2232

],

yoshi-code-bot

2021-09-07 00:20:27 -0700

[diff] [blame^]

2233

"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.

2234

"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.

2235

"linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.

2236

"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

2237

"table": "A String", # The table to which CSV data is imported.

2238

},

2239

"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.

2240

"fileType": "A String", # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data.

2241

"importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.

2242

"kind": "A String", # This is always **sql#importContext**.

2243

"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.

2244

},

2245

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

2246

"kind": "A String", # This is always **sql#operation**.

2247

"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.

2248

"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**

2249

"selfLink": "A String", # The URI of this resource.

2250

"startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

2251

"status": "A String", # The status of an operation. Valid values are: **PENDING** **RUNNING** **DONE** **SQL_OPERATION_STATUS_UNSPECIFIED**

2252

"targetId": "A String", # Name of the database instance related to this operation.

2253

"targetLink": "A String",

2254

"targetProject": "A String", # The project ID of the target instance related to this operation.

2255

"user": "A String", # The email address of the user who initiated this operation.

}</pre>

</div>

<code class="details" id="restoreBackup">restoreBackup(project, instance, body=None, x__xgafv=None)</code>

2261

<pre>Restores a backup of a Cloud SQL instance. Using this operation might cause your instance to restart.

2262

2263

Args:

2264

project: string, Project ID of the project that contains the instance. (required)

2265

instance: string, Cloud SQL instance ID. This does not include the project ID. (required)

2266

body: object, The request body.

2267

The object takes the form of:

2268

2269

{ # Database instance restore backup request.

2270

"restoreBackupContext": { # Database instance restore from backup context. Backup context contains source instance id and project id. # Parameters required to perform the restore backup operation.

2271

"backupRunId": "A String", # The ID of the backup run to restore from.

2272

"instanceId": "A String", # The ID of the instance that the backup was taken from.

2273

"kind": "A String", # This is always *sql#restoreBackupContext*.

2274

"project": "A String", # The full project ID of the source instance.

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2285

2286

{ # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.

2287

"backupContext": { # Backup context. # The context for backup operation, if applicable.

2288

"backupId": "A String", # The identifier of the backup.

2289

"kind": "A String", # This is always **sql#backupContext**.

2290

},

2291

"endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

2292

"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.

2293

"errors": [ # The list of errors encountered while processing this operation.

2294

{ # Database instance operation error.

2295

"code": "A String", # Identifies the specific error that occurred.

2296

"kind": "A String", # This is always **sql#operationError**.

2297

"message": "A String", # Additional information about the error encountered.

2298

},

2299

],

2300

"kind": "A String", # This is always **sql#operationErrors**.

2301

},

2302

"exportContext": { # Database instance export context. # The context for export operation, if applicable.

2303

"csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only.

yoshi-code-bot

2021-09-07 00:20:27 -0700

[diff] [blame^]

2304

"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.

2305

"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.

2306

"linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.

2307

"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

2308

"selectQuery": "A String", # The select query used to extract the data.

2309

},

2310

"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**.

2311

"A String",

2312

],

2313

"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.

2314

"kind": "A String", # This is always **sql#exportContext**.

2315

"offload": True or False, # Option for export offload.

2316

"sqlExportOptions": { # Options for exporting data as SQL statements.

2317

"mysqlExportOptions": { # Options for exporting from MySQL.

2318

"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.

2319

},

2320

"schemaOnly": True or False, # Export only schemas.

2321

"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.

"A String",

],

},

"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.

2326

},

2327

"importContext": { # Database instance import context. # The context for import operation, if applicable.

2328

"bakImportOptions": { # Import parameters specific to SQL Server .BAK files

2329

"encryptionOptions": {

2330

"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.

2331

"pvkPassword": "A String", # Password that encrypts the private key

2332

"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.

2333

},

2334

},

2335

"csvImportOptions": { # Options for importing data as CSV.

2336

"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.

2337

"A String",

2338

],

yoshi-code-bot

2021-09-07 00:20:27 -0700

[diff] [blame^]

2339

"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.

2340

"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.

2341

"linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.

2342

"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

2343

"table": "A String", # The table to which CSV data is imported.

2344

},

2345

"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.

2346

"fileType": "A String", # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data.

2347

"importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.

2348

"kind": "A String", # This is always **sql#importContext**.

2349

"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.

2350

},

2351

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

2352

"kind": "A String", # This is always **sql#operation**.

2353

"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.

2354

"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**

2355

"selfLink": "A String", # The URI of this resource.

2356

"startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

2357

"status": "A String", # The status of an operation. Valid values are: **PENDING** **RUNNING** **DONE** **SQL_OPERATION_STATUS_UNSPECIFIED**

2358

"targetId": "A String", # Name of the database instance related to this operation.

2359

"targetLink": "A String",

2360

"targetProject": "A String", # The project ID of the target instance related to this operation.

2361

"user": "A String", # The email address of the user who initiated this operation.

}</pre>

</div>

<code class="details" id="rotateServerCa">rotateServerCa(project, instance, body=None, x__xgafv=None)</code>

2367

<pre>Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method.

2368

2369

Args:

2370

project: string, Project ID of the project that contains the instance. (required)

2371

instance: string, Cloud SQL instance ID. This does not include the project ID. (required)

2372

body: object, The request body.

2373

The object takes the form of:

2374

2375

{ # Rotate server CA request.

2376

"rotateServerCaContext": { # Instance rotate server CA context. # Contains details about the rotate server CA operation.

2377

"kind": "A String", # This is always *sql#rotateServerCaContext*.

2378

"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.

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2389

2390

{ # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.

2391

"backupContext": { # Backup context. # The context for backup operation, if applicable.

2392

"backupId": "A String", # The identifier of the backup.

2393

"kind": "A String", # This is always **sql#backupContext**.

2394

},

2395

"endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

2396

"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.

2397

"errors": [ # The list of errors encountered while processing this operation.

2398

{ # Database instance operation error.

2399

"code": "A String", # Identifies the specific error that occurred.

2400

"kind": "A String", # This is always **sql#operationError**.

2401

"message": "A String", # Additional information about the error encountered.

2402

},

2403

],

2404

"kind": "A String", # This is always **sql#operationErrors**.

2405

},

2406

"exportContext": { # Database instance export context. # The context for export operation, if applicable.

2407

"csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only.

yoshi-code-bot

2021-09-07 00:20:27 -0700

[diff] [blame^]

2408

"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.

2409

"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.

2410

"linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.

2411

"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

2412

"selectQuery": "A String", # The select query used to extract the data.

2413

},

2414

"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**.

2415

"A String",

2416

],

2417

"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.

2418

"kind": "A String", # This is always **sql#exportContext**.

2419

"offload": True or False, # Option for export offload.

2420

"sqlExportOptions": { # Options for exporting data as SQL statements.

2421

"mysqlExportOptions": { # Options for exporting from MySQL.

2422

"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.

2423

},

2424

"schemaOnly": True or False, # Export only schemas.

2425

"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.

"A String",

],

},

"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.

2430

},

2431

"importContext": { # Database instance import context. # The context for import operation, if applicable.

2432

"bakImportOptions": { # Import parameters specific to SQL Server .BAK files

2433

"encryptionOptions": {

2434

"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.

2435

"pvkPassword": "A String", # Password that encrypts the private key

2436

"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.

2437

},

2438

},

2439

"csvImportOptions": { # Options for importing data as CSV.

2440

"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.

2441

"A String",

2442

],

yoshi-code-bot

2021-09-07 00:20:27 -0700

[diff] [blame^]

2443

"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.

2444

"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.

2445

"linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.

2446

"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

2447

"table": "A String", # The table to which CSV data is imported.

2448

},

2449

"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.

2450

"fileType": "A String", # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data.

2451

"importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.

2452

"kind": "A String", # This is always **sql#importContext**.

2453

"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.

2454

},

2455

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

2456

"kind": "A String", # This is always **sql#operation**.

2457

"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.

2458

"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**

2459

"selfLink": "A String", # The URI of this resource.

2460

"startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

2461

"status": "A String", # The status of an operation. Valid values are: **PENDING** **RUNNING** **DONE** **SQL_OPERATION_STATUS_UNSPECIFIED**

2462

"targetId": "A String", # Name of the database instance related to this operation.

2463

"targetLink": "A String",

2464

"targetProject": "A String", # The project ID of the target instance related to this operation.

2465

"user": "A String", # The email address of the user who initiated this operation.

}</pre>

</div>

<code class="details" id="startReplica">startReplica(project, instance, x__xgafv=None)</code>

2471

<pre>Starts the replication in the read replica instance.

2472

2473

Args:

2474

project: string, ID of the project that contains the read replica. (required)

2475

instance: string, Cloud SQL read replica instance name. (required)

2476

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2483

2484

{ # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.

2485

"backupContext": { # Backup context. # The context for backup operation, if applicable.

2486

"backupId": "A String", # The identifier of the backup.

2487

"kind": "A String", # This is always **sql#backupContext**.

2488

},

2489

"endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

2490

"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.

2491

"errors": [ # The list of errors encountered while processing this operation.

2492

{ # Database instance operation error.

2493

"code": "A String", # Identifies the specific error that occurred.

2494

"kind": "A String", # This is always **sql#operationError**.

2495

"message": "A String", # Additional information about the error encountered.

2496

},

2497

],

2498

"kind": "A String", # This is always **sql#operationErrors**.

2499

},

2500

"exportContext": { # Database instance export context. # The context for export operation, if applicable.

2501

"csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only.

yoshi-code-bot

2021-09-07 00:20:27 -0700

[diff] [blame^]

2502

"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.

2503

"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.

2504

"linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.

2505

"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

2506

"selectQuery": "A String", # The select query used to extract the data.

2507

},

2508

"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**.

2509

"A String",

2510

],

2511

"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.

2512

"kind": "A String", # This is always **sql#exportContext**.

2513

"offload": True or False, # Option for export offload.

2514

"sqlExportOptions": { # Options for exporting data as SQL statements.

2515

"mysqlExportOptions": { # Options for exporting from MySQL.

2516

"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.

2517

},

2518

"schemaOnly": True or False, # Export only schemas.

2519

"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.

"A String",

],

},

"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.

2524

},

2525

"importContext": { # Database instance import context. # The context for import operation, if applicable.

2526

"bakImportOptions": { # Import parameters specific to SQL Server .BAK files

2527

"encryptionOptions": {

2528

"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.

2529

"pvkPassword": "A String", # Password that encrypts the private key

2530

"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.

2531

},

2532

},

2533

"csvImportOptions": { # Options for importing data as CSV.

2534

"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.

2535

"A String",

2536

],

yoshi-code-bot

2021-09-07 00:20:27 -0700

[diff] [blame^]

2537

"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.

2538

"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.

2539

"linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.

2540

"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

2541

"table": "A String", # The table to which CSV data is imported.

2542

},

2543

"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.

2544

"fileType": "A String", # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data.

2545

"importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.

2546

"kind": "A String", # This is always **sql#importContext**.

2547

"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.

2548

},

2549

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

2550

"kind": "A String", # This is always **sql#operation**.

2551

"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.

2552

"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**

2553

"selfLink": "A String", # The URI of this resource.

2554

"startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

2555

"status": "A String", # The status of an operation. Valid values are: **PENDING** **RUNNING** **DONE** **SQL_OPERATION_STATUS_UNSPECIFIED**

2556

"targetId": "A String", # Name of the database instance related to this operation.

2557

"targetLink": "A String",

2558

"targetProject": "A String", # The project ID of the target instance related to this operation.

2559

"user": "A String", # The email address of the user who initiated this operation.

}</pre>

</div>

<code class="details" id="stopReplica">stopReplica(project, instance, x__xgafv=None)</code>

2565

<pre>Stops the replication in the read replica instance.

2566

2567

Args:

2568

project: string, ID of the project that contains the read replica. (required)

2569

instance: string, Cloud SQL read replica instance name. (required)

2570

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2577

2578

{ # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.

2579

"backupContext": { # Backup context. # The context for backup operation, if applicable.

2580

"backupId": "A String", # The identifier of the backup.

2581

"kind": "A String", # This is always **sql#backupContext**.

2582

},

2583

"endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

2584

"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.

2585

"errors": [ # The list of errors encountered while processing this operation.

2586

{ # Database instance operation error.

2587

"code": "A String", # Identifies the specific error that occurred.

2588

"kind": "A String", # This is always **sql#operationError**.

2589

"message": "A String", # Additional information about the error encountered.

2590

},

2591

],

2592

"kind": "A String", # This is always **sql#operationErrors**.

2593

},

2594

"exportContext": { # Database instance export context. # The context for export operation, if applicable.

2595

"csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only.

yoshi-code-bot

2021-09-07 00:20:27 -0700

[diff] [blame^]

2596

"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.

2597

"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.

2598

"linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.

2599

"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

2600

"selectQuery": "A String", # The select query used to extract the data.

2601

},

2602

"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**.

2603

"A String",

2604

],

2605

"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.

2606

"kind": "A String", # This is always **sql#exportContext**.

2607

"offload": True or False, # Option for export offload.

2608

"sqlExportOptions": { # Options for exporting data as SQL statements.

2609

"mysqlExportOptions": { # Options for exporting from MySQL.

2610

"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.

2611

},

2612

"schemaOnly": True or False, # Export only schemas.

2613

"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.

"A String",

],

},

"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.

2618

},

2619

"importContext": { # Database instance import context. # The context for import operation, if applicable.

2620

"bakImportOptions": { # Import parameters specific to SQL Server .BAK files

2621

"encryptionOptions": {

2622

"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.

2623

"pvkPassword": "A String", # Password that encrypts the private key

2624

"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.

2625

},

2626

},

2627

"csvImportOptions": { # Options for importing data as CSV.

2628

"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.

2629

"A String",

2630

],

yoshi-code-bot

2021-09-07 00:20:27 -0700

[diff] [blame^]

2631

"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.

2632

"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.

2633

"linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.

2634

"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

2635

"table": "A String", # The table to which CSV data is imported.

2636

},

2637

"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.

2638

"fileType": "A String", # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data.

2639

"importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.

2640

"kind": "A String", # This is always **sql#importContext**.

2641

"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.

2642

},

2643

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

2644

"kind": "A String", # This is always **sql#operation**.

2645

"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.

2646

"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**

2647

"selfLink": "A String", # The URI of this resource.

2648

"startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

2649

"status": "A String", # The status of an operation. Valid values are: **PENDING** **RUNNING** **DONE** **SQL_OPERATION_STATUS_UNSPECIFIED**

2650

"targetId": "A String", # Name of the database instance related to this operation.

2651

"targetLink": "A String",

2652

"targetProject": "A String", # The project ID of the target instance related to this operation.

2653

"user": "A String", # The email address of the user who initiated this operation.

}</pre>

</div>

<code class="details" id="truncateLog">truncateLog(project, instance, body=None, x__xgafv=None)</code>

2659

<pre>Truncate MySQL general and slow query log tables MySQL only.

2660

2661

Args:

2662

project: string, Project ID of the Cloud SQL project. (required)

2663

instance: string, Cloud SQL instance ID. This does not include the project ID. (required)

2664

body: object, The request body.

2665

The object takes the form of:

2666

2667

{ # Instance truncate log request.

2668

"truncateLogContext": { # Database Instance truncate log context. # Contains details about the truncate log operation.

2669

"kind": "A String", # This is always *sql#truncateLogContext*.

2670

"logType": "A String", # The type of log to truncate. Valid values are *MYSQL_GENERAL_TABLE* and *MYSQL_SLOW_TABLE*.

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2681

2682

{ # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.

2683

"backupContext": { # Backup context. # The context for backup operation, if applicable.

2684

"backupId": "A String", # The identifier of the backup.

2685

"kind": "A String", # This is always **sql#backupContext**.

2686

},

2687

"endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

2688

"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.

2689

"errors": [ # The list of errors encountered while processing this operation.

2690

{ # Database instance operation error.

2691

"code": "A String", # Identifies the specific error that occurred.

2692

"kind": "A String", # This is always **sql#operationError**.

2693

"message": "A String", # Additional information about the error encountered.

2694

},

2695

],

2696

"kind": "A String", # This is always **sql#operationErrors**.

2697

},

2698

"exportContext": { # Database instance export context. # The context for export operation, if applicable.

2699

"csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only.

yoshi-code-bot

2021-09-07 00:20:27 -0700

[diff] [blame^]

2700

"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.

2701

"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.

2702

"linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.

2703

"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

2704

"selectQuery": "A String", # The select query used to extract the data.

2705

},

2706

"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**.

2707

"A String",

2708

],

2709

"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.

2710

"kind": "A String", # This is always **sql#exportContext**.

2711

"offload": True or False, # Option for export offload.

2712

"sqlExportOptions": { # Options for exporting data as SQL statements.

2713

"mysqlExportOptions": { # Options for exporting from MySQL.

2714

"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.

2715

},

2716

"schemaOnly": True or False, # Export only schemas.

2717

"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.

"A String",

],

},

"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.

2722

},

2723

"importContext": { # Database instance import context. # The context for import operation, if applicable.

2724

"bakImportOptions": { # Import parameters specific to SQL Server .BAK files

2725

"encryptionOptions": {

2726

"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.

2727

"pvkPassword": "A String", # Password that encrypts the private key

2728

"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.

2729

},

2730

},

2731

"csvImportOptions": { # Options for importing data as CSV.

2732

"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.

2733

"A String",

2734

],

yoshi-code-bot

2021-09-07 00:20:27 -0700

[diff] [blame^]

2735

"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.

2736

"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.

2737

"linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.

2738

"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

2739

"table": "A String", # The table to which CSV data is imported.

2740

},

2741

"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.

2742

"fileType": "A String", # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data.

2743

"importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.

2744

"kind": "A String", # This is always **sql#importContext**.

2745

"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.

2746

},

2747

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

2748

"kind": "A String", # This is always **sql#operation**.

2749

"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.

2750

"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**

2751

"selfLink": "A String", # The URI of this resource.

2752

"startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

2753

"status": "A String", # The status of an operation. Valid values are: **PENDING** **RUNNING** **DONE** **SQL_OPERATION_STATUS_UNSPECIFIED**

2754

"targetId": "A String", # Name of the database instance related to this operation.

2755

"targetLink": "A String",

2756

"targetProject": "A String", # The project ID of the target instance related to this operation.

2757

"user": "A String", # The email address of the user who initiated this operation.

}</pre>

</div>

<code class="details" id="update">update(project, instance, body=None, x__xgafv=None)</code>

2763

<pre>Updates settings of a Cloud SQL instance. Using this operation might cause your instance to restart.

2764

2765

Args:

2766

project: string, Project ID of the project that contains the instance. (required)

2767

instance: string, Cloud SQL instance ID. This does not include the project ID. (required)

2768

body: object, The request body.

2769

The object takes the form of:

2770

2771

{ # A Cloud SQL instance resource.

2772

"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.

2773

"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]

2774

"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-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

2775

"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.

2776

"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*.

2777

"diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance.

2778

"kind": "A String", # This is always **sql#diskEncryptionConfiguration**.

2779

"kmsKeyName": "A String", # Resource name of KMS key for disk encryption

2780

},

2781

"diskEncryptionStatus": { # Disk encryption status for an instance. # Disk encryption status specific to an instance.

2782

"kind": "A String", # This is always **sql#diskEncryptionStatus**.

2783

"kmsKeyVersionName": "A String", # KMS key version used to encrypt the Cloud SQL instance resource

2784

},

2785

"etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the *settings.settingsVersion* field instead.

2786

"failoverReplica": { # The name and status of the failover replica.

2787

"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.

2788

"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.

2789

},

2790

"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.

2791

"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.

2792

"ipAddresses": [ # The assigned IP addresses for the instance.

2793

{ # Database instance IP Mapping.

2794

"ipAddress": "A String", # The IP address assigned.

2795

"timeToRetire": "A String", # The due time for this IP to be retired in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. This field is only available when the IP is scheduled to be retired.

2796

"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.

2797

},

2798

],

2799

"ipv6Address": "A String", # The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances.

2800

"kind": "A String", # This is always *sql#instance*.

2801

"masterInstanceName": "A String", # The name of the instance which will act as primary in the replication setup.

2802

"maxDiskSize": "A String", # The maximum disk size of the instance in bytes.

2803

"name": "A String", # Name of the Cloud SQL instance. This does not include the project ID.

2804

"onPremisesConfiguration": { # On-premises instance configuration. # Configuration specific to on-premises instances.

2805

"caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.

2806

"clientCertificate": "A String", # PEM representation of the replica's x509 certificate.

2807

"clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.

2808

"dumpFilePath": "A String", # The dump file to create the Cloud SQL replica.

2809

"hostPort": "A String", # The host and port of the on-premises instance in host:port format

2810

"kind": "A String", # This is always *sql#onPremisesConfiguration*.

2811

"password": "A String", # The password for connecting to on-premises instance.

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

2812

"sourceInstance": { # Reference to another Cloud SQL instance. # The reference to Cloud SQL instance if the source is Cloud SQL.

2813

"name": "A String", # The name of the Cloud SQL instance being referenced. This does not include the project ID.

2814

"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.

2815

"region": "A String", # The region of the Cloud SQL instance being referenced.

2816

},

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

2817

"username": "A String", # The username for connecting to on-premises instance.

2818

},

2819

"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 Pantheon frontend -- the proactive database wellness job

2820

"sqlMinRecommendedIncreaseSizeGb": 42, # The minimum recommended increase size in GigaBytes This field is consumed by the frontend Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend

2821

"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 Pantheon frontend -- the proactive database wellness job

2822

},

2823

"project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.

2824

"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.

2825

"replicaConfiguration": { # Read-replica configuration for connecting to the primary instance. # Configuration specific to failover replicas and read replicas.

2826

"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.

2827

"kind": "A String", # This is always *sql#replicaConfiguration*.

2828

"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.

2829

"caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.

2830

"clientCertificate": "A String", # PEM representation of the replica's x509 certificate.

2831

"clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.

2832

"connectRetryInterval": 42, # Seconds to wait between connect retries. MySQL's default is 60 seconds.

2833

"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.

2834

"kind": "A String", # This is always **sql#mysqlReplicaConfiguration**.

2835

"masterHeartbeatPeriod": "A String", # Interval in milliseconds between replication heartbeats.

2836

"password": "A String", # The password for the replication connection.

2837

"sslCipher": "A String", # A list of permissible ciphers to use for SSL encryption.

2838

"username": "A String", # The username for the replication connection.

2839

"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.

2840

},

2841

},

2842

"replicaNames": [ # The replicas of the instance.

2843

"A String",

2844

],

2845

"rootPassword": "A String", # Initial root password. Use only on creation.

2846

"satisfiesPzs": True or False, # The status indicating if instance satisfiesPzs. Reserved for future use.

2847

"scheduledMaintenance": { # Any scheduled maintenancce for this instance. # The start time of any upcoming scheduled maintenance for this instance.

2848

"canDefer": True or False,

2849

"canReschedule": True or False, # If the scheduled maintenance can be rescheduled.

2850

"scheduleDeadlineTime": "A String", # Maintenance cannot be rescheduled to start beyond this deadline.

2851

"startTime": "A String", # The start time of any upcoming scheduled maintenance for this instance.

2852

},

2853

"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.

2854

"selfLink": "A String", # The URI of this resource.

2855

"serverCaCert": { # SslCerts Resource # SSL configuration.

2856

"cert": "A String", # PEM representation.

2857

"certSerialNumber": "A String", # Serial number, as extracted from the certificate.

2858

"commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.

2859

"createTime": "A String", # The time when the certificate was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**

2860

"expirationTime": "A String", # The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

2861

"instance": "A String", # Name of the database instance.

2862

"kind": "A String", # This is always sql#sslCert.

2863

"selfLink": "A String", # The URI of this resource.

2864

"sha1Fingerprint": "A String", # Sha1 Fingerprint.

2865

},

2866

"serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance. This property is read-only.

2867

"settings": { # Database instance settings. # The user settings.

2868

"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.

2869

"activeDirectoryConfig": { # Active Directory configuration, relevant only for Cloud SQL for SQL Server. # Active Directory configuration, relevant only for Cloud SQL for SQL Server.

2870

"domain": "A String", # The name of the domain (e.g., mydomain.com).

2871

"kind": "A String", # This is always sql#activeDirectoryConfig.

2872

},

2873

"authorizedGaeApplications": [ # The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only.

2874

"A String",

2875

],

2876

"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](https://cloud.google.com/sql/docs/mysql/high-availability).

2877

"backupConfiguration": { # Database instance backup configuration. # The daily backup configuration for the instance.

2878

"backupRetentionSettings": { # We currently only support backup retention by specifying the number of backups we will retain. # Backup retention settings.

2879

"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.

2880

"retentionUnit": "A String", # The unit that 'retained_backups' represents.

2881

},

2882

"binaryLogEnabled": True or False, # (MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well.

2883

"enabled": True or False, # Whether this configuration is enabled.

2884

"kind": "A String", # This is always **sql#backupConfiguration**.

2885

"location": "A String", # Location of the backup

2886

"pointInTimeRecoveryEnabled": True or False, # (Postgres only) Whether point in time recovery is enabled.

2887

"replicationLogArchivingEnabled": True or False, # Reserved for future use.

2888

"startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - **HH:MM**.

2889

"transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7.

2890

},

2891

"collation": "A String", # The name of server Instance collation.

2892

"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.

2893

"dataDiskSizeGb": "A String", # The size of data disk, in GB. The data disk size minimum is 10GB.

2894

"dataDiskType": "A String", # The type of data disk: **PD_SSD** (default) or **PD_HDD**.

2895

"databaseFlags": [ # The database flags passed to the instance at startup.

2896

{ # Database flags for Cloud SQL instances.

2897

"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](https://cloud.google.com/sql/docs/mysql/flags) in the Cloud SQL documentation.

2898

"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.

2899

},

2900

],

2901

"databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not.

2902

"denyMaintenancePeriods": [ # Deny maintenance periods

2903

{ # Deny maintenance Periods. This specifies a date range during when all CSA rollout will be denied.

2904

"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 no maintenance interval recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01

2905

"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 no maintenance interval recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01

2906

"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

2907

},

2908

],

2909

"insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres.

2910

"queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled.

2911

"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. Default is 5.

2912

"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.

2913

"recordApplicationTags": True or False, # Whether Query Insights will record application tags from query when enabled.

2914

"recordClientAddress": True or False, # Whether Query Insights will record client address when enabled.

2915

},

2916

"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 for Second Generation instances.

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

2917

"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-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

2918

"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**).

2919

{ # An entry for an Access Control list.

2920

"expirationTime": "A String", # The time when this access control entry expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

2921

"kind": "A String", # This is always **sql#aclEntry**.

2922

"name": "A String", # Optional. A label to identify this entry.

2923

"value": "A String", # The allowlisted value for the access control list.

2924

},

2925

],

2926

"ipv4Enabled": True or False, # Whether the instance is assigned a public IP address or not.

2927

"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.

2928

"requireSsl": True or False, # Whether SSL connections over IP are enforced or not.

2929

},

2930

"kind": "A String", # This is always **sql#settings**.

2931

"locationPreference": { # Preferred location. This specifies where a Cloud SQL instance is located. 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 Compute Engine zone for better performance.

2932

"followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance.

2933

"kind": "A String", # This is always **sql#locationPreference**.

2934

"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.

2935

"zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.).

2936

},

2937

"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.

2938

"day": 42, # day of week (1-7), starting on Monday.

2939

"hour": 42, # hour of day - 0 to 23.

2940

"kind": "A String", # This is always **sql#maintenanceWindow**.

2941

"updateTrack": "A String", # Maintenance timing setting: **canary** (Earlier) or **stable** (Later). [Learn more] (https://cloud.google.com/sql/docs/mysql/instance-settings#maintenance-timing-2ndgen).

2942

},

2943

"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.

2944

"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.

2945

"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.

yoshi-code-bot

2021-09-07 00:20:27 -0700

[diff] [blame^]

2946

"sqlServerAuditConfig": { # SQL Server specific audit configuration. # SQL Server specific audit configuration.

2947

"bucket": "A String", # The name of the destination bucket (e.g., gs://mybucket).

2948

"kind": "A String", # This is always sql#sqlServerAuditConfig

2949

},

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

2950

"storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is true.

2951

"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.

2952

"tier": "A String", # The tier (or machine type) for this instance, for example **db-custom-1-3840**.

2953

"userLabels": { # User-provided labels, represented as a dictionary where each label is a single key value pair.

"a_key": "A String",

},

},

"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.

2958

"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension.

"A String",

],

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2970

2971

{ # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.

2972

"backupContext": { # Backup context. # The context for backup operation, if applicable.

2973

"backupId": "A String", # The identifier of the backup.

2974

"kind": "A String", # This is always **sql#backupContext**.

2975

},

2976

"endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

2977

"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.

2978

"errors": [ # The list of errors encountered while processing this operation.

2979

{ # Database instance operation error.

2980

"code": "A String", # Identifies the specific error that occurred.

2981

"kind": "A String", # This is always **sql#operationError**.

2982

"message": "A String", # Additional information about the error encountered.

2983

},

2984

],

2985

"kind": "A String", # This is always **sql#operationErrors**.

2986

},

2987

"exportContext": { # Database instance export context. # The context for export operation, if applicable.

2988

"csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only.

yoshi-code-bot

2021-09-07 00:20:27 -0700

[diff] [blame^]

2989

"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.

2990

"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.

2991

"linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.

2992

"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

2993

"selectQuery": "A String", # The select query used to extract the data.

2994

},

2995

"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**.

2996

"A String",

2997

],

2998

"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.

2999

"kind": "A String", # This is always **sql#exportContext**.

3000

"offload": True or False, # Option for export offload.

3001

"sqlExportOptions": { # Options for exporting data as SQL statements.

3002

"mysqlExportOptions": { # Options for exporting from MySQL.

3003

"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.

3004

},

3005

"schemaOnly": True or False, # Export only schemas.

3006

"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.

"A String",

],

},

"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.

3011

},

3012

"importContext": { # Database instance import context. # The context for import operation, if applicable.

3013

"bakImportOptions": { # Import parameters specific to SQL Server .BAK files

3014

"encryptionOptions": {

3015

"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.

3016

"pvkPassword": "A String", # Password that encrypts the private key

3017

"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.

3018

},

3019

},

3020

"csvImportOptions": { # Options for importing data as CSV.

3021

"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.

3022

"A String",

3023

],

yoshi-code-bot

2021-09-07 00:20:27 -0700

[diff] [blame^]

3024

"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.

3025

"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.

3026

"linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.

3027

"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.

yoshi-code-bot