| yoshi-code-bot | 1a4514d | 2021-07-13 00:20:24 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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_v1.html">Cloud SQL Admin API</a> . <a href="sqladmin_v1.projects.html">projects</a> . <a href="sqladmin_v1.projects.instances.html">instances</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| yoshi-code-bot | 1a4514d | 2021-07-13 00:20:24 -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"> |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -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> |
| yoshi-code-bot | 1a4514d | 2021-07-13 00:20:24 -0700 | [diff] [blame] | 83 | <p class="toc_element"> |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 84 | <code><a href="#startExternalSync">startExternalSync(project, instance, body=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 85 | <p class="firstline">Start External primary instance migration.</p> |
| yoshi-code-bot | 1a4514d | 2021-07-13 00:20:24 -0700 | [diff] [blame] | 86 | <p class="toc_element"> |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 87 | <code><a href="#verifyExternalSyncSettings">verifyExternalSyncSettings(project, instance, body=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 88 | <p class="firstline">Verify External primary instance external sync settings.</p> |
| yoshi-code-bot | 1a4514d | 2021-07-13 00:20:24 -0700 | [diff] [blame] | 89 | <h3>Method Details</h3> |
| 90 | <div class="method"> |
| 91 | <code class="details" id="close">close()</code> |
| 92 | <pre>Close httplib2 connections.</pre> |
| 93 | </div> |
| 94 | |
| 95 | <div class="method"> |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -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. |
| yoshi-code-bot | 1a4514d | 2021-07-13 00:20:24 -0700 | [diff] [blame] | 98 | |
| 99 | Args: |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 100 | project: string, ID of the project that contains the instance. (required) |
| yoshi-code-bot | 1a4514d | 2021-07-13 00:20:24 -0700 | [diff] [blame] | 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 | |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 105 | { # Reschedule options for maintenance windows. |
| 106 | "reschedule": { # Required. The type of the reschedule the user wants. |
| 107 | "rescheduleType": "A String", # Required. The type of the reschedule. |
| 108 | "scheduleTime": "A String", # 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 | }, |
| yoshi-code-bot | 1a4514d | 2021-07-13 00:20:24 -0700 | [diff] [blame] | 110 | } |
| 111 | |
| 112 | x__xgafv: string, V1 error format. |
| 113 | Allowed values |
| 114 | 1 - v1 error format |
| 115 | 2 - v2 error format |
| 116 | |
| 117 | Returns: |
| 118 | An object of the form: |
| 119 | |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -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. |
| 121 | "backupContext": { # Backup context. # The context for backup operation, if applicable. |
| 122 | "backupId": "A String", # The identifier of the backup. |
| 123 | "kind": "A String", # This is always **sql#backupContext**. |
| yoshi-code-bot | 1a4514d | 2021-07-13 00:20:24 -0700 | [diff] [blame] | 124 | }, |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 125 | "endTime": "A String", # 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**. |
| 126 | "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated. |
| 127 | "errors": [ # The list of errors encountered while processing this operation. |
| 128 | { # Database instance operation error. |
| 129 | "code": "A String", # Identifies the specific error that occurred. |
| 130 | "kind": "A String", # This is always **sql#operationError**. |
| 131 | "message": "A String", # Additional information about the error encountered. |
| 132 | }, |
| 133 | ], |
| 134 | "kind": "A String", # This is always **sql#operationErrors**. |
| 135 | }, |
| 136 | "exportContext": { # Database instance export context. # The context for export operation, if applicable. |
| 137 | "csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only. |
| 138 | "selectQuery": "A String", # The select query used to extract the data. |
| 139 | }, |
| 140 | "databases": [ # 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**. |
| 141 | "A String", |
| 142 | ], |
| 143 | "fileType": "A String", # 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. |
| 144 | "kind": "A String", # This is always **sql#exportContext**. |
| 145 | "offload": True or False, # Option for export offload. |
| 146 | "sqlExportOptions": { # Options for exporting data as SQL statements. |
| 147 | "mysqlExportOptions": { # Options for exporting from MySQL. |
| 148 | "masterData": 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. |
| 149 | }, |
| 150 | "schemaOnly": True or False, # Export only schemas. |
| 151 | "tables": [ # 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. |
| 152 | "A String", |
| 153 | ], |
| 154 | }, |
| 155 | "uri": "A String", # 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. |
| 156 | }, |
| 157 | "importContext": { # Database instance import context. # The context for import operation, if applicable. |
| 158 | "bakImportOptions": { # Import parameters specific to SQL Server .BAK files |
| 159 | "encryptionOptions": { |
| 160 | "certPath": "A String", # 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 | "pvkPassword": "A String", # Password that encrypts the private key |
| 162 | "pvkPath": "A String", # 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. |
| 163 | }, |
| 164 | }, |
| 165 | "csvImportOptions": { # Options for importing data as CSV. |
| 166 | "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. |
| 167 | "A String", |
| 168 | ], |
| 169 | "table": "A String", # The table to which CSV data is imported. |
| 170 | }, |
| 171 | "database": "A String", # 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 | "fileType": "A String", # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data. |
| 173 | "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only. |
| 174 | "kind": "A String", # This is always **sql#importContext**. |
| 175 | "uri": "A String", # 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. |
| 176 | }, |
| 177 | "insertTime": "A String", # 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**. |
| 178 | "kind": "A String", # This is always **sql#operation**. |
| 179 | "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. |
| 180 | "operationType": "A String", # 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 | "selfLink": "A String", # The URI of this resource. |
| 182 | "startTime": "A String", # 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**. |
| 183 | "status": "A String", # The status of an operation. Valid values are: **PENDING** **RUNNING** **DONE** **SQL_OPERATION_STATUS_UNSPECIFIED** |
| 184 | "targetId": "A String", # Name of the database instance related to this operation. |
| 185 | "targetLink": "A String", |
| 186 | "targetProject": "A String", # The project ID of the target instance related to this operation. |
| 187 | "user": "A String", # The email address of the user who initiated this operation. |
| yoshi-code-bot | 1a4514d | 2021-07-13 00:20:24 -0700 | [diff] [blame] | 188 | }</pre> |
| 189 | </div> |
| 190 | |
| 191 | <div class="method"> |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 192 | <code class="details" id="startExternalSync">startExternalSync(project, instance, body=None, x__xgafv=None)</code> |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 193 | <pre>Start External primary instance migration. |
| yoshi-code-bot | 1a4514d | 2021-07-13 00:20:24 -0700 | [diff] [blame] | 194 | |
| 195 | Args: |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 196 | project: string, ID of the project that contains the instance. (required) |
| 197 | instance: string, Cloud SQL instance ID. This does not include the project ID. (required) |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 198 | body: object, The request body. |
| 199 | The object takes the form of: |
| 200 | |
| 201 | { # Instance start external sync request. |
| 202 | "mysqlSyncConfig": { # MySQL-specific external server sync settings. # MySQL-specific settings for start external sync. |
| 203 | }, |
| 204 | "skipVerification": True or False, # Whether to skip the verification step (VESS). |
| 205 | "syncMode": "A String", # External sync mode. |
| 206 | } |
| 207 | |
| yoshi-code-bot | 1a4514d | 2021-07-13 00:20:24 -0700 | [diff] [blame] | 208 | x__xgafv: string, V1 error format. |
| 209 | Allowed values |
| 210 | 1 - v1 error format |
| 211 | 2 - v2 error format |
| 212 | |
| 213 | Returns: |
| 214 | An object of the form: |
| 215 | |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 216 | { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. |
| 217 | "backupContext": { # Backup context. # The context for backup operation, if applicable. |
| 218 | "backupId": "A String", # The identifier of the backup. |
| 219 | "kind": "A String", # This is always **sql#backupContext**. |
| yoshi-code-bot | 1a4514d | 2021-07-13 00:20:24 -0700 | [diff] [blame] | 220 | }, |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 221 | "endTime": "A String", # 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**. |
| 222 | "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated. |
| 223 | "errors": [ # The list of errors encountered while processing this operation. |
| 224 | { # Database instance operation error. |
| 225 | "code": "A String", # Identifies the specific error that occurred. |
| 226 | "kind": "A String", # This is always **sql#operationError**. |
| 227 | "message": "A String", # Additional information about the error encountered. |
| yoshi-code-bot | 1a4514d | 2021-07-13 00:20:24 -0700 | [diff] [blame] | 228 | }, |
| 229 | ], |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 230 | "kind": "A String", # This is always **sql#operationErrors**. |
| 231 | }, |
| 232 | "exportContext": { # Database instance export context. # The context for export operation, if applicable. |
| 233 | "csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only. |
| 234 | "selectQuery": "A String", # The select query used to extract the data. |
| yoshi-code-bot | 1a4514d | 2021-07-13 00:20:24 -0700 | [diff] [blame] | 235 | }, |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 236 | "databases": [ # 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**. |
| 237 | "A String", |
| 238 | ], |
| 239 | "fileType": "A String", # 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. |
| 240 | "kind": "A String", # This is always **sql#exportContext**. |
| 241 | "offload": True or False, # Option for export offload. |
| 242 | "sqlExportOptions": { # Options for exporting data as SQL statements. |
| 243 | "mysqlExportOptions": { # Options for exporting from MySQL. |
| 244 | "masterData": 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. |
| 245 | }, |
| 246 | "schemaOnly": True or False, # Export only schemas. |
| 247 | "tables": [ # 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. |
| 248 | "A String", |
| yoshi-code-bot | 1a4514d | 2021-07-13 00:20:24 -0700 | [diff] [blame] | 249 | ], |
| yoshi-code-bot | 1a4514d | 2021-07-13 00:20:24 -0700 | [diff] [blame] | 250 | }, |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 251 | "uri": "A String", # 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-code-bot | 1a4514d | 2021-07-13 00:20:24 -0700 | [diff] [blame] | 252 | }, |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 253 | "importContext": { # Database instance import context. # The context for import operation, if applicable. |
| 254 | "bakImportOptions": { # Import parameters specific to SQL Server .BAK files |
| 255 | "encryptionOptions": { |
| 256 | "certPath": "A String", # 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. |
| 257 | "pvkPassword": "A String", # Password that encrypts the private key |
| 258 | "pvkPath": "A String", # 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. |
| 259 | }, |
| 260 | }, |
| 261 | "csvImportOptions": { # Options for importing data as CSV. |
| 262 | "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. |
| 263 | "A String", |
| 264 | ], |
| 265 | "table": "A String", # The table to which CSV data is imported. |
| 266 | }, |
| 267 | "database": "A String", # 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. |
| 268 | "fileType": "A String", # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data. |
| 269 | "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only. |
| 270 | "kind": "A String", # This is always **sql#importContext**. |
| 271 | "uri": "A String", # 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. |
| 272 | }, |
| 273 | "insertTime": "A String", # 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**. |
| 274 | "kind": "A String", # This is always **sql#operation**. |
| 275 | "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. |
| 276 | "operationType": "A String", # 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** |
| 277 | "selfLink": "A String", # The URI of this resource. |
| 278 | "startTime": "A String", # 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**. |
| 279 | "status": "A String", # The status of an operation. Valid values are: **PENDING** **RUNNING** **DONE** **SQL_OPERATION_STATUS_UNSPECIFIED** |
| 280 | "targetId": "A String", # Name of the database instance related to this operation. |
| 281 | "targetLink": "A String", |
| 282 | "targetProject": "A String", # The project ID of the target instance related to this operation. |
| 283 | "user": "A String", # The email address of the user who initiated this operation. |
| yoshi-code-bot | 1a4514d | 2021-07-13 00:20:24 -0700 | [diff] [blame] | 284 | }</pre> |
| 285 | </div> |
| 286 | |
| 287 | <div class="method"> |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 288 | <code class="details" id="verifyExternalSyncSettings">verifyExternalSyncSettings(project, instance, body=None, x__xgafv=None)</code> |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 289 | <pre>Verify External primary instance external sync settings. |
| yoshi-code-bot | 1a4514d | 2021-07-13 00:20:24 -0700 | [diff] [blame] | 290 | |
| 291 | Args: |
| 292 | project: string, Project ID of the project that contains the instance. (required) |
| 293 | instance: string, Cloud SQL instance ID. This does not include the project ID. (required) |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 294 | body: object, The request body. |
| 295 | The object takes the form of: |
| 296 | |
| 297 | { # Instance verify external sync settings request. |
| 298 | "mysqlSyncConfig": { # MySQL-specific external server sync settings. # Optional. MySQL-specific settings for start external sync. |
| 299 | }, |
| 300 | "syncMode": "A String", # External sync mode |
| 301 | "verifyConnectionOnly": True or False, # Flag to enable verifying connection only |
| 302 | } |
| 303 | |
| yoshi-code-bot | 1a4514d | 2021-07-13 00:20:24 -0700 | [diff] [blame] | 304 | x__xgafv: string, V1 error format. |
| 305 | Allowed values |
| 306 | 1 - v1 error format |
| 307 | 2 - v2 error format |
| 308 | |
| 309 | Returns: |
| 310 | An object of the form: |
| 311 | |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 312 | { # Instance verify external sync settings response. |
| 313 | "errors": [ # List of migration violations. |
| 314 | { # External primary instance migration setting error. |
| 315 | "detail": "A String", # Additional information about the error encountered. |
| 316 | "kind": "A String", # Can be *sql#externalSyncSettingError* or *sql#externalSyncSettingWarning*. |
| 317 | "type": "A String", # Identifies the specific error that occurred. |
| yoshi-code-bot | 1a4514d | 2021-07-13 00:20:24 -0700 | [diff] [blame] | 318 | }, |
| 319 | ], |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 320 | "kind": "A String", # This is always *sql#migrationSettingErrorList*. |
| 321 | "warnings": [ # List of migration warnings. |
| 322 | { # External primary instance migration setting error. |
| 323 | "detail": "A String", # Additional information about the error encountered. |
| 324 | "kind": "A String", # Can be *sql#externalSyncSettingError* or *sql#externalSyncSettingWarning*. |
| 325 | "type": "A String", # Identifies the specific error that occurred. |
| 326 | }, |
| 327 | ], |
| yoshi-code-bot | 1a4514d | 2021-07-13 00:20:24 -0700 | [diff] [blame] | 328 | }</pre> |
| 329 | </div> |
| 330 | |
| 331 | </body></html> |