@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/build/v1beta1.d.ts
CHANGED
|
@@ -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,18 +584,49 @@ 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
|
+
* `DeleteRepositoryLongRunning` request message.
|
|
598
|
+
*/
|
|
599
|
+
export interface Schema$DeleteRepositoryLongRunningRequest {
|
|
600
|
+
/**
|
|
601
|
+
* 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.*
|
|
602
|
+
*/
|
|
603
|
+
force?: boolean | null;
|
|
604
|
+
}
|
|
605
|
+
/**
|
|
606
|
+
* `DeleteTeamFolderTree` request message.
|
|
607
|
+
*/
|
|
608
|
+
export interface Schema$DeleteTeamFolderTreeRequest {
|
|
609
|
+
/**
|
|
610
|
+
* 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.
|
|
611
|
+
*/
|
|
612
|
+
force?: boolean | null;
|
|
613
|
+
}
|
|
587
614
|
/**
|
|
588
615
|
* Represents a single entry in a directory.
|
|
589
616
|
*/
|
|
590
617
|
export interface Schema$DirectoryEntry {
|
|
591
618
|
/**
|
|
592
|
-
* A child directory in the directory.
|
|
619
|
+
* A child directory in the directory. The path is returned including the full folder structure from the root.
|
|
593
620
|
*/
|
|
594
621
|
directory?: string | null;
|
|
595
622
|
/**
|
|
596
|
-
* A file in the directory.
|
|
623
|
+
* A file in the directory. The path is returned including the full folder structure from the root.
|
|
597
624
|
*/
|
|
598
625
|
file?: string | null;
|
|
626
|
+
/**
|
|
627
|
+
* Entry with metadata.
|
|
628
|
+
*/
|
|
629
|
+
metadata?: Schema$FilesystemEntryMetadata;
|
|
599
630
|
}
|
|
600
631
|
/**
|
|
601
632
|
* Client-facing representation of a directory entry in search results.
|
|
@@ -720,12 +751,25 @@ export declare namespace dataform_v1beta1 {
|
|
|
720
751
|
*/
|
|
721
752
|
path?: string | null;
|
|
722
753
|
}
|
|
754
|
+
/**
|
|
755
|
+
* Represents metadata for a single entry in a filesystem.
|
|
756
|
+
*/
|
|
757
|
+
export interface Schema$FilesystemEntryMetadata {
|
|
758
|
+
/**
|
|
759
|
+
* Output only. Provides the size of the entry in bytes. For directories, this will be 0.
|
|
760
|
+
*/
|
|
761
|
+
sizeBytes?: string | null;
|
|
762
|
+
/**
|
|
763
|
+
* Output only. Represents the time of the last modification of the entry.
|
|
764
|
+
*/
|
|
765
|
+
updateTime?: string | null;
|
|
766
|
+
}
|
|
723
767
|
/**
|
|
724
768
|
* Represents a Dataform Folder. This is a resource that is used to organize Files and other Folders and provide hierarchical access controls.
|
|
725
769
|
*/
|
|
726
770
|
export interface Schema$Folder {
|
|
727
771
|
/**
|
|
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
|
|
772
|
+
* 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
773
|
*/
|
|
730
774
|
containingFolder?: string | null;
|
|
731
775
|
/**
|
|
@@ -779,9 +823,13 @@ export declare namespace dataform_v1beta1 {
|
|
|
779
823
|
*/
|
|
780
824
|
authenticationTokenSecretVersion?: string | null;
|
|
781
825
|
/**
|
|
782
|
-
*
|
|
826
|
+
* Optional. The Git remote's default branch name. If not set `main` will be used.
|
|
783
827
|
*/
|
|
784
828
|
defaultBranch?: string | null;
|
|
829
|
+
/**
|
|
830
|
+
* 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`.
|
|
831
|
+
*/
|
|
832
|
+
effectiveDefaultBranch?: string | null;
|
|
785
833
|
/**
|
|
786
834
|
* Optional. Authentication fields for remote uris using SSH protocol.
|
|
787
835
|
*/
|
|
@@ -915,7 +963,7 @@ export declare namespace dataform_v1beta1 {
|
|
|
915
963
|
*/
|
|
916
964
|
nextPageToken?: string | null;
|
|
917
965
|
/**
|
|
918
|
-
* Locations which could not be reached.
|
|
966
|
+
* Locations which could not be reached. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ListCompilationResultsResponse)
|
|
919
967
|
*/
|
|
920
968
|
unreachable?: string[] | null;
|
|
921
969
|
}
|
|
@@ -962,7 +1010,7 @@ export declare namespace dataform_v1beta1 {
|
|
|
962
1010
|
*/
|
|
963
1011
|
releaseConfigs?: Schema$ReleaseConfig[];
|
|
964
1012
|
/**
|
|
965
|
-
* Locations which could not be reached.
|
|
1013
|
+
* Locations which could not be reached. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ListReleaseConfigsResponse)
|
|
966
1014
|
*/
|
|
967
1015
|
unreachable?: string[] | null;
|
|
968
1016
|
}
|
|
@@ -1139,7 +1187,7 @@ export declare namespace dataform_v1beta1 {
|
|
|
1139
1187
|
*/
|
|
1140
1188
|
export interface Schema$MoveFolderRequest {
|
|
1141
1189
|
/**
|
|
1142
|
-
*
|
|
1190
|
+
* 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
1191
|
*/
|
|
1144
1192
|
destinationContainingFolder?: string | null;
|
|
1145
1193
|
}
|
|
@@ -1148,7 +1196,7 @@ export declare namespace dataform_v1beta1 {
|
|
|
1148
1196
|
*/
|
|
1149
1197
|
export interface Schema$MoveRepositoryRequest {
|
|
1150
1198
|
/**
|
|
1151
|
-
*
|
|
1199
|
+
* 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
1200
|
*/
|
|
1153
1201
|
destinationContainingFolder?: string | null;
|
|
1154
1202
|
}
|
|
@@ -1182,7 +1230,7 @@ export declare namespace dataform_v1beta1 {
|
|
|
1182
1230
|
*/
|
|
1183
1231
|
contents?: string | null;
|
|
1184
1232
|
/**
|
|
1185
|
-
* Output only. The ID of the
|
|
1233
|
+
* 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
1234
|
*/
|
|
1187
1235
|
jobId?: string | null;
|
|
1188
1236
|
}
|
|
@@ -1489,7 +1537,7 @@ export declare namespace dataform_v1beta1 {
|
|
|
1489
1537
|
*/
|
|
1490
1538
|
clusterExpressions?: string[] | null;
|
|
1491
1539
|
/**
|
|
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\}
|
|
1540
|
+
* 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
1541
|
*/
|
|
1494
1542
|
connection?: string | null;
|
|
1495
1543
|
/**
|
|
@@ -1593,7 +1641,7 @@ export declare namespace dataform_v1beta1 {
|
|
|
1593
1641
|
*/
|
|
1594
1642
|
gitCommitish?: string | null;
|
|
1595
1643
|
/**
|
|
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.
|
|
1644
|
+
* 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
1645
|
*/
|
|
1598
1646
|
internalMetadata?: string | null;
|
|
1599
1647
|
/**
|
|
@@ -2319,7 +2367,7 @@ export declare namespace dataform_v1beta1 {
|
|
|
2319
2367
|
getConfig(params: Params$Resource$Projects$Locations$Getconfig, callback: BodyResponseCallback<Schema$Config>): void;
|
|
2320
2368
|
getConfig(callback: BodyResponseCallback<Schema$Config>): void;
|
|
2321
2369
|
/**
|
|
2322
|
-
* Lists information about the supported locations for this service.
|
|
2370
|
+
* 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
2371
|
* @example
|
|
2324
2372
|
* ```js
|
|
2325
2373
|
* // Before running the sample:
|
|
@@ -2352,7 +2400,7 @@ export declare namespace dataform_v1beta1 {
|
|
|
2352
2400
|
*
|
|
2353
2401
|
* // Do the magic
|
|
2354
2402
|
* const res = await dataform.projects.locations.list({
|
|
2355
|
-
* // Optional. Do not use this field
|
|
2403
|
+
* // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.
|
|
2356
2404
|
* extraLocationTypes: 'placeholder-value',
|
|
2357
2405
|
* // 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
2406
|
* filter: 'placeholder-value',
|
|
@@ -2424,11 +2472,11 @@ export declare namespace dataform_v1beta1 {
|
|
|
2424
2472
|
*
|
|
2425
2473
|
* // Do the magic
|
|
2426
2474
|
* 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:
|
|
2475
|
+
* // Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter="display_name="MyFolder""`
|
|
2428
2476
|
* filter: 'placeholder-value',
|
|
2429
|
-
* // Required. Location of the user root folder
|
|
2477
|
+
* // Required. Location of the user root folder to list contents for. Format: projects/x/locations/x
|
|
2430
2478
|
* 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:
|
|
2479
|
+
* // 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
2480
|
* orderBy: 'placeholder-value',
|
|
2433
2481
|
* // 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
2482
|
* pageSize: 'placeholder-value',
|
|
@@ -2554,7 +2602,7 @@ export declare namespace dataform_v1beta1 {
|
|
|
2554
2602
|
}
|
|
2555
2603
|
export interface Params$Resource$Projects$Locations$List extends StandardParameters {
|
|
2556
2604
|
/**
|
|
2557
|
-
* Optional. Do not use this field
|
|
2605
|
+
* Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.
|
|
2558
2606
|
*/
|
|
2559
2607
|
extraLocationTypes?: string[];
|
|
2560
2608
|
/**
|
|
@@ -2576,15 +2624,15 @@ export declare namespace dataform_v1beta1 {
|
|
|
2576
2624
|
}
|
|
2577
2625
|
export interface Params$Resource$Projects$Locations$Queryuserrootcontents extends StandardParameters {
|
|
2578
2626
|
/**
|
|
2579
|
-
* Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example:
|
|
2627
|
+
* Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter="display_name="MyFolder""`
|
|
2580
2628
|
*/
|
|
2581
2629
|
filter?: string;
|
|
2582
2630
|
/**
|
|
2583
|
-
* Required. Location of the user root folder
|
|
2631
|
+
* Required. Location of the user root folder to list contents for. Format: projects/x/locations/x
|
|
2584
2632
|
*/
|
|
2585
2633
|
location?: string;
|
|
2586
2634
|
/**
|
|
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:
|
|
2635
|
+
* 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
2636
|
*/
|
|
2589
2637
|
orderBy?: string;
|
|
2590
2638
|
/**
|
|
@@ -2647,7 +2695,7 @@ export declare namespace dataform_v1beta1 {
|
|
|
2647
2695
|
*
|
|
2648
2696
|
* // Do the magic
|
|
2649
2697
|
* 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.
|
|
2698
|
+
* // 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
2699
|
* folderId: 'placeholder-value',
|
|
2652
2700
|
* // Required. The location in which to create the Folder. Must be in the format `projects/x/locations/x`.
|
|
2653
2701
|
* parent: 'projects/my-project/locations/my-location',
|
|
@@ -2761,6 +2809,81 @@ export declare namespace dataform_v1beta1 {
|
|
|
2761
2809
|
delete(params: Params$Resource$Projects$Locations$Folders$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
|
|
2762
2810
|
delete(params: Params$Resource$Projects$Locations$Folders$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
|
|
2763
2811
|
delete(callback: BodyResponseCallback<Schema$Empty>): void;
|
|
2812
|
+
/**
|
|
2813
|
+
* Deletes a Folder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).
|
|
2814
|
+
* @example
|
|
2815
|
+
* ```js
|
|
2816
|
+
* // Before running the sample:
|
|
2817
|
+
* // - Enable the API at:
|
|
2818
|
+
* // https://console.developers.google.com/apis/api/dataform.googleapis.com
|
|
2819
|
+
* // - Login into gcloud by running:
|
|
2820
|
+
* // ```sh
|
|
2821
|
+
* // $ gcloud auth application-default login
|
|
2822
|
+
* // ```
|
|
2823
|
+
* // - Install the npm module by running:
|
|
2824
|
+
* // ```sh
|
|
2825
|
+
* // $ npm install googleapis
|
|
2826
|
+
* // ```
|
|
2827
|
+
*
|
|
2828
|
+
* const {google} = require('googleapis');
|
|
2829
|
+
* const dataform = google.dataform('v1beta1');
|
|
2830
|
+
*
|
|
2831
|
+
* async function main() {
|
|
2832
|
+
* const auth = new google.auth.GoogleAuth({
|
|
2833
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2834
|
+
* scopes: [
|
|
2835
|
+
* 'https://www.googleapis.com/auth/bigquery',
|
|
2836
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
2837
|
+
* ],
|
|
2838
|
+
* });
|
|
2839
|
+
*
|
|
2840
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
2841
|
+
* const authClient = await auth.getClient();
|
|
2842
|
+
* google.options({auth: authClient});
|
|
2843
|
+
*
|
|
2844
|
+
* // Do the magic
|
|
2845
|
+
* const res = await dataform.projects.locations.folders.deleteTree({
|
|
2846
|
+
* // Required. The Folder's name. Format: projects/{project\}/locations/{location\}/folders/{folder\}
|
|
2847
|
+
* name: 'projects/my-project/locations/my-location/folders/my-folder',
|
|
2848
|
+
*
|
|
2849
|
+
* // Request body metadata
|
|
2850
|
+
* requestBody: {
|
|
2851
|
+
* // request body parameters
|
|
2852
|
+
* // {
|
|
2853
|
+
* // "force": false
|
|
2854
|
+
* // }
|
|
2855
|
+
* },
|
|
2856
|
+
* });
|
|
2857
|
+
* console.log(res.data);
|
|
2858
|
+
*
|
|
2859
|
+
* // Example response
|
|
2860
|
+
* // {
|
|
2861
|
+
* // "done": false,
|
|
2862
|
+
* // "error": {},
|
|
2863
|
+
* // "metadata": {},
|
|
2864
|
+
* // "name": "my_name",
|
|
2865
|
+
* // "response": {}
|
|
2866
|
+
* // }
|
|
2867
|
+
* }
|
|
2868
|
+
*
|
|
2869
|
+
* main().catch(e => {
|
|
2870
|
+
* console.error(e);
|
|
2871
|
+
* throw e;
|
|
2872
|
+
* });
|
|
2873
|
+
*
|
|
2874
|
+
* ```
|
|
2875
|
+
*
|
|
2876
|
+
* @param params - Parameters for request
|
|
2877
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2878
|
+
* @param callback - Optional callback that handles the response.
|
|
2879
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2880
|
+
*/
|
|
2881
|
+
deleteTree(params: Params$Resource$Projects$Locations$Folders$Deletetree, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
2882
|
+
deleteTree(params?: Params$Resource$Projects$Locations$Folders$Deletetree, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
2883
|
+
deleteTree(params: Params$Resource$Projects$Locations$Folders$Deletetree, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2884
|
+
deleteTree(params: Params$Resource$Projects$Locations$Folders$Deletetree, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2885
|
+
deleteTree(params: Params$Resource$Projects$Locations$Folders$Deletetree, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2886
|
+
deleteTree(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2764
2887
|
/**
|
|
2765
2888
|
* Fetches a single Folder.
|
|
2766
2889
|
* @example
|
|
@@ -3094,11 +3217,11 @@ export declare namespace dataform_v1beta1 {
|
|
|
3094
3217
|
*
|
|
3095
3218
|
* // Do the magic
|
|
3096
3219
|
* 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:
|
|
3220
|
+
* // Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter="display_name="MyFolder""`
|
|
3098
3221
|
* filter: 'placeholder-value',
|
|
3099
|
-
* // Required.
|
|
3222
|
+
* // Required. Resource name of the Folder to list contents for. Format: projects/x/locations/x/folders/x
|
|
3100
3223
|
* 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:
|
|
3224
|
+
* // 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
3225
|
* orderBy: 'placeholder-value',
|
|
3103
3226
|
* // 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
3227
|
* pageSize: 'placeholder-value',
|
|
@@ -3279,7 +3402,7 @@ export declare namespace dataform_v1beta1 {
|
|
|
3279
3402
|
}
|
|
3280
3403
|
export interface Params$Resource$Projects$Locations$Folders$Create extends StandardParameters {
|
|
3281
3404
|
/**
|
|
3282
|
-
* The ID to use for the Folder, which will become the final component of the Folder's resource name.
|
|
3405
|
+
* 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
3406
|
*/
|
|
3284
3407
|
folderId?: string;
|
|
3285
3408
|
/**
|
|
@@ -3297,6 +3420,16 @@ export declare namespace dataform_v1beta1 {
|
|
|
3297
3420
|
*/
|
|
3298
3421
|
name?: string;
|
|
3299
3422
|
}
|
|
3423
|
+
export interface Params$Resource$Projects$Locations$Folders$Deletetree extends StandardParameters {
|
|
3424
|
+
/**
|
|
3425
|
+
* Required. The Folder's name. Format: projects/{project\}/locations/{location\}/folders/{folder\}
|
|
3426
|
+
*/
|
|
3427
|
+
name?: string;
|
|
3428
|
+
/**
|
|
3429
|
+
* Request body metadata
|
|
3430
|
+
*/
|
|
3431
|
+
requestBody?: Schema$DeleteFolderTreeRequest;
|
|
3432
|
+
}
|
|
3300
3433
|
export interface Params$Resource$Projects$Locations$Folders$Get extends StandardParameters {
|
|
3301
3434
|
/**
|
|
3302
3435
|
* Required. The Folder's name.
|
|
@@ -3339,15 +3472,15 @@ export declare namespace dataform_v1beta1 {
|
|
|
3339
3472
|
}
|
|
3340
3473
|
export interface Params$Resource$Projects$Locations$Folders$Queryfoldercontents extends StandardParameters {
|
|
3341
3474
|
/**
|
|
3342
|
-
* Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example:
|
|
3475
|
+
* Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter="display_name="MyFolder""`
|
|
3343
3476
|
*/
|
|
3344
3477
|
filter?: string;
|
|
3345
3478
|
/**
|
|
3346
|
-
* Required.
|
|
3479
|
+
* Required. Resource name of the Folder to list contents for. Format: projects/x/locations/x/folders/x
|
|
3347
3480
|
*/
|
|
3348
3481
|
folder?: string;
|
|
3349
3482
|
/**
|
|
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:
|
|
3483
|
+
* 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
3484
|
*/
|
|
3352
3485
|
orderBy?: string;
|
|
3353
3486
|
/**
|
|
@@ -4002,6 +4135,81 @@ export declare namespace dataform_v1beta1 {
|
|
|
4002
4135
|
delete(params: Params$Resource$Projects$Locations$Repositories$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
|
|
4003
4136
|
delete(params: Params$Resource$Projects$Locations$Repositories$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
|
|
4004
4137
|
delete(callback: BodyResponseCallback<Schema$Empty>): void;
|
|
4138
|
+
/**
|
|
4139
|
+
* Deletes a single Repository asynchronously.
|
|
4140
|
+
* @example
|
|
4141
|
+
* ```js
|
|
4142
|
+
* // Before running the sample:
|
|
4143
|
+
* // - Enable the API at:
|
|
4144
|
+
* // https://console.developers.google.com/apis/api/dataform.googleapis.com
|
|
4145
|
+
* // - Login into gcloud by running:
|
|
4146
|
+
* // ```sh
|
|
4147
|
+
* // $ gcloud auth application-default login
|
|
4148
|
+
* // ```
|
|
4149
|
+
* // - Install the npm module by running:
|
|
4150
|
+
* // ```sh
|
|
4151
|
+
* // $ npm install googleapis
|
|
4152
|
+
* // ```
|
|
4153
|
+
*
|
|
4154
|
+
* const {google} = require('googleapis');
|
|
4155
|
+
* const dataform = google.dataform('v1beta1');
|
|
4156
|
+
*
|
|
4157
|
+
* async function main() {
|
|
4158
|
+
* const auth = new google.auth.GoogleAuth({
|
|
4159
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
4160
|
+
* scopes: [
|
|
4161
|
+
* 'https://www.googleapis.com/auth/bigquery',
|
|
4162
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
4163
|
+
* ],
|
|
4164
|
+
* });
|
|
4165
|
+
*
|
|
4166
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
4167
|
+
* const authClient = await auth.getClient();
|
|
4168
|
+
* google.options({auth: authClient});
|
|
4169
|
+
*
|
|
4170
|
+
* // Do the magic
|
|
4171
|
+
* const res = await dataform.projects.locations.repositories.deleteLongRunning({
|
|
4172
|
+
* // Required. The repository's name.
|
|
4173
|
+
* name: 'projects/my-project/locations/my-location/repositories/my-repositorie',
|
|
4174
|
+
*
|
|
4175
|
+
* // Request body metadata
|
|
4176
|
+
* requestBody: {
|
|
4177
|
+
* // request body parameters
|
|
4178
|
+
* // {
|
|
4179
|
+
* // "force": false
|
|
4180
|
+
* // }
|
|
4181
|
+
* },
|
|
4182
|
+
* });
|
|
4183
|
+
* console.log(res.data);
|
|
4184
|
+
*
|
|
4185
|
+
* // Example response
|
|
4186
|
+
* // {
|
|
4187
|
+
* // "done": false,
|
|
4188
|
+
* // "error": {},
|
|
4189
|
+
* // "metadata": {},
|
|
4190
|
+
* // "name": "my_name",
|
|
4191
|
+
* // "response": {}
|
|
4192
|
+
* // }
|
|
4193
|
+
* }
|
|
4194
|
+
*
|
|
4195
|
+
* main().catch(e => {
|
|
4196
|
+
* console.error(e);
|
|
4197
|
+
* throw e;
|
|
4198
|
+
* });
|
|
4199
|
+
*
|
|
4200
|
+
* ```
|
|
4201
|
+
*
|
|
4202
|
+
* @param params - Parameters for request
|
|
4203
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
4204
|
+
* @param callback - Optional callback that handles the response.
|
|
4205
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
4206
|
+
*/
|
|
4207
|
+
deleteLongRunning(params: Params$Resource$Projects$Locations$Repositories$Deletelongrunning, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
4208
|
+
deleteLongRunning(params?: Params$Resource$Projects$Locations$Repositories$Deletelongrunning, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
4209
|
+
deleteLongRunning(params: Params$Resource$Projects$Locations$Repositories$Deletelongrunning, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
4210
|
+
deleteLongRunning(params: Params$Resource$Projects$Locations$Repositories$Deletelongrunning, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
4211
|
+
deleteLongRunning(params: Params$Resource$Projects$Locations$Repositories$Deletelongrunning, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
4212
|
+
deleteLongRunning(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
4005
4213
|
/**
|
|
4006
4214
|
* Fetches a Repository's history of commits. The Repository must not have a value for `git_remote_settings.url`.
|
|
4007
4215
|
* @example
|
|
@@ -4854,6 +5062,16 @@ export declare namespace dataform_v1beta1 {
|
|
|
4854
5062
|
*/
|
|
4855
5063
|
name?: string;
|
|
4856
5064
|
}
|
|
5065
|
+
export interface Params$Resource$Projects$Locations$Repositories$Deletelongrunning extends StandardParameters {
|
|
5066
|
+
/**
|
|
5067
|
+
* Required. The repository's name.
|
|
5068
|
+
*/
|
|
5069
|
+
name?: string;
|
|
5070
|
+
/**
|
|
5071
|
+
* Request body metadata
|
|
5072
|
+
*/
|
|
5073
|
+
requestBody?: Schema$DeleteRepositoryLongRunningRequest;
|
|
5074
|
+
}
|
|
4857
5075
|
export interface Params$Resource$Projects$Locations$Repositories$Fetchhistory extends StandardParameters {
|
|
4858
5076
|
/**
|
|
4859
5077
|
* Required. The repository's name.
|
|
@@ -5125,7 +5343,7 @@ export declare namespace dataform_v1beta1 {
|
|
|
5125
5343
|
* // Do the magic
|
|
5126
5344
|
* const res =
|
|
5127
5345
|
* await dataform.projects.locations.repositories.compilationResults.get({
|
|
5128
|
-
* // Required. The compilation result's name.
|
|
5346
|
+
* // Required. The compilation result's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:GetCompilationResultRequest)
|
|
5129
5347
|
* name: 'projects/my-project/locations/my-location/repositories/my-repositorie/compilationResults/my-compilationResult',
|
|
5130
5348
|
* });
|
|
5131
5349
|
* console.log(res.data);
|
|
@@ -5200,7 +5418,7 @@ export declare namespace dataform_v1beta1 {
|
|
|
5200
5418
|
* // Do the magic
|
|
5201
5419
|
* const res =
|
|
5202
5420
|
* await dataform.projects.locations.repositories.compilationResults.list({
|
|
5203
|
-
* // Optional. Filter for the returned list.
|
|
5421
|
+
* // Optional. Filter for the returned list. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ListCompilationResultsRequest)
|
|
5204
5422
|
* filter: 'placeholder-value',
|
|
5205
5423
|
* // 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
5424
|
* orderBy: 'placeholder-value',
|
|
@@ -5324,13 +5542,13 @@ export declare namespace dataform_v1beta1 {
|
|
|
5324
5542
|
}
|
|
5325
5543
|
export interface Params$Resource$Projects$Locations$Repositories$Compilationresults$Get extends StandardParameters {
|
|
5326
5544
|
/**
|
|
5327
|
-
* Required. The compilation result's name.
|
|
5545
|
+
* Required. The compilation result's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:GetCompilationResultRequest)
|
|
5328
5546
|
*/
|
|
5329
5547
|
name?: string;
|
|
5330
5548
|
}
|
|
5331
5549
|
export interface Params$Resource$Projects$Locations$Repositories$Compilationresults$List extends StandardParameters {
|
|
5332
5550
|
/**
|
|
5333
|
-
* Optional. Filter for the returned list.
|
|
5551
|
+
* Optional. Filter for the returned list. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ListCompilationResultsRequest)
|
|
5334
5552
|
*/
|
|
5335
5553
|
filter?: string;
|
|
5336
5554
|
/**
|
|
@@ -5409,7 +5627,7 @@ export declare namespace dataform_v1beta1 {
|
|
|
5409
5627
|
* // Required. The repository in which to create the release config. Must be in the format `projects/x/locations/x/repositories/x`.
|
|
5410
5628
|
* parent:
|
|
5411
5629
|
* '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.
|
|
5630
|
+
* // 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
5631
|
* releaseConfigId: 'placeholder-value',
|
|
5414
5632
|
*
|
|
5415
5633
|
* // Request body metadata
|
|
@@ -5497,7 +5715,7 @@ export declare namespace dataform_v1beta1 {
|
|
|
5497
5715
|
* // Do the magic
|
|
5498
5716
|
* const res =
|
|
5499
5717
|
* await dataform.projects.locations.repositories.releaseConfigs.delete({
|
|
5500
|
-
* // Required. The release config's name.
|
|
5718
|
+
* // Required. The release config's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:DeleteReleaseConfigRequest)
|
|
5501
5719
|
* name: 'projects/my-project/locations/my-location/repositories/my-repositorie/releaseConfigs/my-releaseConfig',
|
|
5502
5720
|
* });
|
|
5503
5721
|
* console.log(res.data);
|
|
@@ -5559,7 +5777,7 @@ export declare namespace dataform_v1beta1 {
|
|
|
5559
5777
|
* // Do the magic
|
|
5560
5778
|
* const res = await dataform.projects.locations.repositories.releaseConfigs.get(
|
|
5561
5779
|
* {
|
|
5562
|
-
* // Required. The release config's name.
|
|
5780
|
+
* // Required. The release config's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:GetReleaseConfigRequest)
|
|
5563
5781
|
* name: 'projects/my-project/locations/my-location/repositories/my-repositorie/releaseConfigs/my-releaseConfig',
|
|
5564
5782
|
* },
|
|
5565
5783
|
* );
|
|
@@ -5634,7 +5852,7 @@ export declare namespace dataform_v1beta1 {
|
|
|
5634
5852
|
* await dataform.projects.locations.repositories.releaseConfigs.list({
|
|
5635
5853
|
* // 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
5854
|
* 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.
|
|
5855
|
+
* // 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
5856
|
* pageToken: 'placeholder-value',
|
|
5639
5857
|
* // Required. The repository in which to list release configs. Must be in the format `projects/x/locations/x/repositories/x`.
|
|
5640
5858
|
* parent:
|
|
@@ -5765,7 +5983,7 @@ export declare namespace dataform_v1beta1 {
|
|
|
5765
5983
|
*/
|
|
5766
5984
|
parent?: string;
|
|
5767
5985
|
/**
|
|
5768
|
-
* Required. The ID to use for the release config, which will become the final component of the release config's resource name.
|
|
5986
|
+
* 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
5987
|
*/
|
|
5770
5988
|
releaseConfigId?: string;
|
|
5771
5989
|
/**
|
|
@@ -5775,13 +5993,13 @@ export declare namespace dataform_v1beta1 {
|
|
|
5775
5993
|
}
|
|
5776
5994
|
export interface Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Delete extends StandardParameters {
|
|
5777
5995
|
/**
|
|
5778
|
-
* Required. The release config's name.
|
|
5996
|
+
* Required. The release config's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:DeleteReleaseConfigRequest)
|
|
5779
5997
|
*/
|
|
5780
5998
|
name?: string;
|
|
5781
5999
|
}
|
|
5782
6000
|
export interface Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Get extends StandardParameters {
|
|
5783
6001
|
/**
|
|
5784
|
-
* Required. The release config's name.
|
|
6002
|
+
* Required. The release config's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:GetReleaseConfigRequest)
|
|
5785
6003
|
*/
|
|
5786
6004
|
name?: string;
|
|
5787
6005
|
}
|
|
@@ -5791,7 +6009,7 @@ export declare namespace dataform_v1beta1 {
|
|
|
5791
6009
|
*/
|
|
5792
6010
|
pageSize?: number;
|
|
5793
6011
|
/**
|
|
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.
|
|
6012
|
+
* 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
6013
|
*/
|
|
5796
6014
|
pageToken?: string;
|
|
5797
6015
|
/**
|
|
@@ -7871,6 +8089,8 @@ export declare namespace dataform_v1beta1 {
|
|
|
7871
8089
|
* pageToken: 'placeholder-value',
|
|
7872
8090
|
* // Optional. The directory's full path including directory name, relative to the workspace root. If left unset, the workspace root is used.
|
|
7873
8091
|
* path: 'placeholder-value',
|
|
8092
|
+
* // 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.
|
|
8093
|
+
* view: 'placeholder-value',
|
|
7874
8094
|
* // Required. The workspace's name.
|
|
7875
8095
|
* workspace:
|
|
7876
8096
|
* 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
|
|
@@ -8646,6 +8866,10 @@ export declare namespace dataform_v1beta1 {
|
|
|
8646
8866
|
* Optional. The directory's full path including directory name, relative to the workspace root. If left unset, the workspace root is used.
|
|
8647
8867
|
*/
|
|
8648
8868
|
path?: string;
|
|
8869
|
+
/**
|
|
8870
|
+
* 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.
|
|
8871
|
+
*/
|
|
8872
|
+
view?: string;
|
|
8649
8873
|
/**
|
|
8650
8874
|
* Required. The workspace's name.
|
|
8651
8875
|
*/
|
|
@@ -8782,7 +9006,7 @@ export declare namespace dataform_v1beta1 {
|
|
|
8782
9006
|
* const res = await dataform.projects.locations.teamFolders.create({
|
|
8783
9007
|
* // Required. The location in which to create the TeamFolder. Must be in the format `projects/x/locations/x`.
|
|
8784
9008
|
* 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.
|
|
9009
|
+
* // 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
9010
|
* teamFolderId: 'placeholder-value',
|
|
8787
9011
|
*
|
|
8788
9012
|
* // Request body metadata
|
|
@@ -8890,6 +9114,81 @@ export declare namespace dataform_v1beta1 {
|
|
|
8890
9114
|
delete(params: Params$Resource$Projects$Locations$Teamfolders$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
|
|
8891
9115
|
delete(params: Params$Resource$Projects$Locations$Teamfolders$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
|
|
8892
9116
|
delete(callback: BodyResponseCallback<Schema$Empty>): void;
|
|
9117
|
+
/**
|
|
9118
|
+
* Deletes a TeamFolder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).
|
|
9119
|
+
* @example
|
|
9120
|
+
* ```js
|
|
9121
|
+
* // Before running the sample:
|
|
9122
|
+
* // - Enable the API at:
|
|
9123
|
+
* // https://console.developers.google.com/apis/api/dataform.googleapis.com
|
|
9124
|
+
* // - Login into gcloud by running:
|
|
9125
|
+
* // ```sh
|
|
9126
|
+
* // $ gcloud auth application-default login
|
|
9127
|
+
* // ```
|
|
9128
|
+
* // - Install the npm module by running:
|
|
9129
|
+
* // ```sh
|
|
9130
|
+
* // $ npm install googleapis
|
|
9131
|
+
* // ```
|
|
9132
|
+
*
|
|
9133
|
+
* const {google} = require('googleapis');
|
|
9134
|
+
* const dataform = google.dataform('v1beta1');
|
|
9135
|
+
*
|
|
9136
|
+
* async function main() {
|
|
9137
|
+
* const auth = new google.auth.GoogleAuth({
|
|
9138
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
9139
|
+
* scopes: [
|
|
9140
|
+
* 'https://www.googleapis.com/auth/bigquery',
|
|
9141
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
9142
|
+
* ],
|
|
9143
|
+
* });
|
|
9144
|
+
*
|
|
9145
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
9146
|
+
* const authClient = await auth.getClient();
|
|
9147
|
+
* google.options({auth: authClient});
|
|
9148
|
+
*
|
|
9149
|
+
* // Do the magic
|
|
9150
|
+
* const res = await dataform.projects.locations.teamFolders.deleteTree({
|
|
9151
|
+
* // Required. The TeamFolder's name. Format: projects/{project\}/locations/{location\}/teamFolders/{team_folder\}
|
|
9152
|
+
* name: 'projects/my-project/locations/my-location/teamFolders/my-teamFolder',
|
|
9153
|
+
*
|
|
9154
|
+
* // Request body metadata
|
|
9155
|
+
* requestBody: {
|
|
9156
|
+
* // request body parameters
|
|
9157
|
+
* // {
|
|
9158
|
+
* // "force": false
|
|
9159
|
+
* // }
|
|
9160
|
+
* },
|
|
9161
|
+
* });
|
|
9162
|
+
* console.log(res.data);
|
|
9163
|
+
*
|
|
9164
|
+
* // Example response
|
|
9165
|
+
* // {
|
|
9166
|
+
* // "done": false,
|
|
9167
|
+
* // "error": {},
|
|
9168
|
+
* // "metadata": {},
|
|
9169
|
+
* // "name": "my_name",
|
|
9170
|
+
* // "response": {}
|
|
9171
|
+
* // }
|
|
9172
|
+
* }
|
|
9173
|
+
*
|
|
9174
|
+
* main().catch(e => {
|
|
9175
|
+
* console.error(e);
|
|
9176
|
+
* throw e;
|
|
9177
|
+
* });
|
|
9178
|
+
*
|
|
9179
|
+
* ```
|
|
9180
|
+
*
|
|
9181
|
+
* @param params - Parameters for request
|
|
9182
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
9183
|
+
* @param callback - Optional callback that handles the response.
|
|
9184
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
9185
|
+
*/
|
|
9186
|
+
deleteTree(params: Params$Resource$Projects$Locations$Teamfolders$Deletetree, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
9187
|
+
deleteTree(params?: Params$Resource$Projects$Locations$Teamfolders$Deletetree, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
9188
|
+
deleteTree(params: Params$Resource$Projects$Locations$Teamfolders$Deletetree, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
9189
|
+
deleteTree(params: Params$Resource$Projects$Locations$Teamfolders$Deletetree, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
9190
|
+
deleteTree(params: Params$Resource$Projects$Locations$Teamfolders$Deletetree, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
9191
|
+
deleteTree(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
8893
9192
|
/**
|
|
8894
9193
|
* Fetches a single TeamFolder.
|
|
8895
9194
|
* @example
|
|
@@ -9143,15 +9442,15 @@ export declare namespace dataform_v1beta1 {
|
|
|
9143
9442
|
*
|
|
9144
9443
|
* // Do the magic
|
|
9145
9444
|
* 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:
|
|
9445
|
+
* // Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter="display_name="MyFolder""`
|
|
9147
9446
|
* 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:
|
|
9447
|
+
* // 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
9448
|
* orderBy: 'placeholder-value',
|
|
9150
9449
|
* // 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
9450
|
* pageSize: 'placeholder-value',
|
|
9152
9451
|
* // 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
9452
|
* pageToken: 'placeholder-value',
|
|
9154
|
-
* // Required.
|
|
9453
|
+
* // Required. Resource name of the TeamFolder to list contents for. Format: `projects/x/locations/x/teamFolders/x`.
|
|
9155
9454
|
* teamFolder:
|
|
9156
9455
|
* 'projects/my-project/locations/my-location/teamFolders/my-teamFolder',
|
|
9157
9456
|
* });
|
|
@@ -9216,13 +9515,13 @@ export declare namespace dataform_v1beta1 {
|
|
|
9216
9515
|
*
|
|
9217
9516
|
* // Do the magic
|
|
9218
9517
|
* 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:
|
|
9518
|
+
* // Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter="display_name="MyFolder""`
|
|
9220
9519
|
* filter: 'placeholder-value',
|
|
9221
9520
|
* // Required. Location in which to query TeamFolders. Format: `projects/x/locations/x`.
|
|
9222
9521
|
* 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:
|
|
9522
|
+
* // 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
9523
|
* orderBy: 'placeholder-value',
|
|
9225
|
-
* // Optional. Maximum number of TeamFolders to return. The server may return fewer items than requested. If unspecified, the server will pick
|
|
9524
|
+
* // 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.
|
|
9226
9525
|
* pageSize: 'placeholder-value',
|
|
9227
9526
|
* // 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.
|
|
9228
9527
|
* pageToken: 'placeholder-value',
|
|
@@ -9407,7 +9706,7 @@ export declare namespace dataform_v1beta1 {
|
|
|
9407
9706
|
*/
|
|
9408
9707
|
parent?: string;
|
|
9409
9708
|
/**
|
|
9410
|
-
* The ID to use for the TeamFolder, which will become the final component of the TeamFolder's resource name.
|
|
9709
|
+
* 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
9710
|
*/
|
|
9412
9711
|
teamFolderId?: string;
|
|
9413
9712
|
/**
|
|
@@ -9421,6 +9720,16 @@ export declare namespace dataform_v1beta1 {
|
|
|
9421
9720
|
*/
|
|
9422
9721
|
name?: string;
|
|
9423
9722
|
}
|
|
9723
|
+
export interface Params$Resource$Projects$Locations$Teamfolders$Deletetree extends StandardParameters {
|
|
9724
|
+
/**
|
|
9725
|
+
* Required. The TeamFolder's name. Format: projects/{project\}/locations/{location\}/teamFolders/{team_folder\}
|
|
9726
|
+
*/
|
|
9727
|
+
name?: string;
|
|
9728
|
+
/**
|
|
9729
|
+
* Request body metadata
|
|
9730
|
+
*/
|
|
9731
|
+
requestBody?: Schema$DeleteTeamFolderTreeRequest;
|
|
9732
|
+
}
|
|
9424
9733
|
export interface Params$Resource$Projects$Locations$Teamfolders$Get extends StandardParameters {
|
|
9425
9734
|
/**
|
|
9426
9735
|
* Required. The TeamFolder's name.
|
|
@@ -9453,11 +9762,11 @@ export declare namespace dataform_v1beta1 {
|
|
|
9453
9762
|
}
|
|
9454
9763
|
export interface Params$Resource$Projects$Locations$Teamfolders$Querycontents extends StandardParameters {
|
|
9455
9764
|
/**
|
|
9456
|
-
* Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example:
|
|
9765
|
+
* Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter="display_name="MyFolder""`
|
|
9457
9766
|
*/
|
|
9458
9767
|
filter?: string;
|
|
9459
9768
|
/**
|
|
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:
|
|
9769
|
+
* 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
9770
|
*/
|
|
9462
9771
|
orderBy?: string;
|
|
9463
9772
|
/**
|
|
@@ -9469,13 +9778,13 @@ export declare namespace dataform_v1beta1 {
|
|
|
9469
9778
|
*/
|
|
9470
9779
|
pageToken?: string;
|
|
9471
9780
|
/**
|
|
9472
|
-
* Required.
|
|
9781
|
+
* Required. Resource name of the TeamFolder to list contents for. Format: `projects/x/locations/x/teamFolders/x`.
|
|
9473
9782
|
*/
|
|
9474
9783
|
teamFolder?: string;
|
|
9475
9784
|
}
|
|
9476
9785
|
export interface Params$Resource$Projects$Locations$Teamfolders$Search extends StandardParameters {
|
|
9477
9786
|
/**
|
|
9478
|
-
* Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example:
|
|
9787
|
+
* Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter="display_name="MyFolder""`
|
|
9479
9788
|
*/
|
|
9480
9789
|
filter?: string;
|
|
9481
9790
|
/**
|
|
@@ -9483,11 +9792,11 @@ export declare namespace dataform_v1beta1 {
|
|
|
9483
9792
|
*/
|
|
9484
9793
|
location?: string;
|
|
9485
9794
|
/**
|
|
9486
|
-
* Optional. Field to additionally sort results by. Supported keywords: `display_name` (default), `create_time`, `last_modified_time`. Examples:
|
|
9795
|
+
* 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
9796
|
*/
|
|
9488
9797
|
orderBy?: string;
|
|
9489
9798
|
/**
|
|
9490
|
-
* Optional. Maximum number of TeamFolders to return. The server may return fewer items than requested. If unspecified, the server will pick
|
|
9799
|
+
* 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.
|
|
9491
9800
|
*/
|
|
9492
9801
|
pageSize?: number;
|
|
9493
9802
|
/**
|