@googleapis/dataform 14.1.0 → 15.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.
@@ -375,7 +375,7 @@ export declare namespace dataform_v1beta1 {
375
375
  */
376
376
  export interface Schema$CompilationError {
377
377
  /**
378
- * Output only. The identifier of the action where this error occurred, if available.
378
+ * 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)
379
379
  */
380
380
  actionTarget?: Schema$Target;
381
381
  /**
@@ -584,6 +584,24 @@ export declare namespace dataform_v1beta1 {
584
584
  */
585
585
  export interface Schema$DeleteFile {
586
586
  }
587
+ /**
588
+ * `DeleteFolderTree` request message.
589
+ */
590
+ export interface Schema$DeleteFolderTreeRequest {
591
+ /**
592
+ * 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.
593
+ */
594
+ force?: boolean | null;
595
+ }
596
+ /**
597
+ * `DeleteTeamFolderTree` request message.
598
+ */
599
+ export interface Schema$DeleteTeamFolderTreeRequest {
600
+ /**
601
+ * 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.
602
+ */
603
+ force?: boolean | null;
604
+ }
587
605
  /**
588
606
  * Represents a single entry in a directory.
589
607
  */
@@ -596,6 +614,10 @@ export declare namespace dataform_v1beta1 {
596
614
  * A file in the directory.
597
615
  */
598
616
  file?: string | null;
617
+ /**
618
+ * Entry with metadata.
619
+ */
620
+ metadata?: Schema$FilesystemEntryMetadata;
599
621
  }
600
622
  /**
601
623
  * Client-facing representation of a directory entry in search results.
@@ -720,12 +742,25 @@ export declare namespace dataform_v1beta1 {
720
742
  */
721
743
  path?: string | null;
722
744
  }
745
+ /**
746
+ * Represents metadata for a single entry in a filesystem.
747
+ */
748
+ export interface Schema$FilesystemEntryMetadata {
749
+ /**
750
+ * Output only. Provides the size of the entry in bytes. For directories, this will be 0.
751
+ */
752
+ sizeBytes?: string | null;
753
+ /**
754
+ * Output only. Represents the time of the last modification of the entry.
755
+ */
756
+ updateTime?: string | null;
757
+ }
723
758
  /**
724
759
  * Represents a Dataform Folder. This is a resource that is used to organize Files and other Folders and provide hierarchical access controls.
725
760
  */
726
761
  export interface Schema$Folder {
727
762
  /**
728
- * 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 projects/{project\}/locations/{location\} if this is a root Folder. This field can only be updated through MoveFolder.
763
+ * 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.
729
764
  */
730
765
  containingFolder?: string | null;
731
766
  /**
@@ -779,7 +814,7 @@ export declare namespace dataform_v1beta1 {
779
814
  */
780
815
  authenticationTokenSecretVersion?: string | null;
781
816
  /**
782
- * Required. The Git remote's default branch name.
817
+ * Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository.
783
818
  */
784
819
  defaultBranch?: string | null;
785
820
  /**
@@ -915,7 +950,7 @@ export declare namespace dataform_v1beta1 {
915
950
  */
916
951
  nextPageToken?: string | null;
917
952
  /**
918
- * Locations which could not be reached.
953
+ * Locations which could not be reached. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ListCompilationResultsResponse)
919
954
  */
920
955
  unreachable?: string[] | null;
921
956
  }
@@ -962,7 +997,7 @@ export declare namespace dataform_v1beta1 {
962
997
  */
963
998
  releaseConfigs?: Schema$ReleaseConfig[];
964
999
  /**
965
- * Locations which could not be reached.
1000
+ * Locations which could not be reached. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ListReleaseConfigsResponse)
966
1001
  */
967
1002
  unreachable?: string[] | null;
968
1003
  }
@@ -1139,7 +1174,7 @@ export declare namespace dataform_v1beta1 {
1139
1174
  */
1140
1175
  export interface Schema$MoveFolderRequest {
1141
1176
  /**
1142
- * Required. 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
+ * 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`
1143
1178
  */
1144
1179
  destinationContainingFolder?: string | null;
1145
1180
  }
@@ -1148,7 +1183,7 @@ export declare namespace dataform_v1beta1 {
1148
1183
  */
1149
1184
  export interface Schema$MoveRepositoryRequest {
1150
1185
  /**
1151
- * Required. 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
+ * 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`
1152
1187
  */
1153
1188
  destinationContainingFolder?: string | null;
1154
1189
  }
@@ -1182,7 +1217,7 @@ export declare namespace dataform_v1beta1 {
1182
1217
  */
1183
1218
  contents?: string | null;
1184
1219
  /**
1185
- * Output only. The ID of the Vertex 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
+ * 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.
1186
1221
  */
1187
1222
  jobId?: string | null;
1188
1223
  }
@@ -1489,7 +1524,7 @@ export declare namespace dataform_v1beta1 {
1489
1524
  */
1490
1525
  clusterExpressions?: string[] | null;
1491
1526
  /**
1492
- * 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.
1527
+ * 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.
1493
1528
  */
1494
1529
  connection?: string | null;
1495
1530
  /**
@@ -1593,7 +1628,7 @@ export declare namespace dataform_v1beta1 {
1593
1628
  */
1594
1629
  gitCommitish?: string | null;
1595
1630
  /**
1596
- * 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.
1631
+ * 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)
1597
1632
  */
1598
1633
  internalMetadata?: string | null;
1599
1634
  /**
@@ -2319,7 +2354,7 @@ export declare namespace dataform_v1beta1 {
2319
2354
  getConfig(params: Params$Resource$Projects$Locations$Getconfig, callback: BodyResponseCallback<Schema$Config>): void;
2320
2355
  getConfig(callback: BodyResponseCallback<Schema$Config>): void;
2321
2356
  /**
2322
- * Lists information about the supported locations for this service.
2357
+ * 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.
2323
2358
  * @example
2324
2359
  * ```js
2325
2360
  * // Before running the sample:
@@ -2352,7 +2387,7 @@ export declare namespace dataform_v1beta1 {
2352
2387
  *
2353
2388
  * // Do the magic
2354
2389
  * const res = await dataform.projects.locations.list({
2355
- * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.
2390
+ * // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.
2356
2391
  * extraLocationTypes: 'placeholder-value',
2357
2392
  * // 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).
2358
2393
  * filter: 'placeholder-value',
@@ -2424,11 +2459,11 @@ export declare namespace dataform_v1beta1 {
2424
2459
  *
2425
2460
  * // Do the magic
2426
2461
  * const res = await dataform.projects.locations.queryUserRootContents({
2427
- * // Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: - `filter="display_name="MyFolder""`
2462
+ * // Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter="display_name="MyFolder""`
2428
2463
  * filter: 'placeholder-value',
2429
- * // Required. Location of the user root folder whose contents to list. Format: projects/x/locations/x
2464
+ * // Required. Location of the user root folder to list contents for. Format: projects/x/locations/x
2430
2465
  * location: 'projects/my-project/locations/my-location',
2431
- * // 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"`
2466
+ * // 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"`
2432
2467
  * orderBy: 'placeholder-value',
2433
2468
  * // Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
2434
2469
  * pageSize: 'placeholder-value',
@@ -2554,7 +2589,7 @@ export declare namespace dataform_v1beta1 {
2554
2589
  }
2555
2590
  export interface Params$Resource$Projects$Locations$List extends StandardParameters {
2556
2591
  /**
2557
- * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.
2592
+ * Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.
2558
2593
  */
2559
2594
  extraLocationTypes?: string[];
2560
2595
  /**
@@ -2576,15 +2611,15 @@ export declare namespace dataform_v1beta1 {
2576
2611
  }
2577
2612
  export interface Params$Resource$Projects$Locations$Queryuserrootcontents extends StandardParameters {
2578
2613
  /**
2579
- * Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: - `filter="display_name="MyFolder""`
2614
+ * Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter="display_name="MyFolder""`
2580
2615
  */
2581
2616
  filter?: string;
2582
2617
  /**
2583
- * Required. Location of the user root folder whose contents to list. Format: projects/x/locations/x
2618
+ * Required. Location of the user root folder to list contents for. Format: projects/x/locations/x
2584
2619
  */
2585
2620
  location?: string;
2586
2621
  /**
2587
- * 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"`
2622
+ * 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"`
2588
2623
  */
2589
2624
  orderBy?: string;
2590
2625
  /**
@@ -2647,7 +2682,7 @@ export declare namespace dataform_v1beta1 {
2647
2682
  *
2648
2683
  * // Do the magic
2649
2684
  * const res = await dataform.projects.locations.folders.create({
2650
- * // The ID to use for the Folder, which will become the final component of the Folder's resource name.
2685
+ * // 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.
2651
2686
  * folderId: 'placeholder-value',
2652
2687
  * // Required. The location in which to create the Folder. Must be in the format `projects/x/locations/x`.
2653
2688
  * parent: 'projects/my-project/locations/my-location',
@@ -2761,6 +2796,81 @@ export declare namespace dataform_v1beta1 {
2761
2796
  delete(params: Params$Resource$Projects$Locations$Folders$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
2762
2797
  delete(params: Params$Resource$Projects$Locations$Folders$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
2763
2798
  delete(callback: BodyResponseCallback<Schema$Empty>): void;
2799
+ /**
2800
+ * Deletes a Folder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).
2801
+ * @example
2802
+ * ```js
2803
+ * // Before running the sample:
2804
+ * // - Enable the API at:
2805
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
2806
+ * // - Login into gcloud by running:
2807
+ * // ```sh
2808
+ * // $ gcloud auth application-default login
2809
+ * // ```
2810
+ * // - Install the npm module by running:
2811
+ * // ```sh
2812
+ * // $ npm install googleapis
2813
+ * // ```
2814
+ *
2815
+ * const {google} = require('googleapis');
2816
+ * const dataform = google.dataform('v1beta1');
2817
+ *
2818
+ * async function main() {
2819
+ * const auth = new google.auth.GoogleAuth({
2820
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2821
+ * scopes: [
2822
+ * 'https://www.googleapis.com/auth/bigquery',
2823
+ * 'https://www.googleapis.com/auth/cloud-platform',
2824
+ * ],
2825
+ * });
2826
+ *
2827
+ * // Acquire an auth client, and bind it to all future calls
2828
+ * const authClient = await auth.getClient();
2829
+ * google.options({auth: authClient});
2830
+ *
2831
+ * // Do the magic
2832
+ * const res = await dataform.projects.locations.folders.deleteTree({
2833
+ * // Required. The Folder's name. Format: projects/{project\}/locations/{location\}/folders/{folder\}
2834
+ * name: 'projects/my-project/locations/my-location/folders/my-folder',
2835
+ *
2836
+ * // Request body metadata
2837
+ * requestBody: {
2838
+ * // request body parameters
2839
+ * // {
2840
+ * // "force": false
2841
+ * // }
2842
+ * },
2843
+ * });
2844
+ * console.log(res.data);
2845
+ *
2846
+ * // Example response
2847
+ * // {
2848
+ * // "done": false,
2849
+ * // "error": {},
2850
+ * // "metadata": {},
2851
+ * // "name": "my_name",
2852
+ * // "response": {}
2853
+ * // }
2854
+ * }
2855
+ *
2856
+ * main().catch(e => {
2857
+ * console.error(e);
2858
+ * throw e;
2859
+ * });
2860
+ *
2861
+ * ```
2862
+ *
2863
+ * @param params - Parameters for request
2864
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
2865
+ * @param callback - Optional callback that handles the response.
2866
+ * @returns A promise if used with async/await, or void if used with a callback.
2867
+ */
2868
+ deleteTree(params: Params$Resource$Projects$Locations$Folders$Deletetree, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
2869
+ deleteTree(params?: Params$Resource$Projects$Locations$Folders$Deletetree, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
2870
+ deleteTree(params: Params$Resource$Projects$Locations$Folders$Deletetree, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
2871
+ deleteTree(params: Params$Resource$Projects$Locations$Folders$Deletetree, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
2872
+ deleteTree(params: Params$Resource$Projects$Locations$Folders$Deletetree, callback: BodyResponseCallback<Schema$Operation>): void;
2873
+ deleteTree(callback: BodyResponseCallback<Schema$Operation>): void;
2764
2874
  /**
2765
2875
  * Fetches a single Folder.
2766
2876
  * @example
@@ -3094,11 +3204,11 @@ export declare namespace dataform_v1beta1 {
3094
3204
  *
3095
3205
  * // Do the magic
3096
3206
  * const res = await dataform.projects.locations.folders.queryFolderContents({
3097
- * // Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: - `filter="display_name="MyFolder""`
3207
+ * // Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter="display_name="MyFolder""`
3098
3208
  * filter: 'placeholder-value',
3099
- * // Required. Name of the folder whose contents to list. Format: projects/x/locations/x/folders/x
3209
+ * // Required. Resource name of the Folder to list contents for. Format: projects/x/locations/x/folders/x
3100
3210
  * folder: 'projects/my-project/locations/my-location/folders/my-folder',
3101
- * // 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"`
3211
+ * // 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"`
3102
3212
  * orderBy: 'placeholder-value',
3103
3213
  * // Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
3104
3214
  * pageSize: 'placeholder-value',
@@ -3279,7 +3389,7 @@ export declare namespace dataform_v1beta1 {
3279
3389
  }
3280
3390
  export interface Params$Resource$Projects$Locations$Folders$Create extends StandardParameters {
3281
3391
  /**
3282
- * The ID to use for the Folder, which will become the final component of the Folder's resource name.
3392
+ * 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.
3283
3393
  */
3284
3394
  folderId?: string;
3285
3395
  /**
@@ -3297,6 +3407,16 @@ export declare namespace dataform_v1beta1 {
3297
3407
  */
3298
3408
  name?: string;
3299
3409
  }
3410
+ export interface Params$Resource$Projects$Locations$Folders$Deletetree extends StandardParameters {
3411
+ /**
3412
+ * Required. The Folder's name. Format: projects/{project\}/locations/{location\}/folders/{folder\}
3413
+ */
3414
+ name?: string;
3415
+ /**
3416
+ * Request body metadata
3417
+ */
3418
+ requestBody?: Schema$DeleteFolderTreeRequest;
3419
+ }
3300
3420
  export interface Params$Resource$Projects$Locations$Folders$Get extends StandardParameters {
3301
3421
  /**
3302
3422
  * Required. The Folder's name.
@@ -3339,15 +3459,15 @@ export declare namespace dataform_v1beta1 {
3339
3459
  }
3340
3460
  export interface Params$Resource$Projects$Locations$Folders$Queryfoldercontents extends StandardParameters {
3341
3461
  /**
3342
- * Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: - `filter="display_name="MyFolder""`
3462
+ * Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter="display_name="MyFolder""`
3343
3463
  */
3344
3464
  filter?: string;
3345
3465
  /**
3346
- * Required. Name of the folder whose contents to list. Format: projects/x/locations/x/folders/x
3466
+ * Required. Resource name of the Folder to list contents for. Format: projects/x/locations/x/folders/x
3347
3467
  */
3348
3468
  folder?: string;
3349
3469
  /**
3350
- * 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"`
3470
+ * 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"`
3351
3471
  */
3352
3472
  orderBy?: string;
3353
3473
  /**
@@ -5125,7 +5245,7 @@ export declare namespace dataform_v1beta1 {
5125
5245
  * // Do the magic
5126
5246
  * const res =
5127
5247
  * await dataform.projects.locations.repositories.compilationResults.get({
5128
- * // Required. The compilation result's name.
5248
+ * // Required. The compilation result's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:GetCompilationResultRequest)
5129
5249
  * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/compilationResults/my-compilationResult',
5130
5250
  * });
5131
5251
  * console.log(res.data);
@@ -5200,7 +5320,7 @@ export declare namespace dataform_v1beta1 {
5200
5320
  * // Do the magic
5201
5321
  * const res =
5202
5322
  * await dataform.projects.locations.repositories.compilationResults.list({
5203
- * // Optional. Filter for the returned list.
5323
+ * // Optional. Filter for the returned list. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ListCompilationResultsRequest)
5204
5324
  * filter: 'placeholder-value',
5205
5325
  * // 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.
5206
5326
  * orderBy: 'placeholder-value',
@@ -5324,13 +5444,13 @@ export declare namespace dataform_v1beta1 {
5324
5444
  }
5325
5445
  export interface Params$Resource$Projects$Locations$Repositories$Compilationresults$Get extends StandardParameters {
5326
5446
  /**
5327
- * Required. The compilation result's name.
5447
+ * Required. The compilation result's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:GetCompilationResultRequest)
5328
5448
  */
5329
5449
  name?: string;
5330
5450
  }
5331
5451
  export interface Params$Resource$Projects$Locations$Repositories$Compilationresults$List extends StandardParameters {
5332
5452
  /**
5333
- * Optional. Filter for the returned list.
5453
+ * Optional. Filter for the returned list. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ListCompilationResultsRequest)
5334
5454
  */
5335
5455
  filter?: string;
5336
5456
  /**
@@ -5409,7 +5529,7 @@ export declare namespace dataform_v1beta1 {
5409
5529
  * // Required. The repository in which to create the release config. Must be in the format `projects/x/locations/x/repositories/x`.
5410
5530
  * parent:
5411
5531
  * 'projects/my-project/locations/my-location/repositories/my-repositorie',
5412
- * // Required. The ID to use for the release config, which will become the final component of the release config's resource name.
5532
+ * // 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)
5413
5533
  * releaseConfigId: 'placeholder-value',
5414
5534
  *
5415
5535
  * // Request body metadata
@@ -5497,7 +5617,7 @@ export declare namespace dataform_v1beta1 {
5497
5617
  * // Do the magic
5498
5618
  * const res =
5499
5619
  * await dataform.projects.locations.repositories.releaseConfigs.delete({
5500
- * // Required. The release config's name.
5620
+ * // Required. The release config's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:DeleteReleaseConfigRequest)
5501
5621
  * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/releaseConfigs/my-releaseConfig',
5502
5622
  * });
5503
5623
  * console.log(res.data);
@@ -5559,7 +5679,7 @@ export declare namespace dataform_v1beta1 {
5559
5679
  * // Do the magic
5560
5680
  * const res = await dataform.projects.locations.repositories.releaseConfigs.get(
5561
5681
  * {
5562
- * // Required. The release config's name.
5682
+ * // Required. The release config's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:GetReleaseConfigRequest)
5563
5683
  * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/releaseConfigs/my-releaseConfig',
5564
5684
  * },
5565
5685
  * );
@@ -5634,7 +5754,7 @@ export declare namespace dataform_v1beta1 {
5634
5754
  * await dataform.projects.locations.repositories.releaseConfigs.list({
5635
5755
  * // 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.
5636
5756
  * pageSize: 'placeholder-value',
5637
- * // 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.
5757
+ * // 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)
5638
5758
  * pageToken: 'placeholder-value',
5639
5759
  * // Required. The repository in which to list release configs. Must be in the format `projects/x/locations/x/repositories/x`.
5640
5760
  * parent:
@@ -5765,7 +5885,7 @@ export declare namespace dataform_v1beta1 {
5765
5885
  */
5766
5886
  parent?: string;
5767
5887
  /**
5768
- * Required. The ID to use for the release config, which will become the final component of the release config's resource name.
5888
+ * 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)
5769
5889
  */
5770
5890
  releaseConfigId?: string;
5771
5891
  /**
@@ -5775,13 +5895,13 @@ export declare namespace dataform_v1beta1 {
5775
5895
  }
5776
5896
  export interface Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Delete extends StandardParameters {
5777
5897
  /**
5778
- * Required. The release config's name.
5898
+ * Required. The release config's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:DeleteReleaseConfigRequest)
5779
5899
  */
5780
5900
  name?: string;
5781
5901
  }
5782
5902
  export interface Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Get extends StandardParameters {
5783
5903
  /**
5784
- * Required. The release config's name.
5904
+ * Required. The release config's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:GetReleaseConfigRequest)
5785
5905
  */
5786
5906
  name?: string;
5787
5907
  }
@@ -5791,7 +5911,7 @@ export declare namespace dataform_v1beta1 {
5791
5911
  */
5792
5912
  pageSize?: number;
5793
5913
  /**
5794
- * 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.
5914
+ * 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)
5795
5915
  */
5796
5916
  pageToken?: string;
5797
5917
  /**
@@ -7871,6 +7991,8 @@ export declare namespace dataform_v1beta1 {
7871
7991
  * pageToken: 'placeholder-value',
7872
7992
  * // Optional. The directory's full path including directory name, relative to the workspace root. If left unset, the workspace root is used.
7873
7993
  * path: 'placeholder-value',
7994
+ * // 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.
7995
+ * view: 'placeholder-value',
7874
7996
  * // Required. The workspace's name.
7875
7997
  * workspace:
7876
7998
  * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
@@ -8646,6 +8768,10 @@ export declare namespace dataform_v1beta1 {
8646
8768
  * Optional. The directory's full path including directory name, relative to the workspace root. If left unset, the workspace root is used.
8647
8769
  */
8648
8770
  path?: string;
8771
+ /**
8772
+ * 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.
8773
+ */
8774
+ view?: string;
8649
8775
  /**
8650
8776
  * Required. The workspace's name.
8651
8777
  */
@@ -8782,7 +8908,7 @@ export declare namespace dataform_v1beta1 {
8782
8908
  * const res = await dataform.projects.locations.teamFolders.create({
8783
8909
  * // Required. The location in which to create the TeamFolder. Must be in the format `projects/x/locations/x`.
8784
8910
  * parent: 'projects/my-project/locations/my-location',
8785
- * // The ID to use for the TeamFolder, which will become the final component of the TeamFolder's resource name.
8911
+ * // 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.
8786
8912
  * teamFolderId: 'placeholder-value',
8787
8913
  *
8788
8914
  * // Request body metadata
@@ -8890,6 +9016,81 @@ export declare namespace dataform_v1beta1 {
8890
9016
  delete(params: Params$Resource$Projects$Locations$Teamfolders$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
8891
9017
  delete(params: Params$Resource$Projects$Locations$Teamfolders$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
8892
9018
  delete(callback: BodyResponseCallback<Schema$Empty>): void;
9019
+ /**
9020
+ * Deletes a TeamFolder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).
9021
+ * @example
9022
+ * ```js
9023
+ * // Before running the sample:
9024
+ * // - Enable the API at:
9025
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
9026
+ * // - Login into gcloud by running:
9027
+ * // ```sh
9028
+ * // $ gcloud auth application-default login
9029
+ * // ```
9030
+ * // - Install the npm module by running:
9031
+ * // ```sh
9032
+ * // $ npm install googleapis
9033
+ * // ```
9034
+ *
9035
+ * const {google} = require('googleapis');
9036
+ * const dataform = google.dataform('v1beta1');
9037
+ *
9038
+ * async function main() {
9039
+ * const auth = new google.auth.GoogleAuth({
9040
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
9041
+ * scopes: [
9042
+ * 'https://www.googleapis.com/auth/bigquery',
9043
+ * 'https://www.googleapis.com/auth/cloud-platform',
9044
+ * ],
9045
+ * });
9046
+ *
9047
+ * // Acquire an auth client, and bind it to all future calls
9048
+ * const authClient = await auth.getClient();
9049
+ * google.options({auth: authClient});
9050
+ *
9051
+ * // Do the magic
9052
+ * const res = await dataform.projects.locations.teamFolders.deleteTree({
9053
+ * // Required. The TeamFolder's name. Format: projects/{project\}/locations/{location\}/teamFolders/{team_folder\}
9054
+ * name: 'projects/my-project/locations/my-location/teamFolders/my-teamFolder',
9055
+ *
9056
+ * // Request body metadata
9057
+ * requestBody: {
9058
+ * // request body parameters
9059
+ * // {
9060
+ * // "force": false
9061
+ * // }
9062
+ * },
9063
+ * });
9064
+ * console.log(res.data);
9065
+ *
9066
+ * // Example response
9067
+ * // {
9068
+ * // "done": false,
9069
+ * // "error": {},
9070
+ * // "metadata": {},
9071
+ * // "name": "my_name",
9072
+ * // "response": {}
9073
+ * // }
9074
+ * }
9075
+ *
9076
+ * main().catch(e => {
9077
+ * console.error(e);
9078
+ * throw e;
9079
+ * });
9080
+ *
9081
+ * ```
9082
+ *
9083
+ * @param params - Parameters for request
9084
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
9085
+ * @param callback - Optional callback that handles the response.
9086
+ * @returns A promise if used with async/await, or void if used with a callback.
9087
+ */
9088
+ deleteTree(params: Params$Resource$Projects$Locations$Teamfolders$Deletetree, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
9089
+ deleteTree(params?: Params$Resource$Projects$Locations$Teamfolders$Deletetree, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
9090
+ deleteTree(params: Params$Resource$Projects$Locations$Teamfolders$Deletetree, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
9091
+ deleteTree(params: Params$Resource$Projects$Locations$Teamfolders$Deletetree, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
9092
+ deleteTree(params: Params$Resource$Projects$Locations$Teamfolders$Deletetree, callback: BodyResponseCallback<Schema$Operation>): void;
9093
+ deleteTree(callback: BodyResponseCallback<Schema$Operation>): void;
8893
9094
  /**
8894
9095
  * Fetches a single TeamFolder.
8895
9096
  * @example
@@ -9143,15 +9344,15 @@ export declare namespace dataform_v1beta1 {
9143
9344
  *
9144
9345
  * // Do the magic
9145
9346
  * const res = await dataform.projects.locations.teamFolders.queryContents({
9146
- * // Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: - `filter="display_name="MyFolder""`
9347
+ * // Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter="display_name="MyFolder""`
9147
9348
  * filter: 'placeholder-value',
9148
- * // 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"`
9349
+ * // 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"`
9149
9350
  * orderBy: 'placeholder-value',
9150
9351
  * // Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
9151
9352
  * pageSize: 'placeholder-value',
9152
9353
  * // 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.
9153
9354
  * pageToken: 'placeholder-value',
9154
- * // Required. Name of the team_folder whose contents to list. Format: `projects/x/locations/x/teamFolders/x`.
9355
+ * // Required. Resource name of the TeamFolder to list contents for. Format: `projects/x/locations/x/teamFolders/x`.
9155
9356
  * teamFolder:
9156
9357
  * 'projects/my-project/locations/my-location/teamFolders/my-teamFolder',
9157
9358
  * });
@@ -9216,11 +9417,11 @@ export declare namespace dataform_v1beta1 {
9216
9417
  *
9217
9418
  * // Do the magic
9218
9419
  * const res = await dataform.projects.locations.teamFolders.search({
9219
- * // Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: - `filter="display_name="MyFolder""`
9420
+ * // Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter="display_name="MyFolder""`
9220
9421
  * filter: 'placeholder-value',
9221
9422
  * // Required. Location in which to query TeamFolders. Format: `projects/x/locations/x`.
9222
9423
  * location: 'projects/my-project/locations/my-location',
9223
- * // 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"`
9424
+ * // 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"`
9224
9425
  * orderBy: 'placeholder-value',
9225
9426
  * // Optional. Maximum number of TeamFolders to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
9226
9427
  * pageSize: 'placeholder-value',
@@ -9407,7 +9608,7 @@ export declare namespace dataform_v1beta1 {
9407
9608
  */
9408
9609
  parent?: string;
9409
9610
  /**
9410
- * The ID to use for the TeamFolder, which will become the final component of the TeamFolder's resource name.
9611
+ * 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.
9411
9612
  */
9412
9613
  teamFolderId?: string;
9413
9614
  /**
@@ -9421,6 +9622,16 @@ export declare namespace dataform_v1beta1 {
9421
9622
  */
9422
9623
  name?: string;
9423
9624
  }
9625
+ export interface Params$Resource$Projects$Locations$Teamfolders$Deletetree extends StandardParameters {
9626
+ /**
9627
+ * Required. The TeamFolder's name. Format: projects/{project\}/locations/{location\}/teamFolders/{team_folder\}
9628
+ */
9629
+ name?: string;
9630
+ /**
9631
+ * Request body metadata
9632
+ */
9633
+ requestBody?: Schema$DeleteTeamFolderTreeRequest;
9634
+ }
9424
9635
  export interface Params$Resource$Projects$Locations$Teamfolders$Get extends StandardParameters {
9425
9636
  /**
9426
9637
  * Required. The TeamFolder's name.
@@ -9453,11 +9664,11 @@ export declare namespace dataform_v1beta1 {
9453
9664
  }
9454
9665
  export interface Params$Resource$Projects$Locations$Teamfolders$Querycontents extends StandardParameters {
9455
9666
  /**
9456
- * Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: - `filter="display_name="MyFolder""`
9667
+ * Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter="display_name="MyFolder""`
9457
9668
  */
9458
9669
  filter?: string;
9459
9670
  /**
9460
- * 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"`
9671
+ * 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"`
9461
9672
  */
9462
9673
  orderBy?: string;
9463
9674
  /**
@@ -9469,13 +9680,13 @@ export declare namespace dataform_v1beta1 {
9469
9680
  */
9470
9681
  pageToken?: string;
9471
9682
  /**
9472
- * Required. Name of the team_folder whose contents to list. Format: `projects/x/locations/x/teamFolders/x`.
9683
+ * Required. Resource name of the TeamFolder to list contents for. Format: `projects/x/locations/x/teamFolders/x`.
9473
9684
  */
9474
9685
  teamFolder?: string;
9475
9686
  }
9476
9687
  export interface Params$Resource$Projects$Locations$Teamfolders$Search extends StandardParameters {
9477
9688
  /**
9478
- * Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: - `filter="display_name="MyFolder""`
9689
+ * Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter="display_name="MyFolder""`
9479
9690
  */
9480
9691
  filter?: string;
9481
9692
  /**
@@ -9483,7 +9694,7 @@ export declare namespace dataform_v1beta1 {
9483
9694
  */
9484
9695
  location?: string;
9485
9696
  /**
9486
- * 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"`
9697
+ * 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"`
9487
9698
  */
9488
9699
  orderBy?: string;
9489
9700
  /**