Blame - docs/dyn/sqladmin_v1.operations.html - platform/external/python/google-api-python-client

<p class="firstline">Lists all instance operations that have been performed on the given Cloud SQL instance in the reverse chronological order of the start time.</p>

86

87

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

88

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

89

<h3>Method Details</h3>

90

91

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

92

<pre>Close httplib2 connections.</pre>

</div>

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

97

<pre>Retrieves an instance operation that has been performed on an instance.

98

99

Args:

100

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

101

operation: string, Instance operation ID. (required)

102

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

109

110

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

111

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

112

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

113

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

114

},

115

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

116

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

117

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

118

{ # Database instance operation error.

119

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

120

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

121

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

122

},

123

],

124

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

125

},

126

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

127

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

128

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

129

},

130

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

131

"A String",

132

],

133

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

134

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

135

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

136

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

137

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

138

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

139

},

140

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

141

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

"A String",

],

},

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

146

},

147

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

148

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

149

"encryptionOptions": {

150

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

151

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

152

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

153

},

154

},

155

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

156

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

157

"A String",

158

],

159

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

160

},

161

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

162

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

163

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

164

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

165

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

166

},

167

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

168

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

169

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

170

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

171

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

172

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

173

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

174

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

175

"targetLink": "A String",

176

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

177

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

}</pre>

</div>

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

183

<pre>Lists all instance operations that have been performed on the given Cloud SQL instance in the reverse chronological order of the start time.

184

185

Args:

186

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

187

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

188

maxResults: integer, Maximum number of operations per response.

189

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

190

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

197

198

{ # Operations list response.

199

"items": [ # List of operation resources.

200

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

201

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

202

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

203

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

204

},

205

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

206

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

207

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

208

{ # Database instance operation error.

209

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

210

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

211

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

212

},

213

],

214

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

215

},

216

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

217

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

218

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

219

},

220

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

221

"A String",

222

],

223

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

224

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

225

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

226

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

227

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

228

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

229

},

230

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

231

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

"A String",

],

},

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

236

},

237

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

238

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

239

"encryptionOptions": {

240

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

241

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

242

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

243

},

244

},

245

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

246

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

247

"A String",

248

],

249

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

250

},

251

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

252

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

253

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

254

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

255

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

256

},

257

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

258

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

259

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

260

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

261

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

262

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

263

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

264

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

265

"targetLink": "A String",

266

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

267

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

268

},

269

],

270

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

271

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

}</pre>

</div>

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

277

<pre>Retrieves the next page of results.

278

279