@maxim_mazurok/gapi.client.dataform-v1beta1 0.2.20260304 → 0.2.20260529
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +241 -37
- package/package.json +1 -1
- package/readme.md +17 -0
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://dataform.googleapis.com/$discovery/rest?version=v1beta1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260529
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -162,7 +162,7 @@ declare namespace gapi.client {
|
|
|
162
162
|
}
|
|
163
163
|
interface CommitWorkspaceChangesResponse {}
|
|
164
164
|
interface CompilationError {
|
|
165
|
-
/** Output only. The identifier of the action where this error occurred, if available. */
|
|
165
|
+
/** Output only. The identifier of the action where this error occurred, if available. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:CompilationError) */
|
|
166
166
|
actionTarget?: Target;
|
|
167
167
|
/** Output only. The error's top level message. */
|
|
168
168
|
message?: string;
|
|
@@ -225,7 +225,8 @@ declare namespace gapi.client {
|
|
|
225
225
|
| 'TOKEN_STATUS_UNSPECIFIED'
|
|
226
226
|
| 'NOT_FOUND'
|
|
227
227
|
| 'INVALID'
|
|
228
|
-
| 'VALID'
|
|
228
|
+
| 'VALID'
|
|
229
|
+
| 'PERMISSION_DENIED';
|
|
229
230
|
}
|
|
230
231
|
interface Config {
|
|
231
232
|
/** Optional. The default KMS key that is used if no encryption key is provided when a repository is created. */
|
|
@@ -266,11 +267,25 @@ declare namespace gapi.client {
|
|
|
266
267
|
relationDescriptor?: RelationDescriptor;
|
|
267
268
|
}
|
|
268
269
|
interface DeleteFile {}
|
|
270
|
+
interface DeleteFolderTreeRequest {
|
|
271
|
+
/** Optional. If `false` (default): The operation will fail if any Repository within the folder hierarchy has associated Release Configs or Workflow Configs. If `true`: The operation will attempt to delete everything, including any Release Configs and Workflow Configs linked to Repositories within the folder hierarchy. This permanently removes schedules and resources. */
|
|
272
|
+
force?: boolean;
|
|
273
|
+
}
|
|
274
|
+
interface DeleteRepositoryLongRunningRequest {
|
|
275
|
+
/** Optional. If set to true, child resources of this repository (compilation results and workflow invocations) will also be deleted. Otherwise, the request will only succeed if the repository has no child resources. **Note:** *This flag doesn't support deletion of workspaces, release configs or workflow configs. If any of such resources exists in the repository, the request will fail.* */
|
|
276
|
+
force?: boolean;
|
|
277
|
+
}
|
|
278
|
+
interface DeleteTeamFolderTreeRequest {
|
|
279
|
+
/** Optional. If `false` (default): The operation will fail if any Repository within the folder hierarchy has associated Release Configs or Workflow Configs. If `true`: The operation will attempt to delete everything, including any Release Configs and Workflow Configs linked to Repositories within the folder hierarchy. This permanently removes schedules and resources. */
|
|
280
|
+
force?: boolean;
|
|
281
|
+
}
|
|
269
282
|
interface DirectoryEntry {
|
|
270
|
-
/** A child directory in the directory. */
|
|
283
|
+
/** A child directory in the directory. The path is returned including the full folder structure from the root. */
|
|
271
284
|
directory?: string;
|
|
272
|
-
/** A file in the directory. */
|
|
285
|
+
/** A file in the directory. The path is returned including the full folder structure from the root. */
|
|
273
286
|
file?: string;
|
|
287
|
+
/** Entry with metadata. */
|
|
288
|
+
metadata?: FilesystemEntryMetadata;
|
|
274
289
|
}
|
|
275
290
|
interface DirectorySearchResult {
|
|
276
291
|
/** File system path relative to the workspace root. */
|
|
@@ -327,8 +342,14 @@ declare namespace gapi.client {
|
|
|
327
342
|
/** File system path relative to the workspace root. */
|
|
328
343
|
path?: string;
|
|
329
344
|
}
|
|
345
|
+
interface FilesystemEntryMetadata {
|
|
346
|
+
/** Output only. Provides the size of the entry in bytes. For directories, this will be 0. */
|
|
347
|
+
sizeBytes?: string;
|
|
348
|
+
/** Output only. Represents the time of the last modification of the entry. */
|
|
349
|
+
updateTime?: string;
|
|
350
|
+
}
|
|
330
351
|
interface Folder {
|
|
331
|
-
/** 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
|
|
352
|
+
/** 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 "" if this is a root Folder. This field can only be updated through MoveFolder. */
|
|
332
353
|
containingFolder?: string;
|
|
333
354
|
/** Output only. The timestamp of when the Folder was created. */
|
|
334
355
|
createTime?: string;
|
|
@@ -354,8 +375,12 @@ declare namespace gapi.client {
|
|
|
354
375
|
interface GitRemoteSettings {
|
|
355
376
|
/** 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/*`. */
|
|
356
377
|
authenticationTokenSecretVersion?: string;
|
|
357
|
-
/**
|
|
378
|
+
/** Optional. The Git remote's default branch name. If not set `main` will be used. */
|
|
358
379
|
defaultBranch?: string;
|
|
380
|
+
/** Output only. The Git remote's effective default branch name. This is the default branch name of the Git remote if it is set, otherwise it is `main`. */
|
|
381
|
+
effectiveDefaultBranch?: string;
|
|
382
|
+
/** Optional. Resource name for the GitRepositoryLink used for machine credentials. Must be in the format `projects/*/locations/*/connections/*/gitRepositoryLinks/*` */
|
|
383
|
+
gitRepositoryLink?: string;
|
|
359
384
|
/** Optional. Authentication fields for remote uris using SSH protocol. */
|
|
360
385
|
sshAuthenticationConfig?: SshAuthenticationConfig;
|
|
361
386
|
/** 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 */
|
|
@@ -420,7 +445,7 @@ declare namespace gapi.client {
|
|
|
420
445
|
compilationResults?: CompilationResult[];
|
|
421
446
|
/** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
422
447
|
nextPageToken?: string;
|
|
423
|
-
/** Locations which could not be reached. */
|
|
448
|
+
/** Locations which could not be reached. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ListCompilationResultsResponse) */
|
|
424
449
|
unreachable?: string[];
|
|
425
450
|
}
|
|
426
451
|
interface ListLocationsResponse {
|
|
@@ -442,7 +467,7 @@ declare namespace gapi.client {
|
|
|
442
467
|
nextPageToken?: string;
|
|
443
468
|
/** List of release configs. */
|
|
444
469
|
releaseConfigs?: ReleaseConfig[];
|
|
445
|
-
/** Locations which could not be reached. */
|
|
470
|
+
/** Locations which could not be reached. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ListReleaseConfigsResponse) */
|
|
446
471
|
unreachable?: string[];
|
|
447
472
|
}
|
|
448
473
|
interface ListRepositoriesResponse {
|
|
@@ -539,7 +564,7 @@ declare namespace gapi.client {
|
|
|
539
564
|
interface NotebookAction {
|
|
540
565
|
/** Output only. The code contents of a Notebook to be run. */
|
|
541
566
|
contents?: string;
|
|
542
|
-
/** Output only. The ID of the
|
|
567
|
+
/** Output only. The ID of the Gemini Enterprise Agent Platform 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. */
|
|
543
568
|
jobId?: string;
|
|
544
569
|
}
|
|
545
570
|
interface NotebookRuntimeOptions {
|
|
@@ -732,7 +757,7 @@ declare namespace gapi.client {
|
|
|
732
757
|
disabled?: boolean;
|
|
733
758
|
/** Required. 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` */
|
|
734
759
|
gitCommitish?: string;
|
|
735
|
-
/** 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. */
|
|
760
|
+
/** 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. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ReleaseConfig) */
|
|
736
761
|
internalMetadata?: string;
|
|
737
762
|
/** Identifier. The release config's name. */
|
|
738
763
|
name?: string;
|
|
@@ -853,7 +878,7 @@ declare namespace gapi.client {
|
|
|
853
878
|
/** The status code, which should be an enum value of google.rpc.Code. */
|
|
854
879
|
code?: number;
|
|
855
880
|
/** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
|
|
856
|
-
details?:
|
|
881
|
+
details?: {[P in string]: any}[];
|
|
857
882
|
/** A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */
|
|
858
883
|
message?: string;
|
|
859
884
|
}
|
|
@@ -1031,7 +1056,7 @@ declare namespace gapi.client {
|
|
|
1031
1056
|
callback?: string;
|
|
1032
1057
|
/** Selector specifying which fields to include in a partial response. */
|
|
1033
1058
|
fields?: string;
|
|
1034
|
-
/** The ID to use for the Folder, which will become the final component of the Folder's resource name. */
|
|
1059
|
+
/** Deprecated: This field is not used. The resource name is generated automatically. The ID to use for the Folder, which will become the final component of the Folder's resource name. */
|
|
1035
1060
|
folderId?: string;
|
|
1036
1061
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1037
1062
|
key?: string;
|
|
@@ -1062,7 +1087,7 @@ declare namespace gapi.client {
|
|
|
1062
1087
|
callback?: string;
|
|
1063
1088
|
/** Selector specifying which fields to include in a partial response. */
|
|
1064
1089
|
fields?: string;
|
|
1065
|
-
/** The ID to use for the Folder, which will become the final component of the Folder's resource name. */
|
|
1090
|
+
/** Deprecated: This field is not used. The resource name is generated automatically. The ID to use for the Folder, which will become the final component of the Folder's resource name. */
|
|
1066
1091
|
folderId?: string;
|
|
1067
1092
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1068
1093
|
key?: string;
|
|
@@ -1108,6 +1133,64 @@ declare namespace gapi.client {
|
|
|
1108
1133
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1109
1134
|
uploadType?: string;
|
|
1110
1135
|
}): Request<{}>;
|
|
1136
|
+
/** Deletes a Folder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs). */
|
|
1137
|
+
deleteTree(request: {
|
|
1138
|
+
/** V1 error format. */
|
|
1139
|
+
'$.xgafv'?: '1' | '2';
|
|
1140
|
+
/** OAuth access token. */
|
|
1141
|
+
access_token?: string;
|
|
1142
|
+
/** Data format for response. */
|
|
1143
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1144
|
+
/** JSONP */
|
|
1145
|
+
callback?: string;
|
|
1146
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1147
|
+
fields?: string;
|
|
1148
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1149
|
+
key?: string;
|
|
1150
|
+
/** Required. The Folder's name. Format: projects/{project}/locations/{location}/folders/{folder} */
|
|
1151
|
+
name: string;
|
|
1152
|
+
/** OAuth 2.0 token for the current user. */
|
|
1153
|
+
oauth_token?: string;
|
|
1154
|
+
/** Returns response with indentations and line breaks. */
|
|
1155
|
+
prettyPrint?: boolean;
|
|
1156
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1157
|
+
quotaUser?: string;
|
|
1158
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1159
|
+
upload_protocol?: string;
|
|
1160
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1161
|
+
uploadType?: string;
|
|
1162
|
+
/** Request body */
|
|
1163
|
+
resource: DeleteFolderTreeRequest;
|
|
1164
|
+
}): Request<Operation>;
|
|
1165
|
+
deleteTree(
|
|
1166
|
+
request: {
|
|
1167
|
+
/** V1 error format. */
|
|
1168
|
+
'$.xgafv'?: '1' | '2';
|
|
1169
|
+
/** OAuth access token. */
|
|
1170
|
+
access_token?: string;
|
|
1171
|
+
/** Data format for response. */
|
|
1172
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1173
|
+
/** JSONP */
|
|
1174
|
+
callback?: string;
|
|
1175
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1176
|
+
fields?: string;
|
|
1177
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1178
|
+
key?: string;
|
|
1179
|
+
/** Required. The Folder's name. Format: projects/{project}/locations/{location}/folders/{folder} */
|
|
1180
|
+
name: string;
|
|
1181
|
+
/** OAuth 2.0 token for the current user. */
|
|
1182
|
+
oauth_token?: string;
|
|
1183
|
+
/** Returns response with indentations and line breaks. */
|
|
1184
|
+
prettyPrint?: boolean;
|
|
1185
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1186
|
+
quotaUser?: string;
|
|
1187
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1188
|
+
upload_protocol?: string;
|
|
1189
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1190
|
+
uploadType?: string;
|
|
1191
|
+
},
|
|
1192
|
+
body: DeleteFolderTreeRequest,
|
|
1193
|
+
): Request<Operation>;
|
|
1111
1194
|
/** Fetches a single Folder. */
|
|
1112
1195
|
get(request?: {
|
|
1113
1196
|
/** V1 error format. */
|
|
@@ -1296,15 +1379,15 @@ declare namespace gapi.client {
|
|
|
1296
1379
|
callback?: string;
|
|
1297
1380
|
/** Selector specifying which fields to include in a partial response. */
|
|
1298
1381
|
fields?: string;
|
|
1299
|
-
/** Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example:
|
|
1382
|
+
/** Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter="display_name="MyFolder""` */
|
|
1300
1383
|
filter?: string;
|
|
1301
|
-
/** Required.
|
|
1384
|
+
/** Required. Resource name of the Folder to list contents for. Format: projects/*/locations/*/folders/* */
|
|
1302
1385
|
folder: string;
|
|
1303
1386
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1304
1387
|
key?: string;
|
|
1305
1388
|
/** OAuth 2.0 token for the current user. */
|
|
1306
1389
|
oauth_token?: string;
|
|
1307
|
-
/** 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), create_time, last_modified_time. Examples:
|
|
1390
|
+
/** 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), create_time, last_modified_time. Examples: * `orderBy="display_name"` * `orderBy="display_name desc"` */
|
|
1308
1391
|
orderBy?: string;
|
|
1309
1392
|
/** Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. */
|
|
1310
1393
|
pageSize?: number;
|
|
@@ -1602,7 +1685,7 @@ declare namespace gapi.client {
|
|
|
1602
1685
|
fields?: string;
|
|
1603
1686
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1604
1687
|
key?: string;
|
|
1605
|
-
/** Required. The compilation result's name. */
|
|
1688
|
+
/** Required. The compilation result's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:GetCompilationResultRequest) */
|
|
1606
1689
|
name: string;
|
|
1607
1690
|
/** OAuth 2.0 token for the current user. */
|
|
1608
1691
|
oauth_token?: string;
|
|
@@ -1627,7 +1710,7 @@ declare namespace gapi.client {
|
|
|
1627
1710
|
callback?: string;
|
|
1628
1711
|
/** Selector specifying which fields to include in a partial response. */
|
|
1629
1712
|
fields?: string;
|
|
1630
|
-
/** Optional. Filter for the returned list. */
|
|
1713
|
+
/** Optional. Filter for the returned list. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ListCompilationResultsRequest) */
|
|
1631
1714
|
filter?: string;
|
|
1632
1715
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1633
1716
|
key?: string;
|
|
@@ -1707,7 +1790,7 @@ declare namespace gapi.client {
|
|
|
1707
1790
|
prettyPrint?: boolean;
|
|
1708
1791
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1709
1792
|
quotaUser?: string;
|
|
1710
|
-
/** Required. The ID to use for the release config, which will become the final component of the release config's resource name. */
|
|
1793
|
+
/** Required. The ID to use for the release config, which will become the final component of the release config's resource name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:CreateReleaseConfigRequest) */
|
|
1711
1794
|
releaseConfigId?: string;
|
|
1712
1795
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1713
1796
|
upload_protocol?: string;
|
|
@@ -1738,7 +1821,7 @@ declare namespace gapi.client {
|
|
|
1738
1821
|
prettyPrint?: boolean;
|
|
1739
1822
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1740
1823
|
quotaUser?: string;
|
|
1741
|
-
/** Required. The ID to use for the release config, which will become the final component of the release config's resource name. */
|
|
1824
|
+
/** Required. The ID to use for the release config, which will become the final component of the release config's resource name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:CreateReleaseConfigRequest) */
|
|
1742
1825
|
releaseConfigId?: string;
|
|
1743
1826
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1744
1827
|
upload_protocol?: string;
|
|
@@ -1761,7 +1844,7 @@ declare namespace gapi.client {
|
|
|
1761
1844
|
fields?: string;
|
|
1762
1845
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1763
1846
|
key?: string;
|
|
1764
|
-
/** Required. The release config's name. */
|
|
1847
|
+
/** Required. The release config's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:DeleteReleaseConfigRequest) */
|
|
1765
1848
|
name: string;
|
|
1766
1849
|
/** OAuth 2.0 token for the current user. */
|
|
1767
1850
|
oauth_token?: string;
|
|
@@ -1788,7 +1871,7 @@ declare namespace gapi.client {
|
|
|
1788
1871
|
fields?: string;
|
|
1789
1872
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1790
1873
|
key?: string;
|
|
1791
|
-
/** Required. The release config's name. */
|
|
1874
|
+
/** Required. The release config's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:GetReleaseConfigRequest) */
|
|
1792
1875
|
name: string;
|
|
1793
1876
|
/** OAuth 2.0 token for the current user. */
|
|
1794
1877
|
oauth_token?: string;
|
|
@@ -1819,7 +1902,7 @@ declare namespace gapi.client {
|
|
|
1819
1902
|
oauth_token?: string;
|
|
1820
1903
|
/** Optional. Maximum number of release configs to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. */
|
|
1821
1904
|
pageSize?: number;
|
|
1822
|
-
/** Optional. Page token received from a previous `ListReleaseConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReleaseConfigs`, with the exception of `page_size`, must match the call that provided the page token. */
|
|
1905
|
+
/** Optional. Page token received from a previous `ListReleaseConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReleaseConfigs`, with the exception of `page_size`, must match the call that provided the page token. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ListReleaseConfigsRequest) */
|
|
1823
1906
|
pageToken?: string;
|
|
1824
1907
|
/** Required. The repository in which to list release configs. Must be in the format `projects/*/locations/*/repositories/*`. */
|
|
1825
1908
|
parent: string;
|
|
@@ -3046,6 +3129,11 @@ declare namespace gapi.client {
|
|
|
3046
3129
|
upload_protocol?: string;
|
|
3047
3130
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3048
3131
|
uploadType?: string;
|
|
3132
|
+
/** Optional. Specifies the metadata to return for each directory entry. If unspecified, the default is `DIRECTORY_CONTENTS_VIEW_BASIC`. Currently the `DIRECTORY_CONTENTS_VIEW_METADATA` view is not supported by CMEK-protected workspaces. */
|
|
3133
|
+
view?:
|
|
3134
|
+
| 'DIRECTORY_CONTENTS_VIEW_UNSPECIFIED'
|
|
3135
|
+
| 'DIRECTORY_CONTENTS_VIEW_BASIC'
|
|
3136
|
+
| 'DIRECTORY_CONTENTS_VIEW_METADATA';
|
|
3049
3137
|
/** Required. The workspace's name. */
|
|
3050
3138
|
workspace: string;
|
|
3051
3139
|
}): Request<QueryDirectoryContentsResponse>;
|
|
@@ -3583,6 +3671,64 @@ declare namespace gapi.client {
|
|
|
3583
3671
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3584
3672
|
uploadType?: string;
|
|
3585
3673
|
}): Request<{}>;
|
|
3674
|
+
/** Deletes a single Repository asynchronously. */
|
|
3675
|
+
deleteLongRunning(request: {
|
|
3676
|
+
/** V1 error format. */
|
|
3677
|
+
'$.xgafv'?: '1' | '2';
|
|
3678
|
+
/** OAuth access token. */
|
|
3679
|
+
access_token?: string;
|
|
3680
|
+
/** Data format for response. */
|
|
3681
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3682
|
+
/** JSONP */
|
|
3683
|
+
callback?: string;
|
|
3684
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3685
|
+
fields?: string;
|
|
3686
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3687
|
+
key?: string;
|
|
3688
|
+
/** Required. The repository's name. */
|
|
3689
|
+
name: string;
|
|
3690
|
+
/** OAuth 2.0 token for the current user. */
|
|
3691
|
+
oauth_token?: string;
|
|
3692
|
+
/** Returns response with indentations and line breaks. */
|
|
3693
|
+
prettyPrint?: boolean;
|
|
3694
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3695
|
+
quotaUser?: string;
|
|
3696
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3697
|
+
upload_protocol?: string;
|
|
3698
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3699
|
+
uploadType?: string;
|
|
3700
|
+
/** Request body */
|
|
3701
|
+
resource: DeleteRepositoryLongRunningRequest;
|
|
3702
|
+
}): Request<Operation>;
|
|
3703
|
+
deleteLongRunning(
|
|
3704
|
+
request: {
|
|
3705
|
+
/** V1 error format. */
|
|
3706
|
+
'$.xgafv'?: '1' | '2';
|
|
3707
|
+
/** OAuth access token. */
|
|
3708
|
+
access_token?: string;
|
|
3709
|
+
/** Data format for response. */
|
|
3710
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3711
|
+
/** JSONP */
|
|
3712
|
+
callback?: string;
|
|
3713
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3714
|
+
fields?: string;
|
|
3715
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3716
|
+
key?: string;
|
|
3717
|
+
/** Required. The repository's name. */
|
|
3718
|
+
name: string;
|
|
3719
|
+
/** OAuth 2.0 token for the current user. */
|
|
3720
|
+
oauth_token?: string;
|
|
3721
|
+
/** Returns response with indentations and line breaks. */
|
|
3722
|
+
prettyPrint?: boolean;
|
|
3723
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3724
|
+
quotaUser?: string;
|
|
3725
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3726
|
+
upload_protocol?: string;
|
|
3727
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3728
|
+
uploadType?: string;
|
|
3729
|
+
},
|
|
3730
|
+
body: DeleteRepositoryLongRunningRequest,
|
|
3731
|
+
): Request<Operation>;
|
|
3586
3732
|
/** Fetches a Repository's history of commits. The Repository must not have a value for `git_remote_settings.url`. */
|
|
3587
3733
|
fetchHistory(request?: {
|
|
3588
3734
|
/** V1 error format. */
|
|
@@ -4007,7 +4153,7 @@ declare namespace gapi.client {
|
|
|
4007
4153
|
prettyPrint?: boolean;
|
|
4008
4154
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
4009
4155
|
quotaUser?: string;
|
|
4010
|
-
/** The ID to use for the TeamFolder, which will become the final component of the TeamFolder's resource name. */
|
|
4156
|
+
/** Deprecated: This field is not used. The resource name is generated automatically. The ID to use for the TeamFolder, which will become the final component of the TeamFolder's resource name. */
|
|
4011
4157
|
teamFolderId?: string;
|
|
4012
4158
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4013
4159
|
upload_protocol?: string;
|
|
@@ -4038,7 +4184,7 @@ declare namespace gapi.client {
|
|
|
4038
4184
|
prettyPrint?: boolean;
|
|
4039
4185
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
4040
4186
|
quotaUser?: string;
|
|
4041
|
-
/** The ID to use for the TeamFolder, which will become the final component of the TeamFolder's resource name. */
|
|
4187
|
+
/** Deprecated: This field is not used. The resource name is generated automatically. The ID to use for the TeamFolder, which will become the final component of the TeamFolder's resource name. */
|
|
4042
4188
|
teamFolderId?: string;
|
|
4043
4189
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4044
4190
|
upload_protocol?: string;
|
|
@@ -4074,6 +4220,64 @@ declare namespace gapi.client {
|
|
|
4074
4220
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4075
4221
|
uploadType?: string;
|
|
4076
4222
|
}): Request<{}>;
|
|
4223
|
+
/** Deletes a TeamFolder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs). */
|
|
4224
|
+
deleteTree(request: {
|
|
4225
|
+
/** V1 error format. */
|
|
4226
|
+
'$.xgafv'?: '1' | '2';
|
|
4227
|
+
/** OAuth access token. */
|
|
4228
|
+
access_token?: string;
|
|
4229
|
+
/** Data format for response. */
|
|
4230
|
+
alt?: 'json' | 'media' | 'proto';
|
|
4231
|
+
/** JSONP */
|
|
4232
|
+
callback?: string;
|
|
4233
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4234
|
+
fields?: string;
|
|
4235
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
4236
|
+
key?: string;
|
|
4237
|
+
/** Required. The TeamFolder's name. Format: projects/{project}/locations/{location}/teamFolders/{team_folder} */
|
|
4238
|
+
name: string;
|
|
4239
|
+
/** OAuth 2.0 token for the current user. */
|
|
4240
|
+
oauth_token?: string;
|
|
4241
|
+
/** Returns response with indentations and line breaks. */
|
|
4242
|
+
prettyPrint?: boolean;
|
|
4243
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
4244
|
+
quotaUser?: string;
|
|
4245
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4246
|
+
upload_protocol?: string;
|
|
4247
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4248
|
+
uploadType?: string;
|
|
4249
|
+
/** Request body */
|
|
4250
|
+
resource: DeleteTeamFolderTreeRequest;
|
|
4251
|
+
}): Request<Operation>;
|
|
4252
|
+
deleteTree(
|
|
4253
|
+
request: {
|
|
4254
|
+
/** V1 error format. */
|
|
4255
|
+
'$.xgafv'?: '1' | '2';
|
|
4256
|
+
/** OAuth access token. */
|
|
4257
|
+
access_token?: string;
|
|
4258
|
+
/** Data format for response. */
|
|
4259
|
+
alt?: 'json' | 'media' | 'proto';
|
|
4260
|
+
/** JSONP */
|
|
4261
|
+
callback?: string;
|
|
4262
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4263
|
+
fields?: string;
|
|
4264
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
4265
|
+
key?: string;
|
|
4266
|
+
/** Required. The TeamFolder's name. Format: projects/{project}/locations/{location}/teamFolders/{team_folder} */
|
|
4267
|
+
name: string;
|
|
4268
|
+
/** OAuth 2.0 token for the current user. */
|
|
4269
|
+
oauth_token?: string;
|
|
4270
|
+
/** Returns response with indentations and line breaks. */
|
|
4271
|
+
prettyPrint?: boolean;
|
|
4272
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
4273
|
+
quotaUser?: string;
|
|
4274
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4275
|
+
upload_protocol?: string;
|
|
4276
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4277
|
+
uploadType?: string;
|
|
4278
|
+
},
|
|
4279
|
+
body: DeleteTeamFolderTreeRequest,
|
|
4280
|
+
): Request<Operation>;
|
|
4077
4281
|
/** Fetches a single TeamFolder. */
|
|
4078
4282
|
get(request?: {
|
|
4079
4283
|
/** V1 error format. */
|
|
@@ -4204,13 +4408,13 @@ declare namespace gapi.client {
|
|
|
4204
4408
|
callback?: string;
|
|
4205
4409
|
/** Selector specifying which fields to include in a partial response. */
|
|
4206
4410
|
fields?: string;
|
|
4207
|
-
/** Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example:
|
|
4411
|
+
/** Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter="display_name="MyFolder""` */
|
|
4208
4412
|
filter?: string;
|
|
4209
4413
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
4210
4414
|
key?: string;
|
|
4211
4415
|
/** OAuth 2.0 token for the current user. */
|
|
4212
4416
|
oauth_token?: string;
|
|
4213
|
-
/** 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), `create_time`, last_modified_time. Examples:
|
|
4417
|
+
/** 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), `create_time`, last_modified_time. Examples: * `orderBy="display_name"` * `orderBy="display_name desc"` */
|
|
4214
4418
|
orderBy?: string;
|
|
4215
4419
|
/** Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. */
|
|
4216
4420
|
pageSize?: number;
|
|
@@ -4220,7 +4424,7 @@ declare namespace gapi.client {
|
|
|
4220
4424
|
prettyPrint?: boolean;
|
|
4221
4425
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
4222
4426
|
quotaUser?: string;
|
|
4223
|
-
/** Required.
|
|
4427
|
+
/** Required. Resource name of the TeamFolder to list contents for. Format: `projects/*/locations/*/teamFolders/*`. */
|
|
4224
4428
|
teamFolder: string;
|
|
4225
4429
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4226
4430
|
upload_protocol?: string;
|
|
@@ -4239,7 +4443,7 @@ declare namespace gapi.client {
|
|
|
4239
4443
|
callback?: string;
|
|
4240
4444
|
/** Selector specifying which fields to include in a partial response. */
|
|
4241
4445
|
fields?: string;
|
|
4242
|
-
/** Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example:
|
|
4446
|
+
/** Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter="display_name="MyFolder""` */
|
|
4243
4447
|
filter?: string;
|
|
4244
4448
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
4245
4449
|
key?: string;
|
|
@@ -4247,9 +4451,9 @@ declare namespace gapi.client {
|
|
|
4247
4451
|
location: string;
|
|
4248
4452
|
/** OAuth 2.0 token for the current user. */
|
|
4249
4453
|
oauth_token?: string;
|
|
4250
|
-
/** Optional. Field to additionally sort results by. Supported keywords: `display_name` (default), `create_time`, `last_modified_time`. Examples:
|
|
4454
|
+
/** Optional. Field to additionally sort results by. Supported keywords: `display_name` (default), `create_time`, `last_modified_time`. Examples: * `orderBy="display_name"` * `orderBy="display_name desc"` */
|
|
4251
4455
|
orderBy?: string;
|
|
4252
|
-
/** Optional. Maximum number of TeamFolders to return. The server may return fewer items than requested. If unspecified, the server will pick
|
|
4456
|
+
/** Optional. Maximum number of TeamFolders to return. The server may return fewer items than requested. If unspecified, the server will pick a default of page_size = 50. */
|
|
4253
4457
|
pageSize?: number;
|
|
4254
4458
|
/** Optional. Page token received from a previous `SearchTeamFolders` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchTeamFolders`, with the exception of `page_size`, must match the call that provided the page token. */
|
|
4255
4459
|
pageToken?: string;
|
|
@@ -4378,7 +4582,7 @@ declare namespace gapi.client {
|
|
|
4378
4582
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4379
4583
|
uploadType?: string;
|
|
4380
4584
|
}): Request<Config>;
|
|
4381
|
-
/** Lists information about the supported locations for this service. This method
|
|
4585
|
+
/** 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. */
|
|
4382
4586
|
list(request?: {
|
|
4383
4587
|
/** V1 error format. */
|
|
4384
4588
|
'$.xgafv'?: '1' | '2';
|
|
@@ -4388,7 +4592,7 @@ declare namespace gapi.client {
|
|
|
4388
4592
|
alt?: 'json' | 'media' | 'proto';
|
|
4389
4593
|
/** JSONP */
|
|
4390
4594
|
callback?: string;
|
|
4391
|
-
/** Optional. Do not use this field
|
|
4595
|
+
/** Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. */
|
|
4392
4596
|
extraLocationTypes?: string | string[];
|
|
4393
4597
|
/** Selector specifying which fields to include in a partial response. */
|
|
4394
4598
|
fields?: string;
|
|
@@ -4425,15 +4629,15 @@ declare namespace gapi.client {
|
|
|
4425
4629
|
callback?: string;
|
|
4426
4630
|
/** Selector specifying which fields to include in a partial response. */
|
|
4427
4631
|
fields?: string;
|
|
4428
|
-
/** Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example:
|
|
4632
|
+
/** Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter="display_name="MyFolder""` */
|
|
4429
4633
|
filter?: string;
|
|
4430
4634
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
4431
4635
|
key?: string;
|
|
4432
|
-
/** Required. Location of the user root folder
|
|
4636
|
+
/** Required. Location of the user root folder to list contents for. Format: projects/*/locations/* */
|
|
4433
4637
|
location: string;
|
|
4434
4638
|
/** OAuth 2.0 token for the current user. */
|
|
4435
4639
|
oauth_token?: string;
|
|
4436
|
-
/** 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:
|
|
4640
|
+
/** 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="display_name"` * `orderBy="display_name desc"` */
|
|
4437
4641
|
orderBy?: string;
|
|
4438
4642
|
/** Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. */
|
|
4439
4643
|
pageSize?: number;
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -11,6 +11,23 @@ Install typings for Dataform API:
|
|
|
11
11
|
npm install @types/gapi.client.dataform-v1beta1 --save-dev
|
|
12
12
|
```
|
|
13
13
|
|
|
14
|
+
## TypeScript 6.0+
|
|
15
|
+
|
|
16
|
+
TypeScript 6.0 changed `types` to default to `[]`. You must now explicitly list type packages in `tsconfig.json`:
|
|
17
|
+
|
|
18
|
+
```json
|
|
19
|
+
{
|
|
20
|
+
"compilerOptions": {
|
|
21
|
+
"types": [
|
|
22
|
+
"gapi",
|
|
23
|
+
"gapi.auth2",
|
|
24
|
+
"gapi.client",
|
|
25
|
+
"gapi.client.dataform-v1beta1"
|
|
26
|
+
]
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
```
|
|
30
|
+
|
|
14
31
|
## Usage
|
|
15
32
|
|
|
16
33
|
You need to initialize Google API client in your code:
|