Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 3b134fd

Browse files
committedJan 28, 2025
feat(dataform): update the api
#### dataform:v1beta1 The following keys were added: - schemas.CompilationResult.properties.internalMetadata (Total Keys: 2) - schemas.CompilationResultAction.properties.internalMetadata (Total Keys: 2) - schemas.ReleaseConfig.properties.internalMetadata (Total Keys: 2) - schemas.Repository.properties.internalMetadata (Total Keys: 2) - schemas.WorkflowConfig.properties.internalMetadata (Total Keys: 2) - schemas.WorkflowInvocation.properties.internalMetadata (Total Keys: 2) - schemas.WorkflowInvocationAction.properties.internalMetadata (Total Keys: 2) - schemas.Workspace.properties.internalMetadata (Total Keys: 2)
1 parent 5739c98 commit 3b134fd

8 files changed

+98
-26
lines changed
 

‎docs/dyn/dataform_v1beta1.projects.locations.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ <h2>Instance Methods</h2>
9696
<p class="firstline">Retrieves the next page of results.</p>
9797
<p class="toc_element">
9898
<code><a href="#updateConfig">updateConfig(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
99-
<p class="firstline">Update default config for a given project and location. *Note:* This method does not fully implement AIP/134. In particular: 1. The wildcard entry (***) is treated as a bad request 2. When the *field_mask* is omitted, instead of only updating the set fields, the request is treated as a full update on all modifiable fields </p>
99+
<p class="firstline">Update default config for a given project and location. **Note:** *This method does not fully implement*, (see [AIP/134](https://google.aip.dev/134), in particular: - The wildcard entry (**\***) is treated as a bad request - When the **field_mask** is omitted, instead of only updating the set fields, the request is treated as a full update on all modifiable fields</p>
100100
<h3>Method Details</h3>
101101
<div class="method">
102102
<code class="details" id="close">close()</code>
@@ -201,7 +201,7 @@ <h3>Method Details</h3>
201201

202202
<div class="method">
203203
<code class="details" id="updateConfig">updateConfig(name, body=None, updateMask=None, x__xgafv=None)</code>
204-
<pre>Update default config for a given project and location. *Note:* This method does not fully implement AIP/134. In particular: 1. The wildcard entry (***) is treated as a bad request 2. When the *field_mask* is omitted, instead of only updating the set fields, the request is treated as a full update on all modifiable fields
204+
<pre>Update default config for a given project and location. **Note:** *This method does not fully implement*, (see [AIP/134](https://google.aip.dev/134), in particular: - The wildcard entry (**\***) is treated as a bad request - When the **field_mask** is omitted, instead of only updating the set fields, the request is treated as a full update on all modifiable fields
205205

206206
Args:
207207
name: string, Identifier. The config name. (required)

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

+9-4
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ <h3>Method Details</h3>
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.
119119
&quot;defaultNotebookRuntimeOptions&quot;: {
120-
&quot;gcsOutputBucket&quot;: &quot;A String&quot;, # Optional. The GCS location to upload the result to. Format: `gs://bucket-name`.
120+
&quot;gcsOutputBucket&quot;: &quot;A String&quot;, # Optional. The Google Cloud Storage location to upload the result to. Format: `gs://bucket-name`.
121121
},
122122
&quot;defaultSchema&quot;: &quot;A String&quot;, # Optional. The default schema (BigQuery dataset ID).
123123
&quot;schemaSuffix&quot;: &quot;A String&quot;, # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
@@ -144,6 +144,7 @@ <h3>Method Details</h3>
144144
},
145145
&quot;dataformCoreVersion&quot;: &quot;A String&quot;, # Output only. The version of `@dataform/core` that was used for compilation.
146146
&quot;gitCommitish&quot;: &quot;A String&quot;, # 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`
147+
&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.
147148
&quot;name&quot;: &quot;A String&quot;, # Output only. The compilation result&#x27;s name.
148149
&quot;releaseConfig&quot;: &quot;A String&quot;, # Immutable. The name of the release config to compile. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
149150
&quot;resolvedGitCommitSha&quot;: &quot;A String&quot;, # Output only. The fully resolved Git commit SHA of the code that was compiled. Not set for compilation results whose source is a workspace.
@@ -165,7 +166,7 @@ <h3>Method Details</h3>
165166
&quot;defaultDatabase&quot;: &quot;A String&quot;, # Optional. The default database (Google Cloud project ID).
166167
&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.
167168
&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+
&quot;gcsOutputBucket&quot;: &quot;A String&quot;, # Optional. The Google Cloud Storage location to upload the result to. Format: `gs://bucket-name`.
169170
},
170171
&quot;defaultSchema&quot;: &quot;A String&quot;, # Optional. The default schema (BigQuery dataset ID).
171172
&quot;schemaSuffix&quot;: &quot;A String&quot;, # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
@@ -192,6 +193,7 @@ <h3>Method Details</h3>
192193
},
193194
&quot;dataformCoreVersion&quot;: &quot;A String&quot;, # Output only. The version of `@dataform/core` that was used for compilation.
194195
&quot;gitCommitish&quot;: &quot;A String&quot;, # 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`
196+
&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.
195197
&quot;name&quot;: &quot;A String&quot;, # Output only. The compilation result&#x27;s name.
196198
&quot;releaseConfig&quot;: &quot;A String&quot;, # Immutable. The name of the release config to compile. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
197199
&quot;resolvedGitCommitSha&quot;: &quot;A String&quot;, # Output only. The fully resolved Git commit SHA of the code that was compiled. Not set for compilation results whose source is a workspace.
@@ -220,7 +222,7 @@ <h3>Method Details</h3>
220222
&quot;defaultDatabase&quot;: &quot;A String&quot;, # Optional. The default database (Google Cloud project ID).
221223
&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.
222224
&quot;defaultNotebookRuntimeOptions&quot;: {
223-
&quot;gcsOutputBucket&quot;: &quot;A String&quot;, # Optional. The GCS location to upload the result to. Format: `gs://bucket-name`.
225+
&quot;gcsOutputBucket&quot;: &quot;A String&quot;, # Optional. The Google Cloud Storage location to upload the result to. Format: `gs://bucket-name`.
224226
},
225227
&quot;defaultSchema&quot;: &quot;A String&quot;, # Optional. The default schema (BigQuery dataset ID).
226228
&quot;schemaSuffix&quot;: &quot;A String&quot;, # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
@@ -247,6 +249,7 @@ <h3>Method Details</h3>
247249
},
248250
&quot;dataformCoreVersion&quot;: &quot;A String&quot;, # Output only. The version of `@dataform/core` that was used for compilation.
249251
&quot;gitCommitish&quot;: &quot;A String&quot;, # 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`
252+
&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.
250253
&quot;name&quot;: &quot;A String&quot;, # Output only. The compilation result&#x27;s name.
251254
&quot;releaseConfig&quot;: &quot;A String&quot;, # Immutable. The name of the release config to compile. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
252255
&quot;resolvedGitCommitSha&quot;: &quot;A String&quot;, # Output only. The fully resolved Git commit SHA of the code that was compiled. Not set for compilation results whose source is a workspace.
@@ -281,7 +284,7 @@ <h3>Method Details</h3>
281284
&quot;defaultDatabase&quot;: &quot;A String&quot;, # Optional. The default database (Google Cloud project ID).
282285
&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.
283286
&quot;defaultNotebookRuntimeOptions&quot;: {
284-
&quot;gcsOutputBucket&quot;: &quot;A String&quot;, # Optional. The GCS location to upload the result to. Format: `gs://bucket-name`.
287+
&quot;gcsOutputBucket&quot;: &quot;A String&quot;, # Optional. The Google Cloud Storage location to upload the result to. Format: `gs://bucket-name`.
285288
},
286289
&quot;defaultSchema&quot;: &quot;A String&quot;, # Optional. The default schema (BigQuery dataset ID).
287290
&quot;schemaSuffix&quot;: &quot;A String&quot;, # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
@@ -308,6 +311,7 @@ <h3>Method Details</h3>
308311
},
309312
&quot;dataformCoreVersion&quot;: &quot;A String&quot;, # Output only. The version of `@dataform/core` that was used for compilation.
310313
&quot;gitCommitish&quot;: &quot;A String&quot;, # 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`
314+
&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.
311315
&quot;name&quot;: &quot;A String&quot;, # Output only. The compilation result&#x27;s name.
312316
&quot;releaseConfig&quot;: &quot;A String&quot;, # Immutable. The name of the release config to compile. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
313317
&quot;resolvedGitCommitSha&quot;: &quot;A String&quot;, # Output only. The fully resolved Git commit SHA of the code that was compiled. Not set for compilation results whose source is a workspace.
@@ -416,6 +420,7 @@ <h3>Method Details</h3>
416420
},
417421
},
418422
&quot;filePath&quot;: &quot;A String&quot;, # The full path including filename in which this action is located, relative to the workspace root.
423+
&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.
419424
&quot;notebook&quot;: { # The notebook executed by this action.
420425
&quot;contents&quot;: &quot;A String&quot;, # The contents of the notebook.
421426
&quot;dependencyTargets&quot;: [ # A list of actions that this action depends on.

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

+8-2
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ <h2>Instance Methods</h2>
137137
<p class="firstline">Retrieves the next page of results.</p>
138138
<p class="toc_element">
139139
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
140-
<p class="firstline">Updates a single Repository. *Note:* This method does not fully implement AIP/134. In particular: 1. The wildcard entry (***) is treated as a bad request 2. When the *field_mask* is omitted, instead of only updating the set fields, the request is treated as a full update on all modifiable fields </p>
140+
<p class="firstline">Updates a single Repository. **Note:** *This method does not fully implement*, (see [AIP/134](https://google.aip.dev/134), in particular: - The wildcard entry (**\***) is treated as a bad request - When the **field_mask** is omitted, instead of only updating the set fields, the request is treated as a full update on all modifiable fields</p>
141141
<p class="toc_element">
142142
<code><a href="#queryDirectoryContents">queryDirectoryContents(name, commitSha=None, pageSize=None, pageToken=None, path=None, x__xgafv=None)</a></code></p>
143143
<p class="firstline">Returns the contents of a given Repository directory. The Repository must not have a value for `git_remote_settings.url`.</p>
@@ -245,6 +245,7 @@ <h3>Method Details</h3>
245245
&quot;tokenStatus&quot;: &quot;A String&quot;, # Output only. Deprecated: The field does not contain any token status information. Instead use https://cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories/computeAccessTokenStatus
246246
&quot;url&quot;: &quot;A String&quot;, # Required. The Git remote&#x27;s URL.
247247
},
248+
&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.
248249
&quot;kmsKeyName&quot;: &quot;A String&quot;, # Optional. The reference to a KMS encryption key. If provided, it will be used to encrypt user data in the repository and all child resources. It is not possible to add or update the encryption key after the repository is created. Example: `projects/{kms_project}/locations/{location}/keyRings/{key_location}/cryptoKeys/{key}`
249250
&quot;labels&quot;: { # Optional. Repository user labels.
250251
&quot;a_key&quot;: &quot;A String&quot;,
@@ -285,6 +286,7 @@ <h3>Method Details</h3>
285286
&quot;tokenStatus&quot;: &quot;A String&quot;, # Output only. Deprecated: The field does not contain any token status information. Instead use https://cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories/computeAccessTokenStatus
286287
&quot;url&quot;: &quot;A String&quot;, # Required. The Git remote&#x27;s URL.
287288
},
289+
&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.
288290
&quot;kmsKeyName&quot;: &quot;A String&quot;, # Optional. The reference to a KMS encryption key. If provided, it will be used to encrypt user data in the repository and all child resources. It is not possible to add or update the encryption key after the repository is created. Example: `projects/{kms_project}/locations/{location}/keyRings/{key_location}/cryptoKeys/{key}`
289291
&quot;labels&quot;: { # Optional. Repository user labels.
290292
&quot;a_key&quot;: &quot;A String&quot;,
@@ -417,6 +419,7 @@ <h3>Method Details</h3>
417419
&quot;tokenStatus&quot;: &quot;A String&quot;, # Output only. Deprecated: The field does not contain any token status information. Instead use https://cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories/computeAccessTokenStatus
418420
&quot;url&quot;: &quot;A String&quot;, # Required. The Git remote&#x27;s URL.
419421
},
422+
&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.
420423
&quot;kmsKeyName&quot;: &quot;A String&quot;, # Optional. The reference to a KMS encryption key. If provided, it will be used to encrypt user data in the repository and all child resources. It is not possible to add or update the encryption key after the repository is created. Example: `projects/{kms_project}/locations/{location}/keyRings/{key_location}/cryptoKeys/{key}`
421424
&quot;labels&quot;: { # Optional. Repository user labels.
422425
&quot;a_key&quot;: &quot;A String&quot;,
@@ -505,6 +508,7 @@ <h3>Method Details</h3>
505508
&quot;tokenStatus&quot;: &quot;A String&quot;, # Output only. Deprecated: The field does not contain any token status information. Instead use https://cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories/computeAccessTokenStatus
506509
&quot;url&quot;: &quot;A String&quot;, # Required. The Git remote&#x27;s URL.
507510
},
511+
&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.
508512
&quot;kmsKeyName&quot;: &quot;A String&quot;, # Optional. The reference to a KMS encryption key. If provided, it will be used to encrypt user data in the repository and all child resources. It is not possible to add or update the encryption key after the repository is created. Example: `projects/{kms_project}/locations/{location}/keyRings/{key_location}/cryptoKeys/{key}`
509513
&quot;labels&quot;: { # Optional. Repository user labels.
510514
&quot;a_key&quot;: &quot;A String&quot;,
@@ -542,7 +546,7 @@ <h3>Method Details</h3>
542546

543547
<div class="method">
544548
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
545-
<pre>Updates a single Repository. *Note:* This method does not fully implement AIP/134. In particular: 1. The wildcard entry (***) is treated as a bad request 2. When the *field_mask* is omitted, instead of only updating the set fields, the request is treated as a full update on all modifiable fields
549+
<pre>Updates a single Repository. **Note:** *This method does not fully implement*, (see [AIP/134](https://google.aip.dev/134), in particular: - The wildcard entry (**\***) is treated as a bad request - When the **field_mask** is omitted, instead of only updating the set fields, the request is treated as a full update on all modifiable fields
546550

547551
Args:
548552
name: string, Identifier. The repository&#x27;s name. (required)
@@ -565,6 +569,7 @@ <h3>Method Details</h3>
565569
&quot;tokenStatus&quot;: &quot;A String&quot;, # Output only. Deprecated: The field does not contain any token status information. Instead use https://cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories/computeAccessTokenStatus
566570
&quot;url&quot;: &quot;A String&quot;, # Required. The Git remote&#x27;s URL.
567571
},
572+
&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.
568573
&quot;kmsKeyName&quot;: &quot;A String&quot;, # Optional. The reference to a KMS encryption key. If provided, it will be used to encrypt user data in the repository and all child resources. It is not possible to add or update the encryption key after the repository is created. Example: `projects/{kms_project}/locations/{location}/keyRings/{key_location}/cryptoKeys/{key}`
569574
&quot;labels&quot;: { # Optional. Repository user labels.
570575
&quot;a_key&quot;: &quot;A String&quot;,
@@ -605,6 +610,7 @@ <h3>Method Details</h3>
605610
&quot;tokenStatus&quot;: &quot;A String&quot;, # Output only. Deprecated: The field does not contain any token status information. Instead use https://cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories/computeAccessTokenStatus
606611
&quot;url&quot;: &quot;A String&quot;, # Required. The Git remote&#x27;s URL.
607612
},
613+
&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.
608614
&quot;kmsKeyName&quot;: &quot;A String&quot;, # Optional. The reference to a KMS encryption key. If provided, it will be used to encrypt user data in the repository and all child resources. It is not possible to add or update the encryption key after the repository is created. Example: `projects/{kms_project}/locations/{location}/keyRings/{key_location}/cryptoKeys/{key}`
609615
&quot;labels&quot;: { # Optional. Repository user labels.
610616
&quot;a_key&quot;: &quot;A String&quot;,

0 commit comments

Comments
 (0)
Please sign in to comment.