Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 8595441799dfc7cb2ec12d6ecfe893fd87b2fa7c / . / docs / dyn / sqladmin_v1beta4.projects.instances.html
blob: edd5324aa822dc317fa3c72edb69c6c3677dfcc1 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="sqladmin_v1beta4.html">Cloud SQL Admin API</a> . <a href="sqladmin_v1beta4.projects.html">projects</a> . <a href="sqladmin_v1beta4.projects.instances.html">instances</a></h1>
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">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]81 <code><a href="#rescheduleMaintenance">rescheduleMaintenance(project, instance, body=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Reschedules the maintenance on the given instance.</p>
83<p class="toc_element">
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700[diff] [blame]84 <code><a href="#startExternalSync">startExternalSync(project, instance, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]85<p class="firstline">Start External primary instance migration.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]86<p class="toc_element">
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700[diff] [blame]87 <code><a href="#verifyExternalSyncSettings">verifyExternalSyncSettings(project, instance, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88<p class="firstline">Verify External primary instance external sync settings.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]89<h3>Method Details</h3>
90<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]91 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93</div>
94
95<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]96 <code class="details" id="rescheduleMaintenance">rescheduleMaintenance(project, instance, body=None, x__xgafv=None)</code>
97 <pre>Reschedules the maintenance on the given instance.
98
99Args:
100 project: string, ID of the project that contains the instance. (required)
101 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
102 body: object, The request body.
103 The object takes the form of:
104
105{ # Reschedule options for maintenance windows.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]106 &quot;reschedule&quot;: { # Required. The type of the reschedule the user wants.
107 &quot;rescheduleType&quot;: &quot;A String&quot;, # Required. The type of the reschedule.
yoshi-code-bot312da312021-09-21 00:22:28 -0700[diff] [blame]108 &quot;scheduleTime&quot;: &quot;A String&quot;, # Optional. Timestamp when the maintenance shall be rescheduled to if reschedule_type=SPECIFIC_TIME, 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 -0800[diff] [blame]109 },
110}
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]111
112 x__xgafv: string, V1 error format.
113 Allowed values
114 1 - v1 error format
115 2 - v2 error format
116
117Returns:
118 An object of the form:
119
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]120 { # 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 -0800[diff] [blame]121 &quot;backupContext&quot;: { # Backup context. # The context for backup operation, if applicable.
122 &quot;backupId&quot;: &quot;A String&quot;, # The identifier of the backup.
yoshi-code-bot312da312021-09-21 00:22:28 -0700[diff] [blame]123 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#backupContext**.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]124 },
yoshi-code-bot312da312021-09-21 00:22:28 -0700[diff] [blame]125 &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 -0800[diff] [blame]126 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
127 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
128 { # Database instance operation error.
129 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
yoshi-code-bot312da312021-09-21 00:22:28 -0700[diff] [blame]130 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#operationError**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]131 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
132 },
133 ],
yoshi-code-bot312da312021-09-21 00:22:28 -0700[diff] [blame]134 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#operationErrors**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]135 },
136 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
yoshi-code-bot312da312021-09-21 00:22:28 -0700[diff] [blame]137 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only.
yoshi-code-bot2da5ed12021-09-07 00:20:27 -0700[diff] [blame]138 &quot;escapeCharacter&quot;: &quot;A String&quot;, # Specifies the character that should appear before a data character that needs to be escaped.
139 &quot;fieldsTerminatedBy&quot;: &quot;A String&quot;, # Specifies the character that separates columns within each row (line) of the file.
140 &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.
141 &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 -0800[diff] [blame]142 &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]143 },
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]144 &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 -0800[diff] [blame]145 &quot;A String&quot;,
146 ],
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]147 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri.
yoshi-code-bot1c9dcfd2021-10-12 00:20:31 -0700[diff] [blame]148 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#exportContext**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]149 &quot;offload&quot;: True or False, # Option for export offload.
150 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
151 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]152 &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]153 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]154 &quot;schemaOnly&quot;: True or False, # Export only schemas.
155 &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]156 &quot;A String&quot;,
157 ],
158 },
yoshi-code-bot312da312021-09-21 00:22:28 -0700[diff] [blame]159 &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]160 },
161 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
162 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
163 &quot;encryptionOptions&quot;: {
yoshi-code-bot312da312021-09-21 00:22:28 -0700[diff] [blame]164 &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 -0800[diff] [blame]165 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
yoshi-code-bot1c9dcfd2021-10-12 00:20:31 -0700[diff] [blame]166 &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]167 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]168 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]169 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
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 ],
yoshi-code-bot2da5ed12021-09-07 00:20:27 -0700[diff] [blame]173 &quot;escapeCharacter&quot;: &quot;A String&quot;, # Specifies the character that should appear before a data character that needs to be escaped.
174 &quot;fieldsTerminatedBy&quot;: &quot;A String&quot;, # Specifies the character that separates columns within each row (line) of the file.
175 &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.
176 &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 -0800[diff] [blame]177 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
178 },
yoshi-code-bot312da312021-09-21 00:22:28 -0700[diff] [blame]179 &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.
180 &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]181 &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 -0700[diff] [blame]182 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#importContext**.
183 &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]184 },
yoshi-code-bot312da312021-09-21 00:22:28 -0700[diff] [blame]185 &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**.
186 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#operation**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]187 &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 -0700[diff] [blame]188 &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 -0800[diff] [blame]189 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
yoshi-code-bot312da312021-09-21 00:22:28 -0700[diff] [blame]190 &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**.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]191 &quot;status&quot;: &quot;A String&quot;, # The status of an operation.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]192 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
193 &quot;targetLink&quot;: &quot;A String&quot;,
194 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
195 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
196}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]197</div>
198
199<div class="method">
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700[diff] [blame]200 <code class="details" id="startExternalSync">startExternalSync(project, instance, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]201 <pre>Start External primary instance migration.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]202
203Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]204 project: string, ID of the project that contains the instance. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]205 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700[diff] [blame]206 body: object, The request body.
207 The object takes the form of:
208
209{
210 &quot;mysqlSyncConfig&quot;: { # MySQL-specific external server sync settings. # MySQL-specific settings for start external sync.
yoshi-code-bot8bb904c2021-08-31 00:28:27 -0700[diff] [blame]211 &quot;initialSyncFlags&quot;: [ # Flags to use for the initial dump.
212 { # Initial sync flags for certain Cloud SQL APIs. Currently used for the MySQL external server initial dump.
213 &quot;name&quot;: &quot;A String&quot;, # The name of the flag.
214 &quot;value&quot;: &quot;A String&quot;, # The value of the flag. This field must be omitted if the flag doesn&#x27;t take a value.
215 },
216 ],
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700[diff] [blame]217 },
218 &quot;skipVerification&quot;: True or False, # Whether to skip the verification step (VESS).
219 &quot;syncMode&quot;: &quot;A String&quot;, # External sync mode.
220}
221
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]222 x__xgafv: string, V1 error format.
223 Allowed values
224 1 - v1 error format
225 2 - v2 error format
226
227Returns:
228 An object of the form:
229
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]230 { # 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 -0800[diff] [blame]231 &quot;backupContext&quot;: { # Backup context. # The context for backup operation, if applicable.
232 &quot;backupId&quot;: &quot;A String&quot;, # The identifier of the backup.
yoshi-code-bot312da312021-09-21 00:22:28 -0700[diff] [blame]233 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#backupContext**.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]234 },
yoshi-code-bot312da312021-09-21 00:22:28 -0700[diff] [blame]235 &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 -0800[diff] [blame]236 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
237 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
238 { # Database instance operation error.
239 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
yoshi-code-bot312da312021-09-21 00:22:28 -0700[diff] [blame]240 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#operationError**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]241 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
242 },
243 ],
yoshi-code-bot312da312021-09-21 00:22:28 -0700[diff] [blame]244 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#operationErrors**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]245 },
246 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
yoshi-code-bot312da312021-09-21 00:22:28 -0700[diff] [blame]247 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only.
yoshi-code-bot2da5ed12021-09-07 00:20:27 -0700[diff] [blame]248 &quot;escapeCharacter&quot;: &quot;A String&quot;, # Specifies the character that should appear before a data character that needs to be escaped.
249 &quot;fieldsTerminatedBy&quot;: &quot;A String&quot;, # Specifies the character that separates columns within each row (line) of the file.
250 &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.
251 &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 -0800[diff] [blame]252 &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]253 },
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]254 &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 -0800[diff] [blame]255 &quot;A String&quot;,
256 ],
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]257 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri.
yoshi-code-bot1c9dcfd2021-10-12 00:20:31 -0700[diff] [blame]258 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#exportContext**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]259 &quot;offload&quot;: True or False, # Option for export offload.
260 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
261 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]262 &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]263 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]264 &quot;schemaOnly&quot;: True or False, # Export only schemas.
265 &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]266 &quot;A String&quot;,
267 ],
268 },
yoshi-code-bot312da312021-09-21 00:22:28 -0700[diff] [blame]269 &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]270 },
271 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
272 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
273 &quot;encryptionOptions&quot;: {
yoshi-code-bot312da312021-09-21 00:22:28 -0700[diff] [blame]274 &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 -0800[diff] [blame]275 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
yoshi-code-bot1c9dcfd2021-10-12 00:20:31 -0700[diff] [blame]276 &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]277 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]278 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]279 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
280 &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.
281 &quot;A String&quot;,
282 ],
yoshi-code-bot2da5ed12021-09-07 00:20:27 -0700[diff] [blame]283 &quot;escapeCharacter&quot;: &quot;A String&quot;, # Specifies the character that should appear before a data character that needs to be escaped.
284 &quot;fieldsTerminatedBy&quot;: &quot;A String&quot;, # Specifies the character that separates columns within each row (line) of the file.
285 &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.
286 &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 -0800[diff] [blame]287 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
288 },
yoshi-code-bot312da312021-09-21 00:22:28 -0700[diff] [blame]289 &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.
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. * **BAK**: The file contains backup data for a SQL Server instance.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]291 &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 -0700[diff] [blame]292 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#importContext**.
293 &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]294 },
yoshi-code-bot312da312021-09-21 00:22:28 -0700[diff] [blame]295 &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**.
296 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#operation**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]297 &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 -0700[diff] [blame]298 &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 -0800[diff] [blame]299 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
yoshi-code-bot312da312021-09-21 00:22:28 -0700[diff] [blame]300 &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**.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]301 &quot;status&quot;: &quot;A String&quot;, # The status of an operation.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]302 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
303 &quot;targetLink&quot;: &quot;A String&quot;,
304 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
305 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
306}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]307</div>
308
309<div class="method">
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700[diff] [blame]310 <code class="details" id="verifyExternalSyncSettings">verifyExternalSyncSettings(project, instance, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]311 <pre>Verify External primary instance external sync settings.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]312
313Args:
314 project: string, Project ID of the project that contains the instance. (required)
315 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700[diff] [blame]316 body: object, The request body.
317 The object takes the form of:
318
319{
320 &quot;mysqlSyncConfig&quot;: { # MySQL-specific external server sync settings. # Optional. MySQL-specific settings for start external sync.
yoshi-code-bot8bb904c2021-08-31 00:28:27 -0700[diff] [blame]321 &quot;initialSyncFlags&quot;: [ # Flags to use for the initial dump.
322 { # Initial sync flags for certain Cloud SQL APIs. Currently used for the MySQL external server initial dump.
323 &quot;name&quot;: &quot;A String&quot;, # The name of the flag.
324 &quot;value&quot;: &quot;A String&quot;, # The value of the flag. This field must be omitted if the flag doesn&#x27;t take a value.
325 },
326 ],
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700[diff] [blame]327 },
328 &quot;syncMode&quot;: &quot;A String&quot;, # External sync mode
329 &quot;verifyConnectionOnly&quot;: True or False, # Flag to enable verifying connection only
yoshi-code-bot2da5ed12021-09-07 00:20:27 -0700[diff] [blame]330 &quot;verifyReplicationOnly&quot;: True or False, # Optional. Flag to verify settings required by replication setup only
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700[diff] [blame]331}
332
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]333 x__xgafv: string, V1 error format.
334 Allowed values
335 1 - v1 error format
336 2 - v2 error format
337
338Returns:
339 An object of the form:
340
341 { # Instance verify external sync settings response.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]342 &quot;errors&quot;: [ # List of migration violations.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]343 { # External primary instance migration setting error/warning.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]344 &quot;detail&quot;: &quot;A String&quot;, # Additional information about the error encountered.
yoshi-code-bot1c9dcfd2021-10-12 00:20:31 -0700[diff] [blame]345 &quot;kind&quot;: &quot;A String&quot;, # Can be **sql#externalSyncSettingError** or **sql#externalSyncSettingWarning**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]346 &quot;type&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
347 },
348 ],
yoshi-code-bot1c9dcfd2021-10-12 00:20:31 -0700[diff] [blame]349 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#migrationSettingErrorList**.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]350 &quot;warnings&quot;: [ # List of migration warnings.
351 { # External primary instance migration setting error/warning.
352 &quot;detail&quot;: &quot;A String&quot;, # Additional information about the error encountered.
yoshi-code-bot1c9dcfd2021-10-12 00:20:31 -0700[diff] [blame]353 &quot;kind&quot;: &quot;A String&quot;, # Can be **sql#externalSyncSettingError** or **sql#externalSyncSettingWarning**.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]354 &quot;type&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
355 },
356 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]357}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]358</div>
359
360</body></html>