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

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

[diff] [blame]

<style>

body, h1, h2, h3, div, span, p, pre, a {

margin: 0;

padding: 0;

border: 0;

font-weight: inherit;

9

font-style: inherit;

10

font-size: 100%;

11

font-family: inherit;

12

vertical-align: baseline;

}

body {

font-size: 13px;

padding: 1em;

}

h1 {

font-size: 26px;

margin-bottom: 1em;

}

h2 {

font-size: 24px;

margin-bottom: 1em;

}

h3 {

font-size: 20px;

margin-bottom: 1em;

margin-top: 1em;

}

pre, code {

line-height: 1.5;

font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;

}

pre {

margin-top: 0.5em;

}

h1, h2, h3, p {

font-family: Arial, sans serif;

}

h1, h2, h3 {

border-bottom: solid #CCC 1px;

}

.toc_element {

margin-top: 0.5em;

}

.firstline {

margin-left: 2 em;

}

.method {

margin-top: 1em;

border: solid 1px #CCC;

padding: 1em;

background: #EEE;

}

.details {

font-weight: bold;

font-size: 14px;

}

</style>

Bu Sun Kim

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

[diff] [blame]

75

<h1><a href="sqladmin_v1beta4.html">Cloud SQL Admin API</a> . <a href="sqladmin_v1beta4.backupRuns.html">backupRuns</a></h1>

Craig Citro

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

[diff] [blame]

76

<h2>Instance Methods</h2>

77

Dan O'Meara

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

[diff] [blame]

78

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

Takashi Matsuo

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

[diff] [blame]

79

<p class="firstline">Deletes the backup taken by a backup run.</p>

80

Dan O'Meara

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

[diff] [blame]

81

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

Craig Citro

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

[diff] [blame]

82

<p class="firstline">Retrieves a resource containing information about a backup run.</p>

83

Dan O'Meara

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

[diff] [blame]

84

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

85

<p class="firstline">Creates a new backup run on demand. This method is applicable only to</p>

Jon Wayne Parrott

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

[diff] [blame]

86

Bu Sun Kim

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

[diff] [blame]

87

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

Dan O'Meara

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

[diff] [blame]

88

<p class="firstline">Lists all backup runs associated with a given instance and configuration in</p>

Craig Citro

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

[diff] [blame]

89

90

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

91

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

92

<h3>Method Details</h3>

93

Dan O'Meara

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

[diff] [blame]

94

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

Takashi Matsuo

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

[diff] [blame]

95

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

96

97

Args:

98

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

99

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

Dan O'Meara

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

[diff] [blame]

100

id: string, The ID of the Backup Run to delete. To find a Backup Run ID, use the <a

Bu Sun Kim

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

[diff] [blame]

101

href="/sql/docs/db_path/admin-api/rest/v1beta4/backupRuns/list">list</a>

Dan O'Meara

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

[diff] [blame]

102

method. (required)

103

x__xgafv: string, V1 error format.

104

Allowed values

105

1 - v1 error format

106

2 - v2 error format

Takashi Matsuo

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

[diff] [blame]

107

108

Returns:

109

An object of the form:

110

Dan O'Meara

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

[diff] [blame]

111

{ # An Operation resource.&nbsp;For successful operations that return an

112

# Operation resource, only the fields relevant to the operation are populated

113

# in the resource.

Bu Sun Kim

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

[diff] [blame]

114

"targetLink": "A String",

115

"operationType": "A String", # The type of the operation. Valid values are <code>CREATE</code>,

116

# <code>DELETE</code>, <code>UPDATE</code>, <code>RESTART</code>,

117

# <code>IMPORT</code>, <code>EXPORT</code>, <code>BACKUP_VOLUME</code>,

118

# <code>RESTORE_VOLUME</code>, <code>CREATE_USER</code>,

119

# <code>DELETE_USER</code>, <code>CREATE_DATABASE</code>,

120

# <code>DELETE_DATABASE</code> .

121

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

122

# populated.

123

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

124

{ # Database instance operation error.

125

"kind": "A String", # This is always <code>sql#operationError</code>.

126

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

127

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

Dan O'Meara

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

[diff] [blame]

128

},

Bu Sun Kim

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

[diff] [blame]

129

],

130

"kind": "A String", # This is always <code>sql#operationErrors</code>.

131

},

132

"kind": "A String", # This is always <code>sql#operation</code>.

133

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

Bu Sun Kim

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

[diff] [blame]

134

"database": "A String", # The target database for the import. If <code>fileType</code> is

Dan O'Meara

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

[diff] [blame]

135

# <code>SQL</code>, this field is required only if the import file does not

136

# specify a database, and is overridden by any database specification in the

137

# import file. If <code>fileType</code> is <code>CSV</code>, one database

138

# must be specified.

Bu Sun Kim

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

[diff] [blame]

139

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

140

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

141

"encryptionOptions": {

Bu Sun Kim

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

[diff] [blame]

142

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

Bu Sun Kim

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

[diff] [blame]

143

"certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form

144

# <code>gs://bucketName/fileName</code>. The instance must have

145

# write permissions to the bucket and read access to the file.

146

"pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the

147

# form <code>gs://bucketName/fileName</code>. The instance must have

148

# write permissions to the bucket and read access to the file.

Bu Sun Kim

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

[diff] [blame]

149

},

150

},

151

"uri": "A String", # Path to the import file in Cloud Storage, in the form

Dan O'Meara

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

[diff] [blame]

152

# <code>gs:

153

# //bucketName/fileName</code>. Compressed gzip files (.gz) are supported

154

# // when <code>fileType</code> is <code>SQL</code>. The instance must have

155

# // write permissions to the bucket and read access to the file.

Bu Sun Kim

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

[diff] [blame]

156

"fileType": "A String", # The file type for the specified uri. <br><code>SQL</code>: The file

157

# contains SQL statements. <br><code>CSV</code>: The file contains CSV data.

Bu Sun Kim

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

[diff] [blame]

158

"kind": "A String", # This is always <code>sql#importContext</code>.

159

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

160

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

161

"columns": [ # The columns to which CSV data is imported. If not specified, all columns

162

# of the database table are loaded with CSV data.

163

"A String",

164

],

165

},

Takashi Matsuo

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

[diff] [blame]

166

},

Bu Sun Kim

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

[diff] [blame]

167

"status": "A String", # The status of an operation. Valid values are <code>PENDING</code>,

168

# <code>RUNNING</code>, <code>DONE</code>,

169

# <code>SQL_OPERATION_STATUS_UNSPECIFIED</code>.

170

"name": "A String", # An identifier that uniquely identifies the operation. You can use this

Dan O'Meara

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

[diff] [blame]

171

# identifier to retrieve the Operations resource that has information about

172

# the operation.

Bu Sun Kim

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

[diff] [blame]

173

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

Bu Sun Kim

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

[diff] [blame]

174

"fileType": "A String", # The file type for the specified uri. <br><code>SQL</code>: The file

175

# contains SQL statements. <br><code>CSV</code>: The file contains CSV data.

176

"uri": "A String", # The path to the file in Google Cloud Storage where the export will be

177

# stored. The URI is in the form <code>gs:

178

# //bucketName/fileName</code>. If the file already exists, the requests

179

# // succeeds, but the operation fails. If <code>fileType</code> is

180

# // <code>SQL</code> and the filename ends with .gz, the contents are

181

# // compressed.

182

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

183

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

184

},

185

"kind": "A String", # This is always <code>sql#exportContext</code>.

Bu Sun Kim

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

[diff] [blame]

186

"databases": [ # Databases to be exported. <br /> <b>MySQL instances:</b> If

Dan O'Meara

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

[diff] [blame]

187

# <code>fileType</code> is <code>SQL</code> and no database is specified, all

188

# databases are exported, except for the <code>mysql</code> system database.

189

# If <code>fileType</code> is <code>CSV</code>, you can specify one database,

190

# either by using this property or by using the

191

# <code>csvExportOptions.selectQuery</code> property, which takes precedence

192

# over this property. <br /> <b>PostgreSQL instances:</b> You must specify

193

# one database to be exported. If <code>fileType</code> is <code>CSV</code>,

194

# this database must match the one specified in the

195

# <code>csvExportOptions.selectQuery</code> property.

Bu Sun Kim

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

[diff] [blame]

196

"A String",

Takashi Matsuo

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

[diff] [blame]

197

],

Bu Sun Kim

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

[diff] [blame]

198

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

199

"tables": [ # Tables to export, or that were exported, from the specified database. If

Dan O'Meara

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

[diff] [blame]

200

# you specify tables, specify one and only one database. For PostgreSQL

201

# instances, you can specify only one table.

Bu Sun Kim

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

[diff] [blame]

202

"A String",

Takashi Matsuo

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

[diff] [blame]

203

],

Bu Sun Kim

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

[diff] [blame]

204

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

205

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

206

"masterData": 42, # Option to include SQL statement required to set up replication.

Dan O'Meara

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

[diff] [blame]

207

# If set to <code>1</code>, the dump file includes

208

# a CHANGE MASTER TO statement with the binary log coordinates.

209

# If set to <code>2</code>, the CHANGE MASTER TO statement is written as

210

# a SQL comment, and has no effect.

211

# All other values are ignored.

Bu Sun Kim

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

[diff] [blame]

212

},

Takashi Matsuo

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

[diff] [blame]

213

},

214

},

Bu Sun Kim

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

[diff] [blame]

215

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

Bu Sun Kim

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

[diff] [blame]

216

"endTime": "A String", # The time this operation finished in UTC timezone in <a

217

# href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example

218

# <code>2012-11-15T16:19:00.094Z</code>.

219

"startTime": "A String", # The time this operation actually started in UTC timezone in <a

220

# href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example

221

# <code>2012-11-15T16:19:00.094Z</code>.

222

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in <a

223

# href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example

224

# <code>2012-11-15T16:19:00.094Z</code>.

225

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

226

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

227

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

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]

232

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

Craig Citro

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

[diff] [blame]

233

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

234

235

Args:

236

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

237

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

238

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

Dan O'Meara

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

[diff] [blame]

239

x__xgafv: string, V1 error format.

240

Allowed values

241

1 - v1 error format

242

2 - v2 error format

Craig Citro

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

[diff] [blame]

243

244

Returns:

245

An object of the form:

246

Bu Sun Kim

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

[diff] [blame]

247

{ # A BackupRun resource.

Bu Sun Kim

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

[diff] [blame]

248

"enqueuedTime": "A String", # The time the run was enqueued in UTC timezone in <a

249

# href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example

Dan O'Meara

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

[diff] [blame]

250

# <code>2012-11-15T16:19:00.094Z</code>.

Bu Sun Kim

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

[diff] [blame]

251

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

252

# instance.

253

"endTime": "A String", # The time the backup operation completed in UTC timezone in <a

254

# href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example

Dan O'Meara

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

[diff] [blame]

255

# <code>2012-11-15T16:19:00.094Z</code>.

Bu Sun Kim

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

[diff] [blame]

256

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

257

"startTime": "A String", # The time the backup operation actually started in UTC timezone in <a

258

# href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example

259

# <code>2012-11-15T16:19:00.094Z</code>.

260

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

261

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

Bu Sun Kim

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

[diff] [blame]

262

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

Bu Sun Kim

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

[diff] [blame]

263

"windowStartTime": "A String", # The start time of the backup window during which this the backup was

264

# attempted in <a href="https://tools.ietf.org/html/rfc3339">RFC 3339</a>

265

# format, for example <code>2012-11-15T16:19:00.094Z</code>.

Bu Sun Kim

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

[diff] [blame]

266

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

267

# Applies only to Second Generation instances.

268

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

269

"kind": "A String", # This is always <code>sql#diskEncryptionStatus</code>.

270

},

Bu Sun Kim

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

[diff] [blame]

271

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

272

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

273

# the run has the FAILED status.

274

"kind": "A String", # This is always <code>sql#operationError</code>.

275

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

276

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

277

},

278

"kind": "A String", # This is always <code>sql#backupRun</code>.

279

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

280

# Applies only to Second Generation instances.

281

"kind": "A String", # This is always <code>sql#diskEncryptionConfiguration</code>.

282

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

283

},

284

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

}</pre>

</div>

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

290

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

291

Second Generation instances.

292

293

Args:

294

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

295

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

296

body: object, The request body.

297

The object takes the form of:

298

299

{ # A BackupRun resource.

300

"enqueuedTime": "A String", # The time the run was enqueued in UTC timezone in <a

301

# href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example

302

# <code>2012-11-15T16:19:00.094Z</code>.

303

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

304

# instance.

305

"endTime": "A String", # The time the backup operation completed in UTC timezone in <a

306

# href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example

307

# <code>2012-11-15T16:19:00.094Z</code>.

308

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

309

"startTime": "A String", # The time the backup operation actually started in UTC timezone in <a

310

# href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example

311

# <code>2012-11-15T16:19:00.094Z</code>.

312

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

313

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

314

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

315

"windowStartTime": "A String", # The start time of the backup window during which this the backup was

316

# attempted in <a href="https://tools.ietf.org/html/rfc3339">RFC 3339</a>

317

# format, for example <code>2012-11-15T16:19:00.094Z</code>.

318

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

319

# Applies only to Second Generation instances.

320

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

321

"kind": "A String", # This is always <code>sql#diskEncryptionStatus</code>.

322

},

323

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

324

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

325

# the run has the FAILED status.

326

"kind": "A String", # This is always <code>sql#operationError</code>.

327

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

328

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

329

},

330

"kind": "A String", # This is always <code>sql#backupRun</code>.

331

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

332

# Applies only to Second Generation instances.

333

"kind": "A String", # This is always <code>sql#diskEncryptionConfiguration</code>.

334

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

335

},

336

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

337

}

Jon Wayne Parrott

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

[diff] [blame]

338

Dan O'Meara

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

[diff] [blame]

339

x__xgafv: string, V1 error format.

340

Allowed values

341

1 - v1 error format

342

2 - v2 error format

Jon Wayne Parrott

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

[diff] [blame]

343

344

Returns:

345

An object of the form:

346

Dan O'Meara

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

[diff] [blame]

347

{ # An Operation resource.&nbsp;For successful operations that return an

348

# Operation resource, only the fields relevant to the operation are populated

349

# in the resource.

Bu Sun Kim

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

[diff] [blame]

350

"targetLink": "A String",

351

"operationType": "A String", # The type of the operation. Valid values are <code>CREATE</code>,

352

# <code>DELETE</code>, <code>UPDATE</code>, <code>RESTART</code>,

353

# <code>IMPORT</code>, <code>EXPORT</code>, <code>BACKUP_VOLUME</code>,

354

# <code>RESTORE_VOLUME</code>, <code>CREATE_USER</code>,

355

# <code>DELETE_USER</code>, <code>CREATE_DATABASE</code>,

356

# <code>DELETE_DATABASE</code> .

357

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

358

# populated.

359

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

360

{ # Database instance operation error.

361

"kind": "A String", # This is always <code>sql#operationError</code>.

362

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

363

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

Dan O'Meara

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

[diff] [blame]

364

},

Bu Sun Kim

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

[diff] [blame]

365

],

366

"kind": "A String", # This is always <code>sql#operationErrors</code>.

367

},

368

"kind": "A String", # This is always <code>sql#operation</code>.

369

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

Bu Sun Kim

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

[diff] [blame]

370

"database": "A String", # The target database for the import. If <code>fileType</code> is

Dan O'Meara

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

[diff] [blame]

371

# <code>SQL</code>, this field is required only if the import file does not

372

# specify a database, and is overridden by any database specification in the

373

# import file. If <code>fileType</code> is <code>CSV</code>, one database

374

# must be specified.

Bu Sun Kim

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

[diff] [blame]

375

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

376

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

377

"encryptionOptions": {

Bu Sun Kim

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

[diff] [blame]

378

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

Bu Sun Kim

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

[diff] [blame]

379

"certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form

380

# <code>gs://bucketName/fileName</code>. The instance must have

381

# write permissions to the bucket and read access to the file.

382

"pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the

383

# form <code>gs://bucketName/fileName</code>. The instance must have

384

# write permissions to the bucket and read access to the file.

Bu Sun Kim

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

[diff] [blame]

385

},

386

},

387

"uri": "A String", # Path to the import file in Cloud Storage, in the form

Dan O'Meara

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

[diff] [blame]

388

# <code>gs:

389

# //bucketName/fileName</code>. Compressed gzip files (.gz) are supported

390

# // when <code>fileType</code> is <code>SQL</code>. The instance must have

391

# // write permissions to the bucket and read access to the file.

Bu Sun Kim

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

[diff] [blame]

392

"fileType": "A String", # The file type for the specified uri. <br><code>SQL</code>: The file

393

# contains SQL statements. <br><code>CSV</code>: The file contains CSV data.

Bu Sun Kim

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

[diff] [blame]

394

"kind": "A String", # This is always <code>sql#importContext</code>.

395

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

396

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

397

"columns": [ # The columns to which CSV data is imported. If not specified, all columns

398

# of the database table are loaded with CSV data.

399

"A String",

400

],

401

},

Jon Wayne Parrott

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

[diff] [blame]

402

},

Bu Sun Kim

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

[diff] [blame]

403

"status": "A String", # The status of an operation. Valid values are <code>PENDING</code>,

404

# <code>RUNNING</code>, <code>DONE</code>,

405

# <code>SQL_OPERATION_STATUS_UNSPECIFIED</code>.

406

"name": "A String", # An identifier that uniquely identifies the operation. You can use this

Dan O'Meara

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

[diff] [blame]

407

# identifier to retrieve the Operations resource that has information about

408

# the operation.

Bu Sun Kim

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

[diff] [blame]

409

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

Bu Sun Kim

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

[diff] [blame]

410

"fileType": "A String", # The file type for the specified uri. <br><code>SQL</code>: The file

411

# contains SQL statements. <br><code>CSV</code>: The file contains CSV data.

412

"uri": "A String", # The path to the file in Google Cloud Storage where the export will be

413

# stored. The URI is in the form <code>gs:

414

# //bucketName/fileName</code>. If the file already exists, the requests

415

# // succeeds, but the operation fails. If <code>fileType</code> is

416

# // <code>SQL</code> and the filename ends with .gz, the contents are

417

# // compressed.

418

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

419

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

420

},

421

"kind": "A String", # This is always <code>sql#exportContext</code>.

Bu Sun Kim

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

[diff] [blame]

422

"databases": [ # Databases to be exported. <br /> <b>MySQL instances:</b> If

Dan O'Meara

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

[diff] [blame]

423

# <code>fileType</code> is <code>SQL</code> and no database is specified, all

424

# databases are exported, except for the <code>mysql</code> system database.

425

# If <code>fileType</code> is <code>CSV</code>, you can specify one database,

426

# either by using this property or by using the

427

# <code>csvExportOptions.selectQuery</code> property, which takes precedence

428

# over this property. <br /> <b>PostgreSQL instances:</b> You must specify

429

# one database to be exported. If <code>fileType</code> is <code>CSV</code>,

430

# this database must match the one specified in the

431

# <code>csvExportOptions.selectQuery</code> property.

Bu Sun Kim

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

[diff] [blame]

432

"A String",

Jon Wayne Parrott

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

[diff] [blame]

433

],

Bu Sun Kim

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

[diff] [blame]

434

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

435

"tables": [ # Tables to export, or that were exported, from the specified database. If

Dan O'Meara

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

[diff] [blame]

436

# you specify tables, specify one and only one database. For PostgreSQL

437

# instances, you can specify only one table.

Bu Sun Kim

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

[diff] [blame]

438

"A String",

Jon Wayne Parrott

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

[diff] [blame]

439

],

Bu Sun Kim

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

[diff] [blame]

440

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

441

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

442

"masterData": 42, # Option to include SQL statement required to set up replication.

Dan O'Meara

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

[diff] [blame]

443

# If set to <code>1</code>, the dump file includes

444

# a CHANGE MASTER TO statement with the binary log coordinates.

445

# If set to <code>2</code>, the CHANGE MASTER TO statement is written as

446

# a SQL comment, and has no effect.

447

# All other values are ignored.

Bu Sun Kim

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

[diff] [blame]

448

},

Jon Wayne Parrott

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

[diff] [blame]

449

},

450

},

Bu Sun Kim

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

[diff] [blame]

451

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

Bu Sun Kim

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

[diff] [blame]

452

"endTime": "A String", # The time this operation finished in UTC timezone in <a

453

# href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example

454

# <code>2012-11-15T16:19:00.094Z</code>.

455

"startTime": "A String", # The time this operation actually started in UTC timezone in <a

456

# href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example

457

# <code>2012-11-15T16:19:00.094Z</code>.

458

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in <a

459

# href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example

460

# <code>2012-11-15T16:19:00.094Z</code>.

461

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

462

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

463

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

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]

468

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

Dan O'Meara

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

[diff] [blame]

469

<pre>Lists all backup runs associated with a given instance and configuration in

470

the reverse chronological order of the backup initiation time.

Craig Citro

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

[diff] [blame]

471

472

Args:

473

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

474

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]

475

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

Dan O'Meara

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

[diff] [blame]

476

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

477

results to view.

478

x__xgafv: string, V1 error format.

479

Allowed values

480

1 - v1 error format

481

2 - v2 error format

Craig Citro

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

[diff] [blame]

482

483

Returns:

484

An object of the form:

485

486

{ # Backup run list results.

Bu Sun Kim

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

[diff] [blame]

487

"nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide

488

# this value in a subsequent request to return the next page of results.

Bu Sun Kim

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

[diff] [blame]

489

"kind": "A String", # This is always <code>sql#backupRunsList</code>.

490

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

491

{ # A BackupRun resource.

Bu Sun Kim

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

[diff] [blame]

492

"enqueuedTime": "A String", # The time the run was enqueued in UTC timezone in <a

493

# href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example

494

# <code>2012-11-15T16:19:00.094Z</code>.

495

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

496

# instance.

497

"endTime": "A String", # The time the backup operation completed in UTC timezone in <a

498

# href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example

499

# <code>2012-11-15T16:19:00.094Z</code>.

500

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

501

"startTime": "A String", # The time the backup operation actually started in UTC timezone in <a

502

# href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example

503

# <code>2012-11-15T16:19:00.094Z</code>.

504

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

505

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

506

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

507

"windowStartTime": "A String", # The start time of the backup window during which this the backup was

508

# attempted in <a href="https://tools.ietf.org/html/rfc3339">RFC 3339</a>

509

# format, for example <code>2012-11-15T16:19:00.094Z</code>.

510

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

511

# Applies only to Second Generation instances.

512

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

513

"kind": "A String", # This is always <code>sql#diskEncryptionStatus</code>.

Craig Citro

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

[diff] [blame]

514

},

Bu Sun Kim

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

[diff] [blame]

515

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

516

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

517

# the run has the FAILED status.

518

"kind": "A String", # This is always <code>sql#operationError</code>.

519

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

520

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

521

},

522

"kind": "A String", # This is always <code>sql#backupRun</code>.

523

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

524

# Applies only to Second Generation instances.

525

"kind": "A String", # This is always <code>sql#diskEncryptionConfiguration</code>.

526

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

527

},

528

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

529

},

Craig Citro

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

[diff] [blame]

530

],

Craig Citro

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

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

536

<pre>Retrieves the next page of results.

537

538

Args:

539

previous_request: The request for the previous page. (required)

540

previous_response: The response from the request for the previous page. (required)

541

542

Returns:

Bu Sun Kim

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

[diff] [blame]

543

A request object that you can call 'execute()' on to request the next

Craig Citro