Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 1b1171d09d4c39542e0749eefb1b0bc7b38a9d6a / . / docs / dyn / sqladmin_v1beta4.sslCerts.html
blob: 95040dc9e8ff1aa16785f039e53fa7001fc6ea35 [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.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]112 &quot;access_token&quot;: &quot;A String&quot;, # Access token to include in the signed certificate.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]113 &quot;public_key&quot;: &quot;A String&quot;, # PEM encoded public key to include in the signed certificate.
114}
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]115
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]116 x__xgafv: string, V1 error format.
117 Allowed values
118 1 - v1 error format
119 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]120
121Returns:
122 An object of the form:
123
124 { # SslCerts Resource
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]125 &quot;cert&quot;: &quot;A String&quot;, # PEM representation.
126 &quot;certSerialNumber&quot;: &quot;A String&quot;, # Serial number, as extracted from the certificate.
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 RFC 3339 format, for example *2012-11-15T16:19:00.094Z*
129 &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*.
130 &quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
131 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#sslCert*.
132 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
133 &quot;sha1Fingerprint&quot;: &quot;A String&quot;, # Sha1 Fingerprint.
134}</pre>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]135</div>
136
137<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]138 <code class="details" id="delete">delete(project, instance, sha1Fingerprint, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]139 <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]140
141Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]142 project: string, Project ID of the project that contains the instance. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]143 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
144 sha1Fingerprint: string, Sha1 FingerPrint. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]145 x__xgafv: string, V1 error format.
146 Allowed values
147 1 - v1 error format
148 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]149
150Returns:
151 An object of the form:
152
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]153 { # 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
154 &quot;backupContext&quot;: { # Backup context. # The context for backup operation, if applicable.
155 &quot;backupId&quot;: &quot;A String&quot;, # The identifier of the backup.
156 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#backupContext*.
157 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]158 &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*.
159 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
160 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
161 { # Database instance operation error.
162 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
163 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationError*.
164 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
165 },
166 ],
167 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationErrors*.
168 },
169 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]170 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]171 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]172 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]173 &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.
174 &quot;A String&quot;,
175 ],
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]176 &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. *BAK*: The file contains backup data for a SQL Server instance.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]177 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#exportContext*.
178 &quot;offload&quot;: True or False, # Option for export offload.
179 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
180 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]181 &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, 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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]182 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]183 &quot;schemaOnly&quot;: True or False, # Export only schemas.
184 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]185 &quot;A String&quot;,
186 ],
187 },
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]188 &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 request succeeds, but the operation fails. If *fileType* is *SQL* and the filename ends with .gz, the contents are compressed.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]189 },
190 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
191 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
192 &quot;encryptionOptions&quot;: {
193 &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.
194 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
195 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]196 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]197 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]198 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
199 &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.
200 &quot;A String&quot;,
201 ],
202 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
203 },
204 &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.
205 &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.
206 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
207 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#importContext*.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]208 &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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]209 },
210 &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*.
211 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operation*.
212 &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.
213 &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*
214 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
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*.
216 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
217 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
218 &quot;targetLink&quot;: &quot;A String&quot;,
219 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
220 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
221}</pre>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]222</div>
223
224<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]225 <code class="details" id="get">get(project, instance, sha1Fingerprint, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]226 <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]227
228Args:
229 project: string, Project ID of the project that contains the instance. (required)
230 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
231 sha1Fingerprint: string, Sha1 FingerPrint. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]232 x__xgafv: string, V1 error format.
233 Allowed values
234 1 - v1 error format
235 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]236
237Returns:
238 An object of the form:
239
240 { # SslCerts Resource
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]241 &quot;cert&quot;: &quot;A String&quot;, # PEM representation.
242 &quot;certSerialNumber&quot;: &quot;A String&quot;, # Serial number, as extracted from the certificate.
243 &quot;commonName&quot;: &quot;A String&quot;, # User supplied name. Constrained to [a-zA-Z.-_ ]+.
244 &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*
245 &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*.
246 &quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
247 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#sslCert*.
248 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
249 &quot;sha1Fingerprint&quot;: &quot;A String&quot;, # Sha1 Fingerprint.
250}</pre>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]251</div>
252
253<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]254 <code class="details" id="insert">insert(project, instance, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]255 <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]256
257Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]258 project: string, Project ID of the project that contains the instance. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]259 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]260 body: object, The request body.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]261 The object takes the form of:
262
263{ # SslCerts insert request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]264 &quot;commonName&quot;: &quot;A String&quot;, # User supplied name. Must be a distinct name from the other certificates for this instance.
265}
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]266
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]267 x__xgafv: string, V1 error format.
268 Allowed values
269 1 - v1 error format
270 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]271
272Returns:
273 An object of the form:
274
275 { # SslCert insert response.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]276 &quot;clientCert&quot;: { # SslCertDetail. # The new client certificate and private key.
277 &quot;certInfo&quot;: { # SslCerts Resource # The public information about the cert.
278 &quot;cert&quot;: &quot;A String&quot;, # PEM representation.
279 &quot;certSerialNumber&quot;: &quot;A String&quot;, # Serial number, as extracted from the certificate.
280 &quot;commonName&quot;: &quot;A String&quot;, # User supplied name. Constrained to [a-zA-Z.-_ ]+.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]281 &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*
282 &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*.
283 &quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]284 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#sslCert*.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]285 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]286 &quot;sha1Fingerprint&quot;: &quot;A String&quot;, # Sha1 Fingerprint.
287 },
288 &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.
289 },
290 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#sslCertsInsert*.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]291 &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. Next field: 18 # The operation to track the ssl certs insert request.
292 &quot;backupContext&quot;: { # Backup context. # The context for backup operation, if applicable.
293 &quot;backupId&quot;: &quot;A String&quot;, # The identifier of the backup.
294 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#backupContext*.
295 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]296 &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*.
297 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
298 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
299 { # Database instance operation error.
300 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
301 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationError*.
302 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]303 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]304 ],
305 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationErrors*.
306 },
307 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]308 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]309 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
310 },
311 &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.
312 &quot;A String&quot;,
313 ],
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]314 &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. *BAK*: The file contains backup data for a SQL Server instance.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]315 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#exportContext*.
316 &quot;offload&quot;: True or False, # Option for export offload.
317 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
318 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]319 &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, 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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]320 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]321 &quot;schemaOnly&quot;: True or False, # Export only schemas.
322 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]323 &quot;A String&quot;,
324 ],
325 },
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]326 &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 request succeeds, but the operation fails. If *fileType* is *SQL* and the filename ends with .gz, the contents are compressed.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]327 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]328 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
329 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
330 &quot;encryptionOptions&quot;: {
331 &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.
332 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
333 &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.
334 },
335 },
336 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
337 &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.
338 &quot;A String&quot;,
339 ],
340 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
341 },
342 &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.
343 &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.
344 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
345 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#importContext*.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]346 &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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]347 },
348 &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*.
349 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operation*.
350 &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.
351 &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*
352 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
353 &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*.
354 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
355 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
356 &quot;targetLink&quot;: &quot;A String&quot;,
357 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
358 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
359 },
360 &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.
361 &quot;cert&quot;: &quot;A String&quot;, # PEM representation.
362 &quot;certSerialNumber&quot;: &quot;A String&quot;, # Serial number, as extracted from the certificate.
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 RFC 3339 format, for example *2012-11-15T16:19:00.094Z*
365 &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*.
366 &quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
367 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#sslCert*.
368 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
369 &quot;sha1Fingerprint&quot;: &quot;A String&quot;, # Sha1 Fingerprint.
370 },
371}</pre>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]372</div>
373
374<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]375 <code class="details" id="list">list(project, instance, x__xgafv=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]376 <pre>Lists all of the current SSL certificates for the instance.
377
378Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]379 project: string, Project ID of the project that contains the instance. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]380 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]381 x__xgafv: string, V1 error format.
382 Allowed values
383 1 - v1 error format
384 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]385
386Returns:
387 An object of the form:
388
389 { # SslCerts list response.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]390 &quot;items&quot;: [ # List of client certificates for the instance.
391 { # SslCerts Resource
392 &quot;cert&quot;: &quot;A String&quot;, # PEM representation.
393 &quot;certSerialNumber&quot;: &quot;A String&quot;, # Serial number, as extracted from the certificate.
394 &quot;commonName&quot;: &quot;A String&quot;, # User supplied name. Constrained to [a-zA-Z.-_ ]+.
395 &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*
396 &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*.
397 &quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
398 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#sslCert*.
399 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
400 &quot;sha1Fingerprint&quot;: &quot;A String&quot;, # Sha1 Fingerprint.
401 },
402 ],
403 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#sslCertsList*.
404}</pre>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]405</div>
406
407</body></html>