Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b6971b0405ba59d905b84fa5fc8e27e12d29b70c / . / docs / dyn / sqladmin_v1beta4.projects.instances.html
blob: b64e163bfd0f9db88adc70a8631b6eca0dd012f7 [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">
84 <code><a href="#startExternalSync">startExternalSync(project, instance, syncMode=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 Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]87 <code><a href="#verifyExternalSyncSettings">verifyExternalSyncSettings(project, instance, syncMode=None, verifyConnectionOnly=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.
106 &quot;reschedule&quot;: { # Required. The type of the reschedule the user wants.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]107 &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*.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]108 &quot;rescheduleType&quot;: &quot;A String&quot;, # Required. The type of the reschedule.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]109 },
110 }
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 Automation Bot0d561ef2020-11-25 07:50:41 -0800[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. Next field: 18
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]121 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]122 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]123 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]124 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
125 &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.
126 &quot;database&quot;: &quot;A String&quot;, # The target database for the import. If *fileType* is *SQL*, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If *fileType* is *CSV*, one database must be specified.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]127 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
128 &quot;encryptionOptions&quot;: {
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]129 &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^]130 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
131 &quot;certPath&quot;: &quot;A String&quot;, # Path to the Certificate (.cer) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]132 },
133 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]134 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#importContext*.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]135 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]136 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
137 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
138 &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.
139 &quot;A String&quot;,
140 ],
141 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]142 },
143 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
144 &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*
145 &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*.
146 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
147 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
148 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationErrors*.
149 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
150 { # Database instance operation error.
151 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationError*.
152 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
153 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
154 },
155 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]156 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]157 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]158 &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*.
159 &quot;name&quot;: &quot;A String&quot;, # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]160 &quot;endTime&quot;: &quot;A String&quot;, # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]161 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operation*.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]162 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]163 &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.
164 &quot;A String&quot;,
165 ],
166 &quot;uri&quot;: &quot;A String&quot;, # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form *gs: //bucketName/fileName*. If the file already exists, the requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]167 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.
168 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
169 },
170 &quot;offload&quot;: True or False, # Option for export offload.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]171 &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.
172 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#exportContext*.
173 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
174 &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.
175 &quot;A String&quot;,
176 ],
177 &quot;schemaOnly&quot;: True or False, # Export only schemas.
178 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
179 &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.
180 },
181 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]182 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]183 &quot;targetLink&quot;: &quot;A String&quot;,
184 &quot;backupContext&quot;: { # Backup context. # The context for backup operation, if applicable.
185 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#backupContext*.
186 &quot;backupId&quot;: &quot;A String&quot;, # The identifier of the backup.
187 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]188 }</pre>
189</div>
190
191<div class="method">
192 <code class="details" id="startExternalSync">startExternalSync(project, instance, syncMode=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]193 <pre>Start External primary instance migration.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]194
195Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]196 project: string, ID of the project that contains the instance. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]197 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]198 syncMode: string, External sync mode.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]199 Allowed values
200 EXTERNAL_SYNC_MODE_UNSPECIFIED - Unknown external sync mode, will be defaulted to ONLINE mode
201 ONLINE - Online external sync will set up replication after initial data external sync
202 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 -0700[diff] [blame]203 x__xgafv: string, V1 error format.
204 Allowed values
205 1 - v1 error format
206 2 - v2 error format
207
208Returns:
209 An object of the form:
210
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]211 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. Next field: 18
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]212 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]213 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]214 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]215 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
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.
217 &quot;database&quot;: &quot;A String&quot;, # The target database for the import. If *fileType* is *SQL*, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If *fileType* is *CSV*, one database must be specified.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]218 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
219 &quot;encryptionOptions&quot;: {
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]220 &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^]221 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
222 &quot;certPath&quot;: &quot;A String&quot;, # Path to the Certificate (.cer) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]223 },
224 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]225 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#importContext*.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]226 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]227 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
228 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
229 &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.
230 &quot;A String&quot;,
231 ],
232 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]233 },
234 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
235 &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*
236 &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*.
237 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
238 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
239 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationErrors*.
240 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
241 { # Database instance operation error.
242 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationError*.
243 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
244 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
245 },
246 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]247 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]248 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]249 &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*.
250 &quot;name&quot;: &quot;A String&quot;, # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]251 &quot;endTime&quot;: &quot;A String&quot;, # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]252 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operation*.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]253 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]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.
255 &quot;A String&quot;,
256 ],
257 &quot;uri&quot;: &quot;A String&quot;, # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form *gs: //bucketName/fileName*. If the file already exists, the requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]258 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.
259 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
260 },
261 &quot;offload&quot;: True or False, # Option for export offload.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]262 &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.
263 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#exportContext*.
264 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
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.
266 &quot;A String&quot;,
267 ],
268 &quot;schemaOnly&quot;: True or False, # Export only schemas.
269 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
270 &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.
271 },
272 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]273 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]274 &quot;targetLink&quot;: &quot;A String&quot;,
275 &quot;backupContext&quot;: { # Backup context. # The context for backup operation, if applicable.
276 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#backupContext*.
277 &quot;backupId&quot;: &quot;A String&quot;, # The identifier of the backup.
278 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]279 }</pre>
280</div>
281
282<div class="method">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]283 <code class="details" id="verifyExternalSyncSettings">verifyExternalSyncSettings(project, instance, syncMode=None, verifyConnectionOnly=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]284 <pre>Verify External primary instance external sync settings.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]285
286Args:
287 project: string, Project ID of the project that contains the instance. (required)
288 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]289 syncMode: string, External sync mode
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]290 Allowed values
291 EXTERNAL_SYNC_MODE_UNSPECIFIED - Unknown external sync mode, will be defaulted to ONLINE mode
292 ONLINE - Online external sync will set up replication after initial data external sync
293 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 -0800[diff] [blame^]294 verifyConnectionOnly: boolean, Flag to enable verifying connection only
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]295 x__xgafv: string, V1 error format.
296 Allowed values
297 1 - v1 error format
298 2 - v2 error format
299
300Returns:
301 An object of the form:
302
303 { # Instance verify external sync settings response.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]304 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#migrationSettingErrorList*.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]305 &quot;errors&quot;: [ # List of migration violations.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]306 { # External primary instance migration setting error.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]307 &quot;detail&quot;: &quot;A String&quot;, # Additional information about the error encountered.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]308 &quot;type&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
309 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#migrationSettingError*.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]310 },
311 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]312 }</pre>
313</div>
314
315</body></html>