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

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

[diff] [blame]

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

91

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

92

<pre>Close httplib2 connections.</pre>

</div>

Dan O'Meara

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

[diff] [blame]

96

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

Craig Citro

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

[diff] [blame]

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)

Dan O'Meara

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

[diff] [blame]

102

x__xgafv: string, V1 error format.

103

Allowed values

104

1 - v1 error format

105

2 - v2 error format

Craig Citro

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

[diff] [blame]

106

107

Returns:

108

An object of the form:

109

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

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

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

112

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

113

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

114

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

Bu Sun Kim

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

[diff] [blame]

115

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

116

{ # Database instance operation error.

Bu Sun Kim

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

[diff] [blame]

117

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

118

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

Bu Sun Kim

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

[diff] [blame]

119

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

Dan O'Meara

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

[diff] [blame]

120

},

Bu Sun Kim

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

[diff] [blame]

121

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

122

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

Bu Sun Kim

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

[diff] [blame]

123

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

124

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

125

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

126

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

Bu Sun Kim

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

[diff] [blame]

127

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

Bu Sun Kim

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

[diff] [blame]

128

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

129

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

130

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

131

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

132

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

133

"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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.

134

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

Bu Sun Kim

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

[diff] [blame]

135

"A String",

Craig Citro

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

[diff] [blame]

136

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

137

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

Bu Sun Kim

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

[diff] [blame]

138

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

139

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

140

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

Bu Sun Kim

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

[diff] [blame]

141

"A String",

Craig Citro

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

[diff] [blame]

142

],

Bu Sun Kim

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

[diff] [blame]

143

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

144

"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. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored.

Bu Sun Kim

715bd7f

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

[diff] [blame]

145

},

Craig Citro

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

[diff] [blame]

146

},

147

},

Bu Sun Kim

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

[diff] [blame]

148

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

149

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

150

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

151

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

Bu Sun Kim

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

[diff] [blame]

152

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

153

"targetLink": "A String",

154

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

155

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

156

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

157

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

158

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

159

"A String",

160

],

161

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

162

},

163

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

164

"encryptionOptions": {

165

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

166

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

167

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

168

},

169

},

170

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

171

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

172

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

173

},

Craig Citro

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

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

178

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

179

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

Craig Citro

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

[diff] [blame]

180

181

Args:

182

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

Bu Sun Kim

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

[diff] [blame]

183

maxResults: integer, Maximum number of operations per response.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

184

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

Bu Sun Kim

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

[diff] [blame]

185

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

Dan O'Meara

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

[diff] [blame]

186

x__xgafv: string, V1 error format.

187

Allowed values

188

1 - v1 error format

189

2 - v2 error format

Craig Citro

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

[diff] [blame]

190

191

Returns:

192

An object of the form:

193

194

{ # Database instance list operations response.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

195

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

196

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

Bu Sun Kim

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

[diff] [blame]

197

"items": [ # List of operation resources.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

198

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

199

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

200

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

201

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

202

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

Bu Sun Kim

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

[diff] [blame]

203

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

204

{ # Database instance operation error.

Bu Sun Kim

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

[diff] [blame]

205

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

206

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

Bu Sun Kim

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

[diff] [blame]

207

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

Dan O'Meara

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

[diff] [blame]

208

},

Bu Sun Kim

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

[diff] [blame]

209

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

210

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

Bu Sun Kim

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

[diff] [blame]

211

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

212

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

213

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

214

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

Bu Sun Kim

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

[diff] [blame]

215

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

Bu Sun Kim

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

[diff] [blame]

216

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

217

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

218

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

219

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

220

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

221

"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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.

222

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

Bu Sun Kim

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

[diff] [blame]

223

"A String",

Craig Citro

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

[diff] [blame]

224

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

225

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

Bu Sun Kim

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

[diff] [blame]

226

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

227

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

228

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

Bu Sun Kim

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

[diff] [blame]

229

"A String",

Craig Citro

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

[diff] [blame]

230

],

Bu Sun Kim

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

[diff] [blame]

231

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

232

"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. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored.

Bu Sun Kim

715bd7f

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

[diff] [blame]

233

},

Craig Citro

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

[diff] [blame]

234

},

235

},

Bu Sun Kim

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

[diff] [blame]

236

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

237

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

238

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

239

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

Bu Sun Kim

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

[diff] [blame]

240

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

241

"targetLink": "A String",

242

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

243

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

244

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

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

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

252

"encryptionOptions": {

253

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

254

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

255

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

256

},

257

},

258

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

259

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

260

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

261

},

Craig Citro