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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
|
<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="datastream_v1alpha1.html">Datastream API</a> . <a href="datastream_v1alpha1.projects.html">projects</a> . <a href="datastream_v1alpha1.projects.locations.html">locations</a> . <a href="datastream_v1alpha1.projects.locations.streams.html">streams</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="datastream_v1alpha1.projects.locations.streams.objects.html">objects()</a></code>
</p>
<p class="firstline">Returns the objects Resource.</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="#create">create(parent, body=None, force=None, requestId=None, streamId=None, validateOnly=None, x__xgafv=None)</a></code></p>
<p class="firstline">Use this method to create a stream.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Use this method to delete a stream.</p>
<p class="toc_element">
<code><a href="#fetchErrors">fetchErrors(stream, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Use this method to fetch any errors associated with a stream.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Use this method to get details about a stream.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Use this method to list streams in a project and location.</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(name, body=None, force=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)</a></code></p>
<p class="firstline">Use this method to update the configuration of a stream.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, force=None, requestId=None, streamId=None, validateOnly=None, x__xgafv=None)</code>
<pre>Use this method to create a stream.
Args:
parent: string, Required. The parent that owns the collection of streams. (required)
body: object, The request body.
The object takes the form of:
{
"backfillAll": { # Backfill strategy to automatically backfill the Stream's objects. Specific objects can be excluded. # Automatically backfill objects included in the stream source configuration. Specific objects can be excluded.
"mysqlExcludedObjects": { # MySQL database structure # MySQL data source objects to avoid backfilling.
"mysqlDatabases": [ # Mysql databases on the server
{ # MySQL database.
"databaseName": "A String", # Database name.
"mysqlTables": [ # Tables in the database.
{ # MySQL table.
"mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything.
{ # MySQL Column.
"collation": "A String", # Column collation.
"columnName": "A String", # Column name.
"dataType": "A String", # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"primaryKey": True or False, # Whether or not the column represents a primary key.
},
],
"tableName": "A String", # Table name.
},
],
},
],
},
"oracleExcludedObjects": { # Oracle database structure. # Oracle data source objects to avoid backfilling.
"oracleSchemas": [ # Oracle schemas/databases in the database server.
{ # Oracle schema.
"oracleTables": [ # Tables in the schema.
{ # Oracle table.
"oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything.
{ # Oracle Column.
"columnName": "A String", # Column name.
"dataType": "A String", # The Oracle data type.
"encoding": "A String", # Column encoding.
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"precision": 42, # Column precision.
"primaryKey": True or False, # Whether or not the column represents a primary key.
"scale": 42, # Column scale.
},
],
"tableName": "A String", # Table name.
},
],
"schemaName": "A String", # Schema name.
},
],
},
},
"backfillNone": { # Backfill strategy to disable automatic backfill for the Stream's objects. # Do not automatically backfill any objects.
},
"createTime": "A String", # Output only. The creation time of the stream.
"customerManagedEncryptionKey": "A String", # Immutable. A reference to a KMS encryption key. If provided, it will be used to encrypt the data. If left blank, data will be encrypted using an internal Stream-specific encryption key provisioned through KMS.
"destinationConfig": { # The configuration of the stream destination. # Required. Destination connection profile configuration.
"destinationConnectionProfileName": "A String", # Required. Destination connection profile identifier.
"gcsDestinationConfig": { # Google Cloud Storage destination configuration # GCS destination configuration.
"avroFileFormat": { # AVRO file format configuration. # AVRO file format configuration.
},
"fileRotationInterval": "A String", # The maximum duration for which new events are added before a file is closed and a new file is created.
"fileRotationMb": 42, # The maximum file size to be saved in the bucket.
"gcsFileFormat": "A String", # File format that data should be written in. Deprecated field (b/169501737) - use file_format instead.
"jsonFileFormat": { # JSON file format configuration. # JSON file format configuration.
"compression": "A String", # Compression of the loaded JSON file.
"schemaFileFormat": "A String", # The schema file format along JSON data files.
},
"path": "A String", # Path inside the Cloud Storage bucket to write data to.
},
},
"displayName": "A String", # Required. Display name.
"errors": [ # Output only. Errors on the Stream.
{ # Represent a user-facing Error.
"details": { # Additional information about the error.
"a_key": "A String",
},
"errorTime": "A String", # The time when the error occurred.
"errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
"message": "A String", # A message containing more information about the error that occurred.
"reason": "A String", # A title that explains the reason for the error.
},
],
"labels": { # Labels.
"a_key": "A String",
},
"name": "A String", # Output only. The stream's name.
"sourceConfig": { # The configuration of the stream source. # Required. Source connection profile configuration.
"mysqlSourceConfig": { # MySQL source configuration # MySQL data source configuration
"allowlist": { # MySQL database structure # MySQL objects to retrieve from the source.
"mysqlDatabases": [ # Mysql databases on the server
{ # MySQL database.
"databaseName": "A String", # Database name.
"mysqlTables": [ # Tables in the database.
{ # MySQL table.
"mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything.
{ # MySQL Column.
"collation": "A String", # Column collation.
"columnName": "A String", # Column name.
"dataType": "A String", # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"primaryKey": True or False, # Whether or not the column represents a primary key.
},
],
"tableName": "A String", # Table name.
},
],
},
],
},
"rejectlist": { # MySQL database structure # MySQL objects to exclude from the stream.
"mysqlDatabases": [ # Mysql databases on the server
{ # MySQL database.
"databaseName": "A String", # Database name.
"mysqlTables": [ # Tables in the database.
{ # MySQL table.
"mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything.
{ # MySQL Column.
"collation": "A String", # Column collation.
"columnName": "A String", # Column name.
"dataType": "A String", # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"primaryKey": True or False, # Whether or not the column represents a primary key.
},
],
"tableName": "A String", # Table name.
},
],
},
],
},
},
"oracleSourceConfig": { # Oracle data source configuration # Oracle data source configuration
"allowlist": { # Oracle database structure. # Oracle objects to include in the stream.
"oracleSchemas": [ # Oracle schemas/databases in the database server.
{ # Oracle schema.
"oracleTables": [ # Tables in the schema.
{ # Oracle table.
"oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything.
{ # Oracle Column.
"columnName": "A String", # Column name.
"dataType": "A String", # The Oracle data type.
"encoding": "A String", # Column encoding.
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"precision": 42, # Column precision.
"primaryKey": True or False, # Whether or not the column represents a primary key.
"scale": 42, # Column scale.
},
],
"tableName": "A String", # Table name.
},
],
"schemaName": "A String", # Schema name.
},
],
},
"dropLargeObjects": { # Configuration to drop large object values. # Drop large object values.
},
"rejectlist": { # Oracle database structure. # Oracle objects to exclude from the stream.
"oracleSchemas": [ # Oracle schemas/databases in the database server.
{ # Oracle schema.
"oracleTables": [ # Tables in the schema.
{ # Oracle table.
"oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything.
{ # Oracle Column.
"columnName": "A String", # Column name.
"dataType": "A String", # The Oracle data type.
"encoding": "A String", # Column encoding.
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"precision": 42, # Column precision.
"primaryKey": True or False, # Whether or not the column represents a primary key.
"scale": 42, # Column scale.
},
],
"tableName": "A String", # Table name.
},
],
"schemaName": "A String", # Schema name.
},
],
},
},
"sourceConnectionProfileName": "A String", # Required. Source connection profile identifier.
},
"state": "A String", # The state of the stream.
"updateTime": "A String", # Output only. The last update time of the stream.
}
force: boolean, Optional. Create the stream without validating it.
requestId: string, Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
streamId: string, Required. The stream identifier.
validateOnly: boolean, Optional. Only validate the stream, but do not create any resources. The default is false.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, requestId=None, x__xgafv=None)</code>
<pre>Use this method to delete a stream.
Args:
name: string, Required. The name of the stream resource to delete. (required)
requestId: string, Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="fetchErrors">fetchErrors(stream, body=None, x__xgafv=None)</code>
<pre>Use this method to fetch any errors associated with a stream.
Args:
stream: string, Name of the Stream resource for which to fetch any errors. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for 'FetchErrors' request.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Use this method to get details about a stream.
Args:
name: string, Required. The name of the stream resource to get. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"backfillAll": { # Backfill strategy to automatically backfill the Stream's objects. Specific objects can be excluded. # Automatically backfill objects included in the stream source configuration. Specific objects can be excluded.
"mysqlExcludedObjects": { # MySQL database structure # MySQL data source objects to avoid backfilling.
"mysqlDatabases": [ # Mysql databases on the server
{ # MySQL database.
"databaseName": "A String", # Database name.
"mysqlTables": [ # Tables in the database.
{ # MySQL table.
"mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything.
{ # MySQL Column.
"collation": "A String", # Column collation.
"columnName": "A String", # Column name.
"dataType": "A String", # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"primaryKey": True or False, # Whether or not the column represents a primary key.
},
],
"tableName": "A String", # Table name.
},
],
},
],
},
"oracleExcludedObjects": { # Oracle database structure. # Oracle data source objects to avoid backfilling.
"oracleSchemas": [ # Oracle schemas/databases in the database server.
{ # Oracle schema.
"oracleTables": [ # Tables in the schema.
{ # Oracle table.
"oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything.
{ # Oracle Column.
"columnName": "A String", # Column name.
"dataType": "A String", # The Oracle data type.
"encoding": "A String", # Column encoding.
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"precision": 42, # Column precision.
"primaryKey": True or False, # Whether or not the column represents a primary key.
"scale": 42, # Column scale.
},
],
"tableName": "A String", # Table name.
},
],
"schemaName": "A String", # Schema name.
},
],
},
},
"backfillNone": { # Backfill strategy to disable automatic backfill for the Stream's objects. # Do not automatically backfill any objects.
},
"createTime": "A String", # Output only. The creation time of the stream.
"customerManagedEncryptionKey": "A String", # Immutable. A reference to a KMS encryption key. If provided, it will be used to encrypt the data. If left blank, data will be encrypted using an internal Stream-specific encryption key provisioned through KMS.
"destinationConfig": { # The configuration of the stream destination. # Required. Destination connection profile configuration.
"destinationConnectionProfileName": "A String", # Required. Destination connection profile identifier.
"gcsDestinationConfig": { # Google Cloud Storage destination configuration # GCS destination configuration.
"avroFileFormat": { # AVRO file format configuration. # AVRO file format configuration.
},
"fileRotationInterval": "A String", # The maximum duration for which new events are added before a file is closed and a new file is created.
"fileRotationMb": 42, # The maximum file size to be saved in the bucket.
"gcsFileFormat": "A String", # File format that data should be written in. Deprecated field (b/169501737) - use file_format instead.
"jsonFileFormat": { # JSON file format configuration. # JSON file format configuration.
"compression": "A String", # Compression of the loaded JSON file.
"schemaFileFormat": "A String", # The schema file format along JSON data files.
},
"path": "A String", # Path inside the Cloud Storage bucket to write data to.
},
},
"displayName": "A String", # Required. Display name.
"errors": [ # Output only. Errors on the Stream.
{ # Represent a user-facing Error.
"details": { # Additional information about the error.
"a_key": "A String",
},
"errorTime": "A String", # The time when the error occurred.
"errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
"message": "A String", # A message containing more information about the error that occurred.
"reason": "A String", # A title that explains the reason for the error.
},
],
"labels": { # Labels.
"a_key": "A String",
},
"name": "A String", # Output only. The stream's name.
"sourceConfig": { # The configuration of the stream source. # Required. Source connection profile configuration.
"mysqlSourceConfig": { # MySQL source configuration # MySQL data source configuration
"allowlist": { # MySQL database structure # MySQL objects to retrieve from the source.
"mysqlDatabases": [ # Mysql databases on the server
{ # MySQL database.
"databaseName": "A String", # Database name.
"mysqlTables": [ # Tables in the database.
{ # MySQL table.
"mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything.
{ # MySQL Column.
"collation": "A String", # Column collation.
"columnName": "A String", # Column name.
"dataType": "A String", # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"primaryKey": True or False, # Whether or not the column represents a primary key.
},
],
"tableName": "A String", # Table name.
},
],
},
],
},
"rejectlist": { # MySQL database structure # MySQL objects to exclude from the stream.
"mysqlDatabases": [ # Mysql databases on the server
{ # MySQL database.
"databaseName": "A String", # Database name.
"mysqlTables": [ # Tables in the database.
{ # MySQL table.
"mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything.
{ # MySQL Column.
"collation": "A String", # Column collation.
"columnName": "A String", # Column name.
"dataType": "A String", # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"primaryKey": True or False, # Whether or not the column represents a primary key.
},
],
"tableName": "A String", # Table name.
},
],
},
],
},
},
"oracleSourceConfig": { # Oracle data source configuration # Oracle data source configuration
"allowlist": { # Oracle database structure. # Oracle objects to include in the stream.
"oracleSchemas": [ # Oracle schemas/databases in the database server.
{ # Oracle schema.
"oracleTables": [ # Tables in the schema.
{ # Oracle table.
"oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything.
{ # Oracle Column.
"columnName": "A String", # Column name.
"dataType": "A String", # The Oracle data type.
"encoding": "A String", # Column encoding.
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"precision": 42, # Column precision.
"primaryKey": True or False, # Whether or not the column represents a primary key.
"scale": 42, # Column scale.
},
],
"tableName": "A String", # Table name.
},
],
"schemaName": "A String", # Schema name.
},
],
},
"dropLargeObjects": { # Configuration to drop large object values. # Drop large object values.
},
"rejectlist": { # Oracle database structure. # Oracle objects to exclude from the stream.
"oracleSchemas": [ # Oracle schemas/databases in the database server.
{ # Oracle schema.
"oracleTables": [ # Tables in the schema.
{ # Oracle table.
"oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything.
{ # Oracle Column.
"columnName": "A String", # Column name.
"dataType": "A String", # The Oracle data type.
"encoding": "A String", # Column encoding.
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"precision": 42, # Column precision.
"primaryKey": True or False, # Whether or not the column represents a primary key.
"scale": 42, # Column scale.
},
],
"tableName": "A String", # Table name.
},
],
"schemaName": "A String", # Schema name.
},
],
},
},
"sourceConnectionProfileName": "A String", # Required. Source connection profile identifier.
},
"state": "A String", # The state of the stream.
"updateTime": "A String", # Output only. The last update time of the stream.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Use this method to list streams in a project and location.
Args:
parent: string, Required. The parent that owns the collection of streams. (required)
filter: string, Filter request.
orderBy: string, Order by fields for the result.
pageSize: integer, Maximum number of streams to return. If unspecified, at most 50 streams will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, Page token received from a previous `ListStreams` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListStreams` must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"streams": [ # List of streams
{
"backfillAll": { # Backfill strategy to automatically backfill the Stream's objects. Specific objects can be excluded. # Automatically backfill objects included in the stream source configuration. Specific objects can be excluded.
"mysqlExcludedObjects": { # MySQL database structure # MySQL data source objects to avoid backfilling.
"mysqlDatabases": [ # Mysql databases on the server
{ # MySQL database.
"databaseName": "A String", # Database name.
"mysqlTables": [ # Tables in the database.
{ # MySQL table.
"mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything.
{ # MySQL Column.
"collation": "A String", # Column collation.
"columnName": "A String", # Column name.
"dataType": "A String", # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"primaryKey": True or False, # Whether or not the column represents a primary key.
},
],
"tableName": "A String", # Table name.
},
],
},
],
},
"oracleExcludedObjects": { # Oracle database structure. # Oracle data source objects to avoid backfilling.
"oracleSchemas": [ # Oracle schemas/databases in the database server.
{ # Oracle schema.
"oracleTables": [ # Tables in the schema.
{ # Oracle table.
"oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything.
{ # Oracle Column.
"columnName": "A String", # Column name.
"dataType": "A String", # The Oracle data type.
"encoding": "A String", # Column encoding.
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"precision": 42, # Column precision.
"primaryKey": True or False, # Whether or not the column represents a primary key.
"scale": 42, # Column scale.
},
],
"tableName": "A String", # Table name.
},
],
"schemaName": "A String", # Schema name.
},
],
},
},
"backfillNone": { # Backfill strategy to disable automatic backfill for the Stream's objects. # Do not automatically backfill any objects.
},
"createTime": "A String", # Output only. The creation time of the stream.
"customerManagedEncryptionKey": "A String", # Immutable. A reference to a KMS encryption key. If provided, it will be used to encrypt the data. If left blank, data will be encrypted using an internal Stream-specific encryption key provisioned through KMS.
"destinationConfig": { # The configuration of the stream destination. # Required. Destination connection profile configuration.
"destinationConnectionProfileName": "A String", # Required. Destination connection profile identifier.
"gcsDestinationConfig": { # Google Cloud Storage destination configuration # GCS destination configuration.
"avroFileFormat": { # AVRO file format configuration. # AVRO file format configuration.
},
"fileRotationInterval": "A String", # The maximum duration for which new events are added before a file is closed and a new file is created.
"fileRotationMb": 42, # The maximum file size to be saved in the bucket.
"gcsFileFormat": "A String", # File format that data should be written in. Deprecated field (b/169501737) - use file_format instead.
"jsonFileFormat": { # JSON file format configuration. # JSON file format configuration.
"compression": "A String", # Compression of the loaded JSON file.
"schemaFileFormat": "A String", # The schema file format along JSON data files.
},
"path": "A String", # Path inside the Cloud Storage bucket to write data to.
},
},
"displayName": "A String", # Required. Display name.
"errors": [ # Output only. Errors on the Stream.
{ # Represent a user-facing Error.
"details": { # Additional information about the error.
"a_key": "A String",
},
"errorTime": "A String", # The time when the error occurred.
"errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
"message": "A String", # A message containing more information about the error that occurred.
"reason": "A String", # A title that explains the reason for the error.
},
],
"labels": { # Labels.
"a_key": "A String",
},
"name": "A String", # Output only. The stream's name.
"sourceConfig": { # The configuration of the stream source. # Required. Source connection profile configuration.
"mysqlSourceConfig": { # MySQL source configuration # MySQL data source configuration
"allowlist": { # MySQL database structure # MySQL objects to retrieve from the source.
"mysqlDatabases": [ # Mysql databases on the server
{ # MySQL database.
"databaseName": "A String", # Database name.
"mysqlTables": [ # Tables in the database.
{ # MySQL table.
"mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything.
{ # MySQL Column.
"collation": "A String", # Column collation.
"columnName": "A String", # Column name.
"dataType": "A String", # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"primaryKey": True or False, # Whether or not the column represents a primary key.
},
],
"tableName": "A String", # Table name.
},
],
},
],
},
"rejectlist": { # MySQL database structure # MySQL objects to exclude from the stream.
"mysqlDatabases": [ # Mysql databases on the server
{ # MySQL database.
"databaseName": "A String", # Database name.
"mysqlTables": [ # Tables in the database.
{ # MySQL table.
"mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything.
{ # MySQL Column.
"collation": "A String", # Column collation.
"columnName": "A String", # Column name.
"dataType": "A String", # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"primaryKey": True or False, # Whether or not the column represents a primary key.
},
],
"tableName": "A String", # Table name.
},
],
},
],
},
},
"oracleSourceConfig": { # Oracle data source configuration # Oracle data source configuration
"allowlist": { # Oracle database structure. # Oracle objects to include in the stream.
"oracleSchemas": [ # Oracle schemas/databases in the database server.
{ # Oracle schema.
"oracleTables": [ # Tables in the schema.
{ # Oracle table.
"oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything.
{ # Oracle Column.
"columnName": "A String", # Column name.
"dataType": "A String", # The Oracle data type.
"encoding": "A String", # Column encoding.
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"precision": 42, # Column precision.
"primaryKey": True or False, # Whether or not the column represents a primary key.
"scale": 42, # Column scale.
},
],
"tableName": "A String", # Table name.
},
],
"schemaName": "A String", # Schema name.
},
],
},
"dropLargeObjects": { # Configuration to drop large object values. # Drop large object values.
},
"rejectlist": { # Oracle database structure. # Oracle objects to exclude from the stream.
"oracleSchemas": [ # Oracle schemas/databases in the database server.
{ # Oracle schema.
"oracleTables": [ # Tables in the schema.
{ # Oracle table.
"oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything.
{ # Oracle Column.
"columnName": "A String", # Column name.
"dataType": "A String", # The Oracle data type.
"encoding": "A String", # Column encoding.
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"precision": 42, # Column precision.
"primaryKey": True or False, # Whether or not the column represents a primary key.
"scale": 42, # Column scale.
},
],
"tableName": "A String", # Table name.
},
],
"schemaName": "A String", # Schema name.
},
],
},
},
"sourceConnectionProfileName": "A String", # Required. Source connection profile identifier.
},
"state": "A String", # The state of the stream.
"updateTime": "A String", # Output only. The last update time of the stream.
},
],
"unreachable": [ # Locations that could not be reached.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, force=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)</code>
<pre>Use this method to update the configuration of a stream.
Args:
name: string, Output only. The stream's name. (required)
body: object, The request body.
The object takes the form of:
{
"backfillAll": { # Backfill strategy to automatically backfill the Stream's objects. Specific objects can be excluded. # Automatically backfill objects included in the stream source configuration. Specific objects can be excluded.
"mysqlExcludedObjects": { # MySQL database structure # MySQL data source objects to avoid backfilling.
"mysqlDatabases": [ # Mysql databases on the server
{ # MySQL database.
"databaseName": "A String", # Database name.
"mysqlTables": [ # Tables in the database.
{ # MySQL table.
"mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything.
{ # MySQL Column.
"collation": "A String", # Column collation.
"columnName": "A String", # Column name.
"dataType": "A String", # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"primaryKey": True or False, # Whether or not the column represents a primary key.
},
],
"tableName": "A String", # Table name.
},
],
},
],
},
"oracleExcludedObjects": { # Oracle database structure. # Oracle data source objects to avoid backfilling.
"oracleSchemas": [ # Oracle schemas/databases in the database server.
{ # Oracle schema.
"oracleTables": [ # Tables in the schema.
{ # Oracle table.
"oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything.
{ # Oracle Column.
"columnName": "A String", # Column name.
"dataType": "A String", # The Oracle data type.
"encoding": "A String", # Column encoding.
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"precision": 42, # Column precision.
"primaryKey": True or False, # Whether or not the column represents a primary key.
"scale": 42, # Column scale.
},
],
"tableName": "A String", # Table name.
},
],
"schemaName": "A String", # Schema name.
},
],
},
},
"backfillNone": { # Backfill strategy to disable automatic backfill for the Stream's objects. # Do not automatically backfill any objects.
},
"createTime": "A String", # Output only. The creation time of the stream.
"customerManagedEncryptionKey": "A String", # Immutable. A reference to a KMS encryption key. If provided, it will be used to encrypt the data. If left blank, data will be encrypted using an internal Stream-specific encryption key provisioned through KMS.
"destinationConfig": { # The configuration of the stream destination. # Required. Destination connection profile configuration.
"destinationConnectionProfileName": "A String", # Required. Destination connection profile identifier.
"gcsDestinationConfig": { # Google Cloud Storage destination configuration # GCS destination configuration.
"avroFileFormat": { # AVRO file format configuration. # AVRO file format configuration.
},
"fileRotationInterval": "A String", # The maximum duration for which new events are added before a file is closed and a new file is created.
"fileRotationMb": 42, # The maximum file size to be saved in the bucket.
"gcsFileFormat": "A String", # File format that data should be written in. Deprecated field (b/169501737) - use file_format instead.
"jsonFileFormat": { # JSON file format configuration. # JSON file format configuration.
"compression": "A String", # Compression of the loaded JSON file.
"schemaFileFormat": "A String", # The schema file format along JSON data files.
},
"path": "A String", # Path inside the Cloud Storage bucket to write data to.
},
},
"displayName": "A String", # Required. Display name.
"errors": [ # Output only. Errors on the Stream.
{ # Represent a user-facing Error.
"details": { # Additional information about the error.
"a_key": "A String",
},
"errorTime": "A String", # The time when the error occurred.
"errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
"message": "A String", # A message containing more information about the error that occurred.
"reason": "A String", # A title that explains the reason for the error.
},
],
"labels": { # Labels.
"a_key": "A String",
},
"name": "A String", # Output only. The stream's name.
"sourceConfig": { # The configuration of the stream source. # Required. Source connection profile configuration.
"mysqlSourceConfig": { # MySQL source configuration # MySQL data source configuration
"allowlist": { # MySQL database structure # MySQL objects to retrieve from the source.
"mysqlDatabases": [ # Mysql databases on the server
{ # MySQL database.
"databaseName": "A String", # Database name.
"mysqlTables": [ # Tables in the database.
{ # MySQL table.
"mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything.
{ # MySQL Column.
"collation": "A String", # Column collation.
"columnName": "A String", # Column name.
"dataType": "A String", # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"primaryKey": True or False, # Whether or not the column represents a primary key.
},
],
"tableName": "A String", # Table name.
},
],
},
],
},
"rejectlist": { # MySQL database structure # MySQL objects to exclude from the stream.
"mysqlDatabases": [ # Mysql databases on the server
{ # MySQL database.
"databaseName": "A String", # Database name.
"mysqlTables": [ # Tables in the database.
{ # MySQL table.
"mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything.
{ # MySQL Column.
"collation": "A String", # Column collation.
"columnName": "A String", # Column name.
"dataType": "A String", # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"primaryKey": True or False, # Whether or not the column represents a primary key.
},
],
"tableName": "A String", # Table name.
},
],
},
],
},
},
"oracleSourceConfig": { # Oracle data source configuration # Oracle data source configuration
"allowlist": { # Oracle database structure. # Oracle objects to include in the stream.
"oracleSchemas": [ # Oracle schemas/databases in the database server.
{ # Oracle schema.
"oracleTables": [ # Tables in the schema.
{ # Oracle table.
"oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything.
{ # Oracle Column.
"columnName": "A String", # Column name.
"dataType": "A String", # The Oracle data type.
"encoding": "A String", # Column encoding.
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"precision": 42, # Column precision.
"primaryKey": True or False, # Whether or not the column represents a primary key.
"scale": 42, # Column scale.
},
],
"tableName": "A String", # Table name.
},
],
"schemaName": "A String", # Schema name.
},
],
},
"dropLargeObjects": { # Configuration to drop large object values. # Drop large object values.
},
"rejectlist": { # Oracle database structure. # Oracle objects to exclude from the stream.
"oracleSchemas": [ # Oracle schemas/databases in the database server.
{ # Oracle schema.
"oracleTables": [ # Tables in the schema.
{ # Oracle table.
"oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything.
{ # Oracle Column.
"columnName": "A String", # Column name.
"dataType": "A String", # The Oracle data type.
"encoding": "A String", # Column encoding.
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"precision": 42, # Column precision.
"primaryKey": True or False, # Whether or not the column represents a primary key.
"scale": 42, # Column scale.
},
],
"tableName": "A String", # Table name.
},
],
"schemaName": "A String", # Schema name.
},
],
},
},
"sourceConnectionProfileName": "A String", # Required. Source connection profile identifier.
},
"state": "A String", # The state of the stream.
"updateTime": "A String", # Output only. The last update time of the stream.
}
force: boolean, Optional. Execute the update without validating it.
requestId: string, Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the stream resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
validateOnly: boolean, Optional. Only validate the stream with the changes, without actually updating it. The default is false.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
</body></html>
|
