blob: 50f4c1ba1ce82b559ef965bd556dd46e5287b7b9 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -07001<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 -070078 <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 -070081 <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-botb6dc1b92021-03-02 11:49:08 -080084 <code><a href="#startExternalSync">startExternalSync(project, instance, skipVerification=None, syncMode=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070085<p class="firstline">Start External primary instance migration.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -070086<p class="toc_element">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -080087 <code><a href="#verifyExternalSyncSettings">verifyExternalSyncSettings(project, instance, syncMode=None, verifyConnectionOnly=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070088<p class="firstline">Verify External primary instance external sync settings.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -070089<h3>Method Details</h3>
90<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070091 <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 -070096 <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 -0800106 &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.
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 format, for example *2012-11-15T16:19:00.094Z*.
109 },
110}
Bu Sun Kim65020912020-05-20 12:08:20 -0700111
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 -0700120 { # 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 -0800121 &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.
123 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#backupContext*.
124 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800125 &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*.
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.
130 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationError*.
131 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
132 },
133 ],
134 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationErrors*.
135 },
136 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800137 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800138 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800139 },
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700140 &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 -0800141 &quot;A String&quot;,
142 ],
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800143 &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 -0800144 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#exportContext*.
145 &quot;offload&quot;: True or False, # Option for export offload.
146 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
147 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800148 &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 -0800149 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800150 &quot;schemaOnly&quot;: True or False, # Export only schemas.
151 &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 -0800152 &quot;A String&quot;,
153 ],
154 },
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800155 &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 -0800156 },
157 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
158 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
159 &quot;encryptionOptions&quot;: {
160 &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.
161 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
162 &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 -0800163 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800164 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800165 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
166 &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.
167 &quot;A String&quot;,
168 ],
169 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
170 },
171 &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.
172 &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.
173 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
174 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#importContext*.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800175 &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 -0800176 },
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;kind&quot;: &quot;A String&quot;, # This is always *sql#operation*.
179 &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.
180 &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*
181 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
182 &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*.
183 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
184 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
185 &quot;targetLink&quot;: &quot;A String&quot;,
186 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
187 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
188}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700189</div>
190
191<div class="method">
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800192 <code class="details" id="startExternalSync">startExternalSync(project, instance, skipVerification=None, syncMode=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700193 <pre>Start External primary instance migration.
Bu Sun Kim65020912020-05-20 12:08:20 -0700194
195Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700196 project: string, ID of the project that contains the instance. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700197 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800198 skipVerification: boolean, Whether to skip the verification step (VESS).
199 syncMode: string, External sync mode.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700200 Allowed values
201 EXTERNAL_SYNC_MODE_UNSPECIFIED - Unknown external sync mode, will be defaulted to ONLINE mode
202 ONLINE - Online external sync will set up replication after initial data external sync
203 OFFLINE - Offline external sync only dumps and loads a one-time snapshot of the primary instance&#x27;s data
Bu Sun Kim65020912020-05-20 12:08:20 -0700204 x__xgafv: string, V1 error format.
205 Allowed values
206 1 - v1 error format
207 2 - v2 error format
208
209Returns:
210 An object of the form:
211
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700212 { # 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 -0800213 &quot;backupContext&quot;: { # Backup context. # The context for backup operation, if applicable.
214 &quot;backupId&quot;: &quot;A String&quot;, # The identifier of the backup.
215 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#backupContext*.
216 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800217 &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*.
218 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
219 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
220 { # Database instance operation error.
221 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
222 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationError*.
223 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
224 },
225 ],
226 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationErrors*.
227 },
228 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800229 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800230 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800231 },
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700232 &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 -0800233 &quot;A String&quot;,
234 ],
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800235 &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 -0800236 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#exportContext*.
237 &quot;offload&quot;: True or False, # Option for export offload.
238 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
239 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800240 &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 -0800241 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800242 &quot;schemaOnly&quot;: True or False, # Export only schemas.
243 &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 -0800244 &quot;A String&quot;,
245 ],
246 },
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800247 &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 -0800248 },
249 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
250 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
251 &quot;encryptionOptions&quot;: {
252 &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.
253 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
254 &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 -0800255 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800256 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800257 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
258 &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.
259 &quot;A String&quot;,
260 ],
261 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
262 },
263 &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.
264 &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.
265 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
266 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#importContext*.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800267 &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 -0800268 },
269 &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*.
270 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operation*.
271 &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.
272 &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*
273 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
274 &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*.
275 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
276 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
277 &quot;targetLink&quot;: &quot;A String&quot;,
278 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
279 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
280}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700281</div>
282
283<div class="method">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800284 <code class="details" id="verifyExternalSyncSettings">verifyExternalSyncSettings(project, instance, syncMode=None, verifyConnectionOnly=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700285 <pre>Verify External primary instance external sync settings.
Bu Sun Kim65020912020-05-20 12:08:20 -0700286
287Args:
288 project: string, Project ID of the project that contains the instance. (required)
289 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700290 syncMode: string, External sync mode
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700291 Allowed values
292 EXTERNAL_SYNC_MODE_UNSPECIFIED - Unknown external sync mode, will be defaulted to ONLINE mode
293 ONLINE - Online external sync will set up replication after initial data external sync
294 OFFLINE - Offline external sync only dumps and loads a one-time snapshot of the primary instance&#x27;s data
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800295 verifyConnectionOnly: boolean, Flag to enable verifying connection only
Bu Sun Kim65020912020-05-20 12:08:20 -0700296 x__xgafv: string, V1 error format.
297 Allowed values
298 1 - v1 error format
299 2 - v2 error format
300
301Returns:
302 An object of the form:
303
304 { # Instance verify external sync settings response.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800305 &quot;errors&quot;: [ # List of migration violations.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700306 { # External primary instance migration setting error/warning.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800307 &quot;detail&quot;: &quot;A String&quot;, # Additional information about the error encountered.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700308 &quot;kind&quot;: &quot;A String&quot;, # Can be *sql#externalSyncSettingError* or *sql#externalSyncSettingWarning*.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800309 &quot;type&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
310 },
311 ],
312 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#migrationSettingErrorList*.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700313 &quot;warnings&quot;: [ # List of migration warnings.
314 { # External primary instance migration setting error/warning.
315 &quot;detail&quot;: &quot;A String&quot;, # Additional information about the error encountered.
316 &quot;kind&quot;: &quot;A String&quot;, # Can be *sql#externalSyncSettingError* or *sql#externalSyncSettingWarning*.
317 &quot;type&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
318 },
319 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800320}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700321</div>
322
323</body></html>