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
|
<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.workflowConfigs.html">workflowConfigs</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, workflowConfigId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new WorkflowConfig in a given Repository.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a single WorkflowConfig.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Fetches a single WorkflowConfig.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists WorkflowConfigs 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="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a single WorkflowConfig. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*</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, workflowConfigId=None, x__xgafv=None)</code>
<pre>Creates a new WorkflowConfig in a given Repository.
Args:
parent: string, Required. The repository in which to create the workflow config. Must be in the format `projects/*/locations/*/repositories/*`. (required)
body: object, The request body.
The object takes the form of:
{ # Represents a Dataform workflow configuration.
"createTime": "A String", # Output only. The timestamp of when the WorkflowConfig was created.
"cronSchedule": "A String", # Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
"disabled": True or False, # Optional. Disables automatic creation of workflow invocations.
"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.
"invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Optional. If left unset, a default InvocationConfig will be used.
"fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed.
"includedTags": [ # Optional. The set of tags to include.
"A String",
],
"includedTargets": [ # Optional. The set of action identifiers to include.
{ # 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`.
},
],
"serviceAccount": "A String", # Optional. The service account to run workflow invocations under.
"transitiveDependenciesIncluded": True or False, # Optional. When set to true, transitive dependencies of included actions will be executed.
"transitiveDependentsIncluded": True or False, # Optional. When set to true, transitive dependents of included actions will be executed.
},
"name": "A String", # Identifier. The workflow config's name.
"recentScheduledExecutionRecords": [ # Output only. Records of the 10 most recent scheduled execution attempts, ordered in descending order of `execution_time`. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.
{ # A record of an attempt to create a workflow invocation for this workflow config.
"errorStatus": { # 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 status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"executionTime": "A String", # Output only. The timestamp of this execution attempt.
"workflowInvocation": "A String", # The name of the created workflow invocation, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/workflowInvocations/*`.
},
],
"releaseConfig": "A String", # Required. The name of the release config whose release_compilation_result should be executed. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
"timeZone": "A String", # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
"updateTime": "A String", # Output only. The timestamp of when the WorkflowConfig was last updated.
}
workflowConfigId: string, Required. The ID to use for the workflow config, which will become the final component of the workflow config's resource name.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a Dataform workflow configuration.
"createTime": "A String", # Output only. The timestamp of when the WorkflowConfig was created.
"cronSchedule": "A String", # Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
"disabled": True or False, # Optional. Disables automatic creation of workflow invocations.
"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.
"invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Optional. If left unset, a default InvocationConfig will be used.
"fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed.
"includedTags": [ # Optional. The set of tags to include.
"A String",
],
"includedTargets": [ # Optional. The set of action identifiers to include.
{ # 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`.
},
],
"serviceAccount": "A String", # Optional. The service account to run workflow invocations under.
"transitiveDependenciesIncluded": True or False, # Optional. When set to true, transitive dependencies of included actions will be executed.
"transitiveDependentsIncluded": True or False, # Optional. When set to true, transitive dependents of included actions will be executed.
},
"name": "A String", # Identifier. The workflow config's name.
"recentScheduledExecutionRecords": [ # Output only. Records of the 10 most recent scheduled execution attempts, ordered in descending order of `execution_time`. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.
{ # A record of an attempt to create a workflow invocation for this workflow config.
"errorStatus": { # 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 status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"executionTime": "A String", # Output only. The timestamp of this execution attempt.
"workflowInvocation": "A String", # The name of the created workflow invocation, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/workflowInvocations/*`.
},
],
"releaseConfig": "A String", # Required. The name of the release config whose release_compilation_result should be executed. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
"timeZone": "A String", # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
"updateTime": "A String", # Output only. The timestamp of when the WorkflowConfig was last updated.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes a single WorkflowConfig.
Args:
name: string, Required. The workflow config'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:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Fetches a single WorkflowConfig.
Args:
name: string, Required. The workflow config'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 a Dataform workflow configuration.
"createTime": "A String", # Output only. The timestamp of when the WorkflowConfig was created.
"cronSchedule": "A String", # Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
"disabled": True or False, # Optional. Disables automatic creation of workflow invocations.
"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.
"invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Optional. If left unset, a default InvocationConfig will be used.
"fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed.
"includedTags": [ # Optional. The set of tags to include.
"A String",
],
"includedTargets": [ # Optional. The set of action identifiers to include.
{ # 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`.
},
],
"serviceAccount": "A String", # Optional. The service account to run workflow invocations under.
"transitiveDependenciesIncluded": True or False, # Optional. When set to true, transitive dependencies of included actions will be executed.
"transitiveDependentsIncluded": True or False, # Optional. When set to true, transitive dependents of included actions will be executed.
},
"name": "A String", # Identifier. The workflow config's name.
"recentScheduledExecutionRecords": [ # Output only. Records of the 10 most recent scheduled execution attempts, ordered in descending order of `execution_time`. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.
{ # A record of an attempt to create a workflow invocation for this workflow config.
"errorStatus": { # 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 status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"executionTime": "A String", # Output only. The timestamp of this execution attempt.
"workflowInvocation": "A String", # The name of the created workflow invocation, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/workflowInvocations/*`.
},
],
"releaseConfig": "A String", # Required. The name of the release config whose release_compilation_result should be executed. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
"timeZone": "A String", # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
"updateTime": "A String", # Output only. The timestamp of when the WorkflowConfig was last updated.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists WorkflowConfigs in a given Repository.
Args:
parent: string, Required. The repository in which to list workflow configs. Must be in the format `projects/*/locations/*/repositories/*`. (required)
pageSize: integer, Optional. Maximum number of workflow configs 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 `ListWorkflowConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkflowConfigs`, 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:
{ # `ListWorkflowConfigs` response message.
"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",
],
"workflowConfigs": [ # List of workflow configs.
{ # Represents a Dataform workflow configuration.
"createTime": "A String", # Output only. The timestamp of when the WorkflowConfig was created.
"cronSchedule": "A String", # Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
"disabled": True or False, # Optional. Disables automatic creation of workflow invocations.
"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.
"invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Optional. If left unset, a default InvocationConfig will be used.
"fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed.
"includedTags": [ # Optional. The set of tags to include.
"A String",
],
"includedTargets": [ # Optional. The set of action identifiers to include.
{ # 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`.
},
],
"serviceAccount": "A String", # Optional. The service account to run workflow invocations under.
"transitiveDependenciesIncluded": True or False, # Optional. When set to true, transitive dependencies of included actions will be executed.
"transitiveDependentsIncluded": True or False, # Optional. When set to true, transitive dependents of included actions will be executed.
},
"name": "A String", # Identifier. The workflow config's name.
"recentScheduledExecutionRecords": [ # Output only. Records of the 10 most recent scheduled execution attempts, ordered in descending order of `execution_time`. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.
{ # A record of an attempt to create a workflow invocation for this workflow config.
"errorStatus": { # 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 status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"executionTime": "A String", # Output only. The timestamp of this execution attempt.
"workflowInvocation": "A String", # The name of the created workflow invocation, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/workflowInvocations/*`.
},
],
"releaseConfig": "A String", # Required. The name of the release config whose release_compilation_result should be executed. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
"timeZone": "A String", # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
"updateTime": "A String", # Output only. The timestamp of when the WorkflowConfig was last updated.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates a single WorkflowConfig. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*
Args:
name: string, Identifier. The workflow config's name. (required)
body: object, The request body.
The object takes the form of:
{ # Represents a Dataform workflow configuration.
"createTime": "A String", # Output only. The timestamp of when the WorkflowConfig was created.
"cronSchedule": "A String", # Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
"disabled": True or False, # Optional. Disables automatic creation of workflow invocations.
"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.
"invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Optional. If left unset, a default InvocationConfig will be used.
"fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed.
"includedTags": [ # Optional. The set of tags to include.
"A String",
],
"includedTargets": [ # Optional. The set of action identifiers to include.
{ # 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`.
},
],
"serviceAccount": "A String", # Optional. The service account to run workflow invocations under.
"transitiveDependenciesIncluded": True or False, # Optional. When set to true, transitive dependencies of included actions will be executed.
"transitiveDependentsIncluded": True or False, # Optional. When set to true, transitive dependents of included actions will be executed.
},
"name": "A String", # Identifier. The workflow config's name.
"recentScheduledExecutionRecords": [ # Output only. Records of the 10 most recent scheduled execution attempts, ordered in descending order of `execution_time`. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.
{ # A record of an attempt to create a workflow invocation for this workflow config.
"errorStatus": { # 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 status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"executionTime": "A String", # Output only. The timestamp of this execution attempt.
"workflowInvocation": "A String", # The name of the created workflow invocation, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/workflowInvocations/*`.
},
],
"releaseConfig": "A String", # Required. The name of the release config whose release_compilation_result should be executed. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
"timeZone": "A String", # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
"updateTime": "A String", # Output only. The timestamp of when the WorkflowConfig was last updated.
}
updateMask: string, Optional. Specifies the fields to be updated in the workflow config. If left unset, all fields will be updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a Dataform workflow configuration.
"createTime": "A String", # Output only. The timestamp of when the WorkflowConfig was created.
"cronSchedule": "A String", # Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
"disabled": True or False, # Optional. Disables automatic creation of workflow invocations.
"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.
"invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Optional. If left unset, a default InvocationConfig will be used.
"fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed.
"includedTags": [ # Optional. The set of tags to include.
"A String",
],
"includedTargets": [ # Optional. The set of action identifiers to include.
{ # 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`.
},
],
"serviceAccount": "A String", # Optional. The service account to run workflow invocations under.
"transitiveDependenciesIncluded": True or False, # Optional. When set to true, transitive dependencies of included actions will be executed.
"transitiveDependentsIncluded": True or False, # Optional. When set to true, transitive dependents of included actions will be executed.
},
"name": "A String", # Identifier. The workflow config's name.
"recentScheduledExecutionRecords": [ # Output only. Records of the 10 most recent scheduled execution attempts, ordered in descending order of `execution_time`. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.
{ # A record of an attempt to create a workflow invocation for this workflow config.
"errorStatus": { # 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 status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"executionTime": "A String", # Output only. The timestamp of this execution attempt.
"workflowInvocation": "A String", # The name of the created workflow invocation, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/workflowInvocations/*`.
},
],
"releaseConfig": "A String", # Required. The name of the release config whose release_compilation_result should be executed. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
"timeZone": "A String", # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
"updateTime": "A String", # Output only. The timestamp of when the WorkflowConfig was last updated.
}</pre>
</div>
</body></html>
|
