Skip to content

Commit a26ff80

Browse files
feat(dataform): update the api
#### dataform:v1beta1 The following keys were added: - resources.projects.resources.locations.resources.repositories.resources.compilationResults.methods.list.parameters.orderBy (Total Keys: 2) - schemas.BigQueryAction.properties.jobId (Total Keys: 2) - schemas.CodeCompilationConfig.properties.defaultNotebookRuntimeOptions.$ref (Total Keys: 1) - schemas.CompilationResultAction.properties.notebook.$ref (Total Keys: 1) - schemas.Notebook (Total Keys: 17) - schemas.WorkflowInvocationAction.properties.notebookAction (Total Keys: 2)
1 parent 19793e5 commit a26ff80

4 files changed

+130
-3
lines changed

docs/dyn/dataform_v1beta1.projects.locations.repositories.compilationResults.html

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ <h2>Instance Methods</h2>
8484
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
8585
<p class="firstline">Fetches a single CompilationResult.</p>
8686
<p class="toc_element">
87-
<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
87+
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
8888
<p class="firstline">Lists CompilationResults in a given Repository.</p>
8989
<p class="toc_element">
9090
<code><a href="#list_next">list_next()</a></code></p>
@@ -116,6 +116,9 @@ <h3>Method Details</h3>
116116
&quot;databaseSuffix&quot;: &quot;A String&quot;, # Optional. The suffix that should be appended to all database (Google Cloud project ID) names.
117117
&quot;defaultDatabase&quot;: &quot;A String&quot;, # Optional. The default database (Google Cloud project ID).
118118
&quot;defaultLocation&quot;: &quot;A String&quot;, # Optional. The default BigQuery location to use. Defaults to &quot;US&quot;. See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations.
119+
&quot;defaultNotebookRuntimeOptions&quot;: {
120+
&quot;gcsOutputBucket&quot;: &quot;A String&quot;, # Optional. The GCS location to upload the result to. Format: `gs://bucket-name`.
121+
},
119122
&quot;defaultSchema&quot;: &quot;A String&quot;, # Optional. The default schema (BigQuery dataset ID).
120123
&quot;schemaSuffix&quot;: &quot;A String&quot;, # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
121124
&quot;tablePrefix&quot;: &quot;A String&quot;, # Optional. The prefix that should be prepended to all table names.
@@ -157,6 +160,9 @@ <h3>Method Details</h3>
157160
&quot;databaseSuffix&quot;: &quot;A String&quot;, # Optional. The suffix that should be appended to all database (Google Cloud project ID) names.
158161
&quot;defaultDatabase&quot;: &quot;A String&quot;, # Optional. The default database (Google Cloud project ID).
159162
&quot;defaultLocation&quot;: &quot;A String&quot;, # Optional. The default BigQuery location to use. Defaults to &quot;US&quot;. See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations.
163+
&quot;defaultNotebookRuntimeOptions&quot;: {
164+
&quot;gcsOutputBucket&quot;: &quot;A String&quot;, # Optional. The GCS location to upload the result to. Format: `gs://bucket-name`.
165+
},
160166
&quot;defaultSchema&quot;: &quot;A String&quot;, # Optional. The default schema (BigQuery dataset ID).
161167
&quot;schemaSuffix&quot;: &quot;A String&quot;, # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
162168
&quot;tablePrefix&quot;: &quot;A String&quot;, # Optional. The prefix that should be prepended to all table names.
@@ -205,6 +211,9 @@ <h3>Method Details</h3>
205211
&quot;databaseSuffix&quot;: &quot;A String&quot;, # Optional. The suffix that should be appended to all database (Google Cloud project ID) names.
206212
&quot;defaultDatabase&quot;: &quot;A String&quot;, # Optional. The default database (Google Cloud project ID).
207213
&quot;defaultLocation&quot;: &quot;A String&quot;, # Optional. The default BigQuery location to use. Defaults to &quot;US&quot;. See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations.
214+
&quot;defaultNotebookRuntimeOptions&quot;: {
215+
&quot;gcsOutputBucket&quot;: &quot;A String&quot;, # Optional. The GCS location to upload the result to. Format: `gs://bucket-name`.
216+
},
208217
&quot;defaultSchema&quot;: &quot;A String&quot;, # Optional. The default schema (BigQuery dataset ID).
209218
&quot;schemaSuffix&quot;: &quot;A String&quot;, # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
210219
&quot;tablePrefix&quot;: &quot;A String&quot;, # Optional. The prefix that should be prepended to all table names.
@@ -234,12 +243,13 @@ <h3>Method Details</h3>
234243
</div>
235244

236245
<div class="method">
237-
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
246+
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
238247
<pre>Lists CompilationResults in a given Repository.
239248

240249
Args:
241250
parent: string, Required. The repository in which to list compilation results. Must be in the format `projects/*/locations/*/repositories/*`. (required)
242251
filter: string, Optional. Filter for the returned list.
252+
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.
243253
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.
244254
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` must match the call that provided the page token.
245255
x__xgafv: string, V1 error format.
@@ -258,6 +268,9 @@ <h3>Method Details</h3>
258268
&quot;databaseSuffix&quot;: &quot;A String&quot;, # Optional. The suffix that should be appended to all database (Google Cloud project ID) names.
259269
&quot;defaultDatabase&quot;: &quot;A String&quot;, # Optional. The default database (Google Cloud project ID).
260270
&quot;defaultLocation&quot;: &quot;A String&quot;, # Optional. The default BigQuery location to use. Defaults to &quot;US&quot;. See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations.
271+
&quot;defaultNotebookRuntimeOptions&quot;: {
272+
&quot;gcsOutputBucket&quot;: &quot;A String&quot;, # Optional. The GCS location to upload the result to. Format: `gs://bucket-name`.
273+
},
261274
&quot;defaultSchema&quot;: &quot;A String&quot;, # Optional. The default schema (BigQuery dataset ID).
262275
&quot;schemaSuffix&quot;: &quot;A String&quot;, # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
263276
&quot;tablePrefix&quot;: &quot;A String&quot;, # Optional. The prefix that should be prepended to all table names.
@@ -387,6 +400,20 @@ <h3>Method Details</h3>
387400
},
388401
},
389402
&quot;filePath&quot;: &quot;A String&quot;, # The full path including filename in which this action is located, relative to the workspace root.
403+
&quot;notebook&quot;: { # The notebook executed by this action.
404+
&quot;contents&quot;: &quot;A String&quot;, # The contents of the notebook.
405+
&quot;dependencyTargets&quot;: [ # A list of actions that this action depends on.
406+
{ # Represents an action identifier. If the action writes output, the output will be written to the referenced database object.
407+
&quot;database&quot;: &quot;A String&quot;, # The action&#x27;s database (Google Cloud project ID) .
408+
&quot;name&quot;: &quot;A String&quot;, # The action&#x27;s name, within `database` and `schema`.
409+
&quot;schema&quot;: &quot;A String&quot;, # The action&#x27;s schema (BigQuery dataset ID), within `database`.
410+
},
411+
],
412+
&quot;disabled&quot;: True or False, # Whether this action is disabled (i.e. should not be run).
413+
&quot;tags&quot;: [ # Arbitrary, user-defined tags on this action.
414+
&quot;A String&quot;,
415+
],
416+
},
390417
&quot;operations&quot;: { # Represents a list of arbitrary database operations. # The database operations executed by this action.
391418
&quot;dependencyTargets&quot;: [ # A list of actions that this action depends on.
392419
{ # Represents an action identifier. If the action writes output, the output will be written to the referenced database object.

docs/dyn/dataform_v1beta1.projects.locations.repositories.releaseConfigs.html

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,9 @@ <h3>Method Details</h3>
116116
&quot;databaseSuffix&quot;: &quot;A String&quot;, # Optional. The suffix that should be appended to all database (Google Cloud project ID) names.
117117
&quot;defaultDatabase&quot;: &quot;A String&quot;, # Optional. The default database (Google Cloud project ID).
118118
&quot;defaultLocation&quot;: &quot;A String&quot;, # Optional. The default BigQuery location to use. Defaults to &quot;US&quot;. See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations.
119+
&quot;defaultNotebookRuntimeOptions&quot;: {
120+
&quot;gcsOutputBucket&quot;: &quot;A String&quot;, # Optional. The GCS location to upload the result to. Format: `gs://bucket-name`.
121+
},
119122
&quot;defaultSchema&quot;: &quot;A String&quot;, # Optional. The default schema (BigQuery dataset ID).
120123
&quot;schemaSuffix&quot;: &quot;A String&quot;, # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
121124
&quot;tablePrefix&quot;: &quot;A String&quot;, # Optional. The prefix that should be prepended to all table names.
@@ -161,6 +164,9 @@ <h3>Method Details</h3>
161164
&quot;databaseSuffix&quot;: &quot;A String&quot;, # Optional. The suffix that should be appended to all database (Google Cloud project ID) names.
162165
&quot;defaultDatabase&quot;: &quot;A String&quot;, # Optional. The default database (Google Cloud project ID).
163166
&quot;defaultLocation&quot;: &quot;A String&quot;, # Optional. The default BigQuery location to use. Defaults to &quot;US&quot;. See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations.
167+
&quot;defaultNotebookRuntimeOptions&quot;: {
168+
&quot;gcsOutputBucket&quot;: &quot;A String&quot;, # Optional. The GCS location to upload the result to. Format: `gs://bucket-name`.
169+
},
164170
&quot;defaultSchema&quot;: &quot;A String&quot;, # Optional. The default schema (BigQuery dataset ID).
165171
&quot;schemaSuffix&quot;: &quot;A String&quot;, # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
166172
&quot;tablePrefix&quot;: &quot;A String&quot;, # Optional. The prefix that should be prepended to all table names.
@@ -230,6 +236,9 @@ <h3>Method Details</h3>
230236
&quot;databaseSuffix&quot;: &quot;A String&quot;, # Optional. The suffix that should be appended to all database (Google Cloud project ID) names.
231237
&quot;defaultDatabase&quot;: &quot;A String&quot;, # Optional. The default database (Google Cloud project ID).
232238
&quot;defaultLocation&quot;: &quot;A String&quot;, # Optional. The default BigQuery location to use. Defaults to &quot;US&quot;. See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations.
239+
&quot;defaultNotebookRuntimeOptions&quot;: {
240+
&quot;gcsOutputBucket&quot;: &quot;A String&quot;, # Optional. The GCS location to upload the result to. Format: `gs://bucket-name`.
241+
},
233242
&quot;defaultSchema&quot;: &quot;A String&quot;, # Optional. The default schema (BigQuery dataset ID).
234243
&quot;schemaSuffix&quot;: &quot;A String&quot;, # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
235244
&quot;tablePrefix&quot;: &quot;A String&quot;, # Optional. The prefix that should be prepended to all table names.
@@ -286,6 +295,9 @@ <h3>Method Details</h3>
286295
&quot;databaseSuffix&quot;: &quot;A String&quot;, # Optional. The suffix that should be appended to all database (Google Cloud project ID) names.
287296
&quot;defaultDatabase&quot;: &quot;A String&quot;, # Optional. The default database (Google Cloud project ID).
288297
&quot;defaultLocation&quot;: &quot;A String&quot;, # Optional. The default BigQuery location to use. Defaults to &quot;US&quot;. See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations.
298+
&quot;defaultNotebookRuntimeOptions&quot;: {
299+
&quot;gcsOutputBucket&quot;: &quot;A String&quot;, # Optional. The GCS location to upload the result to. Format: `gs://bucket-name`.
300+
},
289301
&quot;defaultSchema&quot;: &quot;A String&quot;, # Optional. The default schema (BigQuery dataset ID).
290302
&quot;schemaSuffix&quot;: &quot;A String&quot;, # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
291303
&quot;tablePrefix&quot;: &quot;A String&quot;, # Optional. The prefix that should be prepended to all table names.
@@ -351,6 +363,9 @@ <h3>Method Details</h3>
351363
&quot;databaseSuffix&quot;: &quot;A String&quot;, # Optional. The suffix that should be appended to all database (Google Cloud project ID) names.
352364
&quot;defaultDatabase&quot;: &quot;A String&quot;, # Optional. The default database (Google Cloud project ID).
353365
&quot;defaultLocation&quot;: &quot;A String&quot;, # Optional. The default BigQuery location to use. Defaults to &quot;US&quot;. See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations.
366+
&quot;defaultNotebookRuntimeOptions&quot;: {
367+
&quot;gcsOutputBucket&quot;: &quot;A String&quot;, # Optional. The GCS location to upload the result to. Format: `gs://bucket-name`.
368+
},
354369
&quot;defaultSchema&quot;: &quot;A String&quot;, # Optional. The default schema (BigQuery dataset ID).
355370
&quot;schemaSuffix&quot;: &quot;A String&quot;, # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
356371
&quot;tablePrefix&quot;: &quot;A String&quot;, # Optional. The prefix that should be prepended to all table names.
@@ -396,6 +411,9 @@ <h3>Method Details</h3>
396411
&quot;databaseSuffix&quot;: &quot;A String&quot;, # Optional. The suffix that should be appended to all database (Google Cloud project ID) names.
397412
&quot;defaultDatabase&quot;: &quot;A String&quot;, # Optional. The default database (Google Cloud project ID).
398413
&quot;defaultLocation&quot;: &quot;A String&quot;, # Optional. The default BigQuery location to use. Defaults to &quot;US&quot;. See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations.
414+
&quot;defaultNotebookRuntimeOptions&quot;: {
415+
&quot;gcsOutputBucket&quot;: &quot;A String&quot;, # Optional. The GCS location to upload the result to. Format: `gs://bucket-name`.
416+
},
399417
&quot;defaultSchema&quot;: &quot;A String&quot;, # Optional. The default schema (BigQuery dataset ID).
400418
&quot;schemaSuffix&quot;: &quot;A String&quot;, # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
401419
&quot;tablePrefix&quot;: &quot;A String&quot;, # Optional. The prefix that should be prepended to all table names.

docs/dyn/dataform_v1beta1.projects.locations.repositories.workflowInvocations.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -356,6 +356,7 @@ <h3>Method Details</h3>
356356
&quot;workflowInvocationActions&quot;: [ # List of workflow invocation actions.
357357
{ # Represents a single action in a workflow invocation.
358358
&quot;bigqueryAction&quot;: { # Represents a workflow action that will run against BigQuery. # Output only. The workflow action&#x27;s bigquery action details.
359+
&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.
359360
&quot;sqlScript&quot;: &quot;A String&quot;, # Output only. The generated BigQuery SQL script that will be executed.
360361
},
361362
&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.
@@ -368,6 +369,10 @@ <h3>Method Details</h3>
368369
&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.
369370
&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.
370371
},
372+
&quot;notebookAction&quot;: { # Represents a workflow action that will run against a Notebook runtime. # Output only. The workflow action&#x27;s notebook action details.
373+
&quot;contents&quot;: &quot;A String&quot;, # Output only. The code contents of a Notebook to be run.
374+
&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 GCS buckets. Only set once the job has started to run.
375+
},
371376
&quot;state&quot;: &quot;A String&quot;, # Output only. This action&#x27;s current state.
372377
&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.
373378
&quot;database&quot;: &quot;A String&quot;, # The action&#x27;s database (Google Cloud project ID) .

0 commit comments

Comments
 (0)