Debian Codegraph @

docs/dyn/datastream_v1.projects.locations.streams.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="datastream_v1.html">Datastream API</a> . <a href="datastream_v1.projects.html">projects</a> . <a href="datastream_v1.projects.locations.html">locations</a> . <a href="datastream_v1.projects.locations.streams.html">streams</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="datastream_v1.projects.locations.streams.objects.html">objects()</a></code>
79 </p>
80 <p class="firstline">Returns the objects Resource.</p>
81
82 <p class="toc_element">
83 <code><a href="#close">close()</a></code></p>
84 <p class="firstline">Close httplib2 connections.</p>
85 <p class="toc_element">
86 <code><a href="#create">create(parent, body=None, force=None, requestId=None, streamId=None, validateOnly=None, x__xgafv=None)</a></code></p>
87 <p class="firstline">Use this method to create a stream.</p>
88 <p class="toc_element">
89 <code><a href="#delete">delete(name, requestId=None, x__xgafv=None)</a></code></p>
90 <p class="firstline">Use this method to delete a stream.</p>
91 <p class="toc_element">
92 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
93 <p class="firstline">Use this method to get details about a stream.</p>
94 <p class="toc_element">
95 <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
96 <p class="firstline">Use this method to list streams in a project and location.</p>
97 <p class="toc_element">
98 <code><a href="#list_next">list_next()</a></code></p>
99 <p class="firstline">Retrieves the next page of results.</p>
100 <p class="toc_element">
101 <code><a href="#patch">patch(name, body=None, force=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)</a></code></p>
102 <p class="firstline">Use this method to update the configuration of a stream.</p>
103 <p class="toc_element">
104 <code><a href="#run">run(name, body=None, x__xgafv=None)</a></code></p>
105 <p class="firstline">Use this method to start, resume or recover a stream with a non default CDC strategy.</p>
106 <h3>Method Details</h3>
107 <div class="method">
108 <code class="details" id="close">close()</code>
109 <pre>Close httplib2 connections.</pre>
110 </div>
111
112 <div class="method">
113 <code class="details" id="create">create(parent, body=None, force=None, requestId=None, streamId=None, validateOnly=None, x__xgafv=None)</code>
114 <pre>Use this method to create a stream.
115
116 Args:
117 parent: string, Required. The parent that owns the collection of streams. (required)
118 body: object, The request body.
119 The object takes the form of:
120
121 { # A resource representing streaming data from a source to a destination.
122 &quot;backfillAll&quot;: { # Backfill strategy to automatically backfill the Stream&#x27;s objects. Specific objects can be excluded. # Automatically backfill objects included in the stream source configuration. Specific objects can be excluded.
123 &quot;mongodbExcludedObjects&quot;: { # MongoDB Cluster structure. # MongoDB data source objects to avoid backfilling
124 &quot;databases&quot;: [ # MongoDB databases in the cluster.
125 { # MongoDB Database.
126 &quot;collections&quot;: [ # Collections in the database.
127 { # MongoDB Collection.
128 &quot;collection&quot;: &quot;A String&quot;, # The collection name.
129 &quot;fields&quot;: [ # Fields in the collection.
130 { # MongoDB Field.
131 &quot;field&quot;: &quot;A String&quot;, # The field name.
132 },
133 ],
134 },
135 ],
136 &quot;database&quot;: &quot;A String&quot;, # The database name.
137 },
138 ],
139 },
140 &quot;mysqlExcludedObjects&quot;: { # MySQL database structure # MySQL data source objects to avoid backfilling.
141 &quot;mysqlDatabases&quot;: [ # Mysql databases on the server
142 { # MySQL database.
143 &quot;database&quot;: &quot;A String&quot;, # The database name.
144 &quot;mysqlTables&quot;: [ # Tables in the database.
145 { # MySQL table.
146 &quot;mysqlColumns&quot;: [ # MySQL columns in the database. When unspecified as part of include/exclude objects, includes/excludes everything.
147 { # MySQL Column.
148 &quot;collation&quot;: &quot;A String&quot;, # Column collation.
149 &quot;column&quot;: &quot;A String&quot;, # The column name.
150 &quot;dataType&quot;: &quot;A String&quot;, # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html
151 &quot;length&quot;: 42, # Column length.
152 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
153 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
154 &quot;precision&quot;: 42, # Column precision.
155 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
156 &quot;scale&quot;: 42, # Column scale.
157 },
158 ],
159 &quot;table&quot;: &quot;A String&quot;, # The table name.
160 },
161 ],
162 },
163 ],
164 },
165 &quot;oracleExcludedObjects&quot;: { # Oracle database structure. # Oracle data source objects to avoid backfilling.
166 &quot;oracleSchemas&quot;: [ # Oracle schemas/databases in the database server.
167 { # Oracle schema.
168 &quot;oracleTables&quot;: [ # Tables in the schema.
169 { # Oracle table.
170 &quot;oracleColumns&quot;: [ # Oracle columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything.
171 { # Oracle Column.
172 &quot;column&quot;: &quot;A String&quot;, # The column name.
173 &quot;dataType&quot;: &quot;A String&quot;, # The Oracle data type.
174 &quot;encoding&quot;: &quot;A String&quot;, # Column encoding.
175 &quot;length&quot;: 42, # Column length.
176 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
177 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
178 &quot;precision&quot;: 42, # Column precision.
179 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
180 &quot;scale&quot;: 42, # Column scale.
181 },
182 ],
183 &quot;table&quot;: &quot;A String&quot;, # The table name.
184 },
185 ],
186 &quot;schema&quot;: &quot;A String&quot;, # The schema name.
187 },
188 ],
189 },
190 &quot;postgresqlExcludedObjects&quot;: { # PostgreSQL database structure. # PostgreSQL data source objects to avoid backfilling.
191 &quot;postgresqlSchemas&quot;: [ # PostgreSQL schemas in the database server.
192 { # PostgreSQL schema.
193 &quot;postgresqlTables&quot;: [ # Tables in the schema.
194 { # PostgreSQL table.
195 &quot;postgresqlColumns&quot;: [ # PostgreSQL columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything.
196 { # PostgreSQL Column.
197 &quot;column&quot;: &quot;A String&quot;, # The column name.
198 &quot;dataType&quot;: &quot;A String&quot;, # The PostgreSQL data type.
199 &quot;length&quot;: 42, # Column length.
200 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
201 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
202 &quot;precision&quot;: 42, # Column precision.
203 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
204 &quot;scale&quot;: 42, # Column scale.
205 },
206 ],
207 &quot;table&quot;: &quot;A String&quot;, # The table name.
208 },
209 ],
210 &quot;schema&quot;: &quot;A String&quot;, # The schema name.
211 },
212 ],
213 },
214 &quot;saasExcludedObjects&quot;: { # Source catalog. # Source catalog data source objects to avoid backfilling. This is mainly used to represent SaaS applications objects.
215 &quot;objects&quot;: [ # Optional. Source objects in the catalog.
216 { # Source object.
217 &quot;objectName&quot;: &quot;A String&quot;, # Required. The object name.
218 &quot;properties&quot;: [ # Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
219 { # Source property.
220 &quot;primaryKey&quot;: True or False, # Optional. Whether or not the property is a primary key.
221 &quot;properties&quot;: [ # Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
222 # Object with schema name: SourceProperty
223 ],
224 &quot;propertyName&quot;: &quot;A String&quot;, # Required. The property name.
225 },
226 ],
227 },
228 ],
229 },
230 &quot;salesforceExcludedObjects&quot;: { # Salesforce organization structure. # Salesforce data source objects to avoid backfilling
231 &quot;objects&quot;: [ # Salesforce objects in the database server.
232 { # Salesforce object.
233 &quot;fields&quot;: [ # Salesforce fields. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
234 { # Salesforce field.
235 &quot;dataType&quot;: &quot;A String&quot;, # The data type.
236 &quot;name&quot;: &quot;A String&quot;, # The field name.
237 &quot;nillable&quot;: True or False, # Indicates whether the field can accept nil values.
238 },
239 ],
240 &quot;objectName&quot;: &quot;A String&quot;, # The object name.
241 },
242 ],
243 },
244 &quot;spannerExcludedObjects&quot;: { # Spanner database structure. # Spanner data source objects to avoid backfilling.
245 &quot;schemas&quot;: [ # Optional. Spanner schemas in the database.
246 { # Spanner schema.
247 &quot;schema&quot;: &quot;A String&quot;, # Required. The schema name.
248 &quot;tables&quot;: [ # Optional. Spanner tables in the schema.
249 { # Spanner table.
250 &quot;columns&quot;: [ # Optional. Spanner columns in the table.
251 { # Spanner column.
252 &quot;column&quot;: &quot;A String&quot;, # Required. The column name.
253 &quot;dataType&quot;: &quot;A String&quot;, # Optional. Spanner data type.
254 &quot;isPrimaryKey&quot;: True or False, # Optional. Whether or not the column is a primary key.
255 &quot;ordinalPosition&quot;: &quot;A String&quot;, # Optional. The ordinal position of the column in the table.
256 },
257 ],
258 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
259 },
260 ],
261 },
262 ],
263 },
264 &quot;sqlServerExcludedObjects&quot;: { # SQLServer database structure. # SQLServer data source objects to avoid backfilling
265 &quot;schemas&quot;: [ # SQLServer schemas in the database server.
266 { # SQLServer schema.
267 &quot;schema&quot;: &quot;A String&quot;, # The schema name.
268 &quot;tables&quot;: [ # Tables in the schema.
269 { # SQLServer table.
270 &quot;columns&quot;: [ # SQLServer columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything.
271 { # SQLServer Column.
272 &quot;column&quot;: &quot;A String&quot;, # The column name.
273 &quot;dataType&quot;: &quot;A String&quot;, # The SQLServer data type.
274 &quot;length&quot;: 42, # Column length.
275 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
276 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
277 &quot;precision&quot;: 42, # Column precision.
278 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
279 &quot;scale&quot;: 42, # Column scale.
280 },
281 ],
282 &quot;table&quot;: &quot;A String&quot;, # The table name.
283 },
284 ],
285 },
286 ],
287 },
288 },
289 &quot;backfillNone&quot;: { # Backfill strategy to disable automatic backfill for the Stream&#x27;s objects. # Do not automatically backfill any objects.
290 },
291 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation time of the stream.
292 &quot;customerManagedEncryptionKey&quot;: &quot;A String&quot;, # 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.
293 &quot;destinationConfig&quot;: { # The configuration of the stream destination. # Required. Destination connection profile configuration.
294 &quot;bigqueryDestinationConfig&quot;: { # BigQuery destination configuration # BigQuery destination configuration.
295 &quot;appendOnly&quot;: { # AppendOnly mode defines that all changes to a table will be written to the destination table. # Append only mode
296 },
297 &quot;blmtConfig&quot;: { # The configuration for BLMT. # Optional. Big Lake Managed Tables (BLMT) configuration.
298 &quot;bucket&quot;: &quot;A String&quot;, # Required. The Cloud Storage bucket name.
299 &quot;connectionName&quot;: &quot;A String&quot;, # Required. The bigquery connection. Format: `{project}.{location}.{name}`
300 &quot;fileFormat&quot;: &quot;A String&quot;, # Required. The file format.
301 &quot;rootPath&quot;: &quot;A String&quot;, # The root path inside the Cloud Storage bucket.
302 &quot;tableFormat&quot;: &quot;A String&quot;, # Required. The table format.
303 },
304 &quot;dataFreshness&quot;: &quot;A String&quot;, # The guaranteed data freshness (in seconds) when querying tables created by the stream. Editing this field will only affect new tables created in the future, but existing tables will not be impacted. Lower values mean that queries will return fresher data, but may result in higher cost.
305 &quot;merge&quot;: { # Merge mode defines that all changes to a table will be merged at the destination table. # The standard mode
306 },
307 &quot;singleTargetDataset&quot;: { # A single target dataset to which all data will be streamed. # Single destination dataset.
308 &quot;datasetId&quot;: &quot;A String&quot;, # The dataset ID of the target dataset. DatasetIds allowed characters: https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets#datasetreference.
309 },
310 &quot;sourceHierarchyDatasets&quot;: { # Destination datasets are created so that hierarchy of the destination data objects matches the source hierarchy. # Source hierarchy datasets.
311 &quot;datasetTemplate&quot;: { # Dataset template used for dynamic dataset creation. # The dataset template to use for dynamic dataset creation.
312 &quot;datasetIdPrefix&quot;: &quot;A String&quot;, # If supplied, every created dataset will have its name prefixed by the provided value. The prefix and name will be separated by an underscore. i.e. _.
313 &quot;kmsKeyName&quot;: &quot;A String&quot;, # Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key. i.e. projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{cryptoKey}. See https://cloud.google.com/bigquery/docs/customer-managed-encryption for more information.
314 &quot;location&quot;: &quot;A String&quot;, # Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
315 },
316 &quot;projectId&quot;: &quot;A String&quot;, # Optional. The project id of the BigQuery dataset. If not specified, the project will be inferred from the stream resource.
317 },
318 },
319 &quot;destinationConnectionProfile&quot;: &quot;A String&quot;, # Required. Destination connection profile resource. Format: `projects/{project}/locations/{location}/connectionProfiles/{name}`
320 &quot;gcsDestinationConfig&quot;: { # Google Cloud Storage destination configuration # A configuration for how data should be loaded to Cloud Storage.
321 &quot;avroFileFormat&quot;: { # AVRO file format configuration. # AVRO file format configuration.
322 },
323 &quot;fileRotationInterval&quot;: &quot;A String&quot;, # The maximum duration for which new events are added before a file is closed and a new file is created. Values within the range of 15-60 seconds are allowed.
324 &quot;fileRotationMb&quot;: 42, # The maximum file size to be saved in the bucket.
325 &quot;jsonFileFormat&quot;: { # JSON file format configuration. # JSON file format configuration.
326 &quot;compression&quot;: &quot;A String&quot;, # Compression of the loaded JSON file.
327 &quot;schemaFileFormat&quot;: &quot;A String&quot;, # The schema file format along JSON data files.
328 },
329 &quot;path&quot;: &quot;A String&quot;, # Path inside the Cloud Storage bucket to write data to.
330 },
331 },
332 &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name.
333 &quot;errors&quot;: [ # Output only. Errors on the Stream.
334 { # Represent a user-facing Error.
335 &quot;details&quot;: { # Additional information about the error.
336 &quot;a_key&quot;: &quot;A String&quot;,
337 },
338 &quot;errorTime&quot;: &quot;A String&quot;, # The time when the error occurred.
339 &quot;errorUuid&quot;: &quot;A String&quot;, # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
340 &quot;message&quot;: &quot;A String&quot;, # A message containing more information about the error that occurred.
341 &quot;reason&quot;: &quot;A String&quot;, # A title that explains the reason for the error.
342 },
343 ],
344 &quot;labels&quot;: { # Labels.
345 &quot;a_key&quot;: &quot;A String&quot;,
346 },
347 &quot;lastRecoveryTime&quot;: &quot;A String&quot;, # Output only. If the stream was recovered, the time of the last recovery. Note: This field is currently experimental.
348 &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The stream&#x27;s name.
349 &quot;ruleSets&quot;: [ # Optional. Rule sets to apply to the stream.
350 { # A set of rules to apply to a set of objects.
351 &quot;customizationRules&quot;: [ # Required. List of customization rules to apply.
352 { # A customization rule to apply to a set of objects.
353 &quot;bigqueryClustering&quot;: { # BigQuery clustering configuration. # BigQuery clustering rule.
354 &quot;columns&quot;: [ # Required. Column names to set as clustering columns.
355 &quot;A String&quot;,
356 ],
357 },
358 &quot;bigqueryPartitioning&quot;: { # BigQuery partitioning configuration. # BigQuery partitioning rule.
359 &quot;ingestionTimePartition&quot;: { # Ingestion time partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time # Ingestion time partitioning.
360 &quot;partitioningTimeGranularity&quot;: &quot;A String&quot;, # Optional. Partition granularity
361 },
362 &quot;integerRangePartition&quot;: { # Integer range partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#integer_range # Integer range partitioning.
363 &quot;column&quot;: &quot;A String&quot;, # Required. The partitioning column.
364 &quot;end&quot;: &quot;A String&quot;, # Required. The ending value for range partitioning (exclusive).
365 &quot;interval&quot;: &quot;A String&quot;, # Required. The interval of each range within the partition.
366 &quot;start&quot;: &quot;A String&quot;, # Required. The starting value for range partitioning (inclusive).
367 },
368 &quot;requirePartitionFilter&quot;: True or False, # Optional. If true, queries over the table require a partition filter.
369 &quot;timeUnitPartition&quot;: { # Time unit column partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#date_timestamp_partitioned_tables # Time unit column partitioning.
370 &quot;column&quot;: &quot;A String&quot;, # Required. The partitioning column.
371 &quot;partitioningTimeGranularity&quot;: &quot;A String&quot;, # Optional. Partition granularity.
372 },
373 },
374 },
375 ],
376 &quot;objectFilter&quot;: { # Object filter to apply the rules to. # Required. Object filter to apply the customization rules to.
377 &quot;sourceObjectIdentifier&quot;: { # Represents an identifier of an object in the data source. # Specific source object identifier.
378 &quot;mongodbIdentifier&quot;: { # MongoDB data source object identifier. # MongoDB data source object identifier.
379 &quot;collection&quot;: &quot;A String&quot;, # Required. The collection name.
380 &quot;database&quot;: &quot;A String&quot;, # Required. The database name.
381 },
382 &quot;mysqlIdentifier&quot;: { # Mysql data source object identifier. # Mysql data source object identifier.
383 &quot;database&quot;: &quot;A String&quot;, # Required. The database name.
384 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
385 },
386 &quot;oracleIdentifier&quot;: { # Oracle data source object identifier. # Oracle data source object identifier.
387 &quot;schema&quot;: &quot;A String&quot;, # Required. The schema name.
388 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
389 },
390 &quot;postgresqlIdentifier&quot;: { # PostgreSQL data source object identifier. # PostgreSQL data source object identifier.
391 &quot;schema&quot;: &quot;A String&quot;, # Required. The schema name.
392 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
393 },
394 &quot;salesforceIdentifier&quot;: { # Salesforce data source object identifier. # Salesforce data source object identifier.
395 &quot;objectName&quot;: &quot;A String&quot;, # Required. The object name.
396 },
397 &quot;spannerIdentifier&quot;: { # Spanner data source object identifier. # Spanner data source object identifier.
398 &quot;schema&quot;: &quot;A String&quot;, # Optional. The schema name.
399 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
400 },
401 &quot;sqlServerIdentifier&quot;: { # SQLServer data source object identifier. # SQLServer data source object identifier.
402 &quot;schema&quot;: &quot;A String&quot;, # Required. The schema name.
403 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
404 },
405 },
406 },
407 },
408 ],
409 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
410 &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
411 &quot;sourceConfig&quot;: { # The configuration of the stream source. # Required. Source connection profile configuration.
412 &quot;dataverseSourceConfig&quot;: { # Configuration for syncing data from a Dataverse source. # Dataverse data source configuration.
413 &quot;excludeObjects&quot;: { # Source catalog. # Optional. The objects to exclude from the stream.
414 &quot;objects&quot;: [ # Optional. Source objects in the catalog.
415 { # Source object.
416 &quot;objectName&quot;: &quot;A String&quot;, # Required. The object name.
417 &quot;properties&quot;: [ # Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
418 { # Source property.
419 &quot;primaryKey&quot;: True or False, # Optional. Whether or not the property is a primary key.
420 &quot;properties&quot;: [ # Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
421 # Object with schema name: SourceProperty
422 ],
423 &quot;propertyName&quot;: &quot;A String&quot;, # Required. The property name.
424 },
425 ],
426 },
427 ],
428 },
429 &quot;includeObjects&quot;: { # Source catalog. # Optional. The objects to retrieve from the source.
430 &quot;objects&quot;: [ # Optional. Source objects in the catalog.
431 { # Source object.
432 &quot;objectName&quot;: &quot;A String&quot;, # Required. The object name.
433 &quot;properties&quot;: [ # Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
434 { # Source property.
435 &quot;primaryKey&quot;: True or False, # Optional. Whether or not the property is a primary key.
436 &quot;properties&quot;: [ # Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
437 # Object with schema name: SourceProperty
438 ],
439 &quot;propertyName&quot;: &quot;A String&quot;, # Required. The property name.
440 },
441 ],
442 },
443 ],
444 },
445 &quot;pollingInterval&quot;: &quot;A String&quot;, # Required. Incremental sync polling interval for all objects. If not set, a default value of `5 minutes` is used. The duration must be from `5 minutes` to `24 hours`, inclusive.
446 },
447 &quot;mongodbSourceConfig&quot;: { # Configuration for syncing data from a MongoDB source. # MongoDB data source configuration.
448 &quot;excludeObjects&quot;: { # MongoDB Cluster structure. # The MongoDB collections to exclude from the stream.
449 &quot;databases&quot;: [ # MongoDB databases in the cluster.
450 { # MongoDB Database.
451 &quot;collections&quot;: [ # Collections in the database.
452 { # MongoDB Collection.
453 &quot;collection&quot;: &quot;A String&quot;, # The collection name.
454 &quot;fields&quot;: [ # Fields in the collection.
455 { # MongoDB Field.
456 &quot;field&quot;: &quot;A String&quot;, # The field name.
457 },
458 ],
459 },
460 ],
461 &quot;database&quot;: &quot;A String&quot;, # The database name.
462 },
463 ],
464 },
465 &quot;includeObjects&quot;: { # MongoDB Cluster structure. # The MongoDB collections to include in the stream.
466 &quot;databases&quot;: [ # MongoDB databases in the cluster.
467 { # MongoDB Database.
468 &quot;collections&quot;: [ # Collections in the database.
469 { # MongoDB Collection.
470 &quot;collection&quot;: &quot;A String&quot;, # The collection name.
471 &quot;fields&quot;: [ # Fields in the collection.
472 { # MongoDB Field.
473 &quot;field&quot;: &quot;A String&quot;, # The field name.
474 },
475 ],
476 },
477 ],
478 &quot;database&quot;: &quot;A String&quot;, # The database name.
479 },
480 ],
481 },
482 &quot;jsonMode&quot;: &quot;A String&quot;, # Optional. MongoDB JSON mode to use for the stream.
483 &quot;maxConcurrentBackfillTasks&quot;: 42, # Optional. Maximum number of concurrent backfill tasks. The number should be non-negative and less than or equal to 50. If not set (or set to 0), the system&#x27;s default value is used
484 },
485 &quot;mysqlSourceConfig&quot;: { # Configuration for syncing data from a MySQL source. # MySQL data source configuration.
486 &quot;binaryLogPosition&quot;: { # Use Binary log position based replication. # Use Binary log position based replication.
487 },
488 &quot;excludeObjects&quot;: { # MySQL database structure # The MySQL objects to exclude from the stream.
489 &quot;mysqlDatabases&quot;: [ # Mysql databases on the server
490 { # MySQL database.
491 &quot;database&quot;: &quot;A String&quot;, # The database name.
492 &quot;mysqlTables&quot;: [ # Tables in the database.
493 { # MySQL table.
494 &quot;mysqlColumns&quot;: [ # MySQL columns in the database. When unspecified as part of include/exclude objects, includes/excludes everything.
495 { # MySQL Column.
496 &quot;collation&quot;: &quot;A String&quot;, # Column collation.
497 &quot;column&quot;: &quot;A String&quot;, # The column name.
498 &quot;dataType&quot;: &quot;A String&quot;, # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html
499 &quot;length&quot;: 42, # Column length.
500 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
501 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
502 &quot;precision&quot;: 42, # Column precision.
503 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
504 &quot;scale&quot;: 42, # Column scale.
505 },
506 ],
507 &quot;table&quot;: &quot;A String&quot;, # The table name.
508 },
509 ],
510 },
511 ],
512 },
513 &quot;gtid&quot;: { # Use GTID based replication. # Use GTID based replication.
514 },
515 &quot;includeObjects&quot;: { # MySQL database structure # The MySQL objects to retrieve from the source.
516 &quot;mysqlDatabases&quot;: [ # Mysql databases on the server
517 { # MySQL database.
518 &quot;database&quot;: &quot;A String&quot;, # The database name.
519 &quot;mysqlTables&quot;: [ # Tables in the database.
520 { # MySQL table.
521 &quot;mysqlColumns&quot;: [ # MySQL columns in the database. When unspecified as part of include/exclude objects, includes/excludes everything.
522 { # MySQL Column.
523 &quot;collation&quot;: &quot;A String&quot;, # Column collation.
524 &quot;column&quot;: &quot;A String&quot;, # The column name.
525 &quot;dataType&quot;: &quot;A String&quot;, # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html
526 &quot;length&quot;: 42, # Column length.
527 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
528 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
529 &quot;precision&quot;: 42, # Column precision.
530 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
531 &quot;scale&quot;: 42, # Column scale.
532 },
533 ],
534 &quot;table&quot;: &quot;A String&quot;, # The table name.
535 },
536 ],
537 },
538 ],
539 },
540 &quot;maxConcurrentBackfillTasks&quot;: 42, # Maximum number of concurrent backfill tasks. The number should be non negative. If not set (or set to 0), the system&#x27;s default value will be used.
541 &quot;maxConcurrentCdcTasks&quot;: 42, # Maximum number of concurrent CDC tasks. The number should be non negative. If not set (or set to 0), the system&#x27;s default value will be used.
542 },
543 &quot;oracleSourceConfig&quot;: { # Configuration for syncing data from an Oracle source. # Oracle data source configuration.
544 &quot;binaryLogParser&quot;: { # Configuration to use Binary Log Parser CDC technique. # Use Binary Log Parser.
545 &quot;logFileDirectories&quot;: { # Configuration to specify the Oracle directories to access the log files. # Use Oracle directories.
546 &quot;archivedLogDirectory&quot;: &quot;A String&quot;, # Required. Oracle directory for archived logs.
547 &quot;onlineLogDirectory&quot;: &quot;A String&quot;, # Required. Oracle directory for online logs.
548 },
549 &quot;oracleAsmLogFileAccess&quot;: { # Configuration to use Oracle ASM to access the log files. # Use Oracle ASM.
550 },
551 },
552 &quot;dropLargeObjects&quot;: { # Configuration to drop large object values. # Drop large object values.
553 },
554 &quot;excludeObjects&quot;: { # Oracle database structure. # The Oracle objects to exclude from the stream.
555 &quot;oracleSchemas&quot;: [ # Oracle schemas/databases in the database server.
556 { # Oracle schema.
557 &quot;oracleTables&quot;: [ # Tables in the schema.
558 { # Oracle table.
559 &quot;oracleColumns&quot;: [ # Oracle columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything.
560 { # Oracle Column.
561 &quot;column&quot;: &quot;A String&quot;, # The column name.
562 &quot;dataType&quot;: &quot;A String&quot;, # The Oracle data type.
563 &quot;encoding&quot;: &quot;A String&quot;, # Column encoding.
564 &quot;length&quot;: 42, # Column length.
565 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
566 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
567 &quot;precision&quot;: 42, # Column precision.
568 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
569 &quot;scale&quot;: 42, # Column scale.
570 },
571 ],
572 &quot;table&quot;: &quot;A String&quot;, # The table name.
573 },
574 ],
575 &quot;schema&quot;: &quot;A String&quot;, # The schema name.
576 },
577 ],
578 },
579 &quot;includeObjects&quot;: { # Oracle database structure. # The Oracle objects to include in the stream.
580 &quot;oracleSchemas&quot;: [ # Oracle schemas/databases in the database server.
581 { # Oracle schema.
582 &quot;oracleTables&quot;: [ # Tables in the schema.
583 { # Oracle table.
584 &quot;oracleColumns&quot;: [ # Oracle columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything.
585 { # Oracle Column.
586 &quot;column&quot;: &quot;A String&quot;, # The column name.
587 &quot;dataType&quot;: &quot;A String&quot;, # The Oracle data type.
588 &quot;encoding&quot;: &quot;A String&quot;, # Column encoding.
589 &quot;length&quot;: 42, # Column length.
590 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
591 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
592 &quot;precision&quot;: 42, # Column precision.
593 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
594 &quot;scale&quot;: 42, # Column scale.
595 },
596 ],
597 &quot;table&quot;: &quot;A String&quot;, # The table name.
598 },
599 ],
600 &quot;schema&quot;: &quot;A String&quot;, # The schema name.
601 },
602 ],
603 },
604 &quot;logMiner&quot;: { # Configuration to use LogMiner CDC method. # Use LogMiner.
605 },
606 &quot;maxConcurrentBackfillTasks&quot;: 42, # Maximum number of concurrent backfill tasks. The number should be non-negative. If not set (or set to 0), the system&#x27;s default value is used.
607 &quot;maxConcurrentCdcTasks&quot;: 42, # Maximum number of concurrent CDC tasks. The number should be non-negative. If not set (or set to 0), the system&#x27;s default value is used.
608 &quot;streamLargeObjects&quot;: { # Configuration to stream large object values. # Stream large object values.
609 },
610 },
611 &quot;postgresqlSourceConfig&quot;: { # Configuration for syncing data from a PostgreSQL source. # PostgreSQL data source configuration.
612 &quot;excludeObjects&quot;: { # PostgreSQL database structure. # The PostgreSQL objects to exclude from the stream.
613 &quot;postgresqlSchemas&quot;: [ # PostgreSQL schemas in the database server.
614 { # PostgreSQL schema.
615 &quot;postgresqlTables&quot;: [ # Tables in the schema.
616 { # PostgreSQL table.
617 &quot;postgresqlColumns&quot;: [ # PostgreSQL columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything.
618 { # PostgreSQL Column.
619 &quot;column&quot;: &quot;A String&quot;, # The column name.
620 &quot;dataType&quot;: &quot;A String&quot;, # The PostgreSQL data type.
621 &quot;length&quot;: 42, # Column length.
622 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
623 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
624 &quot;precision&quot;: 42, # Column precision.
625 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
626 &quot;scale&quot;: 42, # Column scale.
627 },
628 ],
629 &quot;table&quot;: &quot;A String&quot;, # The table name.
630 },
631 ],
632 &quot;schema&quot;: &quot;A String&quot;, # The schema name.
633 },
634 ],
635 },
636 &quot;includeObjects&quot;: { # PostgreSQL database structure. # The PostgreSQL objects to include in the stream.
637 &quot;postgresqlSchemas&quot;: [ # PostgreSQL schemas in the database server.
638 { # PostgreSQL schema.
639 &quot;postgresqlTables&quot;: [ # Tables in the schema.
640 { # PostgreSQL table.
641 &quot;postgresqlColumns&quot;: [ # PostgreSQL columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything.
642 { # PostgreSQL Column.
643 &quot;column&quot;: &quot;A String&quot;, # The column name.
644 &quot;dataType&quot;: &quot;A String&quot;, # The PostgreSQL data type.
645 &quot;length&quot;: 42, # Column length.
646 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
647 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
648 &quot;precision&quot;: 42, # Column precision.
649 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
650 &quot;scale&quot;: 42, # Column scale.
651 },
652 ],
653 &quot;table&quot;: &quot;A String&quot;, # The table name.
654 },
655 ],
656 &quot;schema&quot;: &quot;A String&quot;, # The schema name.
657 },
658 ],
659 },
660 &quot;maxConcurrentBackfillTasks&quot;: 42, # Maximum number of concurrent backfill tasks. The number should be non negative. If not set (or set to 0), the system&#x27;s default value will be used.
661 &quot;publication&quot;: &quot;A String&quot;, # Required. The name of the publication that includes the set of all tables that are defined in the stream&#x27;s include_objects.
662 &quot;replicationSlot&quot;: &quot;A String&quot;, # Required. Immutable. The name of the logical replication slot that&#x27;s configured with the pgoutput plugin.
663 },
664 &quot;salesforceMarketingCloudSourceConfig&quot;: { # Configuration for syncing data from a Salesforce Marketing Cloud source. # Salesforce Marketing Cloud data source configuration.
665 &quot;excludeObjects&quot;: { # Source catalog. # Optional. The objects to exclude from the stream.
666 &quot;objects&quot;: [ # Optional. Source objects in the catalog.
667 { # Source object.
668 &quot;objectName&quot;: &quot;A String&quot;, # Required. The object name.
669 &quot;properties&quot;: [ # Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
670 { # Source property.
671 &quot;primaryKey&quot;: True or False, # Optional. Whether or not the property is a primary key.
672 &quot;properties&quot;: [ # Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
673 # Object with schema name: SourceProperty
674 ],
675 &quot;propertyName&quot;: &quot;A String&quot;, # Required. The property name.
676 },
677 ],
678 },
679 ],
680 },
681 &quot;fullRefreshPollingInterval&quot;: &quot;A String&quot;, # Required. Specifies the polling interval for a full refresh of objects that do not support incremental sync. If not set, a default value of 24 hours is used. The duration must be between 1 and 24 hours, inclusive.
682 &quot;includeObjects&quot;: { # Source catalog. # Optional. The objects to retrieve from the source.
683 &quot;objects&quot;: [ # Optional. Source objects in the catalog.
684 { # Source object.
685 &quot;objectName&quot;: &quot;A String&quot;, # Required. The object name.
686 &quot;properties&quot;: [ # Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
687 { # Source property.
688 &quot;primaryKey&quot;: True or False, # Optional. Whether or not the property is a primary key.
689 &quot;properties&quot;: [ # Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
690 # Object with schema name: SourceProperty
691 ],
692 &quot;propertyName&quot;: &quot;A String&quot;, # Required. The property name.
693 },
694 ],
695 },
696 ],
697 },
698 &quot;pollingInterval&quot;: &quot;A String&quot;, # Required. Incremental sync polling interval for all objects. If not set, a default value of `5 minutes` is used. The duration must be from `5 minutes` to `24 hours`, inclusive.
699 },
700 &quot;salesforceSourceConfig&quot;: { # Configuration for syncing data from a Salesforce source. # Salesforce data source configuration.
701 &quot;excludeObjects&quot;: { # Salesforce organization structure. # The Salesforce objects to exclude from the stream.
702 &quot;objects&quot;: [ # Salesforce objects in the database server.
703 { # Salesforce object.
704 &quot;fields&quot;: [ # Salesforce fields. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
705 { # Salesforce field.
706 &quot;dataType&quot;: &quot;A String&quot;, # The data type.
707 &quot;name&quot;: &quot;A String&quot;, # The field name.
708 &quot;nillable&quot;: True or False, # Indicates whether the field can accept nil values.
709 },
710 ],
711 &quot;objectName&quot;: &quot;A String&quot;, # The object name.
712 },
713 ],
714 },
715 &quot;includeObjects&quot;: { # Salesforce organization structure. # The Salesforce objects to retrieve from the source.
716 &quot;objects&quot;: [ # Salesforce objects in the database server.
717 { # Salesforce object.
718 &quot;fields&quot;: [ # Salesforce fields. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
719 { # Salesforce field.
720 &quot;dataType&quot;: &quot;A String&quot;, # The data type.
721 &quot;name&quot;: &quot;A String&quot;, # The field name.
722 &quot;nillable&quot;: True or False, # Indicates whether the field can accept nil values.
723 },
724 ],
725 &quot;objectName&quot;: &quot;A String&quot;, # The object name.
726 },
727 ],
728 },
729 &quot;pollingInterval&quot;: &quot;A String&quot;, # Required. Salesforce objects polling interval. The interval at which new changes will be polled for each object. The duration must be from `5 minutes` to `24 hours`, inclusive.
730 },
731 &quot;serviceNowSourceConfig&quot;: { # Configuration for syncing data from a ServiceNow source. # ServiceNow data source configuration.
732 &quot;excludeObjects&quot;: { # Source catalog. # Optional. The objects to exclude from the stream.
733 &quot;objects&quot;: [ # Optional. Source objects in the catalog.
734 { # Source object.
735 &quot;objectName&quot;: &quot;A String&quot;, # Required. The object name.
736 &quot;properties&quot;: [ # Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
737 { # Source property.
738 &quot;primaryKey&quot;: True or False, # Optional. Whether or not the property is a primary key.
739 &quot;properties&quot;: [ # Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
740 # Object with schema name: SourceProperty
741 ],
742 &quot;propertyName&quot;: &quot;A String&quot;, # Required. The property name.
743 },
744 ],
745 },
746 ],
747 },
748 &quot;includeObjects&quot;: { # Source catalog. # Optional. The objects to retrieve from the source.
749 &quot;objects&quot;: [ # Optional. Source objects in the catalog.
750 { # Source object.
751 &quot;objectName&quot;: &quot;A String&quot;, # Required. The object name.
752 &quot;properties&quot;: [ # Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
753 { # Source property.
754 &quot;primaryKey&quot;: True or False, # Optional. Whether or not the property is a primary key.
755 &quot;properties&quot;: [ # Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
756 # Object with schema name: SourceProperty
757 ],
758 &quot;propertyName&quot;: &quot;A String&quot;, # Required. The property name.
759 },
760 ],
761 },
762 ],
763 },
764 &quot;pollingInterval&quot;: &quot;A String&quot;, # Required. Incremental sync polling interval for all objects. If not set, a default value of `5 minutes` is used. The duration must be from `5 minutes` to `24 hours`, inclusive.
765 },
766 &quot;sourceConnectionProfile&quot;: &quot;A String&quot;, # Required. Source connection profile resource. Format: `projects/{project}/locations/{location}/connectionProfiles/{name}`
767 &quot;spannerSourceConfig&quot;: { # Configuration for syncing data from a Spanner source. # Spanner data source configuration.
768 &quot;backfillDataBoostEnabled&quot;: True or False, # Optional. Whether to use Data Boost for Spanner backfills. Defaults to false if not set.
769 &quot;changeStreamName&quot;: &quot;A String&quot;, # Required. Immutable. The change stream name to use for the stream.
770 &quot;excludeObjects&quot;: { # Spanner database structure. # Optional. The Spanner objects to avoid retrieving. If some objects are both included and excluded, an error will be thrown.
771 &quot;schemas&quot;: [ # Optional. Spanner schemas in the database.
772 { # Spanner schema.
773 &quot;schema&quot;: &quot;A String&quot;, # Required. The schema name.
774 &quot;tables&quot;: [ # Optional. Spanner tables in the schema.
775 { # Spanner table.
776 &quot;columns&quot;: [ # Optional. Spanner columns in the table.
777 { # Spanner column.
778 &quot;column&quot;: &quot;A String&quot;, # Required. The column name.
779 &quot;dataType&quot;: &quot;A String&quot;, # Optional. Spanner data type.
780 &quot;isPrimaryKey&quot;: True or False, # Optional. Whether or not the column is a primary key.
781 &quot;ordinalPosition&quot;: &quot;A String&quot;, # Optional. The ordinal position of the column in the table.
782 },
783 ],
784 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
785 },
786 ],
787 },
788 ],
789 },
790 &quot;fgacRole&quot;: &quot;A String&quot;, # Optional. The FGAC role to use for the stream.
791 &quot;includeObjects&quot;: { # Spanner database structure. # Optional. The Spanner objects to retrieve from the data source. If some objects are both included and excluded, an error will be thrown.
792 &quot;schemas&quot;: [ # Optional. Spanner schemas in the database.
793 { # Spanner schema.
794 &quot;schema&quot;: &quot;A String&quot;, # Required. The schema name.
795 &quot;tables&quot;: [ # Optional. Spanner tables in the schema.
796 { # Spanner table.
797 &quot;columns&quot;: [ # Optional. Spanner columns in the table.
798 { # Spanner column.
799 &quot;column&quot;: &quot;A String&quot;, # Required. The column name.
800 &quot;dataType&quot;: &quot;A String&quot;, # Optional. Spanner data type.
801 &quot;isPrimaryKey&quot;: True or False, # Optional. Whether or not the column is a primary key.
802 &quot;ordinalPosition&quot;: &quot;A String&quot;, # Optional. The ordinal position of the column in the table.
803 },
804 ],
805 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
806 },
807 ],
808 },
809 ],
810 },
811 &quot;maxConcurrentBackfillTasks&quot;: 42, # Optional. Maximum number of concurrent backfill tasks.
812 &quot;maxConcurrentCdcTasks&quot;: 42, # Optional. Maximum number of concurrent CDC tasks.
813 &quot;spannerRpcPriority&quot;: &quot;A String&quot;, # Optional. The RPC priority to use for the stream.
814 },
815 &quot;sqlServerSourceConfig&quot;: { # Configuration for syncing data from a SQLServer source. # SQLServer data source configuration.
816 &quot;changeTables&quot;: { # Configuration to use Change Tables CDC read method. # CDC reader reads from change tables.
817 },
818 &quot;excludeObjects&quot;: { # SQLServer database structure. # The SQLServer objects to exclude from the stream.
819 &quot;schemas&quot;: [ # SQLServer schemas in the database server.
820 { # SQLServer schema.
821 &quot;schema&quot;: &quot;A String&quot;, # The schema name.
822 &quot;tables&quot;: [ # Tables in the schema.
823 { # SQLServer table.
824 &quot;columns&quot;: [ # SQLServer columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything.
825 { # SQLServer Column.
826 &quot;column&quot;: &quot;A String&quot;, # The column name.
827 &quot;dataType&quot;: &quot;A String&quot;, # The SQLServer data type.
828 &quot;length&quot;: 42, # Column length.
829 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
830 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
831 &quot;precision&quot;: 42, # Column precision.
832 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
833 &quot;scale&quot;: 42, # Column scale.
834 },
835 ],
836 &quot;table&quot;: &quot;A String&quot;, # The table name.
837 },
838 ],
839 },
840 ],
841 },
842 &quot;includeObjects&quot;: { # SQLServer database structure. # The SQLServer objects to include in the stream.
843 &quot;schemas&quot;: [ # SQLServer schemas in the database server.
844 { # SQLServer schema.
845 &quot;schema&quot;: &quot;A String&quot;, # The schema name.
846 &quot;tables&quot;: [ # Tables in the schema.
847 { # SQLServer table.
848 &quot;columns&quot;: [ # SQLServer columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything.
849 { # SQLServer Column.
850 &quot;column&quot;: &quot;A String&quot;, # The column name.
851 &quot;dataType&quot;: &quot;A String&quot;, # The SQLServer data type.
852 &quot;length&quot;: 42, # Column length.
853 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
854 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
855 &quot;precision&quot;: 42, # Column precision.
856 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
857 &quot;scale&quot;: 42, # Column scale.
858 },
859 ],
860 &quot;table&quot;: &quot;A String&quot;, # The table name.
861 },
862 ],
863 },
864 ],
865 },
866 &quot;maxConcurrentBackfillTasks&quot;: 42, # Max concurrent backfill tasks.
867 &quot;maxConcurrentCdcTasks&quot;: 42, # Max concurrent CDC tasks.
868 &quot;transactionLogs&quot;: { # Configuration to use Transaction Logs CDC read method. # CDC reader reads from transaction logs.
869 },
870 },
871 },
872 &quot;state&quot;: &quot;A String&quot;, # The state of the stream.
873 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update time of the stream.
874 }
875
876 force: boolean, Optional. Create the stream without validating it.
877 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).
878 streamId: string, Required. The stream identifier.
879 validateOnly: boolean, Optional. Only validate the stream, but don&#x27;t create any resources. The default is false.
880 x__xgafv: string, V1 error format.
881 Allowed values
882 1 - v1 error format
883 2 - v2 error format
884
885 Returns:
886 An object of the form:
887
888 { # This resource represents a long-running operation that is the result of a network API call.
889 &quot;done&quot;: 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.
890 &quot;error&quot;: { # 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.
891 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
892 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
893 {
894 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
895 },
896 ],
897 &quot;message&quot;: &quot;A String&quot;, # 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.
898 },
899 &quot;metadata&quot;: { # 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.
900 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
901 },
902 &quot;name&quot;: &quot;A String&quot;, # 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}`.
903 &quot;response&quot;: { # 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`.
904 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
905 },
906 }</pre>
907 </div>
908
909 <div class="method">
910 <code class="details" id="delete">delete(name, requestId=None, x__xgafv=None)</code>
911 <pre>Use this method to delete a stream.
912
913 Args:
914 name: string, Required. The name of the stream resource to delete. (required)
915 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).
916 x__xgafv: string, V1 error format.
917 Allowed values
918 1 - v1 error format
919 2 - v2 error format
920
921 Returns:
922 An object of the form:
923
924 { # This resource represents a long-running operation that is the result of a network API call.
925 &quot;done&quot;: 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.
926 &quot;error&quot;: { # 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.
927 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
928 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
929 {
930 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
931 },
932 ],
933 &quot;message&quot;: &quot;A String&quot;, # 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.
934 },
935 &quot;metadata&quot;: { # 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.
936 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
937 },
938 &quot;name&quot;: &quot;A String&quot;, # 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}`.
939 &quot;response&quot;: { # 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`.
940 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
941 },
942 }</pre>
943 </div>
944
945 <div class="method">
946 <code class="details" id="get">get(name, x__xgafv=None)</code>
947 <pre>Use this method to get details about a stream.
948
949 Args:
950 name: string, Required. The name of the stream resource to get. (required)
951 x__xgafv: string, V1 error format.
952 Allowed values
953 1 - v1 error format
954 2 - v2 error format
955
956 Returns:
957 An object of the form:
958
959 { # A resource representing streaming data from a source to a destination.
960 &quot;backfillAll&quot;: { # Backfill strategy to automatically backfill the Stream&#x27;s objects. Specific objects can be excluded. # Automatically backfill objects included in the stream source configuration. Specific objects can be excluded.
961 &quot;mongodbExcludedObjects&quot;: { # MongoDB Cluster structure. # MongoDB data source objects to avoid backfilling
962 &quot;databases&quot;: [ # MongoDB databases in the cluster.
963 { # MongoDB Database.
964 &quot;collections&quot;: [ # Collections in the database.
965 { # MongoDB Collection.
966 &quot;collection&quot;: &quot;A String&quot;, # The collection name.
967 &quot;fields&quot;: [ # Fields in the collection.
968 { # MongoDB Field.
969 &quot;field&quot;: &quot;A String&quot;, # The field name.
970 },
971 ],
972 },
973 ],
974 &quot;database&quot;: &quot;A String&quot;, # The database name.
975 },
976 ],
977 },
978 &quot;mysqlExcludedObjects&quot;: { # MySQL database structure # MySQL data source objects to avoid backfilling.
979 &quot;mysqlDatabases&quot;: [ # Mysql databases on the server
980 { # MySQL database.
981 &quot;database&quot;: &quot;A String&quot;, # The database name.
982 &quot;mysqlTables&quot;: [ # Tables in the database.
983 { # MySQL table.
984 &quot;mysqlColumns&quot;: [ # MySQL columns in the database. When unspecified as part of include/exclude objects, includes/excludes everything.
985 { # MySQL Column.
986 &quot;collation&quot;: &quot;A String&quot;, # Column collation.
987 &quot;column&quot;: &quot;A String&quot;, # The column name.
988 &quot;dataType&quot;: &quot;A String&quot;, # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html
989 &quot;length&quot;: 42, # Column length.
990 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
991 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
992 &quot;precision&quot;: 42, # Column precision.
993 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
994 &quot;scale&quot;: 42, # Column scale.
995 },
996 ],
997 &quot;table&quot;: &quot;A String&quot;, # The table name.
998 },
999 ],
1000 },
1001 ],
1002 },
1003 &quot;oracleExcludedObjects&quot;: { # Oracle database structure. # Oracle data source objects to avoid backfilling.
1004 &quot;oracleSchemas&quot;: [ # Oracle schemas/databases in the database server.
1005 { # Oracle schema.
1006 &quot;oracleTables&quot;: [ # Tables in the schema.
1007 { # Oracle table.
1008 &quot;oracleColumns&quot;: [ # Oracle columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything.
1009 { # Oracle Column.
1010 &quot;column&quot;: &quot;A String&quot;, # The column name.
1011 &quot;dataType&quot;: &quot;A String&quot;, # The Oracle data type.
1012 &quot;encoding&quot;: &quot;A String&quot;, # Column encoding.
1013 &quot;length&quot;: 42, # Column length.
1014 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
1015 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
1016 &quot;precision&quot;: 42, # Column precision.
1017 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
1018 &quot;scale&quot;: 42, # Column scale.
1019 },
1020 ],
1021 &quot;table&quot;: &quot;A String&quot;, # The table name.
1022 },
1023 ],
1024 &quot;schema&quot;: &quot;A String&quot;, # The schema name.
1025 },
1026 ],
1027 },
1028 &quot;postgresqlExcludedObjects&quot;: { # PostgreSQL database structure. # PostgreSQL data source objects to avoid backfilling.
1029 &quot;postgresqlSchemas&quot;: [ # PostgreSQL schemas in the database server.
1030 { # PostgreSQL schema.
1031 &quot;postgresqlTables&quot;: [ # Tables in the schema.
1032 { # PostgreSQL table.
1033 &quot;postgresqlColumns&quot;: [ # PostgreSQL columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything.
1034 { # PostgreSQL Column.
1035 &quot;column&quot;: &quot;A String&quot;, # The column name.
1036 &quot;dataType&quot;: &quot;A String&quot;, # The PostgreSQL data type.
1037 &quot;length&quot;: 42, # Column length.
1038 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
1039 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
1040 &quot;precision&quot;: 42, # Column precision.
1041 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
1042 &quot;scale&quot;: 42, # Column scale.
1043 },
1044 ],
1045 &quot;table&quot;: &quot;A String&quot;, # The table name.
1046 },
1047 ],
1048 &quot;schema&quot;: &quot;A String&quot;, # The schema name.
1049 },
1050 ],
1051 },
1052 &quot;saasExcludedObjects&quot;: { # Source catalog. # Source catalog data source objects to avoid backfilling. This is mainly used to represent SaaS applications objects.
1053 &quot;objects&quot;: [ # Optional. Source objects in the catalog.
1054 { # Source object.
1055 &quot;objectName&quot;: &quot;A String&quot;, # Required. The object name.
1056 &quot;properties&quot;: [ # Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
1057 { # Source property.
1058 &quot;primaryKey&quot;: True or False, # Optional. Whether or not the property is a primary key.
1059 &quot;properties&quot;: [ # Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
1060 # Object with schema name: SourceProperty
1061 ],
1062 &quot;propertyName&quot;: &quot;A String&quot;, # Required. The property name.
1063 },
1064 ],
1065 },
1066 ],
1067 },
1068 &quot;salesforceExcludedObjects&quot;: { # Salesforce organization structure. # Salesforce data source objects to avoid backfilling
1069 &quot;objects&quot;: [ # Salesforce objects in the database server.
1070 { # Salesforce object.
1071 &quot;fields&quot;: [ # Salesforce fields. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
1072 { # Salesforce field.
1073 &quot;dataType&quot;: &quot;A String&quot;, # The data type.
1074 &quot;name&quot;: &quot;A String&quot;, # The field name.
1075 &quot;nillable&quot;: True or False, # Indicates whether the field can accept nil values.
1076 },
1077 ],
1078 &quot;objectName&quot;: &quot;A String&quot;, # The object name.
1079 },
1080 ],
1081 },
1082 &quot;spannerExcludedObjects&quot;: { # Spanner database structure. # Spanner data source objects to avoid backfilling.
1083 &quot;schemas&quot;: [ # Optional. Spanner schemas in the database.
1084 { # Spanner schema.
1085 &quot;schema&quot;: &quot;A String&quot;, # Required. The schema name.
1086 &quot;tables&quot;: [ # Optional. Spanner tables in the schema.
1087 { # Spanner table.
1088 &quot;columns&quot;: [ # Optional. Spanner columns in the table.
1089 { # Spanner column.
1090 &quot;column&quot;: &quot;A String&quot;, # Required. The column name.
1091 &quot;dataType&quot;: &quot;A String&quot;, # Optional. Spanner data type.
1092 &quot;isPrimaryKey&quot;: True or False, # Optional. Whether or not the column is a primary key.
1093 &quot;ordinalPosition&quot;: &quot;A String&quot;, # Optional. The ordinal position of the column in the table.
1094 },
1095 ],
1096 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
1097 },
1098 ],
1099 },
1100 ],
1101 },
1102 &quot;sqlServerExcludedObjects&quot;: { # SQLServer database structure. # SQLServer data source objects to avoid backfilling
1103 &quot;schemas&quot;: [ # SQLServer schemas in the database server.
1104 { # SQLServer schema.
1105 &quot;schema&quot;: &quot;A String&quot;, # The schema name.
1106 &quot;tables&quot;: [ # Tables in the schema.
1107 { # SQLServer table.
1108 &quot;columns&quot;: [ # SQLServer columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything.
1109 { # SQLServer Column.
1110 &quot;column&quot;: &quot;A String&quot;, # The column name.
1111 &quot;dataType&quot;: &quot;A String&quot;, # The SQLServer data type.
1112 &quot;length&quot;: 42, # Column length.
1113 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
1114 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
1115 &quot;precision&quot;: 42, # Column precision.
1116 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
1117 &quot;scale&quot;: 42, # Column scale.
1118 },
1119 ],
1120 &quot;table&quot;: &quot;A String&quot;, # The table name.
1121 },
1122 ],
1123 },
1124 ],
1125 },
1126 },
1127 &quot;backfillNone&quot;: { # Backfill strategy to disable automatic backfill for the Stream&#x27;s objects. # Do not automatically backfill any objects.
1128 },
1129 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation time of the stream.
1130 &quot;customerManagedEncryptionKey&quot;: &quot;A String&quot;, # 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.
1131 &quot;destinationConfig&quot;: { # The configuration of the stream destination. # Required. Destination connection profile configuration.
1132 &quot;bigqueryDestinationConfig&quot;: { # BigQuery destination configuration # BigQuery destination configuration.
1133 &quot;appendOnly&quot;: { # AppendOnly mode defines that all changes to a table will be written to the destination table. # Append only mode
1134 },
1135 &quot;blmtConfig&quot;: { # The configuration for BLMT. # Optional. Big Lake Managed Tables (BLMT) configuration.
1136 &quot;bucket&quot;: &quot;A String&quot;, # Required. The Cloud Storage bucket name.
1137 &quot;connectionName&quot;: &quot;A String&quot;, # Required. The bigquery connection. Format: `{project}.{location}.{name}`
1138 &quot;fileFormat&quot;: &quot;A String&quot;, # Required. The file format.
1139 &quot;rootPath&quot;: &quot;A String&quot;, # The root path inside the Cloud Storage bucket.
1140 &quot;tableFormat&quot;: &quot;A String&quot;, # Required. The table format.
1141 },
1142 &quot;dataFreshness&quot;: &quot;A String&quot;, # The guaranteed data freshness (in seconds) when querying tables created by the stream. Editing this field will only affect new tables created in the future, but existing tables will not be impacted. Lower values mean that queries will return fresher data, but may result in higher cost.
1143 &quot;merge&quot;: { # Merge mode defines that all changes to a table will be merged at the destination table. # The standard mode
1144 },
1145 &quot;singleTargetDataset&quot;: { # A single target dataset to which all data will be streamed. # Single destination dataset.
1146 &quot;datasetId&quot;: &quot;A String&quot;, # The dataset ID of the target dataset. DatasetIds allowed characters: https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets#datasetreference.
1147 },
1148 &quot;sourceHierarchyDatasets&quot;: { # Destination datasets are created so that hierarchy of the destination data objects matches the source hierarchy. # Source hierarchy datasets.
1149 &quot;datasetTemplate&quot;: { # Dataset template used for dynamic dataset creation. # The dataset template to use for dynamic dataset creation.
1150 &quot;datasetIdPrefix&quot;: &quot;A String&quot;, # If supplied, every created dataset will have its name prefixed by the provided value. The prefix and name will be separated by an underscore. i.e. _.
1151 &quot;kmsKeyName&quot;: &quot;A String&quot;, # Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key. i.e. projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{cryptoKey}. See https://cloud.google.com/bigquery/docs/customer-managed-encryption for more information.
1152 &quot;location&quot;: &quot;A String&quot;, # Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
1153 },
1154 &quot;projectId&quot;: &quot;A String&quot;, # Optional. The project id of the BigQuery dataset. If not specified, the project will be inferred from the stream resource.
1155 },
1156 },
1157 &quot;destinationConnectionProfile&quot;: &quot;A String&quot;, # Required. Destination connection profile resource. Format: `projects/{project}/locations/{location}/connectionProfiles/{name}`
1158 &quot;gcsDestinationConfig&quot;: { # Google Cloud Storage destination configuration # A configuration for how data should be loaded to Cloud Storage.
1159 &quot;avroFileFormat&quot;: { # AVRO file format configuration. # AVRO file format configuration.
1160 },
1161 &quot;fileRotationInterval&quot;: &quot;A String&quot;, # The maximum duration for which new events are added before a file is closed and a new file is created. Values within the range of 15-60 seconds are allowed.
1162 &quot;fileRotationMb&quot;: 42, # The maximum file size to be saved in the bucket.
1163 &quot;jsonFileFormat&quot;: { # JSON file format configuration. # JSON file format configuration.
1164 &quot;compression&quot;: &quot;A String&quot;, # Compression of the loaded JSON file.
1165 &quot;schemaFileFormat&quot;: &quot;A String&quot;, # The schema file format along JSON data files.
1166 },
1167 &quot;path&quot;: &quot;A String&quot;, # Path inside the Cloud Storage bucket to write data to.
1168 },
1169 },
1170 &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name.
1171 &quot;errors&quot;: [ # Output only. Errors on the Stream.
1172 { # Represent a user-facing Error.
1173 &quot;details&quot;: { # Additional information about the error.
1174 &quot;a_key&quot;: &quot;A String&quot;,
1175 },
1176 &quot;errorTime&quot;: &quot;A String&quot;, # The time when the error occurred.
1177 &quot;errorUuid&quot;: &quot;A String&quot;, # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
1178 &quot;message&quot;: &quot;A String&quot;, # A message containing more information about the error that occurred.
1179 &quot;reason&quot;: &quot;A String&quot;, # A title that explains the reason for the error.
1180 },
1181 ],
1182 &quot;labels&quot;: { # Labels.
1183 &quot;a_key&quot;: &quot;A String&quot;,
1184 },
1185 &quot;lastRecoveryTime&quot;: &quot;A String&quot;, # Output only. If the stream was recovered, the time of the last recovery. Note: This field is currently experimental.
1186 &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The stream&#x27;s name.
1187 &quot;ruleSets&quot;: [ # Optional. Rule sets to apply to the stream.
1188 { # A set of rules to apply to a set of objects.
1189 &quot;customizationRules&quot;: [ # Required. List of customization rules to apply.
1190 { # A customization rule to apply to a set of objects.
1191 &quot;bigqueryClustering&quot;: { # BigQuery clustering configuration. # BigQuery clustering rule.
1192 &quot;columns&quot;: [ # Required. Column names to set as clustering columns.
1193 &quot;A String&quot;,
1194 ],
1195 },
1196 &quot;bigqueryPartitioning&quot;: { # BigQuery partitioning configuration. # BigQuery partitioning rule.
1197 &quot;ingestionTimePartition&quot;: { # Ingestion time partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time # Ingestion time partitioning.
1198 &quot;partitioningTimeGranularity&quot;: &quot;A String&quot;, # Optional. Partition granularity
1199 },
1200 &quot;integerRangePartition&quot;: { # Integer range partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#integer_range # Integer range partitioning.
1201 &quot;column&quot;: &quot;A String&quot;, # Required. The partitioning column.
1202 &quot;end&quot;: &quot;A String&quot;, # Required. The ending value for range partitioning (exclusive).
1203 &quot;interval&quot;: &quot;A String&quot;, # Required. The interval of each range within the partition.
1204 &quot;start&quot;: &quot;A String&quot;, # Required. The starting value for range partitioning (inclusive).
1205 },
1206 &quot;requirePartitionFilter&quot;: True or False, # Optional. If true, queries over the table require a partition filter.
1207 &quot;timeUnitPartition&quot;: { # Time unit column partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#date_timestamp_partitioned_tables # Time unit column partitioning.
1208 &quot;column&quot;: &quot;A String&quot;, # Required. The partitioning column.
1209 &quot;partitioningTimeGranularity&quot;: &quot;A String&quot;, # Optional. Partition granularity.
1210 },
1211 },
1212 },
1213 ],
1214 &quot;objectFilter&quot;: { # Object filter to apply the rules to. # Required. Object filter to apply the customization rules to.
1215 &quot;sourceObjectIdentifier&quot;: { # Represents an identifier of an object in the data source. # Specific source object identifier.
1216 &quot;mongodbIdentifier&quot;: { # MongoDB data source object identifier. # MongoDB data source object identifier.
1217 &quot;collection&quot;: &quot;A String&quot;, # Required. The collection name.
1218 &quot;database&quot;: &quot;A String&quot;, # Required. The database name.
1219 },
1220 &quot;mysqlIdentifier&quot;: { # Mysql data source object identifier. # Mysql data source object identifier.
1221 &quot;database&quot;: &quot;A String&quot;, # Required. The database name.
1222 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
1223 },
1224 &quot;oracleIdentifier&quot;: { # Oracle data source object identifier. # Oracle data source object identifier.
1225 &quot;schema&quot;: &quot;A String&quot;, # Required. The schema name.
1226 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
1227 },
1228 &quot;postgresqlIdentifier&quot;: { # PostgreSQL data source object identifier. # PostgreSQL data source object identifier.
1229 &quot;schema&quot;: &quot;A String&quot;, # Required. The schema name.
1230 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
1231 },
1232 &quot;salesforceIdentifier&quot;: { # Salesforce data source object identifier. # Salesforce data source object identifier.
1233 &quot;objectName&quot;: &quot;A String&quot;, # Required. The object name.
1234 },
1235 &quot;spannerIdentifier&quot;: { # Spanner data source object identifier. # Spanner data source object identifier.
1236 &quot;schema&quot;: &quot;A String&quot;, # Optional. The schema name.
1237 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
1238 },
1239 &quot;sqlServerIdentifier&quot;: { # SQLServer data source object identifier. # SQLServer data source object identifier.
1240 &quot;schema&quot;: &quot;A String&quot;, # Required. The schema name.
1241 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
1242 },
1243 },
1244 },
1245 },
1246 ],
1247 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
1248 &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
1249 &quot;sourceConfig&quot;: { # The configuration of the stream source. # Required. Source connection profile configuration.
1250 &quot;dataverseSourceConfig&quot;: { # Configuration for syncing data from a Dataverse source. # Dataverse data source configuration.
1251 &quot;excludeObjects&quot;: { # Source catalog. # Optional. The objects to exclude from the stream.
1252 &quot;objects&quot;: [ # Optional. Source objects in the catalog.
1253 { # Source object.
1254 &quot;objectName&quot;: &quot;A String&quot;, # Required. The object name.
1255 &quot;properties&quot;: [ # Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
1256 { # Source property.
1257 &quot;primaryKey&quot;: True or False, # Optional. Whether or not the property is a primary key.
1258 &quot;properties&quot;: [ # Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
1259 # Object with schema name: SourceProperty
1260 ],
1261 &quot;propertyName&quot;: &quot;A String&quot;, # Required. The property name.
1262 },
1263 ],
1264 },
1265 ],
1266 },
1267 &quot;includeObjects&quot;: { # Source catalog. # Optional. The objects to retrieve from the source.
1268 &quot;objects&quot;: [ # Optional. Source objects in the catalog.
1269 { # Source object.
1270 &quot;objectName&quot;: &quot;A String&quot;, # Required. The object name.
1271 &quot;properties&quot;: [ # Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
1272 { # Source property.
1273 &quot;primaryKey&quot;: True or False, # Optional. Whether or not the property is a primary key.
1274 &quot;properties&quot;: [ # Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
1275 # Object with schema name: SourceProperty
1276 ],
1277 &quot;propertyName&quot;: &quot;A String&quot;, # Required. The property name.
1278 },
1279 ],
1280 },
1281 ],
1282 },
1283 &quot;pollingInterval&quot;: &quot;A String&quot;, # Required. Incremental sync polling interval for all objects. If not set, a default value of `5 minutes` is used. The duration must be from `5 minutes` to `24 hours`, inclusive.
1284 },
1285 &quot;mongodbSourceConfig&quot;: { # Configuration for syncing data from a MongoDB source. # MongoDB data source configuration.
1286 &quot;excludeObjects&quot;: { # MongoDB Cluster structure. # The MongoDB collections to exclude from the stream.
1287 &quot;databases&quot;: [ # MongoDB databases in the cluster.
1288 { # MongoDB Database.
1289 &quot;collections&quot;: [ # Collections in the database.
1290 { # MongoDB Collection.
1291 &quot;collection&quot;: &quot;A String&quot;, # The collection name.
1292 &quot;fields&quot;: [ # Fields in the collection.
1293 { # MongoDB Field.
1294 &quot;field&quot;: &quot;A String&quot;, # The field name.
1295 },
1296 ],
1297 },
1298 ],
1299 &quot;database&quot;: &quot;A String&quot;, # The database name.
1300 },
1301 ],
1302 },
1303 &quot;includeObjects&quot;: { # MongoDB Cluster structure. # The MongoDB collections to include in the stream.
1304 &quot;databases&quot;: [ # MongoDB databases in the cluster.
1305 { # MongoDB Database.
1306 &quot;collections&quot;: [ # Collections in the database.
1307 { # MongoDB Collection.
1308 &quot;collection&quot;: &quot;A String&quot;, # The collection name.
1309 &quot;fields&quot;: [ # Fields in the collection.
1310 { # MongoDB Field.
1311 &quot;field&quot;: &quot;A String&quot;, # The field name.
1312 },
1313 ],
1314 },
1315 ],
1316 &quot;database&quot;: &quot;A String&quot;, # The database name.
1317 },
1318 ],
1319 },
1320 &quot;jsonMode&quot;: &quot;A String&quot;, # Optional. MongoDB JSON mode to use for the stream.
1321 &quot;maxConcurrentBackfillTasks&quot;: 42, # Optional. Maximum number of concurrent backfill tasks. The number should be non-negative and less than or equal to 50. If not set (or set to 0), the system&#x27;s default value is used
1322 },
1323 &quot;mysqlSourceConfig&quot;: { # Configuration for syncing data from a MySQL source. # MySQL data source configuration.
1324 &quot;binaryLogPosition&quot;: { # Use Binary log position based replication. # Use Binary log position based replication.
1325 },
1326 &quot;excludeObjects&quot;: { # MySQL database structure # The MySQL objects to exclude from the stream.
1327 &quot;mysqlDatabases&quot;: [ # Mysql databases on the server
1328 { # MySQL database.
1329 &quot;database&quot;: &quot;A String&quot;, # The database name.
1330 &quot;mysqlTables&quot;: [ # Tables in the database.
1331 { # MySQL table.
1332 &quot;mysqlColumns&quot;: [ # MySQL columns in the database. When unspecified as part of include/exclude objects, includes/excludes everything.
1333 { # MySQL Column.
1334 &quot;collation&quot;: &quot;A String&quot;, # Column collation.
1335 &quot;column&quot;: &quot;A String&quot;, # The column name.
1336 &quot;dataType&quot;: &quot;A String&quot;, # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html
1337 &quot;length&quot;: 42, # Column length.
1338 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
1339 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
1340 &quot;precision&quot;: 42, # Column precision.
1341 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
1342 &quot;scale&quot;: 42, # Column scale.
1343 },
1344 ],
1345 &quot;table&quot;: &quot;A String&quot;, # The table name.
1346 },
1347 ],
1348 },
1349 ],
1350 },
1351 &quot;gtid&quot;: { # Use GTID based replication. # Use GTID based replication.
1352 },
1353 &quot;includeObjects&quot;: { # MySQL database structure # The MySQL objects to retrieve from the source.
1354 &quot;mysqlDatabases&quot;: [ # Mysql databases on the server
1355 { # MySQL database.
1356 &quot;database&quot;: &quot;A String&quot;, # The database name.
1357 &quot;mysqlTables&quot;: [ # Tables in the database.
1358 { # MySQL table.
1359 &quot;mysqlColumns&quot;: [ # MySQL columns in the database. When unspecified as part of include/exclude objects, includes/excludes everything.
1360 { # MySQL Column.
1361 &quot;collation&quot;: &quot;A String&quot;, # Column collation.
1362 &quot;column&quot;: &quot;A String&quot;, # The column name.
1363 &quot;dataType&quot;: &quot;A String&quot;, # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html
1364 &quot;length&quot;: 42, # Column length.
1365 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
1366 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
1367 &quot;precision&quot;: 42, # Column precision.
1368 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
1369 &quot;scale&quot;: 42, # Column scale.
1370 },
1371 ],
1372 &quot;table&quot;: &quot;A String&quot;, # The table name.
1373 },
1374 ],
1375 },
1376 ],
1377 },
1378 &quot;maxConcurrentBackfillTasks&quot;: 42, # Maximum number of concurrent backfill tasks. The number should be non negative. If not set (or set to 0), the system&#x27;s default value will be used.
1379 &quot;maxConcurrentCdcTasks&quot;: 42, # Maximum number of concurrent CDC tasks. The number should be non negative. If not set (or set to 0), the system&#x27;s default value will be used.
1380 },
1381 &quot;oracleSourceConfig&quot;: { # Configuration for syncing data from an Oracle source. # Oracle data source configuration.
1382 &quot;binaryLogParser&quot;: { # Configuration to use Binary Log Parser CDC technique. # Use Binary Log Parser.
1383 &quot;logFileDirectories&quot;: { # Configuration to specify the Oracle directories to access the log files. # Use Oracle directories.
1384 &quot;archivedLogDirectory&quot;: &quot;A String&quot;, # Required. Oracle directory for archived logs.
1385 &quot;onlineLogDirectory&quot;: &quot;A String&quot;, # Required. Oracle directory for online logs.
1386 },
1387 &quot;oracleAsmLogFileAccess&quot;: { # Configuration to use Oracle ASM to access the log files. # Use Oracle ASM.
1388 },
1389 },
1390 &quot;dropLargeObjects&quot;: { # Configuration to drop large object values. # Drop large object values.
1391 },
1392 &quot;excludeObjects&quot;: { # Oracle database structure. # The Oracle objects to exclude from the stream.
1393 &quot;oracleSchemas&quot;: [ # Oracle schemas/databases in the database server.
1394 { # Oracle schema.
1395 &quot;oracleTables&quot;: [ # Tables in the schema.
1396 { # Oracle table.
1397 &quot;oracleColumns&quot;: [ # Oracle columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything.
1398 { # Oracle Column.
1399 &quot;column&quot;: &quot;A String&quot;, # The column name.
1400 &quot;dataType&quot;: &quot;A String&quot;, # The Oracle data type.
1401 &quot;encoding&quot;: &quot;A String&quot;, # Column encoding.
1402 &quot;length&quot;: 42, # Column length.
1403 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
1404 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
1405 &quot;precision&quot;: 42, # Column precision.
1406 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
1407 &quot;scale&quot;: 42, # Column scale.
1408 },
1409 ],
1410 &quot;table&quot;: &quot;A String&quot;, # The table name.
1411 },
1412 ],
1413 &quot;schema&quot;: &quot;A String&quot;, # The schema name.
1414 },
1415 ],
1416 },
1417 &quot;includeObjects&quot;: { # Oracle database structure. # The Oracle objects to include in the stream.
1418 &quot;oracleSchemas&quot;: [ # Oracle schemas/databases in the database server.
1419 { # Oracle schema.
1420 &quot;oracleTables&quot;: [ # Tables in the schema.
1421 { # Oracle table.
1422 &quot;oracleColumns&quot;: [ # Oracle columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything.
1423 { # Oracle Column.
1424 &quot;column&quot;: &quot;A String&quot;, # The column name.
1425 &quot;dataType&quot;: &quot;A String&quot;, # The Oracle data type.
1426 &quot;encoding&quot;: &quot;A String&quot;, # Column encoding.
1427 &quot;length&quot;: 42, # Column length.
1428 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
1429 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
1430 &quot;precision&quot;: 42, # Column precision.
1431 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
1432 &quot;scale&quot;: 42, # Column scale.
1433 },
1434 ],
1435 &quot;table&quot;: &quot;A String&quot;, # The table name.
1436 },
1437 ],
1438 &quot;schema&quot;: &quot;A String&quot;, # The schema name.
1439 },
1440 ],
1441 },
1442 &quot;logMiner&quot;: { # Configuration to use LogMiner CDC method. # Use LogMiner.
1443 },
1444 &quot;maxConcurrentBackfillTasks&quot;: 42, # Maximum number of concurrent backfill tasks. The number should be non-negative. If not set (or set to 0), the system&#x27;s default value is used.
1445 &quot;maxConcurrentCdcTasks&quot;: 42, # Maximum number of concurrent CDC tasks. The number should be non-negative. If not set (or set to 0), the system&#x27;s default value is used.
1446 &quot;streamLargeObjects&quot;: { # Configuration to stream large object values. # Stream large object values.
1447 },
1448 },
1449 &quot;postgresqlSourceConfig&quot;: { # Configuration for syncing data from a PostgreSQL source. # PostgreSQL data source configuration.
1450 &quot;excludeObjects&quot;: { # PostgreSQL database structure. # The PostgreSQL objects to exclude from the stream.
1451 &quot;postgresqlSchemas&quot;: [ # PostgreSQL schemas in the database server.
1452 { # PostgreSQL schema.
1453 &quot;postgresqlTables&quot;: [ # Tables in the schema.
1454 { # PostgreSQL table.
1455 &quot;postgresqlColumns&quot;: [ # PostgreSQL columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything.
1456 { # PostgreSQL Column.
1457 &quot;column&quot;: &quot;A String&quot;, # The column name.
1458 &quot;dataType&quot;: &quot;A String&quot;, # The PostgreSQL data type.
1459 &quot;length&quot;: 42, # Column length.
1460 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
1461 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
1462 &quot;precision&quot;: 42, # Column precision.
1463 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
1464 &quot;scale&quot;: 42, # Column scale.
1465 },
1466 ],
1467 &quot;table&quot;: &quot;A String&quot;, # The table name.
1468 },
1469 ],
1470 &quot;schema&quot;: &quot;A String&quot;, # The schema name.
1471 },
1472 ],
1473 },
1474 &quot;includeObjects&quot;: { # PostgreSQL database structure. # The PostgreSQL objects to include in the stream.
1475 &quot;postgresqlSchemas&quot;: [ # PostgreSQL schemas in the database server.
1476 { # PostgreSQL schema.
1477 &quot;postgresqlTables&quot;: [ # Tables in the schema.
1478 { # PostgreSQL table.
1479 &quot;postgresqlColumns&quot;: [ # PostgreSQL columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything.
1480 { # PostgreSQL Column.
1481 &quot;column&quot;: &quot;A String&quot;, # The column name.
1482 &quot;dataType&quot;: &quot;A String&quot;, # The PostgreSQL data type.
1483 &quot;length&quot;: 42, # Column length.
1484 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
1485 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
1486 &quot;precision&quot;: 42, # Column precision.
1487 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
1488 &quot;scale&quot;: 42, # Column scale.
1489 },
1490 ],
1491 &quot;table&quot;: &quot;A String&quot;, # The table name.
1492 },
1493 ],
1494 &quot;schema&quot;: &quot;A String&quot;, # The schema name.
1495 },
1496 ],
1497 },
1498 &quot;maxConcurrentBackfillTasks&quot;: 42, # Maximum number of concurrent backfill tasks. The number should be non negative. If not set (or set to 0), the system&#x27;s default value will be used.
1499 &quot;publication&quot;: &quot;A String&quot;, # Required. The name of the publication that includes the set of all tables that are defined in the stream&#x27;s include_objects.
1500 &quot;replicationSlot&quot;: &quot;A String&quot;, # Required. Immutable. The name of the logical replication slot that&#x27;s configured with the pgoutput plugin.
1501 },
1502 &quot;salesforceMarketingCloudSourceConfig&quot;: { # Configuration for syncing data from a Salesforce Marketing Cloud source. # Salesforce Marketing Cloud data source configuration.
1503 &quot;excludeObjects&quot;: { # Source catalog. # Optional. The objects to exclude from the stream.
1504 &quot;objects&quot;: [ # Optional. Source objects in the catalog.
1505 { # Source object.
1506 &quot;objectName&quot;: &quot;A String&quot;, # Required. The object name.
1507 &quot;properties&quot;: [ # Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
1508 { # Source property.
1509 &quot;primaryKey&quot;: True or False, # Optional. Whether or not the property is a primary key.
1510 &quot;properties&quot;: [ # Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
1511 # Object with schema name: SourceProperty
1512 ],
1513 &quot;propertyName&quot;: &quot;A String&quot;, # Required. The property name.
1514 },
1515 ],
1516 },
1517 ],
1518 },
1519 &quot;fullRefreshPollingInterval&quot;: &quot;A String&quot;, # Required. Specifies the polling interval for a full refresh of objects that do not support incremental sync. If not set, a default value of 24 hours is used. The duration must be between 1 and 24 hours, inclusive.
1520 &quot;includeObjects&quot;: { # Source catalog. # Optional. The objects to retrieve from the source.
1521 &quot;objects&quot;: [ # Optional. Source objects in the catalog.
1522 { # Source object.
1523 &quot;objectName&quot;: &quot;A String&quot;, # Required. The object name.
1524 &quot;properties&quot;: [ # Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
1525 { # Source property.
1526 &quot;primaryKey&quot;: True or False, # Optional. Whether or not the property is a primary key.
1527 &quot;properties&quot;: [ # Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
1528 # Object with schema name: SourceProperty
1529 ],
1530 &quot;propertyName&quot;: &quot;A String&quot;, # Required. The property name.
1531 },
1532 ],
1533 },
1534 ],
1535 },
1536 &quot;pollingInterval&quot;: &quot;A String&quot;, # Required. Incremental sync polling interval for all objects. If not set, a default value of `5 minutes` is used. The duration must be from `5 minutes` to `24 hours`, inclusive.
1537 },
1538 &quot;salesforceSourceConfig&quot;: { # Configuration for syncing data from a Salesforce source. # Salesforce data source configuration.
1539 &quot;excludeObjects&quot;: { # Salesforce organization structure. # The Salesforce objects to exclude from the stream.
1540 &quot;objects&quot;: [ # Salesforce objects in the database server.
1541 { # Salesforce object.
1542 &quot;fields&quot;: [ # Salesforce fields. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
1543 { # Salesforce field.
1544 &quot;dataType&quot;: &quot;A String&quot;, # The data type.
1545 &quot;name&quot;: &quot;A String&quot;, # The field name.
1546 &quot;nillable&quot;: True or False, # Indicates whether the field can accept nil values.
1547 },
1548 ],
1549 &quot;objectName&quot;: &quot;A String&quot;, # The object name.
1550 },
1551 ],
1552 },
1553 &quot;includeObjects&quot;: { # Salesforce organization structure. # The Salesforce objects to retrieve from the source.
1554 &quot;objects&quot;: [ # Salesforce objects in the database server.
1555 { # Salesforce object.
1556 &quot;fields&quot;: [ # Salesforce fields. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
1557 { # Salesforce field.
1558 &quot;dataType&quot;: &quot;A String&quot;, # The data type.
1559 &quot;name&quot;: &quot;A String&quot;, # The field name.
1560 &quot;nillable&quot;: True or False, # Indicates whether the field can accept nil values.
1561 },
1562 ],
1563 &quot;objectName&quot;: &quot;A String&quot;, # The object name.
1564 },
1565 ],
1566 },
1567 &quot;pollingInterval&quot;: &quot;A String&quot;, # Required. Salesforce objects polling interval. The interval at which new changes will be polled for each object. The duration must be from `5 minutes` to `24 hours`, inclusive.
1568 },
1569 &quot;serviceNowSourceConfig&quot;: { # Configuration for syncing data from a ServiceNow source. # ServiceNow data source configuration.
1570 &quot;excludeObjects&quot;: { # Source catalog. # Optional. The objects to exclude from the stream.
1571 &quot;objects&quot;: [ # Optional. Source objects in the catalog.
1572 { # Source object.
1573 &quot;objectName&quot;: &quot;A String&quot;, # Required. The object name.
1574 &quot;properties&quot;: [ # Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
1575 { # Source property.
1576 &quot;primaryKey&quot;: True or False, # Optional. Whether or not the property is a primary key.
1577 &quot;properties&quot;: [ # Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
1578 # Object with schema name: SourceProperty
1579 ],
1580 &quot;propertyName&quot;: &quot;A String&quot;, # Required. The property name.
1581 },
1582 ],
1583 },
1584 ],
1585 },
1586 &quot;includeObjects&quot;: { # Source catalog. # Optional. The objects to retrieve from the source.
1587 &quot;objects&quot;: [ # Optional. Source objects in the catalog.
1588 { # Source object.
1589 &quot;objectName&quot;: &quot;A String&quot;, # Required. The object name.
1590 &quot;properties&quot;: [ # Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
1591 { # Source property.
1592 &quot;primaryKey&quot;: True or False, # Optional. Whether or not the property is a primary key.
1593 &quot;properties&quot;: [ # Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
1594 # Object with schema name: SourceProperty
1595 ],
1596 &quot;propertyName&quot;: &quot;A String&quot;, # Required. The property name.
1597 },
1598 ],
1599 },
1600 ],
1601 },
1602 &quot;pollingInterval&quot;: &quot;A String&quot;, # Required. Incremental sync polling interval for all objects. If not set, a default value of `5 minutes` is used. The duration must be from `5 minutes` to `24 hours`, inclusive.
1603 },
1604 &quot;sourceConnectionProfile&quot;: &quot;A String&quot;, # Required. Source connection profile resource. Format: `projects/{project}/locations/{location}/connectionProfiles/{name}`
1605 &quot;spannerSourceConfig&quot;: { # Configuration for syncing data from a Spanner source. # Spanner data source configuration.
1606 &quot;backfillDataBoostEnabled&quot;: True or False, # Optional. Whether to use Data Boost for Spanner backfills. Defaults to false if not set.
1607 &quot;changeStreamName&quot;: &quot;A String&quot;, # Required. Immutable. The change stream name to use for the stream.
1608 &quot;excludeObjects&quot;: { # Spanner database structure. # Optional. The Spanner objects to avoid retrieving. If some objects are both included and excluded, an error will be thrown.
1609 &quot;schemas&quot;: [ # Optional. Spanner schemas in the database.
1610 { # Spanner schema.
1611 &quot;schema&quot;: &quot;A String&quot;, # Required. The schema name.
1612 &quot;tables&quot;: [ # Optional. Spanner tables in the schema.
1613 { # Spanner table.
1614 &quot;columns&quot;: [ # Optional. Spanner columns in the table.
1615 { # Spanner column.
1616 &quot;column&quot;: &quot;A String&quot;, # Required. The column name.
1617 &quot;dataType&quot;: &quot;A String&quot;, # Optional. Spanner data type.
1618 &quot;isPrimaryKey&quot;: True or False, # Optional. Whether or not the column is a primary key.
1619 &quot;ordinalPosition&quot;: &quot;A String&quot;, # Optional. The ordinal position of the column in the table.
1620 },
1621 ],
1622 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
1623 },
1624 ],
1625 },
1626 ],
1627 },
1628 &quot;fgacRole&quot;: &quot;A String&quot;, # Optional. The FGAC role to use for the stream.
1629 &quot;includeObjects&quot;: { # Spanner database structure. # Optional. The Spanner objects to retrieve from the data source. If some objects are both included and excluded, an error will be thrown.
1630 &quot;schemas&quot;: [ # Optional. Spanner schemas in the database.
1631 { # Spanner schema.
1632 &quot;schema&quot;: &quot;A String&quot;, # Required. The schema name.
1633 &quot;tables&quot;: [ # Optional. Spanner tables in the schema.
1634 { # Spanner table.
1635 &quot;columns&quot;: [ # Optional. Spanner columns in the table.
1636 { # Spanner column.
1637 &quot;column&quot;: &quot;A String&quot;, # Required. The column name.
1638 &quot;dataType&quot;: &quot;A String&quot;, # Optional. Spanner data type.
1639 &quot;isPrimaryKey&quot;: True or False, # Optional. Whether or not the column is a primary key.
1640 &quot;ordinalPosition&quot;: &quot;A String&quot;, # Optional. The ordinal position of the column in the table.
1641 },
1642 ],
1643 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
1644 },
1645 ],
1646 },
1647 ],
1648 },
1649 &quot;maxConcurrentBackfillTasks&quot;: 42, # Optional. Maximum number of concurrent backfill tasks.
1650 &quot;maxConcurrentCdcTasks&quot;: 42, # Optional. Maximum number of concurrent CDC tasks.
1651 &quot;spannerRpcPriority&quot;: &quot;A String&quot;, # Optional. The RPC priority to use for the stream.
1652 },
1653 &quot;sqlServerSourceConfig&quot;: { # Configuration for syncing data from a SQLServer source. # SQLServer data source configuration.
1654 &quot;changeTables&quot;: { # Configuration to use Change Tables CDC read method. # CDC reader reads from change tables.
1655 },
1656 &quot;excludeObjects&quot;: { # SQLServer database structure. # The SQLServer objects to exclude from the stream.
1657 &quot;schemas&quot;: [ # SQLServer schemas in the database server.
1658 { # SQLServer schema.
1659 &quot;schema&quot;: &quot;A String&quot;, # The schema name.
1660 &quot;tables&quot;: [ # Tables in the schema.
1661 { # SQLServer table.
1662 &quot;columns&quot;: [ # SQLServer columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything.
1663 { # SQLServer Column.
1664 &quot;column&quot;: &quot;A String&quot;, # The column name.
1665 &quot;dataType&quot;: &quot;A String&quot;, # The SQLServer data type.
1666 &quot;length&quot;: 42, # Column length.
1667 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
1668 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
1669 &quot;precision&quot;: 42, # Column precision.
1670 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
1671 &quot;scale&quot;: 42, # Column scale.
1672 },
1673 ],
1674 &quot;table&quot;: &quot;A String&quot;, # The table name.
1675 },
1676 ],
1677 },
1678 ],
1679 },
1680 &quot;includeObjects&quot;: { # SQLServer database structure. # The SQLServer objects to include in the stream.
1681 &quot;schemas&quot;: [ # SQLServer schemas in the database server.
1682 { # SQLServer schema.
1683 &quot;schema&quot;: &quot;A String&quot;, # The schema name.
1684 &quot;tables&quot;: [ # Tables in the schema.
1685 { # SQLServer table.
1686 &quot;columns&quot;: [ # SQLServer columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything.
1687 { # SQLServer Column.
1688 &quot;column&quot;: &quot;A String&quot;, # The column name.
1689 &quot;dataType&quot;: &quot;A String&quot;, # The SQLServer data type.
1690 &quot;length&quot;: 42, # Column length.
1691 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
1692 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
1693 &quot;precision&quot;: 42, # Column precision.
1694 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
1695 &quot;scale&quot;: 42, # Column scale.
1696 },
1697 ],
1698 &quot;table&quot;: &quot;A String&quot;, # The table name.
1699 },
1700 ],
1701 },
1702 ],
1703 },
1704 &quot;maxConcurrentBackfillTasks&quot;: 42, # Max concurrent backfill tasks.
1705 &quot;maxConcurrentCdcTasks&quot;: 42, # Max concurrent CDC tasks.
1706 &quot;transactionLogs&quot;: { # Configuration to use Transaction Logs CDC read method. # CDC reader reads from transaction logs.
1707 },
1708 },
1709 },
1710 &quot;state&quot;: &quot;A String&quot;, # The state of the stream.
1711 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update time of the stream.
1712 }</pre>
1713 </div>
1714
1715 <div class="method">
1716 <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
1717 <pre>Use this method to list streams in a project and location.
1718
1719 Args:
1720 parent: string, Required. The parent that owns the collection of streams. (required)
1721 filter: string, Optional. Filter request.
1722 orderBy: string, Optional. Order by fields for the result.
1723 pageSize: integer, Optional. 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.
1724 pageToken: string, Optional. 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.
1725 x__xgafv: string, V1 error format.
1726 Allowed values
1727 1 - v1 error format
1728 2 - v2 error format
1729
1730 Returns:
1731 An object of the form:
1732
1733 { # Response message for listing streams.
1734 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
1735 &quot;streams&quot;: [ # List of streams
1736 { # A resource representing streaming data from a source to a destination.
1737 &quot;backfillAll&quot;: { # Backfill strategy to automatically backfill the Stream&#x27;s objects. Specific objects can be excluded. # Automatically backfill objects included in the stream source configuration. Specific objects can be excluded.
1738 &quot;mongodbExcludedObjects&quot;: { # MongoDB Cluster structure. # MongoDB data source objects to avoid backfilling
1739 &quot;databases&quot;: [ # MongoDB databases in the cluster.
1740 { # MongoDB Database.
1741 &quot;collections&quot;: [ # Collections in the database.
1742 { # MongoDB Collection.
1743 &quot;collection&quot;: &quot;A String&quot;, # The collection name.
1744 &quot;fields&quot;: [ # Fields in the collection.
1745 { # MongoDB Field.
1746 &quot;field&quot;: &quot;A String&quot;, # The field name.
1747 },
1748 ],
1749 },
1750 ],
1751 &quot;database&quot;: &quot;A String&quot;, # The database name.
1752 },
1753 ],
1754 },
1755 &quot;mysqlExcludedObjects&quot;: { # MySQL database structure # MySQL data source objects to avoid backfilling.
1756 &quot;mysqlDatabases&quot;: [ # Mysql databases on the server
1757 { # MySQL database.
1758 &quot;database&quot;: &quot;A String&quot;, # The database name.
1759 &quot;mysqlTables&quot;: [ # Tables in the database.
1760 { # MySQL table.
1761 &quot;mysqlColumns&quot;: [ # MySQL columns in the database. When unspecified as part of include/exclude objects, includes/excludes everything.
1762 { # MySQL Column.
1763 &quot;collation&quot;: &quot;A String&quot;, # Column collation.
1764 &quot;column&quot;: &quot;A String&quot;, # The column name.
1765 &quot;dataType&quot;: &quot;A String&quot;, # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html
1766 &quot;length&quot;: 42, # Column length.
1767 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
1768 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
1769 &quot;precision&quot;: 42, # Column precision.
1770 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
1771 &quot;scale&quot;: 42, # Column scale.
1772 },
1773 ],
1774 &quot;table&quot;: &quot;A String&quot;, # The table name.
1775 },
1776 ],
1777 },
1778 ],
1779 },
1780 &quot;oracleExcludedObjects&quot;: { # Oracle database structure. # Oracle data source objects to avoid backfilling.
1781 &quot;oracleSchemas&quot;: [ # Oracle schemas/databases in the database server.
1782 { # Oracle schema.
1783 &quot;oracleTables&quot;: [ # Tables in the schema.
1784 { # Oracle table.
1785 &quot;oracleColumns&quot;: [ # Oracle columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything.
1786 { # Oracle Column.
1787 &quot;column&quot;: &quot;A String&quot;, # The column name.
1788 &quot;dataType&quot;: &quot;A String&quot;, # The Oracle data type.
1789 &quot;encoding&quot;: &quot;A String&quot;, # Column encoding.
1790 &quot;length&quot;: 42, # Column length.
1791 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
1792 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
1793 &quot;precision&quot;: 42, # Column precision.
1794 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
1795 &quot;scale&quot;: 42, # Column scale.
1796 },
1797 ],
1798 &quot;table&quot;: &quot;A String&quot;, # The table name.
1799 },
1800 ],
1801 &quot;schema&quot;: &quot;A String&quot;, # The schema name.
1802 },
1803 ],
1804 },
1805 &quot;postgresqlExcludedObjects&quot;: { # PostgreSQL database structure. # PostgreSQL data source objects to avoid backfilling.
1806 &quot;postgresqlSchemas&quot;: [ # PostgreSQL schemas in the database server.
1807 { # PostgreSQL schema.
1808 &quot;postgresqlTables&quot;: [ # Tables in the schema.
1809 { # PostgreSQL table.
1810 &quot;postgresqlColumns&quot;: [ # PostgreSQL columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything.
1811 { # PostgreSQL Column.
1812 &quot;column&quot;: &quot;A String&quot;, # The column name.
1813 &quot;dataType&quot;: &quot;A String&quot;, # The PostgreSQL data type.
1814 &quot;length&quot;: 42, # Column length.
1815 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
1816 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
1817 &quot;precision&quot;: 42, # Column precision.
1818 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
1819 &quot;scale&quot;: 42, # Column scale.
1820 },
1821 ],
1822 &quot;table&quot;: &quot;A String&quot;, # The table name.
1823 },
1824 ],
1825 &quot;schema&quot;: &quot;A String&quot;, # The schema name.
1826 },
1827 ],
1828 },
1829 &quot;saasExcludedObjects&quot;: { # Source catalog. # Source catalog data source objects to avoid backfilling. This is mainly used to represent SaaS applications objects.
1830 &quot;objects&quot;: [ # Optional. Source objects in the catalog.
1831 { # Source object.
1832 &quot;objectName&quot;: &quot;A String&quot;, # Required. The object name.
1833 &quot;properties&quot;: [ # Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
1834 { # Source property.
1835 &quot;primaryKey&quot;: True or False, # Optional. Whether or not the property is a primary key.
1836 &quot;properties&quot;: [ # Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
1837 # Object with schema name: SourceProperty
1838 ],
1839 &quot;propertyName&quot;: &quot;A String&quot;, # Required. The property name.
1840 },
1841 ],
1842 },
1843 ],
1844 },
1845 &quot;salesforceExcludedObjects&quot;: { # Salesforce organization structure. # Salesforce data source objects to avoid backfilling
1846 &quot;objects&quot;: [ # Salesforce objects in the database server.
1847 { # Salesforce object.
1848 &quot;fields&quot;: [ # Salesforce fields. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
1849 { # Salesforce field.
1850 &quot;dataType&quot;: &quot;A String&quot;, # The data type.
1851 &quot;name&quot;: &quot;A String&quot;, # The field name.
1852 &quot;nillable&quot;: True or False, # Indicates whether the field can accept nil values.
1853 },
1854 ],
1855 &quot;objectName&quot;: &quot;A String&quot;, # The object name.
1856 },
1857 ],
1858 },
1859 &quot;spannerExcludedObjects&quot;: { # Spanner database structure. # Spanner data source objects to avoid backfilling.
1860 &quot;schemas&quot;: [ # Optional. Spanner schemas in the database.
1861 { # Spanner schema.
1862 &quot;schema&quot;: &quot;A String&quot;, # Required. The schema name.
1863 &quot;tables&quot;: [ # Optional. Spanner tables in the schema.
1864 { # Spanner table.
1865 &quot;columns&quot;: [ # Optional. Spanner columns in the table.
1866 { # Spanner column.
1867 &quot;column&quot;: &quot;A String&quot;, # Required. The column name.
1868 &quot;dataType&quot;: &quot;A String&quot;, # Optional. Spanner data type.
1869 &quot;isPrimaryKey&quot;: True or False, # Optional. Whether or not the column is a primary key.
1870 &quot;ordinalPosition&quot;: &quot;A String&quot;, # Optional. The ordinal position of the column in the table.
1871 },
1872 ],
1873 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
1874 },
1875 ],
1876 },
1877 ],
1878 },
1879 &quot;sqlServerExcludedObjects&quot;: { # SQLServer database structure. # SQLServer data source objects to avoid backfilling
1880 &quot;schemas&quot;: [ # SQLServer schemas in the database server.
1881 { # SQLServer schema.
1882 &quot;schema&quot;: &quot;A String&quot;, # The schema name.
1883 &quot;tables&quot;: [ # Tables in the schema.
1884 { # SQLServer table.
1885 &quot;columns&quot;: [ # SQLServer columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything.
1886 { # SQLServer Column.
1887 &quot;column&quot;: &quot;A String&quot;, # The column name.
1888 &quot;dataType&quot;: &quot;A String&quot;, # The SQLServer data type.
1889 &quot;length&quot;: 42, # Column length.
1890 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
1891 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
1892 &quot;precision&quot;: 42, # Column precision.
1893 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
1894 &quot;scale&quot;: 42, # Column scale.
1895 },
1896 ],
1897 &quot;table&quot;: &quot;A String&quot;, # The table name.
1898 },
1899 ],
1900 },
1901 ],
1902 },
1903 },
1904 &quot;backfillNone&quot;: { # Backfill strategy to disable automatic backfill for the Stream&#x27;s objects. # Do not automatically backfill any objects.
1905 },
1906 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation time of the stream.
1907 &quot;customerManagedEncryptionKey&quot;: &quot;A String&quot;, # 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.
1908 &quot;destinationConfig&quot;: { # The configuration of the stream destination. # Required. Destination connection profile configuration.
1909 &quot;bigqueryDestinationConfig&quot;: { # BigQuery destination configuration # BigQuery destination configuration.
1910 &quot;appendOnly&quot;: { # AppendOnly mode defines that all changes to a table will be written to the destination table. # Append only mode
1911 },
1912 &quot;blmtConfig&quot;: { # The configuration for BLMT. # Optional. Big Lake Managed Tables (BLMT) configuration.
1913 &quot;bucket&quot;: &quot;A String&quot;, # Required. The Cloud Storage bucket name.
1914 &quot;connectionName&quot;: &quot;A String&quot;, # Required. The bigquery connection. Format: `{project}.{location}.{name}`
1915 &quot;fileFormat&quot;: &quot;A String&quot;, # Required. The file format.
1916 &quot;rootPath&quot;: &quot;A String&quot;, # The root path inside the Cloud Storage bucket.
1917 &quot;tableFormat&quot;: &quot;A String&quot;, # Required. The table format.
1918 },
1919 &quot;dataFreshness&quot;: &quot;A String&quot;, # The guaranteed data freshness (in seconds) when querying tables created by the stream. Editing this field will only affect new tables created in the future, but existing tables will not be impacted. Lower values mean that queries will return fresher data, but may result in higher cost.
1920 &quot;merge&quot;: { # Merge mode defines that all changes to a table will be merged at the destination table. # The standard mode
1921 },
1922 &quot;singleTargetDataset&quot;: { # A single target dataset to which all data will be streamed. # Single destination dataset.
1923 &quot;datasetId&quot;: &quot;A String&quot;, # The dataset ID of the target dataset. DatasetIds allowed characters: https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets#datasetreference.
1924 },
1925 &quot;sourceHierarchyDatasets&quot;: { # Destination datasets are created so that hierarchy of the destination data objects matches the source hierarchy. # Source hierarchy datasets.
1926 &quot;datasetTemplate&quot;: { # Dataset template used for dynamic dataset creation. # The dataset template to use for dynamic dataset creation.
1927 &quot;datasetIdPrefix&quot;: &quot;A String&quot;, # If supplied, every created dataset will have its name prefixed by the provided value. The prefix and name will be separated by an underscore. i.e. _.
1928 &quot;kmsKeyName&quot;: &quot;A String&quot;, # Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key. i.e. projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{cryptoKey}. See https://cloud.google.com/bigquery/docs/customer-managed-encryption for more information.
1929 &quot;location&quot;: &quot;A String&quot;, # Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
1930 },
1931 &quot;projectId&quot;: &quot;A String&quot;, # Optional. The project id of the BigQuery dataset. If not specified, the project will be inferred from the stream resource.
1932 },
1933 },
1934 &quot;destinationConnectionProfile&quot;: &quot;A String&quot;, # Required. Destination connection profile resource. Format: `projects/{project}/locations/{location}/connectionProfiles/{name}`
1935 &quot;gcsDestinationConfig&quot;: { # Google Cloud Storage destination configuration # A configuration for how data should be loaded to Cloud Storage.
1936 &quot;avroFileFormat&quot;: { # AVRO file format configuration. # AVRO file format configuration.
1937 },
1938 &quot;fileRotationInterval&quot;: &quot;A String&quot;, # The maximum duration for which new events are added before a file is closed and a new file is created. Values within the range of 15-60 seconds are allowed.
1939 &quot;fileRotationMb&quot;: 42, # The maximum file size to be saved in the bucket.
1940 &quot;jsonFileFormat&quot;: { # JSON file format configuration. # JSON file format configuration.
1941 &quot;compression&quot;: &quot;A String&quot;, # Compression of the loaded JSON file.
1942 &quot;schemaFileFormat&quot;: &quot;A String&quot;, # The schema file format along JSON data files.
1943 },
1944 &quot;path&quot;: &quot;A String&quot;, # Path inside the Cloud Storage bucket to write data to.
1945 },
1946 },
1947 &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name.
1948 &quot;errors&quot;: [ # Output only. Errors on the Stream.
1949 { # Represent a user-facing Error.
1950 &quot;details&quot;: { # Additional information about the error.
1951 &quot;a_key&quot;: &quot;A String&quot;,
1952 },
1953 &quot;errorTime&quot;: &quot;A String&quot;, # The time when the error occurred.
1954 &quot;errorUuid&quot;: &quot;A String&quot;, # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
1955 &quot;message&quot;: &quot;A String&quot;, # A message containing more information about the error that occurred.
1956 &quot;reason&quot;: &quot;A String&quot;, # A title that explains the reason for the error.
1957 },
1958 ],
1959 &quot;labels&quot;: { # Labels.
1960 &quot;a_key&quot;: &quot;A String&quot;,
1961 },
1962 &quot;lastRecoveryTime&quot;: &quot;A String&quot;, # Output only. If the stream was recovered, the time of the last recovery. Note: This field is currently experimental.
1963 &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The stream&#x27;s name.
1964 &quot;ruleSets&quot;: [ # Optional. Rule sets to apply to the stream.
1965 { # A set of rules to apply to a set of objects.
1966 &quot;customizationRules&quot;: [ # Required. List of customization rules to apply.
1967 { # A customization rule to apply to a set of objects.
1968 &quot;bigqueryClustering&quot;: { # BigQuery clustering configuration. # BigQuery clustering rule.
1969 &quot;columns&quot;: [ # Required. Column names to set as clustering columns.
1970 &quot;A String&quot;,
1971 ],
1972 },
1973 &quot;bigqueryPartitioning&quot;: { # BigQuery partitioning configuration. # BigQuery partitioning rule.
1974 &quot;ingestionTimePartition&quot;: { # Ingestion time partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time # Ingestion time partitioning.
1975 &quot;partitioningTimeGranularity&quot;: &quot;A String&quot;, # Optional. Partition granularity
1976 },
1977 &quot;integerRangePartition&quot;: { # Integer range partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#integer_range # Integer range partitioning.
1978 &quot;column&quot;: &quot;A String&quot;, # Required. The partitioning column.
1979 &quot;end&quot;: &quot;A String&quot;, # Required. The ending value for range partitioning (exclusive).
1980 &quot;interval&quot;: &quot;A String&quot;, # Required. The interval of each range within the partition.
1981 &quot;start&quot;: &quot;A String&quot;, # Required. The starting value for range partitioning (inclusive).
1982 },
1983 &quot;requirePartitionFilter&quot;: True or False, # Optional. If true, queries over the table require a partition filter.
1984 &quot;timeUnitPartition&quot;: { # Time unit column partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#date_timestamp_partitioned_tables # Time unit column partitioning.
1985 &quot;column&quot;: &quot;A String&quot;, # Required. The partitioning column.
1986 &quot;partitioningTimeGranularity&quot;: &quot;A String&quot;, # Optional. Partition granularity.
1987 },
1988 },
1989 },
1990 ],
1991 &quot;objectFilter&quot;: { # Object filter to apply the rules to. # Required. Object filter to apply the customization rules to.
1992 &quot;sourceObjectIdentifier&quot;: { # Represents an identifier of an object in the data source. # Specific source object identifier.
1993 &quot;mongodbIdentifier&quot;: { # MongoDB data source object identifier. # MongoDB data source object identifier.
1994 &quot;collection&quot;: &quot;A String&quot;, # Required. The collection name.
1995 &quot;database&quot;: &quot;A String&quot;, # Required. The database name.
1996 },
1997 &quot;mysqlIdentifier&quot;: { # Mysql data source object identifier. # Mysql data source object identifier.
1998 &quot;database&quot;: &quot;A String&quot;, # Required. The database name.
1999 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
2000 },
2001 &quot;oracleIdentifier&quot;: { # Oracle data source object identifier. # Oracle data source object identifier.
2002 &quot;schema&quot;: &quot;A String&quot;, # Required. The schema name.
2003 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
2004 },
2005 &quot;postgresqlIdentifier&quot;: { # PostgreSQL data source object identifier. # PostgreSQL data source object identifier.
2006 &quot;schema&quot;: &quot;A String&quot;, # Required. The schema name.
2007 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
2008 },
2009 &quot;salesforceIdentifier&quot;: { # Salesforce data source object identifier. # Salesforce data source object identifier.
2010 &quot;objectName&quot;: &quot;A String&quot;, # Required. The object name.
2011 },
2012 &quot;spannerIdentifier&quot;: { # Spanner data source object identifier. # Spanner data source object identifier.
2013 &quot;schema&quot;: &quot;A String&quot;, # Optional. The schema name.
2014 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
2015 },
2016 &quot;sqlServerIdentifier&quot;: { # SQLServer data source object identifier. # SQLServer data source object identifier.
2017 &quot;schema&quot;: &quot;A String&quot;, # Required. The schema name.
2018 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
2019 },
2020 },
2021 },
2022 },
2023 ],
2024 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
2025 &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
2026 &quot;sourceConfig&quot;: { # The configuration of the stream source. # Required. Source connection profile configuration.
2027 &quot;dataverseSourceConfig&quot;: { # Configuration for syncing data from a Dataverse source. # Dataverse data source configuration.
2028 &quot;excludeObjects&quot;: { # Source catalog. # Optional. The objects to exclude from the stream.
2029 &quot;objects&quot;: [ # Optional. Source objects in the catalog.
2030 { # Source object.
2031 &quot;objectName&quot;: &quot;A String&quot;, # Required. The object name.
2032 &quot;properties&quot;: [ # Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
2033 { # Source property.
2034 &quot;primaryKey&quot;: True or False, # Optional. Whether or not the property is a primary key.
2035 &quot;properties&quot;: [ # Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
2036 # Object with schema name: SourceProperty
2037 ],
2038 &quot;propertyName&quot;: &quot;A String&quot;, # Required. The property name.
2039 },
2040 ],
2041 },
2042 ],
2043 },
2044 &quot;includeObjects&quot;: { # Source catalog. # Optional. The objects to retrieve from the source.
2045 &quot;objects&quot;: [ # Optional. Source objects in the catalog.
2046 { # Source object.
2047 &quot;objectName&quot;: &quot;A String&quot;, # Required. The object name.
2048 &quot;properties&quot;: [ # Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
2049 { # Source property.
2050 &quot;primaryKey&quot;: True or False, # Optional. Whether or not the property is a primary key.
2051 &quot;properties&quot;: [ # Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
2052 # Object with schema name: SourceProperty
2053 ],
2054 &quot;propertyName&quot;: &quot;A String&quot;, # Required. The property name.
2055 },
2056 ],
2057 },
2058 ],
2059 },
2060 &quot;pollingInterval&quot;: &quot;A String&quot;, # Required. Incremental sync polling interval for all objects. If not set, a default value of `5 minutes` is used. The duration must be from `5 minutes` to `24 hours`, inclusive.
2061 },
2062 &quot;mongodbSourceConfig&quot;: { # Configuration for syncing data from a MongoDB source. # MongoDB data source configuration.
2063 &quot;excludeObjects&quot;: { # MongoDB Cluster structure. # The MongoDB collections to exclude from the stream.
2064 &quot;databases&quot;: [ # MongoDB databases in the cluster.
2065 { # MongoDB Database.
2066 &quot;collections&quot;: [ # Collections in the database.
2067 { # MongoDB Collection.
2068 &quot;collection&quot;: &quot;A String&quot;, # The collection name.
2069 &quot;fields&quot;: [ # Fields in the collection.
2070 { # MongoDB Field.
2071 &quot;field&quot;: &quot;A String&quot;, # The field name.
2072 },
2073 ],
2074 },
2075 ],
2076 &quot;database&quot;: &quot;A String&quot;, # The database name.
2077 },
2078 ],
2079 },
2080 &quot;includeObjects&quot;: { # MongoDB Cluster structure. # The MongoDB collections to include in the stream.
2081 &quot;databases&quot;: [ # MongoDB databases in the cluster.
2082 { # MongoDB Database.
2083 &quot;collections&quot;: [ # Collections in the database.
2084 { # MongoDB Collection.
2085 &quot;collection&quot;: &quot;A String&quot;, # The collection name.
2086 &quot;fields&quot;: [ # Fields in the collection.
2087 { # MongoDB Field.
2088 &quot;field&quot;: &quot;A String&quot;, # The field name.
2089 },
2090 ],
2091 },
2092 ],
2093 &quot;database&quot;: &quot;A String&quot;, # The database name.
2094 },
2095 ],
2096 },
2097 &quot;jsonMode&quot;: &quot;A String&quot;, # Optional. MongoDB JSON mode to use for the stream.
2098 &quot;maxConcurrentBackfillTasks&quot;: 42, # Optional. Maximum number of concurrent backfill tasks. The number should be non-negative and less than or equal to 50. If not set (or set to 0), the system&#x27;s default value is used
2099 },
2100 &quot;mysqlSourceConfig&quot;: { # Configuration for syncing data from a MySQL source. # MySQL data source configuration.
2101 &quot;binaryLogPosition&quot;: { # Use Binary log position based replication. # Use Binary log position based replication.
2102 },
2103 &quot;excludeObjects&quot;: { # MySQL database structure # The MySQL objects to exclude from the stream.
2104 &quot;mysqlDatabases&quot;: [ # Mysql databases on the server
2105 { # MySQL database.
2106 &quot;database&quot;: &quot;A String&quot;, # The database name.
2107 &quot;mysqlTables&quot;: [ # Tables in the database.
2108 { # MySQL table.
2109 &quot;mysqlColumns&quot;: [ # MySQL columns in the database. When unspecified as part of include/exclude objects, includes/excludes everything.
2110 { # MySQL Column.
2111 &quot;collation&quot;: &quot;A String&quot;, # Column collation.
2112 &quot;column&quot;: &quot;A String&quot;, # The column name.
2113 &quot;dataType&quot;: &quot;A String&quot;, # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html
2114 &quot;length&quot;: 42, # Column length.
2115 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
2116 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
2117 &quot;precision&quot;: 42, # Column precision.
2118 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
2119 &quot;scale&quot;: 42, # Column scale.
2120 },
2121 ],
2122 &quot;table&quot;: &quot;A String&quot;, # The table name.
2123 },
2124 ],
2125 },
2126 ],
2127 },
2128 &quot;gtid&quot;: { # Use GTID based replication. # Use GTID based replication.
2129 },
2130 &quot;includeObjects&quot;: { # MySQL database structure # The MySQL objects to retrieve from the source.
2131 &quot;mysqlDatabases&quot;: [ # Mysql databases on the server
2132 { # MySQL database.
2133 &quot;database&quot;: &quot;A String&quot;, # The database name.
2134 &quot;mysqlTables&quot;: [ # Tables in the database.
2135 { # MySQL table.
2136 &quot;mysqlColumns&quot;: [ # MySQL columns in the database. When unspecified as part of include/exclude objects, includes/excludes everything.
2137 { # MySQL Column.
2138 &quot;collation&quot;: &quot;A String&quot;, # Column collation.
2139 &quot;column&quot;: &quot;A String&quot;, # The column name.
2140 &quot;dataType&quot;: &quot;A String&quot;, # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html
2141 &quot;length&quot;: 42, # Column length.
2142 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
2143 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
2144 &quot;precision&quot;: 42, # Column precision.
2145 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
2146 &quot;scale&quot;: 42, # Column scale.
2147 },
2148 ],
2149 &quot;table&quot;: &quot;A String&quot;, # The table name.
2150 },
2151 ],
2152 },
2153 ],
2154 },
2155 &quot;maxConcurrentBackfillTasks&quot;: 42, # Maximum number of concurrent backfill tasks. The number should be non negative. If not set (or set to 0), the system&#x27;s default value will be used.
2156 &quot;maxConcurrentCdcTasks&quot;: 42, # Maximum number of concurrent CDC tasks. The number should be non negative. If not set (or set to 0), the system&#x27;s default value will be used.
2157 },
2158 &quot;oracleSourceConfig&quot;: { # Configuration for syncing data from an Oracle source. # Oracle data source configuration.
2159 &quot;binaryLogParser&quot;: { # Configuration to use Binary Log Parser CDC technique. # Use Binary Log Parser.
2160 &quot;logFileDirectories&quot;: { # Configuration to specify the Oracle directories to access the log files. # Use Oracle directories.
2161 &quot;archivedLogDirectory&quot;: &quot;A String&quot;, # Required. Oracle directory for archived logs.
2162 &quot;onlineLogDirectory&quot;: &quot;A String&quot;, # Required. Oracle directory for online logs.
2163 },
2164 &quot;oracleAsmLogFileAccess&quot;: { # Configuration to use Oracle ASM to access the log files. # Use Oracle ASM.
2165 },
2166 },
2167 &quot;dropLargeObjects&quot;: { # Configuration to drop large object values. # Drop large object values.
2168 },
2169 &quot;excludeObjects&quot;: { # Oracle database structure. # The Oracle objects to exclude from the stream.
2170 &quot;oracleSchemas&quot;: [ # Oracle schemas/databases in the database server.
2171 { # Oracle schema.
2172 &quot;oracleTables&quot;: [ # Tables in the schema.
2173 { # Oracle table.
2174 &quot;oracleColumns&quot;: [ # Oracle columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything.
2175 { # Oracle Column.
2176 &quot;column&quot;: &quot;A String&quot;, # The column name.
2177 &quot;dataType&quot;: &quot;A String&quot;, # The Oracle data type.
2178 &quot;encoding&quot;: &quot;A String&quot;, # Column encoding.
2179 &quot;length&quot;: 42, # Column length.
2180 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
2181 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
2182 &quot;precision&quot;: 42, # Column precision.
2183 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
2184 &quot;scale&quot;: 42, # Column scale.
2185 },
2186 ],
2187 &quot;table&quot;: &quot;A String&quot;, # The table name.
2188 },
2189 ],
2190 &quot;schema&quot;: &quot;A String&quot;, # The schema name.
2191 },
2192 ],
2193 },
2194 &quot;includeObjects&quot;: { # Oracle database structure. # The Oracle objects to include in the stream.
2195 &quot;oracleSchemas&quot;: [ # Oracle schemas/databases in the database server.
2196 { # Oracle schema.
2197 &quot;oracleTables&quot;: [ # Tables in the schema.
2198 { # Oracle table.
2199 &quot;oracleColumns&quot;: [ # Oracle columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything.
2200 { # Oracle Column.
2201 &quot;column&quot;: &quot;A String&quot;, # The column name.
2202 &quot;dataType&quot;: &quot;A String&quot;, # The Oracle data type.
2203 &quot;encoding&quot;: &quot;A String&quot;, # Column encoding.
2204 &quot;length&quot;: 42, # Column length.
2205 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
2206 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
2207 &quot;precision&quot;: 42, # Column precision.
2208 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
2209 &quot;scale&quot;: 42, # Column scale.
2210 },
2211 ],
2212 &quot;table&quot;: &quot;A String&quot;, # The table name.
2213 },
2214 ],
2215 &quot;schema&quot;: &quot;A String&quot;, # The schema name.
2216 },
2217 ],
2218 },
2219 &quot;logMiner&quot;: { # Configuration to use LogMiner CDC method. # Use LogMiner.
2220 },
2221 &quot;maxConcurrentBackfillTasks&quot;: 42, # Maximum number of concurrent backfill tasks. The number should be non-negative. If not set (or set to 0), the system&#x27;s default value is used.
2222 &quot;maxConcurrentCdcTasks&quot;: 42, # Maximum number of concurrent CDC tasks. The number should be non-negative. If not set (or set to 0), the system&#x27;s default value is used.
2223 &quot;streamLargeObjects&quot;: { # Configuration to stream large object values. # Stream large object values.
2224 },
2225 },
2226 &quot;postgresqlSourceConfig&quot;: { # Configuration for syncing data from a PostgreSQL source. # PostgreSQL data source configuration.
2227 &quot;excludeObjects&quot;: { # PostgreSQL database structure. # The PostgreSQL objects to exclude from the stream.
2228 &quot;postgresqlSchemas&quot;: [ # PostgreSQL schemas in the database server.
2229 { # PostgreSQL schema.
2230 &quot;postgresqlTables&quot;: [ # Tables in the schema.
2231 { # PostgreSQL table.
2232 &quot;postgresqlColumns&quot;: [ # PostgreSQL columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything.
2233 { # PostgreSQL Column.
2234 &quot;column&quot;: &quot;A String&quot;, # The column name.
2235 &quot;dataType&quot;: &quot;A String&quot;, # The PostgreSQL data type.
2236 &quot;length&quot;: 42, # Column length.
2237 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
2238 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
2239 &quot;precision&quot;: 42, # Column precision.
2240 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
2241 &quot;scale&quot;: 42, # Column scale.
2242 },
2243 ],
2244 &quot;table&quot;: &quot;A String&quot;, # The table name.
2245 },
2246 ],
2247 &quot;schema&quot;: &quot;A String&quot;, # The schema name.
2248 },
2249 ],
2250 },
2251 &quot;includeObjects&quot;: { # PostgreSQL database structure. # The PostgreSQL objects to include in the stream.
2252 &quot;postgresqlSchemas&quot;: [ # PostgreSQL schemas in the database server.
2253 { # PostgreSQL schema.
2254 &quot;postgresqlTables&quot;: [ # Tables in the schema.
2255 { # PostgreSQL table.
2256 &quot;postgresqlColumns&quot;: [ # PostgreSQL columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything.
2257 { # PostgreSQL Column.
2258 &quot;column&quot;: &quot;A String&quot;, # The column name.
2259 &quot;dataType&quot;: &quot;A String&quot;, # The PostgreSQL data type.
2260 &quot;length&quot;: 42, # Column length.
2261 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
2262 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
2263 &quot;precision&quot;: 42, # Column precision.
2264 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
2265 &quot;scale&quot;: 42, # Column scale.
2266 },
2267 ],
2268 &quot;table&quot;: &quot;A String&quot;, # The table name.
2269 },
2270 ],
2271 &quot;schema&quot;: &quot;A String&quot;, # The schema name.
2272 },
2273 ],
2274 },
2275 &quot;maxConcurrentBackfillTasks&quot;: 42, # Maximum number of concurrent backfill tasks. The number should be non negative. If not set (or set to 0), the system&#x27;s default value will be used.
2276 &quot;publication&quot;: &quot;A String&quot;, # Required. The name of the publication that includes the set of all tables that are defined in the stream&#x27;s include_objects.
2277 &quot;replicationSlot&quot;: &quot;A String&quot;, # Required. Immutable. The name of the logical replication slot that&#x27;s configured with the pgoutput plugin.
2278 },
2279 &quot;salesforceMarketingCloudSourceConfig&quot;: { # Configuration for syncing data from a Salesforce Marketing Cloud source. # Salesforce Marketing Cloud data source configuration.
2280 &quot;excludeObjects&quot;: { # Source catalog. # Optional. The objects to exclude from the stream.
2281 &quot;objects&quot;: [ # Optional. Source objects in the catalog.
2282 { # Source object.
2283 &quot;objectName&quot;: &quot;A String&quot;, # Required. The object name.
2284 &quot;properties&quot;: [ # Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
2285 { # Source property.
2286 &quot;primaryKey&quot;: True or False, # Optional. Whether or not the property is a primary key.
2287 &quot;properties&quot;: [ # Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
2288 # Object with schema name: SourceProperty
2289 ],
2290 &quot;propertyName&quot;: &quot;A String&quot;, # Required. The property name.
2291 },
2292 ],
2293 },
2294 ],
2295 },
2296 &quot;fullRefreshPollingInterval&quot;: &quot;A String&quot;, # Required. Specifies the polling interval for a full refresh of objects that do not support incremental sync. If not set, a default value of 24 hours is used. The duration must be between 1 and 24 hours, inclusive.
2297 &quot;includeObjects&quot;: { # Source catalog. # Optional. The objects to retrieve from the source.
2298 &quot;objects&quot;: [ # Optional. Source objects in the catalog.
2299 { # Source object.
2300 &quot;objectName&quot;: &quot;A String&quot;, # Required. The object name.
2301 &quot;properties&quot;: [ # Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
2302 { # Source property.
2303 &quot;primaryKey&quot;: True or False, # Optional. Whether or not the property is a primary key.
2304 &quot;properties&quot;: [ # Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
2305 # Object with schema name: SourceProperty
2306 ],
2307 &quot;propertyName&quot;: &quot;A String&quot;, # Required. The property name.
2308 },
2309 ],
2310 },
2311 ],
2312 },
2313 &quot;pollingInterval&quot;: &quot;A String&quot;, # Required. Incremental sync polling interval for all objects. If not set, a default value of `5 minutes` is used. The duration must be from `5 minutes` to `24 hours`, inclusive.
2314 },
2315 &quot;salesforceSourceConfig&quot;: { # Configuration for syncing data from a Salesforce source. # Salesforce data source configuration.
2316 &quot;excludeObjects&quot;: { # Salesforce organization structure. # The Salesforce objects to exclude from the stream.
2317 &quot;objects&quot;: [ # Salesforce objects in the database server.
2318 { # Salesforce object.
2319 &quot;fields&quot;: [ # Salesforce fields. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
2320 { # Salesforce field.
2321 &quot;dataType&quot;: &quot;A String&quot;, # The data type.
2322 &quot;name&quot;: &quot;A String&quot;, # The field name.
2323 &quot;nillable&quot;: True or False, # Indicates whether the field can accept nil values.
2324 },
2325 ],
2326 &quot;objectName&quot;: &quot;A String&quot;, # The object name.
2327 },
2328 ],
2329 },
2330 &quot;includeObjects&quot;: { # Salesforce organization structure. # The Salesforce objects to retrieve from the source.
2331 &quot;objects&quot;: [ # Salesforce objects in the database server.
2332 { # Salesforce object.
2333 &quot;fields&quot;: [ # Salesforce fields. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
2334 { # Salesforce field.
2335 &quot;dataType&quot;: &quot;A String&quot;, # The data type.
2336 &quot;name&quot;: &quot;A String&quot;, # The field name.
2337 &quot;nillable&quot;: True or False, # Indicates whether the field can accept nil values.
2338 },
2339 ],
2340 &quot;objectName&quot;: &quot;A String&quot;, # The object name.
2341 },
2342 ],
2343 },
2344 &quot;pollingInterval&quot;: &quot;A String&quot;, # Required. Salesforce objects polling interval. The interval at which new changes will be polled for each object. The duration must be from `5 minutes` to `24 hours`, inclusive.
2345 },
2346 &quot;serviceNowSourceConfig&quot;: { # Configuration for syncing data from a ServiceNow source. # ServiceNow data source configuration.
2347 &quot;excludeObjects&quot;: { # Source catalog. # Optional. The objects to exclude from the stream.
2348 &quot;objects&quot;: [ # Optional. Source objects in the catalog.
2349 { # Source object.
2350 &quot;objectName&quot;: &quot;A String&quot;, # Required. The object name.
2351 &quot;properties&quot;: [ # Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
2352 { # Source property.
2353 &quot;primaryKey&quot;: True or False, # Optional. Whether or not the property is a primary key.
2354 &quot;properties&quot;: [ # Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
2355 # Object with schema name: SourceProperty
2356 ],
2357 &quot;propertyName&quot;: &quot;A String&quot;, # Required. The property name.
2358 },
2359 ],
2360 },
2361 ],
2362 },
2363 &quot;includeObjects&quot;: { # Source catalog. # Optional. The objects to retrieve from the source.
2364 &quot;objects&quot;: [ # Optional. Source objects in the catalog.
2365 { # Source object.
2366 &quot;objectName&quot;: &quot;A String&quot;, # Required. The object name.
2367 &quot;properties&quot;: [ # Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
2368 { # Source property.
2369 &quot;primaryKey&quot;: True or False, # Optional. Whether or not the property is a primary key.
2370 &quot;properties&quot;: [ # Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
2371 # Object with schema name: SourceProperty
2372 ],
2373 &quot;propertyName&quot;: &quot;A String&quot;, # Required. The property name.
2374 },
2375 ],
2376 },
2377 ],
2378 },
2379 &quot;pollingInterval&quot;: &quot;A String&quot;, # Required. Incremental sync polling interval for all objects. If not set, a default value of `5 minutes` is used. The duration must be from `5 minutes` to `24 hours`, inclusive.
2380 },
2381 &quot;sourceConnectionProfile&quot;: &quot;A String&quot;, # Required. Source connection profile resource. Format: `projects/{project}/locations/{location}/connectionProfiles/{name}`
2382 &quot;spannerSourceConfig&quot;: { # Configuration for syncing data from a Spanner source. # Spanner data source configuration.
2383 &quot;backfillDataBoostEnabled&quot;: True or False, # Optional. Whether to use Data Boost for Spanner backfills. Defaults to false if not set.
2384 &quot;changeStreamName&quot;: &quot;A String&quot;, # Required. Immutable. The change stream name to use for the stream.
2385 &quot;excludeObjects&quot;: { # Spanner database structure. # Optional. The Spanner objects to avoid retrieving. If some objects are both included and excluded, an error will be thrown.
2386 &quot;schemas&quot;: [ # Optional. Spanner schemas in the database.
2387 { # Spanner schema.
2388 &quot;schema&quot;: &quot;A String&quot;, # Required. The schema name.
2389 &quot;tables&quot;: [ # Optional. Spanner tables in the schema.
2390 { # Spanner table.
2391 &quot;columns&quot;: [ # Optional. Spanner columns in the table.
2392 { # Spanner column.
2393 &quot;column&quot;: &quot;A String&quot;, # Required. The column name.
2394 &quot;dataType&quot;: &quot;A String&quot;, # Optional. Spanner data type.
2395 &quot;isPrimaryKey&quot;: True or False, # Optional. Whether or not the column is a primary key.
2396 &quot;ordinalPosition&quot;: &quot;A String&quot;, # Optional. The ordinal position of the column in the table.
2397 },
2398 ],
2399 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
2400 },
2401 ],
2402 },
2403 ],
2404 },
2405 &quot;fgacRole&quot;: &quot;A String&quot;, # Optional. The FGAC role to use for the stream.
2406 &quot;includeObjects&quot;: { # Spanner database structure. # Optional. The Spanner objects to retrieve from the data source. If some objects are both included and excluded, an error will be thrown.
2407 &quot;schemas&quot;: [ # Optional. Spanner schemas in the database.
2408 { # Spanner schema.
2409 &quot;schema&quot;: &quot;A String&quot;, # Required. The schema name.
2410 &quot;tables&quot;: [ # Optional. Spanner tables in the schema.
2411 { # Spanner table.
2412 &quot;columns&quot;: [ # Optional. Spanner columns in the table.
2413 { # Spanner column.
2414 &quot;column&quot;: &quot;A String&quot;, # Required. The column name.
2415 &quot;dataType&quot;: &quot;A String&quot;, # Optional. Spanner data type.
2416 &quot;isPrimaryKey&quot;: True or False, # Optional. Whether or not the column is a primary key.
2417 &quot;ordinalPosition&quot;: &quot;A String&quot;, # Optional. The ordinal position of the column in the table.
2418 },
2419 ],
2420 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
2421 },
2422 ],
2423 },
2424 ],
2425 },
2426 &quot;maxConcurrentBackfillTasks&quot;: 42, # Optional. Maximum number of concurrent backfill tasks.
2427 &quot;maxConcurrentCdcTasks&quot;: 42, # Optional. Maximum number of concurrent CDC tasks.
2428 &quot;spannerRpcPriority&quot;: &quot;A String&quot;, # Optional. The RPC priority to use for the stream.
2429 },
2430 &quot;sqlServerSourceConfig&quot;: { # Configuration for syncing data from a SQLServer source. # SQLServer data source configuration.
2431 &quot;changeTables&quot;: { # Configuration to use Change Tables CDC read method. # CDC reader reads from change tables.
2432 },
2433 &quot;excludeObjects&quot;: { # SQLServer database structure. # The SQLServer objects to exclude from the stream.
2434 &quot;schemas&quot;: [ # SQLServer schemas in the database server.
2435 { # SQLServer schema.
2436 &quot;schema&quot;: &quot;A String&quot;, # The schema name.
2437 &quot;tables&quot;: [ # Tables in the schema.
2438 { # SQLServer table.
2439 &quot;columns&quot;: [ # SQLServer columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything.
2440 { # SQLServer Column.
2441 &quot;column&quot;: &quot;A String&quot;, # The column name.
2442 &quot;dataType&quot;: &quot;A String&quot;, # The SQLServer data type.
2443 &quot;length&quot;: 42, # Column length.
2444 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
2445 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
2446 &quot;precision&quot;: 42, # Column precision.
2447 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
2448 &quot;scale&quot;: 42, # Column scale.
2449 },
2450 ],
2451 &quot;table&quot;: &quot;A String&quot;, # The table name.
2452 },
2453 ],
2454 },
2455 ],
2456 },
2457 &quot;includeObjects&quot;: { # SQLServer database structure. # The SQLServer objects to include in the stream.
2458 &quot;schemas&quot;: [ # SQLServer schemas in the database server.
2459 { # SQLServer schema.
2460 &quot;schema&quot;: &quot;A String&quot;, # The schema name.
2461 &quot;tables&quot;: [ # Tables in the schema.
2462 { # SQLServer table.
2463 &quot;columns&quot;: [ # SQLServer columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything.
2464 { # SQLServer Column.
2465 &quot;column&quot;: &quot;A String&quot;, # The column name.
2466 &quot;dataType&quot;: &quot;A String&quot;, # The SQLServer data type.
2467 &quot;length&quot;: 42, # Column length.
2468 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
2469 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
2470 &quot;precision&quot;: 42, # Column precision.
2471 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
2472 &quot;scale&quot;: 42, # Column scale.
2473 },
2474 ],
2475 &quot;table&quot;: &quot;A String&quot;, # The table name.
2476 },
2477 ],
2478 },
2479 ],
2480 },
2481 &quot;maxConcurrentBackfillTasks&quot;: 42, # Max concurrent backfill tasks.
2482 &quot;maxConcurrentCdcTasks&quot;: 42, # Max concurrent CDC tasks.
2483 &quot;transactionLogs&quot;: { # Configuration to use Transaction Logs CDC read method. # CDC reader reads from transaction logs.
2484 },
2485 },
2486 },
2487 &quot;state&quot;: &quot;A String&quot;, # The state of the stream.
2488 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update time of the stream.
2489 },
2490 ],
2491 &quot;unreachable&quot;: [ # Locations that could not be reached.
2492 &quot;A String&quot;,
2493 ],
2494 }</pre>
2495 </div>
2496
2497 <div class="method">
2498 <code class="details" id="list_next">list_next()</code>
2499 <pre>Retrieves the next page of results.
2500
2501 Args:
2502 previous_request: The request for the previous page. (required)
2503 previous_response: The response from the request for the previous page. (required)
2504
2505 Returns:
2506 A request object that you can call &#x27;execute()&#x27; on to request the next
2507 page. Returns None if there are no more items in the collection.
2508 </pre>
2509 </div>
2510
2511 <div class="method">
2512 <code class="details" id="patch">patch(name, body=None, force=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)</code>
2513 <pre>Use this method to update the configuration of a stream.
2514
2515 Args:
2516 name: string, Output only. Identifier. The stream&#x27;s name. (required)
2517 body: object, The request body.
2518 The object takes the form of:
2519
2520 { # A resource representing streaming data from a source to a destination.
2521 &quot;backfillAll&quot;: { # Backfill strategy to automatically backfill the Stream&#x27;s objects. Specific objects can be excluded. # Automatically backfill objects included in the stream source configuration. Specific objects can be excluded.
2522 &quot;mongodbExcludedObjects&quot;: { # MongoDB Cluster structure. # MongoDB data source objects to avoid backfilling
2523 &quot;databases&quot;: [ # MongoDB databases in the cluster.
2524 { # MongoDB Database.
2525 &quot;collections&quot;: [ # Collections in the database.
2526 { # MongoDB Collection.
2527 &quot;collection&quot;: &quot;A String&quot;, # The collection name.
2528 &quot;fields&quot;: [ # Fields in the collection.
2529 { # MongoDB Field.
2530 &quot;field&quot;: &quot;A String&quot;, # The field name.
2531 },
2532 ],
2533 },
2534 ],
2535 &quot;database&quot;: &quot;A String&quot;, # The database name.
2536 },
2537 ],
2538 },
2539 &quot;mysqlExcludedObjects&quot;: { # MySQL database structure # MySQL data source objects to avoid backfilling.
2540 &quot;mysqlDatabases&quot;: [ # Mysql databases on the server
2541 { # MySQL database.
2542 &quot;database&quot;: &quot;A String&quot;, # The database name.
2543 &quot;mysqlTables&quot;: [ # Tables in the database.
2544 { # MySQL table.
2545 &quot;mysqlColumns&quot;: [ # MySQL columns in the database. When unspecified as part of include/exclude objects, includes/excludes everything.
2546 { # MySQL Column.
2547 &quot;collation&quot;: &quot;A String&quot;, # Column collation.
2548 &quot;column&quot;: &quot;A String&quot;, # The column name.
2549 &quot;dataType&quot;: &quot;A String&quot;, # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html
2550 &quot;length&quot;: 42, # Column length.
2551 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
2552 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
2553 &quot;precision&quot;: 42, # Column precision.
2554 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
2555 &quot;scale&quot;: 42, # Column scale.
2556 },
2557 ],
2558 &quot;table&quot;: &quot;A String&quot;, # The table name.
2559 },
2560 ],
2561 },
2562 ],
2563 },
2564 &quot;oracleExcludedObjects&quot;: { # Oracle database structure. # Oracle data source objects to avoid backfilling.
2565 &quot;oracleSchemas&quot;: [ # Oracle schemas/databases in the database server.
2566 { # Oracle schema.
2567 &quot;oracleTables&quot;: [ # Tables in the schema.
2568 { # Oracle table.
2569 &quot;oracleColumns&quot;: [ # Oracle columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything.
2570 { # Oracle Column.
2571 &quot;column&quot;: &quot;A String&quot;, # The column name.
2572 &quot;dataType&quot;: &quot;A String&quot;, # The Oracle data type.
2573 &quot;encoding&quot;: &quot;A String&quot;, # Column encoding.
2574 &quot;length&quot;: 42, # Column length.
2575 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
2576 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
2577 &quot;precision&quot;: 42, # Column precision.
2578 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
2579 &quot;scale&quot;: 42, # Column scale.
2580 },
2581 ],
2582 &quot;table&quot;: &quot;A String&quot;, # The table name.
2583 },
2584 ],
2585 &quot;schema&quot;: &quot;A String&quot;, # The schema name.
2586 },
2587 ],
2588 },
2589 &quot;postgresqlExcludedObjects&quot;: { # PostgreSQL database structure. # PostgreSQL data source objects to avoid backfilling.
2590 &quot;postgresqlSchemas&quot;: [ # PostgreSQL schemas in the database server.
2591 { # PostgreSQL schema.
2592 &quot;postgresqlTables&quot;: [ # Tables in the schema.
2593 { # PostgreSQL table.
2594 &quot;postgresqlColumns&quot;: [ # PostgreSQL columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything.
2595 { # PostgreSQL Column.
2596 &quot;column&quot;: &quot;A String&quot;, # The column name.
2597 &quot;dataType&quot;: &quot;A String&quot;, # The PostgreSQL data type.
2598 &quot;length&quot;: 42, # Column length.
2599 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
2600 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
2601 &quot;precision&quot;: 42, # Column precision.
2602 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
2603 &quot;scale&quot;: 42, # Column scale.
2604 },
2605 ],
2606 &quot;table&quot;: &quot;A String&quot;, # The table name.
2607 },
2608 ],
2609 &quot;schema&quot;: &quot;A String&quot;, # The schema name.
2610 },
2611 ],
2612 },
2613 &quot;saasExcludedObjects&quot;: { # Source catalog. # Source catalog data source objects to avoid backfilling. This is mainly used to represent SaaS applications objects.
2614 &quot;objects&quot;: [ # Optional. Source objects in the catalog.
2615 { # Source object.
2616 &quot;objectName&quot;: &quot;A String&quot;, # Required. The object name.
2617 &quot;properties&quot;: [ # Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
2618 { # Source property.
2619 &quot;primaryKey&quot;: True or False, # Optional. Whether or not the property is a primary key.
2620 &quot;properties&quot;: [ # Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
2621 # Object with schema name: SourceProperty
2622 ],
2623 &quot;propertyName&quot;: &quot;A String&quot;, # Required. The property name.
2624 },
2625 ],
2626 },
2627 ],
2628 },
2629 &quot;salesforceExcludedObjects&quot;: { # Salesforce organization structure. # Salesforce data source objects to avoid backfilling
2630 &quot;objects&quot;: [ # Salesforce objects in the database server.
2631 { # Salesforce object.
2632 &quot;fields&quot;: [ # Salesforce fields. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
2633 { # Salesforce field.
2634 &quot;dataType&quot;: &quot;A String&quot;, # The data type.
2635 &quot;name&quot;: &quot;A String&quot;, # The field name.
2636 &quot;nillable&quot;: True or False, # Indicates whether the field can accept nil values.
2637 },
2638 ],
2639 &quot;objectName&quot;: &quot;A String&quot;, # The object name.
2640 },
2641 ],
2642 },
2643 &quot;spannerExcludedObjects&quot;: { # Spanner database structure. # Spanner data source objects to avoid backfilling.
2644 &quot;schemas&quot;: [ # Optional. Spanner schemas in the database.
2645 { # Spanner schema.
2646 &quot;schema&quot;: &quot;A String&quot;, # Required. The schema name.
2647 &quot;tables&quot;: [ # Optional. Spanner tables in the schema.
2648 { # Spanner table.
2649 &quot;columns&quot;: [ # Optional. Spanner columns in the table.
2650 { # Spanner column.
2651 &quot;column&quot;: &quot;A String&quot;, # Required. The column name.
2652 &quot;dataType&quot;: &quot;A String&quot;, # Optional. Spanner data type.
2653 &quot;isPrimaryKey&quot;: True or False, # Optional. Whether or not the column is a primary key.
2654 &quot;ordinalPosition&quot;: &quot;A String&quot;, # Optional. The ordinal position of the column in the table.
2655 },
2656 ],
2657 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
2658 },
2659 ],
2660 },
2661 ],
2662 },
2663 &quot;sqlServerExcludedObjects&quot;: { # SQLServer database structure. # SQLServer data source objects to avoid backfilling
2664 &quot;schemas&quot;: [ # SQLServer schemas in the database server.
2665 { # SQLServer schema.
2666 &quot;schema&quot;: &quot;A String&quot;, # The schema name.
2667 &quot;tables&quot;: [ # Tables in the schema.
2668 { # SQLServer table.
2669 &quot;columns&quot;: [ # SQLServer columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything.
2670 { # SQLServer Column.
2671 &quot;column&quot;: &quot;A String&quot;, # The column name.
2672 &quot;dataType&quot;: &quot;A String&quot;, # The SQLServer data type.
2673 &quot;length&quot;: 42, # Column length.
2674 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
2675 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
2676 &quot;precision&quot;: 42, # Column precision.
2677 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
2678 &quot;scale&quot;: 42, # Column scale.
2679 },
2680 ],
2681 &quot;table&quot;: &quot;A String&quot;, # The table name.
2682 },
2683 ],
2684 },
2685 ],
2686 },
2687 },
2688 &quot;backfillNone&quot;: { # Backfill strategy to disable automatic backfill for the Stream&#x27;s objects. # Do not automatically backfill any objects.
2689 },
2690 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation time of the stream.
2691 &quot;customerManagedEncryptionKey&quot;: &quot;A String&quot;, # 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.
2692 &quot;destinationConfig&quot;: { # The configuration of the stream destination. # Required. Destination connection profile configuration.
2693 &quot;bigqueryDestinationConfig&quot;: { # BigQuery destination configuration # BigQuery destination configuration.
2694 &quot;appendOnly&quot;: { # AppendOnly mode defines that all changes to a table will be written to the destination table. # Append only mode
2695 },
2696 &quot;blmtConfig&quot;: { # The configuration for BLMT. # Optional. Big Lake Managed Tables (BLMT) configuration.
2697 &quot;bucket&quot;: &quot;A String&quot;, # Required. The Cloud Storage bucket name.
2698 &quot;connectionName&quot;: &quot;A String&quot;, # Required. The bigquery connection. Format: `{project}.{location}.{name}`
2699 &quot;fileFormat&quot;: &quot;A String&quot;, # Required. The file format.
2700 &quot;rootPath&quot;: &quot;A String&quot;, # The root path inside the Cloud Storage bucket.
2701 &quot;tableFormat&quot;: &quot;A String&quot;, # Required. The table format.
2702 },
2703 &quot;dataFreshness&quot;: &quot;A String&quot;, # The guaranteed data freshness (in seconds) when querying tables created by the stream. Editing this field will only affect new tables created in the future, but existing tables will not be impacted. Lower values mean that queries will return fresher data, but may result in higher cost.
2704 &quot;merge&quot;: { # Merge mode defines that all changes to a table will be merged at the destination table. # The standard mode
2705 },
2706 &quot;singleTargetDataset&quot;: { # A single target dataset to which all data will be streamed. # Single destination dataset.
2707 &quot;datasetId&quot;: &quot;A String&quot;, # The dataset ID of the target dataset. DatasetIds allowed characters: https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets#datasetreference.
2708 },
2709 &quot;sourceHierarchyDatasets&quot;: { # Destination datasets are created so that hierarchy of the destination data objects matches the source hierarchy. # Source hierarchy datasets.
2710 &quot;datasetTemplate&quot;: { # Dataset template used for dynamic dataset creation. # The dataset template to use for dynamic dataset creation.
2711 &quot;datasetIdPrefix&quot;: &quot;A String&quot;, # If supplied, every created dataset will have its name prefixed by the provided value. The prefix and name will be separated by an underscore. i.e. _.
2712 &quot;kmsKeyName&quot;: &quot;A String&quot;, # Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key. i.e. projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{cryptoKey}. See https://cloud.google.com/bigquery/docs/customer-managed-encryption for more information.
2713 &quot;location&quot;: &quot;A String&quot;, # Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
2714 },
2715 &quot;projectId&quot;: &quot;A String&quot;, # Optional. The project id of the BigQuery dataset. If not specified, the project will be inferred from the stream resource.
2716 },
2717 },
2718 &quot;destinationConnectionProfile&quot;: &quot;A String&quot;, # Required. Destination connection profile resource. Format: `projects/{project}/locations/{location}/connectionProfiles/{name}`
2719 &quot;gcsDestinationConfig&quot;: { # Google Cloud Storage destination configuration # A configuration for how data should be loaded to Cloud Storage.
2720 &quot;avroFileFormat&quot;: { # AVRO file format configuration. # AVRO file format configuration.
2721 },
2722 &quot;fileRotationInterval&quot;: &quot;A String&quot;, # The maximum duration for which new events are added before a file is closed and a new file is created. Values within the range of 15-60 seconds are allowed.
2723 &quot;fileRotationMb&quot;: 42, # The maximum file size to be saved in the bucket.
2724 &quot;jsonFileFormat&quot;: { # JSON file format configuration. # JSON file format configuration.
2725 &quot;compression&quot;: &quot;A String&quot;, # Compression of the loaded JSON file.
2726 &quot;schemaFileFormat&quot;: &quot;A String&quot;, # The schema file format along JSON data files.
2727 },
2728 &quot;path&quot;: &quot;A String&quot;, # Path inside the Cloud Storage bucket to write data to.
2729 },
2730 },
2731 &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name.
2732 &quot;errors&quot;: [ # Output only. Errors on the Stream.
2733 { # Represent a user-facing Error.
2734 &quot;details&quot;: { # Additional information about the error.
2735 &quot;a_key&quot;: &quot;A String&quot;,
2736 },
2737 &quot;errorTime&quot;: &quot;A String&quot;, # The time when the error occurred.
2738 &quot;errorUuid&quot;: &quot;A String&quot;, # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
2739 &quot;message&quot;: &quot;A String&quot;, # A message containing more information about the error that occurred.
2740 &quot;reason&quot;: &quot;A String&quot;, # A title that explains the reason for the error.
2741 },
2742 ],
2743 &quot;labels&quot;: { # Labels.
2744 &quot;a_key&quot;: &quot;A String&quot;,
2745 },
2746 &quot;lastRecoveryTime&quot;: &quot;A String&quot;, # Output only. If the stream was recovered, the time of the last recovery. Note: This field is currently experimental.
2747 &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The stream&#x27;s name.
2748 &quot;ruleSets&quot;: [ # Optional. Rule sets to apply to the stream.
2749 { # A set of rules to apply to a set of objects.
2750 &quot;customizationRules&quot;: [ # Required. List of customization rules to apply.
2751 { # A customization rule to apply to a set of objects.
2752 &quot;bigqueryClustering&quot;: { # BigQuery clustering configuration. # BigQuery clustering rule.
2753 &quot;columns&quot;: [ # Required. Column names to set as clustering columns.
2754 &quot;A String&quot;,
2755 ],
2756 },
2757 &quot;bigqueryPartitioning&quot;: { # BigQuery partitioning configuration. # BigQuery partitioning rule.
2758 &quot;ingestionTimePartition&quot;: { # Ingestion time partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time # Ingestion time partitioning.
2759 &quot;partitioningTimeGranularity&quot;: &quot;A String&quot;, # Optional. Partition granularity
2760 },
2761 &quot;integerRangePartition&quot;: { # Integer range partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#integer_range # Integer range partitioning.
2762 &quot;column&quot;: &quot;A String&quot;, # Required. The partitioning column.
2763 &quot;end&quot;: &quot;A String&quot;, # Required. The ending value for range partitioning (exclusive).
2764 &quot;interval&quot;: &quot;A String&quot;, # Required. The interval of each range within the partition.
2765 &quot;start&quot;: &quot;A String&quot;, # Required. The starting value for range partitioning (inclusive).
2766 },
2767 &quot;requirePartitionFilter&quot;: True or False, # Optional. If true, queries over the table require a partition filter.
2768 &quot;timeUnitPartition&quot;: { # Time unit column partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#date_timestamp_partitioned_tables # Time unit column partitioning.
2769 &quot;column&quot;: &quot;A String&quot;, # Required. The partitioning column.
2770 &quot;partitioningTimeGranularity&quot;: &quot;A String&quot;, # Optional. Partition granularity.
2771 },
2772 },
2773 },
2774 ],
2775 &quot;objectFilter&quot;: { # Object filter to apply the rules to. # Required. Object filter to apply the customization rules to.
2776 &quot;sourceObjectIdentifier&quot;: { # Represents an identifier of an object in the data source. # Specific source object identifier.
2777 &quot;mongodbIdentifier&quot;: { # MongoDB data source object identifier. # MongoDB data source object identifier.
2778 &quot;collection&quot;: &quot;A String&quot;, # Required. The collection name.
2779 &quot;database&quot;: &quot;A String&quot;, # Required. The database name.
2780 },
2781 &quot;mysqlIdentifier&quot;: { # Mysql data source object identifier. # Mysql data source object identifier.
2782 &quot;database&quot;: &quot;A String&quot;, # Required. The database name.
2783 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
2784 },
2785 &quot;oracleIdentifier&quot;: { # Oracle data source object identifier. # Oracle data source object identifier.
2786 &quot;schema&quot;: &quot;A String&quot;, # Required. The schema name.
2787 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
2788 },
2789 &quot;postgresqlIdentifier&quot;: { # PostgreSQL data source object identifier. # PostgreSQL data source object identifier.
2790 &quot;schema&quot;: &quot;A String&quot;, # Required. The schema name.
2791 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
2792 },
2793 &quot;salesforceIdentifier&quot;: { # Salesforce data source object identifier. # Salesforce data source object identifier.
2794 &quot;objectName&quot;: &quot;A String&quot;, # Required. The object name.
2795 },
2796 &quot;spannerIdentifier&quot;: { # Spanner data source object identifier. # Spanner data source object identifier.
2797 &quot;schema&quot;: &quot;A String&quot;, # Optional. The schema name.
2798 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
2799 },
2800 &quot;sqlServerIdentifier&quot;: { # SQLServer data source object identifier. # SQLServer data source object identifier.
2801 &quot;schema&quot;: &quot;A String&quot;, # Required. The schema name.
2802 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
2803 },
2804 },
2805 },
2806 },
2807 ],
2808 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
2809 &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
2810 &quot;sourceConfig&quot;: { # The configuration of the stream source. # Required. Source connection profile configuration.
2811 &quot;dataverseSourceConfig&quot;: { # Configuration for syncing data from a Dataverse source. # Dataverse data source configuration.
2812 &quot;excludeObjects&quot;: { # Source catalog. # Optional. The objects to exclude from the stream.
2813 &quot;objects&quot;: [ # Optional. Source objects in the catalog.
2814 { # Source object.
2815 &quot;objectName&quot;: &quot;A String&quot;, # Required. The object name.
2816 &quot;properties&quot;: [ # Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
2817 { # Source property.
2818 &quot;primaryKey&quot;: True or False, # Optional. Whether or not the property is a primary key.
2819 &quot;properties&quot;: [ # Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
2820 # Object with schema name: SourceProperty
2821 ],
2822 &quot;propertyName&quot;: &quot;A String&quot;, # Required. The property name.
2823 },
2824 ],
2825 },
2826 ],
2827 },
2828 &quot;includeObjects&quot;: { # Source catalog. # Optional. The objects to retrieve from the source.
2829 &quot;objects&quot;: [ # Optional. Source objects in the catalog.
2830 { # Source object.
2831 &quot;objectName&quot;: &quot;A String&quot;, # Required. The object name.
2832 &quot;properties&quot;: [ # Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
2833 { # Source property.
2834 &quot;primaryKey&quot;: True or False, # Optional. Whether or not the property is a primary key.
2835 &quot;properties&quot;: [ # Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
2836 # Object with schema name: SourceProperty
2837 ],
2838 &quot;propertyName&quot;: &quot;A String&quot;, # Required. The property name.
2839 },
2840 ],
2841 },
2842 ],
2843 },
2844 &quot;pollingInterval&quot;: &quot;A String&quot;, # Required. Incremental sync polling interval for all objects. If not set, a default value of `5 minutes` is used. The duration must be from `5 minutes` to `24 hours`, inclusive.
2845 },
2846 &quot;mongodbSourceConfig&quot;: { # Configuration for syncing data from a MongoDB source. # MongoDB data source configuration.
2847 &quot;excludeObjects&quot;: { # MongoDB Cluster structure. # The MongoDB collections to exclude from the stream.
2848 &quot;databases&quot;: [ # MongoDB databases in the cluster.
2849 { # MongoDB Database.
2850 &quot;collections&quot;: [ # Collections in the database.
2851 { # MongoDB Collection.
2852 &quot;collection&quot;: &quot;A String&quot;, # The collection name.
2853 &quot;fields&quot;: [ # Fields in the collection.
2854 { # MongoDB Field.
2855 &quot;field&quot;: &quot;A String&quot;, # The field name.
2856 },
2857 ],
2858 },
2859 ],
2860 &quot;database&quot;: &quot;A String&quot;, # The database name.
2861 },
2862 ],
2863 },
2864 &quot;includeObjects&quot;: { # MongoDB Cluster structure. # The MongoDB collections to include in the stream.
2865 &quot;databases&quot;: [ # MongoDB databases in the cluster.
2866 { # MongoDB Database.
2867 &quot;collections&quot;: [ # Collections in the database.
2868 { # MongoDB Collection.
2869 &quot;collection&quot;: &quot;A String&quot;, # The collection name.
2870 &quot;fields&quot;: [ # Fields in the collection.
2871 { # MongoDB Field.
2872 &quot;field&quot;: &quot;A String&quot;, # The field name.
2873 },
2874 ],
2875 },
2876 ],
2877 &quot;database&quot;: &quot;A String&quot;, # The database name.
2878 },
2879 ],
2880 },
2881 &quot;jsonMode&quot;: &quot;A String&quot;, # Optional. MongoDB JSON mode to use for the stream.
2882 &quot;maxConcurrentBackfillTasks&quot;: 42, # Optional. Maximum number of concurrent backfill tasks. The number should be non-negative and less than or equal to 50. If not set (or set to 0), the system&#x27;s default value is used
2883 },
2884 &quot;mysqlSourceConfig&quot;: { # Configuration for syncing data from a MySQL source. # MySQL data source configuration.
2885 &quot;binaryLogPosition&quot;: { # Use Binary log position based replication. # Use Binary log position based replication.
2886 },
2887 &quot;excludeObjects&quot;: { # MySQL database structure # The MySQL objects to exclude from the stream.
2888 &quot;mysqlDatabases&quot;: [ # Mysql databases on the server
2889 { # MySQL database.
2890 &quot;database&quot;: &quot;A String&quot;, # The database name.
2891 &quot;mysqlTables&quot;: [ # Tables in the database.
2892 { # MySQL table.
2893 &quot;mysqlColumns&quot;: [ # MySQL columns in the database. When unspecified as part of include/exclude objects, includes/excludes everything.
2894 { # MySQL Column.
2895 &quot;collation&quot;: &quot;A String&quot;, # Column collation.
2896 &quot;column&quot;: &quot;A String&quot;, # The column name.
2897 &quot;dataType&quot;: &quot;A String&quot;, # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html
2898 &quot;length&quot;: 42, # Column length.
2899 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
2900 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
2901 &quot;precision&quot;: 42, # Column precision.
2902 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
2903 &quot;scale&quot;: 42, # Column scale.
2904 },
2905 ],
2906 &quot;table&quot;: &quot;A String&quot;, # The table name.
2907 },
2908 ],
2909 },
2910 ],
2911 },
2912 &quot;gtid&quot;: { # Use GTID based replication. # Use GTID based replication.
2913 },
2914 &quot;includeObjects&quot;: { # MySQL database structure # The MySQL objects to retrieve from the source.
2915 &quot;mysqlDatabases&quot;: [ # Mysql databases on the server
2916 { # MySQL database.
2917 &quot;database&quot;: &quot;A String&quot;, # The database name.
2918 &quot;mysqlTables&quot;: [ # Tables in the database.
2919 { # MySQL table.
2920 &quot;mysqlColumns&quot;: [ # MySQL columns in the database. When unspecified as part of include/exclude objects, includes/excludes everything.
2921 { # MySQL Column.
2922 &quot;collation&quot;: &quot;A String&quot;, # Column collation.
2923 &quot;column&quot;: &quot;A String&quot;, # The column name.
2924 &quot;dataType&quot;: &quot;A String&quot;, # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html
2925 &quot;length&quot;: 42, # Column length.
2926 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
2927 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
2928 &quot;precision&quot;: 42, # Column precision.
2929 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
2930 &quot;scale&quot;: 42, # Column scale.
2931 },
2932 ],
2933 &quot;table&quot;: &quot;A String&quot;, # The table name.
2934 },
2935 ],
2936 },
2937 ],
2938 },
2939 &quot;maxConcurrentBackfillTasks&quot;: 42, # Maximum number of concurrent backfill tasks. The number should be non negative. If not set (or set to 0), the system&#x27;s default value will be used.
2940 &quot;maxConcurrentCdcTasks&quot;: 42, # Maximum number of concurrent CDC tasks. The number should be non negative. If not set (or set to 0), the system&#x27;s default value will be used.
2941 },
2942 &quot;oracleSourceConfig&quot;: { # Configuration for syncing data from an Oracle source. # Oracle data source configuration.
2943 &quot;binaryLogParser&quot;: { # Configuration to use Binary Log Parser CDC technique. # Use Binary Log Parser.
2944 &quot;logFileDirectories&quot;: { # Configuration to specify the Oracle directories to access the log files. # Use Oracle directories.
2945 &quot;archivedLogDirectory&quot;: &quot;A String&quot;, # Required. Oracle directory for archived logs.
2946 &quot;onlineLogDirectory&quot;: &quot;A String&quot;, # Required. Oracle directory for online logs.
2947 },
2948 &quot;oracleAsmLogFileAccess&quot;: { # Configuration to use Oracle ASM to access the log files. # Use Oracle ASM.
2949 },
2950 },
2951 &quot;dropLargeObjects&quot;: { # Configuration to drop large object values. # Drop large object values.
2952 },
2953 &quot;excludeObjects&quot;: { # Oracle database structure. # The Oracle objects to exclude from the stream.
2954 &quot;oracleSchemas&quot;: [ # Oracle schemas/databases in the database server.
2955 { # Oracle schema.
2956 &quot;oracleTables&quot;: [ # Tables in the schema.
2957 { # Oracle table.
2958 &quot;oracleColumns&quot;: [ # Oracle columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything.
2959 { # Oracle Column.
2960 &quot;column&quot;: &quot;A String&quot;, # The column name.
2961 &quot;dataType&quot;: &quot;A String&quot;, # The Oracle data type.
2962 &quot;encoding&quot;: &quot;A String&quot;, # Column encoding.
2963 &quot;length&quot;: 42, # Column length.
2964 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
2965 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
2966 &quot;precision&quot;: 42, # Column precision.
2967 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
2968 &quot;scale&quot;: 42, # Column scale.
2969 },
2970 ],
2971 &quot;table&quot;: &quot;A String&quot;, # The table name.
2972 },
2973 ],
2974 &quot;schema&quot;: &quot;A String&quot;, # The schema name.
2975 },
2976 ],
2977 },
2978 &quot;includeObjects&quot;: { # Oracle database structure. # The Oracle objects to include in the stream.
2979 &quot;oracleSchemas&quot;: [ # Oracle schemas/databases in the database server.
2980 { # Oracle schema.
2981 &quot;oracleTables&quot;: [ # Tables in the schema.
2982 { # Oracle table.
2983 &quot;oracleColumns&quot;: [ # Oracle columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything.
2984 { # Oracle Column.
2985 &quot;column&quot;: &quot;A String&quot;, # The column name.
2986 &quot;dataType&quot;: &quot;A String&quot;, # The Oracle data type.
2987 &quot;encoding&quot;: &quot;A String&quot;, # Column encoding.
2988 &quot;length&quot;: 42, # Column length.
2989 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
2990 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
2991 &quot;precision&quot;: 42, # Column precision.
2992 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
2993 &quot;scale&quot;: 42, # Column scale.
2994 },
2995 ],
2996 &quot;table&quot;: &quot;A String&quot;, # The table name.
2997 },
2998 ],
2999 &quot;schema&quot;: &quot;A String&quot;, # The schema name.
3000 },
3001 ],
3002 },
3003 &quot;logMiner&quot;: { # Configuration to use LogMiner CDC method. # Use LogMiner.
3004 },
3005 &quot;maxConcurrentBackfillTasks&quot;: 42, # Maximum number of concurrent backfill tasks. The number should be non-negative. If not set (or set to 0), the system&#x27;s default value is used.
3006 &quot;maxConcurrentCdcTasks&quot;: 42, # Maximum number of concurrent CDC tasks. The number should be non-negative. If not set (or set to 0), the system&#x27;s default value is used.
3007 &quot;streamLargeObjects&quot;: { # Configuration to stream large object values. # Stream large object values.
3008 },
3009 },
3010 &quot;postgresqlSourceConfig&quot;: { # Configuration for syncing data from a PostgreSQL source. # PostgreSQL data source configuration.
3011 &quot;excludeObjects&quot;: { # PostgreSQL database structure. # The PostgreSQL objects to exclude from the stream.
3012 &quot;postgresqlSchemas&quot;: [ # PostgreSQL schemas in the database server.
3013 { # PostgreSQL schema.
3014 &quot;postgresqlTables&quot;: [ # Tables in the schema.
3015 { # PostgreSQL table.
3016 &quot;postgresqlColumns&quot;: [ # PostgreSQL columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything.
3017 { # PostgreSQL Column.
3018 &quot;column&quot;: &quot;A String&quot;, # The column name.
3019 &quot;dataType&quot;: &quot;A String&quot;, # The PostgreSQL data type.
3020 &quot;length&quot;: 42, # Column length.
3021 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
3022 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
3023 &quot;precision&quot;: 42, # Column precision.
3024 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
3025 &quot;scale&quot;: 42, # Column scale.
3026 },
3027 ],
3028 &quot;table&quot;: &quot;A String&quot;, # The table name.
3029 },
3030 ],
3031 &quot;schema&quot;: &quot;A String&quot;, # The schema name.
3032 },
3033 ],
3034 },
3035 &quot;includeObjects&quot;: { # PostgreSQL database structure. # The PostgreSQL objects to include in the stream.
3036 &quot;postgresqlSchemas&quot;: [ # PostgreSQL schemas in the database server.
3037 { # PostgreSQL schema.
3038 &quot;postgresqlTables&quot;: [ # Tables in the schema.
3039 { # PostgreSQL table.
3040 &quot;postgresqlColumns&quot;: [ # PostgreSQL columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything.
3041 { # PostgreSQL Column.
3042 &quot;column&quot;: &quot;A String&quot;, # The column name.
3043 &quot;dataType&quot;: &quot;A String&quot;, # The PostgreSQL data type.
3044 &quot;length&quot;: 42, # Column length.
3045 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
3046 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
3047 &quot;precision&quot;: 42, # Column precision.
3048 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
3049 &quot;scale&quot;: 42, # Column scale.
3050 },
3051 ],
3052 &quot;table&quot;: &quot;A String&quot;, # The table name.
3053 },
3054 ],
3055 &quot;schema&quot;: &quot;A String&quot;, # The schema name.
3056 },
3057 ],
3058 },
3059 &quot;maxConcurrentBackfillTasks&quot;: 42, # Maximum number of concurrent backfill tasks. The number should be non negative. If not set (or set to 0), the system&#x27;s default value will be used.
3060 &quot;publication&quot;: &quot;A String&quot;, # Required. The name of the publication that includes the set of all tables that are defined in the stream&#x27;s include_objects.
3061 &quot;replicationSlot&quot;: &quot;A String&quot;, # Required. Immutable. The name of the logical replication slot that&#x27;s configured with the pgoutput plugin.
3062 },
3063 &quot;salesforceMarketingCloudSourceConfig&quot;: { # Configuration for syncing data from a Salesforce Marketing Cloud source. # Salesforce Marketing Cloud data source configuration.
3064 &quot;excludeObjects&quot;: { # Source catalog. # Optional. The objects to exclude from the stream.
3065 &quot;objects&quot;: [ # Optional. Source objects in the catalog.
3066 { # Source object.
3067 &quot;objectName&quot;: &quot;A String&quot;, # Required. The object name.
3068 &quot;properties&quot;: [ # Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
3069 { # Source property.
3070 &quot;primaryKey&quot;: True or False, # Optional. Whether or not the property is a primary key.
3071 &quot;properties&quot;: [ # Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
3072 # Object with schema name: SourceProperty
3073 ],
3074 &quot;propertyName&quot;: &quot;A String&quot;, # Required. The property name.
3075 },
3076 ],
3077 },
3078 ],
3079 },
3080 &quot;fullRefreshPollingInterval&quot;: &quot;A String&quot;, # Required. Specifies the polling interval for a full refresh of objects that do not support incremental sync. If not set, a default value of 24 hours is used. The duration must be between 1 and 24 hours, inclusive.
3081 &quot;includeObjects&quot;: { # Source catalog. # Optional. The objects to retrieve from the source.
3082 &quot;objects&quot;: [ # Optional. Source objects in the catalog.
3083 { # Source object.
3084 &quot;objectName&quot;: &quot;A String&quot;, # Required. The object name.
3085 &quot;properties&quot;: [ # Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
3086 { # Source property.
3087 &quot;primaryKey&quot;: True or False, # Optional. Whether or not the property is a primary key.
3088 &quot;properties&quot;: [ # Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
3089 # Object with schema name: SourceProperty
3090 ],
3091 &quot;propertyName&quot;: &quot;A String&quot;, # Required. The property name.
3092 },
3093 ],
3094 },
3095 ],
3096 },
3097 &quot;pollingInterval&quot;: &quot;A String&quot;, # Required. Incremental sync polling interval for all objects. If not set, a default value of `5 minutes` is used. The duration must be from `5 minutes` to `24 hours`, inclusive.
3098 },
3099 &quot;salesforceSourceConfig&quot;: { # Configuration for syncing data from a Salesforce source. # Salesforce data source configuration.
3100 &quot;excludeObjects&quot;: { # Salesforce organization structure. # The Salesforce objects to exclude from the stream.
3101 &quot;objects&quot;: [ # Salesforce objects in the database server.
3102 { # Salesforce object.
3103 &quot;fields&quot;: [ # Salesforce fields. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
3104 { # Salesforce field.
3105 &quot;dataType&quot;: &quot;A String&quot;, # The data type.
3106 &quot;name&quot;: &quot;A String&quot;, # The field name.
3107 &quot;nillable&quot;: True or False, # Indicates whether the field can accept nil values.
3108 },
3109 ],
3110 &quot;objectName&quot;: &quot;A String&quot;, # The object name.
3111 },
3112 ],
3113 },
3114 &quot;includeObjects&quot;: { # Salesforce organization structure. # The Salesforce objects to retrieve from the source.
3115 &quot;objects&quot;: [ # Salesforce objects in the database server.
3116 { # Salesforce object.
3117 &quot;fields&quot;: [ # Salesforce fields. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
3118 { # Salesforce field.
3119 &quot;dataType&quot;: &quot;A String&quot;, # The data type.
3120 &quot;name&quot;: &quot;A String&quot;, # The field name.
3121 &quot;nillable&quot;: True or False, # Indicates whether the field can accept nil values.
3122 },
3123 ],
3124 &quot;objectName&quot;: &quot;A String&quot;, # The object name.
3125 },
3126 ],
3127 },
3128 &quot;pollingInterval&quot;: &quot;A String&quot;, # Required. Salesforce objects polling interval. The interval at which new changes will be polled for each object. The duration must be from `5 minutes` to `24 hours`, inclusive.
3129 },
3130 &quot;serviceNowSourceConfig&quot;: { # Configuration for syncing data from a ServiceNow source. # ServiceNow data source configuration.
3131 &quot;excludeObjects&quot;: { # Source catalog. # Optional. The objects to exclude from the stream.
3132 &quot;objects&quot;: [ # Optional. Source objects in the catalog.
3133 { # Source object.
3134 &quot;objectName&quot;: &quot;A String&quot;, # Required. The object name.
3135 &quot;properties&quot;: [ # Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
3136 { # Source property.
3137 &quot;primaryKey&quot;: True or False, # Optional. Whether or not the property is a primary key.
3138 &quot;properties&quot;: [ # Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
3139 # Object with schema name: SourceProperty
3140 ],
3141 &quot;propertyName&quot;: &quot;A String&quot;, # Required. The property name.
3142 },
3143 ],
3144 },
3145 ],
3146 },
3147 &quot;includeObjects&quot;: { # Source catalog. # Optional. The objects to retrieve from the source.
3148 &quot;objects&quot;: [ # Optional. Source objects in the catalog.
3149 { # Source object.
3150 &quot;objectName&quot;: &quot;A String&quot;, # Required. The object name.
3151 &quot;properties&quot;: [ # Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
3152 { # Source property.
3153 &quot;primaryKey&quot;: True or False, # Optional. Whether or not the property is a primary key.
3154 &quot;properties&quot;: [ # Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.
3155 # Object with schema name: SourceProperty
3156 ],
3157 &quot;propertyName&quot;: &quot;A String&quot;, # Required. The property name.
3158 },
3159 ],
3160 },
3161 ],
3162 },
3163 &quot;pollingInterval&quot;: &quot;A String&quot;, # Required. Incremental sync polling interval for all objects. If not set, a default value of `5 minutes` is used. The duration must be from `5 minutes` to `24 hours`, inclusive.
3164 },
3165 &quot;sourceConnectionProfile&quot;: &quot;A String&quot;, # Required. Source connection profile resource. Format: `projects/{project}/locations/{location}/connectionProfiles/{name}`
3166 &quot;spannerSourceConfig&quot;: { # Configuration for syncing data from a Spanner source. # Spanner data source configuration.
3167 &quot;backfillDataBoostEnabled&quot;: True or False, # Optional. Whether to use Data Boost for Spanner backfills. Defaults to false if not set.
3168 &quot;changeStreamName&quot;: &quot;A String&quot;, # Required. Immutable. The change stream name to use for the stream.
3169 &quot;excludeObjects&quot;: { # Spanner database structure. # Optional. The Spanner objects to avoid retrieving. If some objects are both included and excluded, an error will be thrown.
3170 &quot;schemas&quot;: [ # Optional. Spanner schemas in the database.
3171 { # Spanner schema.
3172 &quot;schema&quot;: &quot;A String&quot;, # Required. The schema name.
3173 &quot;tables&quot;: [ # Optional. Spanner tables in the schema.
3174 { # Spanner table.
3175 &quot;columns&quot;: [ # Optional. Spanner columns in the table.
3176 { # Spanner column.
3177 &quot;column&quot;: &quot;A String&quot;, # Required. The column name.
3178 &quot;dataType&quot;: &quot;A String&quot;, # Optional. Spanner data type.
3179 &quot;isPrimaryKey&quot;: True or False, # Optional. Whether or not the column is a primary key.
3180 &quot;ordinalPosition&quot;: &quot;A String&quot;, # Optional. The ordinal position of the column in the table.
3181 },
3182 ],
3183 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
3184 },
3185 ],
3186 },
3187 ],
3188 },
3189 &quot;fgacRole&quot;: &quot;A String&quot;, # Optional. The FGAC role to use for the stream.
3190 &quot;includeObjects&quot;: { # Spanner database structure. # Optional. The Spanner objects to retrieve from the data source. If some objects are both included and excluded, an error will be thrown.
3191 &quot;schemas&quot;: [ # Optional. Spanner schemas in the database.
3192 { # Spanner schema.
3193 &quot;schema&quot;: &quot;A String&quot;, # Required. The schema name.
3194 &quot;tables&quot;: [ # Optional. Spanner tables in the schema.
3195 { # Spanner table.
3196 &quot;columns&quot;: [ # Optional. Spanner columns in the table.
3197 { # Spanner column.
3198 &quot;column&quot;: &quot;A String&quot;, # Required. The column name.
3199 &quot;dataType&quot;: &quot;A String&quot;, # Optional. Spanner data type.
3200 &quot;isPrimaryKey&quot;: True or False, # Optional. Whether or not the column is a primary key.
3201 &quot;ordinalPosition&quot;: &quot;A String&quot;, # Optional. The ordinal position of the column in the table.
3202 },
3203 ],
3204 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
3205 },
3206 ],
3207 },
3208 ],
3209 },
3210 &quot;maxConcurrentBackfillTasks&quot;: 42, # Optional. Maximum number of concurrent backfill tasks.
3211 &quot;maxConcurrentCdcTasks&quot;: 42, # Optional. Maximum number of concurrent CDC tasks.
3212 &quot;spannerRpcPriority&quot;: &quot;A String&quot;, # Optional. The RPC priority to use for the stream.
3213 },
3214 &quot;sqlServerSourceConfig&quot;: { # Configuration for syncing data from a SQLServer source. # SQLServer data source configuration.
3215 &quot;changeTables&quot;: { # Configuration to use Change Tables CDC read method. # CDC reader reads from change tables.
3216 },
3217 &quot;excludeObjects&quot;: { # SQLServer database structure. # The SQLServer objects to exclude from the stream.
3218 &quot;schemas&quot;: [ # SQLServer schemas in the database server.
3219 { # SQLServer schema.
3220 &quot;schema&quot;: &quot;A String&quot;, # The schema name.
3221 &quot;tables&quot;: [ # Tables in the schema.
3222 { # SQLServer table.
3223 &quot;columns&quot;: [ # SQLServer columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything.
3224 { # SQLServer Column.
3225 &quot;column&quot;: &quot;A String&quot;, # The column name.
3226 &quot;dataType&quot;: &quot;A String&quot;, # The SQLServer data type.
3227 &quot;length&quot;: 42, # Column length.
3228 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
3229 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
3230 &quot;precision&quot;: 42, # Column precision.
3231 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
3232 &quot;scale&quot;: 42, # Column scale.
3233 },
3234 ],
3235 &quot;table&quot;: &quot;A String&quot;, # The table name.
3236 },
3237 ],
3238 },
3239 ],
3240 },
3241 &quot;includeObjects&quot;: { # SQLServer database structure. # The SQLServer objects to include in the stream.
3242 &quot;schemas&quot;: [ # SQLServer schemas in the database server.
3243 { # SQLServer schema.
3244 &quot;schema&quot;: &quot;A String&quot;, # The schema name.
3245 &quot;tables&quot;: [ # Tables in the schema.
3246 { # SQLServer table.
3247 &quot;columns&quot;: [ # SQLServer columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything.
3248 { # SQLServer Column.
3249 &quot;column&quot;: &quot;A String&quot;, # The column name.
3250 &quot;dataType&quot;: &quot;A String&quot;, # The SQLServer data type.
3251 &quot;length&quot;: 42, # Column length.
3252 &quot;nullable&quot;: True or False, # Whether or not the column can accept a null value.
3253 &quot;ordinalPosition&quot;: 42, # The ordinal position of the column in the table.
3254 &quot;precision&quot;: 42, # Column precision.
3255 &quot;primaryKey&quot;: True or False, # Whether or not the column represents a primary key.
3256 &quot;scale&quot;: 42, # Column scale.
3257 },
3258 ],
3259 &quot;table&quot;: &quot;A String&quot;, # The table name.
3260 },
3261 ],
3262 },
3263 ],
3264 },
3265 &quot;maxConcurrentBackfillTasks&quot;: 42, # Max concurrent backfill tasks.
3266 &quot;maxConcurrentCdcTasks&quot;: 42, # Max concurrent CDC tasks.
3267 &quot;transactionLogs&quot;: { # Configuration to use Transaction Logs CDC read method. # CDC reader reads from transaction logs.
3268 },
3269 },
3270 },
3271 &quot;state&quot;: &quot;A String&quot;, # The state of the stream.
3272 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update time of the stream.
3273 }
3274
3275 force: boolean, Optional. Update the stream without validating it.
3276 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).
3277 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.
3278 validateOnly: boolean, Optional. Only validate the stream with the changes, without actually updating it. The default is false.
3279 x__xgafv: string, V1 error format.
3280 Allowed values
3281 1 - v1 error format
3282 2 - v2 error format
3283
3284 Returns:
3285 An object of the form:
3286
3287 { # This resource represents a long-running operation that is the result of a network API call.
3288 &quot;done&quot;: 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.
3289 &quot;error&quot;: { # 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.
3290 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
3291 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
3292 {
3293 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
3294 },
3295 ],
3296 &quot;message&quot;: &quot;A String&quot;, # 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.
3297 },
3298 &quot;metadata&quot;: { # 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.
3299 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
3300 },
3301 &quot;name&quot;: &quot;A String&quot;, # 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}`.
3302 &quot;response&quot;: { # 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`.
3303 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
3304 },
3305 }</pre>
3306 </div>
3307
3308 <div class="method">
3309 <code class="details" id="run">run(name, body=None, x__xgafv=None)</code>
3310 <pre>Use this method to start, resume or recover a stream with a non default CDC strategy.
3311
3312 Args:
3313 name: string, Required. Name of the stream resource to start, in the format: projects/{project_id}/locations/{location}/streams/{stream_name} (required)
3314 body: object, The request body.
3315 The object takes the form of:
3316
3317 { # Request message for running a stream.
3318 &quot;cdcStrategy&quot;: { # The strategy that the stream uses for CDC replication. # Optional. The CDC strategy of the stream. If not set, the system&#x27;s default value will be used.
3319 &quot;mostRecentStartPosition&quot;: { # CDC strategy to start replicating from the most recent position in the source. # Optional. Start replicating from the most recent position in the source.
3320 },
3321 &quot;nextAvailableStartPosition&quot;: { # CDC strategy to resume replication from the next available position in the source. # Optional. Resume replication from the next available position in the source.
3322 },
3323 &quot;specificStartPosition&quot;: { # CDC strategy to start replicating from a specific position in the source. # Optional. Start replicating from a specific position in the source.
3324 &quot;mongodbChangeStreamPosition&quot;: { # MongoDB change stream position # MongoDB change stream position to start replicating from.
3325 &quot;startTime&quot;: &quot;A String&quot;, # Required. The timestamp to start change stream from.
3326 },
3327 &quot;mysqlGtidPosition&quot;: { # MySQL GTID position # MySQL GTID set to start replicating from.
3328 &quot;gtidSet&quot;: &quot;A String&quot;, # Required. The gtid set to start replication from.
3329 },
3330 &quot;mysqlLogPosition&quot;: { # MySQL log position # MySQL specific log position to start replicating from.
3331 &quot;logFile&quot;: &quot;A String&quot;, # Required. The binary log file name.
3332 &quot;logPosition&quot;: 42, # Optional. The position within the binary log file. Default is head of file.
3333 },
3334 &quot;oracleScnPosition&quot;: { # Oracle SCN position # Oracle SCN to start replicating from.
3335 &quot;scn&quot;: &quot;A String&quot;, # Required. SCN number from where Logs will be read
3336 },
3337 &quot;spannerChangeStreamPosition&quot;: { # Represents a position in a Spanner change stream from which to start replicating. # Optional. Spanner change stream position to start replicating from.
3338 &quot;startTime&quot;: &quot;A String&quot;, # Required. The timestamp to start change stream queries from. The timestamp must be a positive value.
3339 },
3340 &quot;sqlServerLsnPosition&quot;: { # SQL Server LSN position # SqlServer LSN to start replicating from.
3341 &quot;lsn&quot;: &quot;A String&quot;, # Required. Log sequence number (LSN) from where Logs will be read
3342 },
3343 },
3344 },
3345 &quot;force&quot;: True or False, # Optional. Update the stream without validating it.
3346 }
3347
3348 x__xgafv: string, V1 error format.
3349 Allowed values
3350 1 - v1 error format
3351 2 - v2 error format
3352
3353 Returns:
3354 An object of the form:
3355
3356 { # This resource represents a long-running operation that is the result of a network API call.
3357 &quot;done&quot;: 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.
3358 &quot;error&quot;: { # 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.
3359 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
3360 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
3361 {
3362 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
3363 },
3364 ],
3365 &quot;message&quot;: &quot;A String&quot;, # 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.
3366 },
3367 &quot;metadata&quot;: { # 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.
3368 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
3369 },
3370 &quot;name&quot;: &quot;A String&quot;, # 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}`.
3371 &quot;response&quot;: { # 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`.
3372 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
3373 },
3374 }</pre>
3375 </div>
3376
3377 </body></html>