@googleapis/dataform 8.0.1 → 9.0.1

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
@@ -1110,6 +1110,10 @@ export namespace dataform_v1beta1 {
1110
1110
  * Configures various aspects of Dataform notebook runtime.
1111
1111
  */
1112
1112
  export interface Schema$NotebookRuntimeOptions {
1113
+ /**
1114
+ * 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.
1115
+ */
1116
+ aiPlatformNotebookRuntimeTemplate?: string | null;
1113
1117
  /**
1114
1118
  * Optional. The Google Cloud Storage location to upload the result to. Format: `gs://bucket-name`.
1115
1119
  */
@@ -1890,6 +1894,59 @@ export namespace dataform_v1beta1 {
1890
1894
 
1891
1895
  /**
1892
1896
  * Gets information about a location.
1897
+ * @example
1898
+ * ```js
1899
+ * // Before running the sample:
1900
+ * // - Enable the API at:
1901
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
1902
+ * // - Login into gcloud by running:
1903
+ * // ```sh
1904
+ * // $ gcloud auth application-default login
1905
+ * // ```
1906
+ * // - Install the npm module by running:
1907
+ * // ```sh
1908
+ * // $ npm install googleapis
1909
+ * // ```
1910
+ *
1911
+ * const {google} = require('googleapis');
1912
+ * const dataform = google.dataform('v1beta1');
1913
+ *
1914
+ * async function main() {
1915
+ * const auth = new google.auth.GoogleAuth({
1916
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1917
+ * scopes: [
1918
+ * 'https://www.googleapis.com/auth/bigquery',
1919
+ * 'https://www.googleapis.com/auth/cloud-platform',
1920
+ * ],
1921
+ * });
1922
+ *
1923
+ * // Acquire an auth client, and bind it to all future calls
1924
+ * const authClient = await auth.getClient();
1925
+ * google.options({auth: authClient});
1926
+ *
1927
+ * // Do the magic
1928
+ * const res = await dataform.projects.locations.get({
1929
+ * // Resource name for the location.
1930
+ * name: 'projects/my-project/locations/my-location',
1931
+ * });
1932
+ * console.log(res.data);
1933
+ *
1934
+ * // Example response
1935
+ * // {
1936
+ * // "displayName": "my_displayName",
1937
+ * // "labels": {},
1938
+ * // "locationId": "my_locationId",
1939
+ * // "metadata": {},
1940
+ * // "name": "my_name"
1941
+ * // }
1942
+ * }
1943
+ *
1944
+ * main().catch(e => {
1945
+ * console.error(e);
1946
+ * throw e;
1947
+ * });
1948
+ *
1949
+ * ```
1893
1950
  *
1894
1951
  * @param params - Parameters for request
1895
1952
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1978,6 +2035,56 @@ export namespace dataform_v1beta1 {
1978
2035
 
1979
2036
  /**
1980
2037
  * Get default config for a given project and location.
2038
+ * @example
2039
+ * ```js
2040
+ * // Before running the sample:
2041
+ * // - Enable the API at:
2042
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
2043
+ * // - Login into gcloud by running:
2044
+ * // ```sh
2045
+ * // $ gcloud auth application-default login
2046
+ * // ```
2047
+ * // - Install the npm module by running:
2048
+ * // ```sh
2049
+ * // $ npm install googleapis
2050
+ * // ```
2051
+ *
2052
+ * const {google} = require('googleapis');
2053
+ * const dataform = google.dataform('v1beta1');
2054
+ *
2055
+ * async function main() {
2056
+ * const auth = new google.auth.GoogleAuth({
2057
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2058
+ * scopes: [
2059
+ * 'https://www.googleapis.com/auth/bigquery',
2060
+ * 'https://www.googleapis.com/auth/cloud-platform',
2061
+ * ],
2062
+ * });
2063
+ *
2064
+ * // Acquire an auth client, and bind it to all future calls
2065
+ * const authClient = await auth.getClient();
2066
+ * google.options({auth: authClient});
2067
+ *
2068
+ * // Do the magic
2069
+ * const res = await dataform.projects.locations.getConfig({
2070
+ * // Required. The config name.
2071
+ * name: 'projects/my-project/locations/my-location/config',
2072
+ * });
2073
+ * console.log(res.data);
2074
+ *
2075
+ * // Example response
2076
+ * // {
2077
+ * // "defaultKmsKeyName": "my_defaultKmsKeyName",
2078
+ * // "name": "my_name"
2079
+ * // }
2080
+ * }
2081
+ *
2082
+ * main().catch(e => {
2083
+ * console.error(e);
2084
+ * throw e;
2085
+ * });
2086
+ *
2087
+ * ```
1981
2088
  *
1982
2089
  * @param params - Parameters for request
1983
2090
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2066,6 +2173,64 @@ export namespace dataform_v1beta1 {
2066
2173
 
2067
2174
  /**
2068
2175
  * Lists information about the supported locations for this service.
2176
+ * @example
2177
+ * ```js
2178
+ * // Before running the sample:
2179
+ * // - Enable the API at:
2180
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
2181
+ * // - Login into gcloud by running:
2182
+ * // ```sh
2183
+ * // $ gcloud auth application-default login
2184
+ * // ```
2185
+ * // - Install the npm module by running:
2186
+ * // ```sh
2187
+ * // $ npm install googleapis
2188
+ * // ```
2189
+ *
2190
+ * const {google} = require('googleapis');
2191
+ * const dataform = google.dataform('v1beta1');
2192
+ *
2193
+ * async function main() {
2194
+ * const auth = new google.auth.GoogleAuth({
2195
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2196
+ * scopes: [
2197
+ * 'https://www.googleapis.com/auth/bigquery',
2198
+ * 'https://www.googleapis.com/auth/cloud-platform',
2199
+ * ],
2200
+ * });
2201
+ *
2202
+ * // Acquire an auth client, and bind it to all future calls
2203
+ * const authClient = await auth.getClient();
2204
+ * google.options({auth: authClient});
2205
+ *
2206
+ * // Do the magic
2207
+ * const res = await dataform.projects.locations.list({
2208
+ * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.
2209
+ * extraLocationTypes: 'placeholder-value',
2210
+ * // 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).
2211
+ * filter: 'placeholder-value',
2212
+ * // The resource that owns the locations collection, if applicable.
2213
+ * name: 'projects/my-project',
2214
+ * // The maximum number of results to return. If not set, the service selects a default.
2215
+ * pageSize: 'placeholder-value',
2216
+ * // A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
2217
+ * pageToken: 'placeholder-value',
2218
+ * });
2219
+ * console.log(res.data);
2220
+ *
2221
+ * // Example response
2222
+ * // {
2223
+ * // "locations": [],
2224
+ * // "nextPageToken": "my_nextPageToken"
2225
+ * // }
2226
+ * }
2227
+ *
2228
+ * main().catch(e => {
2229
+ * console.error(e);
2230
+ * throw e;
2231
+ * });
2232
+ *
2233
+ * ```
2069
2234
  *
2070
2235
  * @param params - Parameters for request
2071
2236
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2159,6 +2324,67 @@ export namespace dataform_v1beta1 {
2159
2324
 
2160
2325
  /**
2161
2326
  * 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.*
2327
+ * @example
2328
+ * ```js
2329
+ * // Before running the sample:
2330
+ * // - Enable the API at:
2331
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
2332
+ * // - Login into gcloud by running:
2333
+ * // ```sh
2334
+ * // $ gcloud auth application-default login
2335
+ * // ```
2336
+ * // - Install the npm module by running:
2337
+ * // ```sh
2338
+ * // $ npm install googleapis
2339
+ * // ```
2340
+ *
2341
+ * const {google} = require('googleapis');
2342
+ * const dataform = google.dataform('v1beta1');
2343
+ *
2344
+ * async function main() {
2345
+ * const auth = new google.auth.GoogleAuth({
2346
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2347
+ * scopes: [
2348
+ * 'https://www.googleapis.com/auth/bigquery',
2349
+ * 'https://www.googleapis.com/auth/cloud-platform',
2350
+ * ],
2351
+ * });
2352
+ *
2353
+ * // Acquire an auth client, and bind it to all future calls
2354
+ * const authClient = await auth.getClient();
2355
+ * google.options({auth: authClient});
2356
+ *
2357
+ * // Do the magic
2358
+ * const res = await dataform.projects.locations.updateConfig({
2359
+ * // Identifier. The config name.
2360
+ * name: 'projects/my-project/locations/my-location/config',
2361
+ * // Optional. Specifies the fields to be updated in the config.
2362
+ * updateMask: 'placeholder-value',
2363
+ *
2364
+ * // Request body metadata
2365
+ * requestBody: {
2366
+ * // request body parameters
2367
+ * // {
2368
+ * // "defaultKmsKeyName": "my_defaultKmsKeyName",
2369
+ * // "name": "my_name"
2370
+ * // }
2371
+ * },
2372
+ * });
2373
+ * console.log(res.data);
2374
+ *
2375
+ * // Example response
2376
+ * // {
2377
+ * // "defaultKmsKeyName": "my_defaultKmsKeyName",
2378
+ * // "name": "my_name"
2379
+ * // }
2380
+ * }
2381
+ *
2382
+ * main().catch(e => {
2383
+ * console.error(e);
2384
+ * throw e;
2385
+ * });
2386
+ *
2387
+ * ```
2162
2388
  *
2163
2389
  * @param params - Parameters for request
2164
2390
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2332,6 +2558,65 @@ export namespace dataform_v1beta1 {
2332
2558
 
2333
2559
  /**
2334
2560
  * Applies a Git commit to a Repository. The Repository must not have a value for `git_remote_settings.url`.
2561
+ * @example
2562
+ * ```js
2563
+ * // Before running the sample:
2564
+ * // - Enable the API at:
2565
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
2566
+ * // - Login into gcloud by running:
2567
+ * // ```sh
2568
+ * // $ gcloud auth application-default login
2569
+ * // ```
2570
+ * // - Install the npm module by running:
2571
+ * // ```sh
2572
+ * // $ npm install googleapis
2573
+ * // ```
2574
+ *
2575
+ * const {google} = require('googleapis');
2576
+ * const dataform = google.dataform('v1beta1');
2577
+ *
2578
+ * async function main() {
2579
+ * const auth = new google.auth.GoogleAuth({
2580
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2581
+ * scopes: [
2582
+ * 'https://www.googleapis.com/auth/bigquery',
2583
+ * 'https://www.googleapis.com/auth/cloud-platform',
2584
+ * ],
2585
+ * });
2586
+ *
2587
+ * // Acquire an auth client, and bind it to all future calls
2588
+ * const authClient = await auth.getClient();
2589
+ * google.options({auth: authClient});
2590
+ *
2591
+ * // Do the magic
2592
+ * const res = await dataform.projects.locations.repositories.commit({
2593
+ * // Required. The repository's name.
2594
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie',
2595
+ *
2596
+ * // Request body metadata
2597
+ * requestBody: {
2598
+ * // request body parameters
2599
+ * // {
2600
+ * // "commitMetadata": {},
2601
+ * // "fileOperations": {},
2602
+ * // "requiredHeadCommitSha": "my_requiredHeadCommitSha"
2603
+ * // }
2604
+ * },
2605
+ * });
2606
+ * console.log(res.data);
2607
+ *
2608
+ * // Example response
2609
+ * // {
2610
+ * // "commitSha": "my_commitSha"
2611
+ * // }
2612
+ * }
2613
+ *
2614
+ * main().catch(e => {
2615
+ * console.error(e);
2616
+ * throw e;
2617
+ * });
2618
+ *
2619
+ * ```
2335
2620
  *
2336
2621
  * @param params - Parameters for request
2337
2622
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2429,6 +2714,56 @@ export namespace dataform_v1beta1 {
2429
2714
 
2430
2715
  /**
2431
2716
  * Computes a Repository's Git access token status.
2717
+ * @example
2718
+ * ```js
2719
+ * // Before running the sample:
2720
+ * // - Enable the API at:
2721
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
2722
+ * // - Login into gcloud by running:
2723
+ * // ```sh
2724
+ * // $ gcloud auth application-default login
2725
+ * // ```
2726
+ * // - Install the npm module by running:
2727
+ * // ```sh
2728
+ * // $ npm install googleapis
2729
+ * // ```
2730
+ *
2731
+ * const {google} = require('googleapis');
2732
+ * const dataform = google.dataform('v1beta1');
2733
+ *
2734
+ * async function main() {
2735
+ * const auth = new google.auth.GoogleAuth({
2736
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2737
+ * scopes: [
2738
+ * 'https://www.googleapis.com/auth/bigquery',
2739
+ * 'https://www.googleapis.com/auth/cloud-platform',
2740
+ * ],
2741
+ * });
2742
+ *
2743
+ * // Acquire an auth client, and bind it to all future calls
2744
+ * const authClient = await auth.getClient();
2745
+ * google.options({auth: authClient});
2746
+ *
2747
+ * // Do the magic
2748
+ * const res =
2749
+ * await dataform.projects.locations.repositories.computeAccessTokenStatus({
2750
+ * // Required. The repository's name.
2751
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie',
2752
+ * });
2753
+ * console.log(res.data);
2754
+ *
2755
+ * // Example response
2756
+ * // {
2757
+ * // "tokenStatus": "my_tokenStatus"
2758
+ * // }
2759
+ * }
2760
+ *
2761
+ * main().catch(e => {
2762
+ * console.error(e);
2763
+ * throw e;
2764
+ * });
2765
+ *
2766
+ * ```
2432
2767
  *
2433
2768
  * @param params - Parameters for request
2434
2769
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2530,6 +2865,87 @@ export namespace dataform_v1beta1 {
2530
2865
 
2531
2866
  /**
2532
2867
  * Creates a new Repository in a given project and location.
2868
+ * @example
2869
+ * ```js
2870
+ * // Before running the sample:
2871
+ * // - Enable the API at:
2872
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
2873
+ * // - Login into gcloud by running:
2874
+ * // ```sh
2875
+ * // $ gcloud auth application-default login
2876
+ * // ```
2877
+ * // - Install the npm module by running:
2878
+ * // ```sh
2879
+ * // $ npm install googleapis
2880
+ * // ```
2881
+ *
2882
+ * const {google} = require('googleapis');
2883
+ * const dataform = google.dataform('v1beta1');
2884
+ *
2885
+ * async function main() {
2886
+ * const auth = new google.auth.GoogleAuth({
2887
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2888
+ * scopes: [
2889
+ * 'https://www.googleapis.com/auth/bigquery',
2890
+ * 'https://www.googleapis.com/auth/cloud-platform',
2891
+ * ],
2892
+ * });
2893
+ *
2894
+ * // Acquire an auth client, and bind it to all future calls
2895
+ * const authClient = await auth.getClient();
2896
+ * google.options({auth: authClient});
2897
+ *
2898
+ * // Do the magic
2899
+ * const res = await dataform.projects.locations.repositories.create({
2900
+ * // Required. The location in which to create the repository. Must be in the format `projects/x/locations/x`.
2901
+ * parent: 'projects/my-project/locations/my-location',
2902
+ * // Required. The ID to use for the repository, which will become the final component of the repository's resource name.
2903
+ * repositoryId: 'placeholder-value',
2904
+ *
2905
+ * // Request body metadata
2906
+ * requestBody: {
2907
+ * // request body parameters
2908
+ * // {
2909
+ * // "createTime": "my_createTime",
2910
+ * // "dataEncryptionState": {},
2911
+ * // "displayName": "my_displayName",
2912
+ * // "gitRemoteSettings": {},
2913
+ * // "internalMetadata": "my_internalMetadata",
2914
+ * // "kmsKeyName": "my_kmsKeyName",
2915
+ * // "labels": {},
2916
+ * // "name": "my_name",
2917
+ * // "npmrcEnvironmentVariablesSecretVersion": "my_npmrcEnvironmentVariablesSecretVersion",
2918
+ * // "serviceAccount": "my_serviceAccount",
2919
+ * // "setAuthenticatedUserAdmin": false,
2920
+ * // "workspaceCompilationOverrides": {}
2921
+ * // }
2922
+ * },
2923
+ * });
2924
+ * console.log(res.data);
2925
+ *
2926
+ * // Example response
2927
+ * // {
2928
+ * // "createTime": "my_createTime",
2929
+ * // "dataEncryptionState": {},
2930
+ * // "displayName": "my_displayName",
2931
+ * // "gitRemoteSettings": {},
2932
+ * // "internalMetadata": "my_internalMetadata",
2933
+ * // "kmsKeyName": "my_kmsKeyName",
2934
+ * // "labels": {},
2935
+ * // "name": "my_name",
2936
+ * // "npmrcEnvironmentVariablesSecretVersion": "my_npmrcEnvironmentVariablesSecretVersion",
2937
+ * // "serviceAccount": "my_serviceAccount",
2938
+ * // "setAuthenticatedUserAdmin": false,
2939
+ * // "workspaceCompilationOverrides": {}
2940
+ * // }
2941
+ * }
2942
+ *
2943
+ * main().catch(e => {
2944
+ * console.error(e);
2945
+ * throw e;
2946
+ * });
2947
+ *
2948
+ * ```
2533
2949
  *
2534
2950
  * @param params - Parameters for request
2535
2951
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2621,6 +3037,55 @@ export namespace dataform_v1beta1 {
2621
3037
 
2622
3038
  /**
2623
3039
  * Deletes a single Repository.
3040
+ * @example
3041
+ * ```js
3042
+ * // Before running the sample:
3043
+ * // - Enable the API at:
3044
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
3045
+ * // - Login into gcloud by running:
3046
+ * // ```sh
3047
+ * // $ gcloud auth application-default login
3048
+ * // ```
3049
+ * // - Install the npm module by running:
3050
+ * // ```sh
3051
+ * // $ npm install googleapis
3052
+ * // ```
3053
+ *
3054
+ * const {google} = require('googleapis');
3055
+ * const dataform = google.dataform('v1beta1');
3056
+ *
3057
+ * async function main() {
3058
+ * const auth = new google.auth.GoogleAuth({
3059
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3060
+ * scopes: [
3061
+ * 'https://www.googleapis.com/auth/bigquery',
3062
+ * 'https://www.googleapis.com/auth/cloud-platform',
3063
+ * ],
3064
+ * });
3065
+ *
3066
+ * // Acquire an auth client, and bind it to all future calls
3067
+ * const authClient = await auth.getClient();
3068
+ * google.options({auth: authClient});
3069
+ *
3070
+ * // Do the magic
3071
+ * const res = await dataform.projects.locations.repositories.delete({
3072
+ * // 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.*.
3073
+ * force: 'placeholder-value',
3074
+ * // Required. The repository's name.
3075
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie',
3076
+ * });
3077
+ * console.log(res.data);
3078
+ *
3079
+ * // Example response
3080
+ * // {}
3081
+ * }
3082
+ *
3083
+ * main().catch(e => {
3084
+ * console.error(e);
3085
+ * throw e;
3086
+ * });
3087
+ *
3088
+ * ```
2624
3089
  *
2625
3090
  * @param params - Parameters for request
2626
3091
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2709,6 +3174,60 @@ export namespace dataform_v1beta1 {
2709
3174
 
2710
3175
  /**
2711
3176
  * Fetches a Repository's history of commits. The Repository must not have a value for `git_remote_settings.url`.
3177
+ * @example
3178
+ * ```js
3179
+ * // Before running the sample:
3180
+ * // - Enable the API at:
3181
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
3182
+ * // - Login into gcloud by running:
3183
+ * // ```sh
3184
+ * // $ gcloud auth application-default login
3185
+ * // ```
3186
+ * // - Install the npm module by running:
3187
+ * // ```sh
3188
+ * // $ npm install googleapis
3189
+ * // ```
3190
+ *
3191
+ * const {google} = require('googleapis');
3192
+ * const dataform = google.dataform('v1beta1');
3193
+ *
3194
+ * async function main() {
3195
+ * const auth = new google.auth.GoogleAuth({
3196
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3197
+ * scopes: [
3198
+ * 'https://www.googleapis.com/auth/bigquery',
3199
+ * 'https://www.googleapis.com/auth/cloud-platform',
3200
+ * ],
3201
+ * });
3202
+ *
3203
+ * // Acquire an auth client, and bind it to all future calls
3204
+ * const authClient = await auth.getClient();
3205
+ * google.options({auth: authClient});
3206
+ *
3207
+ * // Do the magic
3208
+ * const res = await dataform.projects.locations.repositories.fetchHistory({
3209
+ * // Required. The repository's name.
3210
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie',
3211
+ * // Optional. Maximum number of commits to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
3212
+ * pageSize: 'placeholder-value',
3213
+ * // 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.
3214
+ * pageToken: 'placeholder-value',
3215
+ * });
3216
+ * console.log(res.data);
3217
+ *
3218
+ * // Example response
3219
+ * // {
3220
+ * // "commits": [],
3221
+ * // "nextPageToken": "my_nextPageToken"
3222
+ * // }
3223
+ * }
3224
+ *
3225
+ * main().catch(e => {
3226
+ * console.error(e);
3227
+ * throw e;
3228
+ * });
3229
+ *
3230
+ * ```
2712
3231
  *
2713
3232
  * @param params - Parameters for request
2714
3233
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2807,6 +3326,56 @@ export namespace dataform_v1beta1 {
2807
3326
 
2808
3327
  /**
2809
3328
  * Fetches a Repository's remote branches.
3329
+ * @example
3330
+ * ```js
3331
+ * // Before running the sample:
3332
+ * // - Enable the API at:
3333
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
3334
+ * // - Login into gcloud by running:
3335
+ * // ```sh
3336
+ * // $ gcloud auth application-default login
3337
+ * // ```
3338
+ * // - Install the npm module by running:
3339
+ * // ```sh
3340
+ * // $ npm install googleapis
3341
+ * // ```
3342
+ *
3343
+ * const {google} = require('googleapis');
3344
+ * const dataform = google.dataform('v1beta1');
3345
+ *
3346
+ * async function main() {
3347
+ * const auth = new google.auth.GoogleAuth({
3348
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3349
+ * scopes: [
3350
+ * 'https://www.googleapis.com/auth/bigquery',
3351
+ * 'https://www.googleapis.com/auth/cloud-platform',
3352
+ * ],
3353
+ * });
3354
+ *
3355
+ * // Acquire an auth client, and bind it to all future calls
3356
+ * const authClient = await auth.getClient();
3357
+ * google.options({auth: authClient});
3358
+ *
3359
+ * // Do the magic
3360
+ * const res =
3361
+ * await dataform.projects.locations.repositories.fetchRemoteBranches({
3362
+ * // Required. The repository's name.
3363
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie',
3364
+ * });
3365
+ * console.log(res.data);
3366
+ *
3367
+ * // Example response
3368
+ * // {
3369
+ * // "branches": []
3370
+ * // }
3371
+ * }
3372
+ *
3373
+ * main().catch(e => {
3374
+ * console.error(e);
3375
+ * throw e;
3376
+ * });
3377
+ *
3378
+ * ```
2810
3379
  *
2811
3380
  * @param params - Parameters for request
2812
3381
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2903,6 +3472,66 @@ export namespace dataform_v1beta1 {
2903
3472
 
2904
3473
  /**
2905
3474
  * Fetches a single Repository.
3475
+ * @example
3476
+ * ```js
3477
+ * // Before running the sample:
3478
+ * // - Enable the API at:
3479
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
3480
+ * // - Login into gcloud by running:
3481
+ * // ```sh
3482
+ * // $ gcloud auth application-default login
3483
+ * // ```
3484
+ * // - Install the npm module by running:
3485
+ * // ```sh
3486
+ * // $ npm install googleapis
3487
+ * // ```
3488
+ *
3489
+ * const {google} = require('googleapis');
3490
+ * const dataform = google.dataform('v1beta1');
3491
+ *
3492
+ * async function main() {
3493
+ * const auth = new google.auth.GoogleAuth({
3494
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3495
+ * scopes: [
3496
+ * 'https://www.googleapis.com/auth/bigquery',
3497
+ * 'https://www.googleapis.com/auth/cloud-platform',
3498
+ * ],
3499
+ * });
3500
+ *
3501
+ * // Acquire an auth client, and bind it to all future calls
3502
+ * const authClient = await auth.getClient();
3503
+ * google.options({auth: authClient});
3504
+ *
3505
+ * // Do the magic
3506
+ * const res = await dataform.projects.locations.repositories.get({
3507
+ * // Required. The repository's name.
3508
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie',
3509
+ * });
3510
+ * console.log(res.data);
3511
+ *
3512
+ * // Example response
3513
+ * // {
3514
+ * // "createTime": "my_createTime",
3515
+ * // "dataEncryptionState": {},
3516
+ * // "displayName": "my_displayName",
3517
+ * // "gitRemoteSettings": {},
3518
+ * // "internalMetadata": "my_internalMetadata",
3519
+ * // "kmsKeyName": "my_kmsKeyName",
3520
+ * // "labels": {},
3521
+ * // "name": "my_name",
3522
+ * // "npmrcEnvironmentVariablesSecretVersion": "my_npmrcEnvironmentVariablesSecretVersion",
3523
+ * // "serviceAccount": "my_serviceAccount",
3524
+ * // "setAuthenticatedUserAdmin": false,
3525
+ * // "workspaceCompilationOverrides": {}
3526
+ * // }
3527
+ * }
3528
+ *
3529
+ * main().catch(e => {
3530
+ * console.error(e);
3531
+ * throw e;
3532
+ * });
3533
+ *
3534
+ * ```
2906
3535
  *
2907
3536
  * @param params - Parameters for request
2908
3537
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2991,6 +3620,60 @@ export namespace dataform_v1beta1 {
2991
3620
 
2992
3621
  /**
2993
3622
  * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
3623
+ * @example
3624
+ * ```js
3625
+ * // Before running the sample:
3626
+ * // - Enable the API at:
3627
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
3628
+ * // - Login into gcloud by running:
3629
+ * // ```sh
3630
+ * // $ gcloud auth application-default login
3631
+ * // ```
3632
+ * // - Install the npm module by running:
3633
+ * // ```sh
3634
+ * // $ npm install googleapis
3635
+ * // ```
3636
+ *
3637
+ * const {google} = require('googleapis');
3638
+ * const dataform = google.dataform('v1beta1');
3639
+ *
3640
+ * async function main() {
3641
+ * const auth = new google.auth.GoogleAuth({
3642
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3643
+ * scopes: [
3644
+ * 'https://www.googleapis.com/auth/bigquery',
3645
+ * 'https://www.googleapis.com/auth/cloud-platform',
3646
+ * ],
3647
+ * });
3648
+ *
3649
+ * // Acquire an auth client, and bind it to all future calls
3650
+ * const authClient = await auth.getClient();
3651
+ * google.options({auth: authClient});
3652
+ *
3653
+ * // Do the magic
3654
+ * const res = await dataform.projects.locations.repositories.getIamPolicy({
3655
+ * // 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).
3656
+ * 'options.requestedPolicyVersion': 'placeholder-value',
3657
+ * // 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.
3658
+ * resource:
3659
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie',
3660
+ * });
3661
+ * console.log(res.data);
3662
+ *
3663
+ * // Example response
3664
+ * // {
3665
+ * // "bindings": [],
3666
+ * // "etag": "my_etag",
3667
+ * // "version": 0
3668
+ * // }
3669
+ * }
3670
+ *
3671
+ * main().catch(e => {
3672
+ * console.error(e);
3673
+ * throw e;
3674
+ * });
3675
+ *
3676
+ * ```
2994
3677
  *
2995
3678
  * @param params - Parameters for request
2996
3679
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3083,6 +3766,65 @@ export namespace dataform_v1beta1 {
3083
3766
 
3084
3767
  /**
3085
3768
  * 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)*.
3769
+ * @example
3770
+ * ```js
3771
+ * // Before running the sample:
3772
+ * // - Enable the API at:
3773
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
3774
+ * // - Login into gcloud by running:
3775
+ * // ```sh
3776
+ * // $ gcloud auth application-default login
3777
+ * // ```
3778
+ * // - Install the npm module by running:
3779
+ * // ```sh
3780
+ * // $ npm install googleapis
3781
+ * // ```
3782
+ *
3783
+ * const {google} = require('googleapis');
3784
+ * const dataform = google.dataform('v1beta1');
3785
+ *
3786
+ * async function main() {
3787
+ * const auth = new google.auth.GoogleAuth({
3788
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3789
+ * scopes: [
3790
+ * 'https://www.googleapis.com/auth/bigquery',
3791
+ * 'https://www.googleapis.com/auth/cloud-platform',
3792
+ * ],
3793
+ * });
3794
+ *
3795
+ * // Acquire an auth client, and bind it to all future calls
3796
+ * const authClient = await auth.getClient();
3797
+ * google.options({auth: authClient});
3798
+ *
3799
+ * // Do the magic
3800
+ * const res = await dataform.projects.locations.repositories.list({
3801
+ * // Optional. Filter for the returned list.
3802
+ * filter: 'placeholder-value',
3803
+ * // 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.
3804
+ * orderBy: 'placeholder-value',
3805
+ * // Optional. Maximum number of repositories to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
3806
+ * pageSize: 'placeholder-value',
3807
+ * // 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.
3808
+ * pageToken: 'placeholder-value',
3809
+ * // Required. The location in which to list repositories. Must be in the format `projects/x/locations/x`.
3810
+ * parent: 'projects/my-project/locations/my-location',
3811
+ * });
3812
+ * console.log(res.data);
3813
+ *
3814
+ * // Example response
3815
+ * // {
3816
+ * // "nextPageToken": "my_nextPageToken",
3817
+ * // "repositories": [],
3818
+ * // "unreachable": []
3819
+ * // }
3820
+ * }
3821
+ *
3822
+ * main().catch(e => {
3823
+ * console.error(e);
3824
+ * throw e;
3825
+ * });
3826
+ *
3827
+ * ```
3086
3828
  *
3087
3829
  * @param params - Parameters for request
3088
3830
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3176,6 +3918,87 @@ export namespace dataform_v1beta1 {
3176
3918
 
3177
3919
  /**
3178
3920
  * 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.*
3921
+ * @example
3922
+ * ```js
3923
+ * // Before running the sample:
3924
+ * // - Enable the API at:
3925
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
3926
+ * // - Login into gcloud by running:
3927
+ * // ```sh
3928
+ * // $ gcloud auth application-default login
3929
+ * // ```
3930
+ * // - Install the npm module by running:
3931
+ * // ```sh
3932
+ * // $ npm install googleapis
3933
+ * // ```
3934
+ *
3935
+ * const {google} = require('googleapis');
3936
+ * const dataform = google.dataform('v1beta1');
3937
+ *
3938
+ * async function main() {
3939
+ * const auth = new google.auth.GoogleAuth({
3940
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3941
+ * scopes: [
3942
+ * 'https://www.googleapis.com/auth/bigquery',
3943
+ * 'https://www.googleapis.com/auth/cloud-platform',
3944
+ * ],
3945
+ * });
3946
+ *
3947
+ * // Acquire an auth client, and bind it to all future calls
3948
+ * const authClient = await auth.getClient();
3949
+ * google.options({auth: authClient});
3950
+ *
3951
+ * // Do the magic
3952
+ * const res = await dataform.projects.locations.repositories.patch({
3953
+ * // Identifier. The repository's name.
3954
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie',
3955
+ * // Optional. Specifies the fields to be updated in the repository. If left unset, all fields will be updated.
3956
+ * updateMask: 'placeholder-value',
3957
+ *
3958
+ * // Request body metadata
3959
+ * requestBody: {
3960
+ * // request body parameters
3961
+ * // {
3962
+ * // "createTime": "my_createTime",
3963
+ * // "dataEncryptionState": {},
3964
+ * // "displayName": "my_displayName",
3965
+ * // "gitRemoteSettings": {},
3966
+ * // "internalMetadata": "my_internalMetadata",
3967
+ * // "kmsKeyName": "my_kmsKeyName",
3968
+ * // "labels": {},
3969
+ * // "name": "my_name",
3970
+ * // "npmrcEnvironmentVariablesSecretVersion": "my_npmrcEnvironmentVariablesSecretVersion",
3971
+ * // "serviceAccount": "my_serviceAccount",
3972
+ * // "setAuthenticatedUserAdmin": false,
3973
+ * // "workspaceCompilationOverrides": {}
3974
+ * // }
3975
+ * },
3976
+ * });
3977
+ * console.log(res.data);
3978
+ *
3979
+ * // Example response
3980
+ * // {
3981
+ * // "createTime": "my_createTime",
3982
+ * // "dataEncryptionState": {},
3983
+ * // "displayName": "my_displayName",
3984
+ * // "gitRemoteSettings": {},
3985
+ * // "internalMetadata": "my_internalMetadata",
3986
+ * // "kmsKeyName": "my_kmsKeyName",
3987
+ * // "labels": {},
3988
+ * // "name": "my_name",
3989
+ * // "npmrcEnvironmentVariablesSecretVersion": "my_npmrcEnvironmentVariablesSecretVersion",
3990
+ * // "serviceAccount": "my_serviceAccount",
3991
+ * // "setAuthenticatedUserAdmin": false,
3992
+ * // "workspaceCompilationOverrides": {}
3993
+ * // }
3994
+ * }
3995
+ *
3996
+ * main().catch(e => {
3997
+ * console.error(e);
3998
+ * throw e;
3999
+ * });
4000
+ *
4001
+ * ```
3179
4002
  *
3180
4003
  * @param params - Parameters for request
3181
4004
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3264,6 +4087,65 @@ export namespace dataform_v1beta1 {
3264
4087
 
3265
4088
  /**
3266
4089
  * Returns the contents of a given Repository directory. The Repository must not have a value for `git_remote_settings.url`.
4090
+ * @example
4091
+ * ```js
4092
+ * // Before running the sample:
4093
+ * // - Enable the API at:
4094
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
4095
+ * // - Login into gcloud by running:
4096
+ * // ```sh
4097
+ * // $ gcloud auth application-default login
4098
+ * // ```
4099
+ * // - Install the npm module by running:
4100
+ * // ```sh
4101
+ * // $ npm install googleapis
4102
+ * // ```
4103
+ *
4104
+ * const {google} = require('googleapis');
4105
+ * const dataform = google.dataform('v1beta1');
4106
+ *
4107
+ * async function main() {
4108
+ * const auth = new google.auth.GoogleAuth({
4109
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4110
+ * scopes: [
4111
+ * 'https://www.googleapis.com/auth/bigquery',
4112
+ * 'https://www.googleapis.com/auth/cloud-platform',
4113
+ * ],
4114
+ * });
4115
+ *
4116
+ * // Acquire an auth client, and bind it to all future calls
4117
+ * const authClient = await auth.getClient();
4118
+ * google.options({auth: authClient});
4119
+ *
4120
+ * // Do the magic
4121
+ * const res =
4122
+ * await dataform.projects.locations.repositories.queryDirectoryContents({
4123
+ * // Optional. The Commit SHA for the commit to query from. If unset, the directory will be queried from HEAD.
4124
+ * commitSha: 'placeholder-value',
4125
+ * // Required. The repository's name.
4126
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie',
4127
+ * // Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
4128
+ * pageSize: 'placeholder-value',
4129
+ * // 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.
4130
+ * pageToken: 'placeholder-value',
4131
+ * // Optional. The directory's full path including directory name, relative to root. If left unset, the root is used.
4132
+ * path: 'placeholder-value',
4133
+ * });
4134
+ * console.log(res.data);
4135
+ *
4136
+ * // Example response
4137
+ * // {
4138
+ * // "directoryEntries": [],
4139
+ * // "nextPageToken": "my_nextPageToken"
4140
+ * // }
4141
+ * }
4142
+ *
4143
+ * main().catch(e => {
4144
+ * console.error(e);
4145
+ * throw e;
4146
+ * });
4147
+ *
4148
+ * ```
3267
4149
  *
3268
4150
  * @param params - Parameters for request
3269
4151
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3366,6 +4248,59 @@ export namespace dataform_v1beta1 {
3366
4248
 
3367
4249
  /**
3368
4250
  * Returns the contents of a file (inside a Repository). The Repository must not have a value for `git_remote_settings.url`.
4251
+ * @example
4252
+ * ```js
4253
+ * // Before running the sample:
4254
+ * // - Enable the API at:
4255
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
4256
+ * // - Login into gcloud by running:
4257
+ * // ```sh
4258
+ * // $ gcloud auth application-default login
4259
+ * // ```
4260
+ * // - Install the npm module by running:
4261
+ * // ```sh
4262
+ * // $ npm install googleapis
4263
+ * // ```
4264
+ *
4265
+ * const {google} = require('googleapis');
4266
+ * const dataform = google.dataform('v1beta1');
4267
+ *
4268
+ * async function main() {
4269
+ * const auth = new google.auth.GoogleAuth({
4270
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4271
+ * scopes: [
4272
+ * 'https://www.googleapis.com/auth/bigquery',
4273
+ * 'https://www.googleapis.com/auth/cloud-platform',
4274
+ * ],
4275
+ * });
4276
+ *
4277
+ * // Acquire an auth client, and bind it to all future calls
4278
+ * const authClient = await auth.getClient();
4279
+ * google.options({auth: authClient});
4280
+ *
4281
+ * // Do the magic
4282
+ * const res = await dataform.projects.locations.repositories.readFile({
4283
+ * // Optional. The commit SHA for the commit to read from. If unset, the file will be read from HEAD.
4284
+ * commitSha: 'placeholder-value',
4285
+ * // Required. The repository's name.
4286
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie',
4287
+ * // Required. Full file path to read including filename, from repository root.
4288
+ * path: 'placeholder-value',
4289
+ * });
4290
+ * console.log(res.data);
4291
+ *
4292
+ * // Example response
4293
+ * // {
4294
+ * // "contents": "my_contents"
4295
+ * // }
4296
+ * }
4297
+ *
4298
+ * main().catch(e => {
4299
+ * console.error(e);
4300
+ * throw e;
4301
+ * });
4302
+ *
4303
+ * ```
3369
4304
  *
3370
4305
  * @param params - Parameters for request
3371
4306
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3461,6 +4396,66 @@ export namespace dataform_v1beta1 {
3461
4396
 
3462
4397
  /**
3463
4398
  * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
4399
+ * @example
4400
+ * ```js
4401
+ * // Before running the sample:
4402
+ * // - Enable the API at:
4403
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
4404
+ * // - Login into gcloud by running:
4405
+ * // ```sh
4406
+ * // $ gcloud auth application-default login
4407
+ * // ```
4408
+ * // - Install the npm module by running:
4409
+ * // ```sh
4410
+ * // $ npm install googleapis
4411
+ * // ```
4412
+ *
4413
+ * const {google} = require('googleapis');
4414
+ * const dataform = google.dataform('v1beta1');
4415
+ *
4416
+ * async function main() {
4417
+ * const auth = new google.auth.GoogleAuth({
4418
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4419
+ * scopes: [
4420
+ * 'https://www.googleapis.com/auth/bigquery',
4421
+ * 'https://www.googleapis.com/auth/cloud-platform',
4422
+ * ],
4423
+ * });
4424
+ *
4425
+ * // Acquire an auth client, and bind it to all future calls
4426
+ * const authClient = await auth.getClient();
4427
+ * google.options({auth: authClient});
4428
+ *
4429
+ * // Do the magic
4430
+ * const res = await dataform.projects.locations.repositories.setIamPolicy({
4431
+ * // 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.
4432
+ * resource:
4433
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie',
4434
+ *
4435
+ * // Request body metadata
4436
+ * requestBody: {
4437
+ * // request body parameters
4438
+ * // {
4439
+ * // "policy": {}
4440
+ * // }
4441
+ * },
4442
+ * });
4443
+ * console.log(res.data);
4444
+ *
4445
+ * // Example response
4446
+ * // {
4447
+ * // "bindings": [],
4448
+ * // "etag": "my_etag",
4449
+ * // "version": 0
4450
+ * // }
4451
+ * }
4452
+ *
4453
+ * main().catch(e => {
4454
+ * console.error(e);
4455
+ * throw e;
4456
+ * });
4457
+ *
4458
+ * ```
3464
4459
  *
3465
4460
  * @param params - Parameters for request
3466
4461
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3553,6 +4548,66 @@ export namespace dataform_v1beta1 {
3553
4548
 
3554
4549
  /**
3555
4550
  * 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.
4551
+ * @example
4552
+ * ```js
4553
+ * // Before running the sample:
4554
+ * // - Enable the API at:
4555
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
4556
+ * // - Login into gcloud by running:
4557
+ * // ```sh
4558
+ * // $ gcloud auth application-default login
4559
+ * // ```
4560
+ * // - Install the npm module by running:
4561
+ * // ```sh
4562
+ * // $ npm install googleapis
4563
+ * // ```
4564
+ *
4565
+ * const {google} = require('googleapis');
4566
+ * const dataform = google.dataform('v1beta1');
4567
+ *
4568
+ * async function main() {
4569
+ * const auth = new google.auth.GoogleAuth({
4570
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4571
+ * scopes: [
4572
+ * 'https://www.googleapis.com/auth/bigquery',
4573
+ * 'https://www.googleapis.com/auth/cloud-platform',
4574
+ * ],
4575
+ * });
4576
+ *
4577
+ * // Acquire an auth client, and bind it to all future calls
4578
+ * const authClient = await auth.getClient();
4579
+ * google.options({auth: authClient});
4580
+ *
4581
+ * // Do the magic
4582
+ * const res = await dataform.projects.locations.repositories.testIamPermissions(
4583
+ * {
4584
+ * // 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.
4585
+ * resource:
4586
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie',
4587
+ *
4588
+ * // Request body metadata
4589
+ * requestBody: {
4590
+ * // request body parameters
4591
+ * // {
4592
+ * // "permissions": []
4593
+ * // }
4594
+ * },
4595
+ * },
4596
+ * );
4597
+ * console.log(res.data);
4598
+ *
4599
+ * // Example response
4600
+ * // {
4601
+ * // "permissions": []
4602
+ * // }
4603
+ * }
4604
+ *
4605
+ * main().catch(e => {
4606
+ * console.error(e);
4607
+ * throw e;
4608
+ * });
4609
+ *
4610
+ * ```
3556
4611
  *
3557
4612
  * @param params - Parameters for request
3558
4613
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3686,7 +4741,7 @@ export namespace dataform_v1beta1 {
3686
4741
  export interface Params$Resource$Projects$Locations$Repositories$Delete
3687
4742
  extends StandardParameters {
3688
4743
  /**
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.)
4744
+ * 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
4745
  */
3691
4746
  force?: boolean;
3692
4747
  /**
@@ -3844,6 +4899,85 @@ export namespace dataform_v1beta1 {
3844
4899
 
3845
4900
  /**
3846
4901
  * Creates a new CompilationResult in a given project and location.
4902
+ * @example
4903
+ * ```js
4904
+ * // Before running the sample:
4905
+ * // - Enable the API at:
4906
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
4907
+ * // - Login into gcloud by running:
4908
+ * // ```sh
4909
+ * // $ gcloud auth application-default login
4910
+ * // ```
4911
+ * // - Install the npm module by running:
4912
+ * // ```sh
4913
+ * // $ npm install googleapis
4914
+ * // ```
4915
+ *
4916
+ * const {google} = require('googleapis');
4917
+ * const dataform = google.dataform('v1beta1');
4918
+ *
4919
+ * async function main() {
4920
+ * const auth = new google.auth.GoogleAuth({
4921
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4922
+ * scopes: [
4923
+ * 'https://www.googleapis.com/auth/bigquery',
4924
+ * 'https://www.googleapis.com/auth/cloud-platform',
4925
+ * ],
4926
+ * });
4927
+ *
4928
+ * // Acquire an auth client, and bind it to all future calls
4929
+ * const authClient = await auth.getClient();
4930
+ * google.options({auth: authClient});
4931
+ *
4932
+ * // Do the magic
4933
+ * const res =
4934
+ * await dataform.projects.locations.repositories.compilationResults.create({
4935
+ * // Required. The repository in which to create the compilation result. Must be in the format `projects/x/locations/x/repositories/x`.
4936
+ * parent:
4937
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie',
4938
+ *
4939
+ * // Request body metadata
4940
+ * requestBody: {
4941
+ * // request body parameters
4942
+ * // {
4943
+ * // "codeCompilationConfig": {},
4944
+ * // "compilationErrors": [],
4945
+ * // "createTime": "my_createTime",
4946
+ * // "dataEncryptionState": {},
4947
+ * // "dataformCoreVersion": "my_dataformCoreVersion",
4948
+ * // "gitCommitish": "my_gitCommitish",
4949
+ * // "internalMetadata": "my_internalMetadata",
4950
+ * // "name": "my_name",
4951
+ * // "releaseConfig": "my_releaseConfig",
4952
+ * // "resolvedGitCommitSha": "my_resolvedGitCommitSha",
4953
+ * // "workspace": "my_workspace"
4954
+ * // }
4955
+ * },
4956
+ * });
4957
+ * console.log(res.data);
4958
+ *
4959
+ * // Example response
4960
+ * // {
4961
+ * // "codeCompilationConfig": {},
4962
+ * // "compilationErrors": [],
4963
+ * // "createTime": "my_createTime",
4964
+ * // "dataEncryptionState": {},
4965
+ * // "dataformCoreVersion": "my_dataformCoreVersion",
4966
+ * // "gitCommitish": "my_gitCommitish",
4967
+ * // "internalMetadata": "my_internalMetadata",
4968
+ * // "name": "my_name",
4969
+ * // "releaseConfig": "my_releaseConfig",
4970
+ * // "resolvedGitCommitSha": "my_resolvedGitCommitSha",
4971
+ * // "workspace": "my_workspace"
4972
+ * // }
4973
+ * }
4974
+ *
4975
+ * main().catch(e => {
4976
+ * console.error(e);
4977
+ * throw e;
4978
+ * });
4979
+ *
4980
+ * ```
3847
4981
  *
3848
4982
  * @param params - Parameters for request
3849
4983
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3936,6 +5070,66 @@ export namespace dataform_v1beta1 {
3936
5070
 
3937
5071
  /**
3938
5072
  * Fetches a single CompilationResult.
5073
+ * @example
5074
+ * ```js
5075
+ * // Before running the sample:
5076
+ * // - Enable the API at:
5077
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
5078
+ * // - Login into gcloud by running:
5079
+ * // ```sh
5080
+ * // $ gcloud auth application-default login
5081
+ * // ```
5082
+ * // - Install the npm module by running:
5083
+ * // ```sh
5084
+ * // $ npm install googleapis
5085
+ * // ```
5086
+ *
5087
+ * const {google} = require('googleapis');
5088
+ * const dataform = google.dataform('v1beta1');
5089
+ *
5090
+ * async function main() {
5091
+ * const auth = new google.auth.GoogleAuth({
5092
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5093
+ * scopes: [
5094
+ * 'https://www.googleapis.com/auth/bigquery',
5095
+ * 'https://www.googleapis.com/auth/cloud-platform',
5096
+ * ],
5097
+ * });
5098
+ *
5099
+ * // Acquire an auth client, and bind it to all future calls
5100
+ * const authClient = await auth.getClient();
5101
+ * google.options({auth: authClient});
5102
+ *
5103
+ * // Do the magic
5104
+ * const res =
5105
+ * await dataform.projects.locations.repositories.compilationResults.get({
5106
+ * // Required. The compilation result's name.
5107
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/compilationResults/my-compilationResult',
5108
+ * });
5109
+ * console.log(res.data);
5110
+ *
5111
+ * // Example response
5112
+ * // {
5113
+ * // "codeCompilationConfig": {},
5114
+ * // "compilationErrors": [],
5115
+ * // "createTime": "my_createTime",
5116
+ * // "dataEncryptionState": {},
5117
+ * // "dataformCoreVersion": "my_dataformCoreVersion",
5118
+ * // "gitCommitish": "my_gitCommitish",
5119
+ * // "internalMetadata": "my_internalMetadata",
5120
+ * // "name": "my_name",
5121
+ * // "releaseConfig": "my_releaseConfig",
5122
+ * // "resolvedGitCommitSha": "my_resolvedGitCommitSha",
5123
+ * // "workspace": "my_workspace"
5124
+ * // }
5125
+ * }
5126
+ *
5127
+ * main().catch(e => {
5128
+ * console.error(e);
5129
+ * throw e;
5130
+ * });
5131
+ *
5132
+ * ```
3939
5133
  *
3940
5134
  * @param params - Parameters for request
3941
5135
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4025,6 +5219,67 @@ export namespace dataform_v1beta1 {
4025
5219
 
4026
5220
  /**
4027
5221
  * Lists CompilationResults in a given Repository.
5222
+ * @example
5223
+ * ```js
5224
+ * // Before running the sample:
5225
+ * // - Enable the API at:
5226
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
5227
+ * // - Login into gcloud by running:
5228
+ * // ```sh
5229
+ * // $ gcloud auth application-default login
5230
+ * // ```
5231
+ * // - Install the npm module by running:
5232
+ * // ```sh
5233
+ * // $ npm install googleapis
5234
+ * // ```
5235
+ *
5236
+ * const {google} = require('googleapis');
5237
+ * const dataform = google.dataform('v1beta1');
5238
+ *
5239
+ * async function main() {
5240
+ * const auth = new google.auth.GoogleAuth({
5241
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5242
+ * scopes: [
5243
+ * 'https://www.googleapis.com/auth/bigquery',
5244
+ * 'https://www.googleapis.com/auth/cloud-platform',
5245
+ * ],
5246
+ * });
5247
+ *
5248
+ * // Acquire an auth client, and bind it to all future calls
5249
+ * const authClient = await auth.getClient();
5250
+ * google.options({auth: authClient});
5251
+ *
5252
+ * // Do the magic
5253
+ * const res =
5254
+ * await dataform.projects.locations.repositories.compilationResults.list({
5255
+ * // Optional. Filter for the returned list.
5256
+ * filter: 'placeholder-value',
5257
+ * // 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.
5258
+ * orderBy: 'placeholder-value',
5259
+ * // 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.
5260
+ * pageSize: 'placeholder-value',
5261
+ * // 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.
5262
+ * pageToken: 'placeholder-value',
5263
+ * // Required. The repository in which to list compilation results. Must be in the format `projects/x/locations/x/repositories/x`.
5264
+ * parent:
5265
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie',
5266
+ * });
5267
+ * console.log(res.data);
5268
+ *
5269
+ * // Example response
5270
+ * // {
5271
+ * // "compilationResults": [],
5272
+ * // "nextPageToken": "my_nextPageToken",
5273
+ * // "unreachable": []
5274
+ * // }
5275
+ * }
5276
+ *
5277
+ * main().catch(e => {
5278
+ * console.error(e);
5279
+ * throw e;
5280
+ * });
5281
+ *
5282
+ * ```
4028
5283
  *
4029
5284
  * @param params - Parameters for request
4030
5285
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4123,6 +5378,63 @@ export namespace dataform_v1beta1 {
4123
5378
 
4124
5379
  /**
4125
5380
  * Returns CompilationResultActions in a given CompilationResult.
5381
+ * @example
5382
+ * ```js
5383
+ * // Before running the sample:
5384
+ * // - Enable the API at:
5385
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
5386
+ * // - Login into gcloud by running:
5387
+ * // ```sh
5388
+ * // $ gcloud auth application-default login
5389
+ * // ```
5390
+ * // - Install the npm module by running:
5391
+ * // ```sh
5392
+ * // $ npm install googleapis
5393
+ * // ```
5394
+ *
5395
+ * const {google} = require('googleapis');
5396
+ * const dataform = google.dataform('v1beta1');
5397
+ *
5398
+ * async function main() {
5399
+ * const auth = new google.auth.GoogleAuth({
5400
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5401
+ * scopes: [
5402
+ * 'https://www.googleapis.com/auth/bigquery',
5403
+ * 'https://www.googleapis.com/auth/cloud-platform',
5404
+ * ],
5405
+ * });
5406
+ *
5407
+ * // Acquire an auth client, and bind it to all future calls
5408
+ * const authClient = await auth.getClient();
5409
+ * google.options({auth: authClient});
5410
+ *
5411
+ * // Do the magic
5412
+ * const res =
5413
+ * await dataform.projects.locations.repositories.compilationResults.query({
5414
+ * // Optional. Optional filter for the returned list. Filtering is only currently supported on the `file_path` field.
5415
+ * filter: 'placeholder-value',
5416
+ * // Required. The compilation result's name.
5417
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/compilationResults/my-compilationResult',
5418
+ * // 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.
5419
+ * pageSize: 'placeholder-value',
5420
+ * // 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.
5421
+ * pageToken: 'placeholder-value',
5422
+ * });
5423
+ * console.log(res.data);
5424
+ *
5425
+ * // Example response
5426
+ * // {
5427
+ * // "compilationResultActions": [],
5428
+ * // "nextPageToken": "my_nextPageToken"
5429
+ * // }
5430
+ * }
5431
+ *
5432
+ * main().catch(e => {
5433
+ * console.error(e);
5434
+ * throw e;
5435
+ * });
5436
+ *
5437
+ * ```
4126
5438
  *
4127
5439
  * @param params - Parameters for request
4128
5440
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4294,6 +5606,83 @@ export namespace dataform_v1beta1 {
4294
5606
 
4295
5607
  /**
4296
5608
  * Creates a new ReleaseConfig in a given Repository.
5609
+ * @example
5610
+ * ```js
5611
+ * // Before running the sample:
5612
+ * // - Enable the API at:
5613
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
5614
+ * // - Login into gcloud by running:
5615
+ * // ```sh
5616
+ * // $ gcloud auth application-default login
5617
+ * // ```
5618
+ * // - Install the npm module by running:
5619
+ * // ```sh
5620
+ * // $ npm install googleapis
5621
+ * // ```
5622
+ *
5623
+ * const {google} = require('googleapis');
5624
+ * const dataform = google.dataform('v1beta1');
5625
+ *
5626
+ * async function main() {
5627
+ * const auth = new google.auth.GoogleAuth({
5628
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5629
+ * scopes: [
5630
+ * 'https://www.googleapis.com/auth/bigquery',
5631
+ * 'https://www.googleapis.com/auth/cloud-platform',
5632
+ * ],
5633
+ * });
5634
+ *
5635
+ * // Acquire an auth client, and bind it to all future calls
5636
+ * const authClient = await auth.getClient();
5637
+ * google.options({auth: authClient});
5638
+ *
5639
+ * // Do the magic
5640
+ * const res =
5641
+ * await dataform.projects.locations.repositories.releaseConfigs.create({
5642
+ * // Required. The repository in which to create the release config. Must be in the format `projects/x/locations/x/repositories/x`.
5643
+ * parent:
5644
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie',
5645
+ * // Required. The ID to use for the release config, which will become the final component of the release config's resource name.
5646
+ * releaseConfigId: 'placeholder-value',
5647
+ *
5648
+ * // Request body metadata
5649
+ * requestBody: {
5650
+ * // request body parameters
5651
+ * // {
5652
+ * // "codeCompilationConfig": {},
5653
+ * // "cronSchedule": "my_cronSchedule",
5654
+ * // "disabled": false,
5655
+ * // "gitCommitish": "my_gitCommitish",
5656
+ * // "internalMetadata": "my_internalMetadata",
5657
+ * // "name": "my_name",
5658
+ * // "recentScheduledReleaseRecords": [],
5659
+ * // "releaseCompilationResult": "my_releaseCompilationResult",
5660
+ * // "timeZone": "my_timeZone"
5661
+ * // }
5662
+ * },
5663
+ * });
5664
+ * console.log(res.data);
5665
+ *
5666
+ * // Example response
5667
+ * // {
5668
+ * // "codeCompilationConfig": {},
5669
+ * // "cronSchedule": "my_cronSchedule",
5670
+ * // "disabled": false,
5671
+ * // "gitCommitish": "my_gitCommitish",
5672
+ * // "internalMetadata": "my_internalMetadata",
5673
+ * // "name": "my_name",
5674
+ * // "recentScheduledReleaseRecords": [],
5675
+ * // "releaseCompilationResult": "my_releaseCompilationResult",
5676
+ * // "timeZone": "my_timeZone"
5677
+ * // }
5678
+ * }
5679
+ *
5680
+ * main().catch(e => {
5681
+ * console.error(e);
5682
+ * throw e;
5683
+ * });
5684
+ *
5685
+ * ```
4297
5686
  *
4298
5687
  * @param params - Parameters for request
4299
5688
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4386,6 +5775,54 @@ export namespace dataform_v1beta1 {
4386
5775
 
4387
5776
  /**
4388
5777
  * Deletes a single ReleaseConfig.
5778
+ * @example
5779
+ * ```js
5780
+ * // Before running the sample:
5781
+ * // - Enable the API at:
5782
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
5783
+ * // - Login into gcloud by running:
5784
+ * // ```sh
5785
+ * // $ gcloud auth application-default login
5786
+ * // ```
5787
+ * // - Install the npm module by running:
5788
+ * // ```sh
5789
+ * // $ npm install googleapis
5790
+ * // ```
5791
+ *
5792
+ * const {google} = require('googleapis');
5793
+ * const dataform = google.dataform('v1beta1');
5794
+ *
5795
+ * async function main() {
5796
+ * const auth = new google.auth.GoogleAuth({
5797
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5798
+ * scopes: [
5799
+ * 'https://www.googleapis.com/auth/bigquery',
5800
+ * 'https://www.googleapis.com/auth/cloud-platform',
5801
+ * ],
5802
+ * });
5803
+ *
5804
+ * // Acquire an auth client, and bind it to all future calls
5805
+ * const authClient = await auth.getClient();
5806
+ * google.options({auth: authClient});
5807
+ *
5808
+ * // Do the magic
5809
+ * const res =
5810
+ * await dataform.projects.locations.repositories.releaseConfigs.delete({
5811
+ * // Required. The release config's name.
5812
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/releaseConfigs/my-releaseConfig',
5813
+ * });
5814
+ * console.log(res.data);
5815
+ *
5816
+ * // Example response
5817
+ * // {}
5818
+ * }
5819
+ *
5820
+ * main().catch(e => {
5821
+ * console.error(e);
5822
+ * throw e;
5823
+ * });
5824
+ *
5825
+ * ```
4389
5826
  *
4390
5827
  * @param params - Parameters for request
4391
5828
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4475,6 +5912,65 @@ export namespace dataform_v1beta1 {
4475
5912
 
4476
5913
  /**
4477
5914
  * Fetches a single ReleaseConfig.
5915
+ * @example
5916
+ * ```js
5917
+ * // Before running the sample:
5918
+ * // - Enable the API at:
5919
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
5920
+ * // - Login into gcloud by running:
5921
+ * // ```sh
5922
+ * // $ gcloud auth application-default login
5923
+ * // ```
5924
+ * // - Install the npm module by running:
5925
+ * // ```sh
5926
+ * // $ npm install googleapis
5927
+ * // ```
5928
+ *
5929
+ * const {google} = require('googleapis');
5930
+ * const dataform = google.dataform('v1beta1');
5931
+ *
5932
+ * async function main() {
5933
+ * const auth = new google.auth.GoogleAuth({
5934
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5935
+ * scopes: [
5936
+ * 'https://www.googleapis.com/auth/bigquery',
5937
+ * 'https://www.googleapis.com/auth/cloud-platform',
5938
+ * ],
5939
+ * });
5940
+ *
5941
+ * // Acquire an auth client, and bind it to all future calls
5942
+ * const authClient = await auth.getClient();
5943
+ * google.options({auth: authClient});
5944
+ *
5945
+ * // Do the magic
5946
+ * const res = await dataform.projects.locations.repositories.releaseConfigs.get(
5947
+ * {
5948
+ * // Required. The release config's name.
5949
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/releaseConfigs/my-releaseConfig',
5950
+ * },
5951
+ * );
5952
+ * console.log(res.data);
5953
+ *
5954
+ * // Example response
5955
+ * // {
5956
+ * // "codeCompilationConfig": {},
5957
+ * // "cronSchedule": "my_cronSchedule",
5958
+ * // "disabled": false,
5959
+ * // "gitCommitish": "my_gitCommitish",
5960
+ * // "internalMetadata": "my_internalMetadata",
5961
+ * // "name": "my_name",
5962
+ * // "recentScheduledReleaseRecords": [],
5963
+ * // "releaseCompilationResult": "my_releaseCompilationResult",
5964
+ * // "timeZone": "my_timeZone"
5965
+ * // }
5966
+ * }
5967
+ *
5968
+ * main().catch(e => {
5969
+ * console.error(e);
5970
+ * throw e;
5971
+ * });
5972
+ *
5973
+ * ```
4478
5974
  *
4479
5975
  * @param params - Parameters for request
4480
5976
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4564,6 +6060,63 @@ export namespace dataform_v1beta1 {
4564
6060
 
4565
6061
  /**
4566
6062
  * Lists ReleaseConfigs in a given Repository.
6063
+ * @example
6064
+ * ```js
6065
+ * // Before running the sample:
6066
+ * // - Enable the API at:
6067
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
6068
+ * // - Login into gcloud by running:
6069
+ * // ```sh
6070
+ * // $ gcloud auth application-default login
6071
+ * // ```
6072
+ * // - Install the npm module by running:
6073
+ * // ```sh
6074
+ * // $ npm install googleapis
6075
+ * // ```
6076
+ *
6077
+ * const {google} = require('googleapis');
6078
+ * const dataform = google.dataform('v1beta1');
6079
+ *
6080
+ * async function main() {
6081
+ * const auth = new google.auth.GoogleAuth({
6082
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6083
+ * scopes: [
6084
+ * 'https://www.googleapis.com/auth/bigquery',
6085
+ * 'https://www.googleapis.com/auth/cloud-platform',
6086
+ * ],
6087
+ * });
6088
+ *
6089
+ * // Acquire an auth client, and bind it to all future calls
6090
+ * const authClient = await auth.getClient();
6091
+ * google.options({auth: authClient});
6092
+ *
6093
+ * // Do the magic
6094
+ * const res =
6095
+ * await dataform.projects.locations.repositories.releaseConfigs.list({
6096
+ * // 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.
6097
+ * pageSize: 'placeholder-value',
6098
+ * // 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.
6099
+ * pageToken: 'placeholder-value',
6100
+ * // Required. The repository in which to list release configs. Must be in the format `projects/x/locations/x/repositories/x`.
6101
+ * parent:
6102
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie',
6103
+ * });
6104
+ * console.log(res.data);
6105
+ *
6106
+ * // Example response
6107
+ * // {
6108
+ * // "nextPageToken": "my_nextPageToken",
6109
+ * // "releaseConfigs": [],
6110
+ * // "unreachable": []
6111
+ * // }
6112
+ * }
6113
+ *
6114
+ * main().catch(e => {
6115
+ * console.error(e);
6116
+ * throw e;
6117
+ * });
6118
+ *
6119
+ * ```
4567
6120
  *
4568
6121
  * @param params - Parameters for request
4569
6122
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4660,6 +6213,82 @@ export namespace dataform_v1beta1 {
4660
6213
 
4661
6214
  /**
4662
6215
  * 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.*
6216
+ * @example
6217
+ * ```js
6218
+ * // Before running the sample:
6219
+ * // - Enable the API at:
6220
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
6221
+ * // - Login into gcloud by running:
6222
+ * // ```sh
6223
+ * // $ gcloud auth application-default login
6224
+ * // ```
6225
+ * // - Install the npm module by running:
6226
+ * // ```sh
6227
+ * // $ npm install googleapis
6228
+ * // ```
6229
+ *
6230
+ * const {google} = require('googleapis');
6231
+ * const dataform = google.dataform('v1beta1');
6232
+ *
6233
+ * async function main() {
6234
+ * const auth = new google.auth.GoogleAuth({
6235
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6236
+ * scopes: [
6237
+ * 'https://www.googleapis.com/auth/bigquery',
6238
+ * 'https://www.googleapis.com/auth/cloud-platform',
6239
+ * ],
6240
+ * });
6241
+ *
6242
+ * // Acquire an auth client, and bind it to all future calls
6243
+ * const authClient = await auth.getClient();
6244
+ * google.options({auth: authClient});
6245
+ *
6246
+ * // Do the magic
6247
+ * const res =
6248
+ * await dataform.projects.locations.repositories.releaseConfigs.patch({
6249
+ * // Identifier. The release config's name.
6250
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/releaseConfigs/my-releaseConfig',
6251
+ * // Optional. Specifies the fields to be updated in the release config. If left unset, all fields will be updated.
6252
+ * updateMask: 'placeholder-value',
6253
+ *
6254
+ * // Request body metadata
6255
+ * requestBody: {
6256
+ * // request body parameters
6257
+ * // {
6258
+ * // "codeCompilationConfig": {},
6259
+ * // "cronSchedule": "my_cronSchedule",
6260
+ * // "disabled": false,
6261
+ * // "gitCommitish": "my_gitCommitish",
6262
+ * // "internalMetadata": "my_internalMetadata",
6263
+ * // "name": "my_name",
6264
+ * // "recentScheduledReleaseRecords": [],
6265
+ * // "releaseCompilationResult": "my_releaseCompilationResult",
6266
+ * // "timeZone": "my_timeZone"
6267
+ * // }
6268
+ * },
6269
+ * });
6270
+ * console.log(res.data);
6271
+ *
6272
+ * // Example response
6273
+ * // {
6274
+ * // "codeCompilationConfig": {},
6275
+ * // "cronSchedule": "my_cronSchedule",
6276
+ * // "disabled": false,
6277
+ * // "gitCommitish": "my_gitCommitish",
6278
+ * // "internalMetadata": "my_internalMetadata",
6279
+ * // "name": "my_name",
6280
+ * // "recentScheduledReleaseRecords": [],
6281
+ * // "releaseCompilationResult": "my_releaseCompilationResult",
6282
+ * // "timeZone": "my_timeZone"
6283
+ * // }
6284
+ * }
6285
+ *
6286
+ * main().catch(e => {
6287
+ * console.error(e);
6288
+ * throw e;
6289
+ * });
6290
+ *
6291
+ * ```
4663
6292
  *
4664
6293
  * @param params - Parameters for request
4665
6294
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4818,6 +6447,85 @@ export namespace dataform_v1beta1 {
4818
6447
 
4819
6448
  /**
4820
6449
  * Creates a new WorkflowConfig in a given Repository.
6450
+ * @example
6451
+ * ```js
6452
+ * // Before running the sample:
6453
+ * // - Enable the API at:
6454
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
6455
+ * // - Login into gcloud by running:
6456
+ * // ```sh
6457
+ * // $ gcloud auth application-default login
6458
+ * // ```
6459
+ * // - Install the npm module by running:
6460
+ * // ```sh
6461
+ * // $ npm install googleapis
6462
+ * // ```
6463
+ *
6464
+ * const {google} = require('googleapis');
6465
+ * const dataform = google.dataform('v1beta1');
6466
+ *
6467
+ * async function main() {
6468
+ * const auth = new google.auth.GoogleAuth({
6469
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6470
+ * scopes: [
6471
+ * 'https://www.googleapis.com/auth/bigquery',
6472
+ * 'https://www.googleapis.com/auth/cloud-platform',
6473
+ * ],
6474
+ * });
6475
+ *
6476
+ * // Acquire an auth client, and bind it to all future calls
6477
+ * const authClient = await auth.getClient();
6478
+ * google.options({auth: authClient});
6479
+ *
6480
+ * // Do the magic
6481
+ * const res =
6482
+ * await dataform.projects.locations.repositories.workflowConfigs.create({
6483
+ * // Required. The repository in which to create the workflow config. Must be in the format `projects/x/locations/x/repositories/x`.
6484
+ * parent:
6485
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie',
6486
+ * // Required. The ID to use for the workflow config, which will become the final component of the workflow config's resource name.
6487
+ * workflowConfigId: 'placeholder-value',
6488
+ *
6489
+ * // Request body metadata
6490
+ * requestBody: {
6491
+ * // request body parameters
6492
+ * // {
6493
+ * // "createTime": "my_createTime",
6494
+ * // "cronSchedule": "my_cronSchedule",
6495
+ * // "disabled": false,
6496
+ * // "internalMetadata": "my_internalMetadata",
6497
+ * // "invocationConfig": {},
6498
+ * // "name": "my_name",
6499
+ * // "recentScheduledExecutionRecords": [],
6500
+ * // "releaseConfig": "my_releaseConfig",
6501
+ * // "timeZone": "my_timeZone",
6502
+ * // "updateTime": "my_updateTime"
6503
+ * // }
6504
+ * },
6505
+ * });
6506
+ * console.log(res.data);
6507
+ *
6508
+ * // Example response
6509
+ * // {
6510
+ * // "createTime": "my_createTime",
6511
+ * // "cronSchedule": "my_cronSchedule",
6512
+ * // "disabled": false,
6513
+ * // "internalMetadata": "my_internalMetadata",
6514
+ * // "invocationConfig": {},
6515
+ * // "name": "my_name",
6516
+ * // "recentScheduledExecutionRecords": [],
6517
+ * // "releaseConfig": "my_releaseConfig",
6518
+ * // "timeZone": "my_timeZone",
6519
+ * // "updateTime": "my_updateTime"
6520
+ * // }
6521
+ * }
6522
+ *
6523
+ * main().catch(e => {
6524
+ * console.error(e);
6525
+ * throw e;
6526
+ * });
6527
+ *
6528
+ * ```
4821
6529
  *
4822
6530
  * @param params - Parameters for request
4823
6531
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4910,6 +6618,54 @@ export namespace dataform_v1beta1 {
4910
6618
 
4911
6619
  /**
4912
6620
  * Deletes a single WorkflowConfig.
6621
+ * @example
6622
+ * ```js
6623
+ * // Before running the sample:
6624
+ * // - Enable the API at:
6625
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
6626
+ * // - Login into gcloud by running:
6627
+ * // ```sh
6628
+ * // $ gcloud auth application-default login
6629
+ * // ```
6630
+ * // - Install the npm module by running:
6631
+ * // ```sh
6632
+ * // $ npm install googleapis
6633
+ * // ```
6634
+ *
6635
+ * const {google} = require('googleapis');
6636
+ * const dataform = google.dataform('v1beta1');
6637
+ *
6638
+ * async function main() {
6639
+ * const auth = new google.auth.GoogleAuth({
6640
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6641
+ * scopes: [
6642
+ * 'https://www.googleapis.com/auth/bigquery',
6643
+ * 'https://www.googleapis.com/auth/cloud-platform',
6644
+ * ],
6645
+ * });
6646
+ *
6647
+ * // Acquire an auth client, and bind it to all future calls
6648
+ * const authClient = await auth.getClient();
6649
+ * google.options({auth: authClient});
6650
+ *
6651
+ * // Do the magic
6652
+ * const res =
6653
+ * await dataform.projects.locations.repositories.workflowConfigs.delete({
6654
+ * // Required. The workflow config's name.
6655
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workflowConfigs/my-workflowConfig',
6656
+ * });
6657
+ * console.log(res.data);
6658
+ *
6659
+ * // Example response
6660
+ * // {}
6661
+ * }
6662
+ *
6663
+ * main().catch(e => {
6664
+ * console.error(e);
6665
+ * throw e;
6666
+ * });
6667
+ *
6668
+ * ```
4913
6669
  *
4914
6670
  * @param params - Parameters for request
4915
6671
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4999,6 +6755,65 @@ export namespace dataform_v1beta1 {
4999
6755
 
5000
6756
  /**
5001
6757
  * Fetches a single WorkflowConfig.
6758
+ * @example
6759
+ * ```js
6760
+ * // Before running the sample:
6761
+ * // - Enable the API at:
6762
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
6763
+ * // - Login into gcloud by running:
6764
+ * // ```sh
6765
+ * // $ gcloud auth application-default login
6766
+ * // ```
6767
+ * // - Install the npm module by running:
6768
+ * // ```sh
6769
+ * // $ npm install googleapis
6770
+ * // ```
6771
+ *
6772
+ * const {google} = require('googleapis');
6773
+ * const dataform = google.dataform('v1beta1');
6774
+ *
6775
+ * async function main() {
6776
+ * const auth = new google.auth.GoogleAuth({
6777
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6778
+ * scopes: [
6779
+ * 'https://www.googleapis.com/auth/bigquery',
6780
+ * 'https://www.googleapis.com/auth/cloud-platform',
6781
+ * ],
6782
+ * });
6783
+ *
6784
+ * // Acquire an auth client, and bind it to all future calls
6785
+ * const authClient = await auth.getClient();
6786
+ * google.options({auth: authClient});
6787
+ *
6788
+ * // Do the magic
6789
+ * const res =
6790
+ * await dataform.projects.locations.repositories.workflowConfigs.get({
6791
+ * // Required. The workflow config's name.
6792
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workflowConfigs/my-workflowConfig',
6793
+ * });
6794
+ * console.log(res.data);
6795
+ *
6796
+ * // Example response
6797
+ * // {
6798
+ * // "createTime": "my_createTime",
6799
+ * // "cronSchedule": "my_cronSchedule",
6800
+ * // "disabled": false,
6801
+ * // "internalMetadata": "my_internalMetadata",
6802
+ * // "invocationConfig": {},
6803
+ * // "name": "my_name",
6804
+ * // "recentScheduledExecutionRecords": [],
6805
+ * // "releaseConfig": "my_releaseConfig",
6806
+ * // "timeZone": "my_timeZone",
6807
+ * // "updateTime": "my_updateTime"
6808
+ * // }
6809
+ * }
6810
+ *
6811
+ * main().catch(e => {
6812
+ * console.error(e);
6813
+ * throw e;
6814
+ * });
6815
+ *
6816
+ * ```
5002
6817
  *
5003
6818
  * @param params - Parameters for request
5004
6819
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5088,6 +6903,63 @@ export namespace dataform_v1beta1 {
5088
6903
 
5089
6904
  /**
5090
6905
  * Lists WorkflowConfigs in a given Repository.
6906
+ * @example
6907
+ * ```js
6908
+ * // Before running the sample:
6909
+ * // - Enable the API at:
6910
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
6911
+ * // - Login into gcloud by running:
6912
+ * // ```sh
6913
+ * // $ gcloud auth application-default login
6914
+ * // ```
6915
+ * // - Install the npm module by running:
6916
+ * // ```sh
6917
+ * // $ npm install googleapis
6918
+ * // ```
6919
+ *
6920
+ * const {google} = require('googleapis');
6921
+ * const dataform = google.dataform('v1beta1');
6922
+ *
6923
+ * async function main() {
6924
+ * const auth = new google.auth.GoogleAuth({
6925
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6926
+ * scopes: [
6927
+ * 'https://www.googleapis.com/auth/bigquery',
6928
+ * 'https://www.googleapis.com/auth/cloud-platform',
6929
+ * ],
6930
+ * });
6931
+ *
6932
+ * // Acquire an auth client, and bind it to all future calls
6933
+ * const authClient = await auth.getClient();
6934
+ * google.options({auth: authClient});
6935
+ *
6936
+ * // Do the magic
6937
+ * const res =
6938
+ * await dataform.projects.locations.repositories.workflowConfigs.list({
6939
+ * // 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.
6940
+ * pageSize: 'placeholder-value',
6941
+ * // 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.
6942
+ * pageToken: 'placeholder-value',
6943
+ * // Required. The repository in which to list workflow configs. Must be in the format `projects/x/locations/x/repositories/x`.
6944
+ * parent:
6945
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie',
6946
+ * });
6947
+ * console.log(res.data);
6948
+ *
6949
+ * // Example response
6950
+ * // {
6951
+ * // "nextPageToken": "my_nextPageToken",
6952
+ * // "unreachable": [],
6953
+ * // "workflowConfigs": []
6954
+ * // }
6955
+ * }
6956
+ *
6957
+ * main().catch(e => {
6958
+ * console.error(e);
6959
+ * throw e;
6960
+ * });
6961
+ *
6962
+ * ```
5091
6963
  *
5092
6964
  * @param params - Parameters for request
5093
6965
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5184,6 +7056,84 @@ export namespace dataform_v1beta1 {
5184
7056
 
5185
7057
  /**
5186
7058
  * 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.*
7059
+ * @example
7060
+ * ```js
7061
+ * // Before running the sample:
7062
+ * // - Enable the API at:
7063
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
7064
+ * // - Login into gcloud by running:
7065
+ * // ```sh
7066
+ * // $ gcloud auth application-default login
7067
+ * // ```
7068
+ * // - Install the npm module by running:
7069
+ * // ```sh
7070
+ * // $ npm install googleapis
7071
+ * // ```
7072
+ *
7073
+ * const {google} = require('googleapis');
7074
+ * const dataform = google.dataform('v1beta1');
7075
+ *
7076
+ * async function main() {
7077
+ * const auth = new google.auth.GoogleAuth({
7078
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
7079
+ * scopes: [
7080
+ * 'https://www.googleapis.com/auth/bigquery',
7081
+ * 'https://www.googleapis.com/auth/cloud-platform',
7082
+ * ],
7083
+ * });
7084
+ *
7085
+ * // Acquire an auth client, and bind it to all future calls
7086
+ * const authClient = await auth.getClient();
7087
+ * google.options({auth: authClient});
7088
+ *
7089
+ * // Do the magic
7090
+ * const res =
7091
+ * await dataform.projects.locations.repositories.workflowConfigs.patch({
7092
+ * // Identifier. The workflow config's name.
7093
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workflowConfigs/my-workflowConfig',
7094
+ * // Optional. Specifies the fields to be updated in the workflow config. If left unset, all fields will be updated.
7095
+ * updateMask: 'placeholder-value',
7096
+ *
7097
+ * // Request body metadata
7098
+ * requestBody: {
7099
+ * // request body parameters
7100
+ * // {
7101
+ * // "createTime": "my_createTime",
7102
+ * // "cronSchedule": "my_cronSchedule",
7103
+ * // "disabled": false,
7104
+ * // "internalMetadata": "my_internalMetadata",
7105
+ * // "invocationConfig": {},
7106
+ * // "name": "my_name",
7107
+ * // "recentScheduledExecutionRecords": [],
7108
+ * // "releaseConfig": "my_releaseConfig",
7109
+ * // "timeZone": "my_timeZone",
7110
+ * // "updateTime": "my_updateTime"
7111
+ * // }
7112
+ * },
7113
+ * });
7114
+ * console.log(res.data);
7115
+ *
7116
+ * // Example response
7117
+ * // {
7118
+ * // "createTime": "my_createTime",
7119
+ * // "cronSchedule": "my_cronSchedule",
7120
+ * // "disabled": false,
7121
+ * // "internalMetadata": "my_internalMetadata",
7122
+ * // "invocationConfig": {},
7123
+ * // "name": "my_name",
7124
+ * // "recentScheduledExecutionRecords": [],
7125
+ * // "releaseConfig": "my_releaseConfig",
7126
+ * // "timeZone": "my_timeZone",
7127
+ * // "updateTime": "my_updateTime"
7128
+ * // }
7129
+ * }
7130
+ *
7131
+ * main().catch(e => {
7132
+ * console.error(e);
7133
+ * throw e;
7134
+ * });
7135
+ *
7136
+ * ```
5187
7137
  *
5188
7138
  * @param params - Parameters for request
5189
7139
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5342,6 +7292,60 @@ export namespace dataform_v1beta1 {
5342
7292
 
5343
7293
  /**
5344
7294
  * Requests cancellation of a running WorkflowInvocation.
7295
+ * @example
7296
+ * ```js
7297
+ * // Before running the sample:
7298
+ * // - Enable the API at:
7299
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
7300
+ * // - Login into gcloud by running:
7301
+ * // ```sh
7302
+ * // $ gcloud auth application-default login
7303
+ * // ```
7304
+ * // - Install the npm module by running:
7305
+ * // ```sh
7306
+ * // $ npm install googleapis
7307
+ * // ```
7308
+ *
7309
+ * const {google} = require('googleapis');
7310
+ * const dataform = google.dataform('v1beta1');
7311
+ *
7312
+ * async function main() {
7313
+ * const auth = new google.auth.GoogleAuth({
7314
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
7315
+ * scopes: [
7316
+ * 'https://www.googleapis.com/auth/bigquery',
7317
+ * 'https://www.googleapis.com/auth/cloud-platform',
7318
+ * ],
7319
+ * });
7320
+ *
7321
+ * // Acquire an auth client, and bind it to all future calls
7322
+ * const authClient = await auth.getClient();
7323
+ * google.options({auth: authClient});
7324
+ *
7325
+ * // Do the magic
7326
+ * const res =
7327
+ * await dataform.projects.locations.repositories.workflowInvocations.cancel({
7328
+ * // Required. The workflow invocation resource's name.
7329
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workflowInvocations/my-workflowInvocation',
7330
+ *
7331
+ * // Request body metadata
7332
+ * requestBody: {
7333
+ * // request body parameters
7334
+ * // {}
7335
+ * },
7336
+ * });
7337
+ * console.log(res.data);
7338
+ *
7339
+ * // Example response
7340
+ * // {}
7341
+ * }
7342
+ *
7343
+ * main().catch(e => {
7344
+ * console.error(e);
7345
+ * throw e;
7346
+ * });
7347
+ *
7348
+ * ```
5345
7349
  *
5346
7350
  * @param params - Parameters for request
5347
7351
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5444,6 +7448,81 @@ export namespace dataform_v1beta1 {
5444
7448
 
5445
7449
  /**
5446
7450
  * Creates a new WorkflowInvocation in a given Repository.
7451
+ * @example
7452
+ * ```js
7453
+ * // Before running the sample:
7454
+ * // - Enable the API at:
7455
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
7456
+ * // - Login into gcloud by running:
7457
+ * // ```sh
7458
+ * // $ gcloud auth application-default login
7459
+ * // ```
7460
+ * // - Install the npm module by running:
7461
+ * // ```sh
7462
+ * // $ npm install googleapis
7463
+ * // ```
7464
+ *
7465
+ * const {google} = require('googleapis');
7466
+ * const dataform = google.dataform('v1beta1');
7467
+ *
7468
+ * async function main() {
7469
+ * const auth = new google.auth.GoogleAuth({
7470
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
7471
+ * scopes: [
7472
+ * 'https://www.googleapis.com/auth/bigquery',
7473
+ * 'https://www.googleapis.com/auth/cloud-platform',
7474
+ * ],
7475
+ * });
7476
+ *
7477
+ * // Acquire an auth client, and bind it to all future calls
7478
+ * const authClient = await auth.getClient();
7479
+ * google.options({auth: authClient});
7480
+ *
7481
+ * // Do the magic
7482
+ * const res =
7483
+ * await dataform.projects.locations.repositories.workflowInvocations.create({
7484
+ * // Required. The repository in which to create the workflow invocation. Must be in the format `projects/x/locations/x/repositories/x`.
7485
+ * parent:
7486
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie',
7487
+ *
7488
+ * // Request body metadata
7489
+ * requestBody: {
7490
+ * // request body parameters
7491
+ * // {
7492
+ * // "compilationResult": "my_compilationResult",
7493
+ * // "dataEncryptionState": {},
7494
+ * // "internalMetadata": "my_internalMetadata",
7495
+ * // "invocationConfig": {},
7496
+ * // "invocationTiming": {},
7497
+ * // "name": "my_name",
7498
+ * // "resolvedCompilationResult": "my_resolvedCompilationResult",
7499
+ * // "state": "my_state",
7500
+ * // "workflowConfig": "my_workflowConfig"
7501
+ * // }
7502
+ * },
7503
+ * });
7504
+ * console.log(res.data);
7505
+ *
7506
+ * // Example response
7507
+ * // {
7508
+ * // "compilationResult": "my_compilationResult",
7509
+ * // "dataEncryptionState": {},
7510
+ * // "internalMetadata": "my_internalMetadata",
7511
+ * // "invocationConfig": {},
7512
+ * // "invocationTiming": {},
7513
+ * // "name": "my_name",
7514
+ * // "resolvedCompilationResult": "my_resolvedCompilationResult",
7515
+ * // "state": "my_state",
7516
+ * // "workflowConfig": "my_workflowConfig"
7517
+ * // }
7518
+ * }
7519
+ *
7520
+ * main().catch(e => {
7521
+ * console.error(e);
7522
+ * throw e;
7523
+ * });
7524
+ *
7525
+ * ```
5447
7526
  *
5448
7527
  * @param params - Parameters for request
5449
7528
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5536,6 +7615,54 @@ export namespace dataform_v1beta1 {
5536
7615
 
5537
7616
  /**
5538
7617
  * Deletes a single WorkflowInvocation.
7618
+ * @example
7619
+ * ```js
7620
+ * // Before running the sample:
7621
+ * // - Enable the API at:
7622
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
7623
+ * // - Login into gcloud by running:
7624
+ * // ```sh
7625
+ * // $ gcloud auth application-default login
7626
+ * // ```
7627
+ * // - Install the npm module by running:
7628
+ * // ```sh
7629
+ * // $ npm install googleapis
7630
+ * // ```
7631
+ *
7632
+ * const {google} = require('googleapis');
7633
+ * const dataform = google.dataform('v1beta1');
7634
+ *
7635
+ * async function main() {
7636
+ * const auth = new google.auth.GoogleAuth({
7637
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
7638
+ * scopes: [
7639
+ * 'https://www.googleapis.com/auth/bigquery',
7640
+ * 'https://www.googleapis.com/auth/cloud-platform',
7641
+ * ],
7642
+ * });
7643
+ *
7644
+ * // Acquire an auth client, and bind it to all future calls
7645
+ * const authClient = await auth.getClient();
7646
+ * google.options({auth: authClient});
7647
+ *
7648
+ * // Do the magic
7649
+ * const res =
7650
+ * await dataform.projects.locations.repositories.workflowInvocations.delete({
7651
+ * // Required. The workflow invocation resource's name.
7652
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workflowInvocations/my-workflowInvocation',
7653
+ * });
7654
+ * console.log(res.data);
7655
+ *
7656
+ * // Example response
7657
+ * // {}
7658
+ * }
7659
+ *
7660
+ * main().catch(e => {
7661
+ * console.error(e);
7662
+ * throw e;
7663
+ * });
7664
+ *
7665
+ * ```
5539
7666
  *
5540
7667
  * @param params - Parameters for request
5541
7668
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5625,6 +7752,64 @@ export namespace dataform_v1beta1 {
5625
7752
 
5626
7753
  /**
5627
7754
  * Fetches a single WorkflowInvocation.
7755
+ * @example
7756
+ * ```js
7757
+ * // Before running the sample:
7758
+ * // - Enable the API at:
7759
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
7760
+ * // - Login into gcloud by running:
7761
+ * // ```sh
7762
+ * // $ gcloud auth application-default login
7763
+ * // ```
7764
+ * // - Install the npm module by running:
7765
+ * // ```sh
7766
+ * // $ npm install googleapis
7767
+ * // ```
7768
+ *
7769
+ * const {google} = require('googleapis');
7770
+ * const dataform = google.dataform('v1beta1');
7771
+ *
7772
+ * async function main() {
7773
+ * const auth = new google.auth.GoogleAuth({
7774
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
7775
+ * scopes: [
7776
+ * 'https://www.googleapis.com/auth/bigquery',
7777
+ * 'https://www.googleapis.com/auth/cloud-platform',
7778
+ * ],
7779
+ * });
7780
+ *
7781
+ * // Acquire an auth client, and bind it to all future calls
7782
+ * const authClient = await auth.getClient();
7783
+ * google.options({auth: authClient});
7784
+ *
7785
+ * // Do the magic
7786
+ * const res =
7787
+ * await dataform.projects.locations.repositories.workflowInvocations.get({
7788
+ * // Required. The workflow invocation resource's name.
7789
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workflowInvocations/my-workflowInvocation',
7790
+ * });
7791
+ * console.log(res.data);
7792
+ *
7793
+ * // Example response
7794
+ * // {
7795
+ * // "compilationResult": "my_compilationResult",
7796
+ * // "dataEncryptionState": {},
7797
+ * // "internalMetadata": "my_internalMetadata",
7798
+ * // "invocationConfig": {},
7799
+ * // "invocationTiming": {},
7800
+ * // "name": "my_name",
7801
+ * // "resolvedCompilationResult": "my_resolvedCompilationResult",
7802
+ * // "state": "my_state",
7803
+ * // "workflowConfig": "my_workflowConfig"
7804
+ * // }
7805
+ * }
7806
+ *
7807
+ * main().catch(e => {
7808
+ * console.error(e);
7809
+ * throw e;
7810
+ * });
7811
+ *
7812
+ * ```
5628
7813
  *
5629
7814
  * @param params - Parameters for request
5630
7815
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5714,6 +7899,67 @@ export namespace dataform_v1beta1 {
5714
7899
 
5715
7900
  /**
5716
7901
  * Lists WorkflowInvocations in a given Repository.
7902
+ * @example
7903
+ * ```js
7904
+ * // Before running the sample:
7905
+ * // - Enable the API at:
7906
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
7907
+ * // - Login into gcloud by running:
7908
+ * // ```sh
7909
+ * // $ gcloud auth application-default login
7910
+ * // ```
7911
+ * // - Install the npm module by running:
7912
+ * // ```sh
7913
+ * // $ npm install googleapis
7914
+ * // ```
7915
+ *
7916
+ * const {google} = require('googleapis');
7917
+ * const dataform = google.dataform('v1beta1');
7918
+ *
7919
+ * async function main() {
7920
+ * const auth = new google.auth.GoogleAuth({
7921
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
7922
+ * scopes: [
7923
+ * 'https://www.googleapis.com/auth/bigquery',
7924
+ * 'https://www.googleapis.com/auth/cloud-platform',
7925
+ * ],
7926
+ * });
7927
+ *
7928
+ * // Acquire an auth client, and bind it to all future calls
7929
+ * const authClient = await auth.getClient();
7930
+ * google.options({auth: authClient});
7931
+ *
7932
+ * // Do the magic
7933
+ * const res =
7934
+ * await dataform.projects.locations.repositories.workflowInvocations.list({
7935
+ * // Optional. Filter for the returned list.
7936
+ * filter: 'placeholder-value',
7937
+ * // 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.
7938
+ * orderBy: 'placeholder-value',
7939
+ * // 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.
7940
+ * pageSize: 'placeholder-value',
7941
+ * // 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.
7942
+ * pageToken: 'placeholder-value',
7943
+ * // Required. The parent resource of the WorkflowInvocation type. Must be in the format `projects/x/locations/x/repositories/x`.
7944
+ * parent:
7945
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie',
7946
+ * });
7947
+ * console.log(res.data);
7948
+ *
7949
+ * // Example response
7950
+ * // {
7951
+ * // "nextPageToken": "my_nextPageToken",
7952
+ * // "unreachable": [],
7953
+ * // "workflowInvocations": []
7954
+ * // }
7955
+ * }
7956
+ *
7957
+ * main().catch(e => {
7958
+ * console.error(e);
7959
+ * throw e;
7960
+ * });
7961
+ *
7962
+ * ```
5717
7963
  *
5718
7964
  * @param params - Parameters for request
5719
7965
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5812,6 +8058,61 @@ export namespace dataform_v1beta1 {
5812
8058
 
5813
8059
  /**
5814
8060
  * Returns WorkflowInvocationActions in a given WorkflowInvocation.
8061
+ * @example
8062
+ * ```js
8063
+ * // Before running the sample:
8064
+ * // - Enable the API at:
8065
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
8066
+ * // - Login into gcloud by running:
8067
+ * // ```sh
8068
+ * // $ gcloud auth application-default login
8069
+ * // ```
8070
+ * // - Install the npm module by running:
8071
+ * // ```sh
8072
+ * // $ npm install googleapis
8073
+ * // ```
8074
+ *
8075
+ * const {google} = require('googleapis');
8076
+ * const dataform = google.dataform('v1beta1');
8077
+ *
8078
+ * async function main() {
8079
+ * const auth = new google.auth.GoogleAuth({
8080
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
8081
+ * scopes: [
8082
+ * 'https://www.googleapis.com/auth/bigquery',
8083
+ * 'https://www.googleapis.com/auth/cloud-platform',
8084
+ * ],
8085
+ * });
8086
+ *
8087
+ * // Acquire an auth client, and bind it to all future calls
8088
+ * const authClient = await auth.getClient();
8089
+ * google.options({auth: authClient});
8090
+ *
8091
+ * // Do the magic
8092
+ * const res =
8093
+ * await dataform.projects.locations.repositories.workflowInvocations.query({
8094
+ * // Required. The workflow invocation's name.
8095
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workflowInvocations/my-workflowInvocation',
8096
+ * // 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.
8097
+ * pageSize: 'placeholder-value',
8098
+ * // 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.
8099
+ * pageToken: 'placeholder-value',
8100
+ * });
8101
+ * console.log(res.data);
8102
+ *
8103
+ * // Example response
8104
+ * // {
8105
+ * // "nextPageToken": "my_nextPageToken",
8106
+ * // "workflowInvocationActions": []
8107
+ * // }
8108
+ * }
8109
+ *
8110
+ * main().catch(e => {
8111
+ * console.error(e);
8112
+ * throw e;
8113
+ * });
8114
+ *
8115
+ * ```
5815
8116
  *
5816
8117
  * @param params - Parameters for request
5817
8118
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5998,6 +8299,63 @@ export namespace dataform_v1beta1 {
5998
8299
 
5999
8300
  /**
6000
8301
  * Applies a Git commit for uncommitted files in a Workspace.
8302
+ * @example
8303
+ * ```js
8304
+ * // Before running the sample:
8305
+ * // - Enable the API at:
8306
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
8307
+ * // - Login into gcloud by running:
8308
+ * // ```sh
8309
+ * // $ gcloud auth application-default login
8310
+ * // ```
8311
+ * // - Install the npm module by running:
8312
+ * // ```sh
8313
+ * // $ npm install googleapis
8314
+ * // ```
8315
+ *
8316
+ * const {google} = require('googleapis');
8317
+ * const dataform = google.dataform('v1beta1');
8318
+ *
8319
+ * async function main() {
8320
+ * const auth = new google.auth.GoogleAuth({
8321
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
8322
+ * scopes: [
8323
+ * 'https://www.googleapis.com/auth/bigquery',
8324
+ * 'https://www.googleapis.com/auth/cloud-platform',
8325
+ * ],
8326
+ * });
8327
+ *
8328
+ * // Acquire an auth client, and bind it to all future calls
8329
+ * const authClient = await auth.getClient();
8330
+ * google.options({auth: authClient});
8331
+ *
8332
+ * // Do the magic
8333
+ * const res = await dataform.projects.locations.repositories.workspaces.commit({
8334
+ * // Required. The workspace's name.
8335
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
8336
+ *
8337
+ * // Request body metadata
8338
+ * requestBody: {
8339
+ * // request body parameters
8340
+ * // {
8341
+ * // "author": {},
8342
+ * // "commitMessage": "my_commitMessage",
8343
+ * // "paths": []
8344
+ * // }
8345
+ * },
8346
+ * });
8347
+ * console.log(res.data);
8348
+ *
8349
+ * // Example response
8350
+ * // {}
8351
+ * }
8352
+ *
8353
+ * main().catch(e => {
8354
+ * console.error(e);
8355
+ * throw e;
8356
+ * });
8357
+ *
8358
+ * ```
6001
8359
  *
6002
8360
  * @param params - Parameters for request
6003
8361
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6096,6 +8454,72 @@ export namespace dataform_v1beta1 {
6096
8454
 
6097
8455
  /**
6098
8456
  * Creates a new Workspace in a given Repository.
8457
+ * @example
8458
+ * ```js
8459
+ * // Before running the sample:
8460
+ * // - Enable the API at:
8461
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
8462
+ * // - Login into gcloud by running:
8463
+ * // ```sh
8464
+ * // $ gcloud auth application-default login
8465
+ * // ```
8466
+ * // - Install the npm module by running:
8467
+ * // ```sh
8468
+ * // $ npm install googleapis
8469
+ * // ```
8470
+ *
8471
+ * const {google} = require('googleapis');
8472
+ * const dataform = google.dataform('v1beta1');
8473
+ *
8474
+ * async function main() {
8475
+ * const auth = new google.auth.GoogleAuth({
8476
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
8477
+ * scopes: [
8478
+ * 'https://www.googleapis.com/auth/bigquery',
8479
+ * 'https://www.googleapis.com/auth/cloud-platform',
8480
+ * ],
8481
+ * });
8482
+ *
8483
+ * // Acquire an auth client, and bind it to all future calls
8484
+ * const authClient = await auth.getClient();
8485
+ * google.options({auth: authClient});
8486
+ *
8487
+ * // Do the magic
8488
+ * const res = await dataform.projects.locations.repositories.workspaces.create({
8489
+ * // Required. The repository in which to create the workspace. Must be in the format `projects/x/locations/x/repositories/x`.
8490
+ * parent:
8491
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie',
8492
+ * // Required. The ID to use for the workspace, which will become the final component of the workspace's resource name.
8493
+ * workspaceId: 'placeholder-value',
8494
+ *
8495
+ * // Request body metadata
8496
+ * requestBody: {
8497
+ * // request body parameters
8498
+ * // {
8499
+ * // "createTime": "my_createTime",
8500
+ * // "dataEncryptionState": {},
8501
+ * // "internalMetadata": "my_internalMetadata",
8502
+ * // "name": "my_name"
8503
+ * // }
8504
+ * },
8505
+ * });
8506
+ * console.log(res.data);
8507
+ *
8508
+ * // Example response
8509
+ * // {
8510
+ * // "createTime": "my_createTime",
8511
+ * // "dataEncryptionState": {},
8512
+ * // "internalMetadata": "my_internalMetadata",
8513
+ * // "name": "my_name"
8514
+ * // }
8515
+ * }
8516
+ *
8517
+ * main().catch(e => {
8518
+ * console.error(e);
8519
+ * throw e;
8520
+ * });
8521
+ *
8522
+ * ```
6099
8523
  *
6100
8524
  * @param params - Parameters for request
6101
8525
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6188,6 +8612,53 @@ export namespace dataform_v1beta1 {
6188
8612
 
6189
8613
  /**
6190
8614
  * Deletes a single Workspace.
8615
+ * @example
8616
+ * ```js
8617
+ * // Before running the sample:
8618
+ * // - Enable the API at:
8619
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
8620
+ * // - Login into gcloud by running:
8621
+ * // ```sh
8622
+ * // $ gcloud auth application-default login
8623
+ * // ```
8624
+ * // - Install the npm module by running:
8625
+ * // ```sh
8626
+ * // $ npm install googleapis
8627
+ * // ```
8628
+ *
8629
+ * const {google} = require('googleapis');
8630
+ * const dataform = google.dataform('v1beta1');
8631
+ *
8632
+ * async function main() {
8633
+ * const auth = new google.auth.GoogleAuth({
8634
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
8635
+ * scopes: [
8636
+ * 'https://www.googleapis.com/auth/bigquery',
8637
+ * 'https://www.googleapis.com/auth/cloud-platform',
8638
+ * ],
8639
+ * });
8640
+ *
8641
+ * // Acquire an auth client, and bind it to all future calls
8642
+ * const authClient = await auth.getClient();
8643
+ * google.options({auth: authClient});
8644
+ *
8645
+ * // Do the magic
8646
+ * const res = await dataform.projects.locations.repositories.workspaces.delete({
8647
+ * // Required. The workspace resource's name.
8648
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
8649
+ * });
8650
+ * console.log(res.data);
8651
+ *
8652
+ * // Example response
8653
+ * // {}
8654
+ * }
8655
+ *
8656
+ * main().catch(e => {
8657
+ * console.error(e);
8658
+ * throw e;
8659
+ * });
8660
+ *
8661
+ * ```
6191
8662
  *
6192
8663
  * @param params - Parameters for request
6193
8664
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6277,6 +8748,59 @@ export namespace dataform_v1beta1 {
6277
8748
 
6278
8749
  /**
6279
8750
  * Fetches Git diff for an uncommitted file in a Workspace.
8751
+ * @example
8752
+ * ```js
8753
+ * // Before running the sample:
8754
+ * // - Enable the API at:
8755
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
8756
+ * // - Login into gcloud by running:
8757
+ * // ```sh
8758
+ * // $ gcloud auth application-default login
8759
+ * // ```
8760
+ * // - Install the npm module by running:
8761
+ * // ```sh
8762
+ * // $ npm install googleapis
8763
+ * // ```
8764
+ *
8765
+ * const {google} = require('googleapis');
8766
+ * const dataform = google.dataform('v1beta1');
8767
+ *
8768
+ * async function main() {
8769
+ * const auth = new google.auth.GoogleAuth({
8770
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
8771
+ * scopes: [
8772
+ * 'https://www.googleapis.com/auth/bigquery',
8773
+ * 'https://www.googleapis.com/auth/cloud-platform',
8774
+ * ],
8775
+ * });
8776
+ *
8777
+ * // Acquire an auth client, and bind it to all future calls
8778
+ * const authClient = await auth.getClient();
8779
+ * google.options({auth: authClient});
8780
+ *
8781
+ * // Do the magic
8782
+ * const res =
8783
+ * await dataform.projects.locations.repositories.workspaces.fetchFileDiff({
8784
+ * // Required. The file's full path including filename, relative to the workspace root.
8785
+ * path: 'placeholder-value',
8786
+ * // Required. The workspace's name.
8787
+ * workspace:
8788
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
8789
+ * });
8790
+ * console.log(res.data);
8791
+ *
8792
+ * // Example response
8793
+ * // {
8794
+ * // "formattedDiff": "my_formattedDiff"
8795
+ * // }
8796
+ * }
8797
+ *
8798
+ * main().catch(e => {
8799
+ * console.error(e);
8800
+ * throw e;
8801
+ * });
8802
+ *
8803
+ * ```
6280
8804
  *
6281
8805
  * @param params - Parameters for request
6282
8806
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6373,6 +8897,58 @@ export namespace dataform_v1beta1 {
6373
8897
 
6374
8898
  /**
6375
8899
  * Fetches Git statuses for the files in a Workspace.
8900
+ * @example
8901
+ * ```js
8902
+ * // Before running the sample:
8903
+ * // - Enable the API at:
8904
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
8905
+ * // - Login into gcloud by running:
8906
+ * // ```sh
8907
+ * // $ gcloud auth application-default login
8908
+ * // ```
8909
+ * // - Install the npm module by running:
8910
+ * // ```sh
8911
+ * // $ npm install googleapis
8912
+ * // ```
8913
+ *
8914
+ * const {google} = require('googleapis');
8915
+ * const dataform = google.dataform('v1beta1');
8916
+ *
8917
+ * async function main() {
8918
+ * const auth = new google.auth.GoogleAuth({
8919
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
8920
+ * scopes: [
8921
+ * 'https://www.googleapis.com/auth/bigquery',
8922
+ * 'https://www.googleapis.com/auth/cloud-platform',
8923
+ * ],
8924
+ * });
8925
+ *
8926
+ * // Acquire an auth client, and bind it to all future calls
8927
+ * const authClient = await auth.getClient();
8928
+ * google.options({auth: authClient});
8929
+ *
8930
+ * // Do the magic
8931
+ * const res =
8932
+ * await dataform.projects.locations.repositories.workspaces.fetchFileGitStatuses(
8933
+ * {
8934
+ * // Required. The workspace's name.
8935
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
8936
+ * },
8937
+ * );
8938
+ * console.log(res.data);
8939
+ *
8940
+ * // Example response
8941
+ * // {
8942
+ * // "uncommittedFileChanges": []
8943
+ * // }
8944
+ * }
8945
+ *
8946
+ * main().catch(e => {
8947
+ * console.error(e);
8948
+ * throw e;
8949
+ * });
8950
+ *
8951
+ * ```
6376
8952
  *
6377
8953
  * @param params - Parameters for request
6378
8954
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6471,6 +9047,61 @@ export namespace dataform_v1beta1 {
6471
9047
 
6472
9048
  /**
6473
9049
  * Fetches Git ahead/behind against a remote branch.
9050
+ * @example
9051
+ * ```js
9052
+ * // Before running the sample:
9053
+ * // - Enable the API at:
9054
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
9055
+ * // - Login into gcloud by running:
9056
+ * // ```sh
9057
+ * // $ gcloud auth application-default login
9058
+ * // ```
9059
+ * // - Install the npm module by running:
9060
+ * // ```sh
9061
+ * // $ npm install googleapis
9062
+ * // ```
9063
+ *
9064
+ * const {google} = require('googleapis');
9065
+ * const dataform = google.dataform('v1beta1');
9066
+ *
9067
+ * async function main() {
9068
+ * const auth = new google.auth.GoogleAuth({
9069
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
9070
+ * scopes: [
9071
+ * 'https://www.googleapis.com/auth/bigquery',
9072
+ * 'https://www.googleapis.com/auth/cloud-platform',
9073
+ * ],
9074
+ * });
9075
+ *
9076
+ * // Acquire an auth client, and bind it to all future calls
9077
+ * const authClient = await auth.getClient();
9078
+ * google.options({auth: authClient});
9079
+ *
9080
+ * // Do the magic
9081
+ * const res =
9082
+ * await dataform.projects.locations.repositories.workspaces.fetchGitAheadBehind(
9083
+ * {
9084
+ * // Required. The workspace's name.
9085
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
9086
+ * // 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.
9087
+ * remoteBranch: 'placeholder-value',
9088
+ * },
9089
+ * );
9090
+ * console.log(res.data);
9091
+ *
9092
+ * // Example response
9093
+ * // {
9094
+ * // "commitsAhead": 0,
9095
+ * // "commitsBehind": 0
9096
+ * // }
9097
+ * }
9098
+ *
9099
+ * main().catch(e => {
9100
+ * console.error(e);
9101
+ * throw e;
9102
+ * });
9103
+ *
9104
+ * ```
6474
9105
  *
6475
9106
  * @param params - Parameters for request
6476
9107
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6567,6 +9198,58 @@ export namespace dataform_v1beta1 {
6567
9198
 
6568
9199
  /**
6569
9200
  * Fetches a single Workspace.
9201
+ * @example
9202
+ * ```js
9203
+ * // Before running the sample:
9204
+ * // - Enable the API at:
9205
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
9206
+ * // - Login into gcloud by running:
9207
+ * // ```sh
9208
+ * // $ gcloud auth application-default login
9209
+ * // ```
9210
+ * // - Install the npm module by running:
9211
+ * // ```sh
9212
+ * // $ npm install googleapis
9213
+ * // ```
9214
+ *
9215
+ * const {google} = require('googleapis');
9216
+ * const dataform = google.dataform('v1beta1');
9217
+ *
9218
+ * async function main() {
9219
+ * const auth = new google.auth.GoogleAuth({
9220
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
9221
+ * scopes: [
9222
+ * 'https://www.googleapis.com/auth/bigquery',
9223
+ * 'https://www.googleapis.com/auth/cloud-platform',
9224
+ * ],
9225
+ * });
9226
+ *
9227
+ * // Acquire an auth client, and bind it to all future calls
9228
+ * const authClient = await auth.getClient();
9229
+ * google.options({auth: authClient});
9230
+ *
9231
+ * // Do the magic
9232
+ * const res = await dataform.projects.locations.repositories.workspaces.get({
9233
+ * // Required. The workspace's name.
9234
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
9235
+ * });
9236
+ * console.log(res.data);
9237
+ *
9238
+ * // Example response
9239
+ * // {
9240
+ * // "createTime": "my_createTime",
9241
+ * // "dataEncryptionState": {},
9242
+ * // "internalMetadata": "my_internalMetadata",
9243
+ * // "name": "my_name"
9244
+ * // }
9245
+ * }
9246
+ *
9247
+ * main().catch(e => {
9248
+ * console.error(e);
9249
+ * throw e;
9250
+ * });
9251
+ *
9252
+ * ```
6570
9253
  *
6571
9254
  * @param params - Parameters for request
6572
9255
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6656,6 +9339,61 @@ export namespace dataform_v1beta1 {
6656
9339
 
6657
9340
  /**
6658
9341
  * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
9342
+ * @example
9343
+ * ```js
9344
+ * // Before running the sample:
9345
+ * // - Enable the API at:
9346
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
9347
+ * // - Login into gcloud by running:
9348
+ * // ```sh
9349
+ * // $ gcloud auth application-default login
9350
+ * // ```
9351
+ * // - Install the npm module by running:
9352
+ * // ```sh
9353
+ * // $ npm install googleapis
9354
+ * // ```
9355
+ *
9356
+ * const {google} = require('googleapis');
9357
+ * const dataform = google.dataform('v1beta1');
9358
+ *
9359
+ * async function main() {
9360
+ * const auth = new google.auth.GoogleAuth({
9361
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
9362
+ * scopes: [
9363
+ * 'https://www.googleapis.com/auth/bigquery',
9364
+ * 'https://www.googleapis.com/auth/cloud-platform',
9365
+ * ],
9366
+ * });
9367
+ *
9368
+ * // Acquire an auth client, and bind it to all future calls
9369
+ * const authClient = await auth.getClient();
9370
+ * google.options({auth: authClient});
9371
+ *
9372
+ * // Do the magic
9373
+ * const res =
9374
+ * await dataform.projects.locations.repositories.workspaces.getIamPolicy({
9375
+ * // 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).
9376
+ * 'options.requestedPolicyVersion': 'placeholder-value',
9377
+ * // 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.
9378
+ * resource:
9379
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
9380
+ * });
9381
+ * console.log(res.data);
9382
+ *
9383
+ * // Example response
9384
+ * // {
9385
+ * // "bindings": [],
9386
+ * // "etag": "my_etag",
9387
+ * // "version": 0
9388
+ * // }
9389
+ * }
9390
+ *
9391
+ * main().catch(e => {
9392
+ * console.error(e);
9393
+ * throw e;
9394
+ * });
9395
+ *
9396
+ * ```
6659
9397
  *
6660
9398
  * @param params - Parameters for request
6661
9399
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6748,6 +9486,63 @@ export namespace dataform_v1beta1 {
6748
9486
 
6749
9487
  /**
6750
9488
  * Installs dependency NPM packages (inside a Workspace).
9489
+ * @example
9490
+ * ```js
9491
+ * // Before running the sample:
9492
+ * // - Enable the API at:
9493
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
9494
+ * // - Login into gcloud by running:
9495
+ * // ```sh
9496
+ * // $ gcloud auth application-default login
9497
+ * // ```
9498
+ * // - Install the npm module by running:
9499
+ * // ```sh
9500
+ * // $ npm install googleapis
9501
+ * // ```
9502
+ *
9503
+ * const {google} = require('googleapis');
9504
+ * const dataform = google.dataform('v1beta1');
9505
+ *
9506
+ * async function main() {
9507
+ * const auth = new google.auth.GoogleAuth({
9508
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
9509
+ * scopes: [
9510
+ * 'https://www.googleapis.com/auth/bigquery',
9511
+ * 'https://www.googleapis.com/auth/cloud-platform',
9512
+ * ],
9513
+ * });
9514
+ *
9515
+ * // Acquire an auth client, and bind it to all future calls
9516
+ * const authClient = await auth.getClient();
9517
+ * google.options({auth: authClient});
9518
+ *
9519
+ * // Do the magic
9520
+ * const res =
9521
+ * await dataform.projects.locations.repositories.workspaces.installNpmPackages(
9522
+ * {
9523
+ * // Required. The workspace's name.
9524
+ * workspace:
9525
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
9526
+ *
9527
+ * // Request body metadata
9528
+ * requestBody: {
9529
+ * // request body parameters
9530
+ * // {}
9531
+ * },
9532
+ * },
9533
+ * );
9534
+ * console.log(res.data);
9535
+ *
9536
+ * // Example response
9537
+ * // {}
9538
+ * }
9539
+ *
9540
+ * main().catch(e => {
9541
+ * console.error(e);
9542
+ * throw e;
9543
+ * });
9544
+ *
9545
+ * ```
6751
9546
  *
6752
9547
  * @param params - Parameters for request
6753
9548
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6844,6 +9639,66 @@ export namespace dataform_v1beta1 {
6844
9639
 
6845
9640
  /**
6846
9641
  * Lists Workspaces in a given Repository.
9642
+ * @example
9643
+ * ```js
9644
+ * // Before running the sample:
9645
+ * // - Enable the API at:
9646
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
9647
+ * // - Login into gcloud by running:
9648
+ * // ```sh
9649
+ * // $ gcloud auth application-default login
9650
+ * // ```
9651
+ * // - Install the npm module by running:
9652
+ * // ```sh
9653
+ * // $ npm install googleapis
9654
+ * // ```
9655
+ *
9656
+ * const {google} = require('googleapis');
9657
+ * const dataform = google.dataform('v1beta1');
9658
+ *
9659
+ * async function main() {
9660
+ * const auth = new google.auth.GoogleAuth({
9661
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
9662
+ * scopes: [
9663
+ * 'https://www.googleapis.com/auth/bigquery',
9664
+ * 'https://www.googleapis.com/auth/cloud-platform',
9665
+ * ],
9666
+ * });
9667
+ *
9668
+ * // Acquire an auth client, and bind it to all future calls
9669
+ * const authClient = await auth.getClient();
9670
+ * google.options({auth: authClient});
9671
+ *
9672
+ * // Do the magic
9673
+ * const res = await dataform.projects.locations.repositories.workspaces.list({
9674
+ * // Optional. Filter for the returned list.
9675
+ * filter: 'placeholder-value',
9676
+ * // 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.
9677
+ * orderBy: 'placeholder-value',
9678
+ * // Optional. Maximum number of workspaces to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
9679
+ * pageSize: 'placeholder-value',
9680
+ * // 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.
9681
+ * pageToken: 'placeholder-value',
9682
+ * // Required. The repository in which to list workspaces. Must be in the format `projects/x/locations/x/repositories/x`.
9683
+ * parent:
9684
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie',
9685
+ * });
9686
+ * console.log(res.data);
9687
+ *
9688
+ * // Example response
9689
+ * // {
9690
+ * // "nextPageToken": "my_nextPageToken",
9691
+ * // "unreachable": [],
9692
+ * // "workspaces": []
9693
+ * // }
9694
+ * }
9695
+ *
9696
+ * main().catch(e => {
9697
+ * console.error(e);
9698
+ * throw e;
9699
+ * });
9700
+ *
9701
+ * ```
6847
9702
  *
6848
9703
  * @param params - Parameters for request
6849
9704
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6938,6 +9793,63 @@ export namespace dataform_v1beta1 {
6938
9793
 
6939
9794
  /**
6940
9795
  * Creates a directory inside a Workspace.
9796
+ * @example
9797
+ * ```js
9798
+ * // Before running the sample:
9799
+ * // - Enable the API at:
9800
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
9801
+ * // - Login into gcloud by running:
9802
+ * // ```sh
9803
+ * // $ gcloud auth application-default login
9804
+ * // ```
9805
+ * // - Install the npm module by running:
9806
+ * // ```sh
9807
+ * // $ npm install googleapis
9808
+ * // ```
9809
+ *
9810
+ * const {google} = require('googleapis');
9811
+ * const dataform = google.dataform('v1beta1');
9812
+ *
9813
+ * async function main() {
9814
+ * const auth = new google.auth.GoogleAuth({
9815
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
9816
+ * scopes: [
9817
+ * 'https://www.googleapis.com/auth/bigquery',
9818
+ * 'https://www.googleapis.com/auth/cloud-platform',
9819
+ * ],
9820
+ * });
9821
+ *
9822
+ * // Acquire an auth client, and bind it to all future calls
9823
+ * const authClient = await auth.getClient();
9824
+ * google.options({auth: authClient});
9825
+ *
9826
+ * // Do the magic
9827
+ * const res =
9828
+ * await dataform.projects.locations.repositories.workspaces.makeDirectory({
9829
+ * // Required. The workspace's name.
9830
+ * workspace:
9831
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
9832
+ *
9833
+ * // Request body metadata
9834
+ * requestBody: {
9835
+ * // request body parameters
9836
+ * // {
9837
+ * // "path": "my_path"
9838
+ * // }
9839
+ * },
9840
+ * });
9841
+ * console.log(res.data);
9842
+ *
9843
+ * // Example response
9844
+ * // {}
9845
+ * }
9846
+ *
9847
+ * main().catch(e => {
9848
+ * console.error(e);
9849
+ * throw e;
9850
+ * });
9851
+ *
9852
+ * ```
6941
9853
  *
6942
9854
  * @param params - Parameters for request
6943
9855
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -7034,6 +9946,64 @@ export namespace dataform_v1beta1 {
7034
9946
 
7035
9947
  /**
7036
9948
  * Moves a directory (inside a Workspace), and all of its contents, to a new location.
9949
+ * @example
9950
+ * ```js
9951
+ * // Before running the sample:
9952
+ * // - Enable the API at:
9953
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
9954
+ * // - Login into gcloud by running:
9955
+ * // ```sh
9956
+ * // $ gcloud auth application-default login
9957
+ * // ```
9958
+ * // - Install the npm module by running:
9959
+ * // ```sh
9960
+ * // $ npm install googleapis
9961
+ * // ```
9962
+ *
9963
+ * const {google} = require('googleapis');
9964
+ * const dataform = google.dataform('v1beta1');
9965
+ *
9966
+ * async function main() {
9967
+ * const auth = new google.auth.GoogleAuth({
9968
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
9969
+ * scopes: [
9970
+ * 'https://www.googleapis.com/auth/bigquery',
9971
+ * 'https://www.googleapis.com/auth/cloud-platform',
9972
+ * ],
9973
+ * });
9974
+ *
9975
+ * // Acquire an auth client, and bind it to all future calls
9976
+ * const authClient = await auth.getClient();
9977
+ * google.options({auth: authClient});
9978
+ *
9979
+ * // Do the magic
9980
+ * const res =
9981
+ * await dataform.projects.locations.repositories.workspaces.moveDirectory({
9982
+ * // Required. The workspace's name.
9983
+ * workspace:
9984
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
9985
+ *
9986
+ * // Request body metadata
9987
+ * requestBody: {
9988
+ * // request body parameters
9989
+ * // {
9990
+ * // "newPath": "my_newPath",
9991
+ * // "path": "my_path"
9992
+ * // }
9993
+ * },
9994
+ * });
9995
+ * console.log(res.data);
9996
+ *
9997
+ * // Example response
9998
+ * // {}
9999
+ * }
10000
+ *
10001
+ * main().catch(e => {
10002
+ * console.error(e);
10003
+ * throw e;
10004
+ * });
10005
+ *
10006
+ * ```
7037
10007
  *
7038
10008
  * @param params - Parameters for request
7039
10009
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -7130,6 +10100,64 @@ export namespace dataform_v1beta1 {
7130
10100
 
7131
10101
  /**
7132
10102
  * Moves a file (inside a Workspace) to a new location.
10103
+ * @example
10104
+ * ```js
10105
+ * // Before running the sample:
10106
+ * // - Enable the API at:
10107
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
10108
+ * // - Login into gcloud by running:
10109
+ * // ```sh
10110
+ * // $ gcloud auth application-default login
10111
+ * // ```
10112
+ * // - Install the npm module by running:
10113
+ * // ```sh
10114
+ * // $ npm install googleapis
10115
+ * // ```
10116
+ *
10117
+ * const {google} = require('googleapis');
10118
+ * const dataform = google.dataform('v1beta1');
10119
+ *
10120
+ * async function main() {
10121
+ * const auth = new google.auth.GoogleAuth({
10122
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
10123
+ * scopes: [
10124
+ * 'https://www.googleapis.com/auth/bigquery',
10125
+ * 'https://www.googleapis.com/auth/cloud-platform',
10126
+ * ],
10127
+ * });
10128
+ *
10129
+ * // Acquire an auth client, and bind it to all future calls
10130
+ * const authClient = await auth.getClient();
10131
+ * google.options({auth: authClient});
10132
+ *
10133
+ * // Do the magic
10134
+ * const res =
10135
+ * await dataform.projects.locations.repositories.workspaces.moveFile({
10136
+ * // Required. The workspace's name.
10137
+ * workspace:
10138
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
10139
+ *
10140
+ * // Request body metadata
10141
+ * requestBody: {
10142
+ * // request body parameters
10143
+ * // {
10144
+ * // "newPath": "my_newPath",
10145
+ * // "path": "my_path"
10146
+ * // }
10147
+ * },
10148
+ * });
10149
+ * console.log(res.data);
10150
+ *
10151
+ * // Example response
10152
+ * // {}
10153
+ * }
10154
+ *
10155
+ * main().catch(e => {
10156
+ * console.error(e);
10157
+ * throw e;
10158
+ * });
10159
+ *
10160
+ * ```
7133
10161
  *
7134
10162
  * @param params - Parameters for request
7135
10163
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -7222,6 +10250,62 @@ export namespace dataform_v1beta1 {
7222
10250
 
7223
10251
  /**
7224
10252
  * Pulls Git commits from the Repository's remote into a Workspace.
10253
+ * @example
10254
+ * ```js
10255
+ * // Before running the sample:
10256
+ * // - Enable the API at:
10257
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
10258
+ * // - Login into gcloud by running:
10259
+ * // ```sh
10260
+ * // $ gcloud auth application-default login
10261
+ * // ```
10262
+ * // - Install the npm module by running:
10263
+ * // ```sh
10264
+ * // $ npm install googleapis
10265
+ * // ```
10266
+ *
10267
+ * const {google} = require('googleapis');
10268
+ * const dataform = google.dataform('v1beta1');
10269
+ *
10270
+ * async function main() {
10271
+ * const auth = new google.auth.GoogleAuth({
10272
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
10273
+ * scopes: [
10274
+ * 'https://www.googleapis.com/auth/bigquery',
10275
+ * 'https://www.googleapis.com/auth/cloud-platform',
10276
+ * ],
10277
+ * });
10278
+ *
10279
+ * // Acquire an auth client, and bind it to all future calls
10280
+ * const authClient = await auth.getClient();
10281
+ * google.options({auth: authClient});
10282
+ *
10283
+ * // Do the magic
10284
+ * const res = await dataform.projects.locations.repositories.workspaces.pull({
10285
+ * // Required. The workspace's name.
10286
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
10287
+ *
10288
+ * // Request body metadata
10289
+ * requestBody: {
10290
+ * // request body parameters
10291
+ * // {
10292
+ * // "author": {},
10293
+ * // "remoteBranch": "my_remoteBranch"
10294
+ * // }
10295
+ * },
10296
+ * });
10297
+ * console.log(res.data);
10298
+ *
10299
+ * // Example response
10300
+ * // {}
10301
+ * }
10302
+ *
10303
+ * main().catch(e => {
10304
+ * console.error(e);
10305
+ * throw e;
10306
+ * });
10307
+ *
10308
+ * ```
7225
10309
  *
7226
10310
  * @param params - Parameters for request
7227
10311
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -7316,6 +10400,61 @@ export namespace dataform_v1beta1 {
7316
10400
 
7317
10401
  /**
7318
10402
  * Pushes Git commits from a Workspace to the Repository's remote.
10403
+ * @example
10404
+ * ```js
10405
+ * // Before running the sample:
10406
+ * // - Enable the API at:
10407
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
10408
+ * // - Login into gcloud by running:
10409
+ * // ```sh
10410
+ * // $ gcloud auth application-default login
10411
+ * // ```
10412
+ * // - Install the npm module by running:
10413
+ * // ```sh
10414
+ * // $ npm install googleapis
10415
+ * // ```
10416
+ *
10417
+ * const {google} = require('googleapis');
10418
+ * const dataform = google.dataform('v1beta1');
10419
+ *
10420
+ * async function main() {
10421
+ * const auth = new google.auth.GoogleAuth({
10422
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
10423
+ * scopes: [
10424
+ * 'https://www.googleapis.com/auth/bigquery',
10425
+ * 'https://www.googleapis.com/auth/cloud-platform',
10426
+ * ],
10427
+ * });
10428
+ *
10429
+ * // Acquire an auth client, and bind it to all future calls
10430
+ * const authClient = await auth.getClient();
10431
+ * google.options({auth: authClient});
10432
+ *
10433
+ * // Do the magic
10434
+ * const res = await dataform.projects.locations.repositories.workspaces.push({
10435
+ * // Required. The workspace's name.
10436
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
10437
+ *
10438
+ * // Request body metadata
10439
+ * requestBody: {
10440
+ * // request body parameters
10441
+ * // {
10442
+ * // "remoteBranch": "my_remoteBranch"
10443
+ * // }
10444
+ * },
10445
+ * });
10446
+ * console.log(res.data);
10447
+ *
10448
+ * // Example response
10449
+ * // {}
10450
+ * }
10451
+ *
10452
+ * main().catch(e => {
10453
+ * console.error(e);
10454
+ * throw e;
10455
+ * });
10456
+ *
10457
+ * ```
7319
10458
  *
7320
10459
  * @param params - Parameters for request
7321
10460
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -7410,6 +10549,66 @@ export namespace dataform_v1beta1 {
7410
10549
 
7411
10550
  /**
7412
10551
  * Returns the contents of a given Workspace directory.
10552
+ * @example
10553
+ * ```js
10554
+ * // Before running the sample:
10555
+ * // - Enable the API at:
10556
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
10557
+ * // - Login into gcloud by running:
10558
+ * // ```sh
10559
+ * // $ gcloud auth application-default login
10560
+ * // ```
10561
+ * // - Install the npm module by running:
10562
+ * // ```sh
10563
+ * // $ npm install googleapis
10564
+ * // ```
10565
+ *
10566
+ * const {google} = require('googleapis');
10567
+ * const dataform = google.dataform('v1beta1');
10568
+ *
10569
+ * async function main() {
10570
+ * const auth = new google.auth.GoogleAuth({
10571
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
10572
+ * scopes: [
10573
+ * 'https://www.googleapis.com/auth/bigquery',
10574
+ * 'https://www.googleapis.com/auth/cloud-platform',
10575
+ * ],
10576
+ * });
10577
+ *
10578
+ * // Acquire an auth client, and bind it to all future calls
10579
+ * const authClient = await auth.getClient();
10580
+ * google.options({auth: authClient});
10581
+ *
10582
+ * // Do the magic
10583
+ * const res =
10584
+ * await dataform.projects.locations.repositories.workspaces.queryDirectoryContents(
10585
+ * {
10586
+ * // Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
10587
+ * pageSize: 'placeholder-value',
10588
+ * // 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.
10589
+ * pageToken: 'placeholder-value',
10590
+ * // Optional. The directory's full path including directory name, relative to the workspace root. If left unset, the workspace root is used.
10591
+ * path: 'placeholder-value',
10592
+ * // Required. The workspace's name.
10593
+ * workspace:
10594
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
10595
+ * },
10596
+ * );
10597
+ * console.log(res.data);
10598
+ *
10599
+ * // Example response
10600
+ * // {
10601
+ * // "directoryEntries": [],
10602
+ * // "nextPageToken": "my_nextPageToken"
10603
+ * // }
10604
+ * }
10605
+ *
10606
+ * main().catch(e => {
10607
+ * console.error(e);
10608
+ * throw e;
10609
+ * });
10610
+ *
10611
+ * ```
7413
10612
  *
7414
10613
  * @param params - Parameters for request
7415
10614
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -7507,6 +10706,61 @@ export namespace dataform_v1beta1 {
7507
10706
 
7508
10707
  /**
7509
10708
  * Returns the contents of a file (inside a Workspace).
10709
+ * @example
10710
+ * ```js
10711
+ * // Before running the sample:
10712
+ * // - Enable the API at:
10713
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
10714
+ * // - Login into gcloud by running:
10715
+ * // ```sh
10716
+ * // $ gcloud auth application-default login
10717
+ * // ```
10718
+ * // - Install the npm module by running:
10719
+ * // ```sh
10720
+ * // $ npm install googleapis
10721
+ * // ```
10722
+ *
10723
+ * const {google} = require('googleapis');
10724
+ * const dataform = google.dataform('v1beta1');
10725
+ *
10726
+ * async function main() {
10727
+ * const auth = new google.auth.GoogleAuth({
10728
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
10729
+ * scopes: [
10730
+ * 'https://www.googleapis.com/auth/bigquery',
10731
+ * 'https://www.googleapis.com/auth/cloud-platform',
10732
+ * ],
10733
+ * });
10734
+ *
10735
+ * // Acquire an auth client, and bind it to all future calls
10736
+ * const authClient = await auth.getClient();
10737
+ * google.options({auth: authClient});
10738
+ *
10739
+ * // Do the magic
10740
+ * const res =
10741
+ * await dataform.projects.locations.repositories.workspaces.readFile({
10742
+ * // Required. The file's full path including filename, relative to the workspace root.
10743
+ * path: 'placeholder-value',
10744
+ * // Optional. The Git revision of the file to return. If left empty, the current contents of `path` will be returned.
10745
+ * revision: 'placeholder-value',
10746
+ * // Required. The workspace's name.
10747
+ * workspace:
10748
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
10749
+ * });
10750
+ * console.log(res.data);
10751
+ *
10752
+ * // Example response
10753
+ * // {
10754
+ * // "fileContents": "my_fileContents"
10755
+ * // }
10756
+ * }
10757
+ *
10758
+ * main().catch(e => {
10759
+ * console.error(e);
10760
+ * throw e;
10761
+ * });
10762
+ *
10763
+ * ```
7510
10764
  *
7511
10765
  * @param params - Parameters for request
7512
10766
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -7599,6 +10853,63 @@ export namespace dataform_v1beta1 {
7599
10853
 
7600
10854
  /**
7601
10855
  * Deletes a directory (inside a Workspace) and all of its contents.
10856
+ * @example
10857
+ * ```js
10858
+ * // Before running the sample:
10859
+ * // - Enable the API at:
10860
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
10861
+ * // - Login into gcloud by running:
10862
+ * // ```sh
10863
+ * // $ gcloud auth application-default login
10864
+ * // ```
10865
+ * // - Install the npm module by running:
10866
+ * // ```sh
10867
+ * // $ npm install googleapis
10868
+ * // ```
10869
+ *
10870
+ * const {google} = require('googleapis');
10871
+ * const dataform = google.dataform('v1beta1');
10872
+ *
10873
+ * async function main() {
10874
+ * const auth = new google.auth.GoogleAuth({
10875
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
10876
+ * scopes: [
10877
+ * 'https://www.googleapis.com/auth/bigquery',
10878
+ * 'https://www.googleapis.com/auth/cloud-platform',
10879
+ * ],
10880
+ * });
10881
+ *
10882
+ * // Acquire an auth client, and bind it to all future calls
10883
+ * const authClient = await auth.getClient();
10884
+ * google.options({auth: authClient});
10885
+ *
10886
+ * // Do the magic
10887
+ * const res =
10888
+ * await dataform.projects.locations.repositories.workspaces.removeDirectory({
10889
+ * // Required. The workspace's name.
10890
+ * workspace:
10891
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
10892
+ *
10893
+ * // Request body metadata
10894
+ * requestBody: {
10895
+ * // request body parameters
10896
+ * // {
10897
+ * // "path": "my_path"
10898
+ * // }
10899
+ * },
10900
+ * });
10901
+ * console.log(res.data);
10902
+ *
10903
+ * // Example response
10904
+ * // {}
10905
+ * }
10906
+ *
10907
+ * main().catch(e => {
10908
+ * console.error(e);
10909
+ * throw e;
10910
+ * });
10911
+ *
10912
+ * ```
7602
10913
  *
7603
10914
  * @param params - Parameters for request
7604
10915
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -7695,6 +11006,63 @@ export namespace dataform_v1beta1 {
7695
11006
 
7696
11007
  /**
7697
11008
  * Deletes a file (inside a Workspace).
11009
+ * @example
11010
+ * ```js
11011
+ * // Before running the sample:
11012
+ * // - Enable the API at:
11013
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
11014
+ * // - Login into gcloud by running:
11015
+ * // ```sh
11016
+ * // $ gcloud auth application-default login
11017
+ * // ```
11018
+ * // - Install the npm module by running:
11019
+ * // ```sh
11020
+ * // $ npm install googleapis
11021
+ * // ```
11022
+ *
11023
+ * const {google} = require('googleapis');
11024
+ * const dataform = google.dataform('v1beta1');
11025
+ *
11026
+ * async function main() {
11027
+ * const auth = new google.auth.GoogleAuth({
11028
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
11029
+ * scopes: [
11030
+ * 'https://www.googleapis.com/auth/bigquery',
11031
+ * 'https://www.googleapis.com/auth/cloud-platform',
11032
+ * ],
11033
+ * });
11034
+ *
11035
+ * // Acquire an auth client, and bind it to all future calls
11036
+ * const authClient = await auth.getClient();
11037
+ * google.options({auth: authClient});
11038
+ *
11039
+ * // Do the magic
11040
+ * const res =
11041
+ * await dataform.projects.locations.repositories.workspaces.removeFile({
11042
+ * // Required. The workspace's name.
11043
+ * workspace:
11044
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
11045
+ *
11046
+ * // Request body metadata
11047
+ * requestBody: {
11048
+ * // request body parameters
11049
+ * // {
11050
+ * // "path": "my_path"
11051
+ * // }
11052
+ * },
11053
+ * });
11054
+ * console.log(res.data);
11055
+ *
11056
+ * // Example response
11057
+ * // {}
11058
+ * }
11059
+ *
11060
+ * main().catch(e => {
11061
+ * console.error(e);
11062
+ * throw e;
11063
+ * });
11064
+ *
11065
+ * ```
7698
11066
  *
7699
11067
  * @param params - Parameters for request
7700
11068
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -7787,6 +11155,62 @@ export namespace dataform_v1beta1 {
7787
11155
 
7788
11156
  /**
7789
11157
  * Performs a Git reset for uncommitted files in a Workspace.
11158
+ * @example
11159
+ * ```js
11160
+ * // Before running the sample:
11161
+ * // - Enable the API at:
11162
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
11163
+ * // - Login into gcloud by running:
11164
+ * // ```sh
11165
+ * // $ gcloud auth application-default login
11166
+ * // ```
11167
+ * // - Install the npm module by running:
11168
+ * // ```sh
11169
+ * // $ npm install googleapis
11170
+ * // ```
11171
+ *
11172
+ * const {google} = require('googleapis');
11173
+ * const dataform = google.dataform('v1beta1');
11174
+ *
11175
+ * async function main() {
11176
+ * const auth = new google.auth.GoogleAuth({
11177
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
11178
+ * scopes: [
11179
+ * 'https://www.googleapis.com/auth/bigquery',
11180
+ * 'https://www.googleapis.com/auth/cloud-platform',
11181
+ * ],
11182
+ * });
11183
+ *
11184
+ * // Acquire an auth client, and bind it to all future calls
11185
+ * const authClient = await auth.getClient();
11186
+ * google.options({auth: authClient});
11187
+ *
11188
+ * // Do the magic
11189
+ * const res = await dataform.projects.locations.repositories.workspaces.reset({
11190
+ * // Required. The workspace's name.
11191
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
11192
+ *
11193
+ * // Request body metadata
11194
+ * requestBody: {
11195
+ * // request body parameters
11196
+ * // {
11197
+ * // "clean": false,
11198
+ * // "paths": []
11199
+ * // }
11200
+ * },
11201
+ * });
11202
+ * console.log(res.data);
11203
+ *
11204
+ * // Example response
11205
+ * // {}
11206
+ * }
11207
+ *
11208
+ * main().catch(e => {
11209
+ * console.error(e);
11210
+ * throw e;
11211
+ * });
11212
+ *
11213
+ * ```
7790
11214
  *
7791
11215
  * @param params - Parameters for request
7792
11216
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -7885,6 +11309,64 @@ export namespace dataform_v1beta1 {
7885
11309
 
7886
11310
  /**
7887
11311
  * Finds the contents of a given Workspace directory by filter.
11312
+ * @example
11313
+ * ```js
11314
+ * // Before running the sample:
11315
+ * // - Enable the API at:
11316
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
11317
+ * // - Login into gcloud by running:
11318
+ * // ```sh
11319
+ * // $ gcloud auth application-default login
11320
+ * // ```
11321
+ * // - Install the npm module by running:
11322
+ * // ```sh
11323
+ * // $ npm install googleapis
11324
+ * // ```
11325
+ *
11326
+ * const {google} = require('googleapis');
11327
+ * const dataform = google.dataform('v1beta1');
11328
+ *
11329
+ * async function main() {
11330
+ * const auth = new google.auth.GoogleAuth({
11331
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
11332
+ * scopes: [
11333
+ * 'https://www.googleapis.com/auth/bigquery',
11334
+ * 'https://www.googleapis.com/auth/cloud-platform',
11335
+ * ],
11336
+ * });
11337
+ *
11338
+ * // Acquire an auth client, and bind it to all future calls
11339
+ * const authClient = await auth.getClient();
11340
+ * google.options({auth: authClient});
11341
+ *
11342
+ * // Do the magic
11343
+ * const res =
11344
+ * await dataform.projects.locations.repositories.workspaces.searchFiles({
11345
+ * // 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.
11346
+ * filter: 'placeholder-value',
11347
+ * // 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.
11348
+ * pageSize: 'placeholder-value',
11349
+ * // 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.
11350
+ * pageToken: 'placeholder-value',
11351
+ * // Required. The workspace's name.
11352
+ * workspace:
11353
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
11354
+ * });
11355
+ * console.log(res.data);
11356
+ *
11357
+ * // Example response
11358
+ * // {
11359
+ * // "nextPageToken": "my_nextPageToken",
11360
+ * // "searchResults": []
11361
+ * // }
11362
+ * }
11363
+ *
11364
+ * main().catch(e => {
11365
+ * console.error(e);
11366
+ * throw e;
11367
+ * });
11368
+ *
11369
+ * ```
7888
11370
  *
7889
11371
  * @param params - Parameters for request
7890
11372
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -7979,6 +11461,67 @@ export namespace dataform_v1beta1 {
7979
11461
 
7980
11462
  /**
7981
11463
  * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
11464
+ * @example
11465
+ * ```js
11466
+ * // Before running the sample:
11467
+ * // - Enable the API at:
11468
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
11469
+ * // - Login into gcloud by running:
11470
+ * // ```sh
11471
+ * // $ gcloud auth application-default login
11472
+ * // ```
11473
+ * // - Install the npm module by running:
11474
+ * // ```sh
11475
+ * // $ npm install googleapis
11476
+ * // ```
11477
+ *
11478
+ * const {google} = require('googleapis');
11479
+ * const dataform = google.dataform('v1beta1');
11480
+ *
11481
+ * async function main() {
11482
+ * const auth = new google.auth.GoogleAuth({
11483
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
11484
+ * scopes: [
11485
+ * 'https://www.googleapis.com/auth/bigquery',
11486
+ * 'https://www.googleapis.com/auth/cloud-platform',
11487
+ * ],
11488
+ * });
11489
+ *
11490
+ * // Acquire an auth client, and bind it to all future calls
11491
+ * const authClient = await auth.getClient();
11492
+ * google.options({auth: authClient});
11493
+ *
11494
+ * // Do the magic
11495
+ * const res =
11496
+ * await dataform.projects.locations.repositories.workspaces.setIamPolicy({
11497
+ * // 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.
11498
+ * resource:
11499
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
11500
+ *
11501
+ * // Request body metadata
11502
+ * requestBody: {
11503
+ * // request body parameters
11504
+ * // {
11505
+ * // "policy": {}
11506
+ * // }
11507
+ * },
11508
+ * });
11509
+ * console.log(res.data);
11510
+ *
11511
+ * // Example response
11512
+ * // {
11513
+ * // "bindings": [],
11514
+ * // "etag": "my_etag",
11515
+ * // "version": 0
11516
+ * // }
11517
+ * }
11518
+ *
11519
+ * main().catch(e => {
11520
+ * console.error(e);
11521
+ * throw e;
11522
+ * });
11523
+ *
11524
+ * ```
7982
11525
  *
7983
11526
  * @param params - Parameters for request
7984
11527
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -8071,6 +11614,67 @@ export namespace dataform_v1beta1 {
8071
11614
 
8072
11615
  /**
8073
11616
  * 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.
11617
+ * @example
11618
+ * ```js
11619
+ * // Before running the sample:
11620
+ * // - Enable the API at:
11621
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
11622
+ * // - Login into gcloud by running:
11623
+ * // ```sh
11624
+ * // $ gcloud auth application-default login
11625
+ * // ```
11626
+ * // - Install the npm module by running:
11627
+ * // ```sh
11628
+ * // $ npm install googleapis
11629
+ * // ```
11630
+ *
11631
+ * const {google} = require('googleapis');
11632
+ * const dataform = google.dataform('v1beta1');
11633
+ *
11634
+ * async function main() {
11635
+ * const auth = new google.auth.GoogleAuth({
11636
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
11637
+ * scopes: [
11638
+ * 'https://www.googleapis.com/auth/bigquery',
11639
+ * 'https://www.googleapis.com/auth/cloud-platform',
11640
+ * ],
11641
+ * });
11642
+ *
11643
+ * // Acquire an auth client, and bind it to all future calls
11644
+ * const authClient = await auth.getClient();
11645
+ * google.options({auth: authClient});
11646
+ *
11647
+ * // Do the magic
11648
+ * const res =
11649
+ * await dataform.projects.locations.repositories.workspaces.testIamPermissions(
11650
+ * {
11651
+ * // 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.
11652
+ * resource:
11653
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
11654
+ *
11655
+ * // Request body metadata
11656
+ * requestBody: {
11657
+ * // request body parameters
11658
+ * // {
11659
+ * // "permissions": []
11660
+ * // }
11661
+ * },
11662
+ * },
11663
+ * );
11664
+ * console.log(res.data);
11665
+ *
11666
+ * // Example response
11667
+ * // {
11668
+ * // "permissions": []
11669
+ * // }
11670
+ * }
11671
+ *
11672
+ * main().catch(e => {
11673
+ * console.error(e);
11674
+ * throw e;
11675
+ * });
11676
+ *
11677
+ * ```
8074
11678
  *
8075
11679
  * @param params - Parameters for request
8076
11680
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -8167,6 +11771,64 @@ export namespace dataform_v1beta1 {
8167
11771
 
8168
11772
  /**
8169
11773
  * Writes to a file (inside a Workspace).
11774
+ * @example
11775
+ * ```js
11776
+ * // Before running the sample:
11777
+ * // - Enable the API at:
11778
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
11779
+ * // - Login into gcloud by running:
11780
+ * // ```sh
11781
+ * // $ gcloud auth application-default login
11782
+ * // ```
11783
+ * // - Install the npm module by running:
11784
+ * // ```sh
11785
+ * // $ npm install googleapis
11786
+ * // ```
11787
+ *
11788
+ * const {google} = require('googleapis');
11789
+ * const dataform = google.dataform('v1beta1');
11790
+ *
11791
+ * async function main() {
11792
+ * const auth = new google.auth.GoogleAuth({
11793
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
11794
+ * scopes: [
11795
+ * 'https://www.googleapis.com/auth/bigquery',
11796
+ * 'https://www.googleapis.com/auth/cloud-platform',
11797
+ * ],
11798
+ * });
11799
+ *
11800
+ * // Acquire an auth client, and bind it to all future calls
11801
+ * const authClient = await auth.getClient();
11802
+ * google.options({auth: authClient});
11803
+ *
11804
+ * // Do the magic
11805
+ * const res =
11806
+ * await dataform.projects.locations.repositories.workspaces.writeFile({
11807
+ * // Required. The workspace's name.
11808
+ * workspace:
11809
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
11810
+ *
11811
+ * // Request body metadata
11812
+ * requestBody: {
11813
+ * // request body parameters
11814
+ * // {
11815
+ * // "contents": "my_contents",
11816
+ * // "path": "my_path"
11817
+ * // }
11818
+ * },
11819
+ * });
11820
+ * console.log(res.data);
11821
+ *
11822
+ * // Example response
11823
+ * // {}
11824
+ * }
11825
+ *
11826
+ * main().catch(e => {
11827
+ * console.error(e);
11828
+ * throw e;
11829
+ * });
11830
+ *
11831
+ * ```
8170
11832
  *
8171
11833
  * @param params - Parameters for request
8172
11834
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.