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

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

[diff] [blame]

92

93

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

94

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

95

<h3>Method Details</h3>

96

Dmitry Frenkel

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

[diff] [blame]

97

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

98

<pre>Close httplib2 connections.</pre>

</div>

Dan O'Meara

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

[diff] [blame]

102

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

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

103

<pre>Deletes the backup taken by a backup run.

104

105

Args:

106

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

107

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

Dmitry Frenkel

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

[diff] [blame]

108

id: string, The ID of the Backup Run to delete. To find a Backup Run ID, use the list method. (required)

Dan O'Meara

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

[diff] [blame]

109

x__xgafv: string, V1 error format.

110

Allowed values

111

1 - v1 error format

112

2 - v2 error format

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

113

114

Returns:

115

An object of the form:

116

Dmitry Frenkel

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

[diff] [blame]

117

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

118

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

119

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

120

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

121

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

122

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

123

{ # Database instance operation error.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

124

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

Dmitry Frenkel

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

[diff] [blame]

125

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

126

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

Dan O'Meara

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

[diff] [blame]

127

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

128

],

Dmitry Frenkel

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

[diff] [blame]

129

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

130

},

Dmitry Frenkel

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

[diff] [blame]

131

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

132

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

133

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

134

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

135

"csvExportOptions": { # Options for exporting data as CSV.

136

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

137

},

Dmitry Frenkel

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

[diff] [blame]

138

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

139

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

140

"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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.

141

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

142

"A String",

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

143

],

Dmitry Frenkel

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

[diff] [blame]

144

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

145

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

Dmitry Frenkel

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

[diff] [blame]

146

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

147

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

148

"A String",

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

149

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

150

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

Dmitry Frenkel

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

[diff] [blame]

151

"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. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored.

Bu Sun Kim

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

[diff] [blame]

152

},

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

153

},

154

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

155

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

Dmitry Frenkel

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

[diff] [blame]

156

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

157

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

158

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

159

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

Dmitry Frenkel

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

[diff] [blame]

160

"targetLink": "A String",

161

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

162

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

163

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

164

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

165

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

166

"A String",

167

],

168

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

169

},

170

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

171

"encryptionOptions": {

172

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

173

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

174

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

175

},

176

},

177

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

178

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

179

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

180

},

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

185

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

Craig Citro

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

[diff] [blame]

186

<pre>Retrieves a resource containing information about a backup run.

187

188

Args:

189

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

190

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

191

id: string, The ID of this Backup Run. (required)

Dan O'Meara

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

[diff] [blame]

192

x__xgafv: string, V1 error format.

193

Allowed values

194

1 - v1 error format

195

2 - v2 error format

Craig Citro

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

[diff] [blame]

196

197

Returns:

198

An object of the form:

199

Bu Sun Kim

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

[diff] [blame]

200

{ # A BackupRun resource.

Dmitry Frenkel

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

[diff] [blame]

201

"diskEncryptionStatus": { # Disk encryption status for an instance. # Encryption status specific to a backup. Applies only to Second Generation instances.

202

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

203

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

204

},

Dmitry Frenkel

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

[diff] [blame]

205

"backupKind": "A String", # Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.

206

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

207

"diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Encryption configuration specific to a backup. Applies only to Second Generation instances.

208

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

209

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

210

},

211

"status": "A String", # The status of this run.

Dmitry Frenkel

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

[diff] [blame]

212

"windowStartTime": "A String", # The start time of the backup window during which this the backup was attempted in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

213

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

214

"id": "A String", # The identifier for this backup run. Unique only for a specific Cloud SQL instance.

215

"error": { # Database instance operation error. # Information about why the backup operation failed. This is only present if the run has the FAILED status.

216

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

217

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

218

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

219

},

220

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

221

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

222

"description": "A String", # The description of this run, only applicable to on-demand backups.

223

"type": "A String", # The type of this run; can be either "AUTOMATED" or "ON_DEMAND".

224

"location": "A String", # Location of the backups.

225

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

226

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

}</pre>

</div>

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

Dmitry Frenkel

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

[diff] [blame]

232

<pre>Creates a new backup run on demand. This method is applicable only to Second Generation instances.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

233

234

Args:

235

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

236

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

237

body: object, The request body.

238

The object takes the form of:

239

240

{ # A BackupRun resource.

Dmitry Frenkel

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

[diff] [blame]

241

"diskEncryptionStatus": { # Disk encryption status for an instance. # Encryption status specific to a backup. Applies only to Second Generation instances.

242

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

243

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

244

},

Dmitry Frenkel

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

[diff] [blame]

245

"backupKind": "A String", # Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.

246

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

247

"diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Encryption configuration specific to a backup. Applies only to Second Generation instances.

248

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

249

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

250

},

251

"status": "A String", # The status of this run.

Dmitry Frenkel

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

[diff] [blame]

252

"windowStartTime": "A String", # The start time of the backup window during which this the backup was attempted in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

253

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

254

"id": "A String", # The identifier for this backup run. Unique only for a specific Cloud SQL instance.

255

"error": { # Database instance operation error. # Information about why the backup operation failed. This is only present if the run has the FAILED status.

256

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

257

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

258

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

259

},

260

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

261

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

262

"description": "A String", # The description of this run, only applicable to on-demand backups.

263

"type": "A String", # The type of this run; can be either "AUTOMATED" or "ON_DEMAND".

264

"location": "A String", # Location of the backups.

265

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

266

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

267

}

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

268

Dan O'Meara

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

[diff] [blame]

269

x__xgafv: string, V1 error format.

270

Allowed values

271

1 - v1 error format

272

2 - v2 error format

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

273

274

Returns:

275

An object of the form:

276

Dmitry Frenkel

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

[diff] [blame]

277

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

278

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

279

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

280

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

281

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

282

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

283

{ # Database instance operation error.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

284

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

Dmitry Frenkel

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

[diff] [blame]

285

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

286

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

Dan O'Meara

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

[diff] [blame]

287

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

288

],

Dmitry Frenkel

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

[diff] [blame]

289

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

290

},

Dmitry Frenkel

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

[diff] [blame]

291

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

292

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

293

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

294

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

295

"csvExportOptions": { # Options for exporting data as CSV.

296

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

297

},

Dmitry Frenkel

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

[diff] [blame]

298

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

299

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

300

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

301

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

302

"A String",

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

303

],

Dmitry Frenkel

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

[diff] [blame]

304

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

305

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

Dmitry Frenkel

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

[diff] [blame]

306

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

307

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

308

"A String",

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

309

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

310

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

Dmitry Frenkel

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

[diff] [blame]

311

"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. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored.

Bu Sun Kim

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

[diff] [blame]

312

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

313

},

314

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

315

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

Dmitry Frenkel

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

[diff] [blame]

316

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

317

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

318

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

319

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

Dmitry Frenkel

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

[diff] [blame]

320

"targetLink": "A String",

321

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

322

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

323

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

324

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

325

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

326

"A String",

327

],

328

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

329

},

330

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

331

"encryptionOptions": {

332

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

333

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

334

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

335

},

336

},

337

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

338

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

339

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

340

},

Craig Citro

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

345

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

Dmitry Frenkel

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

[diff] [blame]

346

<pre>Lists all backup runs associated with a given instance and configuration in the reverse chronological order of the backup initiation time.

Craig Citro

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

[diff] [blame]

347

348

Args:

349

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

350

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

351

maxResults: integer, Maximum number of backup runs per response.

Dmitry Frenkel

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

[diff] [blame]

352

pageToken: string, A previously-returned page token representing part of the larger set of results to view.

Dan O'Meara

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

[diff] [blame]

353

x__xgafv: string, V1 error format.

354

Allowed values

355

1 - v1 error format

356

2 - v2 error format

Craig Citro

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

[diff] [blame]

357

358

Returns:

359

An object of the form:

360

361

{ # Backup run list results.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

362

"items": [ # A list of backup runs in reverse chronological order of the enqueued time.

Bu Sun Kim

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

[diff] [blame]

363

{ # A BackupRun resource.

Dmitry Frenkel

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

[diff] [blame]

364

"diskEncryptionStatus": { # Disk encryption status for an instance. # Encryption status specific to a backup. Applies only to Second Generation instances.

365

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

366

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

Craig Citro

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

[diff] [blame]

367

},

Dmitry Frenkel

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

[diff] [blame]

368

"backupKind": "A String", # Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.

369

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

370

"diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Encryption configuration specific to a backup. Applies only to Second Generation instances.

371

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

372

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

373

},

374

"status": "A String", # The status of this run.

Dmitry Frenkel

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

[diff] [blame]

375

"windowStartTime": "A String", # The start time of the backup window during which this the backup was attempted in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

376

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

377

"id": "A String", # The identifier for this backup run. Unique only for a specific Cloud SQL instance.

378

"error": { # Database instance operation error. # Information about why the backup operation failed. This is only present if the run has the FAILED status.

379

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

380

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

381

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

382

},

383

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

384

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

385

"description": "A String", # The description of this run, only applicable to on-demand backups.

386

"type": "A String", # The type of this run; can be either "AUTOMATED" or "ON_DEMAND".

387

"location": "A String", # Location of the backups.

388

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

389

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

390

},

Craig Citro

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

[diff] [blame]

391

],

Dmitry Frenkel

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

[diff] [blame]

392

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

393

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

Craig Citro