1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="dataform_v1beta1.html">Dataform API</a> . <a href="dataform_v1beta1.projects.html">projects</a> . <a href="dataform_v1beta1.projects.locations.html">locations</a> . <a href="dataform_v1beta1.projects.locations.repositories.html">repositories</a> . <a href="dataform_v1beta1.projects.locations.repositories.compilationResults.html">compilationResults</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new CompilationResult in a given project and location.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Fetches a single CompilationResult.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists CompilationResults in a given Repository.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#query">query(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns CompilationResultActions in a given CompilationResult.</p>
<p class="toc_element">
<code><a href="#query_next">query_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Creates a new CompilationResult in a given project and location.
Args:
parent: string, Required. The repository in which to create the compilation result. Must be in the format `projects/*/locations/*/repositories/*`. (required)
body: object, The request body.
The object takes the form of:
{ # Represents the result of compiling a Dataform project.
"codeCompilationConfig": { # Configures various aspects of Dataform code compilation. # Immutable. If set, fields of `code_compilation_config` override the default compilation settings that are specified in dataform.json.
"assertionSchema": "A String", # Optional. The default schema (BigQuery dataset ID) for assertions.
"builtinAssertionNamePrefix": "A String", # Optional. The prefix to prepend to built-in assertion names.
"databaseSuffix": "A String", # Optional. The suffix that should be appended to all database (Google Cloud project ID) names.
"defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID).
"defaultLocation": "A String", # Optional. The default BigQuery location to use. Defaults to "US". See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations.
"defaultNotebookRuntimeOptions": { # Configures various aspects of Dataform notebook runtime. # Optional. The default notebook runtime options.
"aiPlatformNotebookRuntimeTemplate": "A String", # Optional. The resource name of the [Colab runtime template] (https://cloud.google.com/colab/docs/runtimes), from which a runtime is created for notebook executions. If not specified, a runtime is created with Colab's default specifications.
"gcsOutputBucket": "A String", # Optional. The Google Cloud Storage location to upload the result to. Format: `gs://bucket-name`.
},
"defaultSchema": "A String", # Optional. The default schema (BigQuery dataset ID).
"schemaSuffix": "A String", # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
"tablePrefix": "A String", # Optional. The prefix that should be prepended to all table names.
"vars": { # Optional. User-defined variables that are made available to project code during compilation.
"a_key": "A String",
},
},
"compilationErrors": [ # Output only. Errors encountered during project compilation.
{ # An error encountered when attempting to compile a Dataform project.
"actionTarget": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # Output only. The identifier of the action where this error occurred, if available.
"database": "A String", # Optional. The action's database (Google Cloud project ID) .
"name": "A String", # Optional. The action's name, within `database` and `schema`.
"schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`.
},
"message": "A String", # Output only. The error's top level message.
"path": "A String", # Output only. The path of the file where this error occurred, if available, relative to the project root.
"stack": "A String", # Output only. The error's full stack trace.
},
],
"createTime": "A String", # Output only. The timestamp of when the compilation result was created.
"dataEncryptionState": { # Describes encryption state of a resource. # Output only. Only set if the repository has a KMS Key.
"kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted.
},
"dataformCoreVersion": "A String", # Output only. The version of `@dataform/core` that was used for compilation.
"gitCommitish": "A String", # Immutable. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1`
"internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
"name": "A String", # Output only. The compilation result's name.
"releaseConfig": "A String", # Immutable. The name of the release config to compile. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
"resolvedGitCommitSha": "A String", # Output only. The fully resolved Git commit SHA of the code that was compiled. Not set for compilation results whose source is a workspace.
"workspace": "A String", # Immutable. The name of the workspace to compile. Must be in the format `projects/*/locations/*/repositories/*/workspaces/*`.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents the result of compiling a Dataform project.
"codeCompilationConfig": { # Configures various aspects of Dataform code compilation. # Immutable. If set, fields of `code_compilation_config` override the default compilation settings that are specified in dataform.json.
"assertionSchema": "A String", # Optional. The default schema (BigQuery dataset ID) for assertions.
"builtinAssertionNamePrefix": "A String", # Optional. The prefix to prepend to built-in assertion names.
"databaseSuffix": "A String", # Optional. The suffix that should be appended to all database (Google Cloud project ID) names.
"defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID).
"defaultLocation": "A String", # Optional. The default BigQuery location to use. Defaults to "US". See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations.
"defaultNotebookRuntimeOptions": { # Configures various aspects of Dataform notebook runtime. # Optional. The default notebook runtime options.
"aiPlatformNotebookRuntimeTemplate": "A String", # Optional. The resource name of the [Colab runtime template] (https://cloud.google.com/colab/docs/runtimes), from which a runtime is created for notebook executions. If not specified, a runtime is created with Colab's default specifications.
"gcsOutputBucket": "A String", # Optional. The Google Cloud Storage location to upload the result to. Format: `gs://bucket-name`.
},
"defaultSchema": "A String", # Optional. The default schema (BigQuery dataset ID).
"schemaSuffix": "A String", # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
"tablePrefix": "A String", # Optional. The prefix that should be prepended to all table names.
"vars": { # Optional. User-defined variables that are made available to project code during compilation.
"a_key": "A String",
},
},
"compilationErrors": [ # Output only. Errors encountered during project compilation.
{ # An error encountered when attempting to compile a Dataform project.
"actionTarget": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # Output only. The identifier of the action where this error occurred, if available.
"database": "A String", # Optional. The action's database (Google Cloud project ID) .
"name": "A String", # Optional. The action's name, within `database` and `schema`.
"schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`.
},
"message": "A String", # Output only. The error's top level message.
"path": "A String", # Output only. The path of the file where this error occurred, if available, relative to the project root.
"stack": "A String", # Output only. The error's full stack trace.
},
],
"createTime": "A String", # Output only. The timestamp of when the compilation result was created.
"dataEncryptionState": { # Describes encryption state of a resource. # Output only. Only set if the repository has a KMS Key.
"kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted.
},
"dataformCoreVersion": "A String", # Output only. The version of `@dataform/core` that was used for compilation.
"gitCommitish": "A String", # Immutable. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1`
"internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
"name": "A String", # Output only. The compilation result's name.
"releaseConfig": "A String", # Immutable. The name of the release config to compile. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
"resolvedGitCommitSha": "A String", # Output only. The fully resolved Git commit SHA of the code that was compiled. Not set for compilation results whose source is a workspace.
"workspace": "A String", # Immutable. The name of the workspace to compile. Must be in the format `projects/*/locations/*/repositories/*/workspaces/*`.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Fetches a single CompilationResult.
Args:
name: string, Required. The compilation result's name. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents the result of compiling a Dataform project.
"codeCompilationConfig": { # Configures various aspects of Dataform code compilation. # Immutable. If set, fields of `code_compilation_config` override the default compilation settings that are specified in dataform.json.
"assertionSchema": "A String", # Optional. The default schema (BigQuery dataset ID) for assertions.
"builtinAssertionNamePrefix": "A String", # Optional. The prefix to prepend to built-in assertion names.
"databaseSuffix": "A String", # Optional. The suffix that should be appended to all database (Google Cloud project ID) names.
"defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID).
"defaultLocation": "A String", # Optional. The default BigQuery location to use. Defaults to "US". See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations.
"defaultNotebookRuntimeOptions": { # Configures various aspects of Dataform notebook runtime. # Optional. The default notebook runtime options.
"aiPlatformNotebookRuntimeTemplate": "A String", # Optional. The resource name of the [Colab runtime template] (https://cloud.google.com/colab/docs/runtimes), from which a runtime is created for notebook executions. If not specified, a runtime is created with Colab's default specifications.
"gcsOutputBucket": "A String", # Optional. The Google Cloud Storage location to upload the result to. Format: `gs://bucket-name`.
},
"defaultSchema": "A String", # Optional. The default schema (BigQuery dataset ID).
"schemaSuffix": "A String", # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
"tablePrefix": "A String", # Optional. The prefix that should be prepended to all table names.
"vars": { # Optional. User-defined variables that are made available to project code during compilation.
"a_key": "A String",
},
},
"compilationErrors": [ # Output only. Errors encountered during project compilation.
{ # An error encountered when attempting to compile a Dataform project.
"actionTarget": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # Output only. The identifier of the action where this error occurred, if available.
"database": "A String", # Optional. The action's database (Google Cloud project ID) .
"name": "A String", # Optional. The action's name, within `database` and `schema`.
"schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`.
},
"message": "A String", # Output only. The error's top level message.
"path": "A String", # Output only. The path of the file where this error occurred, if available, relative to the project root.
"stack": "A String", # Output only. The error's full stack trace.
},
],
"createTime": "A String", # Output only. The timestamp of when the compilation result was created.
"dataEncryptionState": { # Describes encryption state of a resource. # Output only. Only set if the repository has a KMS Key.
"kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted.
},
"dataformCoreVersion": "A String", # Output only. The version of `@dataform/core` that was used for compilation.
"gitCommitish": "A String", # Immutable. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1`
"internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
"name": "A String", # Output only. The compilation result's name.
"releaseConfig": "A String", # Immutable. The name of the release config to compile. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
"resolvedGitCommitSha": "A String", # Output only. The fully resolved Git commit SHA of the code that was compiled. Not set for compilation results whose source is a workspace.
"workspace": "A String", # Immutable. The name of the workspace to compile. Must be in the format `projects/*/locations/*/repositories/*/workspaces/*`.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists CompilationResults in a given Repository.
Args:
parent: string, Required. The repository in which to list compilation results. Must be in the format `projects/*/locations/*/repositories/*`. (required)
filter: string, Optional. Filter for the returned list.
orderBy: string, Optional. This field only supports ordering by `name` and `create_time`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field.
pageSize: integer, Optional. Maximum number of compilation results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
pageToken: string, Optional. Page token received from a previous `ListCompilationResults` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCompilationResults`, with the exception of `page_size`, must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # `ListCompilationResults` response message.
"compilationResults": [ # List of compilation results.
{ # Represents the result of compiling a Dataform project.
"codeCompilationConfig": { # Configures various aspects of Dataform code compilation. # Immutable. If set, fields of `code_compilation_config` override the default compilation settings that are specified in dataform.json.
"assertionSchema": "A String", # Optional. The default schema (BigQuery dataset ID) for assertions.
"builtinAssertionNamePrefix": "A String", # Optional. The prefix to prepend to built-in assertion names.
"databaseSuffix": "A String", # Optional. The suffix that should be appended to all database (Google Cloud project ID) names.
"defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID).
"defaultLocation": "A String", # Optional. The default BigQuery location to use. Defaults to "US". See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations.
"defaultNotebookRuntimeOptions": { # Configures various aspects of Dataform notebook runtime. # Optional. The default notebook runtime options.
"aiPlatformNotebookRuntimeTemplate": "A String", # Optional. The resource name of the [Colab runtime template] (https://cloud.google.com/colab/docs/runtimes), from which a runtime is created for notebook executions. If not specified, a runtime is created with Colab's default specifications.
"gcsOutputBucket": "A String", # Optional. The Google Cloud Storage location to upload the result to. Format: `gs://bucket-name`.
},
"defaultSchema": "A String", # Optional. The default schema (BigQuery dataset ID).
"schemaSuffix": "A String", # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
"tablePrefix": "A String", # Optional. The prefix that should be prepended to all table names.
"vars": { # Optional. User-defined variables that are made available to project code during compilation.
"a_key": "A String",
},
},
"compilationErrors": [ # Output only. Errors encountered during project compilation.
{ # An error encountered when attempting to compile a Dataform project.
"actionTarget": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # Output only. The identifier of the action where this error occurred, if available.
"database": "A String", # Optional. The action's database (Google Cloud project ID) .
"name": "A String", # Optional. The action's name, within `database` and `schema`.
"schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`.
},
"message": "A String", # Output only. The error's top level message.
"path": "A String", # Output only. The path of the file where this error occurred, if available, relative to the project root.
"stack": "A String", # Output only. The error's full stack trace.
},
],
"createTime": "A String", # Output only. The timestamp of when the compilation result was created.
"dataEncryptionState": { # Describes encryption state of a resource. # Output only. Only set if the repository has a KMS Key.
"kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted.
},
"dataformCoreVersion": "A String", # Output only. The version of `@dataform/core` that was used for compilation.
"gitCommitish": "A String", # Immutable. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1`
"internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
"name": "A String", # Output only. The compilation result's name.
"releaseConfig": "A String", # Immutable. The name of the release config to compile. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
"resolvedGitCommitSha": "A String", # Output only. The fully resolved Git commit SHA of the code that was compiled. Not set for compilation results whose source is a workspace.
"workspace": "A String", # Immutable. The name of the workspace to compile. Must be in the format `projects/*/locations/*/repositories/*/workspaces/*`.
},
],
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"unreachable": [ # Locations which could not be reached.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="query">query(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Returns CompilationResultActions in a given CompilationResult.
Args:
name: string, Required. The compilation result's name. (required)
filter: string, Optional. Optional filter for the returned list. Filtering is only currently supported on the `file_path` field.
pageSize: integer, Optional. Maximum number of compilation results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
pageToken: string, Optional. Page token received from a previous `QueryCompilationResultActions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryCompilationResultActions`, with the exception of `page_size`, must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # `QueryCompilationResultActions` response message.
"compilationResultActions": [ # List of compilation result actions.
{ # Represents a single Dataform action in a compilation result.
"assertion": { # Represents an assertion upon a SQL query which is required return zero rows. # The assertion executed by this action.
"dependencyTargets": [ # A list of actions that this action depends on.
{ # Represents an action identifier. If the action writes output, the output will be written to the referenced database object.
"database": "A String", # Optional. The action's database (Google Cloud project ID) .
"name": "A String", # Optional. The action's name, within `database` and `schema`.
"schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`.
},
],
"disabled": True or False, # Whether this action is disabled (i.e. should not be run).
"parentAction": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # The parent action of this assertion. Only set if this assertion was automatically generated.
"database": "A String", # Optional. The action's database (Google Cloud project ID) .
"name": "A String", # Optional. The action's name, within `database` and `schema`.
"schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`.
},
"relationDescriptor": { # Describes a relation and its columns. # Descriptor for the assertion's automatically-generated view and its columns.
"bigqueryLabels": { # A set of BigQuery labels that should be applied to the relation.
"a_key": "A String",
},
"columns": [ # A list of descriptions of columns within the relation.
{ # Describes a column.
"bigqueryPolicyTags": [ # A list of BigQuery policy tags that will be applied to the column.
"A String",
],
"description": "A String", # A textual description of the column.
"path": [ # The identifier for the column. Each entry in `path` represents one level of nesting.
"A String",
],
},
],
"description": "A String", # A text description of the relation.
},
"selectQuery": "A String", # The SELECT query which must return zero rows in order for this assertion to succeed.
"tags": [ # Arbitrary, user-defined tags on this action.
"A String",
],
},
"canonicalTarget": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result.
"database": "A String", # Optional. The action's database (Google Cloud project ID) .
"name": "A String", # Optional. The action's name, within `database` and `schema`.
"schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`.
},
"dataPreparation": { # Defines a compiled Data Preparation entity # The data preparation executed by this action.
"contentsSql": { # Definition of a SQL Data Preparation # SQL definition for a Data Preparation. Contains a SQL query and additional context information.
"errorTable": { # Error table information, used to write error data into a BigQuery table. # Error table configuration,
"retentionDays": 42, # Error table partition expiration in days. Only positive values are allowed.
"target": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # Error Table target.
"database": "A String", # Optional. The action's database (Google Cloud project ID) .
"name": "A String", # Optional. The action's name, within `database` and `schema`.
"schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`.
},
},
"load": { # Simplified load configuration for actions # Load configuration.
"append": { # Simple load definition # Append into destination table
},
"maximum": { # Load definition for incremental load modes # Insert records where the value exceeds the previous maximum value for a column in the destination table
"column": "A String", # Column name for incremental load modes
},
"replace": { # Simple load definition # Replace destination table
},
"unique": { # Load definition for incremental load modes # Insert records where the value of a column is not already present in the destination table
"column": "A String", # Column name for incremental load modes
},
},
"query": "A String", # The SQL query representing the data preparation steps. Formatted as a Pipe SQL query statement.
},
"contentsYaml": "A String", # The data preparation definition, stored as a YAML string.
"dependencyTargets": [ # A list of actions that this action depends on.
{ # Represents an action identifier. If the action writes output, the output will be written to the referenced database object.
"database": "A String", # Optional. The action's database (Google Cloud project ID) .
"name": "A String", # Optional. The action's name, within `database` and `schema`.
"schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`.
},
],
"disabled": True or False, # Whether this action is disabled (i.e. should not be run).
"tags": [ # Arbitrary, user-defined tags on this action.
"A String",
],
},
"declaration": { # Represents a relation which is not managed by Dataform but which may be referenced by Dataform actions. # The declaration declared by this action.
"relationDescriptor": { # Describes a relation and its columns. # Descriptor for the relation and its columns. Used as documentation only, i.e. values here will result in no changes to the relation's metadata.
"bigqueryLabels": { # A set of BigQuery labels that should be applied to the relation.
"a_key": "A String",
},
"columns": [ # A list of descriptions of columns within the relation.
{ # Describes a column.
"bigqueryPolicyTags": [ # A list of BigQuery policy tags that will be applied to the column.
"A String",
],
"description": "A String", # A textual description of the column.
"path": [ # The identifier for the column. Each entry in `path` represents one level of nesting.
"A String",
],
},
],
"description": "A String", # A text description of the relation.
},
},
"filePath": "A String", # The full path including filename in which this action is located, relative to the workspace root.
"internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
"notebook": { # Represents a notebook. # The notebook executed by this action.
"contents": "A String", # The contents of the notebook.
"dependencyTargets": [ # A list of actions that this action depends on.
{ # Represents an action identifier. If the action writes output, the output will be written to the referenced database object.
"database": "A String", # Optional. The action's database (Google Cloud project ID) .
"name": "A String", # Optional. The action's name, within `database` and `schema`.
"schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`.
},
],
"disabled": True or False, # Whether this action is disabled (i.e. should not be run).
"tags": [ # Arbitrary, user-defined tags on this action.
"A String",
],
},
"operations": { # Represents a list of arbitrary database operations. # The database operations executed by this action.
"dependencyTargets": [ # A list of actions that this action depends on.
{ # Represents an action identifier. If the action writes output, the output will be written to the referenced database object.
"database": "A String", # Optional. The action's database (Google Cloud project ID) .
"name": "A String", # Optional. The action's name, within `database` and `schema`.
"schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`.
},
],
"disabled": True or False, # Whether this action is disabled (i.e. should not be run).
"hasOutput": True or False, # Whether these operations produce an output relation.
"queries": [ # A list of arbitrary SQL statements that will be executed without alteration.
"A String",
],
"relationDescriptor": { # Describes a relation and its columns. # Descriptor for any output relation and its columns. Only set if `has_output` is true.
"bigqueryLabels": { # A set of BigQuery labels that should be applied to the relation.
"a_key": "A String",
},
"columns": [ # A list of descriptions of columns within the relation.
{ # Describes a column.
"bigqueryPolicyTags": [ # A list of BigQuery policy tags that will be applied to the column.
"A String",
],
"description": "A String", # A textual description of the column.
"path": [ # The identifier for the column. Each entry in `path` represents one level of nesting.
"A String",
],
},
],
"description": "A String", # A text description of the relation.
},
"tags": [ # Arbitrary, user-defined tags on this action.
"A String",
],
},
"relation": { # Represents a database relation. # The database relation created/updated by this action.
"additionalOptions": { # Additional options that will be provided as key/value pairs into the options clause of a create table/view statement. See https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language for more information on which options are supported.
"a_key": "A String",
},
"clusterExpressions": [ # A list of columns or SQL expressions used to cluster the table.
"A String",
],
"dependencyTargets": [ # A list of actions that this action depends on.
{ # Represents an action identifier. If the action writes output, the output will be written to the referenced database object.
"database": "A String", # Optional. The action's database (Google Cloud project ID) .
"name": "A String", # Optional. The action's name, within `database` and `schema`.
"schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`.
},
],
"disabled": True or False, # Whether this action is disabled (i.e. should not be run).
"incrementalTableConfig": { # Contains settings for relations of type `INCREMENTAL_TABLE`. # Configures `INCREMENTAL_TABLE` settings for this relation. Only set if `relation_type` is `INCREMENTAL_TABLE`.
"incrementalPostOperations": [ # SQL statements to be executed after inserting new rows into the relation.
"A String",
],
"incrementalPreOperations": [ # SQL statements to be executed before inserting new rows into the relation.
"A String",
],
"incrementalSelectQuery": "A String", # The SELECT query which returns rows which should be inserted into the relation if it already exists and is not being refreshed.
"refreshDisabled": True or False, # Whether this table should be protected from being refreshed.
"uniqueKeyParts": [ # A set of columns or SQL expressions used to define row uniqueness. If any duplicates are discovered (as defined by `unique_key_parts`), only the newly selected rows (as defined by `incremental_select_query`) will be included in the relation.
"A String",
],
"updatePartitionFilter": "A String", # A SQL expression conditional used to limit the set of existing rows considered for a merge operation (see `unique_key_parts` for more information).
},
"partitionExpirationDays": 42, # Sets the partition expiration in days.
"partitionExpression": "A String", # The SQL expression used to partition the relation.
"postOperations": [ # SQL statements to be executed after creating the relation.
"A String",
],
"preOperations": [ # SQL statements to be executed before creating the relation.
"A String",
],
"relationDescriptor": { # Describes a relation and its columns. # Descriptor for the relation and its columns.
"bigqueryLabels": { # A set of BigQuery labels that should be applied to the relation.
"a_key": "A String",
},
"columns": [ # A list of descriptions of columns within the relation.
{ # Describes a column.
"bigqueryPolicyTags": [ # A list of BigQuery policy tags that will be applied to the column.
"A String",
],
"description": "A String", # A textual description of the column.
"path": [ # The identifier for the column. Each entry in `path` represents one level of nesting.
"A String",
],
},
],
"description": "A String", # A text description of the relation.
},
"relationType": "A String", # The type of this relation.
"requirePartitionFilter": True or False, # Specifies whether queries on this table must include a predicate filter that filters on the partitioning column.
"selectQuery": "A String", # The SELECT query which returns rows which this relation should contain.
"tags": [ # Arbitrary, user-defined tags on this action.
"A String",
],
},
"target": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # This action's identifier. Unique within the compilation result.
"database": "A String", # Optional. The action's database (Google Cloud project ID) .
"name": "A String", # Optional. The action's name, within `database` and `schema`.
"schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`.
},
},
],
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}</pre>
</div>
<div class="method">
<code class="details" id="query_next">query_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
