blob: a380338354d5d6b56104a40b299200af850c705f [file] [log] [blame]
Craig Citroe633be12015-03-02 13:40:36 -08001<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 -070075<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 -080076<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <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 -070081 <code><a href="#createEphemeral">createEphemeral(project, instance, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070082<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 -070083<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070084 <code><a href="#delete">delete(project, instance, sha1Fingerprint, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070085<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 -080086<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070087 <code><a href="#get">get(project, instance, sha1Fingerprint, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070088<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 -080089<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070090 <code><a href="#insert">insert(project, instance, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070091<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 -080092<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070093 <code><a href="#list">list(project, instance, x__xgafv=None)</a></code></p>
Craig Citroe633be12015-03-02 13:40:36 -080094<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 -070097 <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 -0700102 <code class="details" id="createEphemeral">createEphemeral(project, instance, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700103 <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 -0700104
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 -0700108 body: object, The request body.
Takashi Matsuo06694102015-09-11 13:55:40 -0700109 The object takes the form of:
110
111{ # SslCerts create ephemeral certificate request.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800112 &quot;access_token&quot;: &quot;A String&quot;, # Access token to include in the signed certificate.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800113 &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 -0700115
Dan O'Mearadd494642020-05-01 07:42:23 -0700116 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 -0700120
121Returns:
122 An object of the form:
123
124 { # SslCerts Resource
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800125 &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.-_ ]+.
yoshi-code-bot312da312021-09-21 00:22:28 -0700128 &quot;createTime&quot;: &quot;A String&quot;, # The time when the certificate was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) 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](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800130 &quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
yoshi-code-bot312da312021-09-21 00:22:28 -0700131 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#sslCert**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800132 &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 -0700135</div>
136
137<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700138 <code class="details" id="delete">delete(project, instance, sha1Fingerprint, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700139 <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 -0800140
141Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700142 project: string, Project ID of the project that contains the instance. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800143 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 -0700145 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 -0800149
150Returns:
151 An object of the form:
152
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700153 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800154 &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.
yoshi-code-bot312da312021-09-21 00:22:28 -0700156 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#backupContext**.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800157 },
yoshi-code-bot312da312021-09-21 00:22:28 -0700158 &quot;endTime&quot;: &quot;A String&quot;, # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800159 &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.
yoshi-code-bot312da312021-09-21 00:22:28 -0700163 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#operationError**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800164 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
165 },
166 ],
yoshi-code-bot312da312021-09-21 00:22:28 -0700167 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#operationErrors**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800168 },
169 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
yoshi-code-bot312da312021-09-21 00:22:28 -0700170 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only.
yoshi-code-bot2da5ed12021-09-07 00:20:27 -0700171 &quot;escapeCharacter&quot;: &quot;A String&quot;, # Specifies the character that should appear before a data character that needs to be escaped.
172 &quot;fieldsTerminatedBy&quot;: &quot;A String&quot;, # Specifies the character that separates columns within each row (line) of the file.
173 &quot;linesTerminatedBy&quot;: &quot;A String&quot;, # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.
174 &quot;quoteCharacter&quot;: &quot;A String&quot;, # Specifies the quoting character to be used when a data value is quoted.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800175 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800176 },
yoshi-code-bot312da312021-09-21 00:22:28 -0700177 &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. * **SQL Server instances:** You must specify one database to be exported, and the **fileType** must be **BAK**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800178 &quot;A String&quot;,
179 ],
yoshi-code-bot312da312021-09-21 00:22:28 -0700180 &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-code-bot1c9dcfd2021-10-12 00:20:31 -0700181 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#exportContext**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800182 &quot;offload&quot;: True or False, # Option for export offload.
183 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
184 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
yoshi-code-bot312da312021-09-21 00:22:28 -0700185 &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 -0800186 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800187 &quot;schemaOnly&quot;: True or False, # Export only schemas.
188 &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 -0800189 &quot;A String&quot;,
190 ],
191 },
yoshi-code-bot312da312021-09-21 00:22:28 -0700192 &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 -0800193 },
194 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
195 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
196 &quot;encryptionOptions&quot;: {
yoshi-code-bot312da312021-09-21 00:22:28 -0700197 &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 Botcc94ec82021-01-15 07:10:04 -0800198 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
yoshi-code-bot1c9dcfd2021-10-12 00:20:31 -0700199 &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 -0800200 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800201 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800202 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
203 &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.
204 &quot;A String&quot;,
205 ],
yoshi-code-bot2da5ed12021-09-07 00:20:27 -0700206 &quot;escapeCharacter&quot;: &quot;A String&quot;, # Specifies the character that should appear before a data character that needs to be escaped.
207 &quot;fieldsTerminatedBy&quot;: &quot;A String&quot;, # Specifies the character that separates columns within each row (line) of the file.
208 &quot;linesTerminatedBy&quot;: &quot;A String&quot;, # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.
209 &quot;quoteCharacter&quot;: &quot;A String&quot;, # Specifies the quoting character to be used when a data value is quoted.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800210 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
211 },
yoshi-code-bot312da312021-09-21 00:22:28 -0700212 &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.
213 &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 -0800214 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
yoshi-code-bot312da312021-09-21 00:22:28 -0700215 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#importContext**.
216 &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 -0800217 },
yoshi-code-bot312da312021-09-21 00:22:28 -0700218 &quot;insertTime&quot;: &quot;A String&quot;, # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.
219 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#operation**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800220 &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-code-bot312da312021-09-21 00:22:28 -0700221 &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**
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800222 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
yoshi-code-bot312da312021-09-21 00:22:28 -0700223 &quot;startTime&quot;: &quot;A String&quot;, # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.
224 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are: * **PENDING** * **RUNNING** * **DONE** * **SQL_OPERATION_STATUS_UNSPECIFIED**
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800225 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
226 &quot;targetLink&quot;: &quot;A String&quot;,
227 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
228 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
229}</pre>
Craig Citroe633be12015-03-02 13:40:36 -0800230</div>
231
232<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700233 <code class="details" id="get">get(project, instance, sha1Fingerprint, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700234 <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 -0800235
236Args:
237 project: string, Project ID of the project that contains the instance. (required)
238 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
239 sha1Fingerprint: string, Sha1 FingerPrint. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700240 x__xgafv: string, V1 error format.
241 Allowed values
242 1 - v1 error format
243 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800244
245Returns:
246 An object of the form:
247
248 { # SslCerts Resource
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800249 &quot;cert&quot;: &quot;A String&quot;, # PEM representation.
250 &quot;certSerialNumber&quot;: &quot;A String&quot;, # Serial number, as extracted from the certificate.
251 &quot;commonName&quot;: &quot;A String&quot;, # User supplied name. Constrained to [a-zA-Z.-_ ]+.
yoshi-code-bot312da312021-09-21 00:22:28 -0700252 &quot;createTime&quot;: &quot;A String&quot;, # The time when the certificate was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.
253 &quot;expirationTime&quot;: &quot;A String&quot;, # The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800254 &quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
yoshi-code-bot312da312021-09-21 00:22:28 -0700255 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#sslCert**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800256 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
257 &quot;sha1Fingerprint&quot;: &quot;A String&quot;, # Sha1 Fingerprint.
258}</pre>
Craig Citroe633be12015-03-02 13:40:36 -0800259</div>
260
261<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700262 <code class="details" id="insert">insert(project, instance, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700263 <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 -0800264
265Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700266 project: string, Project ID of the project that contains the instance. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800267 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700268 body: object, The request body.
Craig Citroe633be12015-03-02 13:40:36 -0800269 The object takes the form of:
270
271{ # SslCerts insert request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800272 &quot;commonName&quot;: &quot;A String&quot;, # User supplied name. Must be a distinct name from the other certificates for this instance.
273}
Craig Citroe633be12015-03-02 13:40:36 -0800274
Dan O'Mearadd494642020-05-01 07:42:23 -0700275 x__xgafv: string, V1 error format.
276 Allowed values
277 1 - v1 error format
278 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800279
280Returns:
281 An object of the form:
282
283 { # SslCert insert response.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800284 &quot;clientCert&quot;: { # SslCertDetail. # The new client certificate and private key.
285 &quot;certInfo&quot;: { # SslCerts Resource # The public information about the cert.
286 &quot;cert&quot;: &quot;A String&quot;, # PEM representation.
287 &quot;certSerialNumber&quot;: &quot;A String&quot;, # Serial number, as extracted from the certificate.
288 &quot;commonName&quot;: &quot;A String&quot;, # User supplied name. Constrained to [a-zA-Z.-_ ]+.
yoshi-code-bot312da312021-09-21 00:22:28 -0700289 &quot;createTime&quot;: &quot;A String&quot;, # The time when the certificate was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.
290 &quot;expirationTime&quot;: &quot;A String&quot;, # The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800291 &quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
yoshi-code-bot312da312021-09-21 00:22:28 -0700292 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#sslCert**.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800293 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800294 &quot;sha1Fingerprint&quot;: &quot;A String&quot;, # Sha1 Fingerprint.
295 },
296 &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.
297 },
yoshi-code-bot1c9dcfd2021-10-12 00:20:31 -0700298 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#sslCertsInsert**.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700299 &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.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800300 &quot;backupContext&quot;: { # Backup context. # The context for backup operation, if applicable.
301 &quot;backupId&quot;: &quot;A String&quot;, # The identifier of the backup.
yoshi-code-bot312da312021-09-21 00:22:28 -0700302 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#backupContext**.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800303 },
yoshi-code-bot312da312021-09-21 00:22:28 -0700304 &quot;endTime&quot;: &quot;A String&quot;, # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800305 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
306 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
307 { # Database instance operation error.
308 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
yoshi-code-bot312da312021-09-21 00:22:28 -0700309 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#operationError**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800310 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800311 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800312 ],
yoshi-code-bot312da312021-09-21 00:22:28 -0700313 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#operationErrors**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800314 },
315 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
yoshi-code-bot312da312021-09-21 00:22:28 -0700316 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only.
yoshi-code-bot2da5ed12021-09-07 00:20:27 -0700317 &quot;escapeCharacter&quot;: &quot;A String&quot;, # Specifies the character that should appear before a data character that needs to be escaped.
318 &quot;fieldsTerminatedBy&quot;: &quot;A String&quot;, # Specifies the character that separates columns within each row (line) of the file.
319 &quot;linesTerminatedBy&quot;: &quot;A String&quot;, # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.
320 &quot;quoteCharacter&quot;: &quot;A String&quot;, # Specifies the quoting character to be used when a data value is quoted.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800321 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
322 },
yoshi-code-bot312da312021-09-21 00:22:28 -0700323 &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. * **SQL Server instances:** You must specify one database to be exported, and the **fileType** must be **BAK**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800324 &quot;A String&quot;,
325 ],
yoshi-code-bot312da312021-09-21 00:22:28 -0700326 &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-code-bot1c9dcfd2021-10-12 00:20:31 -0700327 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#exportContext**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800328 &quot;offload&quot;: True or False, # Option for export offload.
329 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
330 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
yoshi-code-bot312da312021-09-21 00:22:28 -0700331 &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 -0800332 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800333 &quot;schemaOnly&quot;: True or False, # Export only schemas.
334 &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 -0800335 &quot;A String&quot;,
336 ],
337 },
yoshi-code-bot312da312021-09-21 00:22:28 -0700338 &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 -0700339 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800340 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
341 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
342 &quot;encryptionOptions&quot;: {
yoshi-code-bot312da312021-09-21 00:22:28 -0700343 &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 Botcc94ec82021-01-15 07:10:04 -0800344 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
yoshi-code-bot1c9dcfd2021-10-12 00:20:31 -0700345 &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 Botcc94ec82021-01-15 07:10:04 -0800346 },
347 },
348 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
349 &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.
350 &quot;A String&quot;,
351 ],
yoshi-code-bot2da5ed12021-09-07 00:20:27 -0700352 &quot;escapeCharacter&quot;: &quot;A String&quot;, # Specifies the character that should appear before a data character that needs to be escaped.
353 &quot;fieldsTerminatedBy&quot;: &quot;A String&quot;, # Specifies the character that separates columns within each row (line) of the file.
354 &quot;linesTerminatedBy&quot;: &quot;A String&quot;, # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.
355 &quot;quoteCharacter&quot;: &quot;A String&quot;, # Specifies the quoting character to be used when a data value is quoted.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800356 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
357 },
yoshi-code-bot312da312021-09-21 00:22:28 -0700358 &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.
359 &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 -0800360 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
yoshi-code-bot312da312021-09-21 00:22:28 -0700361 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#importContext**.
362 &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 -0800363 },
yoshi-code-bot312da312021-09-21 00:22:28 -0700364 &quot;insertTime&quot;: &quot;A String&quot;, # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.
365 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#operation**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800366 &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-code-bot312da312021-09-21 00:22:28 -0700367 &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**
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800368 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
yoshi-code-bot312da312021-09-21 00:22:28 -0700369 &quot;startTime&quot;: &quot;A String&quot;, # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.
370 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are: * **PENDING** * **RUNNING** * **DONE** * **SQL_OPERATION_STATUS_UNSPECIFIED**
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800371 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
372 &quot;targetLink&quot;: &quot;A String&quot;,
373 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
374 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
375 },
376 &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.
377 &quot;cert&quot;: &quot;A String&quot;, # PEM representation.
378 &quot;certSerialNumber&quot;: &quot;A String&quot;, # Serial number, as extracted from the certificate.
379 &quot;commonName&quot;: &quot;A String&quot;, # User supplied name. Constrained to [a-zA-Z.-_ ]+.
yoshi-code-bot312da312021-09-21 00:22:28 -0700380 &quot;createTime&quot;: &quot;A String&quot;, # The time when the certificate was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.
381 &quot;expirationTime&quot;: &quot;A String&quot;, # The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800382 &quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
yoshi-code-bot312da312021-09-21 00:22:28 -0700383 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#sslCert**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800384 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
385 &quot;sha1Fingerprint&quot;: &quot;A String&quot;, # Sha1 Fingerprint.
386 },
387}</pre>
Craig Citroe633be12015-03-02 13:40:36 -0800388</div>
389
390<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700391 <code class="details" id="list">list(project, instance, x__xgafv=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800392 <pre>Lists all of the current SSL certificates for the instance.
393
394Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700395 project: string, Project ID of the project that contains the instance. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800396 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700397 x__xgafv: string, V1 error format.
398 Allowed values
399 1 - v1 error format
400 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800401
402Returns:
403 An object of the form:
404
405 { # SslCerts list response.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800406 &quot;items&quot;: [ # List of client certificates for the instance.
407 { # SslCerts Resource
408 &quot;cert&quot;: &quot;A String&quot;, # PEM representation.
409 &quot;certSerialNumber&quot;: &quot;A String&quot;, # Serial number, as extracted from the certificate.
410 &quot;commonName&quot;: &quot;A String&quot;, # User supplied name. Constrained to [a-zA-Z.-_ ]+.
yoshi-code-bot312da312021-09-21 00:22:28 -0700411 &quot;createTime&quot;: &quot;A String&quot;, # The time when the certificate was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.
412 &quot;expirationTime&quot;: &quot;A String&quot;, # The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800413 &quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
yoshi-code-bot312da312021-09-21 00:22:28 -0700414 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#sslCert**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800415 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
416 &quot;sha1Fingerprint&quot;: &quot;A String&quot;, # Sha1 Fingerprint.
417 },
418 ],
yoshi-code-bot1c9dcfd2021-10-12 00:20:31 -0700419 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#sslCertsList**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800420}</pre>
Craig Citroe633be12015-03-02 13:40:36 -0800421</div>
422
423</body></html>