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

3e17f89

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

dd49464

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

Yoshi Automation Bot

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

[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. Next field: 18

Yoshi Automation Bot

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

[diff] [blame]

111

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

112

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

113

{ # Database instance operation error.

114

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

115

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

116

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

117

},

118

],

119

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

120

},

Yoshi Automation Bot

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

[diff] [blame]

121

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

Yoshi Automation Bot

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

[diff] [blame]

122

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

123

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

124

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

125

},

126

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

127

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

128

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

129

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

130

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

131

},

132

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

],

},

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

137

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

138

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

139

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

"A String",

],

},

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

144

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

145

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

146

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

147

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

148

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

149

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

150

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

151

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

152

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

153

},

154

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

155

"targetLink": "A String",

156

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

157

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

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame]

158

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

Yoshi Automation Bot

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

[diff] [blame]

159

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

Yoshi Automation Bot

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

[diff] [blame]

160

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

Yoshi Automation Bot

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

[diff] [blame]

161

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

162

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

163

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

164

"A String",

165

],

166

},

Yoshi Automation Bot

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

[diff] [blame]

167

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

168

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

169

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

170

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

171

"encryptionOptions": {

172

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

173

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

174

"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

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

[diff] [blame]

175

},

176

},

Yoshi Automation Bot

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

[diff] [blame]

177

},

Craig Citro

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

[diff] [blame]

}</pre>

</div>

Yoshi Automation Bot

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

[diff] [blame]

182

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

Dmitry Frenkel

3e17f89

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

[diff] [blame]

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.

Craig Citro

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

[diff] [blame]

184

185

Args:

186

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

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame]

187

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

Yoshi Automation Bot

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

[diff] [blame]

188

maxResults: integer, Maximum number of operations per response.

189

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

Dan O'Meara

dd49464

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

[diff] [blame]

190

x__xgafv: string, V1 error format.

191

Allowed values

192

1 - v1 error format

193

2 - v2 error format

Craig Citro

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

[diff] [blame]

194

195

Returns:

196

An object of the form:

197

198

{ # Database instance list operations response.

Dmitry Frenkel

3e17f89

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

[diff] [blame]

199

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

Yoshi Automation Bot

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

[diff] [blame]

200

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

Bu Sun Kim

6502091

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

[diff] [blame]

201

"items": [ # List of operation resources.

Yoshi Automation Bot

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

[diff] [blame]

202

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

Yoshi Automation Bot

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

[diff] [blame]

203

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

204

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

205

{ # Database instance operation error.

206

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

207

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

208

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

209

},

210

],

211

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

212

},

Yoshi Automation Bot

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

[diff] [blame]

213

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

Yoshi Automation Bot

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

[diff] [blame]

214

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

215

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

216

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

217

},

218

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

219

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

220

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

221

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

222

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

223

},

224

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

],

},

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

229

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

230

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

231

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

"A String",

],

},

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

236

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

237

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

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

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

240

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

241

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

242

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

243

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

244

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

245

},

246

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

247

"targetLink": "A String",

248

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

249

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

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame]

250

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

Yoshi Automation Bot

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

[diff] [blame]

251

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

Yoshi Automation Bot

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

[diff] [blame]

252

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

Yoshi Automation Bot

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

[diff] [blame]

253

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

254

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

255

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

256

"A String",

257

],

258

},

Yoshi Automation Bot

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

[diff] [blame]

259

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

260

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

261

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

262

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

263

"encryptionOptions": {

264

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

265

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

266

"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

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

[diff] [blame]

267

},

268

},

Yoshi Automation Bot