-
Notifications
You must be signed in to change notification settings - Fork 2.4k
/
sqladmin_v1.instances.html
4257 lines (4106 loc) 路 451 KB
/
sqladmin_v1.instances.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="sqladmin_v1.html">Cloud SQL Admin API</a> . <a href="sqladmin_v1.instances.html">instances</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#acquireSsrsLease">acquireSsrsLease(project, instance, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Acquire a lease for the setup of SQL Server Reporting Services (SSRS).</p>
<p class="toc_element">
<code><a href="#addServerCa">addServerCa(project, instance, x__xgafv=None)</a></code></p>
<p class="firstline">Adds a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in.</p>
<p class="toc_element">
<code><a href="#clone">clone(project, instance, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a Cloud SQL instance as a clone of the source instance. Using this operation might cause your instance to restart.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#delete">delete(project, instance, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a Cloud SQL instance.</p>
<p class="toc_element">
<code><a href="#demote">demote(project, instance, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Demotes an existing standalone instance to be a Cloud SQL read replica for an external database server.</p>
<p class="toc_element">
<code><a href="#demoteMaster">demoteMaster(project, instance, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Demotes the stand-alone instance to be a Cloud SQL read replica for an external database server.</p>
<p class="toc_element">
<code><a href="#export">export(project, instance, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL dump or CSV file.</p>
<p class="toc_element">
<code><a href="#failover">failover(project, instance, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Initiates a manual failover of a high availability (HA) primary instance to a standby instance, which becomes the primary instance. Users are then rerouted to the new primary. For more information, see the [Overview of high availability](https://cloud.google.com/sql/docs/mysql/high-availability) page in the Cloud SQL documentation. If using Legacy HA (MySQL only), this causes the instance to failover to its failover replica instance.</p>
<p class="toc_element">
<code><a href="#get">get(project, instance, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a resource containing information about a Cloud SQL instance.</p>
<p class="toc_element">
<code><a href="#import_">import_(project, instance, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Imports data into a Cloud SQL instance from a SQL dump or CSV file in Cloud Storage.</p>
<p class="toc_element">
<code><a href="#insert">insert(project, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new Cloud SQL instance.</p>
<p class="toc_element">
<code><a href="#list">list(project, filter=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists instances under a given project.</p>
<p class="toc_element">
<code><a href="#listServerCas">listServerCas(project, instance, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all of the trusted Certificate Authorities (CAs) for the specified instance. There can be up to three CAs listed: the CA that was used to sign the certificate that is currently in use, a CA that has been added but not yet used to sign a certificate, and a CA used to sign a certificate that has previously rotated out.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(project, instance, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Partially updates settings of a Cloud SQL instance by merging the request with the current configuration. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#promoteReplica">promoteReplica(project, instance, failover=None, x__xgafv=None)</a></code></p>
<p class="firstline">Promotes the read replica instance to be a stand-alone Cloud SQL instance. Using this operation might cause your instance to restart.</p>
<p class="toc_element">
<code><a href="#reencrypt">reencrypt(project, instance, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Reencrypt CMEK instance with latest key version.</p>
<p class="toc_element">
<code><a href="#releaseSsrsLease">releaseSsrsLease(project, instance, x__xgafv=None)</a></code></p>
<p class="firstline">Release a lease for the setup of SQL Server Reporting Services (SSRS).</p>
<p class="toc_element">
<code><a href="#resetSslConfig">resetSslConfig(project, instance, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes all client certificates and generates a new server SSL certificate for the instance.</p>
<p class="toc_element">
<code><a href="#restart">restart(project, instance, x__xgafv=None)</a></code></p>
<p class="firstline">Restarts a Cloud SQL instance.</p>
<p class="toc_element">
<code><a href="#restoreBackup">restoreBackup(project, instance, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Restores a backup of a Cloud SQL instance. Using this operation might cause your instance to restart.</p>
<p class="toc_element">
<code><a href="#rotateServerCa">rotateServerCa(project, instance, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method.</p>
<p class="toc_element">
<code><a href="#startReplica">startReplica(project, instance, x__xgafv=None)</a></code></p>
<p class="firstline">Starts the replication in the read replica instance.</p>
<p class="toc_element">
<code><a href="#stopReplica">stopReplica(project, instance, x__xgafv=None)</a></code></p>
<p class="firstline">Stops the replication in the read replica instance.</p>
<p class="toc_element">
<code><a href="#switchover">switchover(project, instance, dbTimeout=None, x__xgafv=None)</a></code></p>
<p class="firstline">Switches over from the primary instance to the replica instance.</p>
<p class="toc_element">
<code><a href="#truncateLog">truncateLog(project, instance, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Truncate MySQL general and slow query log tables MySQL only.</p>
<p class="toc_element">
<code><a href="#update">update(project, instance, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates settings of a Cloud SQL instance. Using this operation might cause your instance to restart.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="acquireSsrsLease">acquireSsrsLease(project, instance, body=None, x__xgafv=None)</code>
<pre>Acquire a lease for the setup of SQL Server Reporting Services (SSRS).
Args:
project: string, Required. Project ID of the project that contains the instance (Example: project-id). (required)
instance: string, Required. Cloud SQL instance ID. This doesn't include the project ID. It's composed of lowercase letters, numbers, and hyphens, and it must start with a letter. The total length must be 98 characters or less (Example: instance-id). (required)
body: object, The request body.
The object takes the form of:
{ # Request to acquire a lease for SSRS.
"acquireSsrsLeaseContext": { # Acquire SSRS lease context. # Contains details about the acquire SSRS lease operation.
"duration": "A String", # Lease duration needed for SSRS setup.
"reportDatabase": "A String", # The report database to be used for SSRS setup.
"serviceLogin": "A String", # The username to be used as the service login to connect to the report database for SSRS setup.
"setupLogin": "A String", # The username to be used as the setup login to connect to the database server for SSRS setup.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for the acquire SSRS lease request.
"operationId": "A String", # The unique identifier for this operation.
}</pre>
</div>
<div class="method">
<code class="details" id="addServerCa">addServerCa(project, instance, x__xgafv=None)</code>
<pre>Adds a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in.
Args:
project: string, Project ID of the project that contains the instance. (required)
instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
"acquireSsrsLeaseContext": { # Acquire SSRS lease context. # The context for acquire SSRS lease operation, if applicable.
"duration": "A String", # Lease duration needed for SSRS setup.
"reportDatabase": "A String", # The report database to be used for SSRS setup.
"serviceLogin": "A String", # The username to be used as the service login to connect to the report database for SSRS setup.
"setupLogin": "A String", # The username to be used as the setup login to connect to the database server for SSRS setup.
},
"apiWarning": { # An Admin API warning message. # An Admin API warning message.
"code": "A String", # Code to uniquely identify the warning type.
"message": "A String", # The warning message.
"region": "A String", # The region name for REGION_UNREACHABLE warning.
},
"backupContext": { # Backup context. # The context for backup operation, if applicable.
"backupId": "A String", # The identifier of the backup.
"kind": "A String", # This is always `sql#backupContext`.
},
"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`.
"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"code": "A String", # Identifies the specific error that occurred.
"kind": "A String", # This is always `sql#operationError`.
"message": "A String", # Additional information about the error encountered.
},
],
"kind": "A String", # This is always `sql#operationErrors`.
},
"exportContext": { # Database instance export context. # The context for export operation, if applicable.
"bakExportOptions": { # Options for exporting BAK files (SQL Server-only)
"bakType": "A String", # Type of this bak file will be export, FULL or DIFF, SQL Server only
"copyOnly": True or False, # Deprecated: copy_only is deprecated. Use differential_base instead
"differentialBase": True or False, # Whether or not the backup can be used as a differential base copy_only backup can not be served as differential base
"stripeCount": 42, # Option for specifying how many stripes to use for the export. If blank, and the value of the striped field is true, the number of stripes is automatically chosen.
"striped": True or False, # Whether or not the export should be striped.
},
"csvExportOptions": { # Options for exporting data as CSV. `MySQL` and `PostgreSQL` instances only.
"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.
"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.
"linesTerminatedBy": "A String", # 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.
"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.
"selectQuery": "A String", # The select query used to extract the data.
},
"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`.
"A String",
],
"fileType": "A String", # The file type for the specified uri.
"kind": "A String", # This is always `sql#exportContext`.
"offload": True or False, # Option for export offload.
"sqlExportOptions": { # Options for exporting data as SQL statements.
"mysqlExportOptions": { # Options for exporting from MySQL.
"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.
},
"parallel": True or False, # Optional. Whether or not the export should be parallel.
"schemaOnly": True or False, # Export only schemas.
"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.
"A String",
],
"threads": 42, # Optional. The number of threads to use for parallel export.
},
"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.
},
"importContext": { # Database instance import context. # The context for import operation, if applicable.
"bakImportOptions": { # Import parameters specific to SQL Server .BAK files
"bakType": "A String", # Type of the bak content, FULL or DIFF
"encryptionOptions": {
"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.
"pvkPassword": "A String", # Password that encrypts the private key
"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.
},
"noRecovery": True or False, # Whether or not the backup importing will restore database with NORECOVERY option Applies only to Cloud SQL for SQL Server.
"recoveryOnly": True or False, # Whether or not the backup importing request will just bring database online without downloading Bak content only one of "no_recovery" and "recovery_only" can be true otherwise error will return. Applies only to Cloud SQL for SQL Server.
"stopAt": "A String", # Optional. The timestamp when the import should stop. This timestamp is in the [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`). This field is equivalent to the STOPAT keyword and applies to Cloud SQL for SQL Server only.
"stopAtMark": "A String", # Optional. The marked transaction where the import should stop. This field is equivalent to the STOPATMARK keyword and applies to Cloud SQL for SQL Server only.
"striped": True or False, # Whether or not the backup set being restored is striped. Applies only to Cloud SQL for SQL Server.
},
"csvImportOptions": { # Options for importing data as CSV.
"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
"A String",
],
"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.
"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.
"linesTerminatedBy": "A String", # 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.
"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.
"table": "A String", # The table to which CSV data is imported.
},
"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.
"fileType": "A String", # The file type for the specified uri.\`SQL`: The file contains SQL statements. \`CSV`: The file contains CSV data.
"importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
"kind": "A String", # This is always `sql#importContext`.
"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.
},
"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`.
"kind": "A String", # This is always `sql#operation`.
"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.
"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`
"selfLink": "A String", # The URI of this resource.
"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`.
"status": "A String", # The status of an operation.
"targetId": "A String", # Name of the database instance related to this operation.
"targetLink": "A String",
"targetProject": "A String", # The project ID of the target instance related to this operation.
"user": "A String", # The email address of the user who initiated this operation.
}</pre>
</div>
<div class="method">
<code class="details" id="clone">clone(project, instance, body=None, x__xgafv=None)</code>
<pre>Creates a Cloud SQL instance as a clone of the source instance. Using this operation might cause your instance to restart.
Args:
project: string, Project ID of the source as well as the clone Cloud SQL instance. (required)
instance: string, The ID of the Cloud SQL instance to be cloned (source). This does not include the project ID. (required)
body: object, The request body.
The object takes the form of:
{ # Database instance clone request.
"cloneContext": { # Database instance clone context. # Contains details about the clone operation.
"allocatedIpRange": "A String", # The name of the allocated ip range for the private ip Cloud SQL instance. For example: "google-managed-services-default". If set, the cloned instance ip will be created in the allocated range. The range name must comply with [RFC 1035](https://tools.ietf.org/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. Reserved for future use.
"binLogCoordinates": { # Binary log coordinates. # Binary log coordinates, if specified, identify the position up to which the source instance is cloned. If not specified, the source instance is cloned up to the most recent binary log coordinates.
"binLogFileName": "A String", # Name of the binary log file for a Cloud SQL instance.
"binLogPosition": "A String", # Position (offset) within the binary log file.
"kind": "A String", # This is always `sql#binLogCoordinates`.
},
"databaseNames": [ # (SQL Server only) Clone only the specified databases from the source instance. Clone all databases if empty.
"A String",
],
"destinationInstanceName": "A String", # Name of the Cloud SQL instance to be created as a clone.
"kind": "A String", # This is always `sql#cloneContext`.
"pitrTimestampMs": "A String", # Reserved for future use.
"pointInTime": "A String", # Timestamp, if specified, identifies the time to which the source instance is cloned.
"preferredZone": "A String", # Optional. (Point-in-time recovery for PostgreSQL only) Clone to an instance in the specified zone. If no zone is specified, clone to the same zone as the source instance.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
"acquireSsrsLeaseContext": { # Acquire SSRS lease context. # The context for acquire SSRS lease operation, if applicable.
"duration": "A String", # Lease duration needed for SSRS setup.
"reportDatabase": "A String", # The report database to be used for SSRS setup.
"serviceLogin": "A String", # The username to be used as the service login to connect to the report database for SSRS setup.
"setupLogin": "A String", # The username to be used as the setup login to connect to the database server for SSRS setup.
},
"apiWarning": { # An Admin API warning message. # An Admin API warning message.
"code": "A String", # Code to uniquely identify the warning type.
"message": "A String", # The warning message.
"region": "A String", # The region name for REGION_UNREACHABLE warning.
},
"backupContext": { # Backup context. # The context for backup operation, if applicable.
"backupId": "A String", # The identifier of the backup.
"kind": "A String", # This is always `sql#backupContext`.
},
"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`.
"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"code": "A String", # Identifies the specific error that occurred.
"kind": "A String", # This is always `sql#operationError`.
"message": "A String", # Additional information about the error encountered.
},
],
"kind": "A String", # This is always `sql#operationErrors`.
},
"exportContext": { # Database instance export context. # The context for export operation, if applicable.
"bakExportOptions": { # Options for exporting BAK files (SQL Server-only)
"bakType": "A String", # Type of this bak file will be export, FULL or DIFF, SQL Server only
"copyOnly": True or False, # Deprecated: copy_only is deprecated. Use differential_base instead
"differentialBase": True or False, # Whether or not the backup can be used as a differential base copy_only backup can not be served as differential base
"stripeCount": 42, # Option for specifying how many stripes to use for the export. If blank, and the value of the striped field is true, the number of stripes is automatically chosen.
"striped": True or False, # Whether or not the export should be striped.
},
"csvExportOptions": { # Options for exporting data as CSV. `MySQL` and `PostgreSQL` instances only.
"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.
"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.
"linesTerminatedBy": "A String", # 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.
"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.
"selectQuery": "A String", # The select query used to extract the data.
},
"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`.
"A String",
],
"fileType": "A String", # The file type for the specified uri.
"kind": "A String", # This is always `sql#exportContext`.
"offload": True or False, # Option for export offload.
"sqlExportOptions": { # Options for exporting data as SQL statements.
"mysqlExportOptions": { # Options for exporting from MySQL.
"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.
},
"parallel": True or False, # Optional. Whether or not the export should be parallel.
"schemaOnly": True or False, # Export only schemas.
"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.
"A String",
],
"threads": 42, # Optional. The number of threads to use for parallel export.
},
"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.
},
"importContext": { # Database instance import context. # The context for import operation, if applicable.
"bakImportOptions": { # Import parameters specific to SQL Server .BAK files
"bakType": "A String", # Type of the bak content, FULL or DIFF
"encryptionOptions": {
"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.
"pvkPassword": "A String", # Password that encrypts the private key
"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.
},
"noRecovery": True or False, # Whether or not the backup importing will restore database with NORECOVERY option Applies only to Cloud SQL for SQL Server.
"recoveryOnly": True or False, # Whether or not the backup importing request will just bring database online without downloading Bak content only one of "no_recovery" and "recovery_only" can be true otherwise error will return. Applies only to Cloud SQL for SQL Server.
"stopAt": "A String", # Optional. The timestamp when the import should stop. This timestamp is in the [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`). This field is equivalent to the STOPAT keyword and applies to Cloud SQL for SQL Server only.
"stopAtMark": "A String", # Optional. The marked transaction where the import should stop. This field is equivalent to the STOPATMARK keyword and applies to Cloud SQL for SQL Server only.
"striped": True or False, # Whether or not the backup set being restored is striped. Applies only to Cloud SQL for SQL Server.
},
"csvImportOptions": { # Options for importing data as CSV.
"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
"A String",
],
"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.
"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.
"linesTerminatedBy": "A String", # 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.
"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.
"table": "A String", # The table to which CSV data is imported.
},
"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.
"fileType": "A String", # The file type for the specified uri.\`SQL`: The file contains SQL statements. \`CSV`: The file contains CSV data.
"importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
"kind": "A String", # This is always `sql#importContext`.
"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.
},
"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`.
"kind": "A String", # This is always `sql#operation`.
"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.
"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`
"selfLink": "A String", # The URI of this resource.
"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`.
"status": "A String", # The status of an operation.
"targetId": "A String", # Name of the database instance related to this operation.
"targetLink": "A String",
"targetProject": "A String", # The project ID of the target instance related to this operation.
"user": "A String", # The email address of the user who initiated this operation.
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(project, instance, x__xgafv=None)</code>
<pre>Deletes a Cloud SQL instance.
Args:
project: string, Project ID of the project that contains the instance to be deleted. (required)
instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
"acquireSsrsLeaseContext": { # Acquire SSRS lease context. # The context for acquire SSRS lease operation, if applicable.
"duration": "A String", # Lease duration needed for SSRS setup.
"reportDatabase": "A String", # The report database to be used for SSRS setup.
"serviceLogin": "A String", # The username to be used as the service login to connect to the report database for SSRS setup.
"setupLogin": "A String", # The username to be used as the setup login to connect to the database server for SSRS setup.
},
"apiWarning": { # An Admin API warning message. # An Admin API warning message.
"code": "A String", # Code to uniquely identify the warning type.
"message": "A String", # The warning message.
"region": "A String", # The region name for REGION_UNREACHABLE warning.
},
"backupContext": { # Backup context. # The context for backup operation, if applicable.
"backupId": "A String", # The identifier of the backup.
"kind": "A String", # This is always `sql#backupContext`.
},
"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`.
"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"code": "A String", # Identifies the specific error that occurred.
"kind": "A String", # This is always `sql#operationError`.
"message": "A String", # Additional information about the error encountered.
},
],
"kind": "A String", # This is always `sql#operationErrors`.
},
"exportContext": { # Database instance export context. # The context for export operation, if applicable.
"bakExportOptions": { # Options for exporting BAK files (SQL Server-only)
"bakType": "A String", # Type of this bak file will be export, FULL or DIFF, SQL Server only
"copyOnly": True or False, # Deprecated: copy_only is deprecated. Use differential_base instead
"differentialBase": True or False, # Whether or not the backup can be used as a differential base copy_only backup can not be served as differential base
"stripeCount": 42, # Option for specifying how many stripes to use for the export. If blank, and the value of the striped field is true, the number of stripes is automatically chosen.
"striped": True or False, # Whether or not the export should be striped.
},
"csvExportOptions": { # Options for exporting data as CSV. `MySQL` and `PostgreSQL` instances only.
"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.
"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.
"linesTerminatedBy": "A String", # 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.
"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.
"selectQuery": "A String", # The select query used to extract the data.
},
"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`.
"A String",
],
"fileType": "A String", # The file type for the specified uri.
"kind": "A String", # This is always `sql#exportContext`.
"offload": True or False, # Option for export offload.
"sqlExportOptions": { # Options for exporting data as SQL statements.
"mysqlExportOptions": { # Options for exporting from MySQL.
"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.
},
"parallel": True or False, # Optional. Whether or not the export should be parallel.
"schemaOnly": True or False, # Export only schemas.
"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.
"A String",
],
"threads": 42, # Optional. The number of threads to use for parallel export.
},
"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.
},
"importContext": { # Database instance import context. # The context for import operation, if applicable.
"bakImportOptions": { # Import parameters specific to SQL Server .BAK files
"bakType": "A String", # Type of the bak content, FULL or DIFF
"encryptionOptions": {
"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.
"pvkPassword": "A String", # Password that encrypts the private key
"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.
},
"noRecovery": True or False, # Whether or not the backup importing will restore database with NORECOVERY option Applies only to Cloud SQL for SQL Server.
"recoveryOnly": True or False, # Whether or not the backup importing request will just bring database online without downloading Bak content only one of "no_recovery" and "recovery_only" can be true otherwise error will return. Applies only to Cloud SQL for SQL Server.
"stopAt": "A String", # Optional. The timestamp when the import should stop. This timestamp is in the [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`). This field is equivalent to the STOPAT keyword and applies to Cloud SQL for SQL Server only.
"stopAtMark": "A String", # Optional. The marked transaction where the import should stop. This field is equivalent to the STOPATMARK keyword and applies to Cloud SQL for SQL Server only.
"striped": True or False, # Whether or not the backup set being restored is striped. Applies only to Cloud SQL for SQL Server.
},
"csvImportOptions": { # Options for importing data as CSV.
"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
"A String",
],
"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.
"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.
"linesTerminatedBy": "A String", # 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.
"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.
"table": "A String", # The table to which CSV data is imported.
},
"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.
"fileType": "A String", # The file type for the specified uri.\`SQL`: The file contains SQL statements. \`CSV`: The file contains CSV data.
"importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
"kind": "A String", # This is always `sql#importContext`.
"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.
},
"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`.
"kind": "A String", # This is always `sql#operation`.
"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.
"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`
"selfLink": "A String", # The URI of this resource.
"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`.
"status": "A String", # The status of an operation.
"targetId": "A String", # Name of the database instance related to this operation.
"targetLink": "A String",
"targetProject": "A String", # The project ID of the target instance related to this operation.
"user": "A String", # The email address of the user who initiated this operation.
}</pre>
</div>
<div class="method">
<code class="details" id="demote">demote(project, instance, body=None, x__xgafv=None)</code>
<pre>Demotes an existing standalone instance to be a Cloud SQL read replica for an external database server.
Args:
project: string, Required. ID of the project that contains the instance. (required)
instance: string, Required. Cloud SQL instance name. (required)
body: object, The request body.
The object takes the form of:
{ # This request is used to demote an existing standalone instance to be a Cloud SQL read replica for an external database server.
"demoteContext": { # This context is used to demote an existing standalone instance to be a Cloud SQL read replica for an external database server. # Required. Contains details about the demote operation.
"kind": "A String", # This is always `sql#demoteContext`.
"sourceRepresentativeInstanceName": "A String", # Required. The name of the instance which acts as the on-premises primary instance in the replication setup.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
"acquireSsrsLeaseContext": { # Acquire SSRS lease context. # The context for acquire SSRS lease operation, if applicable.
"duration": "A String", # Lease duration needed for SSRS setup.
"reportDatabase": "A String", # The report database to be used for SSRS setup.
"serviceLogin": "A String", # The username to be used as the service login to connect to the report database for SSRS setup.
"setupLogin": "A String", # The username to be used as the setup login to connect to the database server for SSRS setup.
},
"apiWarning": { # An Admin API warning message. # An Admin API warning message.
"code": "A String", # Code to uniquely identify the warning type.
"message": "A String", # The warning message.
"region": "A String", # The region name for REGION_UNREACHABLE warning.
},
"backupContext": { # Backup context. # The context for backup operation, if applicable.
"backupId": "A String", # The identifier of the backup.
"kind": "A String", # This is always `sql#backupContext`.
},
"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`.
"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"code": "A String", # Identifies the specific error that occurred.
"kind": "A String", # This is always `sql#operationError`.
"message": "A String", # Additional information about the error encountered.
},
],
"kind": "A String", # This is always `sql#operationErrors`.
},
"exportContext": { # Database instance export context. # The context for export operation, if applicable.
"bakExportOptions": { # Options for exporting BAK files (SQL Server-only)
"bakType": "A String", # Type of this bak file will be export, FULL or DIFF, SQL Server only
"copyOnly": True or False, # Deprecated: copy_only is deprecated. Use differential_base instead
"differentialBase": True or False, # Whether or not the backup can be used as a differential base copy_only backup can not be served as differential base
"stripeCount": 42, # Option for specifying how many stripes to use for the export. If blank, and the value of the striped field is true, the number of stripes is automatically chosen.
"striped": True or False, # Whether or not the export should be striped.
},
"csvExportOptions": { # Options for exporting data as CSV. `MySQL` and `PostgreSQL` instances only.
"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.
"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.
"linesTerminatedBy": "A String", # 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.
"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.
"selectQuery": "A String", # The select query used to extract the data.
},
"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`.
"A String",
],
"fileType": "A String", # The file type for the specified uri.
"kind": "A String", # This is always `sql#exportContext`.
"offload": True or False, # Option for export offload.
"sqlExportOptions": { # Options for exporting data as SQL statements.
"mysqlExportOptions": { # Options for exporting from MySQL.
"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.
},
"parallel": True or False, # Optional. Whether or not the export should be parallel.
"schemaOnly": True or False, # Export only schemas.
"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.
"A String",
],
"threads": 42, # Optional. The number of threads to use for parallel export.
},
"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.
},
"importContext": { # Database instance import context. # The context for import operation, if applicable.
"bakImportOptions": { # Import parameters specific to SQL Server .BAK files
"bakType": "A String", # Type of the bak content, FULL or DIFF
"encryptionOptions": {
"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.
"pvkPassword": "A String", # Password that encrypts the private key
"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.
},
"noRecovery": True or False, # Whether or not the backup importing will restore database with NORECOVERY option Applies only to Cloud SQL for SQL Server.
"recoveryOnly": True or False, # Whether or not the backup importing request will just bring database online without downloading Bak content only one of "no_recovery" and "recovery_only" can be true otherwise error will return. Applies only to Cloud SQL for SQL Server.
"stopAt": "A String", # Optional. The timestamp when the import should stop. This timestamp is in the [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`). This field is equivalent to the STOPAT keyword and applies to Cloud SQL for SQL Server only.
"stopAtMark": "A String", # Optional. The marked transaction where the import should stop. This field is equivalent to the STOPATMARK keyword and applies to Cloud SQL for SQL Server only.
"striped": True or False, # Whether or not the backup set being restored is striped. Applies only to Cloud SQL for SQL Server.
},
"csvImportOptions": { # Options for importing data as CSV.
"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
"A String",
],
"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.
"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.
"linesTerminatedBy": "A String", # 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.
"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.
"table": "A String", # The table to which CSV data is imported.
},
"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.
"fileType": "A String", # The file type for the specified uri.\`SQL`: The file contains SQL statements. \`CSV`: The file contains CSV data.
"importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
"kind": "A String", # This is always `sql#importContext`.
"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.
},
"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`.
"kind": "A String", # This is always `sql#operation`.
"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.
"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`
"selfLink": "A String", # The URI of this resource.
"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`.
"status": "A String", # The status of an operation.
"targetId": "A String", # Name of the database instance related to this operation.
"targetLink": "A String",
"targetProject": "A String", # The project ID of the target instance related to this operation.
"user": "A String", # The email address of the user who initiated this operation.
}</pre>
</div>
<div class="method">
<code class="details" id="demoteMaster">demoteMaster(project, instance, body=None, x__xgafv=None)</code>
<pre>Demotes the stand-alone instance to be a Cloud SQL read replica for an external database server.
Args:
project: string, ID of the project that contains the instance. (required)
instance: string, Cloud SQL instance name. (required)
body: object, The request body.
The object takes the form of:
{ # Database demote primary instance request.
"demoteMasterContext": { # Database instance demote primary instance context. # Contains details about the demoteMaster operation.
"kind": "A String", # This is always `sql#demoteMasterContext`.
"masterInstanceName": "A String", # The name of the instance which will act as on-premises primary instance in the replication setup.
"replicaConfiguration": { # Read-replica configuration for connecting to the on-premises primary instance. # Configuration specific to read-replicas replicating from the on-premises primary instance.
"kind": "A String", # This is always `sql#demoteMasterConfiguration`.
"mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # MySQL specific configuration when replicating from a MySQL on-premises primary instance. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named `master.info` in the data directory.
"caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
"clientCertificate": "A String", # PEM representation of the replica's x509 certificate.
"clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate. The format of the replica's private key can be either PKCS #1 or PKCS #8.
"kind": "A String", # This is always `sql#demoteMasterMysqlReplicaConfiguration`.
"password": "A String", # The password for the replication connection.
"username": "A String", # The username for the replication connection.
},
},
"skipReplicationSetup": True or False, # Flag to skip replication setup on the instance.
"verifyGtidConsistency": True or False, # Verify the GTID consistency for demote operation. Default value: `True`. Setting this flag to `false` enables you to bypass the GTID consistency check between on-premises primary instance and Cloud SQL instance during the demotion operation but also exposes you to the risk of future replication failures. Change the value only if you know the reason for the GTID divergence and are confident that doing so will not cause any replication issues.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
"acquireSsrsLeaseContext": { # Acquire SSRS lease context. # The context for acquire SSRS lease operation, if applicable.
"duration": "A String", # Lease duration needed for SSRS setup.
"reportDatabase": "A String", # The report database to be used for SSRS setup.
"serviceLogin": "A String", # The username to be used as the service login to connect to the report database for SSRS setup.
"setupLogin": "A String", # The username to be used as the setup login to connect to the database server for SSRS setup.
},
"apiWarning": { # An Admin API warning message. # An Admin API warning message.
"code": "A String", # Code to uniquely identify the warning type.
"message": "A String", # The warning message.
"region": "A String", # The region name for REGION_UNREACHABLE warning.
},
"backupContext": { # Backup context. # The context for backup operation, if applicable.
"backupId": "A String", # The identifier of the backup.
"kind": "A String", # This is always `sql#backupContext`.
},
"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`.
"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"code": "A String", # Identifies the specific error that occurred.
"kind": "A String", # This is always `sql#operationError`.
"message": "A String", # Additional information about the error encountered.
},
],
"kind": "A String", # This is always `sql#operationErrors`.
},
"exportContext": { # Database instance export context. # The context for export operation, if applicable.
"bakExportOptions": { # Options for exporting BAK files (SQL Server-only)
"bakType": "A String", # Type of this bak file will be export, FULL or DIFF, SQL Server only
"copyOnly": True or False, # Deprecated: copy_only is deprecated. Use differential_base instead
"differentialBase": True or False, # Whether or not the backup can be used as a differential base copy_only backup can not be served as differential base
"stripeCount": 42, # Option for specifying how many stripes to use for the export. If blank, and the value of the striped field is true, the number of stripes is automatically chosen.
"striped": True or False, # Whether or not the export should be striped.
},
"csvExportOptions": { # Options for exporting data as CSV. `MySQL` and `PostgreSQL` instances only.
"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.
"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.
"linesTerminatedBy": "A String", # 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.
"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.
"selectQuery": "A String", # The select query used to extract the data.
},
"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`.
"A String",
],
"fileType": "A String", # The file type for the specified uri.
"kind": "A String", # This is always `sql#exportContext`.
"offload": True or False, # Option for export offload.
"sqlExportOptions": { # Options for exporting data as SQL statements.
"mysqlExportOptions": { # Options for exporting from MySQL.
"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.
},
"parallel": True or False, # Optional. Whether or not the export should be parallel.
"schemaOnly": True or False, # Export only schemas.
"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.
"A String",
],
"threads": 42, # Optional. The number of threads to use for parallel export.
},
"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.
},
"importContext": { # Database instance import context. # The context for import operation, if applicable.
"bakImportOptions": { # Import parameters specific to SQL Server .BAK files
"bakType": "A String", # Type of the bak content, FULL or DIFF
"encryptionOptions": {
"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.
"pvkPassword": "A String", # Password that encrypts the private key
"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.
},
"noRecovery": True or False, # Whether or not the backup importing will restore database with NORECOVERY option Applies only to Cloud SQL for SQL Server.
"recoveryOnly": True or False, # Whether or not the backup importing request will just bring database online without downloading Bak content only one of "no_recovery" and "recovery_only" can be true otherwise error will return. Applies only to Cloud SQL for SQL Server.
"stopAt": "A String", # Optional. The timestamp when the import should stop. This timestamp is in the [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`). This field is equivalent to the STOPAT keyword and applies to Cloud SQL for SQL Server only.
"stopAtMark": "A String", # Optional. The marked transaction where the import should stop. This field is equivalent to the STOPATMARK keyword and applies to Cloud SQL for SQL Server only.
"striped": True or False, # Whether or not the backup set being restored is striped. Applies only to Cloud SQL for SQL Server.
},
"csvImportOptions": { # Options for importing data as CSV.
"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
"A String",
],
"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.
"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.
"linesTerminatedBy": "A String", # 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.
"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.
"table": "A String", # The table to which CSV data is imported.
},
"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.
"fileType": "A String", # The file type for the specified uri.\`SQL`: The file contains SQL statements. \`CSV`: The file contains CSV data.
"importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
"kind": "A String", # This is always `sql#importContext`.
"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.
},
"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`.
"kind": "A String", # This is always `sql#operation`.
"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.
"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`
"selfLink": "A String", # The URI of this resource.
"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`.
"status": "A String", # The status of an operation.
"targetId": "A String", # Name of the database instance related to this operation.
"targetLink": "A String",
"targetProject": "A String", # The project ID of the target instance related to this operation.
"user": "A String", # The email address of the user who initiated this operation.
}</pre>
</div>
<div class="method">
<code class="details" id="export">export(project, instance, body=None, x__xgafv=None)</code>
<pre>Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL dump or CSV file.
Args:
project: string, Project ID of the project that contains the instance to be exported. (required)
instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
body: object, The request body.
The object takes the form of:
{ # Database instance export request.
"exportContext": { # Database instance export context. # Contains details about the export operation.
"bakExportOptions": { # Options for exporting BAK files (SQL Server-only)
"bakType": "A String", # Type of this bak file will be export, FULL or DIFF, SQL Server only
"copyOnly": True or False, # Deprecated: copy_only is deprecated. Use differential_base instead
"differentialBase": True or False, # Whether or not the backup can be used as a differential base copy_only backup can not be served as differential base
"stripeCount": 42, # Option for specifying how many stripes to use for the export. If blank, and the value of the striped field is true, the number of stripes is automatically chosen.
"striped": True or False, # Whether or not the export should be striped.
},
"csvExportOptions": { # Options for exporting data as CSV. `MySQL` and `PostgreSQL` instances only.
"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.
"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.
"linesTerminatedBy": "A String", # 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.
"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.
"selectQuery": "A String", # The select query used to extract the data.
},
"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`.
"A String",
],
"fileType": "A String", # The file type for the specified uri.
"kind": "A String", # This is always `sql#exportContext`.
"offload": True or False, # Option for export offload.
"sqlExportOptions": { # Options for exporting data as SQL statements.
"mysqlExportOptions": { # Options for exporting from MySQL.
"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.
},
"parallel": True or False, # Optional. Whether or not the export should be parallel.
"schemaOnly": True or False, # Export only schemas.
"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.
"A String",
],
"threads": 42, # Optional. The number of threads to use for parallel export.
},
"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.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
"acquireSsrsLeaseContext": { # Acquire SSRS lease context. # The context for acquire SSRS lease operation, if applicable.
"duration": "A String", # Lease duration needed for SSRS setup.
"reportDatabase": "A String", # The report database to be used for SSRS setup.
"serviceLogin": "A String", # The username to be used as the service login to connect to the report database for SSRS setup.
"setupLogin": "A String", # The username to be used as the setup login to connect to the database server for SSRS setup.
},
"apiWarning": { # An Admin API warning message. # An Admin API warning message.
"code": "A String", # Code to uniquely identify the warning type.
"message": "A String", # The warning message.
"region": "A String", # The region name for REGION_UNREACHABLE warning.
},
"backupContext": { # Backup context. # The context for backup operation, if applicable.
"backupId": "A String", # The identifier of the backup.
"kind": "A String", # This is always `sql#backupContext`.
},
"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`.
"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"code": "A String", # Identifies the specific error that occurred.
"kind": "A String", # This is always `sql#operationError`.
"message": "A String", # Additional information about the error encountered.
},
],
"kind": "A String", # This is always `sql#operationErrors`.
},
"exportContext": { # Database instance export context. # The context for export operation, if applicable.
"bakExportOptions": { # Options for exporting BAK files (SQL Server-only)
"bakType": "A String", # Type of this bak file will be export, FULL or DIFF, SQL Server only
"copyOnly": True or False, # Deprecated: copy_only is deprecated. Use differential_base instead
"differentialBase": True or False, # Whether or not the backup can be used as a differential base copy_only backup can not be served as differential base
"stripeCount": 42, # Option for specifying how many stripes to use for the export. If blank, and the value of the striped field is true, the number of stripes is automatically chosen.
"striped": True or False, # Whether or not the export should be striped.
},
"csvExportOptions": { # Options for exporting data as CSV. `MySQL` and `PostgreSQL` instances only.
"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.
"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.
"linesTerminatedBy": "A String", # 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.
"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.
"selectQuery": "A String", # The select query used to extract the data.
},
"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`.
"A String",
],
"fileType": "A String", # The file type for the specified uri.
"kind": "A String", # This is always `sql#exportContext`.
"offload": True or False, # Option for export offload.
"sqlExportOptions": { # Options for exporting data as SQL statements.
"mysqlExportOptions": { # Options for exporting from MySQL.
"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.
},
"parallel": True or False, # Optional. Whether or not the export should be parallel.
"schemaOnly": True or False, # Export only schemas.
"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.
"A String",
],
"threads": 42, # Optional. The number of threads to use for parallel export.
},
"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.
},
"importContext": { # Database instance import context. # The context for import operation, if applicable.
"bakImportOptions": { # Import parameters specific to SQL Server .BAK files
"bakType": "A String", # Type of the bak content, FULL or DIFF
"encryptionOptions": {
"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.
"pvkPassword": "A String", # Password that encrypts the private key
"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.
},
"noRecovery": True or False, # Whether or not the backup importing will restore database with NORECOVERY option Applies only to Cloud SQL for SQL Server.
"recoveryOnly": True or False, # Whether or not the backup importing request will just bring database online without downloading Bak content only one of "no_recovery" and "recovery_only" can be true otherwise error will return. Applies only to Cloud SQL for SQL Server.
"stopAt": "A String", # Optional. The timestamp when the import should stop. This timestamp is in the [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`). This field is equivalent to the STOPAT keyword and applies to Cloud SQL for SQL Server only.
"stopAtMark": "A String", # Optional. The marked transaction where the import should stop. This field is equivalent to the STOPATMARK keyword and applies to Cloud SQL for SQL Server only.
"striped": True or False, # Whether or not the backup set being restored is striped. Applies only to Cloud SQL for SQL Server.
},
"csvImportOptions": { # Options for importing data as CSV.
"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
"A String",
],
"escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.
"fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.
"linesTerminatedBy": "A String", # 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.
"quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.
"table": "A String", # The table to which CSV data is imported.
},
"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.
"fileType": "A String", # The file type for the specified uri.\`SQL`: The file contains SQL statements. \`CSV`: The file contains CSV data.
"importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
"kind": "A String", # This is always `sql#importContext`.
"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.
},
"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`.