@googleapis/dataform 14.1.0 → 16.0.0
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/CHANGELOG.md +28 -0
- package/build/tsconfig.tsbuildinfo +1 -1
- package/build/v1.d.ts +2085 -446
- package/build/v1.js +515 -0
- package/build/v1.js.map +1 -1
- package/build/v1beta1.d.ts +364 -55
- package/build/v1beta1.js +98 -0
- package/build/v1beta1.js.map +1 -1
- package/package.json +1 -1
- package/v1.ts +6880 -4002
- package/v1beta1.ts +600 -55
package/v1beta1.ts
CHANGED
|
@@ -420,7 +420,7 @@ export namespace dataform_v1beta1 {
|
|
|
420
420
|
*/
|
|
421
421
|
export interface Schema$CompilationError {
|
|
422
422
|
/**
|
|
423
|
-
* Output only. The identifier of the action where this error occurred, if available.
|
|
423
|
+
* 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)
|
|
424
424
|
*/
|
|
425
425
|
actionTarget?: Schema$Target;
|
|
426
426
|
/**
|
|
@@ -628,18 +628,49 @@ export namespace dataform_v1beta1 {
|
|
|
628
628
|
* Represents the delete file operation.
|
|
629
629
|
*/
|
|
630
630
|
export interface Schema$DeleteFile {}
|
|
631
|
+
/**
|
|
632
|
+
* `DeleteFolderTree` request message.
|
|
633
|
+
*/
|
|
634
|
+
export interface Schema$DeleteFolderTreeRequest {
|
|
635
|
+
/**
|
|
636
|
+
* 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.
|
|
637
|
+
*/
|
|
638
|
+
force?: boolean | null;
|
|
639
|
+
}
|
|
640
|
+
/**
|
|
641
|
+
* `DeleteRepositoryLongRunning` request message.
|
|
642
|
+
*/
|
|
643
|
+
export interface Schema$DeleteRepositoryLongRunningRequest {
|
|
644
|
+
/**
|
|
645
|
+
* 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.*
|
|
646
|
+
*/
|
|
647
|
+
force?: boolean | null;
|
|
648
|
+
}
|
|
649
|
+
/**
|
|
650
|
+
* `DeleteTeamFolderTree` request message.
|
|
651
|
+
*/
|
|
652
|
+
export interface Schema$DeleteTeamFolderTreeRequest {
|
|
653
|
+
/**
|
|
654
|
+
* 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.
|
|
655
|
+
*/
|
|
656
|
+
force?: boolean | null;
|
|
657
|
+
}
|
|
631
658
|
/**
|
|
632
659
|
* Represents a single entry in a directory.
|
|
633
660
|
*/
|
|
634
661
|
export interface Schema$DirectoryEntry {
|
|
635
662
|
/**
|
|
636
|
-
* A child directory in the directory.
|
|
663
|
+
* A child directory in the directory. The path is returned including the full folder structure from the root.
|
|
637
664
|
*/
|
|
638
665
|
directory?: string | null;
|
|
639
666
|
/**
|
|
640
|
-
* A file in the directory.
|
|
667
|
+
* A file in the directory. The path is returned including the full folder structure from the root.
|
|
641
668
|
*/
|
|
642
669
|
file?: string | null;
|
|
670
|
+
/**
|
|
671
|
+
* Entry with metadata.
|
|
672
|
+
*/
|
|
673
|
+
metadata?: Schema$FilesystemEntryMetadata;
|
|
643
674
|
}
|
|
644
675
|
/**
|
|
645
676
|
* Client-facing representation of a directory entry in search results.
|
|
@@ -763,12 +794,25 @@ export namespace dataform_v1beta1 {
|
|
|
763
794
|
*/
|
|
764
795
|
path?: string | null;
|
|
765
796
|
}
|
|
797
|
+
/**
|
|
798
|
+
* Represents metadata for a single entry in a filesystem.
|
|
799
|
+
*/
|
|
800
|
+
export interface Schema$FilesystemEntryMetadata {
|
|
801
|
+
/**
|
|
802
|
+
* Output only. Provides the size of the entry in bytes. For directories, this will be 0.
|
|
803
|
+
*/
|
|
804
|
+
sizeBytes?: string | null;
|
|
805
|
+
/**
|
|
806
|
+
* Output only. Represents the time of the last modification of the entry.
|
|
807
|
+
*/
|
|
808
|
+
updateTime?: string | null;
|
|
809
|
+
}
|
|
766
810
|
/**
|
|
767
811
|
* Represents a Dataform Folder. This is a resource that is used to organize Files and other Folders and provide hierarchical access controls.
|
|
768
812
|
*/
|
|
769
813
|
export interface Schema$Folder {
|
|
770
814
|
/**
|
|
771
|
-
* 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
|
|
815
|
+
* 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.
|
|
772
816
|
*/
|
|
773
817
|
containingFolder?: string | null;
|
|
774
818
|
/**
|
|
@@ -822,9 +866,13 @@ export namespace dataform_v1beta1 {
|
|
|
822
866
|
*/
|
|
823
867
|
authenticationTokenSecretVersion?: string | null;
|
|
824
868
|
/**
|
|
825
|
-
*
|
|
869
|
+
* Optional. The Git remote's default branch name. If not set `main` will be used.
|
|
826
870
|
*/
|
|
827
871
|
defaultBranch?: string | null;
|
|
872
|
+
/**
|
|
873
|
+
* 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`.
|
|
874
|
+
*/
|
|
875
|
+
effectiveDefaultBranch?: string | null;
|
|
828
876
|
/**
|
|
829
877
|
* Optional. Authentication fields for remote uris using SSH protocol.
|
|
830
878
|
*/
|
|
@@ -956,7 +1004,7 @@ export namespace dataform_v1beta1 {
|
|
|
956
1004
|
*/
|
|
957
1005
|
nextPageToken?: string | null;
|
|
958
1006
|
/**
|
|
959
|
-
* Locations which could not be reached.
|
|
1007
|
+
* Locations which could not be reached. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ListCompilationResultsResponse)
|
|
960
1008
|
*/
|
|
961
1009
|
unreachable?: string[] | null;
|
|
962
1010
|
}
|
|
@@ -1003,7 +1051,7 @@ export namespace dataform_v1beta1 {
|
|
|
1003
1051
|
*/
|
|
1004
1052
|
releaseConfigs?: Schema$ReleaseConfig[];
|
|
1005
1053
|
/**
|
|
1006
|
-
* Locations which could not be reached.
|
|
1054
|
+
* Locations which could not be reached. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ListReleaseConfigsResponse)
|
|
1007
1055
|
*/
|
|
1008
1056
|
unreachable?: string[] | null;
|
|
1009
1057
|
}
|
|
@@ -1173,7 +1221,7 @@ export namespace dataform_v1beta1 {
|
|
|
1173
1221
|
*/
|
|
1174
1222
|
export interface Schema$MoveFolderRequest {
|
|
1175
1223
|
/**
|
|
1176
|
-
*
|
|
1224
|
+
* Optional. The name of the Folder, TeamFolder, or root location to move the Folder to. Can be in the format of: "" to move into the root User folder, `projects/x/locations/x/folders/x`, `projects/x/locations/x/teamFolders/x`
|
|
1177
1225
|
*/
|
|
1178
1226
|
destinationContainingFolder?: string | null;
|
|
1179
1227
|
}
|
|
@@ -1182,7 +1230,7 @@ export namespace dataform_v1beta1 {
|
|
|
1182
1230
|
*/
|
|
1183
1231
|
export interface Schema$MoveRepositoryRequest {
|
|
1184
1232
|
/**
|
|
1185
|
-
*
|
|
1233
|
+
* Optional. The name of the Folder, TeamFolder, or root location to move the repository to. Can be in the format of: "" to move into the root User folder, `projects/x/locations/x/folders/x`, `projects/x/locations/x/teamFolders/x`
|
|
1186
1234
|
*/
|
|
1187
1235
|
destinationContainingFolder?: string | null;
|
|
1188
1236
|
}
|
|
@@ -1216,7 +1264,7 @@ export namespace dataform_v1beta1 {
|
|
|
1216
1264
|
*/
|
|
1217
1265
|
contents?: string | null;
|
|
1218
1266
|
/**
|
|
1219
|
-
* Output only. The ID of the
|
|
1267
|
+
* 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.
|
|
1220
1268
|
*/
|
|
1221
1269
|
jobId?: string | null;
|
|
1222
1270
|
}
|
|
@@ -1515,7 +1563,7 @@ export namespace dataform_v1beta1 {
|
|
|
1515
1563
|
*/
|
|
1516
1564
|
clusterExpressions?: string[] | null;
|
|
1517
1565
|
/**
|
|
1518
|
-
* Optional. The connection specifying the credentials to be used to read and write to external storage, such as Cloud Storage. The connection can have the form `{project\}.{location\}.{connection_id\}` or `projects/{project\}/locations/{location\}/connections/{connection_id\}
|
|
1566
|
+
* Optional. The connection specifying the credentials to be used to read and write to external storage, such as Cloud Storage. The connection can have the form `{project\}.{location\}.{connection_id\}` or `projects/{project\}/locations/{location\}/connections/{connection_id\}`, or be set to DEFAULT.
|
|
1519
1567
|
*/
|
|
1520
1568
|
connection?: string | null;
|
|
1521
1569
|
/**
|
|
@@ -1617,7 +1665,7 @@ export namespace dataform_v1beta1 {
|
|
|
1617
1665
|
*/
|
|
1618
1666
|
gitCommitish?: string | null;
|
|
1619
1667
|
/**
|
|
1620
|
-
* 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.
|
|
1668
|
+
* 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)
|
|
1621
1669
|
*/
|
|
1622
1670
|
internalMetadata?: string | null;
|
|
1623
1671
|
/**
|
|
@@ -2500,7 +2548,7 @@ export namespace dataform_v1beta1 {
|
|
|
2500
2548
|
}
|
|
2501
2549
|
|
|
2502
2550
|
/**
|
|
2503
|
-
* Lists information about the supported locations for this service.
|
|
2551
|
+
* 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.
|
|
2504
2552
|
* @example
|
|
2505
2553
|
* ```js
|
|
2506
2554
|
* // Before running the sample:
|
|
@@ -2533,7 +2581,7 @@ export namespace dataform_v1beta1 {
|
|
|
2533
2581
|
*
|
|
2534
2582
|
* // Do the magic
|
|
2535
2583
|
* const res = await dataform.projects.locations.list({
|
|
2536
|
-
* // Optional. Do not use this field
|
|
2584
|
+
* // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.
|
|
2537
2585
|
* extraLocationTypes: 'placeholder-value',
|
|
2538
2586
|
* // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
|
|
2539
2587
|
* filter: 'placeholder-value',
|
|
@@ -2684,11 +2732,11 @@ export namespace dataform_v1beta1 {
|
|
|
2684
2732
|
*
|
|
2685
2733
|
* // Do the magic
|
|
2686
2734
|
* const res = await dataform.projects.locations.queryUserRootContents({
|
|
2687
|
-
* // Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example:
|
|
2735
|
+
* // Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter="display_name="MyFolder""`
|
|
2688
2736
|
* filter: 'placeholder-value',
|
|
2689
|
-
* // Required. Location of the user root folder
|
|
2737
|
+
* // Required. Location of the user root folder to list contents for. Format: projects/x/locations/x
|
|
2690
2738
|
* location: 'projects/my-project/locations/my-location',
|
|
2691
|
-
* // 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:
|
|
2739
|
+
* // 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"`
|
|
2692
2740
|
* orderBy: 'placeholder-value',
|
|
2693
2741
|
* // Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
|
|
2694
2742
|
* pageSize: 'placeholder-value',
|
|
@@ -2970,7 +3018,7 @@ export namespace dataform_v1beta1 {
|
|
|
2970
3018
|
}
|
|
2971
3019
|
export interface Params$Resource$Projects$Locations$List extends StandardParameters {
|
|
2972
3020
|
/**
|
|
2973
|
-
* Optional. Do not use this field
|
|
3021
|
+
* Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.
|
|
2974
3022
|
*/
|
|
2975
3023
|
extraLocationTypes?: string[];
|
|
2976
3024
|
/**
|
|
@@ -2992,15 +3040,15 @@ export namespace dataform_v1beta1 {
|
|
|
2992
3040
|
}
|
|
2993
3041
|
export interface Params$Resource$Projects$Locations$Queryuserrootcontents extends StandardParameters {
|
|
2994
3042
|
/**
|
|
2995
|
-
* Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example:
|
|
3043
|
+
* Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter="display_name="MyFolder""`
|
|
2996
3044
|
*/
|
|
2997
3045
|
filter?: string;
|
|
2998
3046
|
/**
|
|
2999
|
-
* Required. Location of the user root folder
|
|
3047
|
+
* Required. Location of the user root folder to list contents for. Format: projects/x/locations/x
|
|
3000
3048
|
*/
|
|
3001
3049
|
location?: string;
|
|
3002
3050
|
/**
|
|
3003
|
-
* 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:
|
|
3051
|
+
* 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"`
|
|
3004
3052
|
*/
|
|
3005
3053
|
orderBy?: string;
|
|
3006
3054
|
/**
|
|
@@ -3068,7 +3116,7 @@ export namespace dataform_v1beta1 {
|
|
|
3068
3116
|
*
|
|
3069
3117
|
* // Do the magic
|
|
3070
3118
|
* const res = await dataform.projects.locations.folders.create({
|
|
3071
|
-
* // The ID to use for the Folder, which will become the final component of the Folder's resource name.
|
|
3119
|
+
* // 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.
|
|
3072
3120
|
* folderId: 'placeholder-value',
|
|
3073
3121
|
* // Required. The location in which to create the Folder. Must be in the format `projects/x/locations/x`.
|
|
3074
3122
|
* parent: 'projects/my-project/locations/my-location',
|
|
@@ -3333,6 +3381,158 @@ export namespace dataform_v1beta1 {
|
|
|
3333
3381
|
}
|
|
3334
3382
|
}
|
|
3335
3383
|
|
|
3384
|
+
/**
|
|
3385
|
+
* Deletes a Folder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).
|
|
3386
|
+
* @example
|
|
3387
|
+
* ```js
|
|
3388
|
+
* // Before running the sample:
|
|
3389
|
+
* // - Enable the API at:
|
|
3390
|
+
* // https://console.developers.google.com/apis/api/dataform.googleapis.com
|
|
3391
|
+
* // - Login into gcloud by running:
|
|
3392
|
+
* // ```sh
|
|
3393
|
+
* // $ gcloud auth application-default login
|
|
3394
|
+
* // ```
|
|
3395
|
+
* // - Install the npm module by running:
|
|
3396
|
+
* // ```sh
|
|
3397
|
+
* // $ npm install googleapis
|
|
3398
|
+
* // ```
|
|
3399
|
+
*
|
|
3400
|
+
* const {google} = require('googleapis');
|
|
3401
|
+
* const dataform = google.dataform('v1beta1');
|
|
3402
|
+
*
|
|
3403
|
+
* async function main() {
|
|
3404
|
+
* const auth = new google.auth.GoogleAuth({
|
|
3405
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3406
|
+
* scopes: [
|
|
3407
|
+
* 'https://www.googleapis.com/auth/bigquery',
|
|
3408
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
3409
|
+
* ],
|
|
3410
|
+
* });
|
|
3411
|
+
*
|
|
3412
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
3413
|
+
* const authClient = await auth.getClient();
|
|
3414
|
+
* google.options({auth: authClient});
|
|
3415
|
+
*
|
|
3416
|
+
* // Do the magic
|
|
3417
|
+
* const res = await dataform.projects.locations.folders.deleteTree({
|
|
3418
|
+
* // Required. The Folder's name. Format: projects/{project\}/locations/{location\}/folders/{folder\}
|
|
3419
|
+
* name: 'projects/my-project/locations/my-location/folders/my-folder',
|
|
3420
|
+
*
|
|
3421
|
+
* // Request body metadata
|
|
3422
|
+
* requestBody: {
|
|
3423
|
+
* // request body parameters
|
|
3424
|
+
* // {
|
|
3425
|
+
* // "force": false
|
|
3426
|
+
* // }
|
|
3427
|
+
* },
|
|
3428
|
+
* });
|
|
3429
|
+
* console.log(res.data);
|
|
3430
|
+
*
|
|
3431
|
+
* // Example response
|
|
3432
|
+
* // {
|
|
3433
|
+
* // "done": false,
|
|
3434
|
+
* // "error": {},
|
|
3435
|
+
* // "metadata": {},
|
|
3436
|
+
* // "name": "my_name",
|
|
3437
|
+
* // "response": {}
|
|
3438
|
+
* // }
|
|
3439
|
+
* }
|
|
3440
|
+
*
|
|
3441
|
+
* main().catch(e => {
|
|
3442
|
+
* console.error(e);
|
|
3443
|
+
* throw e;
|
|
3444
|
+
* });
|
|
3445
|
+
*
|
|
3446
|
+
* ```
|
|
3447
|
+
*
|
|
3448
|
+
* @param params - Parameters for request
|
|
3449
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3450
|
+
* @param callback - Optional callback that handles the response.
|
|
3451
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3452
|
+
*/
|
|
3453
|
+
deleteTree(
|
|
3454
|
+
params: Params$Resource$Projects$Locations$Folders$Deletetree,
|
|
3455
|
+
options: StreamMethodOptions
|
|
3456
|
+
): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
3457
|
+
deleteTree(
|
|
3458
|
+
params?: Params$Resource$Projects$Locations$Folders$Deletetree,
|
|
3459
|
+
options?: MethodOptions
|
|
3460
|
+
): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
3461
|
+
deleteTree(
|
|
3462
|
+
params: Params$Resource$Projects$Locations$Folders$Deletetree,
|
|
3463
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
3464
|
+
callback: BodyResponseCallback<Readable>
|
|
3465
|
+
): void;
|
|
3466
|
+
deleteTree(
|
|
3467
|
+
params: Params$Resource$Projects$Locations$Folders$Deletetree,
|
|
3468
|
+
options: MethodOptions | BodyResponseCallback<Schema$Operation>,
|
|
3469
|
+
callback: BodyResponseCallback<Schema$Operation>
|
|
3470
|
+
): void;
|
|
3471
|
+
deleteTree(
|
|
3472
|
+
params: Params$Resource$Projects$Locations$Folders$Deletetree,
|
|
3473
|
+
callback: BodyResponseCallback<Schema$Operation>
|
|
3474
|
+
): void;
|
|
3475
|
+
deleteTree(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
3476
|
+
deleteTree(
|
|
3477
|
+
paramsOrCallback?:
|
|
3478
|
+
| Params$Resource$Projects$Locations$Folders$Deletetree
|
|
3479
|
+
| BodyResponseCallback<Schema$Operation>
|
|
3480
|
+
| BodyResponseCallback<Readable>,
|
|
3481
|
+
optionsOrCallback?:
|
|
3482
|
+
| MethodOptions
|
|
3483
|
+
| StreamMethodOptions
|
|
3484
|
+
| BodyResponseCallback<Schema$Operation>
|
|
3485
|
+
| BodyResponseCallback<Readable>,
|
|
3486
|
+
callback?:
|
|
3487
|
+
| BodyResponseCallback<Schema$Operation>
|
|
3488
|
+
| BodyResponseCallback<Readable>
|
|
3489
|
+
):
|
|
3490
|
+
| void
|
|
3491
|
+
| Promise<GaxiosResponseWithHTTP2<Schema$Operation>>
|
|
3492
|
+
| Promise<GaxiosResponseWithHTTP2<Readable>> {
|
|
3493
|
+
let params = (paramsOrCallback ||
|
|
3494
|
+
{}) as Params$Resource$Projects$Locations$Folders$Deletetree;
|
|
3495
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
3496
|
+
|
|
3497
|
+
if (typeof paramsOrCallback === 'function') {
|
|
3498
|
+
callback = paramsOrCallback;
|
|
3499
|
+
params = {} as Params$Resource$Projects$Locations$Folders$Deletetree;
|
|
3500
|
+
options = {};
|
|
3501
|
+
}
|
|
3502
|
+
|
|
3503
|
+
if (typeof optionsOrCallback === 'function') {
|
|
3504
|
+
callback = optionsOrCallback;
|
|
3505
|
+
options = {};
|
|
3506
|
+
}
|
|
3507
|
+
|
|
3508
|
+
const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/';
|
|
3509
|
+
const parameters = {
|
|
3510
|
+
options: Object.assign(
|
|
3511
|
+
{
|
|
3512
|
+
url: (rootUrl + '/v1beta1/{+name}:deleteTree').replace(
|
|
3513
|
+
/([^:]\/)\/+/g,
|
|
3514
|
+
'$1'
|
|
3515
|
+
),
|
|
3516
|
+
method: 'POST',
|
|
3517
|
+
apiVersion: '',
|
|
3518
|
+
},
|
|
3519
|
+
options
|
|
3520
|
+
),
|
|
3521
|
+
params,
|
|
3522
|
+
requiredParams: ['name'],
|
|
3523
|
+
pathParams: ['name'],
|
|
3524
|
+
context: this.context,
|
|
3525
|
+
};
|
|
3526
|
+
if (callback) {
|
|
3527
|
+
createAPIRequest<Schema$Operation>(
|
|
3528
|
+
parameters,
|
|
3529
|
+
callback as BodyResponseCallback<unknown>
|
|
3530
|
+
);
|
|
3531
|
+
} else {
|
|
3532
|
+
return createAPIRequest<Schema$Operation>(parameters);
|
|
3533
|
+
}
|
|
3534
|
+
}
|
|
3535
|
+
|
|
3336
3536
|
/**
|
|
3337
3537
|
* Fetches a single Folder.
|
|
3338
3538
|
* @example
|
|
@@ -3968,11 +4168,11 @@ export namespace dataform_v1beta1 {
|
|
|
3968
4168
|
*
|
|
3969
4169
|
* // Do the magic
|
|
3970
4170
|
* const res = await dataform.projects.locations.folders.queryFolderContents({
|
|
3971
|
-
* // Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example:
|
|
4171
|
+
* // Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter="display_name="MyFolder""`
|
|
3972
4172
|
* filter: 'placeholder-value',
|
|
3973
|
-
* // Required.
|
|
4173
|
+
* // Required. Resource name of the Folder to list contents for. Format: projects/x/locations/x/folders/x
|
|
3974
4174
|
* folder: 'projects/my-project/locations/my-location/folders/my-folder',
|
|
3975
|
-
* // 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:
|
|
4175
|
+
* // 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"`
|
|
3976
4176
|
* orderBy: 'placeholder-value',
|
|
3977
4177
|
* // Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
|
|
3978
4178
|
* pageSize: 'placeholder-value',
|
|
@@ -4394,7 +4594,7 @@ export namespace dataform_v1beta1 {
|
|
|
4394
4594
|
|
|
4395
4595
|
export interface Params$Resource$Projects$Locations$Folders$Create extends StandardParameters {
|
|
4396
4596
|
/**
|
|
4397
|
-
* The ID to use for the Folder, which will become the final component of the Folder's resource name.
|
|
4597
|
+
* 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.
|
|
4398
4598
|
*/
|
|
4399
4599
|
folderId?: string;
|
|
4400
4600
|
/**
|
|
@@ -4413,6 +4613,17 @@ export namespace dataform_v1beta1 {
|
|
|
4413
4613
|
*/
|
|
4414
4614
|
name?: string;
|
|
4415
4615
|
}
|
|
4616
|
+
export interface Params$Resource$Projects$Locations$Folders$Deletetree extends StandardParameters {
|
|
4617
|
+
/**
|
|
4618
|
+
* Required. The Folder's name. Format: projects/{project\}/locations/{location\}/folders/{folder\}
|
|
4619
|
+
*/
|
|
4620
|
+
name?: string;
|
|
4621
|
+
|
|
4622
|
+
/**
|
|
4623
|
+
* Request body metadata
|
|
4624
|
+
*/
|
|
4625
|
+
requestBody?: Schema$DeleteFolderTreeRequest;
|
|
4626
|
+
}
|
|
4416
4627
|
export interface Params$Resource$Projects$Locations$Folders$Get extends StandardParameters {
|
|
4417
4628
|
/**
|
|
4418
4629
|
* Required. The Folder's name.
|
|
@@ -4457,15 +4668,15 @@ export namespace dataform_v1beta1 {
|
|
|
4457
4668
|
}
|
|
4458
4669
|
export interface Params$Resource$Projects$Locations$Folders$Queryfoldercontents extends StandardParameters {
|
|
4459
4670
|
/**
|
|
4460
|
-
* Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example:
|
|
4671
|
+
* Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter="display_name="MyFolder""`
|
|
4461
4672
|
*/
|
|
4462
4673
|
filter?: string;
|
|
4463
4674
|
/**
|
|
4464
|
-
* Required.
|
|
4675
|
+
* Required. Resource name of the Folder to list contents for. Format: projects/x/locations/x/folders/x
|
|
4465
4676
|
*/
|
|
4466
4677
|
folder?: string;
|
|
4467
4678
|
/**
|
|
4468
|
-
* 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:
|
|
4679
|
+
* 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"`
|
|
4469
4680
|
*/
|
|
4470
4681
|
orderBy?: string;
|
|
4471
4682
|
/**
|
|
@@ -5775,6 +5986,159 @@ export namespace dataform_v1beta1 {
|
|
|
5775
5986
|
}
|
|
5776
5987
|
}
|
|
5777
5988
|
|
|
5989
|
+
/**
|
|
5990
|
+
* Deletes a single Repository asynchronously.
|
|
5991
|
+
* @example
|
|
5992
|
+
* ```js
|
|
5993
|
+
* // Before running the sample:
|
|
5994
|
+
* // - Enable the API at:
|
|
5995
|
+
* // https://console.developers.google.com/apis/api/dataform.googleapis.com
|
|
5996
|
+
* // - Login into gcloud by running:
|
|
5997
|
+
* // ```sh
|
|
5998
|
+
* // $ gcloud auth application-default login
|
|
5999
|
+
* // ```
|
|
6000
|
+
* // - Install the npm module by running:
|
|
6001
|
+
* // ```sh
|
|
6002
|
+
* // $ npm install googleapis
|
|
6003
|
+
* // ```
|
|
6004
|
+
*
|
|
6005
|
+
* const {google} = require('googleapis');
|
|
6006
|
+
* const dataform = google.dataform('v1beta1');
|
|
6007
|
+
*
|
|
6008
|
+
* async function main() {
|
|
6009
|
+
* const auth = new google.auth.GoogleAuth({
|
|
6010
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
6011
|
+
* scopes: [
|
|
6012
|
+
* 'https://www.googleapis.com/auth/bigquery',
|
|
6013
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
6014
|
+
* ],
|
|
6015
|
+
* });
|
|
6016
|
+
*
|
|
6017
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
6018
|
+
* const authClient = await auth.getClient();
|
|
6019
|
+
* google.options({auth: authClient});
|
|
6020
|
+
*
|
|
6021
|
+
* // Do the magic
|
|
6022
|
+
* const res = await dataform.projects.locations.repositories.deleteLongRunning({
|
|
6023
|
+
* // Required. The repository's name.
|
|
6024
|
+
* name: 'projects/my-project/locations/my-location/repositories/my-repositorie',
|
|
6025
|
+
*
|
|
6026
|
+
* // Request body metadata
|
|
6027
|
+
* requestBody: {
|
|
6028
|
+
* // request body parameters
|
|
6029
|
+
* // {
|
|
6030
|
+
* // "force": false
|
|
6031
|
+
* // }
|
|
6032
|
+
* },
|
|
6033
|
+
* });
|
|
6034
|
+
* console.log(res.data);
|
|
6035
|
+
*
|
|
6036
|
+
* // Example response
|
|
6037
|
+
* // {
|
|
6038
|
+
* // "done": false,
|
|
6039
|
+
* // "error": {},
|
|
6040
|
+
* // "metadata": {},
|
|
6041
|
+
* // "name": "my_name",
|
|
6042
|
+
* // "response": {}
|
|
6043
|
+
* // }
|
|
6044
|
+
* }
|
|
6045
|
+
*
|
|
6046
|
+
* main().catch(e => {
|
|
6047
|
+
* console.error(e);
|
|
6048
|
+
* throw e;
|
|
6049
|
+
* });
|
|
6050
|
+
*
|
|
6051
|
+
* ```
|
|
6052
|
+
*
|
|
6053
|
+
* @param params - Parameters for request
|
|
6054
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6055
|
+
* @param callback - Optional callback that handles the response.
|
|
6056
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6057
|
+
*/
|
|
6058
|
+
deleteLongRunning(
|
|
6059
|
+
params: Params$Resource$Projects$Locations$Repositories$Deletelongrunning,
|
|
6060
|
+
options: StreamMethodOptions
|
|
6061
|
+
): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
6062
|
+
deleteLongRunning(
|
|
6063
|
+
params?: Params$Resource$Projects$Locations$Repositories$Deletelongrunning,
|
|
6064
|
+
options?: MethodOptions
|
|
6065
|
+
): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
6066
|
+
deleteLongRunning(
|
|
6067
|
+
params: Params$Resource$Projects$Locations$Repositories$Deletelongrunning,
|
|
6068
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
6069
|
+
callback: BodyResponseCallback<Readable>
|
|
6070
|
+
): void;
|
|
6071
|
+
deleteLongRunning(
|
|
6072
|
+
params: Params$Resource$Projects$Locations$Repositories$Deletelongrunning,
|
|
6073
|
+
options: MethodOptions | BodyResponseCallback<Schema$Operation>,
|
|
6074
|
+
callback: BodyResponseCallback<Schema$Operation>
|
|
6075
|
+
): void;
|
|
6076
|
+
deleteLongRunning(
|
|
6077
|
+
params: Params$Resource$Projects$Locations$Repositories$Deletelongrunning,
|
|
6078
|
+
callback: BodyResponseCallback<Schema$Operation>
|
|
6079
|
+
): void;
|
|
6080
|
+
deleteLongRunning(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
6081
|
+
deleteLongRunning(
|
|
6082
|
+
paramsOrCallback?:
|
|
6083
|
+
| Params$Resource$Projects$Locations$Repositories$Deletelongrunning
|
|
6084
|
+
| BodyResponseCallback<Schema$Operation>
|
|
6085
|
+
| BodyResponseCallback<Readable>,
|
|
6086
|
+
optionsOrCallback?:
|
|
6087
|
+
| MethodOptions
|
|
6088
|
+
| StreamMethodOptions
|
|
6089
|
+
| BodyResponseCallback<Schema$Operation>
|
|
6090
|
+
| BodyResponseCallback<Readable>,
|
|
6091
|
+
callback?:
|
|
6092
|
+
| BodyResponseCallback<Schema$Operation>
|
|
6093
|
+
| BodyResponseCallback<Readable>
|
|
6094
|
+
):
|
|
6095
|
+
| void
|
|
6096
|
+
| Promise<GaxiosResponseWithHTTP2<Schema$Operation>>
|
|
6097
|
+
| Promise<GaxiosResponseWithHTTP2<Readable>> {
|
|
6098
|
+
let params = (paramsOrCallback ||
|
|
6099
|
+
{}) as Params$Resource$Projects$Locations$Repositories$Deletelongrunning;
|
|
6100
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
6101
|
+
|
|
6102
|
+
if (typeof paramsOrCallback === 'function') {
|
|
6103
|
+
callback = paramsOrCallback;
|
|
6104
|
+
params =
|
|
6105
|
+
{} as Params$Resource$Projects$Locations$Repositories$Deletelongrunning;
|
|
6106
|
+
options = {};
|
|
6107
|
+
}
|
|
6108
|
+
|
|
6109
|
+
if (typeof optionsOrCallback === 'function') {
|
|
6110
|
+
callback = optionsOrCallback;
|
|
6111
|
+
options = {};
|
|
6112
|
+
}
|
|
6113
|
+
|
|
6114
|
+
const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/';
|
|
6115
|
+
const parameters = {
|
|
6116
|
+
options: Object.assign(
|
|
6117
|
+
{
|
|
6118
|
+
url: (rootUrl + '/v1beta1/{+name}:deleteLongRunning').replace(
|
|
6119
|
+
/([^:]\/)\/+/g,
|
|
6120
|
+
'$1'
|
|
6121
|
+
),
|
|
6122
|
+
method: 'POST',
|
|
6123
|
+
apiVersion: '',
|
|
6124
|
+
},
|
|
6125
|
+
options
|
|
6126
|
+
),
|
|
6127
|
+
params,
|
|
6128
|
+
requiredParams: ['name'],
|
|
6129
|
+
pathParams: ['name'],
|
|
6130
|
+
context: this.context,
|
|
6131
|
+
};
|
|
6132
|
+
if (callback) {
|
|
6133
|
+
createAPIRequest<Schema$Operation>(
|
|
6134
|
+
parameters,
|
|
6135
|
+
callback as BodyResponseCallback<unknown>
|
|
6136
|
+
);
|
|
6137
|
+
} else {
|
|
6138
|
+
return createAPIRequest<Schema$Operation>(parameters);
|
|
6139
|
+
}
|
|
6140
|
+
}
|
|
6141
|
+
|
|
5778
6142
|
/**
|
|
5779
6143
|
* Fetches a Repository's history of commits. The Repository must not have a value for `git_remote_settings.url`.
|
|
5780
6144
|
* @example
|
|
@@ -7506,6 +7870,17 @@ export namespace dataform_v1beta1 {
|
|
|
7506
7870
|
*/
|
|
7507
7871
|
name?: string;
|
|
7508
7872
|
}
|
|
7873
|
+
export interface Params$Resource$Projects$Locations$Repositories$Deletelongrunning extends StandardParameters {
|
|
7874
|
+
/**
|
|
7875
|
+
* Required. The repository's name.
|
|
7876
|
+
*/
|
|
7877
|
+
name?: string;
|
|
7878
|
+
|
|
7879
|
+
/**
|
|
7880
|
+
* Request body metadata
|
|
7881
|
+
*/
|
|
7882
|
+
requestBody?: Schema$DeleteRepositoryLongRunningRequest;
|
|
7883
|
+
}
|
|
7509
7884
|
export interface Params$Resource$Projects$Locations$Repositories$Fetchhistory extends StandardParameters {
|
|
7510
7885
|
/**
|
|
7511
7886
|
* Required. The repository's name.
|
|
@@ -7863,7 +8238,7 @@ export namespace dataform_v1beta1 {
|
|
|
7863
8238
|
* // Do the magic
|
|
7864
8239
|
* const res =
|
|
7865
8240
|
* await dataform.projects.locations.repositories.compilationResults.get({
|
|
7866
|
-
* // Required. The compilation result's name.
|
|
8241
|
+
* // Required. The compilation result's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:GetCompilationResultRequest)
|
|
7867
8242
|
* name: 'projects/my-project/locations/my-location/repositories/my-repositorie/compilationResults/my-compilationResult',
|
|
7868
8243
|
* });
|
|
7869
8244
|
* console.log(res.data);
|
|
@@ -8013,7 +8388,7 @@ export namespace dataform_v1beta1 {
|
|
|
8013
8388
|
* // Do the magic
|
|
8014
8389
|
* const res =
|
|
8015
8390
|
* await dataform.projects.locations.repositories.compilationResults.list({
|
|
8016
|
-
* // Optional. Filter for the returned list.
|
|
8391
|
+
* // Optional. Filter for the returned list. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ListCompilationResultsRequest)
|
|
8017
8392
|
* filter: 'placeholder-value',
|
|
8018
8393
|
* // 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.
|
|
8019
8394
|
* orderBy: 'placeholder-value',
|
|
@@ -8310,13 +8685,13 @@ export namespace dataform_v1beta1 {
|
|
|
8310
8685
|
}
|
|
8311
8686
|
export interface Params$Resource$Projects$Locations$Repositories$Compilationresults$Get extends StandardParameters {
|
|
8312
8687
|
/**
|
|
8313
|
-
* Required. The compilation result's name.
|
|
8688
|
+
* Required. The compilation result's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:GetCompilationResultRequest)
|
|
8314
8689
|
*/
|
|
8315
8690
|
name?: string;
|
|
8316
8691
|
}
|
|
8317
8692
|
export interface Params$Resource$Projects$Locations$Repositories$Compilationresults$List extends StandardParameters {
|
|
8318
8693
|
/**
|
|
8319
|
-
* Optional. Filter for the returned list.
|
|
8694
|
+
* Optional. Filter for the returned list. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ListCompilationResultsRequest)
|
|
8320
8695
|
*/
|
|
8321
8696
|
filter?: string;
|
|
8322
8697
|
/**
|
|
@@ -8399,7 +8774,7 @@ export namespace dataform_v1beta1 {
|
|
|
8399
8774
|
* // Required. The repository in which to create the release config. Must be in the format `projects/x/locations/x/repositories/x`.
|
|
8400
8775
|
* parent:
|
|
8401
8776
|
* 'projects/my-project/locations/my-location/repositories/my-repositorie',
|
|
8402
|
-
* // Required. The ID to use for the release config, which will become the final component of the release config's resource name.
|
|
8777
|
+
* // 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)
|
|
8403
8778
|
* releaseConfigId: 'placeholder-value',
|
|
8404
8779
|
*
|
|
8405
8780
|
* // Request body metadata
|
|
@@ -8565,7 +8940,7 @@ export namespace dataform_v1beta1 {
|
|
|
8565
8940
|
* // Do the magic
|
|
8566
8941
|
* const res =
|
|
8567
8942
|
* await dataform.projects.locations.repositories.releaseConfigs.delete({
|
|
8568
|
-
* // Required. The release config's name.
|
|
8943
|
+
* // Required. The release config's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:DeleteReleaseConfigRequest)
|
|
8569
8944
|
* name: 'projects/my-project/locations/my-location/repositories/my-repositorie/releaseConfigs/my-releaseConfig',
|
|
8570
8945
|
* });
|
|
8571
8946
|
* console.log(res.data);
|
|
@@ -8702,7 +9077,7 @@ export namespace dataform_v1beta1 {
|
|
|
8702
9077
|
* // Do the magic
|
|
8703
9078
|
* const res = await dataform.projects.locations.repositories.releaseConfigs.get(
|
|
8704
9079
|
* {
|
|
8705
|
-
* // Required. The release config's name.
|
|
9080
|
+
* // Required. The release config's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:GetReleaseConfigRequest)
|
|
8706
9081
|
* name: 'projects/my-project/locations/my-location/repositories/my-repositorie/releaseConfigs/my-releaseConfig',
|
|
8707
9082
|
* },
|
|
8708
9083
|
* );
|
|
@@ -8852,7 +9227,7 @@ export namespace dataform_v1beta1 {
|
|
|
8852
9227
|
* await dataform.projects.locations.repositories.releaseConfigs.list({
|
|
8853
9228
|
* // 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.
|
|
8854
9229
|
* pageSize: 'placeholder-value',
|
|
8855
|
-
* // 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.
|
|
9230
|
+
* // 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)
|
|
8856
9231
|
* pageToken: 'placeholder-value',
|
|
8857
9232
|
* // Required. The repository in which to list release configs. Must be in the format `projects/x/locations/x/repositories/x`.
|
|
8858
9233
|
* parent:
|
|
@@ -9140,7 +9515,7 @@ export namespace dataform_v1beta1 {
|
|
|
9140
9515
|
*/
|
|
9141
9516
|
parent?: string;
|
|
9142
9517
|
/**
|
|
9143
|
-
* Required. The ID to use for the release config, which will become the final component of the release config's resource name.
|
|
9518
|
+
* 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)
|
|
9144
9519
|
*/
|
|
9145
9520
|
releaseConfigId?: string;
|
|
9146
9521
|
|
|
@@ -9151,13 +9526,13 @@ export namespace dataform_v1beta1 {
|
|
|
9151
9526
|
}
|
|
9152
9527
|
export interface Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Delete extends StandardParameters {
|
|
9153
9528
|
/**
|
|
9154
|
-
* Required. The release config's name.
|
|
9529
|
+
* Required. The release config's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:DeleteReleaseConfigRequest)
|
|
9155
9530
|
*/
|
|
9156
9531
|
name?: string;
|
|
9157
9532
|
}
|
|
9158
9533
|
export interface Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Get extends StandardParameters {
|
|
9159
9534
|
/**
|
|
9160
|
-
* Required. The release config's name.
|
|
9535
|
+
* Required. The release config's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:GetReleaseConfigRequest)
|
|
9161
9536
|
*/
|
|
9162
9537
|
name?: string;
|
|
9163
9538
|
}
|
|
@@ -9167,7 +9542,7 @@ export namespace dataform_v1beta1 {
|
|
|
9167
9542
|
*/
|
|
9168
9543
|
pageSize?: number;
|
|
9169
9544
|
/**
|
|
9170
|
-
* 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.
|
|
9545
|
+
* 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)
|
|
9171
9546
|
*/
|
|
9172
9547
|
pageToken?: string;
|
|
9173
9548
|
/**
|
|
@@ -13339,6 +13714,8 @@ export namespace dataform_v1beta1 {
|
|
|
13339
13714
|
* pageToken: 'placeholder-value',
|
|
13340
13715
|
* // Optional. The directory's full path including directory name, relative to the workspace root. If left unset, the workspace root is used.
|
|
13341
13716
|
* path: 'placeholder-value',
|
|
13717
|
+
* // 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.
|
|
13718
|
+
* view: 'placeholder-value',
|
|
13342
13719
|
* // Required. The workspace's name.
|
|
13343
13720
|
* workspace:
|
|
13344
13721
|
* 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
|
|
@@ -14845,6 +15222,10 @@ export namespace dataform_v1beta1 {
|
|
|
14845
15222
|
* Optional. The directory's full path including directory name, relative to the workspace root. If left unset, the workspace root is used.
|
|
14846
15223
|
*/
|
|
14847
15224
|
path?: string;
|
|
15225
|
+
/**
|
|
15226
|
+
* 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.
|
|
15227
|
+
*/
|
|
15228
|
+
view?: string;
|
|
14848
15229
|
/**
|
|
14849
15230
|
* Required. The workspace's name.
|
|
14850
15231
|
*/
|
|
@@ -14991,7 +15372,7 @@ export namespace dataform_v1beta1 {
|
|
|
14991
15372
|
* const res = await dataform.projects.locations.teamFolders.create({
|
|
14992
15373
|
* // Required. The location in which to create the TeamFolder. Must be in the format `projects/x/locations/x`.
|
|
14993
15374
|
* parent: 'projects/my-project/locations/my-location',
|
|
14994
|
-
* // The ID to use for the TeamFolder, which will become the final component of the TeamFolder's resource name.
|
|
15375
|
+
* // 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.
|
|
14995
15376
|
* teamFolderId: 'placeholder-value',
|
|
14996
15377
|
*
|
|
14997
15378
|
* // Request body metadata
|
|
@@ -15250,6 +15631,159 @@ export namespace dataform_v1beta1 {
|
|
|
15250
15631
|
}
|
|
15251
15632
|
}
|
|
15252
15633
|
|
|
15634
|
+
/**
|
|
15635
|
+
* Deletes a TeamFolder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).
|
|
15636
|
+
* @example
|
|
15637
|
+
* ```js
|
|
15638
|
+
* // Before running the sample:
|
|
15639
|
+
* // - Enable the API at:
|
|
15640
|
+
* // https://console.developers.google.com/apis/api/dataform.googleapis.com
|
|
15641
|
+
* // - Login into gcloud by running:
|
|
15642
|
+
* // ```sh
|
|
15643
|
+
* // $ gcloud auth application-default login
|
|
15644
|
+
* // ```
|
|
15645
|
+
* // - Install the npm module by running:
|
|
15646
|
+
* // ```sh
|
|
15647
|
+
* // $ npm install googleapis
|
|
15648
|
+
* // ```
|
|
15649
|
+
*
|
|
15650
|
+
* const {google} = require('googleapis');
|
|
15651
|
+
* const dataform = google.dataform('v1beta1');
|
|
15652
|
+
*
|
|
15653
|
+
* async function main() {
|
|
15654
|
+
* const auth = new google.auth.GoogleAuth({
|
|
15655
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
15656
|
+
* scopes: [
|
|
15657
|
+
* 'https://www.googleapis.com/auth/bigquery',
|
|
15658
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
15659
|
+
* ],
|
|
15660
|
+
* });
|
|
15661
|
+
*
|
|
15662
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
15663
|
+
* const authClient = await auth.getClient();
|
|
15664
|
+
* google.options({auth: authClient});
|
|
15665
|
+
*
|
|
15666
|
+
* // Do the magic
|
|
15667
|
+
* const res = await dataform.projects.locations.teamFolders.deleteTree({
|
|
15668
|
+
* // Required. The TeamFolder's name. Format: projects/{project\}/locations/{location\}/teamFolders/{team_folder\}
|
|
15669
|
+
* name: 'projects/my-project/locations/my-location/teamFolders/my-teamFolder',
|
|
15670
|
+
*
|
|
15671
|
+
* // Request body metadata
|
|
15672
|
+
* requestBody: {
|
|
15673
|
+
* // request body parameters
|
|
15674
|
+
* // {
|
|
15675
|
+
* // "force": false
|
|
15676
|
+
* // }
|
|
15677
|
+
* },
|
|
15678
|
+
* });
|
|
15679
|
+
* console.log(res.data);
|
|
15680
|
+
*
|
|
15681
|
+
* // Example response
|
|
15682
|
+
* // {
|
|
15683
|
+
* // "done": false,
|
|
15684
|
+
* // "error": {},
|
|
15685
|
+
* // "metadata": {},
|
|
15686
|
+
* // "name": "my_name",
|
|
15687
|
+
* // "response": {}
|
|
15688
|
+
* // }
|
|
15689
|
+
* }
|
|
15690
|
+
*
|
|
15691
|
+
* main().catch(e => {
|
|
15692
|
+
* console.error(e);
|
|
15693
|
+
* throw e;
|
|
15694
|
+
* });
|
|
15695
|
+
*
|
|
15696
|
+
* ```
|
|
15697
|
+
*
|
|
15698
|
+
* @param params - Parameters for request
|
|
15699
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
15700
|
+
* @param callback - Optional callback that handles the response.
|
|
15701
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
15702
|
+
*/
|
|
15703
|
+
deleteTree(
|
|
15704
|
+
params: Params$Resource$Projects$Locations$Teamfolders$Deletetree,
|
|
15705
|
+
options: StreamMethodOptions
|
|
15706
|
+
): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
15707
|
+
deleteTree(
|
|
15708
|
+
params?: Params$Resource$Projects$Locations$Teamfolders$Deletetree,
|
|
15709
|
+
options?: MethodOptions
|
|
15710
|
+
): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
15711
|
+
deleteTree(
|
|
15712
|
+
params: Params$Resource$Projects$Locations$Teamfolders$Deletetree,
|
|
15713
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
15714
|
+
callback: BodyResponseCallback<Readable>
|
|
15715
|
+
): void;
|
|
15716
|
+
deleteTree(
|
|
15717
|
+
params: Params$Resource$Projects$Locations$Teamfolders$Deletetree,
|
|
15718
|
+
options: MethodOptions | BodyResponseCallback<Schema$Operation>,
|
|
15719
|
+
callback: BodyResponseCallback<Schema$Operation>
|
|
15720
|
+
): void;
|
|
15721
|
+
deleteTree(
|
|
15722
|
+
params: Params$Resource$Projects$Locations$Teamfolders$Deletetree,
|
|
15723
|
+
callback: BodyResponseCallback<Schema$Operation>
|
|
15724
|
+
): void;
|
|
15725
|
+
deleteTree(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
15726
|
+
deleteTree(
|
|
15727
|
+
paramsOrCallback?:
|
|
15728
|
+
| Params$Resource$Projects$Locations$Teamfolders$Deletetree
|
|
15729
|
+
| BodyResponseCallback<Schema$Operation>
|
|
15730
|
+
| BodyResponseCallback<Readable>,
|
|
15731
|
+
optionsOrCallback?:
|
|
15732
|
+
| MethodOptions
|
|
15733
|
+
| StreamMethodOptions
|
|
15734
|
+
| BodyResponseCallback<Schema$Operation>
|
|
15735
|
+
| BodyResponseCallback<Readable>,
|
|
15736
|
+
callback?:
|
|
15737
|
+
| BodyResponseCallback<Schema$Operation>
|
|
15738
|
+
| BodyResponseCallback<Readable>
|
|
15739
|
+
):
|
|
15740
|
+
| void
|
|
15741
|
+
| Promise<GaxiosResponseWithHTTP2<Schema$Operation>>
|
|
15742
|
+
| Promise<GaxiosResponseWithHTTP2<Readable>> {
|
|
15743
|
+
let params = (paramsOrCallback ||
|
|
15744
|
+
{}) as Params$Resource$Projects$Locations$Teamfolders$Deletetree;
|
|
15745
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
15746
|
+
|
|
15747
|
+
if (typeof paramsOrCallback === 'function') {
|
|
15748
|
+
callback = paramsOrCallback;
|
|
15749
|
+
params =
|
|
15750
|
+
{} as Params$Resource$Projects$Locations$Teamfolders$Deletetree;
|
|
15751
|
+
options = {};
|
|
15752
|
+
}
|
|
15753
|
+
|
|
15754
|
+
if (typeof optionsOrCallback === 'function') {
|
|
15755
|
+
callback = optionsOrCallback;
|
|
15756
|
+
options = {};
|
|
15757
|
+
}
|
|
15758
|
+
|
|
15759
|
+
const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/';
|
|
15760
|
+
const parameters = {
|
|
15761
|
+
options: Object.assign(
|
|
15762
|
+
{
|
|
15763
|
+
url: (rootUrl + '/v1beta1/{+name}:deleteTree').replace(
|
|
15764
|
+
/([^:]\/)\/+/g,
|
|
15765
|
+
'$1'
|
|
15766
|
+
),
|
|
15767
|
+
method: 'POST',
|
|
15768
|
+
apiVersion: '',
|
|
15769
|
+
},
|
|
15770
|
+
options
|
|
15771
|
+
),
|
|
15772
|
+
params,
|
|
15773
|
+
requiredParams: ['name'],
|
|
15774
|
+
pathParams: ['name'],
|
|
15775
|
+
context: this.context,
|
|
15776
|
+
};
|
|
15777
|
+
if (callback) {
|
|
15778
|
+
createAPIRequest<Schema$Operation>(
|
|
15779
|
+
parameters,
|
|
15780
|
+
callback as BodyResponseCallback<unknown>
|
|
15781
|
+
);
|
|
15782
|
+
} else {
|
|
15783
|
+
return createAPIRequest<Schema$Operation>(parameters);
|
|
15784
|
+
}
|
|
15785
|
+
}
|
|
15786
|
+
|
|
15253
15787
|
/**
|
|
15254
15788
|
* Fetches a single TeamFolder.
|
|
15255
15789
|
* @example
|
|
@@ -15729,15 +16263,15 @@ export namespace dataform_v1beta1 {
|
|
|
15729
16263
|
*
|
|
15730
16264
|
* // Do the magic
|
|
15731
16265
|
* const res = await dataform.projects.locations.teamFolders.queryContents({
|
|
15732
|
-
* // Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example:
|
|
16266
|
+
* // Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter="display_name="MyFolder""`
|
|
15733
16267
|
* filter: 'placeholder-value',
|
|
15734
|
-
* // 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:
|
|
16268
|
+
* // 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"`
|
|
15735
16269
|
* orderBy: 'placeholder-value',
|
|
15736
16270
|
* // Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
|
|
15737
16271
|
* pageSize: 'placeholder-value',
|
|
15738
16272
|
* // Optional. Page token received from a previous `QueryTeamFolderContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryTeamFolderContents`, with the exception of `page_size`, must match the call that provided the page token.
|
|
15739
16273
|
* pageToken: 'placeholder-value',
|
|
15740
|
-
* // Required.
|
|
16274
|
+
* // Required. Resource name of the TeamFolder to list contents for. Format: `projects/x/locations/x/teamFolders/x`.
|
|
15741
16275
|
* teamFolder:
|
|
15742
16276
|
* 'projects/my-project/locations/my-location/teamFolders/my-teamFolder',
|
|
15743
16277
|
* });
|
|
@@ -15886,13 +16420,13 @@ export namespace dataform_v1beta1 {
|
|
|
15886
16420
|
*
|
|
15887
16421
|
* // Do the magic
|
|
15888
16422
|
* const res = await dataform.projects.locations.teamFolders.search({
|
|
15889
|
-
* // Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example:
|
|
16423
|
+
* // Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter="display_name="MyFolder""`
|
|
15890
16424
|
* filter: 'placeholder-value',
|
|
15891
16425
|
* // Required. Location in which to query TeamFolders. Format: `projects/x/locations/x`.
|
|
15892
16426
|
* location: 'projects/my-project/locations/my-location',
|
|
15893
|
-
* // Optional. Field to additionally sort results by. Supported keywords: `display_name` (default), `create_time`, `last_modified_time`. Examples:
|
|
16427
|
+
* // 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"`
|
|
15894
16428
|
* orderBy: 'placeholder-value',
|
|
15895
|
-
* // Optional. Maximum number of TeamFolders to return. The server may return fewer items than requested. If unspecified, the server will pick
|
|
16429
|
+
* // 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.
|
|
15896
16430
|
* pageSize: 'placeholder-value',
|
|
15897
16431
|
* // 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.
|
|
15898
16432
|
* pageToken: 'placeholder-value',
|
|
@@ -16318,7 +16852,7 @@ export namespace dataform_v1beta1 {
|
|
|
16318
16852
|
*/
|
|
16319
16853
|
parent?: string;
|
|
16320
16854
|
/**
|
|
16321
|
-
* The ID to use for the TeamFolder, which will become the final component of the TeamFolder's resource name.
|
|
16855
|
+
* 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.
|
|
16322
16856
|
*/
|
|
16323
16857
|
teamFolderId?: string;
|
|
16324
16858
|
|
|
@@ -16333,6 +16867,17 @@ export namespace dataform_v1beta1 {
|
|
|
16333
16867
|
*/
|
|
16334
16868
|
name?: string;
|
|
16335
16869
|
}
|
|
16870
|
+
export interface Params$Resource$Projects$Locations$Teamfolders$Deletetree extends StandardParameters {
|
|
16871
|
+
/**
|
|
16872
|
+
* Required. The TeamFolder's name. Format: projects/{project\}/locations/{location\}/teamFolders/{team_folder\}
|
|
16873
|
+
*/
|
|
16874
|
+
name?: string;
|
|
16875
|
+
|
|
16876
|
+
/**
|
|
16877
|
+
* Request body metadata
|
|
16878
|
+
*/
|
|
16879
|
+
requestBody?: Schema$DeleteTeamFolderTreeRequest;
|
|
16880
|
+
}
|
|
16336
16881
|
export interface Params$Resource$Projects$Locations$Teamfolders$Get extends StandardParameters {
|
|
16337
16882
|
/**
|
|
16338
16883
|
* Required. The TeamFolder's name.
|
|
@@ -16366,11 +16911,11 @@ export namespace dataform_v1beta1 {
|
|
|
16366
16911
|
}
|
|
16367
16912
|
export interface Params$Resource$Projects$Locations$Teamfolders$Querycontents extends StandardParameters {
|
|
16368
16913
|
/**
|
|
16369
|
-
* Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example:
|
|
16914
|
+
* Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter="display_name="MyFolder""`
|
|
16370
16915
|
*/
|
|
16371
16916
|
filter?: string;
|
|
16372
16917
|
/**
|
|
16373
|
-
* 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:
|
|
16918
|
+
* 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"`
|
|
16374
16919
|
*/
|
|
16375
16920
|
orderBy?: string;
|
|
16376
16921
|
/**
|
|
@@ -16382,13 +16927,13 @@ export namespace dataform_v1beta1 {
|
|
|
16382
16927
|
*/
|
|
16383
16928
|
pageToken?: string;
|
|
16384
16929
|
/**
|
|
16385
|
-
* Required.
|
|
16930
|
+
* Required. Resource name of the TeamFolder to list contents for. Format: `projects/x/locations/x/teamFolders/x`.
|
|
16386
16931
|
*/
|
|
16387
16932
|
teamFolder?: string;
|
|
16388
16933
|
}
|
|
16389
16934
|
export interface Params$Resource$Projects$Locations$Teamfolders$Search extends StandardParameters {
|
|
16390
16935
|
/**
|
|
16391
|
-
* Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example:
|
|
16936
|
+
* Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter="display_name="MyFolder""`
|
|
16392
16937
|
*/
|
|
16393
16938
|
filter?: string;
|
|
16394
16939
|
/**
|
|
@@ -16396,11 +16941,11 @@ export namespace dataform_v1beta1 {
|
|
|
16396
16941
|
*/
|
|
16397
16942
|
location?: string;
|
|
16398
16943
|
/**
|
|
16399
|
-
* Optional. Field to additionally sort results by. Supported keywords: `display_name` (default), `create_time`, `last_modified_time`. Examples:
|
|
16944
|
+
* 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"`
|
|
16400
16945
|
*/
|
|
16401
16946
|
orderBy?: string;
|
|
16402
16947
|
/**
|
|
16403
|
-
* Optional. Maximum number of TeamFolders to return. The server may return fewer items than requested. If unspecified, the server will pick
|
|
16948
|
+
* 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.
|
|
16404
16949
|
*/
|
|
16405
16950
|
pageSize?: number;
|
|
16406
16951
|
/**
|