Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b8458c0b73030155b64a3c2392b2f70e5fbc3baf / . / docs / dyn / sql_v1beta4.sslCerts.html
blob: d3b61ff71eeb861c067f67c1a352b7a1ba8c2a17 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="sql_v1beta4.html">Cloud SQL Admin API</a> . <a href="sql_v1beta4.sslCerts.html">sslCerts</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#createEphemeral">createEphemeral(project, instance, body=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Generates a short-lived X509 certificate containing the provided public key</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(project, instance, sha1Fingerprint, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes the SSL certificate. For First Generation instances, the</p>
83<p class="toc_element">
84 <code><a href="#get">get(project, instance, sha1Fingerprint, x__xgafv=None)</a></code></p>
85<p class="firstline">Retrieves a particular SSL certificate. Does not include the private key</p>
86<p class="toc_element">
87 <code><a href="#insert">insert(project, instance, body=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Creates an SSL certificate and returns it along with the private key and</p>
89<p class="toc_element">
90 <code><a href="#list">list(project, instance, x__xgafv=None)</a></code></p>
91<p class="firstline">Lists all of the current SSL certificates for the instance.</p>
92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="createEphemeral">createEphemeral(project, instance, body=None, x__xgafv=None)</code>
95 <pre>Generates a short-lived X509 certificate containing the provided public key
96and signed by a private key specific to the target instance. Users may use
97the certificate to authenticate as themselves when connecting to the
98database.
99
100Args:
101 project: string, Project ID of the Cloud SQL project. (required)
102 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
103 body: object, The request body.
104 The object takes the form of:
105
106{ # SslCerts create ephemeral certificate request.
107 &quot;public_key&quot;: &quot;A String&quot;, # PEM encoded public key to include in the signed certificate.
108 }
109
110 x__xgafv: string, V1 error format.
111 Allowed values
112 1 - v1 error format
113 2 - v2 error format
114
115Returns:
116 An object of the form:
117
118 { # SslCerts Resource
119 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
120 &quot;expirationTime&quot;: &quot;A String&quot;, # The time when the certificate expires in &lt;a
121 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
122 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
123 &quot;sha1Fingerprint&quot;: &quot;A String&quot;, # Sha1 Fingerprint.
124 &quot;certSerialNumber&quot;: &quot;A String&quot;, # Serial number, as extracted from the certificate.
125 &quot;cert&quot;: &quot;A String&quot;, # PEM representation.
126 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#sslCert&lt;/code&gt;.
127 &quot;commonName&quot;: &quot;A String&quot;, # User supplied name. Constrained to [a-zA-Z.-_ ]+.
128 &quot;createTime&quot;: &quot;A String&quot;, # The time when the certificate was created in &lt;a
129 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
130 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;
131 &quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
132 }</pre>
133</div>
134
135<div class="method">
136 <code class="details" id="delete">delete(project, instance, sha1Fingerprint, x__xgafv=None)</code>
137 <pre>Deletes the SSL certificate. For First Generation instances, the
138certificate remains valid until the instance is restarted.
139
140Args:
141 project: string, Project ID of the project that contains the instance. (required)
142 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
143 sha1Fingerprint: string, Sha1 FingerPrint. (required)
144 x__xgafv: string, V1 error format.
145 Allowed values
146 1 - v1 error format
147 2 - v2 error format
148
149Returns:
150 An object of the form:
151
152 { # An Operation resource.&amp;nbsp;For successful operations that return an
153 # Operation resource, only the fields relevant to the operation are populated
154 # in the resource.
155 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
156 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
157 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
158 &quot;targetLink&quot;: &quot;A String&quot;,
159 &quot;operationType&quot;: &quot;A String&quot;, # The type of the operation. Valid values are &lt;code&gt;CREATE&lt;/code&gt;,
160 # &lt;code&gt;DELETE&lt;/code&gt;, &lt;code&gt;UPDATE&lt;/code&gt;, &lt;code&gt;RESTART&lt;/code&gt;,
161 # &lt;code&gt;IMPORT&lt;/code&gt;, &lt;code&gt;EXPORT&lt;/code&gt;, &lt;code&gt;BACKUP_VOLUME&lt;/code&gt;,
162 # &lt;code&gt;RESTORE_VOLUME&lt;/code&gt;, &lt;code&gt;CREATE_USER&lt;/code&gt;,
163 # &lt;code&gt;DELETE_USER&lt;/code&gt;, &lt;code&gt;CREATE_DATABASE&lt;/code&gt;,
164 # &lt;code&gt;DELETE_DATABASE&lt;/code&gt; .
165 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be
166 # populated.
167 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
168 { # Database instance operation error.
169 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
170 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
171 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operationError&lt;/code&gt;.
172 },
173 ],
174 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operationErrors&lt;/code&gt;.
175 },
176 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operation&lt;/code&gt;.
177 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
178 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
179 &quot;columns&quot;: [ # The columns to which CSV data is imported. If not specified, all columns
180 # of the database table are loaded with CSV data.
181 &quot;A String&quot;,
182 ],
183 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
184 },
185 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#importContext&lt;/code&gt;.
186 &quot;database&quot;: &quot;A String&quot;, # The target database for the import. If &lt;code&gt;fileType&lt;/code&gt; is
187 # &lt;code&gt;SQL&lt;/code&gt;, this field is required only if the import file does not
188 # specify a database, and is overridden by any database specification in the
189 # import file. If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;, one database
190 # must be specified.
191 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
192 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
193 &quot;encryptionOptions&quot;: {
194 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
195 &quot;certPath&quot;: &quot;A String&quot;, # Path to the Certificate (.cer) in Cloud Storage, in the form
196 # &lt;code&gt;gs://bucketName/fileName&lt;/code&gt;. The instance must have
197 # write permissions to the bucket and read access to the file.
198 &quot;pvkPath&quot;: &quot;A String&quot;, # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the
199 # form &lt;code&gt;gs://bucketName/fileName&lt;/code&gt;. The instance must have
200 # write permissions to the bucket and read access to the file.
201 },
202 },
203 &quot;uri&quot;: &quot;A String&quot;, # Path to the import file in Cloud Storage, in the form
204 # &lt;code&gt;gs:
205 # //bucketName/fileName&lt;/code&gt;. Compressed gzip files (.gz) are supported
206 # // when &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;SQL&lt;/code&gt;. The instance must have
207 # // write permissions to the bucket and read access to the file.
208 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. &lt;br&gt;&lt;code&gt;SQL&lt;/code&gt;: The file
209 # contains SQL statements. &lt;br&gt;&lt;code&gt;CSV&lt;/code&gt;: The file contains CSV data.
210 },
211 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are &lt;code&gt;PENDING&lt;/code&gt;,
212 # &lt;code&gt;RUNNING&lt;/code&gt;, &lt;code&gt;DONE&lt;/code&gt;,
213 # &lt;code&gt;SQL_OPERATION_STATUS_UNSPECIFIED&lt;/code&gt;.
214 &quot;name&quot;: &quot;A String&quot;, # An identifier that uniquely identifies the operation. You can use this
215 # identifier to retrieve the Operations resource that has information about
216 # the operation.
217 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
218 &quot;databases&quot;: [ # Databases to be exported. &lt;br /&gt; &lt;b&gt;MySQL instances:&lt;/b&gt; If
219 # &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;SQL&lt;/code&gt; and no database is specified, all
220 # databases are exported, except for the &lt;code&gt;mysql&lt;/code&gt; system database.
221 # If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;, you can specify one database,
222 # either by using this property or by using the
223 # &lt;code&gt;csvExportOptions.selectQuery&lt;/code&gt; property, which takes precedence
224 # over this property. &lt;br /&gt; &lt;b&gt;PostgreSQL instances:&lt;/b&gt; You must specify
225 # one database to be exported. If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;,
226 # this database must match the one specified in the
227 # &lt;code&gt;csvExportOptions.selectQuery&lt;/code&gt; property.
228 &quot;A String&quot;,
229 ],
230 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
231 &quot;tables&quot;: [ # Tables to export, or that were exported, from the specified database. If
232 # you specify tables, specify one and only one database. For PostgreSQL
233 # instances, you can specify only one table.
234 &quot;A String&quot;,
235 ],
236 &quot;schemaOnly&quot;: True or False, # Export only schemas.
237 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
238 &quot;masterData&quot;: 42, # Option to include SQL statement required to set up replication.
239 # If set to &lt;code&gt;1&lt;/code&gt;, the dump file includes
240 # a CHANGE MASTER TO statement with the binary log coordinates.
241 # If set to &lt;code&gt;2&lt;/code&gt;, the CHANGE MASTER TO statement is written as
242 # a SQL comment, and has no effect.
243 # All other values are ignored.
244 },
245 },
246 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. &lt;br&gt;&lt;code&gt;SQL&lt;/code&gt;: The file
247 # contains SQL statements. &lt;br&gt;&lt;code&gt;CSV&lt;/code&gt;: The file contains CSV data.
248 &quot;uri&quot;: &quot;A String&quot;, # The path to the file in Google Cloud Storage where the export will be
249 # stored. The URI is in the form &lt;code&gt;gs:
250 # //bucketName/fileName&lt;/code&gt;. If the file already exists, the requests
251 # // succeeds, but the operation fails. If &lt;code&gt;fileType&lt;/code&gt; is
252 # // &lt;code&gt;SQL&lt;/code&gt; and the filename ends with .gz, the contents are
253 # // compressed.
254 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV.
255 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
256 },
257 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#exportContext&lt;/code&gt;.
258 },
259 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
260 &quot;endTime&quot;: &quot;A String&quot;, # The time this operation finished in UTC timezone in &lt;a
261 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
262 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
263 &quot;startTime&quot;: &quot;A String&quot;, # The time this operation actually started in UTC timezone in &lt;a
264 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
265 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
266 &quot;insertTime&quot;: &quot;A String&quot;, # The time this operation was enqueued in UTC timezone in &lt;a
267 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
268 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
269 }</pre>
270</div>
271
272<div class="method">
273 <code class="details" id="get">get(project, instance, sha1Fingerprint, x__xgafv=None)</code>
274 <pre>Retrieves a particular SSL certificate. Does not include the private key
275(required for usage). The private key must be saved from the response to
276initial creation.
277
278Args:
279 project: string, Project ID of the project that contains the instance. (required)
280 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
281 sha1Fingerprint: string, Sha1 FingerPrint. (required)
282 x__xgafv: string, V1 error format.
283 Allowed values
284 1 - v1 error format
285 2 - v2 error format
286
287Returns:
288 An object of the form:
289
290 { # SslCerts Resource
291 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
292 &quot;expirationTime&quot;: &quot;A String&quot;, # The time when the certificate expires in &lt;a
293 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
294 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
295 &quot;sha1Fingerprint&quot;: &quot;A String&quot;, # Sha1 Fingerprint.
296 &quot;certSerialNumber&quot;: &quot;A String&quot;, # Serial number, as extracted from the certificate.
297 &quot;cert&quot;: &quot;A String&quot;, # PEM representation.
298 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#sslCert&lt;/code&gt;.
299 &quot;commonName&quot;: &quot;A String&quot;, # User supplied name. Constrained to [a-zA-Z.-_ ]+.
300 &quot;createTime&quot;: &quot;A String&quot;, # The time when the certificate was created in &lt;a
301 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
302 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;
303 &quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
304 }</pre>
305</div>
306
307<div class="method">
308 <code class="details" id="insert">insert(project, instance, body=None, x__xgafv=None)</code>
309 <pre>Creates an SSL certificate and returns it along with the private key and
310server certificate authority. The new certificate will not be usable until
311the instance is restarted.
312
313Args:
314 project: string, Project ID of the project that contains the instance. (required)
315 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
316 body: object, The request body.
317 The object takes the form of:
318
319{ # SslCerts insert request.
320 &quot;commonName&quot;: &quot;A String&quot;, # User supplied name. Must be a distinct name from the other certificates
321 # for this instance.
322 }
323
324 x__xgafv: string, V1 error format.
325 Allowed values
326 1 - v1 error format
327 2 - v2 error format
328
329Returns:
330 An object of the form:
331
332 { # SslCert insert response.
333 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#sslCertsInsert&lt;/code&gt;.
334 &quot;serverCaCert&quot;: { # SslCerts Resource # The server Certificate Authority&#x27;s certificate. If this is missing you can
335 # force a new one to be generated by calling resetSslConfig method on
336 # instances resource.
337 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
338 &quot;expirationTime&quot;: &quot;A String&quot;, # The time when the certificate expires in &lt;a
339 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
340 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
341 &quot;sha1Fingerprint&quot;: &quot;A String&quot;, # Sha1 Fingerprint.
342 &quot;certSerialNumber&quot;: &quot;A String&quot;, # Serial number, as extracted from the certificate.
343 &quot;cert&quot;: &quot;A String&quot;, # PEM representation.
344 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#sslCert&lt;/code&gt;.
345 &quot;commonName&quot;: &quot;A String&quot;, # User supplied name. Constrained to [a-zA-Z.-_ ]+.
346 &quot;createTime&quot;: &quot;A String&quot;, # The time when the certificate was created in &lt;a
347 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
348 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;
349 &quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
350 },
351 &quot;clientCert&quot;: { # SslCertDetail. # The new client certificate and private key. For First Generation
352 # instances, the new certificate does not take effect until the instance is
353 # restarted.
354 &quot;certInfo&quot;: { # SslCerts Resource # The public information about the cert.
355 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
356 &quot;expirationTime&quot;: &quot;A String&quot;, # The time when the certificate expires in &lt;a
357 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
358 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
359 &quot;sha1Fingerprint&quot;: &quot;A String&quot;, # Sha1 Fingerprint.
360 &quot;certSerialNumber&quot;: &quot;A String&quot;, # Serial number, as extracted from the certificate.
361 &quot;cert&quot;: &quot;A String&quot;, # PEM representation.
362 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#sslCert&lt;/code&gt;.
363 &quot;commonName&quot;: &quot;A String&quot;, # User supplied name. Constrained to [a-zA-Z.-_ ]+.
364 &quot;createTime&quot;: &quot;A String&quot;, # The time when the certificate was created in &lt;a
365 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
366 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;
367 &quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
368 },
369 &quot;certPrivateKey&quot;: &quot;A String&quot;, # The private key for the client cert, in pem format. Keep private in order
370 # to protect your security.
371 },
372 &quot;operation&quot;: { # An Operation resource.&amp;nbsp;For successful operations that return an # The operation to track the ssl certs insert request.
373 # Operation resource, only the fields relevant to the operation are populated
374 # in the resource.
375 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
376 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
377 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
378 &quot;targetLink&quot;: &quot;A String&quot;,
379 &quot;operationType&quot;: &quot;A String&quot;, # The type of the operation. Valid values are &lt;code&gt;CREATE&lt;/code&gt;,
380 # &lt;code&gt;DELETE&lt;/code&gt;, &lt;code&gt;UPDATE&lt;/code&gt;, &lt;code&gt;RESTART&lt;/code&gt;,
381 # &lt;code&gt;IMPORT&lt;/code&gt;, &lt;code&gt;EXPORT&lt;/code&gt;, &lt;code&gt;BACKUP_VOLUME&lt;/code&gt;,
382 # &lt;code&gt;RESTORE_VOLUME&lt;/code&gt;, &lt;code&gt;CREATE_USER&lt;/code&gt;,
383 # &lt;code&gt;DELETE_USER&lt;/code&gt;, &lt;code&gt;CREATE_DATABASE&lt;/code&gt;,
384 # &lt;code&gt;DELETE_DATABASE&lt;/code&gt; .
385 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be
386 # populated.
387 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
388 { # Database instance operation error.
389 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
390 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
391 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operationError&lt;/code&gt;.
392 },
393 ],
394 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operationErrors&lt;/code&gt;.
395 },
396 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operation&lt;/code&gt;.
397 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
398 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
399 &quot;columns&quot;: [ # The columns to which CSV data is imported. If not specified, all columns
400 # of the database table are loaded with CSV data.
401 &quot;A String&quot;,
402 ],
403 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
404 },
405 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#importContext&lt;/code&gt;.
406 &quot;database&quot;: &quot;A String&quot;, # The target database for the import. If &lt;code&gt;fileType&lt;/code&gt; is
407 # &lt;code&gt;SQL&lt;/code&gt;, this field is required only if the import file does not
408 # specify a database, and is overridden by any database specification in the
409 # import file. If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;, one database
410 # must be specified.
411 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
412 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
413 &quot;encryptionOptions&quot;: {
414 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
415 &quot;certPath&quot;: &quot;A String&quot;, # Path to the Certificate (.cer) in Cloud Storage, in the form
416 # &lt;code&gt;gs://bucketName/fileName&lt;/code&gt;. The instance must have
417 # write permissions to the bucket and read access to the file.
418 &quot;pvkPath&quot;: &quot;A String&quot;, # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the
419 # form &lt;code&gt;gs://bucketName/fileName&lt;/code&gt;. The instance must have
420 # write permissions to the bucket and read access to the file.
421 },
422 },
423 &quot;uri&quot;: &quot;A String&quot;, # Path to the import file in Cloud Storage, in the form
424 # &lt;code&gt;gs:
425 # //bucketName/fileName&lt;/code&gt;. Compressed gzip files (.gz) are supported
426 # // when &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;SQL&lt;/code&gt;. The instance must have
427 # // write permissions to the bucket and read access to the file.
428 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. &lt;br&gt;&lt;code&gt;SQL&lt;/code&gt;: The file
429 # contains SQL statements. &lt;br&gt;&lt;code&gt;CSV&lt;/code&gt;: The file contains CSV data.
430 },
431 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are &lt;code&gt;PENDING&lt;/code&gt;,
432 # &lt;code&gt;RUNNING&lt;/code&gt;, &lt;code&gt;DONE&lt;/code&gt;,
433 # &lt;code&gt;SQL_OPERATION_STATUS_UNSPECIFIED&lt;/code&gt;.
434 &quot;name&quot;: &quot;A String&quot;, # An identifier that uniquely identifies the operation. You can use this
435 # identifier to retrieve the Operations resource that has information about
436 # the operation.
437 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
438 &quot;databases&quot;: [ # Databases to be exported. &lt;br /&gt; &lt;b&gt;MySQL instances:&lt;/b&gt; If
439 # &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;SQL&lt;/code&gt; and no database is specified, all
440 # databases are exported, except for the &lt;code&gt;mysql&lt;/code&gt; system database.
441 # If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;, you can specify one database,
442 # either by using this property or by using the
443 # &lt;code&gt;csvExportOptions.selectQuery&lt;/code&gt; property, which takes precedence
444 # over this property. &lt;br /&gt; &lt;b&gt;PostgreSQL instances:&lt;/b&gt; You must specify
445 # one database to be exported. If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;,
446 # this database must match the one specified in the
447 # &lt;code&gt;csvExportOptions.selectQuery&lt;/code&gt; property.
448 &quot;A String&quot;,
449 ],
450 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
451 &quot;tables&quot;: [ # Tables to export, or that were exported, from the specified database. If
452 # you specify tables, specify one and only one database. For PostgreSQL
453 # instances, you can specify only one table.
454 &quot;A String&quot;,
455 ],
456 &quot;schemaOnly&quot;: True or False, # Export only schemas.
457 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
458 &quot;masterData&quot;: 42, # Option to include SQL statement required to set up replication.
459 # If set to &lt;code&gt;1&lt;/code&gt;, the dump file includes
460 # a CHANGE MASTER TO statement with the binary log coordinates.
461 # If set to &lt;code&gt;2&lt;/code&gt;, the CHANGE MASTER TO statement is written as
462 # a SQL comment, and has no effect.
463 # All other values are ignored.
464 },
465 },
466 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. &lt;br&gt;&lt;code&gt;SQL&lt;/code&gt;: The file
467 # contains SQL statements. &lt;br&gt;&lt;code&gt;CSV&lt;/code&gt;: The file contains CSV data.
468 &quot;uri&quot;: &quot;A String&quot;, # The path to the file in Google Cloud Storage where the export will be
469 # stored. The URI is in the form &lt;code&gt;gs:
470 # //bucketName/fileName&lt;/code&gt;. If the file already exists, the requests
471 # // succeeds, but the operation fails. If &lt;code&gt;fileType&lt;/code&gt; is
472 # // &lt;code&gt;SQL&lt;/code&gt; and the filename ends with .gz, the contents are
473 # // compressed.
474 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV.
475 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
476 },
477 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#exportContext&lt;/code&gt;.
478 },
479 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
480 &quot;endTime&quot;: &quot;A String&quot;, # The time this operation finished in UTC timezone in &lt;a
481 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
482 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
483 &quot;startTime&quot;: &quot;A String&quot;, # The time this operation actually started in UTC timezone in &lt;a
484 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
485 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
486 &quot;insertTime&quot;: &quot;A String&quot;, # The time this operation was enqueued in UTC timezone in &lt;a
487 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
488 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
489 },
490 }</pre>
491</div>
492
493<div class="method">
494 <code class="details" id="list">list(project, instance, x__xgafv=None)</code>
495 <pre>Lists all of the current SSL certificates for the instance.
496
497Args:
498 project: string, Project ID of the project that contains the instance. (required)
499 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
500 x__xgafv: string, V1 error format.
501 Allowed values
502 1 - v1 error format
503 2 - v2 error format
504
505Returns:
506 An object of the form:
507
508 { # SslCerts list response.
509 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#sslCertsList&lt;/code&gt;.
510 &quot;items&quot;: [ # List of client certificates for the instance.
511 { # SslCerts Resource
512 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
513 &quot;expirationTime&quot;: &quot;A String&quot;, # The time when the certificate expires in &lt;a
514 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
515 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
516 &quot;sha1Fingerprint&quot;: &quot;A String&quot;, # Sha1 Fingerprint.
517 &quot;certSerialNumber&quot;: &quot;A String&quot;, # Serial number, as extracted from the certificate.
518 &quot;cert&quot;: &quot;A String&quot;, # PEM representation.
519 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#sslCert&lt;/code&gt;.
520 &quot;commonName&quot;: &quot;A String&quot;, # User supplied name. Constrained to [a-zA-Z.-_ ]+.
521 &quot;createTime&quot;: &quot;A String&quot;, # The time when the certificate was created in &lt;a
522 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
523 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;
524 &quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
525 },
526 ],
527 }</pre>
528</div>
529
530</body></html>