File: dataform_v1beta1.projects.locations.repositories.workflowInvocations.html

package info (click to toggle)
python-googleapi 2.180.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 527,124 kB
  • sloc: python: 11,076; javascript: 249; sh: 114; makefile: 59
file content (446 lines) | stat: -rw-r--r-- 30,846 bytes parent folder | download
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
<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.workflowInvocations.html">workflowInvocations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#cancel">cancel(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Requests cancellation of a running WorkflowInvocation.</p>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new WorkflowInvocation 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 WorkflowInvocation.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Fetches a single WorkflowInvocation.</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 WorkflowInvocations 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, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns WorkflowInvocationActions in a given WorkflowInvocation.</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="cancel">cancel(name, body=None, x__xgafv=None)</code>
  <pre>Requests cancellation of a running WorkflowInvocation.

Args:
  name: string, Required. The workflow invocation resource&#x27;s name. (required)
  body: object, The request body.
    The object takes the form of:

{ # `CancelWorkflowInvocation` request message.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # `CancelWorkflowInvocation` response message.
}</pre>
</div>

<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
  <pre>Creates a new WorkflowInvocation in a given Repository.

Args:
  parent: string, Required. The repository in which to create the workflow invocation. Must be in the format `projects/*/locations/*/repositories/*`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents a single invocation of a compilation result.
  &quot;compilationResult&quot;: &quot;A String&quot;, # Immutable. The name of the compilation result to use for this invocation. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
  &quot;dataEncryptionState&quot;: { # Describes encryption state of a resource. # Output only. Only set if the repository has a KMS Key.
    &quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # Required. The KMS key version name with which data of a resource is encrypted.
  },
  &quot;internalMetadata&quot;: &quot;A String&quot;, # 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.
  &quot;invocationConfig&quot;: { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Immutable. If left unset, a default InvocationConfig will be used.
    &quot;fullyRefreshIncrementalTablesEnabled&quot;: True or False, # Optional. When set to true, any incremental tables will be fully refreshed.
    &quot;includedTags&quot;: [ # Optional. The set of tags to include.
      &quot;A String&quot;,
    ],
    &quot;includedTargets&quot;: [ # 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.
        &quot;database&quot;: &quot;A String&quot;, # Optional. The action&#x27;s database (Google Cloud project ID) .
        &quot;name&quot;: &quot;A String&quot;, # Optional. The action&#x27;s name, within `database` and `schema`.
        &quot;schema&quot;: &quot;A String&quot;, # Optional. The action&#x27;s schema (BigQuery dataset ID), within `database`.
      },
    ],
    &quot;serviceAccount&quot;: &quot;A String&quot;, # Optional. The service account to run workflow invocations under.
    &quot;transitiveDependenciesIncluded&quot;: True or False, # Optional. When set to true, transitive dependencies of included actions will be executed.
    &quot;transitiveDependentsIncluded&quot;: True or False, # Optional. When set to true, transitive dependents of included actions will be executed.
  },
  &quot;invocationTiming&quot;: { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Output only. This workflow invocation&#x27;s timing details.
    &quot;endTime&quot;: &quot;A String&quot;, # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
    &quot;startTime&quot;: &quot;A String&quot;, # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
  },
  &quot;name&quot;: &quot;A String&quot;, # Output only. The workflow invocation&#x27;s name.
  &quot;resolvedCompilationResult&quot;: &quot;A String&quot;, # Output only. The resolved compilation result that was used to create this invocation. Will be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
  &quot;state&quot;: &quot;A String&quot;, # Output only. This workflow invocation&#x27;s current state.
  &quot;workflowConfig&quot;: &quot;A String&quot;, # Immutable. The name of the workflow config to invoke. Must be in the format `projects/*/locations/*/repositories/*/workflowConfigs/*`.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a single invocation of a compilation result.
  &quot;compilationResult&quot;: &quot;A String&quot;, # Immutable. The name of the compilation result to use for this invocation. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
  &quot;dataEncryptionState&quot;: { # Describes encryption state of a resource. # Output only. Only set if the repository has a KMS Key.
    &quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # Required. The KMS key version name with which data of a resource is encrypted.
  },
  &quot;internalMetadata&quot;: &quot;A String&quot;, # 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.
  &quot;invocationConfig&quot;: { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Immutable. If left unset, a default InvocationConfig will be used.
    &quot;fullyRefreshIncrementalTablesEnabled&quot;: True or False, # Optional. When set to true, any incremental tables will be fully refreshed.
    &quot;includedTags&quot;: [ # Optional. The set of tags to include.
      &quot;A String&quot;,
    ],
    &quot;includedTargets&quot;: [ # 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.
        &quot;database&quot;: &quot;A String&quot;, # Optional. The action&#x27;s database (Google Cloud project ID) .
        &quot;name&quot;: &quot;A String&quot;, # Optional. The action&#x27;s name, within `database` and `schema`.
        &quot;schema&quot;: &quot;A String&quot;, # Optional. The action&#x27;s schema (BigQuery dataset ID), within `database`.
      },
    ],
    &quot;serviceAccount&quot;: &quot;A String&quot;, # Optional. The service account to run workflow invocations under.
    &quot;transitiveDependenciesIncluded&quot;: True or False, # Optional. When set to true, transitive dependencies of included actions will be executed.
    &quot;transitiveDependentsIncluded&quot;: True or False, # Optional. When set to true, transitive dependents of included actions will be executed.
  },
  &quot;invocationTiming&quot;: { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Output only. This workflow invocation&#x27;s timing details.
    &quot;endTime&quot;: &quot;A String&quot;, # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
    &quot;startTime&quot;: &quot;A String&quot;, # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
  },
  &quot;name&quot;: &quot;A String&quot;, # Output only. The workflow invocation&#x27;s name.
  &quot;resolvedCompilationResult&quot;: &quot;A String&quot;, # Output only. The resolved compilation result that was used to create this invocation. Will be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
  &quot;state&quot;: &quot;A String&quot;, # Output only. This workflow invocation&#x27;s current state.
  &quot;workflowConfig&quot;: &quot;A String&quot;, # Immutable. The name of the workflow config to invoke. Must be in the format `projects/*/locations/*/repositories/*/workflowConfigs/*`.
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
  <pre>Deletes a single WorkflowInvocation.

Args:
  name: string, Required. The workflow invocation resource&#x27;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 WorkflowInvocation.

Args:
  name: string, Required. The workflow invocation resource&#x27;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 single invocation of a compilation result.
  &quot;compilationResult&quot;: &quot;A String&quot;, # Immutable. The name of the compilation result to use for this invocation. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
  &quot;dataEncryptionState&quot;: { # Describes encryption state of a resource. # Output only. Only set if the repository has a KMS Key.
    &quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # Required. The KMS key version name with which data of a resource is encrypted.
  },
  &quot;internalMetadata&quot;: &quot;A String&quot;, # 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.
  &quot;invocationConfig&quot;: { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Immutable. If left unset, a default InvocationConfig will be used.
    &quot;fullyRefreshIncrementalTablesEnabled&quot;: True or False, # Optional. When set to true, any incremental tables will be fully refreshed.
    &quot;includedTags&quot;: [ # Optional. The set of tags to include.
      &quot;A String&quot;,
    ],
    &quot;includedTargets&quot;: [ # 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.
        &quot;database&quot;: &quot;A String&quot;, # Optional. The action&#x27;s database (Google Cloud project ID) .
        &quot;name&quot;: &quot;A String&quot;, # Optional. The action&#x27;s name, within `database` and `schema`.
        &quot;schema&quot;: &quot;A String&quot;, # Optional. The action&#x27;s schema (BigQuery dataset ID), within `database`.
      },
    ],
    &quot;serviceAccount&quot;: &quot;A String&quot;, # Optional. The service account to run workflow invocations under.
    &quot;transitiveDependenciesIncluded&quot;: True or False, # Optional. When set to true, transitive dependencies of included actions will be executed.
    &quot;transitiveDependentsIncluded&quot;: True or False, # Optional. When set to true, transitive dependents of included actions will be executed.
  },
  &quot;invocationTiming&quot;: { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Output only. This workflow invocation&#x27;s timing details.
    &quot;endTime&quot;: &quot;A String&quot;, # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
    &quot;startTime&quot;: &quot;A String&quot;, # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
  },
  &quot;name&quot;: &quot;A String&quot;, # Output only. The workflow invocation&#x27;s name.
  &quot;resolvedCompilationResult&quot;: &quot;A String&quot;, # Output only. The resolved compilation result that was used to create this invocation. Will be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
  &quot;state&quot;: &quot;A String&quot;, # Output only. This workflow invocation&#x27;s current state.
  &quot;workflowConfig&quot;: &quot;A String&quot;, # Immutable. The name of the workflow config to invoke. Must be in the format `projects/*/locations/*/repositories/*/workflowConfigs/*`.
}</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 WorkflowInvocations in a given Repository.

Args:
  parent: string, Required. The parent resource of the WorkflowInvocation type. 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`. 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 workflow invocations 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 `ListWorkflowInvocations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkflowInvocations`, 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:

    { # `ListWorkflowInvocations` response message.
  &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.
  &quot;unreachable&quot;: [ # Locations which could not be reached.
    &quot;A String&quot;,
  ],
  &quot;workflowInvocations&quot;: [ # List of workflow invocations.
    { # Represents a single invocation of a compilation result.
      &quot;compilationResult&quot;: &quot;A String&quot;, # Immutable. The name of the compilation result to use for this invocation. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
      &quot;dataEncryptionState&quot;: { # Describes encryption state of a resource. # Output only. Only set if the repository has a KMS Key.
        &quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # Required. The KMS key version name with which data of a resource is encrypted.
      },
      &quot;internalMetadata&quot;: &quot;A String&quot;, # 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.
      &quot;invocationConfig&quot;: { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Immutable. If left unset, a default InvocationConfig will be used.
        &quot;fullyRefreshIncrementalTablesEnabled&quot;: True or False, # Optional. When set to true, any incremental tables will be fully refreshed.
        &quot;includedTags&quot;: [ # Optional. The set of tags to include.
          &quot;A String&quot;,
        ],
        &quot;includedTargets&quot;: [ # 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.
            &quot;database&quot;: &quot;A String&quot;, # Optional. The action&#x27;s database (Google Cloud project ID) .
            &quot;name&quot;: &quot;A String&quot;, # Optional. The action&#x27;s name, within `database` and `schema`.
            &quot;schema&quot;: &quot;A String&quot;, # Optional. The action&#x27;s schema (BigQuery dataset ID), within `database`.
          },
        ],
        &quot;serviceAccount&quot;: &quot;A String&quot;, # Optional. The service account to run workflow invocations under.
        &quot;transitiveDependenciesIncluded&quot;: True or False, # Optional. When set to true, transitive dependencies of included actions will be executed.
        &quot;transitiveDependentsIncluded&quot;: True or False, # Optional. When set to true, transitive dependents of included actions will be executed.
      },
      &quot;invocationTiming&quot;: { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Output only. This workflow invocation&#x27;s timing details.
        &quot;endTime&quot;: &quot;A String&quot;, # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
        &quot;startTime&quot;: &quot;A String&quot;, # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
      },
      &quot;name&quot;: &quot;A String&quot;, # Output only. The workflow invocation&#x27;s name.
      &quot;resolvedCompilationResult&quot;: &quot;A String&quot;, # Output only. The resolved compilation result that was used to create this invocation. Will be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
      &quot;state&quot;: &quot;A String&quot;, # Output only. This workflow invocation&#x27;s current state.
      &quot;workflowConfig&quot;: &quot;A String&quot;, # Immutable. The name of the workflow config to invoke. Must be in the format `projects/*/locations/*/repositories/*/workflowConfigs/*`.
    },
  ],
}</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 &#x27;execute()&#x27; 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, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Returns WorkflowInvocationActions in a given WorkflowInvocation.

Args:
  name: string, Required. The workflow invocation&#x27;s name. (required)
  pageSize: integer, Optional. Maximum number of workflow invocations 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 `QueryWorkflowInvocationActions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryWorkflowInvocationActions`, 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:

    { # `QueryWorkflowInvocationActions` response message.
  &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.
  &quot;workflowInvocationActions&quot;: [ # List of workflow invocation actions.
    { # Represents a single action in a workflow invocation.
      &quot;bigqueryAction&quot;: { # Represents a workflow action that will run against BigQuery. # Output only. The workflow action&#x27;s bigquery action details.
        &quot;jobId&quot;: &quot;A String&quot;, # Output only. The ID of the BigQuery job that executed the SQL in sql_script. Only set once the job has started to run.
        &quot;sqlScript&quot;: &quot;A String&quot;, # Output only. The generated BigQuery SQL script that will be executed.
      },
      &quot;canonicalTarget&quot;: { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # Output only. The action&#x27;s identifier if the project had been compiled without any overrides configured. Unique within the compilation result.
        &quot;database&quot;: &quot;A String&quot;, # Optional. The action&#x27;s database (Google Cloud project ID) .
        &quot;name&quot;: &quot;A String&quot;, # Optional. The action&#x27;s name, within `database` and `schema`.
        &quot;schema&quot;: &quot;A String&quot;, # Optional. The action&#x27;s schema (BigQuery dataset ID), within `database`.
      },
      &quot;dataPreparationAction&quot;: { # Represents a workflow action that will run a Data Preparation. # Output only. The workflow action&#x27;s data preparation action details.
        &quot;contentsSql&quot;: { # Definition of a SQL Data Preparation # SQL definition for a Data Preparation. Contains a SQL query and additional context information.
          &quot;errorTable&quot;: { # Error table information, used to write error data into a BigQuery table. # Error table configuration,
            &quot;retentionDays&quot;: 42, # Error table partition expiration in days. Only positive values are allowed.
            &quot;target&quot;: { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # Error Table target.
              &quot;database&quot;: &quot;A String&quot;, # Optional. The action&#x27;s database (Google Cloud project ID) .
              &quot;name&quot;: &quot;A String&quot;, # Optional. The action&#x27;s name, within `database` and `schema`.
              &quot;schema&quot;: &quot;A String&quot;, # Optional. The action&#x27;s schema (BigQuery dataset ID), within `database`.
            },
          },
          &quot;loadConfig&quot;: { # Simplified load configuration for actions # Load configuration.
            &quot;append&quot;: { # Simple load definition # Append into destination table
            },
            &quot;maximum&quot;: { # Load definition for incremental load modes # Insert records where the value exceeds the previous maximum value for a column in the destination table
              &quot;column&quot;: &quot;A String&quot;, # Column name for incremental load modes
            },
            &quot;replace&quot;: { # Simple load definition # Replace destination table
            },
            &quot;unique&quot;: { # Load definition for incremental load modes # Insert records where the value of a column is not already present in the destination table
              &quot;column&quot;: &quot;A String&quot;, # Column name for incremental load modes
            },
          },
          &quot;query&quot;: &quot;A String&quot;, # The SQL query representing the data preparation steps. Formatted as a Pipe SQL query statement.
        },
        &quot;contentsYaml&quot;: &quot;A String&quot;, # Output only. YAML representing the contents of the data preparation. Can be used to show the customer what the input was to their workflow.
        &quot;generatedSql&quot;: &quot;A String&quot;, # Output only. The generated BigQuery SQL script that will be executed. For reference only.
        &quot;jobId&quot;: &quot;A String&quot;, # Output only. The ID of the BigQuery job that executed the SQL in sql_script. Only set once the job has started to run.
      },
      &quot;failureReason&quot;: &quot;A String&quot;, # Output only. If and only if action&#x27;s state is FAILED a failure reason is set.
      &quot;internalMetadata&quot;: &quot;A String&quot;, # 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.
      &quot;invocationTiming&quot;: { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Output only. This action&#x27;s timing details. `start_time` will be set if the action is in [RUNNING, SUCCEEDED, CANCELLED, FAILED] state. `end_time` will be set if the action is in [SUCCEEDED, CANCELLED, FAILED] state.
        &quot;endTime&quot;: &quot;A String&quot;, # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
        &quot;startTime&quot;: &quot;A String&quot;, # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
      },
      &quot;notebookAction&quot;: { # Represents a workflow action that will run against a Notebook runtime. # Output only. The workflow action&#x27;s notebook action details.
        &quot;contents&quot;: &quot;A String&quot;, # Output only. The code contents of a Notebook to be run.
        &quot;jobId&quot;: &quot;A String&quot;, # Output only. The ID of the Vertex job that executed the notebook in contents and also the ID used for the outputs created in Google Cloud Storage buckets. Only set once the job has started to run.
      },
      &quot;state&quot;: &quot;A String&quot;, # Output only. This action&#x27;s current state.
      &quot;target&quot;: { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # Output only. This action&#x27;s identifier. Unique within the workflow invocation.
        &quot;database&quot;: &quot;A String&quot;, # Optional. The action&#x27;s database (Google Cloud project ID) .
        &quot;name&quot;: &quot;A String&quot;, # Optional. The action&#x27;s name, within `database` and `schema`.
        &quot;schema&quot;: &quot;A String&quot;, # Optional. The action&#x27;s schema (BigQuery dataset ID), within `database`.
      },
    },
  ],
}</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 &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

</body></html>