Debian Codegraph @

docs/dyn/dataform_v1beta1.projects.locations.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <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></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="dataform_v1beta1.projects.locations.folders.html">folders()</a></code>
79 </p>
80 <p class="firstline">Returns the folders Resource.</p>
81
82 <p class="toc_element">
83 <code><a href="dataform_v1beta1.projects.locations.operations.html">operations()</a></code>
84 </p>
85 <p class="firstline">Returns the operations Resource.</p>
86
87 <p class="toc_element">
88 <code><a href="dataform_v1beta1.projects.locations.repositories.html">repositories()</a></code>
89 </p>
90 <p class="firstline">Returns the repositories Resource.</p>
91
92 <p class="toc_element">
93 <code><a href="dataform_v1beta1.projects.locations.teamFolders.html">teamFolders()</a></code>
94 </p>
95 <p class="firstline">Returns the teamFolders Resource.</p>
96
97 <p class="toc_element">
98 <code><a href="#close">close()</a></code></p>
99 <p class="firstline">Close httplib2 connections.</p>
100 <p class="toc_element">
101 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
102 <p class="firstline">Gets information about a location.</p>
103 <p class="toc_element">
104 <code><a href="#getConfig">getConfig(name, x__xgafv=None)</a></code></p>
105 <p class="firstline">Get default config for a given project and location.</p>
106 <p class="toc_element">
107 <code><a href="#list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
108 <p class="firstline">Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.</p>
109 <p class="toc_element">
110 <code><a href="#list_next">list_next()</a></code></p>
111 <p class="firstline">Retrieves the next page of results.</p>
112 <p class="toc_element">
113 <code><a href="#queryUserRootContents">queryUserRootContents(location, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
114 <p class="firstline">Returns the contents of a caller's root folder in a given location. The root folder contains all resources that are created by the user and not contained in any other folder.</p>
115 <p class="toc_element">
116 <code><a href="#queryUserRootContents_next">queryUserRootContents_next()</a></code></p>
117 <p class="firstline">Retrieves the next page of results.</p>
118 <p class="toc_element">
119 <code><a href="#updateConfig">updateConfig(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
120 <p class="firstline">Update default config for a given project and location. **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>
121 <h3>Method Details</h3>
122 <div class="method">
123 <code class="details" id="close">close()</code>
124 <pre>Close httplib2 connections.</pre>
125 </div>
126
127 <div class="method">
128 <code class="details" id="get">get(name, x__xgafv=None)</code>
129 <pre>Gets information about a location.
130
131 Args:
132 name: string, Resource name for the location. (required)
133 x__xgafv: string, V1 error format.
134 Allowed values
135 1 - v1 error format
136 2 - v2 error format
137
138 Returns:
139 An object of the form:
140
141 { # A resource that represents a Google Cloud location.
142 &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name. For example, &quot;Tokyo&quot;.
143 &quot;labels&quot;: { # Cross-service attributes for the location. For example {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
144 &quot;a_key&quot;: &quot;A String&quot;,
145 },
146 &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: `&quot;us-east1&quot;`.
147 &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given location.
148 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
149 },
150 &quot;name&quot;: &quot;A String&quot;, # Resource name for the location, which may vary between implementations. For example: `&quot;projects/example-project/locations/us-east1&quot;`
151 }</pre>
152 </div>
153
154 <div class="method">
155 <code class="details" id="getConfig">getConfig(name, x__xgafv=None)</code>
156 <pre>Get default config for a given project and location.
157
158 Args:
159 name: string, Required. The config name. (required)
160 x__xgafv: string, V1 error format.
161 Allowed values
162 1 - v1 error format
163 2 - v2 error format
164
165 Returns:
166 An object of the form:
167
168 { # Config for all repositories in a given project and location.
169 &quot;defaultKmsKeyName&quot;: &quot;A String&quot;, # Optional. The default KMS key that is used if no encryption key is provided when a repository is created.
170 &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.
171 &quot;name&quot;: &quot;A String&quot;, # Identifier. The config name.
172 }</pre>
173 </div>
174
175 <div class="method">
176 <code class="details" id="list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
177 <pre>Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
178
179 Args:
180 name: string, The resource that owns the locations collection, if applicable. (required)
181 extraLocationTypes: string, Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
182 filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `&quot;displayName=tokyo&quot;`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
183 pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
184 pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
185 x__xgafv: string, V1 error format.
186 Allowed values
187 1 - v1 error format
188 2 - v2 error format
189
190 Returns:
191 An object of the form:
192
193 { # The response message for Locations.ListLocations.
194 &quot;locations&quot;: [ # A list of locations that matches the specified filter in the request.
195 { # A resource that represents a Google Cloud location.
196 &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name. For example, &quot;Tokyo&quot;.
197 &quot;labels&quot;: { # Cross-service attributes for the location. For example {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
198 &quot;a_key&quot;: &quot;A String&quot;,
199 },
200 &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: `&quot;us-east1&quot;`.
201 &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given location.
202 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
203 },
204 &quot;name&quot;: &quot;A String&quot;, # Resource name for the location, which may vary between implementations. For example: `&quot;projects/example-project/locations/us-east1&quot;`
205 },
206 ],
207 &quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
208 }</pre>
209 </div>
210
211 <div class="method">
212 <code class="details" id="list_next">list_next()</code>
213 <pre>Retrieves the next page of results.
214
215 Args:
216 previous_request: The request for the previous page. (required)
217 previous_response: The response from the request for the previous page. (required)
218
219 Returns:
220 A request object that you can call &#x27;execute()&#x27; on to request the next
221 page. Returns None if there are no more items in the collection.
222 </pre>
223 </div>
224
225 <div class="method">
226 <code class="details" id="queryUserRootContents">queryUserRootContents(location, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
227 <pre>Returns the contents of a caller&#x27;s root folder in a given location. The root folder contains all resources that are created by the user and not contained in any other folder.
228
229 Args:
230 location: string, Required. Location of the user root folder to list contents for. Format: projects/*/locations/* (required)
231 filter: string, Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter=&quot;display_name=&quot;MyFolder&quot;&quot;`
232 orderBy: string, Optional. Field to additionally sort results by. Will order Folders before Repositories, and then by `order_by` in ascending order. Supported keywords: display_name (default), created_at, last_modified_at. Examples: * `orderBy=&quot;display_name&quot;` * `orderBy=&quot;display_name desc&quot;`
233 pageSize: integer, Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
234 pageToken: string, Optional. Page token received from a previous `QueryUserRootContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryUserRootFolderContents`, with the exception of `page_size`, must match the call that provided the page token.
235 x__xgafv: string, V1 error format.
236 Allowed values
237 1 - v1 error format
238 2 - v2 error format
239
240 Returns:
241 An object of the form:
242
243 { # `QueryUserRootContents` response message.
244 &quot;entries&quot;: [ # List of entries in the folder.
245 { # Represents a single content entry.
246 &quot;folder&quot;: { # Represents a Dataform Folder. This is a resource that is used to organize Files and other Folders and provide hierarchical access controls. # A subfolder.
247 &quot;containingFolder&quot;: &quot;A String&quot;, # Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just &quot;&quot; if this is a root Folder. This field can only be updated through MoveFolder.
248 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp of when the Folder was created.
249 &quot;creatorIamPrincipal&quot;: &quot;A String&quot;, # Output only. The IAM principal identifier of the creator of the Folder.
250 &quot;displayName&quot;: &quot;A String&quot;, # Required. The Folder&#x27;s user-friendly name.
251 &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.
252 &quot;name&quot;: &quot;A String&quot;, # Identifier. The Folder&#x27;s name.
253 &quot;teamFolderName&quot;: &quot;A String&quot;, # Output only. The resource name of the TeamFolder that this Folder is associated with. This should take the format: projects/{project}/locations/{location}/teamFolders/{teamFolder}. If this is not set, the Folder is not associated with a TeamFolder and is a UserFolder.
254 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp of when the Folder was last updated.
255 },
256 &quot;repository&quot;: { # Represents a Dataform Git repository. # A repository.
257 &quot;containingFolder&quot;: &quot;A String&quot;, # Optional. The name of the containing folder of the repository. The field is immutable and it can be modified via a MoveRepository operation. Format: `projects/*/locations/*/folders/*`. or `projects/*/locations/*/teamFolders/*`.
258 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp of when the repository was created.
259 &quot;dataEncryptionState&quot;: { # Describes encryption state of a resource. # Output only. A data encryption state of a Git repository if this Repository is protected by a KMS key.
260 &quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # Required. The KMS key version name with which data of a resource is encrypted.
261 },
262 &quot;displayName&quot;: &quot;A String&quot;, # Optional. The repository&#x27;s user-friendly name.
263 &quot;gitRemoteSettings&quot;: { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
264 &quot;authenticationTokenSecretVersion&quot;: &quot;A String&quot;, # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
265 &quot;defaultBranch&quot;: &quot;A String&quot;, # Optional. The Git remote&#x27;s default branch name. If not set `main` will be used.
266 &quot;effectiveDefaultBranch&quot;: &quot;A String&quot;, # Output only. The Git remote&#x27;s effective default branch name. This is the default branch name of the Git remote if it is set, otherwise it is `main`.
267 &quot;gitRepositoryLink&quot;: &quot;A String&quot;, # Optional. Resource name for the GitRepositoryLink used for machine credentials. Must be in the format `projects/*/locations/*/connections/*/gitRepositoryLinks/*`
268 &quot;sshAuthenticationConfig&quot;: { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol.
269 &quot;hostPublicKey&quot;: &quot;A String&quot;, # Required. Content of a public SSH key to verify an identity of a remote Git host.
270 &quot;userPrivateKeySecretVersion&quot;: &quot;A String&quot;, # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
271 },
272 &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
273 &quot;url&quot;: &quot;A String&quot;, # Required. The Git remote&#x27;s URL.
274 },
275 &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.
276 &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}`
277 &quot;labels&quot;: { # Optional. Repository user labels.
278 &quot;a_key&quot;: &quot;A String&quot;,
279 },
280 &quot;name&quot;: &quot;A String&quot;, # Identifier. The repository&#x27;s name.
281 &quot;npmrcEnvironmentVariablesSecretVersion&quot;: &quot;A String&quot;, # Optional. The name of the Secret Manager secret version to be used to interpolate variables into the .npmrc file for package installation operations. Must be in the format `projects/*/secrets/*/versions/*`. The file itself must be in a JSON format.
282 &quot;serviceAccount&quot;: &quot;A String&quot;, # Optional. The service account to run workflow invocations under.
283 &quot;setAuthenticatedUserAdmin&quot;: True or False, # Optional. Input only. If set to true, the authenticated user will be granted the roles/dataform.admin role on the created repository. To modify access to the created repository later apply setIamPolicy from https://cloud.google.com/dataform/reference/rest#rest-resource:-v1beta1.projects.locations.repositories
284 &quot;teamFolderName&quot;: &quot;A String&quot;, # Output only. The resource name of the TeamFolder that this Repository is associated with. This should take the format: projects/{project}/locations/{location}/teamFolders/{teamFolder}. If this is not set, the Repository is not associated with a TeamFolder.
285 &quot;workspaceCompilationOverrides&quot;: { # Configures workspace compilation overrides for a repository. Primarily used by the UI (`console.cloud.google.com`). `schema_suffix` and `table_prefix` can have a special expression - `${workspaceName}`, which refers to the workspace name from which the compilation results will be created. API callers are expected to resolve the expression in these overrides and provide them explicitly in `code_compilation_config` (https://cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories.compilationResults#codecompilationconfig) when creating workspace-scoped compilation results. # Optional. If set, fields of `workspace_compilation_overrides` override the default compilation settings that are specified in dataform.json when creating workspace-scoped compilation results. See documentation for `WorkspaceCompilationOverrides` for more information.
286 &quot;defaultDatabase&quot;: &quot;A String&quot;, # Optional. The default database (Google Cloud project ID).
287 &quot;schemaSuffix&quot;: &quot;A String&quot;, # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
288 &quot;tablePrefix&quot;: &quot;A String&quot;, # Optional. The prefix that should be prepended to all table names.
289 },
290 },
291 },
292 ],
293 &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.
294 }</pre>
295 </div>
296
297 <div class="method">
298 <code class="details" id="queryUserRootContents_next">queryUserRootContents_next()</code>
299 <pre>Retrieves the next page of results.
300
301 Args:
302 previous_request: The request for the previous page. (required)
303 previous_response: The response from the request for the previous page. (required)
304
305 Returns:
306 A request object that you can call &#x27;execute()&#x27; on to request the next
307 page. Returns None if there are no more items in the collection.
308 </pre>
309 </div>
310
311 <div class="method">
312 <code class="details" id="updateConfig">updateConfig(name, body=None, updateMask=None, x__xgafv=None)</code>
313 <pre>Update default config for a given project and location. **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.*
314
315 Args:
316 name: string, Identifier. The config name. (required)
317 body: object, The request body.
318 The object takes the form of:
319
320 { # Config for all repositories in a given project and location.
321 &quot;defaultKmsKeyName&quot;: &quot;A String&quot;, # Optional. The default KMS key that is used if no encryption key is provided when a repository is created.
322 &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.
323 &quot;name&quot;: &quot;A String&quot;, # Identifier. The config name.
324 }
325
326 updateMask: string, Optional. Specifies the fields to be updated in the config.
327 x__xgafv: string, V1 error format.
328 Allowed values
329 1 - v1 error format
330 2 - v2 error format
331
332 Returns:
333 An object of the form:
334
335 { # Config for all repositories in a given project and location.
336 &quot;defaultKmsKeyName&quot;: &quot;A String&quot;, # Optional. The default KMS key that is used if no encryption key is provided when a repository is created.
337 &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.
338 &quot;name&quot;: &quot;A String&quot;, # Identifier. The config name.
339 }</pre>
340 </div>
341
342 </body></html>