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