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

0669410

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

0669410

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

[diff] [blame]

113

114

Returns:

115

An object of the form:

116

yoshi-code-bot

2021-03-31 13:33:30 -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.

yoshi-code-bot

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

[diff] [blame]

118

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

119

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

120

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

121

},

Yoshi Automation Bot

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

[diff] [blame]

122

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

123

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

124

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

125

{ # Database instance operation error.

126

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

127

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

128

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

129

},

130

],

131

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

132

},

133

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

yoshi-code-bot

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

[diff] [blame]

134

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

Yoshi Automation Bot

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

[diff] [blame]

135

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

Yoshi Automation Bot

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

[diff] [blame]

136

},

yoshi-code-bot

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

[diff] [blame]

137

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

Yoshi Automation Bot

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

[diff] [blame]

138

"A String",

139

],

yoshi-code-bot

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

[diff] [blame]

140

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

Yoshi Automation Bot

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

[diff] [blame]

141

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

142

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

143

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

144

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

yoshi-code-bot

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

[diff] [blame]

145

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

Yoshi Automation Bot

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

[diff] [blame]

146

},

Yoshi Automation Bot

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

[diff] [blame]

147

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

148

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

Yoshi Automation Bot

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

[diff] [blame]

149

"A String",

150

],

151

},

yoshi-code-bot

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

[diff] [blame]

152

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

Yoshi Automation Bot

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

[diff] [blame]

153

},

154

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

155

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

156

"encryptionOptions": {

157

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

158

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

159

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

Yoshi Automation Bot

b6971b0

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

[diff] [blame]

160

},

Yoshi Automation Bot

0d561ef

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

[diff] [blame]

161

},

Yoshi Automation Bot

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

[diff] [blame]

162

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

163

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

164

"A String",

165

],

166

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

167

},

168

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

169

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

170

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

171

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

yoshi-code-bot

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

[diff] [blame]

172

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

Yoshi Automation Bot

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

[diff] [blame]

173

},

174

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

175

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

176

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

177

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

178

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

179

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

180

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

181

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

182

"targetLink": "A String",

183

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

184

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

185

}</pre>

Takashi Matsuo

0669410

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

189

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

Craig Citro

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

[diff] [blame]

190

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

191

192

Args:

193

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

194

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

195

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

Dan O'Meara

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

[diff] [blame]

196

x__xgafv: string, V1 error format.

197

Allowed values

198

1 - v1 error format

199

2 - v2 error format

Craig Citro

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

[diff] [blame]

200

201

Returns:

202

An object of the form:

203

Bu Sun Kim

715bd7f

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

[diff] [blame]

204

{ # A BackupRun resource.

Yoshi Automation Bot

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

[diff] [blame]

205

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

206

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

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

209

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

210

},

211

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

212

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

213

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

214

},

215

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

216

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

217

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

218

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

219

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

220

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

221

},

222

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

223

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

224

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

225

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

226

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

227

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

228

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

yoshi-code-bot

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

[diff] [blame]

229

"type": "A String", # The type of this run; can be either "AUTOMATED" or "ON_DEMAND". This field defaults to "ON_DEMAND" and is ignored, when specified for insert requests.

Yoshi Automation Bot

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

[diff] [blame]

230

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

231

}</pre>

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

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

236

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

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

237

238

Args:

239

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

240

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

241

body: object, The request body.

242

The object takes the form of:

243

244

{ # A BackupRun resource.

Yoshi Automation Bot

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

[diff] [blame]

245

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

Yoshi Automation Bot

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

[diff] [blame]

246

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

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

249

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

250

},

Yoshi Automation Bot

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

[diff] [blame]

251

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

Yoshi Automation Bot

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

[diff] [blame]

252

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

Yoshi Automation Bot

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

[diff] [blame]

253

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

Yoshi Automation Bot

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

[diff] [blame]

254

},

Yoshi Automation Bot

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

[diff] [blame]

255

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

256

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

Yoshi Automation Bot

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

[diff] [blame]

257

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

258

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

259

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

260

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

261

},

Yoshi Automation Bot

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

[diff] [blame]

262

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

263

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

264

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

265

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

Yoshi Automation Bot

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

[diff] [blame]

266

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

Yoshi Automation Bot

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

[diff] [blame]

267

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

268

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

yoshi-code-bot

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

[diff] [blame]

269

"type": "A String", # The type of this run; can be either "AUTOMATED" or "ON_DEMAND". This field defaults to "ON_DEMAND" and is ignored, when specified for insert requests.

Yoshi Automation Bot

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

[diff] [blame]

270

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

Yoshi Automation Bot

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

[diff] [blame]

271

}

Jon Wayne Parrott

7d5badb

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

[diff] [blame]

272

Dan O'Meara

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

[diff] [blame]

273

x__xgafv: string, V1 error format.

274

Allowed values

275

1 - v1 error format

276

2 - v2 error format

Jon Wayne Parrott

7d5badb

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

[diff] [blame]

277

278

Returns:

279

An object of the form:

280

yoshi-code-bot

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

[diff] [blame]

281

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

yoshi-code-bot

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

[diff] [blame]

282

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

283

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

284

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

285

},

Yoshi Automation Bot

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

[diff] [blame]

286

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

287

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

288

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

289

{ # Database instance operation error.

290

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

291

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

292

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

293

},

294

],

295

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

296

},

297

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

yoshi-code-bot

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

[diff] [blame]

298

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

Yoshi Automation Bot

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

[diff] [blame]

299

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

Yoshi Automation Bot

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

[diff] [blame]

300

},

yoshi-code-bot

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

[diff] [blame]

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. *SQL Server instances:* You must specify one database to be exported, and the *fileType* must be *BAK*.

Yoshi Automation Bot

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

[diff] [blame]

302

"A String",

303

],

yoshi-code-bot

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

[diff] [blame]

304

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

Yoshi Automation Bot

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

[diff] [blame]

305

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

306

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

307

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

308

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

yoshi-code-bot

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

[diff] [blame]

309

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

Yoshi Automation Bot

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

[diff] [blame]

310

},

Yoshi Automation Bot

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

[diff] [blame]

311

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

312

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

Yoshi Automation Bot

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

[diff] [blame]

313

"A String",

314

],

315

},

yoshi-code-bot

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

[diff] [blame]

316

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

Yoshi Automation Bot

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

[diff] [blame]

317

},

318

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

319

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

320

"encryptionOptions": {

321

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

322

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

323

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

Yoshi Automation Bot

b6971b0

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

[diff] [blame]

324

},

Yoshi Automation Bot

0d561ef

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

[diff] [blame]

325

},

Yoshi Automation Bot

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

[diff] [blame]

326

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

327

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

328

"A String",

329

],

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

yoshi-code-bot

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

[diff] [blame]

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.

Yoshi Automation Bot

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

[diff] [blame]

337

},

338

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 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 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.

349

}</pre>

Craig Citro

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

[diff] [blame]

</div>

Yoshi Automation Bot

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

[diff] [blame]

353

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

354

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

355

356

Args:

357

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

358

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

Yoshi Automation Bot

b6971b0

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

[diff] [blame]

359

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

Yoshi Automation Bot

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

[diff] [blame]

360

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]

361

x__xgafv: string, V1 error format.

362

Allowed values

363

1 - v1 error format

364

2 - v2 error format

Craig Citro

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

[diff] [blame]

365

366

Returns:

367

An object of the form:

368

369

{ # Backup run list results.

Yoshi Automation Bot

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

[diff] [blame]

370

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

371

{ # A BackupRun resource.

372

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

373

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

374

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

375

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

376

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

Yoshi Automation Bot

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

[diff] [blame]

377

},

Yoshi Automation Bot

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

[diff] [blame]

378

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

379

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

380

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

381

},

382

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

383

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

384

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

385

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

386

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

387

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

388

},

389

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

390

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

391

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

392

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

393

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

394

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

395

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

yoshi-code-bot

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

[diff] [blame]

396

"type": "A String", # The type of this run; can be either "AUTOMATED" or "ON_DEMAND". This field defaults to "ON_DEMAND" and is ignored, when specified for insert requests.

Yoshi Automation Bot

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

[diff] [blame]

397

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

398

},

399

],

400

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

401

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

402

}</pre>

Craig Citro