@googleapis/dataform 8.0.1 → 9.1.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/v1beta1.ts CHANGED
@@ -776,6 +776,19 @@ export namespace dataform_v1beta1 {
776
776
  */
777
777
  url?: string | null;
778
778
  }
779
+ /**
780
+ * Contains metadata about the IAM policy override for a given Dataform resource. If is_active is true, this the policy encoded in iam_policy_name is the source of truth for this resource. Will be provided in internal ESV2 views for: Workspaces, Repositories, Folders, TeamFolders.
781
+ */
782
+ export interface Schema$IamPolicyOverrideView {
783
+ /**
784
+ * The IAM policy name for the resource.
785
+ */
786
+ iamPolicyName?: Schema$PolicyName;
787
+ /**
788
+ * Whether the IAM policy encoded in this view is active.
789
+ */
790
+ isActive?: boolean | null;
791
+ }
779
792
  /**
780
793
  * Load definition for incremental load modes
781
794
  */
@@ -1110,6 +1123,10 @@ export namespace dataform_v1beta1 {
1110
1123
  * Configures various aspects of Dataform notebook runtime.
1111
1124
  */
1112
1125
  export interface Schema$NotebookRuntimeOptions {
1126
+ /**
1127
+ * Optional. The resource name of the [Colab runtime template] (https://cloud.google.com/colab/docs/runtimes), from which a runtime is created for notebook executions. If not specified, a runtime is created with Colab's default specifications.
1128
+ */
1129
+ aiPlatformNotebookRuntimeTemplate?: string | null;
1113
1130
  /**
1114
1131
  * Optional. The Google Cloud Storage location to upload the result to. Format: `gs://bucket-name`.
1115
1132
  */
@@ -1194,6 +1211,23 @@ export namespace dataform_v1beta1 {
1194
1211
  */
1195
1212
  version?: number | null;
1196
1213
  }
1214
+ /**
1215
+ * An internal name for an IAM policy, based on the resource to which the policy applies. Not to be confused with a resource's external full resource name. For more information on this distinction, see go/iam-full-resource-names.
1216
+ */
1217
+ export interface Schema$PolicyName {
1218
+ /**
1219
+ * Identifies an instance of the type. ID format varies by type. The ID format is defined in the IAM .service file that defines the type, either in path_mapping or in a comment.
1220
+ */
1221
+ id?: string | null;
1222
+ /**
1223
+ * For Cloud IAM: The location of the Policy. Must be empty or "global" for Policies owned by global IAM. Must name a region from prodspec/cloud-iam-cloudspec for Regional IAM Policies, see go/iam-faq#where-is-iam-currently-deployed. For Local IAM: This field should be set to "local".
1224
+ */
1225
+ region?: string | null;
1226
+ /**
1227
+ * Resource type. Types are defined in IAM's .service files. Valid values for type might be 'storage_buckets', 'compute_instances', 'resourcemanager_customers', 'billing_accounts', etc.
1228
+ */
1229
+ type?: string | null;
1230
+ }
1197
1231
  /**
1198
1232
  * `PullGitCommits` request message.
1199
1233
  */
@@ -1890,6 +1924,59 @@ export namespace dataform_v1beta1 {
1890
1924
 
1891
1925
  /**
1892
1926
  * Gets information about a location.
1927
+ * @example
1928
+ * ```js
1929
+ * // Before running the sample:
1930
+ * // - Enable the API at:
1931
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
1932
+ * // - Login into gcloud by running:
1933
+ * // ```sh
1934
+ * // $ gcloud auth application-default login
1935
+ * // ```
1936
+ * // - Install the npm module by running:
1937
+ * // ```sh
1938
+ * // $ npm install googleapis
1939
+ * // ```
1940
+ *
1941
+ * const {google} = require('googleapis');
1942
+ * const dataform = google.dataform('v1beta1');
1943
+ *
1944
+ * async function main() {
1945
+ * const auth = new google.auth.GoogleAuth({
1946
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1947
+ * scopes: [
1948
+ * 'https://www.googleapis.com/auth/bigquery',
1949
+ * 'https://www.googleapis.com/auth/cloud-platform',
1950
+ * ],
1951
+ * });
1952
+ *
1953
+ * // Acquire an auth client, and bind it to all future calls
1954
+ * const authClient = await auth.getClient();
1955
+ * google.options({auth: authClient});
1956
+ *
1957
+ * // Do the magic
1958
+ * const res = await dataform.projects.locations.get({
1959
+ * // Resource name for the location.
1960
+ * name: 'projects/my-project/locations/my-location',
1961
+ * });
1962
+ * console.log(res.data);
1963
+ *
1964
+ * // Example response
1965
+ * // {
1966
+ * // "displayName": "my_displayName",
1967
+ * // "labels": {},
1968
+ * // "locationId": "my_locationId",
1969
+ * // "metadata": {},
1970
+ * // "name": "my_name"
1971
+ * // }
1972
+ * }
1973
+ *
1974
+ * main().catch(e => {
1975
+ * console.error(e);
1976
+ * throw e;
1977
+ * });
1978
+ *
1979
+ * ```
1893
1980
  *
1894
1981
  * @param params - Parameters for request
1895
1982
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1978,6 +2065,56 @@ export namespace dataform_v1beta1 {
1978
2065
 
1979
2066
  /**
1980
2067
  * Get default config for a given project and location.
2068
+ * @example
2069
+ * ```js
2070
+ * // Before running the sample:
2071
+ * // - Enable the API at:
2072
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
2073
+ * // - Login into gcloud by running:
2074
+ * // ```sh
2075
+ * // $ gcloud auth application-default login
2076
+ * // ```
2077
+ * // - Install the npm module by running:
2078
+ * // ```sh
2079
+ * // $ npm install googleapis
2080
+ * // ```
2081
+ *
2082
+ * const {google} = require('googleapis');
2083
+ * const dataform = google.dataform('v1beta1');
2084
+ *
2085
+ * async function main() {
2086
+ * const auth = new google.auth.GoogleAuth({
2087
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2088
+ * scopes: [
2089
+ * 'https://www.googleapis.com/auth/bigquery',
2090
+ * 'https://www.googleapis.com/auth/cloud-platform',
2091
+ * ],
2092
+ * });
2093
+ *
2094
+ * // Acquire an auth client, and bind it to all future calls
2095
+ * const authClient = await auth.getClient();
2096
+ * google.options({auth: authClient});
2097
+ *
2098
+ * // Do the magic
2099
+ * const res = await dataform.projects.locations.getConfig({
2100
+ * // Required. The config name.
2101
+ * name: 'projects/my-project/locations/my-location/config',
2102
+ * });
2103
+ * console.log(res.data);
2104
+ *
2105
+ * // Example response
2106
+ * // {
2107
+ * // "defaultKmsKeyName": "my_defaultKmsKeyName",
2108
+ * // "name": "my_name"
2109
+ * // }
2110
+ * }
2111
+ *
2112
+ * main().catch(e => {
2113
+ * console.error(e);
2114
+ * throw e;
2115
+ * });
2116
+ *
2117
+ * ```
1981
2118
  *
1982
2119
  * @param params - Parameters for request
1983
2120
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2066,6 +2203,64 @@ export namespace dataform_v1beta1 {
2066
2203
 
2067
2204
  /**
2068
2205
  * Lists information about the supported locations for this service.
2206
+ * @example
2207
+ * ```js
2208
+ * // Before running the sample:
2209
+ * // - Enable the API at:
2210
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
2211
+ * // - Login into gcloud by running:
2212
+ * // ```sh
2213
+ * // $ gcloud auth application-default login
2214
+ * // ```
2215
+ * // - Install the npm module by running:
2216
+ * // ```sh
2217
+ * // $ npm install googleapis
2218
+ * // ```
2219
+ *
2220
+ * const {google} = require('googleapis');
2221
+ * const dataform = google.dataform('v1beta1');
2222
+ *
2223
+ * async function main() {
2224
+ * const auth = new google.auth.GoogleAuth({
2225
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2226
+ * scopes: [
2227
+ * 'https://www.googleapis.com/auth/bigquery',
2228
+ * 'https://www.googleapis.com/auth/cloud-platform',
2229
+ * ],
2230
+ * });
2231
+ *
2232
+ * // Acquire an auth client, and bind it to all future calls
2233
+ * const authClient = await auth.getClient();
2234
+ * google.options({auth: authClient});
2235
+ *
2236
+ * // Do the magic
2237
+ * const res = await dataform.projects.locations.list({
2238
+ * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.
2239
+ * extraLocationTypes: 'placeholder-value',
2240
+ * // 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).
2241
+ * filter: 'placeholder-value',
2242
+ * // The resource that owns the locations collection, if applicable.
2243
+ * name: 'projects/my-project',
2244
+ * // The maximum number of results to return. If not set, the service selects a default.
2245
+ * pageSize: 'placeholder-value',
2246
+ * // A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
2247
+ * pageToken: 'placeholder-value',
2248
+ * });
2249
+ * console.log(res.data);
2250
+ *
2251
+ * // Example response
2252
+ * // {
2253
+ * // "locations": [],
2254
+ * // "nextPageToken": "my_nextPageToken"
2255
+ * // }
2256
+ * }
2257
+ *
2258
+ * main().catch(e => {
2259
+ * console.error(e);
2260
+ * throw e;
2261
+ * });
2262
+ *
2263
+ * ```
2069
2264
  *
2070
2265
  * @param params - Parameters for request
2071
2266
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2159,6 +2354,67 @@ export namespace dataform_v1beta1 {
2159
2354
 
2160
2355
  /**
2161
2356
  * Update default config for a given project and location. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*
2357
+ * @example
2358
+ * ```js
2359
+ * // Before running the sample:
2360
+ * // - Enable the API at:
2361
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
2362
+ * // - Login into gcloud by running:
2363
+ * // ```sh
2364
+ * // $ gcloud auth application-default login
2365
+ * // ```
2366
+ * // - Install the npm module by running:
2367
+ * // ```sh
2368
+ * // $ npm install googleapis
2369
+ * // ```
2370
+ *
2371
+ * const {google} = require('googleapis');
2372
+ * const dataform = google.dataform('v1beta1');
2373
+ *
2374
+ * async function main() {
2375
+ * const auth = new google.auth.GoogleAuth({
2376
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2377
+ * scopes: [
2378
+ * 'https://www.googleapis.com/auth/bigquery',
2379
+ * 'https://www.googleapis.com/auth/cloud-platform',
2380
+ * ],
2381
+ * });
2382
+ *
2383
+ * // Acquire an auth client, and bind it to all future calls
2384
+ * const authClient = await auth.getClient();
2385
+ * google.options({auth: authClient});
2386
+ *
2387
+ * // Do the magic
2388
+ * const res = await dataform.projects.locations.updateConfig({
2389
+ * // Identifier. The config name.
2390
+ * name: 'projects/my-project/locations/my-location/config',
2391
+ * // Optional. Specifies the fields to be updated in the config.
2392
+ * updateMask: 'placeholder-value',
2393
+ *
2394
+ * // Request body metadata
2395
+ * requestBody: {
2396
+ * // request body parameters
2397
+ * // {
2398
+ * // "defaultKmsKeyName": "my_defaultKmsKeyName",
2399
+ * // "name": "my_name"
2400
+ * // }
2401
+ * },
2402
+ * });
2403
+ * console.log(res.data);
2404
+ *
2405
+ * // Example response
2406
+ * // {
2407
+ * // "defaultKmsKeyName": "my_defaultKmsKeyName",
2408
+ * // "name": "my_name"
2409
+ * // }
2410
+ * }
2411
+ *
2412
+ * main().catch(e => {
2413
+ * console.error(e);
2414
+ * throw e;
2415
+ * });
2416
+ *
2417
+ * ```
2162
2418
  *
2163
2419
  * @param params - Parameters for request
2164
2420
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2332,6 +2588,65 @@ export namespace dataform_v1beta1 {
2332
2588
 
2333
2589
  /**
2334
2590
  * Applies a Git commit to a Repository. The Repository must not have a value for `git_remote_settings.url`.
2591
+ * @example
2592
+ * ```js
2593
+ * // Before running the sample:
2594
+ * // - Enable the API at:
2595
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
2596
+ * // - Login into gcloud by running:
2597
+ * // ```sh
2598
+ * // $ gcloud auth application-default login
2599
+ * // ```
2600
+ * // - Install the npm module by running:
2601
+ * // ```sh
2602
+ * // $ npm install googleapis
2603
+ * // ```
2604
+ *
2605
+ * const {google} = require('googleapis');
2606
+ * const dataform = google.dataform('v1beta1');
2607
+ *
2608
+ * async function main() {
2609
+ * const auth = new google.auth.GoogleAuth({
2610
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2611
+ * scopes: [
2612
+ * 'https://www.googleapis.com/auth/bigquery',
2613
+ * 'https://www.googleapis.com/auth/cloud-platform',
2614
+ * ],
2615
+ * });
2616
+ *
2617
+ * // Acquire an auth client, and bind it to all future calls
2618
+ * const authClient = await auth.getClient();
2619
+ * google.options({auth: authClient});
2620
+ *
2621
+ * // Do the magic
2622
+ * const res = await dataform.projects.locations.repositories.commit({
2623
+ * // Required. The repository's name.
2624
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie',
2625
+ *
2626
+ * // Request body metadata
2627
+ * requestBody: {
2628
+ * // request body parameters
2629
+ * // {
2630
+ * // "commitMetadata": {},
2631
+ * // "fileOperations": {},
2632
+ * // "requiredHeadCommitSha": "my_requiredHeadCommitSha"
2633
+ * // }
2634
+ * },
2635
+ * });
2636
+ * console.log(res.data);
2637
+ *
2638
+ * // Example response
2639
+ * // {
2640
+ * // "commitSha": "my_commitSha"
2641
+ * // }
2642
+ * }
2643
+ *
2644
+ * main().catch(e => {
2645
+ * console.error(e);
2646
+ * throw e;
2647
+ * });
2648
+ *
2649
+ * ```
2335
2650
  *
2336
2651
  * @param params - Parameters for request
2337
2652
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2429,6 +2744,56 @@ export namespace dataform_v1beta1 {
2429
2744
 
2430
2745
  /**
2431
2746
  * Computes a Repository's Git access token status.
2747
+ * @example
2748
+ * ```js
2749
+ * // Before running the sample:
2750
+ * // - Enable the API at:
2751
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
2752
+ * // - Login into gcloud by running:
2753
+ * // ```sh
2754
+ * // $ gcloud auth application-default login
2755
+ * // ```
2756
+ * // - Install the npm module by running:
2757
+ * // ```sh
2758
+ * // $ npm install googleapis
2759
+ * // ```
2760
+ *
2761
+ * const {google} = require('googleapis');
2762
+ * const dataform = google.dataform('v1beta1');
2763
+ *
2764
+ * async function main() {
2765
+ * const auth = new google.auth.GoogleAuth({
2766
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2767
+ * scopes: [
2768
+ * 'https://www.googleapis.com/auth/bigquery',
2769
+ * 'https://www.googleapis.com/auth/cloud-platform',
2770
+ * ],
2771
+ * });
2772
+ *
2773
+ * // Acquire an auth client, and bind it to all future calls
2774
+ * const authClient = await auth.getClient();
2775
+ * google.options({auth: authClient});
2776
+ *
2777
+ * // Do the magic
2778
+ * const res =
2779
+ * await dataform.projects.locations.repositories.computeAccessTokenStatus({
2780
+ * // Required. The repository's name.
2781
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie',
2782
+ * });
2783
+ * console.log(res.data);
2784
+ *
2785
+ * // Example response
2786
+ * // {
2787
+ * // "tokenStatus": "my_tokenStatus"
2788
+ * // }
2789
+ * }
2790
+ *
2791
+ * main().catch(e => {
2792
+ * console.error(e);
2793
+ * throw e;
2794
+ * });
2795
+ *
2796
+ * ```
2432
2797
  *
2433
2798
  * @param params - Parameters for request
2434
2799
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2530,6 +2895,87 @@ export namespace dataform_v1beta1 {
2530
2895
 
2531
2896
  /**
2532
2897
  * Creates a new Repository in a given project and location.
2898
+ * @example
2899
+ * ```js
2900
+ * // Before running the sample:
2901
+ * // - Enable the API at:
2902
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
2903
+ * // - Login into gcloud by running:
2904
+ * // ```sh
2905
+ * // $ gcloud auth application-default login
2906
+ * // ```
2907
+ * // - Install the npm module by running:
2908
+ * // ```sh
2909
+ * // $ npm install googleapis
2910
+ * // ```
2911
+ *
2912
+ * const {google} = require('googleapis');
2913
+ * const dataform = google.dataform('v1beta1');
2914
+ *
2915
+ * async function main() {
2916
+ * const auth = new google.auth.GoogleAuth({
2917
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2918
+ * scopes: [
2919
+ * 'https://www.googleapis.com/auth/bigquery',
2920
+ * 'https://www.googleapis.com/auth/cloud-platform',
2921
+ * ],
2922
+ * });
2923
+ *
2924
+ * // Acquire an auth client, and bind it to all future calls
2925
+ * const authClient = await auth.getClient();
2926
+ * google.options({auth: authClient});
2927
+ *
2928
+ * // Do the magic
2929
+ * const res = await dataform.projects.locations.repositories.create({
2930
+ * // Required. The location in which to create the repository. Must be in the format `projects/x/locations/x`.
2931
+ * parent: 'projects/my-project/locations/my-location',
2932
+ * // Required. The ID to use for the repository, which will become the final component of the repository's resource name.
2933
+ * repositoryId: 'placeholder-value',
2934
+ *
2935
+ * // Request body metadata
2936
+ * requestBody: {
2937
+ * // request body parameters
2938
+ * // {
2939
+ * // "createTime": "my_createTime",
2940
+ * // "dataEncryptionState": {},
2941
+ * // "displayName": "my_displayName",
2942
+ * // "gitRemoteSettings": {},
2943
+ * // "internalMetadata": "my_internalMetadata",
2944
+ * // "kmsKeyName": "my_kmsKeyName",
2945
+ * // "labels": {},
2946
+ * // "name": "my_name",
2947
+ * // "npmrcEnvironmentVariablesSecretVersion": "my_npmrcEnvironmentVariablesSecretVersion",
2948
+ * // "serviceAccount": "my_serviceAccount",
2949
+ * // "setAuthenticatedUserAdmin": false,
2950
+ * // "workspaceCompilationOverrides": {}
2951
+ * // }
2952
+ * },
2953
+ * });
2954
+ * console.log(res.data);
2955
+ *
2956
+ * // Example response
2957
+ * // {
2958
+ * // "createTime": "my_createTime",
2959
+ * // "dataEncryptionState": {},
2960
+ * // "displayName": "my_displayName",
2961
+ * // "gitRemoteSettings": {},
2962
+ * // "internalMetadata": "my_internalMetadata",
2963
+ * // "kmsKeyName": "my_kmsKeyName",
2964
+ * // "labels": {},
2965
+ * // "name": "my_name",
2966
+ * // "npmrcEnvironmentVariablesSecretVersion": "my_npmrcEnvironmentVariablesSecretVersion",
2967
+ * // "serviceAccount": "my_serviceAccount",
2968
+ * // "setAuthenticatedUserAdmin": false,
2969
+ * // "workspaceCompilationOverrides": {}
2970
+ * // }
2971
+ * }
2972
+ *
2973
+ * main().catch(e => {
2974
+ * console.error(e);
2975
+ * throw e;
2976
+ * });
2977
+ *
2978
+ * ```
2533
2979
  *
2534
2980
  * @param params - Parameters for request
2535
2981
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2621,6 +3067,55 @@ export namespace dataform_v1beta1 {
2621
3067
 
2622
3068
  /**
2623
3069
  * Deletes a single Repository.
3070
+ * @example
3071
+ * ```js
3072
+ * // Before running the sample:
3073
+ * // - Enable the API at:
3074
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
3075
+ * // - Login into gcloud by running:
3076
+ * // ```sh
3077
+ * // $ gcloud auth application-default login
3078
+ * // ```
3079
+ * // - Install the npm module by running:
3080
+ * // ```sh
3081
+ * // $ npm install googleapis
3082
+ * // ```
3083
+ *
3084
+ * const {google} = require('googleapis');
3085
+ * const dataform = google.dataform('v1beta1');
3086
+ *
3087
+ * async function main() {
3088
+ * const auth = new google.auth.GoogleAuth({
3089
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3090
+ * scopes: [
3091
+ * 'https://www.googleapis.com/auth/bigquery',
3092
+ * 'https://www.googleapis.com/auth/cloud-platform',
3093
+ * ],
3094
+ * });
3095
+ *
3096
+ * // Acquire an auth client, and bind it to all future calls
3097
+ * const authClient = await auth.getClient();
3098
+ * google.options({auth: authClient});
3099
+ *
3100
+ * // Do the magic
3101
+ * const res = await dataform.projects.locations.repositories.delete({
3102
+ * // 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.*.
3103
+ * force: 'placeholder-value',
3104
+ * // Required. The repository's name.
3105
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie',
3106
+ * });
3107
+ * console.log(res.data);
3108
+ *
3109
+ * // Example response
3110
+ * // {}
3111
+ * }
3112
+ *
3113
+ * main().catch(e => {
3114
+ * console.error(e);
3115
+ * throw e;
3116
+ * });
3117
+ *
3118
+ * ```
2624
3119
  *
2625
3120
  * @param params - Parameters for request
2626
3121
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2709,6 +3204,60 @@ export namespace dataform_v1beta1 {
2709
3204
 
2710
3205
  /**
2711
3206
  * Fetches a Repository's history of commits. The Repository must not have a value for `git_remote_settings.url`.
3207
+ * @example
3208
+ * ```js
3209
+ * // Before running the sample:
3210
+ * // - Enable the API at:
3211
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
3212
+ * // - Login into gcloud by running:
3213
+ * // ```sh
3214
+ * // $ gcloud auth application-default login
3215
+ * // ```
3216
+ * // - Install the npm module by running:
3217
+ * // ```sh
3218
+ * // $ npm install googleapis
3219
+ * // ```
3220
+ *
3221
+ * const {google} = require('googleapis');
3222
+ * const dataform = google.dataform('v1beta1');
3223
+ *
3224
+ * async function main() {
3225
+ * const auth = new google.auth.GoogleAuth({
3226
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3227
+ * scopes: [
3228
+ * 'https://www.googleapis.com/auth/bigquery',
3229
+ * 'https://www.googleapis.com/auth/cloud-platform',
3230
+ * ],
3231
+ * });
3232
+ *
3233
+ * // Acquire an auth client, and bind it to all future calls
3234
+ * const authClient = await auth.getClient();
3235
+ * google.options({auth: authClient});
3236
+ *
3237
+ * // Do the magic
3238
+ * const res = await dataform.projects.locations.repositories.fetchHistory({
3239
+ * // Required. The repository's name.
3240
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie',
3241
+ * // Optional. Maximum number of commits to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
3242
+ * pageSize: 'placeholder-value',
3243
+ * // Optional. Page token received from a previous `FetchRepositoryHistory` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchRepositoryHistory`, with the exception of `page_size`, must match the call that provided the page token.
3244
+ * pageToken: 'placeholder-value',
3245
+ * });
3246
+ * console.log(res.data);
3247
+ *
3248
+ * // Example response
3249
+ * // {
3250
+ * // "commits": [],
3251
+ * // "nextPageToken": "my_nextPageToken"
3252
+ * // }
3253
+ * }
3254
+ *
3255
+ * main().catch(e => {
3256
+ * console.error(e);
3257
+ * throw e;
3258
+ * });
3259
+ *
3260
+ * ```
2712
3261
  *
2713
3262
  * @param params - Parameters for request
2714
3263
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2807,6 +3356,56 @@ export namespace dataform_v1beta1 {
2807
3356
 
2808
3357
  /**
2809
3358
  * Fetches a Repository's remote branches.
3359
+ * @example
3360
+ * ```js
3361
+ * // Before running the sample:
3362
+ * // - Enable the API at:
3363
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
3364
+ * // - Login into gcloud by running:
3365
+ * // ```sh
3366
+ * // $ gcloud auth application-default login
3367
+ * // ```
3368
+ * // - Install the npm module by running:
3369
+ * // ```sh
3370
+ * // $ npm install googleapis
3371
+ * // ```
3372
+ *
3373
+ * const {google} = require('googleapis');
3374
+ * const dataform = google.dataform('v1beta1');
3375
+ *
3376
+ * async function main() {
3377
+ * const auth = new google.auth.GoogleAuth({
3378
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3379
+ * scopes: [
3380
+ * 'https://www.googleapis.com/auth/bigquery',
3381
+ * 'https://www.googleapis.com/auth/cloud-platform',
3382
+ * ],
3383
+ * });
3384
+ *
3385
+ * // Acquire an auth client, and bind it to all future calls
3386
+ * const authClient = await auth.getClient();
3387
+ * google.options({auth: authClient});
3388
+ *
3389
+ * // Do the magic
3390
+ * const res =
3391
+ * await dataform.projects.locations.repositories.fetchRemoteBranches({
3392
+ * // Required. The repository's name.
3393
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie',
3394
+ * });
3395
+ * console.log(res.data);
3396
+ *
3397
+ * // Example response
3398
+ * // {
3399
+ * // "branches": []
3400
+ * // }
3401
+ * }
3402
+ *
3403
+ * main().catch(e => {
3404
+ * console.error(e);
3405
+ * throw e;
3406
+ * });
3407
+ *
3408
+ * ```
2810
3409
  *
2811
3410
  * @param params - Parameters for request
2812
3411
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2903,6 +3502,66 @@ export namespace dataform_v1beta1 {
2903
3502
 
2904
3503
  /**
2905
3504
  * Fetches a single Repository.
3505
+ * @example
3506
+ * ```js
3507
+ * // Before running the sample:
3508
+ * // - Enable the API at:
3509
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
3510
+ * // - Login into gcloud by running:
3511
+ * // ```sh
3512
+ * // $ gcloud auth application-default login
3513
+ * // ```
3514
+ * // - Install the npm module by running:
3515
+ * // ```sh
3516
+ * // $ npm install googleapis
3517
+ * // ```
3518
+ *
3519
+ * const {google} = require('googleapis');
3520
+ * const dataform = google.dataform('v1beta1');
3521
+ *
3522
+ * async function main() {
3523
+ * const auth = new google.auth.GoogleAuth({
3524
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3525
+ * scopes: [
3526
+ * 'https://www.googleapis.com/auth/bigquery',
3527
+ * 'https://www.googleapis.com/auth/cloud-platform',
3528
+ * ],
3529
+ * });
3530
+ *
3531
+ * // Acquire an auth client, and bind it to all future calls
3532
+ * const authClient = await auth.getClient();
3533
+ * google.options({auth: authClient});
3534
+ *
3535
+ * // Do the magic
3536
+ * const res = await dataform.projects.locations.repositories.get({
3537
+ * // Required. The repository's name.
3538
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie',
3539
+ * });
3540
+ * console.log(res.data);
3541
+ *
3542
+ * // Example response
3543
+ * // {
3544
+ * // "createTime": "my_createTime",
3545
+ * // "dataEncryptionState": {},
3546
+ * // "displayName": "my_displayName",
3547
+ * // "gitRemoteSettings": {},
3548
+ * // "internalMetadata": "my_internalMetadata",
3549
+ * // "kmsKeyName": "my_kmsKeyName",
3550
+ * // "labels": {},
3551
+ * // "name": "my_name",
3552
+ * // "npmrcEnvironmentVariablesSecretVersion": "my_npmrcEnvironmentVariablesSecretVersion",
3553
+ * // "serviceAccount": "my_serviceAccount",
3554
+ * // "setAuthenticatedUserAdmin": false,
3555
+ * // "workspaceCompilationOverrides": {}
3556
+ * // }
3557
+ * }
3558
+ *
3559
+ * main().catch(e => {
3560
+ * console.error(e);
3561
+ * throw e;
3562
+ * });
3563
+ *
3564
+ * ```
2906
3565
  *
2907
3566
  * @param params - Parameters for request
2908
3567
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2991,6 +3650,60 @@ export namespace dataform_v1beta1 {
2991
3650
 
2992
3651
  /**
2993
3652
  * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
3653
+ * @example
3654
+ * ```js
3655
+ * // Before running the sample:
3656
+ * // - Enable the API at:
3657
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
3658
+ * // - Login into gcloud by running:
3659
+ * // ```sh
3660
+ * // $ gcloud auth application-default login
3661
+ * // ```
3662
+ * // - Install the npm module by running:
3663
+ * // ```sh
3664
+ * // $ npm install googleapis
3665
+ * // ```
3666
+ *
3667
+ * const {google} = require('googleapis');
3668
+ * const dataform = google.dataform('v1beta1');
3669
+ *
3670
+ * async function main() {
3671
+ * const auth = new google.auth.GoogleAuth({
3672
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3673
+ * scopes: [
3674
+ * 'https://www.googleapis.com/auth/bigquery',
3675
+ * 'https://www.googleapis.com/auth/cloud-platform',
3676
+ * ],
3677
+ * });
3678
+ *
3679
+ * // Acquire an auth client, and bind it to all future calls
3680
+ * const authClient = await auth.getClient();
3681
+ * google.options({auth: authClient});
3682
+ *
3683
+ * // Do the magic
3684
+ * const res = await dataform.projects.locations.repositories.getIamPolicy({
3685
+ * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3686
+ * 'options.requestedPolicyVersion': 'placeholder-value',
3687
+ * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
3688
+ * resource:
3689
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie',
3690
+ * });
3691
+ * console.log(res.data);
3692
+ *
3693
+ * // Example response
3694
+ * // {
3695
+ * // "bindings": [],
3696
+ * // "etag": "my_etag",
3697
+ * // "version": 0
3698
+ * // }
3699
+ * }
3700
+ *
3701
+ * main().catch(e => {
3702
+ * console.error(e);
3703
+ * throw e;
3704
+ * });
3705
+ *
3706
+ * ```
2994
3707
  *
2995
3708
  * @param params - Parameters for request
2996
3709
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3083,6 +3796,65 @@ export namespace dataform_v1beta1 {
3083
3796
 
3084
3797
  /**
3085
3798
  * Lists Repositories in a given project and location. **Note:** *This method can return repositories not shown in the [Dataform UI](https://console.cloud.google.com/bigquery/dataform)*.
3799
+ * @example
3800
+ * ```js
3801
+ * // Before running the sample:
3802
+ * // - Enable the API at:
3803
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
3804
+ * // - Login into gcloud by running:
3805
+ * // ```sh
3806
+ * // $ gcloud auth application-default login
3807
+ * // ```
3808
+ * // - Install the npm module by running:
3809
+ * // ```sh
3810
+ * // $ npm install googleapis
3811
+ * // ```
3812
+ *
3813
+ * const {google} = require('googleapis');
3814
+ * const dataform = google.dataform('v1beta1');
3815
+ *
3816
+ * async function main() {
3817
+ * const auth = new google.auth.GoogleAuth({
3818
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3819
+ * scopes: [
3820
+ * 'https://www.googleapis.com/auth/bigquery',
3821
+ * 'https://www.googleapis.com/auth/cloud-platform',
3822
+ * ],
3823
+ * });
3824
+ *
3825
+ * // Acquire an auth client, and bind it to all future calls
3826
+ * const authClient = await auth.getClient();
3827
+ * google.options({auth: authClient});
3828
+ *
3829
+ * // Do the magic
3830
+ * const res = await dataform.projects.locations.repositories.list({
3831
+ * // Optional. Filter for the returned list.
3832
+ * filter: 'placeholder-value',
3833
+ * // Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field.
3834
+ * orderBy: 'placeholder-value',
3835
+ * // Optional. Maximum number of repositories to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
3836
+ * pageSize: 'placeholder-value',
3837
+ * // Optional. Page token received from a previous `ListRepositories` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRepositories`, with the exception of `page_size`, must match the call that provided the page token.
3838
+ * pageToken: 'placeholder-value',
3839
+ * // Required. The location in which to list repositories. Must be in the format `projects/x/locations/x`.
3840
+ * parent: 'projects/my-project/locations/my-location',
3841
+ * });
3842
+ * console.log(res.data);
3843
+ *
3844
+ * // Example response
3845
+ * // {
3846
+ * // "nextPageToken": "my_nextPageToken",
3847
+ * // "repositories": [],
3848
+ * // "unreachable": []
3849
+ * // }
3850
+ * }
3851
+ *
3852
+ * main().catch(e => {
3853
+ * console.error(e);
3854
+ * throw e;
3855
+ * });
3856
+ *
3857
+ * ```
3086
3858
  *
3087
3859
  * @param params - Parameters for request
3088
3860
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3176,6 +3948,87 @@ export namespace dataform_v1beta1 {
3176
3948
 
3177
3949
  /**
3178
3950
  * Updates a single Repository. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*
3951
+ * @example
3952
+ * ```js
3953
+ * // Before running the sample:
3954
+ * // - Enable the API at:
3955
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
3956
+ * // - Login into gcloud by running:
3957
+ * // ```sh
3958
+ * // $ gcloud auth application-default login
3959
+ * // ```
3960
+ * // - Install the npm module by running:
3961
+ * // ```sh
3962
+ * // $ npm install googleapis
3963
+ * // ```
3964
+ *
3965
+ * const {google} = require('googleapis');
3966
+ * const dataform = google.dataform('v1beta1');
3967
+ *
3968
+ * async function main() {
3969
+ * const auth = new google.auth.GoogleAuth({
3970
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3971
+ * scopes: [
3972
+ * 'https://www.googleapis.com/auth/bigquery',
3973
+ * 'https://www.googleapis.com/auth/cloud-platform',
3974
+ * ],
3975
+ * });
3976
+ *
3977
+ * // Acquire an auth client, and bind it to all future calls
3978
+ * const authClient = await auth.getClient();
3979
+ * google.options({auth: authClient});
3980
+ *
3981
+ * // Do the magic
3982
+ * const res = await dataform.projects.locations.repositories.patch({
3983
+ * // Identifier. The repository's name.
3984
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie',
3985
+ * // Optional. Specifies the fields to be updated in the repository. If left unset, all fields will be updated.
3986
+ * updateMask: 'placeholder-value',
3987
+ *
3988
+ * // Request body metadata
3989
+ * requestBody: {
3990
+ * // request body parameters
3991
+ * // {
3992
+ * // "createTime": "my_createTime",
3993
+ * // "dataEncryptionState": {},
3994
+ * // "displayName": "my_displayName",
3995
+ * // "gitRemoteSettings": {},
3996
+ * // "internalMetadata": "my_internalMetadata",
3997
+ * // "kmsKeyName": "my_kmsKeyName",
3998
+ * // "labels": {},
3999
+ * // "name": "my_name",
4000
+ * // "npmrcEnvironmentVariablesSecretVersion": "my_npmrcEnvironmentVariablesSecretVersion",
4001
+ * // "serviceAccount": "my_serviceAccount",
4002
+ * // "setAuthenticatedUserAdmin": false,
4003
+ * // "workspaceCompilationOverrides": {}
4004
+ * // }
4005
+ * },
4006
+ * });
4007
+ * console.log(res.data);
4008
+ *
4009
+ * // Example response
4010
+ * // {
4011
+ * // "createTime": "my_createTime",
4012
+ * // "dataEncryptionState": {},
4013
+ * // "displayName": "my_displayName",
4014
+ * // "gitRemoteSettings": {},
4015
+ * // "internalMetadata": "my_internalMetadata",
4016
+ * // "kmsKeyName": "my_kmsKeyName",
4017
+ * // "labels": {},
4018
+ * // "name": "my_name",
4019
+ * // "npmrcEnvironmentVariablesSecretVersion": "my_npmrcEnvironmentVariablesSecretVersion",
4020
+ * // "serviceAccount": "my_serviceAccount",
4021
+ * // "setAuthenticatedUserAdmin": false,
4022
+ * // "workspaceCompilationOverrides": {}
4023
+ * // }
4024
+ * }
4025
+ *
4026
+ * main().catch(e => {
4027
+ * console.error(e);
4028
+ * throw e;
4029
+ * });
4030
+ *
4031
+ * ```
3179
4032
  *
3180
4033
  * @param params - Parameters for request
3181
4034
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3264,6 +4117,65 @@ export namespace dataform_v1beta1 {
3264
4117
 
3265
4118
  /**
3266
4119
  * Returns the contents of a given Repository directory. The Repository must not have a value for `git_remote_settings.url`.
4120
+ * @example
4121
+ * ```js
4122
+ * // Before running the sample:
4123
+ * // - Enable the API at:
4124
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
4125
+ * // - Login into gcloud by running:
4126
+ * // ```sh
4127
+ * // $ gcloud auth application-default login
4128
+ * // ```
4129
+ * // - Install the npm module by running:
4130
+ * // ```sh
4131
+ * // $ npm install googleapis
4132
+ * // ```
4133
+ *
4134
+ * const {google} = require('googleapis');
4135
+ * const dataform = google.dataform('v1beta1');
4136
+ *
4137
+ * async function main() {
4138
+ * const auth = new google.auth.GoogleAuth({
4139
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4140
+ * scopes: [
4141
+ * 'https://www.googleapis.com/auth/bigquery',
4142
+ * 'https://www.googleapis.com/auth/cloud-platform',
4143
+ * ],
4144
+ * });
4145
+ *
4146
+ * // Acquire an auth client, and bind it to all future calls
4147
+ * const authClient = await auth.getClient();
4148
+ * google.options({auth: authClient});
4149
+ *
4150
+ * // Do the magic
4151
+ * const res =
4152
+ * await dataform.projects.locations.repositories.queryDirectoryContents({
4153
+ * // Optional. The Commit SHA for the commit to query from. If unset, the directory will be queried from HEAD.
4154
+ * commitSha: 'placeholder-value',
4155
+ * // Required. The repository's name.
4156
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie',
4157
+ * // Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
4158
+ * pageSize: 'placeholder-value',
4159
+ * // Optional. Page token received from a previous `QueryRepositoryDirectoryContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryRepositoryDirectoryContents`, with the exception of `page_size`, must match the call that provided the page token.
4160
+ * pageToken: 'placeholder-value',
4161
+ * // Optional. The directory's full path including directory name, relative to root. If left unset, the root is used.
4162
+ * path: 'placeholder-value',
4163
+ * });
4164
+ * console.log(res.data);
4165
+ *
4166
+ * // Example response
4167
+ * // {
4168
+ * // "directoryEntries": [],
4169
+ * // "nextPageToken": "my_nextPageToken"
4170
+ * // }
4171
+ * }
4172
+ *
4173
+ * main().catch(e => {
4174
+ * console.error(e);
4175
+ * throw e;
4176
+ * });
4177
+ *
4178
+ * ```
3267
4179
  *
3268
4180
  * @param params - Parameters for request
3269
4181
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3366,6 +4278,59 @@ export namespace dataform_v1beta1 {
3366
4278
 
3367
4279
  /**
3368
4280
  * Returns the contents of a file (inside a Repository). The Repository must not have a value for `git_remote_settings.url`.
4281
+ * @example
4282
+ * ```js
4283
+ * // Before running the sample:
4284
+ * // - Enable the API at:
4285
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
4286
+ * // - Login into gcloud by running:
4287
+ * // ```sh
4288
+ * // $ gcloud auth application-default login
4289
+ * // ```
4290
+ * // - Install the npm module by running:
4291
+ * // ```sh
4292
+ * // $ npm install googleapis
4293
+ * // ```
4294
+ *
4295
+ * const {google} = require('googleapis');
4296
+ * const dataform = google.dataform('v1beta1');
4297
+ *
4298
+ * async function main() {
4299
+ * const auth = new google.auth.GoogleAuth({
4300
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4301
+ * scopes: [
4302
+ * 'https://www.googleapis.com/auth/bigquery',
4303
+ * 'https://www.googleapis.com/auth/cloud-platform',
4304
+ * ],
4305
+ * });
4306
+ *
4307
+ * // Acquire an auth client, and bind it to all future calls
4308
+ * const authClient = await auth.getClient();
4309
+ * google.options({auth: authClient});
4310
+ *
4311
+ * // Do the magic
4312
+ * const res = await dataform.projects.locations.repositories.readFile({
4313
+ * // Optional. The commit SHA for the commit to read from. If unset, the file will be read from HEAD.
4314
+ * commitSha: 'placeholder-value',
4315
+ * // Required. The repository's name.
4316
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie',
4317
+ * // Required. Full file path to read including filename, from repository root.
4318
+ * path: 'placeholder-value',
4319
+ * });
4320
+ * console.log(res.data);
4321
+ *
4322
+ * // Example response
4323
+ * // {
4324
+ * // "contents": "my_contents"
4325
+ * // }
4326
+ * }
4327
+ *
4328
+ * main().catch(e => {
4329
+ * console.error(e);
4330
+ * throw e;
4331
+ * });
4332
+ *
4333
+ * ```
3369
4334
  *
3370
4335
  * @param params - Parameters for request
3371
4336
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3461,6 +4426,66 @@ export namespace dataform_v1beta1 {
3461
4426
 
3462
4427
  /**
3463
4428
  * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
4429
+ * @example
4430
+ * ```js
4431
+ * // Before running the sample:
4432
+ * // - Enable the API at:
4433
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
4434
+ * // - Login into gcloud by running:
4435
+ * // ```sh
4436
+ * // $ gcloud auth application-default login
4437
+ * // ```
4438
+ * // - Install the npm module by running:
4439
+ * // ```sh
4440
+ * // $ npm install googleapis
4441
+ * // ```
4442
+ *
4443
+ * const {google} = require('googleapis');
4444
+ * const dataform = google.dataform('v1beta1');
4445
+ *
4446
+ * async function main() {
4447
+ * const auth = new google.auth.GoogleAuth({
4448
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4449
+ * scopes: [
4450
+ * 'https://www.googleapis.com/auth/bigquery',
4451
+ * 'https://www.googleapis.com/auth/cloud-platform',
4452
+ * ],
4453
+ * });
4454
+ *
4455
+ * // Acquire an auth client, and bind it to all future calls
4456
+ * const authClient = await auth.getClient();
4457
+ * google.options({auth: authClient});
4458
+ *
4459
+ * // Do the magic
4460
+ * const res = await dataform.projects.locations.repositories.setIamPolicy({
4461
+ * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
4462
+ * resource:
4463
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie',
4464
+ *
4465
+ * // Request body metadata
4466
+ * requestBody: {
4467
+ * // request body parameters
4468
+ * // {
4469
+ * // "policy": {}
4470
+ * // }
4471
+ * },
4472
+ * });
4473
+ * console.log(res.data);
4474
+ *
4475
+ * // Example response
4476
+ * // {
4477
+ * // "bindings": [],
4478
+ * // "etag": "my_etag",
4479
+ * // "version": 0
4480
+ * // }
4481
+ * }
4482
+ *
4483
+ * main().catch(e => {
4484
+ * console.error(e);
4485
+ * throw e;
4486
+ * });
4487
+ *
4488
+ * ```
3464
4489
  *
3465
4490
  * @param params - Parameters for request
3466
4491
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3553,6 +4578,66 @@ export namespace dataform_v1beta1 {
3553
4578
 
3554
4579
  /**
3555
4580
  * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
4581
+ * @example
4582
+ * ```js
4583
+ * // Before running the sample:
4584
+ * // - Enable the API at:
4585
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
4586
+ * // - Login into gcloud by running:
4587
+ * // ```sh
4588
+ * // $ gcloud auth application-default login
4589
+ * // ```
4590
+ * // - Install the npm module by running:
4591
+ * // ```sh
4592
+ * // $ npm install googleapis
4593
+ * // ```
4594
+ *
4595
+ * const {google} = require('googleapis');
4596
+ * const dataform = google.dataform('v1beta1');
4597
+ *
4598
+ * async function main() {
4599
+ * const auth = new google.auth.GoogleAuth({
4600
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4601
+ * scopes: [
4602
+ * 'https://www.googleapis.com/auth/bigquery',
4603
+ * 'https://www.googleapis.com/auth/cloud-platform',
4604
+ * ],
4605
+ * });
4606
+ *
4607
+ * // Acquire an auth client, and bind it to all future calls
4608
+ * const authClient = await auth.getClient();
4609
+ * google.options({auth: authClient});
4610
+ *
4611
+ * // Do the magic
4612
+ * const res = await dataform.projects.locations.repositories.testIamPermissions(
4613
+ * {
4614
+ * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
4615
+ * resource:
4616
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie',
4617
+ *
4618
+ * // Request body metadata
4619
+ * requestBody: {
4620
+ * // request body parameters
4621
+ * // {
4622
+ * // "permissions": []
4623
+ * // }
4624
+ * },
4625
+ * },
4626
+ * );
4627
+ * console.log(res.data);
4628
+ *
4629
+ * // Example response
4630
+ * // {
4631
+ * // "permissions": []
4632
+ * // }
4633
+ * }
4634
+ *
4635
+ * main().catch(e => {
4636
+ * console.error(e);
4637
+ * throw e;
4638
+ * });
4639
+ *
4640
+ * ```
3556
4641
  *
3557
4642
  * @param params - Parameters for request
3558
4643
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3686,7 +4771,7 @@ export namespace dataform_v1beta1 {
3686
4771
  export interface Params$Resource$Projects$Locations$Repositories$Delete
3687
4772
  extends StandardParameters {
3688
4773
  /**
3689
- * Optional. If set to true, any child resources of this repository will also be deleted. (Otherwise, the request will only succeed if the repository has no child resources.)
4774
+ * 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.*.
3690
4775
  */
3691
4776
  force?: boolean;
3692
4777
  /**
@@ -3844,6 +4929,85 @@ export namespace dataform_v1beta1 {
3844
4929
 
3845
4930
  /**
3846
4931
  * Creates a new CompilationResult in a given project and location.
4932
+ * @example
4933
+ * ```js
4934
+ * // Before running the sample:
4935
+ * // - Enable the API at:
4936
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
4937
+ * // - Login into gcloud by running:
4938
+ * // ```sh
4939
+ * // $ gcloud auth application-default login
4940
+ * // ```
4941
+ * // - Install the npm module by running:
4942
+ * // ```sh
4943
+ * // $ npm install googleapis
4944
+ * // ```
4945
+ *
4946
+ * const {google} = require('googleapis');
4947
+ * const dataform = google.dataform('v1beta1');
4948
+ *
4949
+ * async function main() {
4950
+ * const auth = new google.auth.GoogleAuth({
4951
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4952
+ * scopes: [
4953
+ * 'https://www.googleapis.com/auth/bigquery',
4954
+ * 'https://www.googleapis.com/auth/cloud-platform',
4955
+ * ],
4956
+ * });
4957
+ *
4958
+ * // Acquire an auth client, and bind it to all future calls
4959
+ * const authClient = await auth.getClient();
4960
+ * google.options({auth: authClient});
4961
+ *
4962
+ * // Do the magic
4963
+ * const res =
4964
+ * await dataform.projects.locations.repositories.compilationResults.create({
4965
+ * // Required. The repository in which to create the compilation result. Must be in the format `projects/x/locations/x/repositories/x`.
4966
+ * parent:
4967
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie',
4968
+ *
4969
+ * // Request body metadata
4970
+ * requestBody: {
4971
+ * // request body parameters
4972
+ * // {
4973
+ * // "codeCompilationConfig": {},
4974
+ * // "compilationErrors": [],
4975
+ * // "createTime": "my_createTime",
4976
+ * // "dataEncryptionState": {},
4977
+ * // "dataformCoreVersion": "my_dataformCoreVersion",
4978
+ * // "gitCommitish": "my_gitCommitish",
4979
+ * // "internalMetadata": "my_internalMetadata",
4980
+ * // "name": "my_name",
4981
+ * // "releaseConfig": "my_releaseConfig",
4982
+ * // "resolvedGitCommitSha": "my_resolvedGitCommitSha",
4983
+ * // "workspace": "my_workspace"
4984
+ * // }
4985
+ * },
4986
+ * });
4987
+ * console.log(res.data);
4988
+ *
4989
+ * // Example response
4990
+ * // {
4991
+ * // "codeCompilationConfig": {},
4992
+ * // "compilationErrors": [],
4993
+ * // "createTime": "my_createTime",
4994
+ * // "dataEncryptionState": {},
4995
+ * // "dataformCoreVersion": "my_dataformCoreVersion",
4996
+ * // "gitCommitish": "my_gitCommitish",
4997
+ * // "internalMetadata": "my_internalMetadata",
4998
+ * // "name": "my_name",
4999
+ * // "releaseConfig": "my_releaseConfig",
5000
+ * // "resolvedGitCommitSha": "my_resolvedGitCommitSha",
5001
+ * // "workspace": "my_workspace"
5002
+ * // }
5003
+ * }
5004
+ *
5005
+ * main().catch(e => {
5006
+ * console.error(e);
5007
+ * throw e;
5008
+ * });
5009
+ *
5010
+ * ```
3847
5011
  *
3848
5012
  * @param params - Parameters for request
3849
5013
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3936,6 +5100,66 @@ export namespace dataform_v1beta1 {
3936
5100
 
3937
5101
  /**
3938
5102
  * Fetches a single CompilationResult.
5103
+ * @example
5104
+ * ```js
5105
+ * // Before running the sample:
5106
+ * // - Enable the API at:
5107
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
5108
+ * // - Login into gcloud by running:
5109
+ * // ```sh
5110
+ * // $ gcloud auth application-default login
5111
+ * // ```
5112
+ * // - Install the npm module by running:
5113
+ * // ```sh
5114
+ * // $ npm install googleapis
5115
+ * // ```
5116
+ *
5117
+ * const {google} = require('googleapis');
5118
+ * const dataform = google.dataform('v1beta1');
5119
+ *
5120
+ * async function main() {
5121
+ * const auth = new google.auth.GoogleAuth({
5122
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5123
+ * scopes: [
5124
+ * 'https://www.googleapis.com/auth/bigquery',
5125
+ * 'https://www.googleapis.com/auth/cloud-platform',
5126
+ * ],
5127
+ * });
5128
+ *
5129
+ * // Acquire an auth client, and bind it to all future calls
5130
+ * const authClient = await auth.getClient();
5131
+ * google.options({auth: authClient});
5132
+ *
5133
+ * // Do the magic
5134
+ * const res =
5135
+ * await dataform.projects.locations.repositories.compilationResults.get({
5136
+ * // Required. The compilation result's name.
5137
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/compilationResults/my-compilationResult',
5138
+ * });
5139
+ * console.log(res.data);
5140
+ *
5141
+ * // Example response
5142
+ * // {
5143
+ * // "codeCompilationConfig": {},
5144
+ * // "compilationErrors": [],
5145
+ * // "createTime": "my_createTime",
5146
+ * // "dataEncryptionState": {},
5147
+ * // "dataformCoreVersion": "my_dataformCoreVersion",
5148
+ * // "gitCommitish": "my_gitCommitish",
5149
+ * // "internalMetadata": "my_internalMetadata",
5150
+ * // "name": "my_name",
5151
+ * // "releaseConfig": "my_releaseConfig",
5152
+ * // "resolvedGitCommitSha": "my_resolvedGitCommitSha",
5153
+ * // "workspace": "my_workspace"
5154
+ * // }
5155
+ * }
5156
+ *
5157
+ * main().catch(e => {
5158
+ * console.error(e);
5159
+ * throw e;
5160
+ * });
5161
+ *
5162
+ * ```
3939
5163
  *
3940
5164
  * @param params - Parameters for request
3941
5165
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4025,6 +5249,67 @@ export namespace dataform_v1beta1 {
4025
5249
 
4026
5250
  /**
4027
5251
  * Lists CompilationResults in a given Repository.
5252
+ * @example
5253
+ * ```js
5254
+ * // Before running the sample:
5255
+ * // - Enable the API at:
5256
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
5257
+ * // - Login into gcloud by running:
5258
+ * // ```sh
5259
+ * // $ gcloud auth application-default login
5260
+ * // ```
5261
+ * // - Install the npm module by running:
5262
+ * // ```sh
5263
+ * // $ npm install googleapis
5264
+ * // ```
5265
+ *
5266
+ * const {google} = require('googleapis');
5267
+ * const dataform = google.dataform('v1beta1');
5268
+ *
5269
+ * async function main() {
5270
+ * const auth = new google.auth.GoogleAuth({
5271
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5272
+ * scopes: [
5273
+ * 'https://www.googleapis.com/auth/bigquery',
5274
+ * 'https://www.googleapis.com/auth/cloud-platform',
5275
+ * ],
5276
+ * });
5277
+ *
5278
+ * // Acquire an auth client, and bind it to all future calls
5279
+ * const authClient = await auth.getClient();
5280
+ * google.options({auth: authClient});
5281
+ *
5282
+ * // Do the magic
5283
+ * const res =
5284
+ * await dataform.projects.locations.repositories.compilationResults.list({
5285
+ * // Optional. Filter for the returned list.
5286
+ * filter: 'placeholder-value',
5287
+ * // 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.
5288
+ * orderBy: 'placeholder-value',
5289
+ * // Optional. Maximum number of compilation results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
5290
+ * pageSize: 'placeholder-value',
5291
+ * // Optional. Page token received from a previous `ListCompilationResults` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCompilationResults`, with the exception of `page_size`, must match the call that provided the page token.
5292
+ * pageToken: 'placeholder-value',
5293
+ * // Required. The repository in which to list compilation results. Must be in the format `projects/x/locations/x/repositories/x`.
5294
+ * parent:
5295
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie',
5296
+ * });
5297
+ * console.log(res.data);
5298
+ *
5299
+ * // Example response
5300
+ * // {
5301
+ * // "compilationResults": [],
5302
+ * // "nextPageToken": "my_nextPageToken",
5303
+ * // "unreachable": []
5304
+ * // }
5305
+ * }
5306
+ *
5307
+ * main().catch(e => {
5308
+ * console.error(e);
5309
+ * throw e;
5310
+ * });
5311
+ *
5312
+ * ```
4028
5313
  *
4029
5314
  * @param params - Parameters for request
4030
5315
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4123,6 +5408,63 @@ export namespace dataform_v1beta1 {
4123
5408
 
4124
5409
  /**
4125
5410
  * Returns CompilationResultActions in a given CompilationResult.
5411
+ * @example
5412
+ * ```js
5413
+ * // Before running the sample:
5414
+ * // - Enable the API at:
5415
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
5416
+ * // - Login into gcloud by running:
5417
+ * // ```sh
5418
+ * // $ gcloud auth application-default login
5419
+ * // ```
5420
+ * // - Install the npm module by running:
5421
+ * // ```sh
5422
+ * // $ npm install googleapis
5423
+ * // ```
5424
+ *
5425
+ * const {google} = require('googleapis');
5426
+ * const dataform = google.dataform('v1beta1');
5427
+ *
5428
+ * async function main() {
5429
+ * const auth = new google.auth.GoogleAuth({
5430
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5431
+ * scopes: [
5432
+ * 'https://www.googleapis.com/auth/bigquery',
5433
+ * 'https://www.googleapis.com/auth/cloud-platform',
5434
+ * ],
5435
+ * });
5436
+ *
5437
+ * // Acquire an auth client, and bind it to all future calls
5438
+ * const authClient = await auth.getClient();
5439
+ * google.options({auth: authClient});
5440
+ *
5441
+ * // Do the magic
5442
+ * const res =
5443
+ * await dataform.projects.locations.repositories.compilationResults.query({
5444
+ * // Optional. Optional filter for the returned list. Filtering is only currently supported on the `file_path` field.
5445
+ * filter: 'placeholder-value',
5446
+ * // Required. The compilation result's name.
5447
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/compilationResults/my-compilationResult',
5448
+ * // Optional. Maximum number of compilation results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
5449
+ * pageSize: 'placeholder-value',
5450
+ * // Optional. Page token received from a previous `QueryCompilationResultActions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryCompilationResultActions`, with the exception of `page_size`, must match the call that provided the page token.
5451
+ * pageToken: 'placeholder-value',
5452
+ * });
5453
+ * console.log(res.data);
5454
+ *
5455
+ * // Example response
5456
+ * // {
5457
+ * // "compilationResultActions": [],
5458
+ * // "nextPageToken": "my_nextPageToken"
5459
+ * // }
5460
+ * }
5461
+ *
5462
+ * main().catch(e => {
5463
+ * console.error(e);
5464
+ * throw e;
5465
+ * });
5466
+ *
5467
+ * ```
4126
5468
  *
4127
5469
  * @param params - Parameters for request
4128
5470
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4294,6 +5636,83 @@ export namespace dataform_v1beta1 {
4294
5636
 
4295
5637
  /**
4296
5638
  * Creates a new ReleaseConfig in a given Repository.
5639
+ * @example
5640
+ * ```js
5641
+ * // Before running the sample:
5642
+ * // - Enable the API at:
5643
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
5644
+ * // - Login into gcloud by running:
5645
+ * // ```sh
5646
+ * // $ gcloud auth application-default login
5647
+ * // ```
5648
+ * // - Install the npm module by running:
5649
+ * // ```sh
5650
+ * // $ npm install googleapis
5651
+ * // ```
5652
+ *
5653
+ * const {google} = require('googleapis');
5654
+ * const dataform = google.dataform('v1beta1');
5655
+ *
5656
+ * async function main() {
5657
+ * const auth = new google.auth.GoogleAuth({
5658
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5659
+ * scopes: [
5660
+ * 'https://www.googleapis.com/auth/bigquery',
5661
+ * 'https://www.googleapis.com/auth/cloud-platform',
5662
+ * ],
5663
+ * });
5664
+ *
5665
+ * // Acquire an auth client, and bind it to all future calls
5666
+ * const authClient = await auth.getClient();
5667
+ * google.options({auth: authClient});
5668
+ *
5669
+ * // Do the magic
5670
+ * const res =
5671
+ * await dataform.projects.locations.repositories.releaseConfigs.create({
5672
+ * // Required. The repository in which to create the release config. Must be in the format `projects/x/locations/x/repositories/x`.
5673
+ * parent:
5674
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie',
5675
+ * // Required. The ID to use for the release config, which will become the final component of the release config's resource name.
5676
+ * releaseConfigId: 'placeholder-value',
5677
+ *
5678
+ * // Request body metadata
5679
+ * requestBody: {
5680
+ * // request body parameters
5681
+ * // {
5682
+ * // "codeCompilationConfig": {},
5683
+ * // "cronSchedule": "my_cronSchedule",
5684
+ * // "disabled": false,
5685
+ * // "gitCommitish": "my_gitCommitish",
5686
+ * // "internalMetadata": "my_internalMetadata",
5687
+ * // "name": "my_name",
5688
+ * // "recentScheduledReleaseRecords": [],
5689
+ * // "releaseCompilationResult": "my_releaseCompilationResult",
5690
+ * // "timeZone": "my_timeZone"
5691
+ * // }
5692
+ * },
5693
+ * });
5694
+ * console.log(res.data);
5695
+ *
5696
+ * // Example response
5697
+ * // {
5698
+ * // "codeCompilationConfig": {},
5699
+ * // "cronSchedule": "my_cronSchedule",
5700
+ * // "disabled": false,
5701
+ * // "gitCommitish": "my_gitCommitish",
5702
+ * // "internalMetadata": "my_internalMetadata",
5703
+ * // "name": "my_name",
5704
+ * // "recentScheduledReleaseRecords": [],
5705
+ * // "releaseCompilationResult": "my_releaseCompilationResult",
5706
+ * // "timeZone": "my_timeZone"
5707
+ * // }
5708
+ * }
5709
+ *
5710
+ * main().catch(e => {
5711
+ * console.error(e);
5712
+ * throw e;
5713
+ * });
5714
+ *
5715
+ * ```
4297
5716
  *
4298
5717
  * @param params - Parameters for request
4299
5718
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4386,6 +5805,54 @@ export namespace dataform_v1beta1 {
4386
5805
 
4387
5806
  /**
4388
5807
  * Deletes a single ReleaseConfig.
5808
+ * @example
5809
+ * ```js
5810
+ * // Before running the sample:
5811
+ * // - Enable the API at:
5812
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
5813
+ * // - Login into gcloud by running:
5814
+ * // ```sh
5815
+ * // $ gcloud auth application-default login
5816
+ * // ```
5817
+ * // - Install the npm module by running:
5818
+ * // ```sh
5819
+ * // $ npm install googleapis
5820
+ * // ```
5821
+ *
5822
+ * const {google} = require('googleapis');
5823
+ * const dataform = google.dataform('v1beta1');
5824
+ *
5825
+ * async function main() {
5826
+ * const auth = new google.auth.GoogleAuth({
5827
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5828
+ * scopes: [
5829
+ * 'https://www.googleapis.com/auth/bigquery',
5830
+ * 'https://www.googleapis.com/auth/cloud-platform',
5831
+ * ],
5832
+ * });
5833
+ *
5834
+ * // Acquire an auth client, and bind it to all future calls
5835
+ * const authClient = await auth.getClient();
5836
+ * google.options({auth: authClient});
5837
+ *
5838
+ * // Do the magic
5839
+ * const res =
5840
+ * await dataform.projects.locations.repositories.releaseConfigs.delete({
5841
+ * // Required. The release config's name.
5842
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/releaseConfigs/my-releaseConfig',
5843
+ * });
5844
+ * console.log(res.data);
5845
+ *
5846
+ * // Example response
5847
+ * // {}
5848
+ * }
5849
+ *
5850
+ * main().catch(e => {
5851
+ * console.error(e);
5852
+ * throw e;
5853
+ * });
5854
+ *
5855
+ * ```
4389
5856
  *
4390
5857
  * @param params - Parameters for request
4391
5858
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4475,6 +5942,65 @@ export namespace dataform_v1beta1 {
4475
5942
 
4476
5943
  /**
4477
5944
  * Fetches a single ReleaseConfig.
5945
+ * @example
5946
+ * ```js
5947
+ * // Before running the sample:
5948
+ * // - Enable the API at:
5949
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
5950
+ * // - Login into gcloud by running:
5951
+ * // ```sh
5952
+ * // $ gcloud auth application-default login
5953
+ * // ```
5954
+ * // - Install the npm module by running:
5955
+ * // ```sh
5956
+ * // $ npm install googleapis
5957
+ * // ```
5958
+ *
5959
+ * const {google} = require('googleapis');
5960
+ * const dataform = google.dataform('v1beta1');
5961
+ *
5962
+ * async function main() {
5963
+ * const auth = new google.auth.GoogleAuth({
5964
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5965
+ * scopes: [
5966
+ * 'https://www.googleapis.com/auth/bigquery',
5967
+ * 'https://www.googleapis.com/auth/cloud-platform',
5968
+ * ],
5969
+ * });
5970
+ *
5971
+ * // Acquire an auth client, and bind it to all future calls
5972
+ * const authClient = await auth.getClient();
5973
+ * google.options({auth: authClient});
5974
+ *
5975
+ * // Do the magic
5976
+ * const res = await dataform.projects.locations.repositories.releaseConfigs.get(
5977
+ * {
5978
+ * // Required. The release config's name.
5979
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/releaseConfigs/my-releaseConfig',
5980
+ * },
5981
+ * );
5982
+ * console.log(res.data);
5983
+ *
5984
+ * // Example response
5985
+ * // {
5986
+ * // "codeCompilationConfig": {},
5987
+ * // "cronSchedule": "my_cronSchedule",
5988
+ * // "disabled": false,
5989
+ * // "gitCommitish": "my_gitCommitish",
5990
+ * // "internalMetadata": "my_internalMetadata",
5991
+ * // "name": "my_name",
5992
+ * // "recentScheduledReleaseRecords": [],
5993
+ * // "releaseCompilationResult": "my_releaseCompilationResult",
5994
+ * // "timeZone": "my_timeZone"
5995
+ * // }
5996
+ * }
5997
+ *
5998
+ * main().catch(e => {
5999
+ * console.error(e);
6000
+ * throw e;
6001
+ * });
6002
+ *
6003
+ * ```
4478
6004
  *
4479
6005
  * @param params - Parameters for request
4480
6006
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4564,6 +6090,63 @@ export namespace dataform_v1beta1 {
4564
6090
 
4565
6091
  /**
4566
6092
  * Lists ReleaseConfigs in a given Repository.
6093
+ * @example
6094
+ * ```js
6095
+ * // Before running the sample:
6096
+ * // - Enable the API at:
6097
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
6098
+ * // - Login into gcloud by running:
6099
+ * // ```sh
6100
+ * // $ gcloud auth application-default login
6101
+ * // ```
6102
+ * // - Install the npm module by running:
6103
+ * // ```sh
6104
+ * // $ npm install googleapis
6105
+ * // ```
6106
+ *
6107
+ * const {google} = require('googleapis');
6108
+ * const dataform = google.dataform('v1beta1');
6109
+ *
6110
+ * async function main() {
6111
+ * const auth = new google.auth.GoogleAuth({
6112
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6113
+ * scopes: [
6114
+ * 'https://www.googleapis.com/auth/bigquery',
6115
+ * 'https://www.googleapis.com/auth/cloud-platform',
6116
+ * ],
6117
+ * });
6118
+ *
6119
+ * // Acquire an auth client, and bind it to all future calls
6120
+ * const authClient = await auth.getClient();
6121
+ * google.options({auth: authClient});
6122
+ *
6123
+ * // Do the magic
6124
+ * const res =
6125
+ * await dataform.projects.locations.repositories.releaseConfigs.list({
6126
+ * // 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.
6127
+ * pageSize: 'placeholder-value',
6128
+ * // 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.
6129
+ * pageToken: 'placeholder-value',
6130
+ * // Required. The repository in which to list release configs. Must be in the format `projects/x/locations/x/repositories/x`.
6131
+ * parent:
6132
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie',
6133
+ * });
6134
+ * console.log(res.data);
6135
+ *
6136
+ * // Example response
6137
+ * // {
6138
+ * // "nextPageToken": "my_nextPageToken",
6139
+ * // "releaseConfigs": [],
6140
+ * // "unreachable": []
6141
+ * // }
6142
+ * }
6143
+ *
6144
+ * main().catch(e => {
6145
+ * console.error(e);
6146
+ * throw e;
6147
+ * });
6148
+ *
6149
+ * ```
4567
6150
  *
4568
6151
  * @param params - Parameters for request
4569
6152
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4660,6 +6243,82 @@ export namespace dataform_v1beta1 {
4660
6243
 
4661
6244
  /**
4662
6245
  * Updates a single ReleaseConfig. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*
6246
+ * @example
6247
+ * ```js
6248
+ * // Before running the sample:
6249
+ * // - Enable the API at:
6250
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
6251
+ * // - Login into gcloud by running:
6252
+ * // ```sh
6253
+ * // $ gcloud auth application-default login
6254
+ * // ```
6255
+ * // - Install the npm module by running:
6256
+ * // ```sh
6257
+ * // $ npm install googleapis
6258
+ * // ```
6259
+ *
6260
+ * const {google} = require('googleapis');
6261
+ * const dataform = google.dataform('v1beta1');
6262
+ *
6263
+ * async function main() {
6264
+ * const auth = new google.auth.GoogleAuth({
6265
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6266
+ * scopes: [
6267
+ * 'https://www.googleapis.com/auth/bigquery',
6268
+ * 'https://www.googleapis.com/auth/cloud-platform',
6269
+ * ],
6270
+ * });
6271
+ *
6272
+ * // Acquire an auth client, and bind it to all future calls
6273
+ * const authClient = await auth.getClient();
6274
+ * google.options({auth: authClient});
6275
+ *
6276
+ * // Do the magic
6277
+ * const res =
6278
+ * await dataform.projects.locations.repositories.releaseConfigs.patch({
6279
+ * // Identifier. The release config's name.
6280
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/releaseConfigs/my-releaseConfig',
6281
+ * // Optional. Specifies the fields to be updated in the release config. If left unset, all fields will be updated.
6282
+ * updateMask: 'placeholder-value',
6283
+ *
6284
+ * // Request body metadata
6285
+ * requestBody: {
6286
+ * // request body parameters
6287
+ * // {
6288
+ * // "codeCompilationConfig": {},
6289
+ * // "cronSchedule": "my_cronSchedule",
6290
+ * // "disabled": false,
6291
+ * // "gitCommitish": "my_gitCommitish",
6292
+ * // "internalMetadata": "my_internalMetadata",
6293
+ * // "name": "my_name",
6294
+ * // "recentScheduledReleaseRecords": [],
6295
+ * // "releaseCompilationResult": "my_releaseCompilationResult",
6296
+ * // "timeZone": "my_timeZone"
6297
+ * // }
6298
+ * },
6299
+ * });
6300
+ * console.log(res.data);
6301
+ *
6302
+ * // Example response
6303
+ * // {
6304
+ * // "codeCompilationConfig": {},
6305
+ * // "cronSchedule": "my_cronSchedule",
6306
+ * // "disabled": false,
6307
+ * // "gitCommitish": "my_gitCommitish",
6308
+ * // "internalMetadata": "my_internalMetadata",
6309
+ * // "name": "my_name",
6310
+ * // "recentScheduledReleaseRecords": [],
6311
+ * // "releaseCompilationResult": "my_releaseCompilationResult",
6312
+ * // "timeZone": "my_timeZone"
6313
+ * // }
6314
+ * }
6315
+ *
6316
+ * main().catch(e => {
6317
+ * console.error(e);
6318
+ * throw e;
6319
+ * });
6320
+ *
6321
+ * ```
4663
6322
  *
4664
6323
  * @param params - Parameters for request
4665
6324
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4818,6 +6477,85 @@ export namespace dataform_v1beta1 {
4818
6477
 
4819
6478
  /**
4820
6479
  * Creates a new WorkflowConfig in a given Repository.
6480
+ * @example
6481
+ * ```js
6482
+ * // Before running the sample:
6483
+ * // - Enable the API at:
6484
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
6485
+ * // - Login into gcloud by running:
6486
+ * // ```sh
6487
+ * // $ gcloud auth application-default login
6488
+ * // ```
6489
+ * // - Install the npm module by running:
6490
+ * // ```sh
6491
+ * // $ npm install googleapis
6492
+ * // ```
6493
+ *
6494
+ * const {google} = require('googleapis');
6495
+ * const dataform = google.dataform('v1beta1');
6496
+ *
6497
+ * async function main() {
6498
+ * const auth = new google.auth.GoogleAuth({
6499
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6500
+ * scopes: [
6501
+ * 'https://www.googleapis.com/auth/bigquery',
6502
+ * 'https://www.googleapis.com/auth/cloud-platform',
6503
+ * ],
6504
+ * });
6505
+ *
6506
+ * // Acquire an auth client, and bind it to all future calls
6507
+ * const authClient = await auth.getClient();
6508
+ * google.options({auth: authClient});
6509
+ *
6510
+ * // Do the magic
6511
+ * const res =
6512
+ * await dataform.projects.locations.repositories.workflowConfigs.create({
6513
+ * // Required. The repository in which to create the workflow config. Must be in the format `projects/x/locations/x/repositories/x`.
6514
+ * parent:
6515
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie',
6516
+ * // Required. The ID to use for the workflow config, which will become the final component of the workflow config's resource name.
6517
+ * workflowConfigId: 'placeholder-value',
6518
+ *
6519
+ * // Request body metadata
6520
+ * requestBody: {
6521
+ * // request body parameters
6522
+ * // {
6523
+ * // "createTime": "my_createTime",
6524
+ * // "cronSchedule": "my_cronSchedule",
6525
+ * // "disabled": false,
6526
+ * // "internalMetadata": "my_internalMetadata",
6527
+ * // "invocationConfig": {},
6528
+ * // "name": "my_name",
6529
+ * // "recentScheduledExecutionRecords": [],
6530
+ * // "releaseConfig": "my_releaseConfig",
6531
+ * // "timeZone": "my_timeZone",
6532
+ * // "updateTime": "my_updateTime"
6533
+ * // }
6534
+ * },
6535
+ * });
6536
+ * console.log(res.data);
6537
+ *
6538
+ * // Example response
6539
+ * // {
6540
+ * // "createTime": "my_createTime",
6541
+ * // "cronSchedule": "my_cronSchedule",
6542
+ * // "disabled": false,
6543
+ * // "internalMetadata": "my_internalMetadata",
6544
+ * // "invocationConfig": {},
6545
+ * // "name": "my_name",
6546
+ * // "recentScheduledExecutionRecords": [],
6547
+ * // "releaseConfig": "my_releaseConfig",
6548
+ * // "timeZone": "my_timeZone",
6549
+ * // "updateTime": "my_updateTime"
6550
+ * // }
6551
+ * }
6552
+ *
6553
+ * main().catch(e => {
6554
+ * console.error(e);
6555
+ * throw e;
6556
+ * });
6557
+ *
6558
+ * ```
4821
6559
  *
4822
6560
  * @param params - Parameters for request
4823
6561
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4910,6 +6648,54 @@ export namespace dataform_v1beta1 {
4910
6648
 
4911
6649
  /**
4912
6650
  * Deletes a single WorkflowConfig.
6651
+ * @example
6652
+ * ```js
6653
+ * // Before running the sample:
6654
+ * // - Enable the API at:
6655
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
6656
+ * // - Login into gcloud by running:
6657
+ * // ```sh
6658
+ * // $ gcloud auth application-default login
6659
+ * // ```
6660
+ * // - Install the npm module by running:
6661
+ * // ```sh
6662
+ * // $ npm install googleapis
6663
+ * // ```
6664
+ *
6665
+ * const {google} = require('googleapis');
6666
+ * const dataform = google.dataform('v1beta1');
6667
+ *
6668
+ * async function main() {
6669
+ * const auth = new google.auth.GoogleAuth({
6670
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6671
+ * scopes: [
6672
+ * 'https://www.googleapis.com/auth/bigquery',
6673
+ * 'https://www.googleapis.com/auth/cloud-platform',
6674
+ * ],
6675
+ * });
6676
+ *
6677
+ * // Acquire an auth client, and bind it to all future calls
6678
+ * const authClient = await auth.getClient();
6679
+ * google.options({auth: authClient});
6680
+ *
6681
+ * // Do the magic
6682
+ * const res =
6683
+ * await dataform.projects.locations.repositories.workflowConfigs.delete({
6684
+ * // Required. The workflow config's name.
6685
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workflowConfigs/my-workflowConfig',
6686
+ * });
6687
+ * console.log(res.data);
6688
+ *
6689
+ * // Example response
6690
+ * // {}
6691
+ * }
6692
+ *
6693
+ * main().catch(e => {
6694
+ * console.error(e);
6695
+ * throw e;
6696
+ * });
6697
+ *
6698
+ * ```
4913
6699
  *
4914
6700
  * @param params - Parameters for request
4915
6701
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4999,6 +6785,65 @@ export namespace dataform_v1beta1 {
4999
6785
 
5000
6786
  /**
5001
6787
  * Fetches a single WorkflowConfig.
6788
+ * @example
6789
+ * ```js
6790
+ * // Before running the sample:
6791
+ * // - Enable the API at:
6792
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
6793
+ * // - Login into gcloud by running:
6794
+ * // ```sh
6795
+ * // $ gcloud auth application-default login
6796
+ * // ```
6797
+ * // - Install the npm module by running:
6798
+ * // ```sh
6799
+ * // $ npm install googleapis
6800
+ * // ```
6801
+ *
6802
+ * const {google} = require('googleapis');
6803
+ * const dataform = google.dataform('v1beta1');
6804
+ *
6805
+ * async function main() {
6806
+ * const auth = new google.auth.GoogleAuth({
6807
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6808
+ * scopes: [
6809
+ * 'https://www.googleapis.com/auth/bigquery',
6810
+ * 'https://www.googleapis.com/auth/cloud-platform',
6811
+ * ],
6812
+ * });
6813
+ *
6814
+ * // Acquire an auth client, and bind it to all future calls
6815
+ * const authClient = await auth.getClient();
6816
+ * google.options({auth: authClient});
6817
+ *
6818
+ * // Do the magic
6819
+ * const res =
6820
+ * await dataform.projects.locations.repositories.workflowConfigs.get({
6821
+ * // Required. The workflow config's name.
6822
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workflowConfigs/my-workflowConfig',
6823
+ * });
6824
+ * console.log(res.data);
6825
+ *
6826
+ * // Example response
6827
+ * // {
6828
+ * // "createTime": "my_createTime",
6829
+ * // "cronSchedule": "my_cronSchedule",
6830
+ * // "disabled": false,
6831
+ * // "internalMetadata": "my_internalMetadata",
6832
+ * // "invocationConfig": {},
6833
+ * // "name": "my_name",
6834
+ * // "recentScheduledExecutionRecords": [],
6835
+ * // "releaseConfig": "my_releaseConfig",
6836
+ * // "timeZone": "my_timeZone",
6837
+ * // "updateTime": "my_updateTime"
6838
+ * // }
6839
+ * }
6840
+ *
6841
+ * main().catch(e => {
6842
+ * console.error(e);
6843
+ * throw e;
6844
+ * });
6845
+ *
6846
+ * ```
5002
6847
  *
5003
6848
  * @param params - Parameters for request
5004
6849
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5088,6 +6933,63 @@ export namespace dataform_v1beta1 {
5088
6933
 
5089
6934
  /**
5090
6935
  * Lists WorkflowConfigs in a given Repository.
6936
+ * @example
6937
+ * ```js
6938
+ * // Before running the sample:
6939
+ * // - Enable the API at:
6940
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
6941
+ * // - Login into gcloud by running:
6942
+ * // ```sh
6943
+ * // $ gcloud auth application-default login
6944
+ * // ```
6945
+ * // - Install the npm module by running:
6946
+ * // ```sh
6947
+ * // $ npm install googleapis
6948
+ * // ```
6949
+ *
6950
+ * const {google} = require('googleapis');
6951
+ * const dataform = google.dataform('v1beta1');
6952
+ *
6953
+ * async function main() {
6954
+ * const auth = new google.auth.GoogleAuth({
6955
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6956
+ * scopes: [
6957
+ * 'https://www.googleapis.com/auth/bigquery',
6958
+ * 'https://www.googleapis.com/auth/cloud-platform',
6959
+ * ],
6960
+ * });
6961
+ *
6962
+ * // Acquire an auth client, and bind it to all future calls
6963
+ * const authClient = await auth.getClient();
6964
+ * google.options({auth: authClient});
6965
+ *
6966
+ * // Do the magic
6967
+ * const res =
6968
+ * await dataform.projects.locations.repositories.workflowConfigs.list({
6969
+ * // Optional. Maximum number of workflow configs to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
6970
+ * pageSize: 'placeholder-value',
6971
+ * // Optional. Page token received from a previous `ListWorkflowConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkflowConfigs`, with the exception of `page_size`, must match the call that provided the page token.
6972
+ * pageToken: 'placeholder-value',
6973
+ * // Required. The repository in which to list workflow configs. Must be in the format `projects/x/locations/x/repositories/x`.
6974
+ * parent:
6975
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie',
6976
+ * });
6977
+ * console.log(res.data);
6978
+ *
6979
+ * // Example response
6980
+ * // {
6981
+ * // "nextPageToken": "my_nextPageToken",
6982
+ * // "unreachable": [],
6983
+ * // "workflowConfigs": []
6984
+ * // }
6985
+ * }
6986
+ *
6987
+ * main().catch(e => {
6988
+ * console.error(e);
6989
+ * throw e;
6990
+ * });
6991
+ *
6992
+ * ```
5091
6993
  *
5092
6994
  * @param params - Parameters for request
5093
6995
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5184,6 +7086,84 @@ export namespace dataform_v1beta1 {
5184
7086
 
5185
7087
  /**
5186
7088
  * Updates a single WorkflowConfig. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*
7089
+ * @example
7090
+ * ```js
7091
+ * // Before running the sample:
7092
+ * // - Enable the API at:
7093
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
7094
+ * // - Login into gcloud by running:
7095
+ * // ```sh
7096
+ * // $ gcloud auth application-default login
7097
+ * // ```
7098
+ * // - Install the npm module by running:
7099
+ * // ```sh
7100
+ * // $ npm install googleapis
7101
+ * // ```
7102
+ *
7103
+ * const {google} = require('googleapis');
7104
+ * const dataform = google.dataform('v1beta1');
7105
+ *
7106
+ * async function main() {
7107
+ * const auth = new google.auth.GoogleAuth({
7108
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
7109
+ * scopes: [
7110
+ * 'https://www.googleapis.com/auth/bigquery',
7111
+ * 'https://www.googleapis.com/auth/cloud-platform',
7112
+ * ],
7113
+ * });
7114
+ *
7115
+ * // Acquire an auth client, and bind it to all future calls
7116
+ * const authClient = await auth.getClient();
7117
+ * google.options({auth: authClient});
7118
+ *
7119
+ * // Do the magic
7120
+ * const res =
7121
+ * await dataform.projects.locations.repositories.workflowConfigs.patch({
7122
+ * // Identifier. The workflow config's name.
7123
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workflowConfigs/my-workflowConfig',
7124
+ * // Optional. Specifies the fields to be updated in the workflow config. If left unset, all fields will be updated.
7125
+ * updateMask: 'placeholder-value',
7126
+ *
7127
+ * // Request body metadata
7128
+ * requestBody: {
7129
+ * // request body parameters
7130
+ * // {
7131
+ * // "createTime": "my_createTime",
7132
+ * // "cronSchedule": "my_cronSchedule",
7133
+ * // "disabled": false,
7134
+ * // "internalMetadata": "my_internalMetadata",
7135
+ * // "invocationConfig": {},
7136
+ * // "name": "my_name",
7137
+ * // "recentScheduledExecutionRecords": [],
7138
+ * // "releaseConfig": "my_releaseConfig",
7139
+ * // "timeZone": "my_timeZone",
7140
+ * // "updateTime": "my_updateTime"
7141
+ * // }
7142
+ * },
7143
+ * });
7144
+ * console.log(res.data);
7145
+ *
7146
+ * // Example response
7147
+ * // {
7148
+ * // "createTime": "my_createTime",
7149
+ * // "cronSchedule": "my_cronSchedule",
7150
+ * // "disabled": false,
7151
+ * // "internalMetadata": "my_internalMetadata",
7152
+ * // "invocationConfig": {},
7153
+ * // "name": "my_name",
7154
+ * // "recentScheduledExecutionRecords": [],
7155
+ * // "releaseConfig": "my_releaseConfig",
7156
+ * // "timeZone": "my_timeZone",
7157
+ * // "updateTime": "my_updateTime"
7158
+ * // }
7159
+ * }
7160
+ *
7161
+ * main().catch(e => {
7162
+ * console.error(e);
7163
+ * throw e;
7164
+ * });
7165
+ *
7166
+ * ```
5187
7167
  *
5188
7168
  * @param params - Parameters for request
5189
7169
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5342,6 +7322,60 @@ export namespace dataform_v1beta1 {
5342
7322
 
5343
7323
  /**
5344
7324
  * Requests cancellation of a running WorkflowInvocation.
7325
+ * @example
7326
+ * ```js
7327
+ * // Before running the sample:
7328
+ * // - Enable the API at:
7329
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
7330
+ * // - Login into gcloud by running:
7331
+ * // ```sh
7332
+ * // $ gcloud auth application-default login
7333
+ * // ```
7334
+ * // - Install the npm module by running:
7335
+ * // ```sh
7336
+ * // $ npm install googleapis
7337
+ * // ```
7338
+ *
7339
+ * const {google} = require('googleapis');
7340
+ * const dataform = google.dataform('v1beta1');
7341
+ *
7342
+ * async function main() {
7343
+ * const auth = new google.auth.GoogleAuth({
7344
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
7345
+ * scopes: [
7346
+ * 'https://www.googleapis.com/auth/bigquery',
7347
+ * 'https://www.googleapis.com/auth/cloud-platform',
7348
+ * ],
7349
+ * });
7350
+ *
7351
+ * // Acquire an auth client, and bind it to all future calls
7352
+ * const authClient = await auth.getClient();
7353
+ * google.options({auth: authClient});
7354
+ *
7355
+ * // Do the magic
7356
+ * const res =
7357
+ * await dataform.projects.locations.repositories.workflowInvocations.cancel({
7358
+ * // Required. The workflow invocation resource's name.
7359
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workflowInvocations/my-workflowInvocation',
7360
+ *
7361
+ * // Request body metadata
7362
+ * requestBody: {
7363
+ * // request body parameters
7364
+ * // {}
7365
+ * },
7366
+ * });
7367
+ * console.log(res.data);
7368
+ *
7369
+ * // Example response
7370
+ * // {}
7371
+ * }
7372
+ *
7373
+ * main().catch(e => {
7374
+ * console.error(e);
7375
+ * throw e;
7376
+ * });
7377
+ *
7378
+ * ```
5345
7379
  *
5346
7380
  * @param params - Parameters for request
5347
7381
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5444,6 +7478,81 @@ export namespace dataform_v1beta1 {
5444
7478
 
5445
7479
  /**
5446
7480
  * Creates a new WorkflowInvocation in a given Repository.
7481
+ * @example
7482
+ * ```js
7483
+ * // Before running the sample:
7484
+ * // - Enable the API at:
7485
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
7486
+ * // - Login into gcloud by running:
7487
+ * // ```sh
7488
+ * // $ gcloud auth application-default login
7489
+ * // ```
7490
+ * // - Install the npm module by running:
7491
+ * // ```sh
7492
+ * // $ npm install googleapis
7493
+ * // ```
7494
+ *
7495
+ * const {google} = require('googleapis');
7496
+ * const dataform = google.dataform('v1beta1');
7497
+ *
7498
+ * async function main() {
7499
+ * const auth = new google.auth.GoogleAuth({
7500
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
7501
+ * scopes: [
7502
+ * 'https://www.googleapis.com/auth/bigquery',
7503
+ * 'https://www.googleapis.com/auth/cloud-platform',
7504
+ * ],
7505
+ * });
7506
+ *
7507
+ * // Acquire an auth client, and bind it to all future calls
7508
+ * const authClient = await auth.getClient();
7509
+ * google.options({auth: authClient});
7510
+ *
7511
+ * // Do the magic
7512
+ * const res =
7513
+ * await dataform.projects.locations.repositories.workflowInvocations.create({
7514
+ * // Required. The repository in which to create the workflow invocation. Must be in the format `projects/x/locations/x/repositories/x`.
7515
+ * parent:
7516
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie',
7517
+ *
7518
+ * // Request body metadata
7519
+ * requestBody: {
7520
+ * // request body parameters
7521
+ * // {
7522
+ * // "compilationResult": "my_compilationResult",
7523
+ * // "dataEncryptionState": {},
7524
+ * // "internalMetadata": "my_internalMetadata",
7525
+ * // "invocationConfig": {},
7526
+ * // "invocationTiming": {},
7527
+ * // "name": "my_name",
7528
+ * // "resolvedCompilationResult": "my_resolvedCompilationResult",
7529
+ * // "state": "my_state",
7530
+ * // "workflowConfig": "my_workflowConfig"
7531
+ * // }
7532
+ * },
7533
+ * });
7534
+ * console.log(res.data);
7535
+ *
7536
+ * // Example response
7537
+ * // {
7538
+ * // "compilationResult": "my_compilationResult",
7539
+ * // "dataEncryptionState": {},
7540
+ * // "internalMetadata": "my_internalMetadata",
7541
+ * // "invocationConfig": {},
7542
+ * // "invocationTiming": {},
7543
+ * // "name": "my_name",
7544
+ * // "resolvedCompilationResult": "my_resolvedCompilationResult",
7545
+ * // "state": "my_state",
7546
+ * // "workflowConfig": "my_workflowConfig"
7547
+ * // }
7548
+ * }
7549
+ *
7550
+ * main().catch(e => {
7551
+ * console.error(e);
7552
+ * throw e;
7553
+ * });
7554
+ *
7555
+ * ```
5447
7556
  *
5448
7557
  * @param params - Parameters for request
5449
7558
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5536,6 +7645,54 @@ export namespace dataform_v1beta1 {
5536
7645
 
5537
7646
  /**
5538
7647
  * Deletes a single WorkflowInvocation.
7648
+ * @example
7649
+ * ```js
7650
+ * // Before running the sample:
7651
+ * // - Enable the API at:
7652
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
7653
+ * // - Login into gcloud by running:
7654
+ * // ```sh
7655
+ * // $ gcloud auth application-default login
7656
+ * // ```
7657
+ * // - Install the npm module by running:
7658
+ * // ```sh
7659
+ * // $ npm install googleapis
7660
+ * // ```
7661
+ *
7662
+ * const {google} = require('googleapis');
7663
+ * const dataform = google.dataform('v1beta1');
7664
+ *
7665
+ * async function main() {
7666
+ * const auth = new google.auth.GoogleAuth({
7667
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
7668
+ * scopes: [
7669
+ * 'https://www.googleapis.com/auth/bigquery',
7670
+ * 'https://www.googleapis.com/auth/cloud-platform',
7671
+ * ],
7672
+ * });
7673
+ *
7674
+ * // Acquire an auth client, and bind it to all future calls
7675
+ * const authClient = await auth.getClient();
7676
+ * google.options({auth: authClient});
7677
+ *
7678
+ * // Do the magic
7679
+ * const res =
7680
+ * await dataform.projects.locations.repositories.workflowInvocations.delete({
7681
+ * // Required. The workflow invocation resource's name.
7682
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workflowInvocations/my-workflowInvocation',
7683
+ * });
7684
+ * console.log(res.data);
7685
+ *
7686
+ * // Example response
7687
+ * // {}
7688
+ * }
7689
+ *
7690
+ * main().catch(e => {
7691
+ * console.error(e);
7692
+ * throw e;
7693
+ * });
7694
+ *
7695
+ * ```
5539
7696
  *
5540
7697
  * @param params - Parameters for request
5541
7698
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5625,6 +7782,64 @@ export namespace dataform_v1beta1 {
5625
7782
 
5626
7783
  /**
5627
7784
  * Fetches a single WorkflowInvocation.
7785
+ * @example
7786
+ * ```js
7787
+ * // Before running the sample:
7788
+ * // - Enable the API at:
7789
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
7790
+ * // - Login into gcloud by running:
7791
+ * // ```sh
7792
+ * // $ gcloud auth application-default login
7793
+ * // ```
7794
+ * // - Install the npm module by running:
7795
+ * // ```sh
7796
+ * // $ npm install googleapis
7797
+ * // ```
7798
+ *
7799
+ * const {google} = require('googleapis');
7800
+ * const dataform = google.dataform('v1beta1');
7801
+ *
7802
+ * async function main() {
7803
+ * const auth = new google.auth.GoogleAuth({
7804
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
7805
+ * scopes: [
7806
+ * 'https://www.googleapis.com/auth/bigquery',
7807
+ * 'https://www.googleapis.com/auth/cloud-platform',
7808
+ * ],
7809
+ * });
7810
+ *
7811
+ * // Acquire an auth client, and bind it to all future calls
7812
+ * const authClient = await auth.getClient();
7813
+ * google.options({auth: authClient});
7814
+ *
7815
+ * // Do the magic
7816
+ * const res =
7817
+ * await dataform.projects.locations.repositories.workflowInvocations.get({
7818
+ * // Required. The workflow invocation resource's name.
7819
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workflowInvocations/my-workflowInvocation',
7820
+ * });
7821
+ * console.log(res.data);
7822
+ *
7823
+ * // Example response
7824
+ * // {
7825
+ * // "compilationResult": "my_compilationResult",
7826
+ * // "dataEncryptionState": {},
7827
+ * // "internalMetadata": "my_internalMetadata",
7828
+ * // "invocationConfig": {},
7829
+ * // "invocationTiming": {},
7830
+ * // "name": "my_name",
7831
+ * // "resolvedCompilationResult": "my_resolvedCompilationResult",
7832
+ * // "state": "my_state",
7833
+ * // "workflowConfig": "my_workflowConfig"
7834
+ * // }
7835
+ * }
7836
+ *
7837
+ * main().catch(e => {
7838
+ * console.error(e);
7839
+ * throw e;
7840
+ * });
7841
+ *
7842
+ * ```
5628
7843
  *
5629
7844
  * @param params - Parameters for request
5630
7845
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5714,6 +7929,67 @@ export namespace dataform_v1beta1 {
5714
7929
 
5715
7930
  /**
5716
7931
  * Lists WorkflowInvocations in a given Repository.
7932
+ * @example
7933
+ * ```js
7934
+ * // Before running the sample:
7935
+ * // - Enable the API at:
7936
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
7937
+ * // - Login into gcloud by running:
7938
+ * // ```sh
7939
+ * // $ gcloud auth application-default login
7940
+ * // ```
7941
+ * // - Install the npm module by running:
7942
+ * // ```sh
7943
+ * // $ npm install googleapis
7944
+ * // ```
7945
+ *
7946
+ * const {google} = require('googleapis');
7947
+ * const dataform = google.dataform('v1beta1');
7948
+ *
7949
+ * async function main() {
7950
+ * const auth = new google.auth.GoogleAuth({
7951
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
7952
+ * scopes: [
7953
+ * 'https://www.googleapis.com/auth/bigquery',
7954
+ * 'https://www.googleapis.com/auth/cloud-platform',
7955
+ * ],
7956
+ * });
7957
+ *
7958
+ * // Acquire an auth client, and bind it to all future calls
7959
+ * const authClient = await auth.getClient();
7960
+ * google.options({auth: authClient});
7961
+ *
7962
+ * // Do the magic
7963
+ * const res =
7964
+ * await dataform.projects.locations.repositories.workflowInvocations.list({
7965
+ * // Optional. Filter for the returned list.
7966
+ * filter: 'placeholder-value',
7967
+ * // Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field.
7968
+ * orderBy: 'placeholder-value',
7969
+ * // Optional. Maximum number of workflow invocations to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
7970
+ * pageSize: 'placeholder-value',
7971
+ * // Optional. Page token received from a previous `ListWorkflowInvocations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkflowInvocations`, with the exception of `page_size`, must match the call that provided the page token.
7972
+ * pageToken: 'placeholder-value',
7973
+ * // Required. The parent resource of the WorkflowInvocation type. Must be in the format `projects/x/locations/x/repositories/x`.
7974
+ * parent:
7975
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie',
7976
+ * });
7977
+ * console.log(res.data);
7978
+ *
7979
+ * // Example response
7980
+ * // {
7981
+ * // "nextPageToken": "my_nextPageToken",
7982
+ * // "unreachable": [],
7983
+ * // "workflowInvocations": []
7984
+ * // }
7985
+ * }
7986
+ *
7987
+ * main().catch(e => {
7988
+ * console.error(e);
7989
+ * throw e;
7990
+ * });
7991
+ *
7992
+ * ```
5717
7993
  *
5718
7994
  * @param params - Parameters for request
5719
7995
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5812,6 +8088,61 @@ export namespace dataform_v1beta1 {
5812
8088
 
5813
8089
  /**
5814
8090
  * Returns WorkflowInvocationActions in a given WorkflowInvocation.
8091
+ * @example
8092
+ * ```js
8093
+ * // Before running the sample:
8094
+ * // - Enable the API at:
8095
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
8096
+ * // - Login into gcloud by running:
8097
+ * // ```sh
8098
+ * // $ gcloud auth application-default login
8099
+ * // ```
8100
+ * // - Install the npm module by running:
8101
+ * // ```sh
8102
+ * // $ npm install googleapis
8103
+ * // ```
8104
+ *
8105
+ * const {google} = require('googleapis');
8106
+ * const dataform = google.dataform('v1beta1');
8107
+ *
8108
+ * async function main() {
8109
+ * const auth = new google.auth.GoogleAuth({
8110
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
8111
+ * scopes: [
8112
+ * 'https://www.googleapis.com/auth/bigquery',
8113
+ * 'https://www.googleapis.com/auth/cloud-platform',
8114
+ * ],
8115
+ * });
8116
+ *
8117
+ * // Acquire an auth client, and bind it to all future calls
8118
+ * const authClient = await auth.getClient();
8119
+ * google.options({auth: authClient});
8120
+ *
8121
+ * // Do the magic
8122
+ * const res =
8123
+ * await dataform.projects.locations.repositories.workflowInvocations.query({
8124
+ * // Required. The workflow invocation's name.
8125
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workflowInvocations/my-workflowInvocation',
8126
+ * // Optional. Maximum number of workflow invocations to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
8127
+ * pageSize: 'placeholder-value',
8128
+ * // Optional. Page token received from a previous `QueryWorkflowInvocationActions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryWorkflowInvocationActions`, with the exception of `page_size`, must match the call that provided the page token.
8129
+ * pageToken: 'placeholder-value',
8130
+ * });
8131
+ * console.log(res.data);
8132
+ *
8133
+ * // Example response
8134
+ * // {
8135
+ * // "nextPageToken": "my_nextPageToken",
8136
+ * // "workflowInvocationActions": []
8137
+ * // }
8138
+ * }
8139
+ *
8140
+ * main().catch(e => {
8141
+ * console.error(e);
8142
+ * throw e;
8143
+ * });
8144
+ *
8145
+ * ```
5815
8146
  *
5816
8147
  * @param params - Parameters for request
5817
8148
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5998,6 +8329,63 @@ export namespace dataform_v1beta1 {
5998
8329
 
5999
8330
  /**
6000
8331
  * Applies a Git commit for uncommitted files in a Workspace.
8332
+ * @example
8333
+ * ```js
8334
+ * // Before running the sample:
8335
+ * // - Enable the API at:
8336
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
8337
+ * // - Login into gcloud by running:
8338
+ * // ```sh
8339
+ * // $ gcloud auth application-default login
8340
+ * // ```
8341
+ * // - Install the npm module by running:
8342
+ * // ```sh
8343
+ * // $ npm install googleapis
8344
+ * // ```
8345
+ *
8346
+ * const {google} = require('googleapis');
8347
+ * const dataform = google.dataform('v1beta1');
8348
+ *
8349
+ * async function main() {
8350
+ * const auth = new google.auth.GoogleAuth({
8351
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
8352
+ * scopes: [
8353
+ * 'https://www.googleapis.com/auth/bigquery',
8354
+ * 'https://www.googleapis.com/auth/cloud-platform',
8355
+ * ],
8356
+ * });
8357
+ *
8358
+ * // Acquire an auth client, and bind it to all future calls
8359
+ * const authClient = await auth.getClient();
8360
+ * google.options({auth: authClient});
8361
+ *
8362
+ * // Do the magic
8363
+ * const res = await dataform.projects.locations.repositories.workspaces.commit({
8364
+ * // Required. The workspace's name.
8365
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
8366
+ *
8367
+ * // Request body metadata
8368
+ * requestBody: {
8369
+ * // request body parameters
8370
+ * // {
8371
+ * // "author": {},
8372
+ * // "commitMessage": "my_commitMessage",
8373
+ * // "paths": []
8374
+ * // }
8375
+ * },
8376
+ * });
8377
+ * console.log(res.data);
8378
+ *
8379
+ * // Example response
8380
+ * // {}
8381
+ * }
8382
+ *
8383
+ * main().catch(e => {
8384
+ * console.error(e);
8385
+ * throw e;
8386
+ * });
8387
+ *
8388
+ * ```
6001
8389
  *
6002
8390
  * @param params - Parameters for request
6003
8391
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6096,6 +8484,72 @@ export namespace dataform_v1beta1 {
6096
8484
 
6097
8485
  /**
6098
8486
  * Creates a new Workspace in a given Repository.
8487
+ * @example
8488
+ * ```js
8489
+ * // Before running the sample:
8490
+ * // - Enable the API at:
8491
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
8492
+ * // - Login into gcloud by running:
8493
+ * // ```sh
8494
+ * // $ gcloud auth application-default login
8495
+ * // ```
8496
+ * // - Install the npm module by running:
8497
+ * // ```sh
8498
+ * // $ npm install googleapis
8499
+ * // ```
8500
+ *
8501
+ * const {google} = require('googleapis');
8502
+ * const dataform = google.dataform('v1beta1');
8503
+ *
8504
+ * async function main() {
8505
+ * const auth = new google.auth.GoogleAuth({
8506
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
8507
+ * scopes: [
8508
+ * 'https://www.googleapis.com/auth/bigquery',
8509
+ * 'https://www.googleapis.com/auth/cloud-platform',
8510
+ * ],
8511
+ * });
8512
+ *
8513
+ * // Acquire an auth client, and bind it to all future calls
8514
+ * const authClient = await auth.getClient();
8515
+ * google.options({auth: authClient});
8516
+ *
8517
+ * // Do the magic
8518
+ * const res = await dataform.projects.locations.repositories.workspaces.create({
8519
+ * // Required. The repository in which to create the workspace. Must be in the format `projects/x/locations/x/repositories/x`.
8520
+ * parent:
8521
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie',
8522
+ * // Required. The ID to use for the workspace, which will become the final component of the workspace's resource name.
8523
+ * workspaceId: 'placeholder-value',
8524
+ *
8525
+ * // Request body metadata
8526
+ * requestBody: {
8527
+ * // request body parameters
8528
+ * // {
8529
+ * // "createTime": "my_createTime",
8530
+ * // "dataEncryptionState": {},
8531
+ * // "internalMetadata": "my_internalMetadata",
8532
+ * // "name": "my_name"
8533
+ * // }
8534
+ * },
8535
+ * });
8536
+ * console.log(res.data);
8537
+ *
8538
+ * // Example response
8539
+ * // {
8540
+ * // "createTime": "my_createTime",
8541
+ * // "dataEncryptionState": {},
8542
+ * // "internalMetadata": "my_internalMetadata",
8543
+ * // "name": "my_name"
8544
+ * // }
8545
+ * }
8546
+ *
8547
+ * main().catch(e => {
8548
+ * console.error(e);
8549
+ * throw e;
8550
+ * });
8551
+ *
8552
+ * ```
6099
8553
  *
6100
8554
  * @param params - Parameters for request
6101
8555
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6188,6 +8642,53 @@ export namespace dataform_v1beta1 {
6188
8642
 
6189
8643
  /**
6190
8644
  * Deletes a single Workspace.
8645
+ * @example
8646
+ * ```js
8647
+ * // Before running the sample:
8648
+ * // - Enable the API at:
8649
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
8650
+ * // - Login into gcloud by running:
8651
+ * // ```sh
8652
+ * // $ gcloud auth application-default login
8653
+ * // ```
8654
+ * // - Install the npm module by running:
8655
+ * // ```sh
8656
+ * // $ npm install googleapis
8657
+ * // ```
8658
+ *
8659
+ * const {google} = require('googleapis');
8660
+ * const dataform = google.dataform('v1beta1');
8661
+ *
8662
+ * async function main() {
8663
+ * const auth = new google.auth.GoogleAuth({
8664
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
8665
+ * scopes: [
8666
+ * 'https://www.googleapis.com/auth/bigquery',
8667
+ * 'https://www.googleapis.com/auth/cloud-platform',
8668
+ * ],
8669
+ * });
8670
+ *
8671
+ * // Acquire an auth client, and bind it to all future calls
8672
+ * const authClient = await auth.getClient();
8673
+ * google.options({auth: authClient});
8674
+ *
8675
+ * // Do the magic
8676
+ * const res = await dataform.projects.locations.repositories.workspaces.delete({
8677
+ * // Required. The workspace resource's name.
8678
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
8679
+ * });
8680
+ * console.log(res.data);
8681
+ *
8682
+ * // Example response
8683
+ * // {}
8684
+ * }
8685
+ *
8686
+ * main().catch(e => {
8687
+ * console.error(e);
8688
+ * throw e;
8689
+ * });
8690
+ *
8691
+ * ```
6191
8692
  *
6192
8693
  * @param params - Parameters for request
6193
8694
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6277,6 +8778,59 @@ export namespace dataform_v1beta1 {
6277
8778
 
6278
8779
  /**
6279
8780
  * Fetches Git diff for an uncommitted file in a Workspace.
8781
+ * @example
8782
+ * ```js
8783
+ * // Before running the sample:
8784
+ * // - Enable the API at:
8785
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
8786
+ * // - Login into gcloud by running:
8787
+ * // ```sh
8788
+ * // $ gcloud auth application-default login
8789
+ * // ```
8790
+ * // - Install the npm module by running:
8791
+ * // ```sh
8792
+ * // $ npm install googleapis
8793
+ * // ```
8794
+ *
8795
+ * const {google} = require('googleapis');
8796
+ * const dataform = google.dataform('v1beta1');
8797
+ *
8798
+ * async function main() {
8799
+ * const auth = new google.auth.GoogleAuth({
8800
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
8801
+ * scopes: [
8802
+ * 'https://www.googleapis.com/auth/bigquery',
8803
+ * 'https://www.googleapis.com/auth/cloud-platform',
8804
+ * ],
8805
+ * });
8806
+ *
8807
+ * // Acquire an auth client, and bind it to all future calls
8808
+ * const authClient = await auth.getClient();
8809
+ * google.options({auth: authClient});
8810
+ *
8811
+ * // Do the magic
8812
+ * const res =
8813
+ * await dataform.projects.locations.repositories.workspaces.fetchFileDiff({
8814
+ * // Required. The file's full path including filename, relative to the workspace root.
8815
+ * path: 'placeholder-value',
8816
+ * // Required. The workspace's name.
8817
+ * workspace:
8818
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
8819
+ * });
8820
+ * console.log(res.data);
8821
+ *
8822
+ * // Example response
8823
+ * // {
8824
+ * // "formattedDiff": "my_formattedDiff"
8825
+ * // }
8826
+ * }
8827
+ *
8828
+ * main().catch(e => {
8829
+ * console.error(e);
8830
+ * throw e;
8831
+ * });
8832
+ *
8833
+ * ```
6280
8834
  *
6281
8835
  * @param params - Parameters for request
6282
8836
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6373,6 +8927,58 @@ export namespace dataform_v1beta1 {
6373
8927
 
6374
8928
  /**
6375
8929
  * Fetches Git statuses for the files in a Workspace.
8930
+ * @example
8931
+ * ```js
8932
+ * // Before running the sample:
8933
+ * // - Enable the API at:
8934
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
8935
+ * // - Login into gcloud by running:
8936
+ * // ```sh
8937
+ * // $ gcloud auth application-default login
8938
+ * // ```
8939
+ * // - Install the npm module by running:
8940
+ * // ```sh
8941
+ * // $ npm install googleapis
8942
+ * // ```
8943
+ *
8944
+ * const {google} = require('googleapis');
8945
+ * const dataform = google.dataform('v1beta1');
8946
+ *
8947
+ * async function main() {
8948
+ * const auth = new google.auth.GoogleAuth({
8949
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
8950
+ * scopes: [
8951
+ * 'https://www.googleapis.com/auth/bigquery',
8952
+ * 'https://www.googleapis.com/auth/cloud-platform',
8953
+ * ],
8954
+ * });
8955
+ *
8956
+ * // Acquire an auth client, and bind it to all future calls
8957
+ * const authClient = await auth.getClient();
8958
+ * google.options({auth: authClient});
8959
+ *
8960
+ * // Do the magic
8961
+ * const res =
8962
+ * await dataform.projects.locations.repositories.workspaces.fetchFileGitStatuses(
8963
+ * {
8964
+ * // Required. The workspace's name.
8965
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
8966
+ * },
8967
+ * );
8968
+ * console.log(res.data);
8969
+ *
8970
+ * // Example response
8971
+ * // {
8972
+ * // "uncommittedFileChanges": []
8973
+ * // }
8974
+ * }
8975
+ *
8976
+ * main().catch(e => {
8977
+ * console.error(e);
8978
+ * throw e;
8979
+ * });
8980
+ *
8981
+ * ```
6376
8982
  *
6377
8983
  * @param params - Parameters for request
6378
8984
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6471,6 +9077,61 @@ export namespace dataform_v1beta1 {
6471
9077
 
6472
9078
  /**
6473
9079
  * Fetches Git ahead/behind against a remote branch.
9080
+ * @example
9081
+ * ```js
9082
+ * // Before running the sample:
9083
+ * // - Enable the API at:
9084
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
9085
+ * // - Login into gcloud by running:
9086
+ * // ```sh
9087
+ * // $ gcloud auth application-default login
9088
+ * // ```
9089
+ * // - Install the npm module by running:
9090
+ * // ```sh
9091
+ * // $ npm install googleapis
9092
+ * // ```
9093
+ *
9094
+ * const {google} = require('googleapis');
9095
+ * const dataform = google.dataform('v1beta1');
9096
+ *
9097
+ * async function main() {
9098
+ * const auth = new google.auth.GoogleAuth({
9099
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
9100
+ * scopes: [
9101
+ * 'https://www.googleapis.com/auth/bigquery',
9102
+ * 'https://www.googleapis.com/auth/cloud-platform',
9103
+ * ],
9104
+ * });
9105
+ *
9106
+ * // Acquire an auth client, and bind it to all future calls
9107
+ * const authClient = await auth.getClient();
9108
+ * google.options({auth: authClient});
9109
+ *
9110
+ * // Do the magic
9111
+ * const res =
9112
+ * await dataform.projects.locations.repositories.workspaces.fetchGitAheadBehind(
9113
+ * {
9114
+ * // Required. The workspace's name.
9115
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
9116
+ * // Optional. The name of the branch in the Git remote against which this workspace should be compared. If left unset, the repository's default branch name will be used.
9117
+ * remoteBranch: 'placeholder-value',
9118
+ * },
9119
+ * );
9120
+ * console.log(res.data);
9121
+ *
9122
+ * // Example response
9123
+ * // {
9124
+ * // "commitsAhead": 0,
9125
+ * // "commitsBehind": 0
9126
+ * // }
9127
+ * }
9128
+ *
9129
+ * main().catch(e => {
9130
+ * console.error(e);
9131
+ * throw e;
9132
+ * });
9133
+ *
9134
+ * ```
6474
9135
  *
6475
9136
  * @param params - Parameters for request
6476
9137
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6567,6 +9228,58 @@ export namespace dataform_v1beta1 {
6567
9228
 
6568
9229
  /**
6569
9230
  * Fetches a single Workspace.
9231
+ * @example
9232
+ * ```js
9233
+ * // Before running the sample:
9234
+ * // - Enable the API at:
9235
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
9236
+ * // - Login into gcloud by running:
9237
+ * // ```sh
9238
+ * // $ gcloud auth application-default login
9239
+ * // ```
9240
+ * // - Install the npm module by running:
9241
+ * // ```sh
9242
+ * // $ npm install googleapis
9243
+ * // ```
9244
+ *
9245
+ * const {google} = require('googleapis');
9246
+ * const dataform = google.dataform('v1beta1');
9247
+ *
9248
+ * async function main() {
9249
+ * const auth = new google.auth.GoogleAuth({
9250
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
9251
+ * scopes: [
9252
+ * 'https://www.googleapis.com/auth/bigquery',
9253
+ * 'https://www.googleapis.com/auth/cloud-platform',
9254
+ * ],
9255
+ * });
9256
+ *
9257
+ * // Acquire an auth client, and bind it to all future calls
9258
+ * const authClient = await auth.getClient();
9259
+ * google.options({auth: authClient});
9260
+ *
9261
+ * // Do the magic
9262
+ * const res = await dataform.projects.locations.repositories.workspaces.get({
9263
+ * // Required. The workspace's name.
9264
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
9265
+ * });
9266
+ * console.log(res.data);
9267
+ *
9268
+ * // Example response
9269
+ * // {
9270
+ * // "createTime": "my_createTime",
9271
+ * // "dataEncryptionState": {},
9272
+ * // "internalMetadata": "my_internalMetadata",
9273
+ * // "name": "my_name"
9274
+ * // }
9275
+ * }
9276
+ *
9277
+ * main().catch(e => {
9278
+ * console.error(e);
9279
+ * throw e;
9280
+ * });
9281
+ *
9282
+ * ```
6570
9283
  *
6571
9284
  * @param params - Parameters for request
6572
9285
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6656,6 +9369,61 @@ export namespace dataform_v1beta1 {
6656
9369
 
6657
9370
  /**
6658
9371
  * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
9372
+ * @example
9373
+ * ```js
9374
+ * // Before running the sample:
9375
+ * // - Enable the API at:
9376
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
9377
+ * // - Login into gcloud by running:
9378
+ * // ```sh
9379
+ * // $ gcloud auth application-default login
9380
+ * // ```
9381
+ * // - Install the npm module by running:
9382
+ * // ```sh
9383
+ * // $ npm install googleapis
9384
+ * // ```
9385
+ *
9386
+ * const {google} = require('googleapis');
9387
+ * const dataform = google.dataform('v1beta1');
9388
+ *
9389
+ * async function main() {
9390
+ * const auth = new google.auth.GoogleAuth({
9391
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
9392
+ * scopes: [
9393
+ * 'https://www.googleapis.com/auth/bigquery',
9394
+ * 'https://www.googleapis.com/auth/cloud-platform',
9395
+ * ],
9396
+ * });
9397
+ *
9398
+ * // Acquire an auth client, and bind it to all future calls
9399
+ * const authClient = await auth.getClient();
9400
+ * google.options({auth: authClient});
9401
+ *
9402
+ * // Do the magic
9403
+ * const res =
9404
+ * await dataform.projects.locations.repositories.workspaces.getIamPolicy({
9405
+ * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
9406
+ * 'options.requestedPolicyVersion': 'placeholder-value',
9407
+ * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
9408
+ * resource:
9409
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
9410
+ * });
9411
+ * console.log(res.data);
9412
+ *
9413
+ * // Example response
9414
+ * // {
9415
+ * // "bindings": [],
9416
+ * // "etag": "my_etag",
9417
+ * // "version": 0
9418
+ * // }
9419
+ * }
9420
+ *
9421
+ * main().catch(e => {
9422
+ * console.error(e);
9423
+ * throw e;
9424
+ * });
9425
+ *
9426
+ * ```
6659
9427
  *
6660
9428
  * @param params - Parameters for request
6661
9429
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6748,6 +9516,63 @@ export namespace dataform_v1beta1 {
6748
9516
 
6749
9517
  /**
6750
9518
  * Installs dependency NPM packages (inside a Workspace).
9519
+ * @example
9520
+ * ```js
9521
+ * // Before running the sample:
9522
+ * // - Enable the API at:
9523
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
9524
+ * // - Login into gcloud by running:
9525
+ * // ```sh
9526
+ * // $ gcloud auth application-default login
9527
+ * // ```
9528
+ * // - Install the npm module by running:
9529
+ * // ```sh
9530
+ * // $ npm install googleapis
9531
+ * // ```
9532
+ *
9533
+ * const {google} = require('googleapis');
9534
+ * const dataform = google.dataform('v1beta1');
9535
+ *
9536
+ * async function main() {
9537
+ * const auth = new google.auth.GoogleAuth({
9538
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
9539
+ * scopes: [
9540
+ * 'https://www.googleapis.com/auth/bigquery',
9541
+ * 'https://www.googleapis.com/auth/cloud-platform',
9542
+ * ],
9543
+ * });
9544
+ *
9545
+ * // Acquire an auth client, and bind it to all future calls
9546
+ * const authClient = await auth.getClient();
9547
+ * google.options({auth: authClient});
9548
+ *
9549
+ * // Do the magic
9550
+ * const res =
9551
+ * await dataform.projects.locations.repositories.workspaces.installNpmPackages(
9552
+ * {
9553
+ * // Required. The workspace's name.
9554
+ * workspace:
9555
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
9556
+ *
9557
+ * // Request body metadata
9558
+ * requestBody: {
9559
+ * // request body parameters
9560
+ * // {}
9561
+ * },
9562
+ * },
9563
+ * );
9564
+ * console.log(res.data);
9565
+ *
9566
+ * // Example response
9567
+ * // {}
9568
+ * }
9569
+ *
9570
+ * main().catch(e => {
9571
+ * console.error(e);
9572
+ * throw e;
9573
+ * });
9574
+ *
9575
+ * ```
6751
9576
  *
6752
9577
  * @param params - Parameters for request
6753
9578
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6844,6 +9669,66 @@ export namespace dataform_v1beta1 {
6844
9669
 
6845
9670
  /**
6846
9671
  * Lists Workspaces in a given Repository.
9672
+ * @example
9673
+ * ```js
9674
+ * // Before running the sample:
9675
+ * // - Enable the API at:
9676
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
9677
+ * // - Login into gcloud by running:
9678
+ * // ```sh
9679
+ * // $ gcloud auth application-default login
9680
+ * // ```
9681
+ * // - Install the npm module by running:
9682
+ * // ```sh
9683
+ * // $ npm install googleapis
9684
+ * // ```
9685
+ *
9686
+ * const {google} = require('googleapis');
9687
+ * const dataform = google.dataform('v1beta1');
9688
+ *
9689
+ * async function main() {
9690
+ * const auth = new google.auth.GoogleAuth({
9691
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
9692
+ * scopes: [
9693
+ * 'https://www.googleapis.com/auth/bigquery',
9694
+ * 'https://www.googleapis.com/auth/cloud-platform',
9695
+ * ],
9696
+ * });
9697
+ *
9698
+ * // Acquire an auth client, and bind it to all future calls
9699
+ * const authClient = await auth.getClient();
9700
+ * google.options({auth: authClient});
9701
+ *
9702
+ * // Do the magic
9703
+ * const res = await dataform.projects.locations.repositories.workspaces.list({
9704
+ * // Optional. Filter for the returned list.
9705
+ * filter: 'placeholder-value',
9706
+ * // Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field.
9707
+ * orderBy: 'placeholder-value',
9708
+ * // Optional. Maximum number of workspaces to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
9709
+ * pageSize: 'placeholder-value',
9710
+ * // Optional. Page token received from a previous `ListWorkspaces` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkspaces`, with the exception of `page_size`, must match the call that provided the page token.
9711
+ * pageToken: 'placeholder-value',
9712
+ * // Required. The repository in which to list workspaces. Must be in the format `projects/x/locations/x/repositories/x`.
9713
+ * parent:
9714
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie',
9715
+ * });
9716
+ * console.log(res.data);
9717
+ *
9718
+ * // Example response
9719
+ * // {
9720
+ * // "nextPageToken": "my_nextPageToken",
9721
+ * // "unreachable": [],
9722
+ * // "workspaces": []
9723
+ * // }
9724
+ * }
9725
+ *
9726
+ * main().catch(e => {
9727
+ * console.error(e);
9728
+ * throw e;
9729
+ * });
9730
+ *
9731
+ * ```
6847
9732
  *
6848
9733
  * @param params - Parameters for request
6849
9734
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6938,6 +9823,63 @@ export namespace dataform_v1beta1 {
6938
9823
 
6939
9824
  /**
6940
9825
  * Creates a directory inside a Workspace.
9826
+ * @example
9827
+ * ```js
9828
+ * // Before running the sample:
9829
+ * // - Enable the API at:
9830
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
9831
+ * // - Login into gcloud by running:
9832
+ * // ```sh
9833
+ * // $ gcloud auth application-default login
9834
+ * // ```
9835
+ * // - Install the npm module by running:
9836
+ * // ```sh
9837
+ * // $ npm install googleapis
9838
+ * // ```
9839
+ *
9840
+ * const {google} = require('googleapis');
9841
+ * const dataform = google.dataform('v1beta1');
9842
+ *
9843
+ * async function main() {
9844
+ * const auth = new google.auth.GoogleAuth({
9845
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
9846
+ * scopes: [
9847
+ * 'https://www.googleapis.com/auth/bigquery',
9848
+ * 'https://www.googleapis.com/auth/cloud-platform',
9849
+ * ],
9850
+ * });
9851
+ *
9852
+ * // Acquire an auth client, and bind it to all future calls
9853
+ * const authClient = await auth.getClient();
9854
+ * google.options({auth: authClient});
9855
+ *
9856
+ * // Do the magic
9857
+ * const res =
9858
+ * await dataform.projects.locations.repositories.workspaces.makeDirectory({
9859
+ * // Required. The workspace's name.
9860
+ * workspace:
9861
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
9862
+ *
9863
+ * // Request body metadata
9864
+ * requestBody: {
9865
+ * // request body parameters
9866
+ * // {
9867
+ * // "path": "my_path"
9868
+ * // }
9869
+ * },
9870
+ * });
9871
+ * console.log(res.data);
9872
+ *
9873
+ * // Example response
9874
+ * // {}
9875
+ * }
9876
+ *
9877
+ * main().catch(e => {
9878
+ * console.error(e);
9879
+ * throw e;
9880
+ * });
9881
+ *
9882
+ * ```
6941
9883
  *
6942
9884
  * @param params - Parameters for request
6943
9885
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -7034,6 +9976,64 @@ export namespace dataform_v1beta1 {
7034
9976
 
7035
9977
  /**
7036
9978
  * Moves a directory (inside a Workspace), and all of its contents, to a new location.
9979
+ * @example
9980
+ * ```js
9981
+ * // Before running the sample:
9982
+ * // - Enable the API at:
9983
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
9984
+ * // - Login into gcloud by running:
9985
+ * // ```sh
9986
+ * // $ gcloud auth application-default login
9987
+ * // ```
9988
+ * // - Install the npm module by running:
9989
+ * // ```sh
9990
+ * // $ npm install googleapis
9991
+ * // ```
9992
+ *
9993
+ * const {google} = require('googleapis');
9994
+ * const dataform = google.dataform('v1beta1');
9995
+ *
9996
+ * async function main() {
9997
+ * const auth = new google.auth.GoogleAuth({
9998
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
9999
+ * scopes: [
10000
+ * 'https://www.googleapis.com/auth/bigquery',
10001
+ * 'https://www.googleapis.com/auth/cloud-platform',
10002
+ * ],
10003
+ * });
10004
+ *
10005
+ * // Acquire an auth client, and bind it to all future calls
10006
+ * const authClient = await auth.getClient();
10007
+ * google.options({auth: authClient});
10008
+ *
10009
+ * // Do the magic
10010
+ * const res =
10011
+ * await dataform.projects.locations.repositories.workspaces.moveDirectory({
10012
+ * // Required. The workspace's name.
10013
+ * workspace:
10014
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
10015
+ *
10016
+ * // Request body metadata
10017
+ * requestBody: {
10018
+ * // request body parameters
10019
+ * // {
10020
+ * // "newPath": "my_newPath",
10021
+ * // "path": "my_path"
10022
+ * // }
10023
+ * },
10024
+ * });
10025
+ * console.log(res.data);
10026
+ *
10027
+ * // Example response
10028
+ * // {}
10029
+ * }
10030
+ *
10031
+ * main().catch(e => {
10032
+ * console.error(e);
10033
+ * throw e;
10034
+ * });
10035
+ *
10036
+ * ```
7037
10037
  *
7038
10038
  * @param params - Parameters for request
7039
10039
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -7130,6 +10130,64 @@ export namespace dataform_v1beta1 {
7130
10130
 
7131
10131
  /**
7132
10132
  * Moves a file (inside a Workspace) to a new location.
10133
+ * @example
10134
+ * ```js
10135
+ * // Before running the sample:
10136
+ * // - Enable the API at:
10137
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
10138
+ * // - Login into gcloud by running:
10139
+ * // ```sh
10140
+ * // $ gcloud auth application-default login
10141
+ * // ```
10142
+ * // - Install the npm module by running:
10143
+ * // ```sh
10144
+ * // $ npm install googleapis
10145
+ * // ```
10146
+ *
10147
+ * const {google} = require('googleapis');
10148
+ * const dataform = google.dataform('v1beta1');
10149
+ *
10150
+ * async function main() {
10151
+ * const auth = new google.auth.GoogleAuth({
10152
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
10153
+ * scopes: [
10154
+ * 'https://www.googleapis.com/auth/bigquery',
10155
+ * 'https://www.googleapis.com/auth/cloud-platform',
10156
+ * ],
10157
+ * });
10158
+ *
10159
+ * // Acquire an auth client, and bind it to all future calls
10160
+ * const authClient = await auth.getClient();
10161
+ * google.options({auth: authClient});
10162
+ *
10163
+ * // Do the magic
10164
+ * const res =
10165
+ * await dataform.projects.locations.repositories.workspaces.moveFile({
10166
+ * // Required. The workspace's name.
10167
+ * workspace:
10168
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
10169
+ *
10170
+ * // Request body metadata
10171
+ * requestBody: {
10172
+ * // request body parameters
10173
+ * // {
10174
+ * // "newPath": "my_newPath",
10175
+ * // "path": "my_path"
10176
+ * // }
10177
+ * },
10178
+ * });
10179
+ * console.log(res.data);
10180
+ *
10181
+ * // Example response
10182
+ * // {}
10183
+ * }
10184
+ *
10185
+ * main().catch(e => {
10186
+ * console.error(e);
10187
+ * throw e;
10188
+ * });
10189
+ *
10190
+ * ```
7133
10191
  *
7134
10192
  * @param params - Parameters for request
7135
10193
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -7222,6 +10280,62 @@ export namespace dataform_v1beta1 {
7222
10280
 
7223
10281
  /**
7224
10282
  * Pulls Git commits from the Repository's remote into a Workspace.
10283
+ * @example
10284
+ * ```js
10285
+ * // Before running the sample:
10286
+ * // - Enable the API at:
10287
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
10288
+ * // - Login into gcloud by running:
10289
+ * // ```sh
10290
+ * // $ gcloud auth application-default login
10291
+ * // ```
10292
+ * // - Install the npm module by running:
10293
+ * // ```sh
10294
+ * // $ npm install googleapis
10295
+ * // ```
10296
+ *
10297
+ * const {google} = require('googleapis');
10298
+ * const dataform = google.dataform('v1beta1');
10299
+ *
10300
+ * async function main() {
10301
+ * const auth = new google.auth.GoogleAuth({
10302
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
10303
+ * scopes: [
10304
+ * 'https://www.googleapis.com/auth/bigquery',
10305
+ * 'https://www.googleapis.com/auth/cloud-platform',
10306
+ * ],
10307
+ * });
10308
+ *
10309
+ * // Acquire an auth client, and bind it to all future calls
10310
+ * const authClient = await auth.getClient();
10311
+ * google.options({auth: authClient});
10312
+ *
10313
+ * // Do the magic
10314
+ * const res = await dataform.projects.locations.repositories.workspaces.pull({
10315
+ * // Required. The workspace's name.
10316
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
10317
+ *
10318
+ * // Request body metadata
10319
+ * requestBody: {
10320
+ * // request body parameters
10321
+ * // {
10322
+ * // "author": {},
10323
+ * // "remoteBranch": "my_remoteBranch"
10324
+ * // }
10325
+ * },
10326
+ * });
10327
+ * console.log(res.data);
10328
+ *
10329
+ * // Example response
10330
+ * // {}
10331
+ * }
10332
+ *
10333
+ * main().catch(e => {
10334
+ * console.error(e);
10335
+ * throw e;
10336
+ * });
10337
+ *
10338
+ * ```
7225
10339
  *
7226
10340
  * @param params - Parameters for request
7227
10341
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -7316,6 +10430,61 @@ export namespace dataform_v1beta1 {
7316
10430
 
7317
10431
  /**
7318
10432
  * Pushes Git commits from a Workspace to the Repository's remote.
10433
+ * @example
10434
+ * ```js
10435
+ * // Before running the sample:
10436
+ * // - Enable the API at:
10437
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
10438
+ * // - Login into gcloud by running:
10439
+ * // ```sh
10440
+ * // $ gcloud auth application-default login
10441
+ * // ```
10442
+ * // - Install the npm module by running:
10443
+ * // ```sh
10444
+ * // $ npm install googleapis
10445
+ * // ```
10446
+ *
10447
+ * const {google} = require('googleapis');
10448
+ * const dataform = google.dataform('v1beta1');
10449
+ *
10450
+ * async function main() {
10451
+ * const auth = new google.auth.GoogleAuth({
10452
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
10453
+ * scopes: [
10454
+ * 'https://www.googleapis.com/auth/bigquery',
10455
+ * 'https://www.googleapis.com/auth/cloud-platform',
10456
+ * ],
10457
+ * });
10458
+ *
10459
+ * // Acquire an auth client, and bind it to all future calls
10460
+ * const authClient = await auth.getClient();
10461
+ * google.options({auth: authClient});
10462
+ *
10463
+ * // Do the magic
10464
+ * const res = await dataform.projects.locations.repositories.workspaces.push({
10465
+ * // Required. The workspace's name.
10466
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
10467
+ *
10468
+ * // Request body metadata
10469
+ * requestBody: {
10470
+ * // request body parameters
10471
+ * // {
10472
+ * // "remoteBranch": "my_remoteBranch"
10473
+ * // }
10474
+ * },
10475
+ * });
10476
+ * console.log(res.data);
10477
+ *
10478
+ * // Example response
10479
+ * // {}
10480
+ * }
10481
+ *
10482
+ * main().catch(e => {
10483
+ * console.error(e);
10484
+ * throw e;
10485
+ * });
10486
+ *
10487
+ * ```
7319
10488
  *
7320
10489
  * @param params - Parameters for request
7321
10490
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -7410,6 +10579,66 @@ export namespace dataform_v1beta1 {
7410
10579
 
7411
10580
  /**
7412
10581
  * Returns the contents of a given Workspace directory.
10582
+ * @example
10583
+ * ```js
10584
+ * // Before running the sample:
10585
+ * // - Enable the API at:
10586
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
10587
+ * // - Login into gcloud by running:
10588
+ * // ```sh
10589
+ * // $ gcloud auth application-default login
10590
+ * // ```
10591
+ * // - Install the npm module by running:
10592
+ * // ```sh
10593
+ * // $ npm install googleapis
10594
+ * // ```
10595
+ *
10596
+ * const {google} = require('googleapis');
10597
+ * const dataform = google.dataform('v1beta1');
10598
+ *
10599
+ * async function main() {
10600
+ * const auth = new google.auth.GoogleAuth({
10601
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
10602
+ * scopes: [
10603
+ * 'https://www.googleapis.com/auth/bigquery',
10604
+ * 'https://www.googleapis.com/auth/cloud-platform',
10605
+ * ],
10606
+ * });
10607
+ *
10608
+ * // Acquire an auth client, and bind it to all future calls
10609
+ * const authClient = await auth.getClient();
10610
+ * google.options({auth: authClient});
10611
+ *
10612
+ * // Do the magic
10613
+ * const res =
10614
+ * await dataform.projects.locations.repositories.workspaces.queryDirectoryContents(
10615
+ * {
10616
+ * // Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
10617
+ * pageSize: 'placeholder-value',
10618
+ * // Optional. Page token received from a previous `QueryDirectoryContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryDirectoryContents`, with the exception of `page_size`, must match the call that provided the page token.
10619
+ * pageToken: 'placeholder-value',
10620
+ * // Optional. The directory's full path including directory name, relative to the workspace root. If left unset, the workspace root is used.
10621
+ * path: 'placeholder-value',
10622
+ * // Required. The workspace's name.
10623
+ * workspace:
10624
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
10625
+ * },
10626
+ * );
10627
+ * console.log(res.data);
10628
+ *
10629
+ * // Example response
10630
+ * // {
10631
+ * // "directoryEntries": [],
10632
+ * // "nextPageToken": "my_nextPageToken"
10633
+ * // }
10634
+ * }
10635
+ *
10636
+ * main().catch(e => {
10637
+ * console.error(e);
10638
+ * throw e;
10639
+ * });
10640
+ *
10641
+ * ```
7413
10642
  *
7414
10643
  * @param params - Parameters for request
7415
10644
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -7507,6 +10736,61 @@ export namespace dataform_v1beta1 {
7507
10736
 
7508
10737
  /**
7509
10738
  * Returns the contents of a file (inside a Workspace).
10739
+ * @example
10740
+ * ```js
10741
+ * // Before running the sample:
10742
+ * // - Enable the API at:
10743
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
10744
+ * // - Login into gcloud by running:
10745
+ * // ```sh
10746
+ * // $ gcloud auth application-default login
10747
+ * // ```
10748
+ * // - Install the npm module by running:
10749
+ * // ```sh
10750
+ * // $ npm install googleapis
10751
+ * // ```
10752
+ *
10753
+ * const {google} = require('googleapis');
10754
+ * const dataform = google.dataform('v1beta1');
10755
+ *
10756
+ * async function main() {
10757
+ * const auth = new google.auth.GoogleAuth({
10758
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
10759
+ * scopes: [
10760
+ * 'https://www.googleapis.com/auth/bigquery',
10761
+ * 'https://www.googleapis.com/auth/cloud-platform',
10762
+ * ],
10763
+ * });
10764
+ *
10765
+ * // Acquire an auth client, and bind it to all future calls
10766
+ * const authClient = await auth.getClient();
10767
+ * google.options({auth: authClient});
10768
+ *
10769
+ * // Do the magic
10770
+ * const res =
10771
+ * await dataform.projects.locations.repositories.workspaces.readFile({
10772
+ * // Required. The file's full path including filename, relative to the workspace root.
10773
+ * path: 'placeholder-value',
10774
+ * // Optional. The Git revision of the file to return. If left empty, the current contents of `path` will be returned.
10775
+ * revision: 'placeholder-value',
10776
+ * // Required. The workspace's name.
10777
+ * workspace:
10778
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
10779
+ * });
10780
+ * console.log(res.data);
10781
+ *
10782
+ * // Example response
10783
+ * // {
10784
+ * // "fileContents": "my_fileContents"
10785
+ * // }
10786
+ * }
10787
+ *
10788
+ * main().catch(e => {
10789
+ * console.error(e);
10790
+ * throw e;
10791
+ * });
10792
+ *
10793
+ * ```
7510
10794
  *
7511
10795
  * @param params - Parameters for request
7512
10796
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -7599,6 +10883,63 @@ export namespace dataform_v1beta1 {
7599
10883
 
7600
10884
  /**
7601
10885
  * Deletes a directory (inside a Workspace) and all of its contents.
10886
+ * @example
10887
+ * ```js
10888
+ * // Before running the sample:
10889
+ * // - Enable the API at:
10890
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
10891
+ * // - Login into gcloud by running:
10892
+ * // ```sh
10893
+ * // $ gcloud auth application-default login
10894
+ * // ```
10895
+ * // - Install the npm module by running:
10896
+ * // ```sh
10897
+ * // $ npm install googleapis
10898
+ * // ```
10899
+ *
10900
+ * const {google} = require('googleapis');
10901
+ * const dataform = google.dataform('v1beta1');
10902
+ *
10903
+ * async function main() {
10904
+ * const auth = new google.auth.GoogleAuth({
10905
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
10906
+ * scopes: [
10907
+ * 'https://www.googleapis.com/auth/bigquery',
10908
+ * 'https://www.googleapis.com/auth/cloud-platform',
10909
+ * ],
10910
+ * });
10911
+ *
10912
+ * // Acquire an auth client, and bind it to all future calls
10913
+ * const authClient = await auth.getClient();
10914
+ * google.options({auth: authClient});
10915
+ *
10916
+ * // Do the magic
10917
+ * const res =
10918
+ * await dataform.projects.locations.repositories.workspaces.removeDirectory({
10919
+ * // Required. The workspace's name.
10920
+ * workspace:
10921
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
10922
+ *
10923
+ * // Request body metadata
10924
+ * requestBody: {
10925
+ * // request body parameters
10926
+ * // {
10927
+ * // "path": "my_path"
10928
+ * // }
10929
+ * },
10930
+ * });
10931
+ * console.log(res.data);
10932
+ *
10933
+ * // Example response
10934
+ * // {}
10935
+ * }
10936
+ *
10937
+ * main().catch(e => {
10938
+ * console.error(e);
10939
+ * throw e;
10940
+ * });
10941
+ *
10942
+ * ```
7602
10943
  *
7603
10944
  * @param params - Parameters for request
7604
10945
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -7695,6 +11036,63 @@ export namespace dataform_v1beta1 {
7695
11036
 
7696
11037
  /**
7697
11038
  * Deletes a file (inside a Workspace).
11039
+ * @example
11040
+ * ```js
11041
+ * // Before running the sample:
11042
+ * // - Enable the API at:
11043
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
11044
+ * // - Login into gcloud by running:
11045
+ * // ```sh
11046
+ * // $ gcloud auth application-default login
11047
+ * // ```
11048
+ * // - Install the npm module by running:
11049
+ * // ```sh
11050
+ * // $ npm install googleapis
11051
+ * // ```
11052
+ *
11053
+ * const {google} = require('googleapis');
11054
+ * const dataform = google.dataform('v1beta1');
11055
+ *
11056
+ * async function main() {
11057
+ * const auth = new google.auth.GoogleAuth({
11058
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
11059
+ * scopes: [
11060
+ * 'https://www.googleapis.com/auth/bigquery',
11061
+ * 'https://www.googleapis.com/auth/cloud-platform',
11062
+ * ],
11063
+ * });
11064
+ *
11065
+ * // Acquire an auth client, and bind it to all future calls
11066
+ * const authClient = await auth.getClient();
11067
+ * google.options({auth: authClient});
11068
+ *
11069
+ * // Do the magic
11070
+ * const res =
11071
+ * await dataform.projects.locations.repositories.workspaces.removeFile({
11072
+ * // Required. The workspace's name.
11073
+ * workspace:
11074
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
11075
+ *
11076
+ * // Request body metadata
11077
+ * requestBody: {
11078
+ * // request body parameters
11079
+ * // {
11080
+ * // "path": "my_path"
11081
+ * // }
11082
+ * },
11083
+ * });
11084
+ * console.log(res.data);
11085
+ *
11086
+ * // Example response
11087
+ * // {}
11088
+ * }
11089
+ *
11090
+ * main().catch(e => {
11091
+ * console.error(e);
11092
+ * throw e;
11093
+ * });
11094
+ *
11095
+ * ```
7698
11096
  *
7699
11097
  * @param params - Parameters for request
7700
11098
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -7787,6 +11185,62 @@ export namespace dataform_v1beta1 {
7787
11185
 
7788
11186
  /**
7789
11187
  * Performs a Git reset for uncommitted files in a Workspace.
11188
+ * @example
11189
+ * ```js
11190
+ * // Before running the sample:
11191
+ * // - Enable the API at:
11192
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
11193
+ * // - Login into gcloud by running:
11194
+ * // ```sh
11195
+ * // $ gcloud auth application-default login
11196
+ * // ```
11197
+ * // - Install the npm module by running:
11198
+ * // ```sh
11199
+ * // $ npm install googleapis
11200
+ * // ```
11201
+ *
11202
+ * const {google} = require('googleapis');
11203
+ * const dataform = google.dataform('v1beta1');
11204
+ *
11205
+ * async function main() {
11206
+ * const auth = new google.auth.GoogleAuth({
11207
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
11208
+ * scopes: [
11209
+ * 'https://www.googleapis.com/auth/bigquery',
11210
+ * 'https://www.googleapis.com/auth/cloud-platform',
11211
+ * ],
11212
+ * });
11213
+ *
11214
+ * // Acquire an auth client, and bind it to all future calls
11215
+ * const authClient = await auth.getClient();
11216
+ * google.options({auth: authClient});
11217
+ *
11218
+ * // Do the magic
11219
+ * const res = await dataform.projects.locations.repositories.workspaces.reset({
11220
+ * // Required. The workspace's name.
11221
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
11222
+ *
11223
+ * // Request body metadata
11224
+ * requestBody: {
11225
+ * // request body parameters
11226
+ * // {
11227
+ * // "clean": false,
11228
+ * // "paths": []
11229
+ * // }
11230
+ * },
11231
+ * });
11232
+ * console.log(res.data);
11233
+ *
11234
+ * // Example response
11235
+ * // {}
11236
+ * }
11237
+ *
11238
+ * main().catch(e => {
11239
+ * console.error(e);
11240
+ * throw e;
11241
+ * });
11242
+ *
11243
+ * ```
7790
11244
  *
7791
11245
  * @param params - Parameters for request
7792
11246
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -7885,6 +11339,64 @@ export namespace dataform_v1beta1 {
7885
11339
 
7886
11340
  /**
7887
11341
  * Finds the contents of a given Workspace directory by filter.
11342
+ * @example
11343
+ * ```js
11344
+ * // Before running the sample:
11345
+ * // - Enable the API at:
11346
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
11347
+ * // - Login into gcloud by running:
11348
+ * // ```sh
11349
+ * // $ gcloud auth application-default login
11350
+ * // ```
11351
+ * // - Install the npm module by running:
11352
+ * // ```sh
11353
+ * // $ npm install googleapis
11354
+ * // ```
11355
+ *
11356
+ * const {google} = require('googleapis');
11357
+ * const dataform = google.dataform('v1beta1');
11358
+ *
11359
+ * async function main() {
11360
+ * const auth = new google.auth.GoogleAuth({
11361
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
11362
+ * scopes: [
11363
+ * 'https://www.googleapis.com/auth/bigquery',
11364
+ * 'https://www.googleapis.com/auth/cloud-platform',
11365
+ * ],
11366
+ * });
11367
+ *
11368
+ * // Acquire an auth client, and bind it to all future calls
11369
+ * const authClient = await auth.getClient();
11370
+ * google.options({auth: authClient});
11371
+ *
11372
+ * // Do the magic
11373
+ * const res =
11374
+ * await dataform.projects.locations.repositories.workspaces.searchFiles({
11375
+ * // Optional. Optional filter for the returned list in filtering format. Filtering is only currently supported on the `path` field. See https://google.aip.dev/160 for details.
11376
+ * filter: 'placeholder-value',
11377
+ * // Optional. Maximum number of search results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
11378
+ * pageSize: 'placeholder-value',
11379
+ * // Optional. Page token received from a previous `SearchFilesRequest` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchFilesRequest`, with the exception of `page_size`, must match the call that provided the page token.
11380
+ * pageToken: 'placeholder-value',
11381
+ * // Required. The workspace's name.
11382
+ * workspace:
11383
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
11384
+ * });
11385
+ * console.log(res.data);
11386
+ *
11387
+ * // Example response
11388
+ * // {
11389
+ * // "nextPageToken": "my_nextPageToken",
11390
+ * // "searchResults": []
11391
+ * // }
11392
+ * }
11393
+ *
11394
+ * main().catch(e => {
11395
+ * console.error(e);
11396
+ * throw e;
11397
+ * });
11398
+ *
11399
+ * ```
7888
11400
  *
7889
11401
  * @param params - Parameters for request
7890
11402
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -7979,6 +11491,67 @@ export namespace dataform_v1beta1 {
7979
11491
 
7980
11492
  /**
7981
11493
  * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
11494
+ * @example
11495
+ * ```js
11496
+ * // Before running the sample:
11497
+ * // - Enable the API at:
11498
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
11499
+ * // - Login into gcloud by running:
11500
+ * // ```sh
11501
+ * // $ gcloud auth application-default login
11502
+ * // ```
11503
+ * // - Install the npm module by running:
11504
+ * // ```sh
11505
+ * // $ npm install googleapis
11506
+ * // ```
11507
+ *
11508
+ * const {google} = require('googleapis');
11509
+ * const dataform = google.dataform('v1beta1');
11510
+ *
11511
+ * async function main() {
11512
+ * const auth = new google.auth.GoogleAuth({
11513
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
11514
+ * scopes: [
11515
+ * 'https://www.googleapis.com/auth/bigquery',
11516
+ * 'https://www.googleapis.com/auth/cloud-platform',
11517
+ * ],
11518
+ * });
11519
+ *
11520
+ * // Acquire an auth client, and bind it to all future calls
11521
+ * const authClient = await auth.getClient();
11522
+ * google.options({auth: authClient});
11523
+ *
11524
+ * // Do the magic
11525
+ * const res =
11526
+ * await dataform.projects.locations.repositories.workspaces.setIamPolicy({
11527
+ * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
11528
+ * resource:
11529
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
11530
+ *
11531
+ * // Request body metadata
11532
+ * requestBody: {
11533
+ * // request body parameters
11534
+ * // {
11535
+ * // "policy": {}
11536
+ * // }
11537
+ * },
11538
+ * });
11539
+ * console.log(res.data);
11540
+ *
11541
+ * // Example response
11542
+ * // {
11543
+ * // "bindings": [],
11544
+ * // "etag": "my_etag",
11545
+ * // "version": 0
11546
+ * // }
11547
+ * }
11548
+ *
11549
+ * main().catch(e => {
11550
+ * console.error(e);
11551
+ * throw e;
11552
+ * });
11553
+ *
11554
+ * ```
7982
11555
  *
7983
11556
  * @param params - Parameters for request
7984
11557
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -8071,6 +11644,67 @@ export namespace dataform_v1beta1 {
8071
11644
 
8072
11645
  /**
8073
11646
  * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
11647
+ * @example
11648
+ * ```js
11649
+ * // Before running the sample:
11650
+ * // - Enable the API at:
11651
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
11652
+ * // - Login into gcloud by running:
11653
+ * // ```sh
11654
+ * // $ gcloud auth application-default login
11655
+ * // ```
11656
+ * // - Install the npm module by running:
11657
+ * // ```sh
11658
+ * // $ npm install googleapis
11659
+ * // ```
11660
+ *
11661
+ * const {google} = require('googleapis');
11662
+ * const dataform = google.dataform('v1beta1');
11663
+ *
11664
+ * async function main() {
11665
+ * const auth = new google.auth.GoogleAuth({
11666
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
11667
+ * scopes: [
11668
+ * 'https://www.googleapis.com/auth/bigquery',
11669
+ * 'https://www.googleapis.com/auth/cloud-platform',
11670
+ * ],
11671
+ * });
11672
+ *
11673
+ * // Acquire an auth client, and bind it to all future calls
11674
+ * const authClient = await auth.getClient();
11675
+ * google.options({auth: authClient});
11676
+ *
11677
+ * // Do the magic
11678
+ * const res =
11679
+ * await dataform.projects.locations.repositories.workspaces.testIamPermissions(
11680
+ * {
11681
+ * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
11682
+ * resource:
11683
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
11684
+ *
11685
+ * // Request body metadata
11686
+ * requestBody: {
11687
+ * // request body parameters
11688
+ * // {
11689
+ * // "permissions": []
11690
+ * // }
11691
+ * },
11692
+ * },
11693
+ * );
11694
+ * console.log(res.data);
11695
+ *
11696
+ * // Example response
11697
+ * // {
11698
+ * // "permissions": []
11699
+ * // }
11700
+ * }
11701
+ *
11702
+ * main().catch(e => {
11703
+ * console.error(e);
11704
+ * throw e;
11705
+ * });
11706
+ *
11707
+ * ```
8074
11708
  *
8075
11709
  * @param params - Parameters for request
8076
11710
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -8167,6 +11801,64 @@ export namespace dataform_v1beta1 {
8167
11801
 
8168
11802
  /**
8169
11803
  * Writes to a file (inside a Workspace).
11804
+ * @example
11805
+ * ```js
11806
+ * // Before running the sample:
11807
+ * // - Enable the API at:
11808
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
11809
+ * // - Login into gcloud by running:
11810
+ * // ```sh
11811
+ * // $ gcloud auth application-default login
11812
+ * // ```
11813
+ * // - Install the npm module by running:
11814
+ * // ```sh
11815
+ * // $ npm install googleapis
11816
+ * // ```
11817
+ *
11818
+ * const {google} = require('googleapis');
11819
+ * const dataform = google.dataform('v1beta1');
11820
+ *
11821
+ * async function main() {
11822
+ * const auth = new google.auth.GoogleAuth({
11823
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
11824
+ * scopes: [
11825
+ * 'https://www.googleapis.com/auth/bigquery',
11826
+ * 'https://www.googleapis.com/auth/cloud-platform',
11827
+ * ],
11828
+ * });
11829
+ *
11830
+ * // Acquire an auth client, and bind it to all future calls
11831
+ * const authClient = await auth.getClient();
11832
+ * google.options({auth: authClient});
11833
+ *
11834
+ * // Do the magic
11835
+ * const res =
11836
+ * await dataform.projects.locations.repositories.workspaces.writeFile({
11837
+ * // Required. The workspace's name.
11838
+ * workspace:
11839
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
11840
+ *
11841
+ * // Request body metadata
11842
+ * requestBody: {
11843
+ * // request body parameters
11844
+ * // {
11845
+ * // "contents": "my_contents",
11846
+ * // "path": "my_path"
11847
+ * // }
11848
+ * },
11849
+ * });
11850
+ * console.log(res.data);
11851
+ *
11852
+ * // Example response
11853
+ * // {}
11854
+ * }
11855
+ *
11856
+ * main().catch(e => {
11857
+ * console.error(e);
11858
+ * throw e;
11859
+ * });
11860
+ *
11861
+ * ```
8170
11862
  *
8171
11863
  * @param params - Parameters for request
8172
11864
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.