Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 673ec5cf1a654055c85c0d426b27d270a8ade262 / . / docs / dyn / sqladmin_v1beta4.sslCerts.html
blob: c9b97c90fc4076b86975ba918769e6ba227cffce [file] [log] [blame]
Craig Citroe633be12015-03-02 13:40:36 -0800[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
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]75<h1><a href="sqladmin_v1beta4.html">Cloud SQL Admin API</a> . <a href="sqladmin_v1beta4.sslCerts.html">sslCerts</a></h1>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]81 <code><a href="#createEphemeral">createEphemeral(project, instance, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]82<p class="firstline">Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]83<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]84 <code><a href="#delete">delete(project, instance, sha1Fingerprint, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]85<p class="firstline">Deletes the SSL certificate. For First Generation instances, the certificate remains valid until the instance is restarted.</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]86<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]87 <code><a href="#get">get(project, instance, sha1Fingerprint, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88<p class="firstline">Retrieves a particular SSL certificate. Does not include the private key (required for usage). The private key must be saved from the response to initial creation.</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]89<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]90 <code><a href="#insert">insert(project, instance, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]91<p class="firstline">Creates an SSL certificate and returns it along with the private key and server certificate authority. The new certificate will not be usable until the instance is restarted.</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]93 <code><a href="#list">list(project, instance, x__xgafv=None)</a></code></p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]94<p class="firstline">Lists all of the current SSL certificates for the instance.</p>
95<h3>Method Details</h3>
96<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]97 <code class="details" id="close">close()</code>
98 <pre>Close httplib2 connections.</pre>
99</div>
100
101<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]102 <code class="details" id="createEphemeral">createEphemeral(project, instance, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]103 <pre>Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]104
105Args:
106 project: string, Project ID of the Cloud SQL project. (required)
107 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]108 body: object, The request body.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]109 The object takes the form of:
110
111{ # SslCerts create ephemeral certificate request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]112 &quot;public_key&quot;: &quot;A String&quot;, # PEM encoded public key to include in the signed certificate.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]113 }
114
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]115 x__xgafv: string, V1 error format.
116 Allowed values
117 1 - v1 error format
118 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]119
120Returns:
121 An object of the form:
122
123 { # SslCerts Resource
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]124 &quot;certSerialNumber&quot;: &quot;A String&quot;, # Serial number, as extracted from the certificate.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]125 &quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
126 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#sslCert*.
127 &quot;createTime&quot;: &quot;A String&quot;, # The time when the certificate was created in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*
128 &quot;cert&quot;: &quot;A String&quot;, # PEM representation.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]129 &quot;sha1Fingerprint&quot;: &quot;A String&quot;, # Sha1 Fingerprint.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]130 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
131 &quot;commonName&quot;: &quot;A String&quot;, # User supplied name. Constrained to [a-zA-Z.-_ ]+.
132 &quot;expirationTime&quot;: &quot;A String&quot;, # The time when the certificate expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]133 }</pre>
134</div>
135
136<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]137 <code class="details" id="delete">delete(project, instance, sha1Fingerprint, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]138 <pre>Deletes the SSL certificate. For First Generation instances, the certificate remains valid until the instance is restarted.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]139
140Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]141 project: string, Project ID of the project that contains the instance. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]142 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
143 sha1Fingerprint: string, Sha1 FingerPrint. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]144 x__xgafv: string, V1 error format.
145 Allowed values
146 1 - v1 error format
147 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]148
149Returns:
150 An object of the form:
151
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]152 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]153 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]154 &quot;database&quot;: &quot;A String&quot;, # 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]155 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
156 &quot;columns&quot;: [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
157 &quot;A String&quot;,
158 ],
159 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
160 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]161 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#importContext*.
162 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
163 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
164 &quot;uri&quot;: &quot;A String&quot;, # 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]165 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
166 &quot;encryptionOptions&quot;: {
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]167 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]168 &quot;certPath&quot;: &quot;A String&quot;, # 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.
169 &quot;pvkPath&quot;: &quot;A String&quot;, # 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]170 },
171 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]172 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]173 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
174 &quot;uri&quot;: &quot;A String&quot;, # 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.
175 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
176 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
177 &quot;masterData&quot;: 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.
178 },
179 &quot;schemaOnly&quot;: True or False, # Export only schemas.
180 &quot;tables&quot;: [ # 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.
181 &quot;A String&quot;,
182 ],
183 },
184 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#exportContext*.
185 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV.
186 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
187 },
188 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
189 &quot;offload&quot;: True or False, # Option for export offload.
190 &quot;databases&quot;: [ # 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.
191 &quot;A String&quot;,
192 ],
193 },
194 &quot;endTime&quot;: &quot;A String&quot;, # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
195 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
196 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
197 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
198 &quot;insertTime&quot;: &quot;A String&quot;, # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
199 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
200 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
201 &quot;operationType&quot;: &quot;A String&quot;, # 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*
202 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operation*.
203 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
204 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationErrors*.
205 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
206 { # Database instance operation error.
207 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
208 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
209 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationError*.
210 },
211 ],
212 },
213 &quot;targetLink&quot;: &quot;A String&quot;,
214 &quot;name&quot;: &quot;A String&quot;, # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
215 &quot;startTime&quot;: &quot;A String&quot;, # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]216 }</pre>
217</div>
218
219<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]220 <code class="details" id="get">get(project, instance, sha1Fingerprint, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]221 <pre>Retrieves a particular SSL certificate. Does not include the private key (required for usage). The private key must be saved from the response to initial creation.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]222
223Args:
224 project: string, Project ID of the project that contains the instance. (required)
225 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
226 sha1Fingerprint: string, Sha1 FingerPrint. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]227 x__xgafv: string, V1 error format.
228 Allowed values
229 1 - v1 error format
230 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]231
232Returns:
233 An object of the form:
234
235 { # SslCerts Resource
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]236 &quot;certSerialNumber&quot;: &quot;A String&quot;, # Serial number, as extracted from the certificate.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]237 &quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
238 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#sslCert*.
239 &quot;createTime&quot;: &quot;A String&quot;, # The time when the certificate was created in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*
240 &quot;cert&quot;: &quot;A String&quot;, # PEM representation.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]241 &quot;sha1Fingerprint&quot;: &quot;A String&quot;, # Sha1 Fingerprint.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]242 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
243 &quot;commonName&quot;: &quot;A String&quot;, # User supplied name. Constrained to [a-zA-Z.-_ ]+.
244 &quot;expirationTime&quot;: &quot;A String&quot;, # The time when the certificate expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]245 }</pre>
246</div>
247
248<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]249 <code class="details" id="insert">insert(project, instance, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]250 <pre>Creates an SSL certificate and returns it along with the private key and server certificate authority. The new certificate will not be usable until the instance is restarted.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]251
252Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]253 project: string, Project ID of the project that contains the instance. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]254 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]255 body: object, The request body.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]256 The object takes the form of:
257
258{ # SslCerts insert request.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]259 &quot;commonName&quot;: &quot;A String&quot;, # User supplied name. Must be a distinct name from the other certificates for this instance.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]260 }
261
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]262 x__xgafv: string, V1 error format.
263 Allowed values
264 1 - v1 error format
265 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]266
267Returns:
268 An object of the form:
269
270 { # SslCert insert response.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]271 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#sslCertsInsert*.
272 &quot;clientCert&quot;: { # SslCertDetail. # The new client certificate and private key.
273 &quot;certPrivateKey&quot;: &quot;A String&quot;, # The private key for the client cert, in pem format. Keep private in order to protect your security.
274 &quot;certInfo&quot;: { # SslCerts Resource # The public information about the cert.
275 &quot;certSerialNumber&quot;: &quot;A String&quot;, # Serial number, as extracted from the certificate.
276 &quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
277 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#sslCert*.
278 &quot;createTime&quot;: &quot;A String&quot;, # The time when the certificate was created in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*
279 &quot;cert&quot;: &quot;A String&quot;, # PEM representation.
280 &quot;sha1Fingerprint&quot;: &quot;A String&quot;, # Sha1 Fingerprint.
281 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
282 &quot;commonName&quot;: &quot;A String&quot;, # User supplied name. Constrained to [a-zA-Z.-_ ]+.
283 &quot;expirationTime&quot;: &quot;A String&quot;, # The time when the certificate expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
284 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]285 },
286 &quot;operation&quot;: { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. # The operation to track the ssl certs insert request.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]287 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]288 &quot;database&quot;: &quot;A String&quot;, # 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]289 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
290 &quot;columns&quot;: [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
291 &quot;A String&quot;,
292 ],
293 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
294 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]295 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#importContext*.
296 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
297 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
298 &quot;uri&quot;: &quot;A String&quot;, # 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]299 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
300 &quot;encryptionOptions&quot;: {
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]301 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]302 &quot;certPath&quot;: &quot;A String&quot;, # 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.
303 &quot;pvkPath&quot;: &quot;A String&quot;, # 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]304 },
305 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]306 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]307 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
308 &quot;uri&quot;: &quot;A String&quot;, # 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.
309 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
310 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
311 &quot;masterData&quot;: 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.
312 },
313 &quot;schemaOnly&quot;: True or False, # Export only schemas.
314 &quot;tables&quot;: [ # 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.
315 &quot;A String&quot;,
316 ],
317 },
318 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#exportContext*.
319 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV.
320 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
321 },
322 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
323 &quot;offload&quot;: True or False, # Option for export offload.
324 &quot;databases&quot;: [ # 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.
325 &quot;A String&quot;,
326 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]327 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]328 &quot;endTime&quot;: &quot;A String&quot;, # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
329 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
330 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
331 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
332 &quot;insertTime&quot;: &quot;A String&quot;, # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
333 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
334 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
335 &quot;operationType&quot;: &quot;A String&quot;, # 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*
336 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operation*.
337 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
338 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationErrors*.
339 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
340 { # Database instance operation error.
341 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
342 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
343 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationError*.
344 },
345 ],
346 },
347 &quot;targetLink&quot;: &quot;A String&quot;,
348 &quot;name&quot;: &quot;A String&quot;, # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
349 &quot;startTime&quot;: &quot;A String&quot;, # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]350 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]351 &quot;serverCaCert&quot;: { # SslCerts Resource # The server Certificate Authority&#x27;s certificate. If this is missing you can force a new one to be generated by calling resetSslConfig method on instances resource.
352 &quot;certSerialNumber&quot;: &quot;A String&quot;, # Serial number, as extracted from the certificate.
353 &quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
354 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#sslCert*.
355 &quot;createTime&quot;: &quot;A String&quot;, # The time when the certificate was created in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*
356 &quot;cert&quot;: &quot;A String&quot;, # PEM representation.
357 &quot;sha1Fingerprint&quot;: &quot;A String&quot;, # Sha1 Fingerprint.
358 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
359 &quot;commonName&quot;: &quot;A String&quot;, # User supplied name. Constrained to [a-zA-Z.-_ ]+.
360 &quot;expirationTime&quot;: &quot;A String&quot;, # The time when the certificate expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
361 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]362 }</pre>
363</div>
364
365<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]366 <code class="details" id="list">list(project, instance, x__xgafv=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]367 <pre>Lists all of the current SSL certificates for the instance.
368
369Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]370 project: string, Project ID of the project that contains the instance. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]371 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]372 x__xgafv: string, V1 error format.
373 Allowed values
374 1 - v1 error format
375 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]376
377Returns:
378 An object of the form:
379
380 { # SslCerts list response.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]381 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#sslCertsList*.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]382 &quot;items&quot;: [ # List of client certificates for the instance.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]383 { # SslCerts Resource
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]384 &quot;certSerialNumber&quot;: &quot;A String&quot;, # Serial number, as extracted from the certificate.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]385 &quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
386 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#sslCert*.
387 &quot;createTime&quot;: &quot;A String&quot;, # The time when the certificate was created in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*
388 &quot;cert&quot;: &quot;A String&quot;, # PEM representation.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]389 &quot;sha1Fingerprint&quot;: &quot;A String&quot;, # Sha1 Fingerprint.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]390 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
391 &quot;commonName&quot;: &quot;A String&quot;, # User supplied name. Constrained to [a-zA-Z.-_ ]+.
392 &quot;expirationTime&quot;: &quot;A String&quot;, # The time when the certificate expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]393 },
394 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]395 }</pre>
396</div>
397
398</body></html>