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

3e17f89

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)

yoshi-code-bot

2021-10-12 00:20:31 -0700

[diff] [blame]

108

id: string, The ID of the backup run to delete. To find a backup run ID, use the [list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1beta4/backupRuns/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

a8b35b9

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.

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

120

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

yoshi-code-bot

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

[diff] [blame]

121

},

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

122

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

Yoshi Automation Bot

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

[diff] [blame]

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.

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

127

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

Yoshi Automation Bot

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

[diff] [blame]

128

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

129

},

130

],

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

131

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

Yoshi Automation Bot

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

[diff] [blame]

132

},

133

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

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

134

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

yoshi-code-bot

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

[diff] [blame]

135

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

136

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

137

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

138

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

Yoshi Automation Bot

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

[diff] [blame]

139

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

Yoshi Automation Bot

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

[diff] [blame]

140

},

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

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

142

"A String",

143

],

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

144

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

2021-10-12 00:20:31 -0700

[diff] [blame]

145

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

Yoshi Automation Bot

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

[diff] [blame]

146

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

147

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

148

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

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

149

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

150

},

Yoshi Automation Bot

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

[diff] [blame]

151

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

152

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

153

"A String",

154

],

155

},

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

156

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

157

},

158

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

159

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

160

"encryptionOptions": {

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

161

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

Yoshi Automation Bot

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

[diff] [blame]

162

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

yoshi-code-bot

2021-10-12 00:20:31 -0700

[diff] [blame]

163

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

164

},

Yoshi Automation Bot

0d561ef

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

[diff] [blame]

165

},

Yoshi Automation Bot

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

[diff] [blame]

166

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

167

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

168

"A String",

169

],

yoshi-code-bot

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

[diff] [blame]

170

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

171

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

172

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

173

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

Yoshi Automation Bot

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

[diff] [blame]

174

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

175

},

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

176

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

177

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

178

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

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

179

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

180

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

181

},

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

182

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

183

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

Yoshi Automation Bot

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

[diff] [blame]

184

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

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

185

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

Yoshi Automation Bot

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

[diff] [blame]

186

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

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

187

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

188

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

Yoshi Automation Bot

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

[diff] [blame]

189

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

190

"targetLink": "A String",

191

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

192

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

193

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

197

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

Craig Citro

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

[diff] [blame]

198

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

199

200

Args:

201

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

202

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

yoshi-code-bot

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

[diff] [blame]

203

id: string, The ID of this backup run. (required)

Dan O'Meara

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

[diff] [blame]

204

x__xgafv: string, V1 error format.

205

Allowed values

206

1 - v1 error format

207

2 - v2 error format

Craig Citro

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

[diff] [blame]

208

209

Returns:

210

An object of the form:

211

Bu Sun Kim

715bd7f

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

[diff] [blame]

212

{ # A BackupRun resource.

Yoshi Automation Bot

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

[diff] [blame]

213

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

214

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

yoshi-code-bot

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

[diff] [blame]

215

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

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

216

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

Yoshi Automation Bot

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

[diff] [blame]

217

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

218

},

yoshi-code-bot

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

[diff] [blame]

219

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

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

220

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

Yoshi Automation Bot

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

[diff] [blame]

221

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

222

},

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

223

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

224

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

Yoshi Automation Bot

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

[diff] [blame]

225

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

226

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

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

227

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

Yoshi Automation Bot

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

[diff] [blame]

228

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

229

},

230

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

231

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

yoshi-code-bot

2021-10-12 00:20:31 -0700

[diff] [blame]

232

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

Yoshi Automation Bot

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

[diff] [blame]

233

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

234

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

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

235

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

Yoshi Automation Bot

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

[diff] [blame]

236

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

yoshi-code-bot

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

[diff] [blame]

237

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

2021-09-21 00:22:28 -0700

[diff] [blame]

238

"windowStartTime": "A String", # The start time of the backup window during which this the backup was attempted in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

Yoshi Automation Bot

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

[diff] [blame]

239

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

yoshi-code-bot

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

[diff] [blame]

244

<pre>Creates a new backup run on demand.

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

245

246

Args:

247

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

248

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

249

body: object, The request body.

250

The object takes the form of:

251

252

{ # A BackupRun resource.

Yoshi Automation Bot

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

[diff] [blame]

253

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

Yoshi Automation Bot

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

[diff] [blame]

254

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

yoshi-code-bot

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

[diff] [blame]

255

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

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

256

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

Yoshi Automation Bot

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

[diff] [blame]

257

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

258

},

yoshi-code-bot

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

[diff] [blame]

259

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

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

260

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

Yoshi Automation Bot

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

[diff] [blame]

261

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

262

},

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

263

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

264

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

Yoshi Automation Bot

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

[diff] [blame]

265

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

266

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

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

267

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

Yoshi Automation Bot

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

[diff] [blame]

268

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

269

},

Yoshi Automation Bot

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

[diff] [blame]

270

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

271

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

yoshi-code-bot

2021-10-12 00:20:31 -0700

[diff] [blame]

272

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

Yoshi Automation Bot

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

[diff] [blame]

273

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

Yoshi Automation Bot

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

[diff] [blame]

274

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

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

275

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

Yoshi Automation Bot

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

[diff] [blame]

276

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

yoshi-code-bot

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

[diff] [blame]

277

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

2021-09-21 00:22:28 -0700

[diff] [blame]

278

"windowStartTime": "A String", # The start time of the backup window during which this the backup was attempted in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

Yoshi Automation Bot

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

[diff] [blame]

279

}

Jon Wayne Parrott

7d5badb

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

[diff] [blame]

280

Dan O'Meara

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

[diff] [blame]

281

x__xgafv: string, V1 error format.

282

Allowed values

283

1 - v1 error format

284

2 - v2 error format

Jon Wayne Parrott

7d5badb

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

[diff] [blame]

285

286

Returns:

287

An object of the form:

288

yoshi-code-bot

a8b35b9

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

[diff] [blame]

289

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

290

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

291

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

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

292

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

yoshi-code-bot

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

[diff] [blame]

293

},

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

294

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

Yoshi Automation Bot

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

[diff] [blame]

295

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

296

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

297

{ # Database instance operation error.

298

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

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

299

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

Yoshi Automation Bot

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

[diff] [blame]

300

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

301

},

302

],

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

303

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

Yoshi Automation Bot

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

[diff] [blame]

304

},

305

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

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

306

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

yoshi-code-bot

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

[diff] [blame]

307

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

308

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

309

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

310

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

Yoshi Automation Bot

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

[diff] [blame]

311

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

Yoshi Automation Bot

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

[diff] [blame]

312

},

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

313

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

314

"A String",

315

],

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

316

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

2021-10-12 00:20:31 -0700

[diff] [blame]

317

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

Yoshi Automation Bot

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

[diff] [blame]

318

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

319

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

320

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

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

321

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

322

},

Yoshi Automation Bot

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

[diff] [blame]

323

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

324

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

325

"A String",

326

],

327

},

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

328

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

329

},

330

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

331

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

332

"encryptionOptions": {

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

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.

Yoshi Automation Bot

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

[diff] [blame]

334

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

yoshi-code-bot

2021-10-12 00:20:31 -0700

[diff] [blame]

335

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

336

},

Yoshi Automation Bot

0d561ef

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

[diff] [blame]

337

},

Yoshi Automation Bot

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

[diff] [blame]

338

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

339

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

340

"A String",

341

],

yoshi-code-bot

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

[diff] [blame]

342

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

343

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

344

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

345

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

Yoshi Automation Bot

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

[diff] [blame]

346

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

347

},

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

348

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

349

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

350

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

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

351

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

352

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

353

},

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

354

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

355

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

Yoshi Automation Bot

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

[diff] [blame]

356

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

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

357

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

Yoshi Automation Bot

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

[diff] [blame]

358

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

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

359

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

360

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

Yoshi Automation Bot

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

[diff] [blame]

361

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

362

"targetLink": "A String",

363

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

364

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

365

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

369

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

yoshi-code-bot

1a4514d

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

[diff] [blame]

370

<pre>Lists all backup runs associated with the project or 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]

371

372

Args:

373

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

yoshi-code-bot

1a4514d

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

[diff] [blame]

374

instance: string, Cloud SQL instance ID, or "-" for all instances. This does not include the project ID. (required)

Yoshi Automation Bot

b6971b0

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

[diff] [blame]

375

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

Yoshi Automation Bot

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

[diff] [blame]

376

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]

377

x__xgafv: string, V1 error format.

378

Allowed values

379

1 - v1 error format

380

2 - v2 error format

Craig Citro

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

[diff] [blame]

381

382

Returns:

383

An object of the form:

384

385

{ # Backup run list results.

Yoshi Automation Bot

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

[diff] [blame]

386

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

387

{ # A BackupRun resource.

388

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

389

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

yoshi-code-bot

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

[diff] [blame]

390

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

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

391

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

Yoshi Automation Bot

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

[diff] [blame]

392

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

Yoshi Automation Bot

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

[diff] [blame]

393

},

yoshi-code-bot

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

[diff] [blame]

394

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

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

395

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

Yoshi Automation Bot

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

[diff] [blame]

396

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

397

},

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

398

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

399

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

Yoshi Automation Bot

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

[diff] [blame]

400

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

401

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

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

402

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

Yoshi Automation Bot

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

[diff] [blame]

403

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

404

},

405

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

406

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

yoshi-code-bot

2021-10-12 00:20:31 -0700

[diff] [blame]

407

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

Yoshi Automation Bot

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

[diff] [blame]

408

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

409

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

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

410

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

Yoshi Automation Bot

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

[diff] [blame]

411

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

yoshi-code-bot

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

[diff] [blame]

412

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

2021-09-21 00:22:28 -0700

[diff] [blame]

413

"windowStartTime": "A String", # The start time of the backup window during which this the backup was attempted in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

Yoshi Automation Bot

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

[diff] [blame]

414

},

415

],

yoshi-code-bot

2021-10-12 00:20:31 -0700

[diff] [blame]

416

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

Yoshi Automation Bot

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

[diff] [blame]

417

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

418

}</pre>

Craig Citro