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

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

76

<h2>Instance Methods</h2>

77

78

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

79

<p class="firstline">Reschedules the maintenance on the given instance.</p>

80

81

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

82

<p class="firstline">Start External master migration.</p>

83

84

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

85

<p class="firstline">Verify External master external sync settings.</p>

86

<h3>Method Details</h3>

87

88

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

89

<pre>Reschedules the maintenance on the given instance.

90

91

Args:

92

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

93

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

94

body: object, The request body.

95

The object takes the form of:

96

97

{ # Reschedule options for maintenance windows.

98

"reschedule": { # Required. The type of the reschedule the user wants.

99

"rescheduleType": "A String", # Required. The type of the reschedule.

100

"scheduleTime": "A String", # Optional. Timestamp when the maintenance shall be rescheduled to if

101

# reschedule_type=SPECIFIC_TIME, in <a

102

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

103

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

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

114

115

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

116

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

117

# in the resource.

118

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

119

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

120

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

121

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

122

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

123

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

124

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

125

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

126

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

127

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

128

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

129

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

130

"targetLink": "A String",

131

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

132

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

133

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

134

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

135

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

136

# <code>DELETE_DATABASE</code> .

137

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

138

# populated.

139

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

140

{ # Database instance operation error.

141

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

142

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

143

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

144

},

145

],

146

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

147

},

148

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

149

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

150

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

151

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

152

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

153

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

154

# of the database table are loaded with CSV data.

"A String",

],

},

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

159

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

160

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

161

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

162

# must be specified.

163

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

164

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

165

"encryptionOptions": {

166

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

167

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

168

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

169

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

170

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

171

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

172

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

173

},

174

},

175

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

176

# <code>gs:

177

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

178

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

179

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

180

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

181

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

182

},

183

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

184

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

185

# <code>SQL_OPERATION_STATUS_UNSPECIFIED</code>.

186

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

187

# identifier to retrieve the Operations resource that has information about

188

# the operation.

189

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

190

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

191

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

192

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

193

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

194

# either by using this property or by using the

195

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

196

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

197

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

198

# this database must match the one specified in the

199

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

200

"A String",

201

],

202

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

203

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

204

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

205

# instances, you can specify only one table.

206

"A String",

207

],

208

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

209

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

210

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

211

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

212

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

213

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

214

# a SQL comment, and has no effect.

215

# All other values are ignored.

216

},

217

},

218

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

219

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

220

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

221

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

222

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

223

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

224

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

225

# // compressed.

226

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

227

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

228

},

229

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

230

},

231

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

}</pre>

</div>

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

237

<pre>Start External master migration.

238

239

Args:

240

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

241

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

242

syncMode: string, External sync mode

243

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

250

251

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

252

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

253

# in the resource.

254

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

255

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

256

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

257

"startTime": "A String", # The time this 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

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

261

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

262

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

263

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

264

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

265

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

266

"targetLink": "A String",

267

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

268

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

269

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

270

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

271

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

272

# <code>DELETE_DATABASE</code> .

273

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

274

# populated.

275

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

276

{ # Database instance operation error.

277

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

278

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

279

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

280

},

281

],

282

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

283

},

284

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

285

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

286

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

287

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

288

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

289

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

290

# of the database table are loaded with CSV data.

"A String",

],

},

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

295

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

296

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

297

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

298

# must be specified.

299

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

300

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

301

"encryptionOptions": {

302

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

303

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

304

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

305

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

306

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

307

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

308

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

309

},

310

},

311

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

312

# <code>gs:

313

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

314

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

315

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

316

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

317

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

318

},

319

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

320

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

321

# <code>SQL_OPERATION_STATUS_UNSPECIFIED</code>.

322

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

323

# identifier to retrieve the Operations resource that has information about

324

# the operation.

325

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

326

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

327

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

328

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

329

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

330

# either by using this property or by using the

331

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

332

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

333

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

334

# this database must match the one specified in the

335

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

336

"A String",

337

],

338

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

339

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

340

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

341

# instances, you can specify only one table.

342

"A String",

343

],

344

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

345

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

346

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

347

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

348

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

349

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

350

# a SQL comment, and has no effect.

351

# All other values are ignored.

352

},

353

},

354

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

355

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

356

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

357

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

358

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

359

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

360

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

361

# // compressed.

362

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

363

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

364

},

365

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

366

},

367

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

}</pre>

</div>

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

373

<pre>Verify External master external sync settings.

374

375

Args:

376

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

377

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

378

syncMode: string, External sync mode

379