@googleapis/dataform 8.0.1 → 9.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -733,6 +733,19 @@ export declare namespace dataform_v1beta1 {
733
733
  */
734
734
  url?: string | null;
735
735
  }
736
+ /**
737
+ * Contains metadata about the IAM policy override for a given Dataform resource. If is_active is true, this the policy encoded in iam_policy_name is the source of truth for this resource. Will be provided in internal ESV2 views for: Workspaces, Repositories, Folders, TeamFolders.
738
+ */
739
+ export interface Schema$IamPolicyOverrideView {
740
+ /**
741
+ * The IAM policy name for the resource.
742
+ */
743
+ iamPolicyName?: Schema$PolicyName;
744
+ /**
745
+ * Whether the IAM policy encoded in this view is active.
746
+ */
747
+ isActive?: boolean | null;
748
+ }
736
749
  /**
737
750
  * Load definition for incremental load modes
738
751
  */
@@ -1076,6 +1089,10 @@ export declare namespace dataform_v1beta1 {
1076
1089
  * Configures various aspects of Dataform notebook runtime.
1077
1090
  */
1078
1091
  export interface Schema$NotebookRuntimeOptions {
1092
+ /**
1093
+ * 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.
1094
+ */
1095
+ aiPlatformNotebookRuntimeTemplate?: string | null;
1079
1096
  /**
1080
1097
  * Optional. The Google Cloud Storage location to upload the result to. Format: `gs://bucket-name`.
1081
1098
  */
@@ -1160,6 +1177,23 @@ export declare namespace dataform_v1beta1 {
1160
1177
  */
1161
1178
  version?: number | null;
1162
1179
  }
1180
+ /**
1181
+ * An internal name for an IAM policy, based on the resource to which the policy applies. Not to be confused with a resource's external full resource name. For more information on this distinction, see go/iam-full-resource-names.
1182
+ */
1183
+ export interface Schema$PolicyName {
1184
+ /**
1185
+ * Identifies an instance of the type. ID format varies by type. The ID format is defined in the IAM .service file that defines the type, either in path_mapping or in a comment.
1186
+ */
1187
+ id?: string | null;
1188
+ /**
1189
+ * For Cloud IAM: The location of the Policy. Must be empty or "global" for Policies owned by global IAM. Must name a region from prodspec/cloud-iam-cloudspec for Regional IAM Policies, see go/iam-faq#where-is-iam-currently-deployed. For Local IAM: This field should be set to "local".
1190
+ */
1191
+ region?: string | null;
1192
+ /**
1193
+ * Resource type. Types are defined in IAM's .service files. Valid values for type might be 'storage_buckets', 'compute_instances', 'resourcemanager_customers', 'billing_accounts', etc.
1194
+ */
1195
+ type?: string | null;
1196
+ }
1163
1197
  /**
1164
1198
  * `PullGitCommits` request message.
1165
1199
  */
@@ -1860,6 +1894,59 @@ export declare namespace dataform_v1beta1 {
1860
1894
  constructor(context: APIRequestContext);
1861
1895
  /**
1862
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
+ * ```
1863
1950
  *
1864
1951
  * @param params - Parameters for request
1865
1952
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1874,6 +1961,56 @@ export declare namespace dataform_v1beta1 {
1874
1961
  get(callback: BodyResponseCallback<Schema$Location>): void;
1875
1962
  /**
1876
1963
  * Get default config for a given project and location.
1964
+ * @example
1965
+ * ```js
1966
+ * // Before running the sample:
1967
+ * // - Enable the API at:
1968
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
1969
+ * // - Login into gcloud by running:
1970
+ * // ```sh
1971
+ * // $ gcloud auth application-default login
1972
+ * // ```
1973
+ * // - Install the npm module by running:
1974
+ * // ```sh
1975
+ * // $ npm install googleapis
1976
+ * // ```
1977
+ *
1978
+ * const {google} = require('googleapis');
1979
+ * const dataform = google.dataform('v1beta1');
1980
+ *
1981
+ * async function main() {
1982
+ * const auth = new google.auth.GoogleAuth({
1983
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1984
+ * scopes: [
1985
+ * 'https://www.googleapis.com/auth/bigquery',
1986
+ * 'https://www.googleapis.com/auth/cloud-platform',
1987
+ * ],
1988
+ * });
1989
+ *
1990
+ * // Acquire an auth client, and bind it to all future calls
1991
+ * const authClient = await auth.getClient();
1992
+ * google.options({auth: authClient});
1993
+ *
1994
+ * // Do the magic
1995
+ * const res = await dataform.projects.locations.getConfig({
1996
+ * // Required. The config name.
1997
+ * name: 'projects/my-project/locations/my-location/config',
1998
+ * });
1999
+ * console.log(res.data);
2000
+ *
2001
+ * // Example response
2002
+ * // {
2003
+ * // "defaultKmsKeyName": "my_defaultKmsKeyName",
2004
+ * // "name": "my_name"
2005
+ * // }
2006
+ * }
2007
+ *
2008
+ * main().catch(e => {
2009
+ * console.error(e);
2010
+ * throw e;
2011
+ * });
2012
+ *
2013
+ * ```
1877
2014
  *
1878
2015
  * @param params - Parameters for request
1879
2016
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1888,6 +2025,64 @@ export declare namespace dataform_v1beta1 {
1888
2025
  getConfig(callback: BodyResponseCallback<Schema$Config>): void;
1889
2026
  /**
1890
2027
  * Lists information about the supported locations for this service.
2028
+ * @example
2029
+ * ```js
2030
+ * // Before running the sample:
2031
+ * // - Enable the API at:
2032
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
2033
+ * // - Login into gcloud by running:
2034
+ * // ```sh
2035
+ * // $ gcloud auth application-default login
2036
+ * // ```
2037
+ * // - Install the npm module by running:
2038
+ * // ```sh
2039
+ * // $ npm install googleapis
2040
+ * // ```
2041
+ *
2042
+ * const {google} = require('googleapis');
2043
+ * const dataform = google.dataform('v1beta1');
2044
+ *
2045
+ * async function main() {
2046
+ * const auth = new google.auth.GoogleAuth({
2047
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2048
+ * scopes: [
2049
+ * 'https://www.googleapis.com/auth/bigquery',
2050
+ * 'https://www.googleapis.com/auth/cloud-platform',
2051
+ * ],
2052
+ * });
2053
+ *
2054
+ * // Acquire an auth client, and bind it to all future calls
2055
+ * const authClient = await auth.getClient();
2056
+ * google.options({auth: authClient});
2057
+ *
2058
+ * // Do the magic
2059
+ * const res = await dataform.projects.locations.list({
2060
+ * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.
2061
+ * extraLocationTypes: 'placeholder-value',
2062
+ * // 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).
2063
+ * filter: 'placeholder-value',
2064
+ * // The resource that owns the locations collection, if applicable.
2065
+ * name: 'projects/my-project',
2066
+ * // The maximum number of results to return. If not set, the service selects a default.
2067
+ * pageSize: 'placeholder-value',
2068
+ * // A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
2069
+ * pageToken: 'placeholder-value',
2070
+ * });
2071
+ * console.log(res.data);
2072
+ *
2073
+ * // Example response
2074
+ * // {
2075
+ * // "locations": [],
2076
+ * // "nextPageToken": "my_nextPageToken"
2077
+ * // }
2078
+ * }
2079
+ *
2080
+ * main().catch(e => {
2081
+ * console.error(e);
2082
+ * throw e;
2083
+ * });
2084
+ *
2085
+ * ```
1891
2086
  *
1892
2087
  * @param params - Parameters for request
1893
2088
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1902,6 +2097,67 @@ export declare namespace dataform_v1beta1 {
1902
2097
  list(callback: BodyResponseCallback<Schema$ListLocationsResponse>): void;
1903
2098
  /**
1904
2099
  * 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.*
2100
+ * @example
2101
+ * ```js
2102
+ * // Before running the sample:
2103
+ * // - Enable the API at:
2104
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
2105
+ * // - Login into gcloud by running:
2106
+ * // ```sh
2107
+ * // $ gcloud auth application-default login
2108
+ * // ```
2109
+ * // - Install the npm module by running:
2110
+ * // ```sh
2111
+ * // $ npm install googleapis
2112
+ * // ```
2113
+ *
2114
+ * const {google} = require('googleapis');
2115
+ * const dataform = google.dataform('v1beta1');
2116
+ *
2117
+ * async function main() {
2118
+ * const auth = new google.auth.GoogleAuth({
2119
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2120
+ * scopes: [
2121
+ * 'https://www.googleapis.com/auth/bigquery',
2122
+ * 'https://www.googleapis.com/auth/cloud-platform',
2123
+ * ],
2124
+ * });
2125
+ *
2126
+ * // Acquire an auth client, and bind it to all future calls
2127
+ * const authClient = await auth.getClient();
2128
+ * google.options({auth: authClient});
2129
+ *
2130
+ * // Do the magic
2131
+ * const res = await dataform.projects.locations.updateConfig({
2132
+ * // Identifier. The config name.
2133
+ * name: 'projects/my-project/locations/my-location/config',
2134
+ * // Optional. Specifies the fields to be updated in the config.
2135
+ * updateMask: 'placeholder-value',
2136
+ *
2137
+ * // Request body metadata
2138
+ * requestBody: {
2139
+ * // request body parameters
2140
+ * // {
2141
+ * // "defaultKmsKeyName": "my_defaultKmsKeyName",
2142
+ * // "name": "my_name"
2143
+ * // }
2144
+ * },
2145
+ * });
2146
+ * console.log(res.data);
2147
+ *
2148
+ * // Example response
2149
+ * // {
2150
+ * // "defaultKmsKeyName": "my_defaultKmsKeyName",
2151
+ * // "name": "my_name"
2152
+ * // }
2153
+ * }
2154
+ *
2155
+ * main().catch(e => {
2156
+ * console.error(e);
2157
+ * throw e;
2158
+ * });
2159
+ *
2160
+ * ```
1905
2161
  *
1906
2162
  * @param params - Parameters for request
1907
2163
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1973,6 +2229,65 @@ export declare namespace dataform_v1beta1 {
1973
2229
  constructor(context: APIRequestContext);
1974
2230
  /**
1975
2231
  * Applies a Git commit to a Repository. The Repository must not have a value for `git_remote_settings.url`.
2232
+ * @example
2233
+ * ```js
2234
+ * // Before running the sample:
2235
+ * // - Enable the API at:
2236
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
2237
+ * // - Login into gcloud by running:
2238
+ * // ```sh
2239
+ * // $ gcloud auth application-default login
2240
+ * // ```
2241
+ * // - Install the npm module by running:
2242
+ * // ```sh
2243
+ * // $ npm install googleapis
2244
+ * // ```
2245
+ *
2246
+ * const {google} = require('googleapis');
2247
+ * const dataform = google.dataform('v1beta1');
2248
+ *
2249
+ * async function main() {
2250
+ * const auth = new google.auth.GoogleAuth({
2251
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2252
+ * scopes: [
2253
+ * 'https://www.googleapis.com/auth/bigquery',
2254
+ * 'https://www.googleapis.com/auth/cloud-platform',
2255
+ * ],
2256
+ * });
2257
+ *
2258
+ * // Acquire an auth client, and bind it to all future calls
2259
+ * const authClient = await auth.getClient();
2260
+ * google.options({auth: authClient});
2261
+ *
2262
+ * // Do the magic
2263
+ * const res = await dataform.projects.locations.repositories.commit({
2264
+ * // Required. The repository's name.
2265
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie',
2266
+ *
2267
+ * // Request body metadata
2268
+ * requestBody: {
2269
+ * // request body parameters
2270
+ * // {
2271
+ * // "commitMetadata": {},
2272
+ * // "fileOperations": {},
2273
+ * // "requiredHeadCommitSha": "my_requiredHeadCommitSha"
2274
+ * // }
2275
+ * },
2276
+ * });
2277
+ * console.log(res.data);
2278
+ *
2279
+ * // Example response
2280
+ * // {
2281
+ * // "commitSha": "my_commitSha"
2282
+ * // }
2283
+ * }
2284
+ *
2285
+ * main().catch(e => {
2286
+ * console.error(e);
2287
+ * throw e;
2288
+ * });
2289
+ *
2290
+ * ```
1976
2291
  *
1977
2292
  * @param params - Parameters for request
1978
2293
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1987,6 +2302,56 @@ export declare namespace dataform_v1beta1 {
1987
2302
  commit(callback: BodyResponseCallback<Schema$CommitRepositoryChangesResponse>): void;
1988
2303
  /**
1989
2304
  * Computes a Repository's Git access token status.
2305
+ * @example
2306
+ * ```js
2307
+ * // Before running the sample:
2308
+ * // - Enable the API at:
2309
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
2310
+ * // - Login into gcloud by running:
2311
+ * // ```sh
2312
+ * // $ gcloud auth application-default login
2313
+ * // ```
2314
+ * // - Install the npm module by running:
2315
+ * // ```sh
2316
+ * // $ npm install googleapis
2317
+ * // ```
2318
+ *
2319
+ * const {google} = require('googleapis');
2320
+ * const dataform = google.dataform('v1beta1');
2321
+ *
2322
+ * async function main() {
2323
+ * const auth = new google.auth.GoogleAuth({
2324
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2325
+ * scopes: [
2326
+ * 'https://www.googleapis.com/auth/bigquery',
2327
+ * 'https://www.googleapis.com/auth/cloud-platform',
2328
+ * ],
2329
+ * });
2330
+ *
2331
+ * // Acquire an auth client, and bind it to all future calls
2332
+ * const authClient = await auth.getClient();
2333
+ * google.options({auth: authClient});
2334
+ *
2335
+ * // Do the magic
2336
+ * const res =
2337
+ * await dataform.projects.locations.repositories.computeAccessTokenStatus({
2338
+ * // Required. The repository's name.
2339
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie',
2340
+ * });
2341
+ * console.log(res.data);
2342
+ *
2343
+ * // Example response
2344
+ * // {
2345
+ * // "tokenStatus": "my_tokenStatus"
2346
+ * // }
2347
+ * }
2348
+ *
2349
+ * main().catch(e => {
2350
+ * console.error(e);
2351
+ * throw e;
2352
+ * });
2353
+ *
2354
+ * ```
1990
2355
  *
1991
2356
  * @param params - Parameters for request
1992
2357
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2001,6 +2366,87 @@ export declare namespace dataform_v1beta1 {
2001
2366
  computeAccessTokenStatus(callback: BodyResponseCallback<Schema$ComputeRepositoryAccessTokenStatusResponse>): void;
2002
2367
  /**
2003
2368
  * Creates a new Repository in a given project and location.
2369
+ * @example
2370
+ * ```js
2371
+ * // Before running the sample:
2372
+ * // - Enable the API at:
2373
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
2374
+ * // - Login into gcloud by running:
2375
+ * // ```sh
2376
+ * // $ gcloud auth application-default login
2377
+ * // ```
2378
+ * // - Install the npm module by running:
2379
+ * // ```sh
2380
+ * // $ npm install googleapis
2381
+ * // ```
2382
+ *
2383
+ * const {google} = require('googleapis');
2384
+ * const dataform = google.dataform('v1beta1');
2385
+ *
2386
+ * async function main() {
2387
+ * const auth = new google.auth.GoogleAuth({
2388
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2389
+ * scopes: [
2390
+ * 'https://www.googleapis.com/auth/bigquery',
2391
+ * 'https://www.googleapis.com/auth/cloud-platform',
2392
+ * ],
2393
+ * });
2394
+ *
2395
+ * // Acquire an auth client, and bind it to all future calls
2396
+ * const authClient = await auth.getClient();
2397
+ * google.options({auth: authClient});
2398
+ *
2399
+ * // Do the magic
2400
+ * const res = await dataform.projects.locations.repositories.create({
2401
+ * // Required. The location in which to create the repository. Must be in the format `projects/x/locations/x`.
2402
+ * parent: 'projects/my-project/locations/my-location',
2403
+ * // Required. The ID to use for the repository, which will become the final component of the repository's resource name.
2404
+ * repositoryId: 'placeholder-value',
2405
+ *
2406
+ * // Request body metadata
2407
+ * requestBody: {
2408
+ * // request body parameters
2409
+ * // {
2410
+ * // "createTime": "my_createTime",
2411
+ * // "dataEncryptionState": {},
2412
+ * // "displayName": "my_displayName",
2413
+ * // "gitRemoteSettings": {},
2414
+ * // "internalMetadata": "my_internalMetadata",
2415
+ * // "kmsKeyName": "my_kmsKeyName",
2416
+ * // "labels": {},
2417
+ * // "name": "my_name",
2418
+ * // "npmrcEnvironmentVariablesSecretVersion": "my_npmrcEnvironmentVariablesSecretVersion",
2419
+ * // "serviceAccount": "my_serviceAccount",
2420
+ * // "setAuthenticatedUserAdmin": false,
2421
+ * // "workspaceCompilationOverrides": {}
2422
+ * // }
2423
+ * },
2424
+ * });
2425
+ * console.log(res.data);
2426
+ *
2427
+ * // Example response
2428
+ * // {
2429
+ * // "createTime": "my_createTime",
2430
+ * // "dataEncryptionState": {},
2431
+ * // "displayName": "my_displayName",
2432
+ * // "gitRemoteSettings": {},
2433
+ * // "internalMetadata": "my_internalMetadata",
2434
+ * // "kmsKeyName": "my_kmsKeyName",
2435
+ * // "labels": {},
2436
+ * // "name": "my_name",
2437
+ * // "npmrcEnvironmentVariablesSecretVersion": "my_npmrcEnvironmentVariablesSecretVersion",
2438
+ * // "serviceAccount": "my_serviceAccount",
2439
+ * // "setAuthenticatedUserAdmin": false,
2440
+ * // "workspaceCompilationOverrides": {}
2441
+ * // }
2442
+ * }
2443
+ *
2444
+ * main().catch(e => {
2445
+ * console.error(e);
2446
+ * throw e;
2447
+ * });
2448
+ *
2449
+ * ```
2004
2450
  *
2005
2451
  * @param params - Parameters for request
2006
2452
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2015,6 +2461,55 @@ export declare namespace dataform_v1beta1 {
2015
2461
  create(callback: BodyResponseCallback<Schema$Repository>): void;
2016
2462
  /**
2017
2463
  * Deletes a single Repository.
2464
+ * @example
2465
+ * ```js
2466
+ * // Before running the sample:
2467
+ * // - Enable the API at:
2468
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
2469
+ * // - Login into gcloud by running:
2470
+ * // ```sh
2471
+ * // $ gcloud auth application-default login
2472
+ * // ```
2473
+ * // - Install the npm module by running:
2474
+ * // ```sh
2475
+ * // $ npm install googleapis
2476
+ * // ```
2477
+ *
2478
+ * const {google} = require('googleapis');
2479
+ * const dataform = google.dataform('v1beta1');
2480
+ *
2481
+ * async function main() {
2482
+ * const auth = new google.auth.GoogleAuth({
2483
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2484
+ * scopes: [
2485
+ * 'https://www.googleapis.com/auth/bigquery',
2486
+ * 'https://www.googleapis.com/auth/cloud-platform',
2487
+ * ],
2488
+ * });
2489
+ *
2490
+ * // Acquire an auth client, and bind it to all future calls
2491
+ * const authClient = await auth.getClient();
2492
+ * google.options({auth: authClient});
2493
+ *
2494
+ * // Do the magic
2495
+ * const res = await dataform.projects.locations.repositories.delete({
2496
+ * // 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.*.
2497
+ * force: 'placeholder-value',
2498
+ * // Required. The repository's name.
2499
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie',
2500
+ * });
2501
+ * console.log(res.data);
2502
+ *
2503
+ * // Example response
2504
+ * // {}
2505
+ * }
2506
+ *
2507
+ * main().catch(e => {
2508
+ * console.error(e);
2509
+ * throw e;
2510
+ * });
2511
+ *
2512
+ * ```
2018
2513
  *
2019
2514
  * @param params - Parameters for request
2020
2515
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2029,6 +2524,60 @@ export declare namespace dataform_v1beta1 {
2029
2524
  delete(callback: BodyResponseCallback<Schema$Empty>): void;
2030
2525
  /**
2031
2526
  * Fetches a Repository's history of commits. The Repository must not have a value for `git_remote_settings.url`.
2527
+ * @example
2528
+ * ```js
2529
+ * // Before running the sample:
2530
+ * // - Enable the API at:
2531
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
2532
+ * // - Login into gcloud by running:
2533
+ * // ```sh
2534
+ * // $ gcloud auth application-default login
2535
+ * // ```
2536
+ * // - Install the npm module by running:
2537
+ * // ```sh
2538
+ * // $ npm install googleapis
2539
+ * // ```
2540
+ *
2541
+ * const {google} = require('googleapis');
2542
+ * const dataform = google.dataform('v1beta1');
2543
+ *
2544
+ * async function main() {
2545
+ * const auth = new google.auth.GoogleAuth({
2546
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2547
+ * scopes: [
2548
+ * 'https://www.googleapis.com/auth/bigquery',
2549
+ * 'https://www.googleapis.com/auth/cloud-platform',
2550
+ * ],
2551
+ * });
2552
+ *
2553
+ * // Acquire an auth client, and bind it to all future calls
2554
+ * const authClient = await auth.getClient();
2555
+ * google.options({auth: authClient});
2556
+ *
2557
+ * // Do the magic
2558
+ * const res = await dataform.projects.locations.repositories.fetchHistory({
2559
+ * // Required. The repository's name.
2560
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie',
2561
+ * // Optional. Maximum number of commits to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
2562
+ * pageSize: 'placeholder-value',
2563
+ * // 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.
2564
+ * pageToken: 'placeholder-value',
2565
+ * });
2566
+ * console.log(res.data);
2567
+ *
2568
+ * // Example response
2569
+ * // {
2570
+ * // "commits": [],
2571
+ * // "nextPageToken": "my_nextPageToken"
2572
+ * // }
2573
+ * }
2574
+ *
2575
+ * main().catch(e => {
2576
+ * console.error(e);
2577
+ * throw e;
2578
+ * });
2579
+ *
2580
+ * ```
2032
2581
  *
2033
2582
  * @param params - Parameters for request
2034
2583
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2043,6 +2592,56 @@ export declare namespace dataform_v1beta1 {
2043
2592
  fetchHistory(callback: BodyResponseCallback<Schema$FetchRepositoryHistoryResponse>): void;
2044
2593
  /**
2045
2594
  * Fetches a Repository's remote branches.
2595
+ * @example
2596
+ * ```js
2597
+ * // Before running the sample:
2598
+ * // - Enable the API at:
2599
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
2600
+ * // - Login into gcloud by running:
2601
+ * // ```sh
2602
+ * // $ gcloud auth application-default login
2603
+ * // ```
2604
+ * // - Install the npm module by running:
2605
+ * // ```sh
2606
+ * // $ npm install googleapis
2607
+ * // ```
2608
+ *
2609
+ * const {google} = require('googleapis');
2610
+ * const dataform = google.dataform('v1beta1');
2611
+ *
2612
+ * async function main() {
2613
+ * const auth = new google.auth.GoogleAuth({
2614
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2615
+ * scopes: [
2616
+ * 'https://www.googleapis.com/auth/bigquery',
2617
+ * 'https://www.googleapis.com/auth/cloud-platform',
2618
+ * ],
2619
+ * });
2620
+ *
2621
+ * // Acquire an auth client, and bind it to all future calls
2622
+ * const authClient = await auth.getClient();
2623
+ * google.options({auth: authClient});
2624
+ *
2625
+ * // Do the magic
2626
+ * const res =
2627
+ * await dataform.projects.locations.repositories.fetchRemoteBranches({
2628
+ * // Required. The repository's name.
2629
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie',
2630
+ * });
2631
+ * console.log(res.data);
2632
+ *
2633
+ * // Example response
2634
+ * // {
2635
+ * // "branches": []
2636
+ * // }
2637
+ * }
2638
+ *
2639
+ * main().catch(e => {
2640
+ * console.error(e);
2641
+ * throw e;
2642
+ * });
2643
+ *
2644
+ * ```
2046
2645
  *
2047
2646
  * @param params - Parameters for request
2048
2647
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2057,6 +2656,66 @@ export declare namespace dataform_v1beta1 {
2057
2656
  fetchRemoteBranches(callback: BodyResponseCallback<Schema$FetchRemoteBranchesResponse>): void;
2058
2657
  /**
2059
2658
  * Fetches a single Repository.
2659
+ * @example
2660
+ * ```js
2661
+ * // Before running the sample:
2662
+ * // - Enable the API at:
2663
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
2664
+ * // - Login into gcloud by running:
2665
+ * // ```sh
2666
+ * // $ gcloud auth application-default login
2667
+ * // ```
2668
+ * // - Install the npm module by running:
2669
+ * // ```sh
2670
+ * // $ npm install googleapis
2671
+ * // ```
2672
+ *
2673
+ * const {google} = require('googleapis');
2674
+ * const dataform = google.dataform('v1beta1');
2675
+ *
2676
+ * async function main() {
2677
+ * const auth = new google.auth.GoogleAuth({
2678
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2679
+ * scopes: [
2680
+ * 'https://www.googleapis.com/auth/bigquery',
2681
+ * 'https://www.googleapis.com/auth/cloud-platform',
2682
+ * ],
2683
+ * });
2684
+ *
2685
+ * // Acquire an auth client, and bind it to all future calls
2686
+ * const authClient = await auth.getClient();
2687
+ * google.options({auth: authClient});
2688
+ *
2689
+ * // Do the magic
2690
+ * const res = await dataform.projects.locations.repositories.get({
2691
+ * // Required. The repository's name.
2692
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie',
2693
+ * });
2694
+ * console.log(res.data);
2695
+ *
2696
+ * // Example response
2697
+ * // {
2698
+ * // "createTime": "my_createTime",
2699
+ * // "dataEncryptionState": {},
2700
+ * // "displayName": "my_displayName",
2701
+ * // "gitRemoteSettings": {},
2702
+ * // "internalMetadata": "my_internalMetadata",
2703
+ * // "kmsKeyName": "my_kmsKeyName",
2704
+ * // "labels": {},
2705
+ * // "name": "my_name",
2706
+ * // "npmrcEnvironmentVariablesSecretVersion": "my_npmrcEnvironmentVariablesSecretVersion",
2707
+ * // "serviceAccount": "my_serviceAccount",
2708
+ * // "setAuthenticatedUserAdmin": false,
2709
+ * // "workspaceCompilationOverrides": {}
2710
+ * // }
2711
+ * }
2712
+ *
2713
+ * main().catch(e => {
2714
+ * console.error(e);
2715
+ * throw e;
2716
+ * });
2717
+ *
2718
+ * ```
2060
2719
  *
2061
2720
  * @param params - Parameters for request
2062
2721
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2071,6 +2730,60 @@ export declare namespace dataform_v1beta1 {
2071
2730
  get(callback: BodyResponseCallback<Schema$Repository>): void;
2072
2731
  /**
2073
2732
  * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
2733
+ * @example
2734
+ * ```js
2735
+ * // Before running the sample:
2736
+ * // - Enable the API at:
2737
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
2738
+ * // - Login into gcloud by running:
2739
+ * // ```sh
2740
+ * // $ gcloud auth application-default login
2741
+ * // ```
2742
+ * // - Install the npm module by running:
2743
+ * // ```sh
2744
+ * // $ npm install googleapis
2745
+ * // ```
2746
+ *
2747
+ * const {google} = require('googleapis');
2748
+ * const dataform = google.dataform('v1beta1');
2749
+ *
2750
+ * async function main() {
2751
+ * const auth = new google.auth.GoogleAuth({
2752
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2753
+ * scopes: [
2754
+ * 'https://www.googleapis.com/auth/bigquery',
2755
+ * 'https://www.googleapis.com/auth/cloud-platform',
2756
+ * ],
2757
+ * });
2758
+ *
2759
+ * // Acquire an auth client, and bind it to all future calls
2760
+ * const authClient = await auth.getClient();
2761
+ * google.options({auth: authClient});
2762
+ *
2763
+ * // Do the magic
2764
+ * const res = await dataform.projects.locations.repositories.getIamPolicy({
2765
+ * // 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).
2766
+ * 'options.requestedPolicyVersion': 'placeholder-value',
2767
+ * // 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.
2768
+ * resource:
2769
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie',
2770
+ * });
2771
+ * console.log(res.data);
2772
+ *
2773
+ * // Example response
2774
+ * // {
2775
+ * // "bindings": [],
2776
+ * // "etag": "my_etag",
2777
+ * // "version": 0
2778
+ * // }
2779
+ * }
2780
+ *
2781
+ * main().catch(e => {
2782
+ * console.error(e);
2783
+ * throw e;
2784
+ * });
2785
+ *
2786
+ * ```
2074
2787
  *
2075
2788
  * @param params - Parameters for request
2076
2789
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2085,6 +2798,65 @@ export declare namespace dataform_v1beta1 {
2085
2798
  getIamPolicy(callback: BodyResponseCallback<Schema$Policy>): void;
2086
2799
  /**
2087
2800
  * 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)*.
2801
+ * @example
2802
+ * ```js
2803
+ * // Before running the sample:
2804
+ * // - Enable the API at:
2805
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
2806
+ * // - Login into gcloud by running:
2807
+ * // ```sh
2808
+ * // $ gcloud auth application-default login
2809
+ * // ```
2810
+ * // - Install the npm module by running:
2811
+ * // ```sh
2812
+ * // $ npm install googleapis
2813
+ * // ```
2814
+ *
2815
+ * const {google} = require('googleapis');
2816
+ * const dataform = google.dataform('v1beta1');
2817
+ *
2818
+ * async function main() {
2819
+ * const auth = new google.auth.GoogleAuth({
2820
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2821
+ * scopes: [
2822
+ * 'https://www.googleapis.com/auth/bigquery',
2823
+ * 'https://www.googleapis.com/auth/cloud-platform',
2824
+ * ],
2825
+ * });
2826
+ *
2827
+ * // Acquire an auth client, and bind it to all future calls
2828
+ * const authClient = await auth.getClient();
2829
+ * google.options({auth: authClient});
2830
+ *
2831
+ * // Do the magic
2832
+ * const res = await dataform.projects.locations.repositories.list({
2833
+ * // Optional. Filter for the returned list.
2834
+ * filter: 'placeholder-value',
2835
+ * // 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.
2836
+ * orderBy: 'placeholder-value',
2837
+ * // Optional. Maximum number of repositories to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
2838
+ * pageSize: 'placeholder-value',
2839
+ * // 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.
2840
+ * pageToken: 'placeholder-value',
2841
+ * // Required. The location in which to list repositories. Must be in the format `projects/x/locations/x`.
2842
+ * parent: 'projects/my-project/locations/my-location',
2843
+ * });
2844
+ * console.log(res.data);
2845
+ *
2846
+ * // Example response
2847
+ * // {
2848
+ * // "nextPageToken": "my_nextPageToken",
2849
+ * // "repositories": [],
2850
+ * // "unreachable": []
2851
+ * // }
2852
+ * }
2853
+ *
2854
+ * main().catch(e => {
2855
+ * console.error(e);
2856
+ * throw e;
2857
+ * });
2858
+ *
2859
+ * ```
2088
2860
  *
2089
2861
  * @param params - Parameters for request
2090
2862
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2099,6 +2871,87 @@ export declare namespace dataform_v1beta1 {
2099
2871
  list(callback: BodyResponseCallback<Schema$ListRepositoriesResponse>): void;
2100
2872
  /**
2101
2873
  * 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.*
2874
+ * @example
2875
+ * ```js
2876
+ * // Before running the sample:
2877
+ * // - Enable the API at:
2878
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
2879
+ * // - Login into gcloud by running:
2880
+ * // ```sh
2881
+ * // $ gcloud auth application-default login
2882
+ * // ```
2883
+ * // - Install the npm module by running:
2884
+ * // ```sh
2885
+ * // $ npm install googleapis
2886
+ * // ```
2887
+ *
2888
+ * const {google} = require('googleapis');
2889
+ * const dataform = google.dataform('v1beta1');
2890
+ *
2891
+ * async function main() {
2892
+ * const auth = new google.auth.GoogleAuth({
2893
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2894
+ * scopes: [
2895
+ * 'https://www.googleapis.com/auth/bigquery',
2896
+ * 'https://www.googleapis.com/auth/cloud-platform',
2897
+ * ],
2898
+ * });
2899
+ *
2900
+ * // Acquire an auth client, and bind it to all future calls
2901
+ * const authClient = await auth.getClient();
2902
+ * google.options({auth: authClient});
2903
+ *
2904
+ * // Do the magic
2905
+ * const res = await dataform.projects.locations.repositories.patch({
2906
+ * // Identifier. The repository's name.
2907
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie',
2908
+ * // Optional. Specifies the fields to be updated in the repository. If left unset, all fields will be updated.
2909
+ * updateMask: 'placeholder-value',
2910
+ *
2911
+ * // Request body metadata
2912
+ * requestBody: {
2913
+ * // request body parameters
2914
+ * // {
2915
+ * // "createTime": "my_createTime",
2916
+ * // "dataEncryptionState": {},
2917
+ * // "displayName": "my_displayName",
2918
+ * // "gitRemoteSettings": {},
2919
+ * // "internalMetadata": "my_internalMetadata",
2920
+ * // "kmsKeyName": "my_kmsKeyName",
2921
+ * // "labels": {},
2922
+ * // "name": "my_name",
2923
+ * // "npmrcEnvironmentVariablesSecretVersion": "my_npmrcEnvironmentVariablesSecretVersion",
2924
+ * // "serviceAccount": "my_serviceAccount",
2925
+ * // "setAuthenticatedUserAdmin": false,
2926
+ * // "workspaceCompilationOverrides": {}
2927
+ * // }
2928
+ * },
2929
+ * });
2930
+ * console.log(res.data);
2931
+ *
2932
+ * // Example response
2933
+ * // {
2934
+ * // "createTime": "my_createTime",
2935
+ * // "dataEncryptionState": {},
2936
+ * // "displayName": "my_displayName",
2937
+ * // "gitRemoteSettings": {},
2938
+ * // "internalMetadata": "my_internalMetadata",
2939
+ * // "kmsKeyName": "my_kmsKeyName",
2940
+ * // "labels": {},
2941
+ * // "name": "my_name",
2942
+ * // "npmrcEnvironmentVariablesSecretVersion": "my_npmrcEnvironmentVariablesSecretVersion",
2943
+ * // "serviceAccount": "my_serviceAccount",
2944
+ * // "setAuthenticatedUserAdmin": false,
2945
+ * // "workspaceCompilationOverrides": {}
2946
+ * // }
2947
+ * }
2948
+ *
2949
+ * main().catch(e => {
2950
+ * console.error(e);
2951
+ * throw e;
2952
+ * });
2953
+ *
2954
+ * ```
2102
2955
  *
2103
2956
  * @param params - Parameters for request
2104
2957
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2113,6 +2966,65 @@ export declare namespace dataform_v1beta1 {
2113
2966
  patch(callback: BodyResponseCallback<Schema$Repository>): void;
2114
2967
  /**
2115
2968
  * Returns the contents of a given Repository directory. The Repository must not have a value for `git_remote_settings.url`.
2969
+ * @example
2970
+ * ```js
2971
+ * // Before running the sample:
2972
+ * // - Enable the API at:
2973
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
2974
+ * // - Login into gcloud by running:
2975
+ * // ```sh
2976
+ * // $ gcloud auth application-default login
2977
+ * // ```
2978
+ * // - Install the npm module by running:
2979
+ * // ```sh
2980
+ * // $ npm install googleapis
2981
+ * // ```
2982
+ *
2983
+ * const {google} = require('googleapis');
2984
+ * const dataform = google.dataform('v1beta1');
2985
+ *
2986
+ * async function main() {
2987
+ * const auth = new google.auth.GoogleAuth({
2988
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2989
+ * scopes: [
2990
+ * 'https://www.googleapis.com/auth/bigquery',
2991
+ * 'https://www.googleapis.com/auth/cloud-platform',
2992
+ * ],
2993
+ * });
2994
+ *
2995
+ * // Acquire an auth client, and bind it to all future calls
2996
+ * const authClient = await auth.getClient();
2997
+ * google.options({auth: authClient});
2998
+ *
2999
+ * // Do the magic
3000
+ * const res =
3001
+ * await dataform.projects.locations.repositories.queryDirectoryContents({
3002
+ * // Optional. The Commit SHA for the commit to query from. If unset, the directory will be queried from HEAD.
3003
+ * commitSha: 'placeholder-value',
3004
+ * // Required. The repository's name.
3005
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie',
3006
+ * // Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
3007
+ * pageSize: 'placeholder-value',
3008
+ * // 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.
3009
+ * pageToken: 'placeholder-value',
3010
+ * // Optional. The directory's full path including directory name, relative to root. If left unset, the root is used.
3011
+ * path: 'placeholder-value',
3012
+ * });
3013
+ * console.log(res.data);
3014
+ *
3015
+ * // Example response
3016
+ * // {
3017
+ * // "directoryEntries": [],
3018
+ * // "nextPageToken": "my_nextPageToken"
3019
+ * // }
3020
+ * }
3021
+ *
3022
+ * main().catch(e => {
3023
+ * console.error(e);
3024
+ * throw e;
3025
+ * });
3026
+ *
3027
+ * ```
2116
3028
  *
2117
3029
  * @param params - Parameters for request
2118
3030
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2127,6 +3039,59 @@ export declare namespace dataform_v1beta1 {
2127
3039
  queryDirectoryContents(callback: BodyResponseCallback<Schema$QueryRepositoryDirectoryContentsResponse>): void;
2128
3040
  /**
2129
3041
  * Returns the contents of a file (inside a Repository). The Repository must not have a value for `git_remote_settings.url`.
3042
+ * @example
3043
+ * ```js
3044
+ * // Before running the sample:
3045
+ * // - Enable the API at:
3046
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
3047
+ * // - Login into gcloud by running:
3048
+ * // ```sh
3049
+ * // $ gcloud auth application-default login
3050
+ * // ```
3051
+ * // - Install the npm module by running:
3052
+ * // ```sh
3053
+ * // $ npm install googleapis
3054
+ * // ```
3055
+ *
3056
+ * const {google} = require('googleapis');
3057
+ * const dataform = google.dataform('v1beta1');
3058
+ *
3059
+ * async function main() {
3060
+ * const auth = new google.auth.GoogleAuth({
3061
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3062
+ * scopes: [
3063
+ * 'https://www.googleapis.com/auth/bigquery',
3064
+ * 'https://www.googleapis.com/auth/cloud-platform',
3065
+ * ],
3066
+ * });
3067
+ *
3068
+ * // Acquire an auth client, and bind it to all future calls
3069
+ * const authClient = await auth.getClient();
3070
+ * google.options({auth: authClient});
3071
+ *
3072
+ * // Do the magic
3073
+ * const res = await dataform.projects.locations.repositories.readFile({
3074
+ * // Optional. The commit SHA for the commit to read from. If unset, the file will be read from HEAD.
3075
+ * commitSha: 'placeholder-value',
3076
+ * // Required. The repository's name.
3077
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie',
3078
+ * // Required. Full file path to read including filename, from repository root.
3079
+ * path: 'placeholder-value',
3080
+ * });
3081
+ * console.log(res.data);
3082
+ *
3083
+ * // Example response
3084
+ * // {
3085
+ * // "contents": "my_contents"
3086
+ * // }
3087
+ * }
3088
+ *
3089
+ * main().catch(e => {
3090
+ * console.error(e);
3091
+ * throw e;
3092
+ * });
3093
+ *
3094
+ * ```
2130
3095
  *
2131
3096
  * @param params - Parameters for request
2132
3097
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2141,6 +3106,66 @@ export declare namespace dataform_v1beta1 {
2141
3106
  readFile(callback: BodyResponseCallback<Schema$ReadRepositoryFileResponse>): void;
2142
3107
  /**
2143
3108
  * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
3109
+ * @example
3110
+ * ```js
3111
+ * // Before running the sample:
3112
+ * // - Enable the API at:
3113
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
3114
+ * // - Login into gcloud by running:
3115
+ * // ```sh
3116
+ * // $ gcloud auth application-default login
3117
+ * // ```
3118
+ * // - Install the npm module by running:
3119
+ * // ```sh
3120
+ * // $ npm install googleapis
3121
+ * // ```
3122
+ *
3123
+ * const {google} = require('googleapis');
3124
+ * const dataform = google.dataform('v1beta1');
3125
+ *
3126
+ * async function main() {
3127
+ * const auth = new google.auth.GoogleAuth({
3128
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3129
+ * scopes: [
3130
+ * 'https://www.googleapis.com/auth/bigquery',
3131
+ * 'https://www.googleapis.com/auth/cloud-platform',
3132
+ * ],
3133
+ * });
3134
+ *
3135
+ * // Acquire an auth client, and bind it to all future calls
3136
+ * const authClient = await auth.getClient();
3137
+ * google.options({auth: authClient});
3138
+ *
3139
+ * // Do the magic
3140
+ * const res = await dataform.projects.locations.repositories.setIamPolicy({
3141
+ * // 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.
3142
+ * resource:
3143
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie',
3144
+ *
3145
+ * // Request body metadata
3146
+ * requestBody: {
3147
+ * // request body parameters
3148
+ * // {
3149
+ * // "policy": {}
3150
+ * // }
3151
+ * },
3152
+ * });
3153
+ * console.log(res.data);
3154
+ *
3155
+ * // Example response
3156
+ * // {
3157
+ * // "bindings": [],
3158
+ * // "etag": "my_etag",
3159
+ * // "version": 0
3160
+ * // }
3161
+ * }
3162
+ *
3163
+ * main().catch(e => {
3164
+ * console.error(e);
3165
+ * throw e;
3166
+ * });
3167
+ *
3168
+ * ```
2144
3169
  *
2145
3170
  * @param params - Parameters for request
2146
3171
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2155,6 +3180,66 @@ export declare namespace dataform_v1beta1 {
2155
3180
  setIamPolicy(callback: BodyResponseCallback<Schema$Policy>): void;
2156
3181
  /**
2157
3182
  * 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.
3183
+ * @example
3184
+ * ```js
3185
+ * // Before running the sample:
3186
+ * // - Enable the API at:
3187
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
3188
+ * // - Login into gcloud by running:
3189
+ * // ```sh
3190
+ * // $ gcloud auth application-default login
3191
+ * // ```
3192
+ * // - Install the npm module by running:
3193
+ * // ```sh
3194
+ * // $ npm install googleapis
3195
+ * // ```
3196
+ *
3197
+ * const {google} = require('googleapis');
3198
+ * const dataform = google.dataform('v1beta1');
3199
+ *
3200
+ * async function main() {
3201
+ * const auth = new google.auth.GoogleAuth({
3202
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3203
+ * scopes: [
3204
+ * 'https://www.googleapis.com/auth/bigquery',
3205
+ * 'https://www.googleapis.com/auth/cloud-platform',
3206
+ * ],
3207
+ * });
3208
+ *
3209
+ * // Acquire an auth client, and bind it to all future calls
3210
+ * const authClient = await auth.getClient();
3211
+ * google.options({auth: authClient});
3212
+ *
3213
+ * // Do the magic
3214
+ * const res = await dataform.projects.locations.repositories.testIamPermissions(
3215
+ * {
3216
+ * // 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.
3217
+ * resource:
3218
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie',
3219
+ *
3220
+ * // Request body metadata
3221
+ * requestBody: {
3222
+ * // request body parameters
3223
+ * // {
3224
+ * // "permissions": []
3225
+ * // }
3226
+ * },
3227
+ * },
3228
+ * );
3229
+ * console.log(res.data);
3230
+ *
3231
+ * // Example response
3232
+ * // {
3233
+ * // "permissions": []
3234
+ * // }
3235
+ * }
3236
+ *
3237
+ * main().catch(e => {
3238
+ * console.error(e);
3239
+ * throw e;
3240
+ * });
3241
+ *
3242
+ * ```
2158
3243
  *
2159
3244
  * @param params - Parameters for request
2160
3245
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2200,7 +3285,7 @@ export declare namespace dataform_v1beta1 {
2200
3285
  }
2201
3286
  export interface Params$Resource$Projects$Locations$Repositories$Delete extends StandardParameters {
2202
3287
  /**
2203
- * 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.)
3288
+ * 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.*.
2204
3289
  */
2205
3290
  force?: boolean;
2206
3291
  /**
@@ -2341,6 +3426,85 @@ export declare namespace dataform_v1beta1 {
2341
3426
  constructor(context: APIRequestContext);
2342
3427
  /**
2343
3428
  * Creates a new CompilationResult in a given project and location.
3429
+ * @example
3430
+ * ```js
3431
+ * // Before running the sample:
3432
+ * // - Enable the API at:
3433
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
3434
+ * // - Login into gcloud by running:
3435
+ * // ```sh
3436
+ * // $ gcloud auth application-default login
3437
+ * // ```
3438
+ * // - Install the npm module by running:
3439
+ * // ```sh
3440
+ * // $ npm install googleapis
3441
+ * // ```
3442
+ *
3443
+ * const {google} = require('googleapis');
3444
+ * const dataform = google.dataform('v1beta1');
3445
+ *
3446
+ * async function main() {
3447
+ * const auth = new google.auth.GoogleAuth({
3448
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3449
+ * scopes: [
3450
+ * 'https://www.googleapis.com/auth/bigquery',
3451
+ * 'https://www.googleapis.com/auth/cloud-platform',
3452
+ * ],
3453
+ * });
3454
+ *
3455
+ * // Acquire an auth client, and bind it to all future calls
3456
+ * const authClient = await auth.getClient();
3457
+ * google.options({auth: authClient});
3458
+ *
3459
+ * // Do the magic
3460
+ * const res =
3461
+ * await dataform.projects.locations.repositories.compilationResults.create({
3462
+ * // Required. The repository in which to create the compilation result. Must be in the format `projects/x/locations/x/repositories/x`.
3463
+ * parent:
3464
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie',
3465
+ *
3466
+ * // Request body metadata
3467
+ * requestBody: {
3468
+ * // request body parameters
3469
+ * // {
3470
+ * // "codeCompilationConfig": {},
3471
+ * // "compilationErrors": [],
3472
+ * // "createTime": "my_createTime",
3473
+ * // "dataEncryptionState": {},
3474
+ * // "dataformCoreVersion": "my_dataformCoreVersion",
3475
+ * // "gitCommitish": "my_gitCommitish",
3476
+ * // "internalMetadata": "my_internalMetadata",
3477
+ * // "name": "my_name",
3478
+ * // "releaseConfig": "my_releaseConfig",
3479
+ * // "resolvedGitCommitSha": "my_resolvedGitCommitSha",
3480
+ * // "workspace": "my_workspace"
3481
+ * // }
3482
+ * },
3483
+ * });
3484
+ * console.log(res.data);
3485
+ *
3486
+ * // Example response
3487
+ * // {
3488
+ * // "codeCompilationConfig": {},
3489
+ * // "compilationErrors": [],
3490
+ * // "createTime": "my_createTime",
3491
+ * // "dataEncryptionState": {},
3492
+ * // "dataformCoreVersion": "my_dataformCoreVersion",
3493
+ * // "gitCommitish": "my_gitCommitish",
3494
+ * // "internalMetadata": "my_internalMetadata",
3495
+ * // "name": "my_name",
3496
+ * // "releaseConfig": "my_releaseConfig",
3497
+ * // "resolvedGitCommitSha": "my_resolvedGitCommitSha",
3498
+ * // "workspace": "my_workspace"
3499
+ * // }
3500
+ * }
3501
+ *
3502
+ * main().catch(e => {
3503
+ * console.error(e);
3504
+ * throw e;
3505
+ * });
3506
+ *
3507
+ * ```
2344
3508
  *
2345
3509
  * @param params - Parameters for request
2346
3510
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2355,6 +3519,66 @@ export declare namespace dataform_v1beta1 {
2355
3519
  create(callback: BodyResponseCallback<Schema$CompilationResult>): void;
2356
3520
  /**
2357
3521
  * Fetches a single CompilationResult.
3522
+ * @example
3523
+ * ```js
3524
+ * // Before running the sample:
3525
+ * // - Enable the API at:
3526
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
3527
+ * // - Login into gcloud by running:
3528
+ * // ```sh
3529
+ * // $ gcloud auth application-default login
3530
+ * // ```
3531
+ * // - Install the npm module by running:
3532
+ * // ```sh
3533
+ * // $ npm install googleapis
3534
+ * // ```
3535
+ *
3536
+ * const {google} = require('googleapis');
3537
+ * const dataform = google.dataform('v1beta1');
3538
+ *
3539
+ * async function main() {
3540
+ * const auth = new google.auth.GoogleAuth({
3541
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3542
+ * scopes: [
3543
+ * 'https://www.googleapis.com/auth/bigquery',
3544
+ * 'https://www.googleapis.com/auth/cloud-platform',
3545
+ * ],
3546
+ * });
3547
+ *
3548
+ * // Acquire an auth client, and bind it to all future calls
3549
+ * const authClient = await auth.getClient();
3550
+ * google.options({auth: authClient});
3551
+ *
3552
+ * // Do the magic
3553
+ * const res =
3554
+ * await dataform.projects.locations.repositories.compilationResults.get({
3555
+ * // Required. The compilation result's name.
3556
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/compilationResults/my-compilationResult',
3557
+ * });
3558
+ * console.log(res.data);
3559
+ *
3560
+ * // Example response
3561
+ * // {
3562
+ * // "codeCompilationConfig": {},
3563
+ * // "compilationErrors": [],
3564
+ * // "createTime": "my_createTime",
3565
+ * // "dataEncryptionState": {},
3566
+ * // "dataformCoreVersion": "my_dataformCoreVersion",
3567
+ * // "gitCommitish": "my_gitCommitish",
3568
+ * // "internalMetadata": "my_internalMetadata",
3569
+ * // "name": "my_name",
3570
+ * // "releaseConfig": "my_releaseConfig",
3571
+ * // "resolvedGitCommitSha": "my_resolvedGitCommitSha",
3572
+ * // "workspace": "my_workspace"
3573
+ * // }
3574
+ * }
3575
+ *
3576
+ * main().catch(e => {
3577
+ * console.error(e);
3578
+ * throw e;
3579
+ * });
3580
+ *
3581
+ * ```
2358
3582
  *
2359
3583
  * @param params - Parameters for request
2360
3584
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2369,6 +3593,67 @@ export declare namespace dataform_v1beta1 {
2369
3593
  get(callback: BodyResponseCallback<Schema$CompilationResult>): void;
2370
3594
  /**
2371
3595
  * Lists CompilationResults in a given Repository.
3596
+ * @example
3597
+ * ```js
3598
+ * // Before running the sample:
3599
+ * // - Enable the API at:
3600
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
3601
+ * // - Login into gcloud by running:
3602
+ * // ```sh
3603
+ * // $ gcloud auth application-default login
3604
+ * // ```
3605
+ * // - Install the npm module by running:
3606
+ * // ```sh
3607
+ * // $ npm install googleapis
3608
+ * // ```
3609
+ *
3610
+ * const {google} = require('googleapis');
3611
+ * const dataform = google.dataform('v1beta1');
3612
+ *
3613
+ * async function main() {
3614
+ * const auth = new google.auth.GoogleAuth({
3615
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3616
+ * scopes: [
3617
+ * 'https://www.googleapis.com/auth/bigquery',
3618
+ * 'https://www.googleapis.com/auth/cloud-platform',
3619
+ * ],
3620
+ * });
3621
+ *
3622
+ * // Acquire an auth client, and bind it to all future calls
3623
+ * const authClient = await auth.getClient();
3624
+ * google.options({auth: authClient});
3625
+ *
3626
+ * // Do the magic
3627
+ * const res =
3628
+ * await dataform.projects.locations.repositories.compilationResults.list({
3629
+ * // Optional. Filter for the returned list.
3630
+ * filter: 'placeholder-value',
3631
+ * // 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.
3632
+ * orderBy: 'placeholder-value',
3633
+ * // 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.
3634
+ * pageSize: 'placeholder-value',
3635
+ * // 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.
3636
+ * pageToken: 'placeholder-value',
3637
+ * // Required. The repository in which to list compilation results. Must be in the format `projects/x/locations/x/repositories/x`.
3638
+ * parent:
3639
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie',
3640
+ * });
3641
+ * console.log(res.data);
3642
+ *
3643
+ * // Example response
3644
+ * // {
3645
+ * // "compilationResults": [],
3646
+ * // "nextPageToken": "my_nextPageToken",
3647
+ * // "unreachable": []
3648
+ * // }
3649
+ * }
3650
+ *
3651
+ * main().catch(e => {
3652
+ * console.error(e);
3653
+ * throw e;
3654
+ * });
3655
+ *
3656
+ * ```
2372
3657
  *
2373
3658
  * @param params - Parameters for request
2374
3659
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2383,6 +3668,63 @@ export declare namespace dataform_v1beta1 {
2383
3668
  list(callback: BodyResponseCallback<Schema$ListCompilationResultsResponse>): void;
2384
3669
  /**
2385
3670
  * Returns CompilationResultActions in a given CompilationResult.
3671
+ * @example
3672
+ * ```js
3673
+ * // Before running the sample:
3674
+ * // - Enable the API at:
3675
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
3676
+ * // - Login into gcloud by running:
3677
+ * // ```sh
3678
+ * // $ gcloud auth application-default login
3679
+ * // ```
3680
+ * // - Install the npm module by running:
3681
+ * // ```sh
3682
+ * // $ npm install googleapis
3683
+ * // ```
3684
+ *
3685
+ * const {google} = require('googleapis');
3686
+ * const dataform = google.dataform('v1beta1');
3687
+ *
3688
+ * async function main() {
3689
+ * const auth = new google.auth.GoogleAuth({
3690
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3691
+ * scopes: [
3692
+ * 'https://www.googleapis.com/auth/bigquery',
3693
+ * 'https://www.googleapis.com/auth/cloud-platform',
3694
+ * ],
3695
+ * });
3696
+ *
3697
+ * // Acquire an auth client, and bind it to all future calls
3698
+ * const authClient = await auth.getClient();
3699
+ * google.options({auth: authClient});
3700
+ *
3701
+ * // Do the magic
3702
+ * const res =
3703
+ * await dataform.projects.locations.repositories.compilationResults.query({
3704
+ * // Optional. Optional filter for the returned list. Filtering is only currently supported on the `file_path` field.
3705
+ * filter: 'placeholder-value',
3706
+ * // Required. The compilation result's name.
3707
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/compilationResults/my-compilationResult',
3708
+ * // 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.
3709
+ * pageSize: 'placeholder-value',
3710
+ * // 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.
3711
+ * pageToken: 'placeholder-value',
3712
+ * });
3713
+ * console.log(res.data);
3714
+ *
3715
+ * // Example response
3716
+ * // {
3717
+ * // "compilationResultActions": [],
3718
+ * // "nextPageToken": "my_nextPageToken"
3719
+ * // }
3720
+ * }
3721
+ *
3722
+ * main().catch(e => {
3723
+ * console.error(e);
3724
+ * throw e;
3725
+ * });
3726
+ *
3727
+ * ```
2386
3728
  *
2387
3729
  * @param params - Parameters for request
2388
3730
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2457,6 +3799,83 @@ export declare namespace dataform_v1beta1 {
2457
3799
  constructor(context: APIRequestContext);
2458
3800
  /**
2459
3801
  * Creates a new ReleaseConfig in a given Repository.
3802
+ * @example
3803
+ * ```js
3804
+ * // Before running the sample:
3805
+ * // - Enable the API at:
3806
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
3807
+ * // - Login into gcloud by running:
3808
+ * // ```sh
3809
+ * // $ gcloud auth application-default login
3810
+ * // ```
3811
+ * // - Install the npm module by running:
3812
+ * // ```sh
3813
+ * // $ npm install googleapis
3814
+ * // ```
3815
+ *
3816
+ * const {google} = require('googleapis');
3817
+ * const dataform = google.dataform('v1beta1');
3818
+ *
3819
+ * async function main() {
3820
+ * const auth = new google.auth.GoogleAuth({
3821
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3822
+ * scopes: [
3823
+ * 'https://www.googleapis.com/auth/bigquery',
3824
+ * 'https://www.googleapis.com/auth/cloud-platform',
3825
+ * ],
3826
+ * });
3827
+ *
3828
+ * // Acquire an auth client, and bind it to all future calls
3829
+ * const authClient = await auth.getClient();
3830
+ * google.options({auth: authClient});
3831
+ *
3832
+ * // Do the magic
3833
+ * const res =
3834
+ * await dataform.projects.locations.repositories.releaseConfigs.create({
3835
+ * // Required. The repository in which to create the release config. Must be in the format `projects/x/locations/x/repositories/x`.
3836
+ * parent:
3837
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie',
3838
+ * // Required. The ID to use for the release config, which will become the final component of the release config's resource name.
3839
+ * releaseConfigId: 'placeholder-value',
3840
+ *
3841
+ * // Request body metadata
3842
+ * requestBody: {
3843
+ * // request body parameters
3844
+ * // {
3845
+ * // "codeCompilationConfig": {},
3846
+ * // "cronSchedule": "my_cronSchedule",
3847
+ * // "disabled": false,
3848
+ * // "gitCommitish": "my_gitCommitish",
3849
+ * // "internalMetadata": "my_internalMetadata",
3850
+ * // "name": "my_name",
3851
+ * // "recentScheduledReleaseRecords": [],
3852
+ * // "releaseCompilationResult": "my_releaseCompilationResult",
3853
+ * // "timeZone": "my_timeZone"
3854
+ * // }
3855
+ * },
3856
+ * });
3857
+ * console.log(res.data);
3858
+ *
3859
+ * // Example response
3860
+ * // {
3861
+ * // "codeCompilationConfig": {},
3862
+ * // "cronSchedule": "my_cronSchedule",
3863
+ * // "disabled": false,
3864
+ * // "gitCommitish": "my_gitCommitish",
3865
+ * // "internalMetadata": "my_internalMetadata",
3866
+ * // "name": "my_name",
3867
+ * // "recentScheduledReleaseRecords": [],
3868
+ * // "releaseCompilationResult": "my_releaseCompilationResult",
3869
+ * // "timeZone": "my_timeZone"
3870
+ * // }
3871
+ * }
3872
+ *
3873
+ * main().catch(e => {
3874
+ * console.error(e);
3875
+ * throw e;
3876
+ * });
3877
+ *
3878
+ * ```
2460
3879
  *
2461
3880
  * @param params - Parameters for request
2462
3881
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2471,6 +3890,54 @@ export declare namespace dataform_v1beta1 {
2471
3890
  create(callback: BodyResponseCallback<Schema$ReleaseConfig>): void;
2472
3891
  /**
2473
3892
  * Deletes a single ReleaseConfig.
3893
+ * @example
3894
+ * ```js
3895
+ * // Before running the sample:
3896
+ * // - Enable the API at:
3897
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
3898
+ * // - Login into gcloud by running:
3899
+ * // ```sh
3900
+ * // $ gcloud auth application-default login
3901
+ * // ```
3902
+ * // - Install the npm module by running:
3903
+ * // ```sh
3904
+ * // $ npm install googleapis
3905
+ * // ```
3906
+ *
3907
+ * const {google} = require('googleapis');
3908
+ * const dataform = google.dataform('v1beta1');
3909
+ *
3910
+ * async function main() {
3911
+ * const auth = new google.auth.GoogleAuth({
3912
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3913
+ * scopes: [
3914
+ * 'https://www.googleapis.com/auth/bigquery',
3915
+ * 'https://www.googleapis.com/auth/cloud-platform',
3916
+ * ],
3917
+ * });
3918
+ *
3919
+ * // Acquire an auth client, and bind it to all future calls
3920
+ * const authClient = await auth.getClient();
3921
+ * google.options({auth: authClient});
3922
+ *
3923
+ * // Do the magic
3924
+ * const res =
3925
+ * await dataform.projects.locations.repositories.releaseConfigs.delete({
3926
+ * // Required. The release config's name.
3927
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/releaseConfigs/my-releaseConfig',
3928
+ * });
3929
+ * console.log(res.data);
3930
+ *
3931
+ * // Example response
3932
+ * // {}
3933
+ * }
3934
+ *
3935
+ * main().catch(e => {
3936
+ * console.error(e);
3937
+ * throw e;
3938
+ * });
3939
+ *
3940
+ * ```
2474
3941
  *
2475
3942
  * @param params - Parameters for request
2476
3943
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2485,6 +3952,65 @@ export declare namespace dataform_v1beta1 {
2485
3952
  delete(callback: BodyResponseCallback<Schema$Empty>): void;
2486
3953
  /**
2487
3954
  * Fetches a single ReleaseConfig.
3955
+ * @example
3956
+ * ```js
3957
+ * // Before running the sample:
3958
+ * // - Enable the API at:
3959
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
3960
+ * // - Login into gcloud by running:
3961
+ * // ```sh
3962
+ * // $ gcloud auth application-default login
3963
+ * // ```
3964
+ * // - Install the npm module by running:
3965
+ * // ```sh
3966
+ * // $ npm install googleapis
3967
+ * // ```
3968
+ *
3969
+ * const {google} = require('googleapis');
3970
+ * const dataform = google.dataform('v1beta1');
3971
+ *
3972
+ * async function main() {
3973
+ * const auth = new google.auth.GoogleAuth({
3974
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3975
+ * scopes: [
3976
+ * 'https://www.googleapis.com/auth/bigquery',
3977
+ * 'https://www.googleapis.com/auth/cloud-platform',
3978
+ * ],
3979
+ * });
3980
+ *
3981
+ * // Acquire an auth client, and bind it to all future calls
3982
+ * const authClient = await auth.getClient();
3983
+ * google.options({auth: authClient});
3984
+ *
3985
+ * // Do the magic
3986
+ * const res = await dataform.projects.locations.repositories.releaseConfigs.get(
3987
+ * {
3988
+ * // Required. The release config's name.
3989
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/releaseConfigs/my-releaseConfig',
3990
+ * },
3991
+ * );
3992
+ * console.log(res.data);
3993
+ *
3994
+ * // Example response
3995
+ * // {
3996
+ * // "codeCompilationConfig": {},
3997
+ * // "cronSchedule": "my_cronSchedule",
3998
+ * // "disabled": false,
3999
+ * // "gitCommitish": "my_gitCommitish",
4000
+ * // "internalMetadata": "my_internalMetadata",
4001
+ * // "name": "my_name",
4002
+ * // "recentScheduledReleaseRecords": [],
4003
+ * // "releaseCompilationResult": "my_releaseCompilationResult",
4004
+ * // "timeZone": "my_timeZone"
4005
+ * // }
4006
+ * }
4007
+ *
4008
+ * main().catch(e => {
4009
+ * console.error(e);
4010
+ * throw e;
4011
+ * });
4012
+ *
4013
+ * ```
2488
4014
  *
2489
4015
  * @param params - Parameters for request
2490
4016
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2499,6 +4025,63 @@ export declare namespace dataform_v1beta1 {
2499
4025
  get(callback: BodyResponseCallback<Schema$ReleaseConfig>): void;
2500
4026
  /**
2501
4027
  * Lists ReleaseConfigs in a given Repository.
4028
+ * @example
4029
+ * ```js
4030
+ * // Before running the sample:
4031
+ * // - Enable the API at:
4032
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
4033
+ * // - Login into gcloud by running:
4034
+ * // ```sh
4035
+ * // $ gcloud auth application-default login
4036
+ * // ```
4037
+ * // - Install the npm module by running:
4038
+ * // ```sh
4039
+ * // $ npm install googleapis
4040
+ * // ```
4041
+ *
4042
+ * const {google} = require('googleapis');
4043
+ * const dataform = google.dataform('v1beta1');
4044
+ *
4045
+ * async function main() {
4046
+ * const auth = new google.auth.GoogleAuth({
4047
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4048
+ * scopes: [
4049
+ * 'https://www.googleapis.com/auth/bigquery',
4050
+ * 'https://www.googleapis.com/auth/cloud-platform',
4051
+ * ],
4052
+ * });
4053
+ *
4054
+ * // Acquire an auth client, and bind it to all future calls
4055
+ * const authClient = await auth.getClient();
4056
+ * google.options({auth: authClient});
4057
+ *
4058
+ * // Do the magic
4059
+ * const res =
4060
+ * await dataform.projects.locations.repositories.releaseConfigs.list({
4061
+ * // 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.
4062
+ * pageSize: 'placeholder-value',
4063
+ * // 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.
4064
+ * pageToken: 'placeholder-value',
4065
+ * // Required. The repository in which to list release configs. Must be in the format `projects/x/locations/x/repositories/x`.
4066
+ * parent:
4067
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie',
4068
+ * });
4069
+ * console.log(res.data);
4070
+ *
4071
+ * // Example response
4072
+ * // {
4073
+ * // "nextPageToken": "my_nextPageToken",
4074
+ * // "releaseConfigs": [],
4075
+ * // "unreachable": []
4076
+ * // }
4077
+ * }
4078
+ *
4079
+ * main().catch(e => {
4080
+ * console.error(e);
4081
+ * throw e;
4082
+ * });
4083
+ *
4084
+ * ```
2502
4085
  *
2503
4086
  * @param params - Parameters for request
2504
4087
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2513,6 +4096,82 @@ export declare namespace dataform_v1beta1 {
2513
4096
  list(callback: BodyResponseCallback<Schema$ListReleaseConfigsResponse>): void;
2514
4097
  /**
2515
4098
  * 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.*
4099
+ * @example
4100
+ * ```js
4101
+ * // Before running the sample:
4102
+ * // - Enable the API at:
4103
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
4104
+ * // - Login into gcloud by running:
4105
+ * // ```sh
4106
+ * // $ gcloud auth application-default login
4107
+ * // ```
4108
+ * // - Install the npm module by running:
4109
+ * // ```sh
4110
+ * // $ npm install googleapis
4111
+ * // ```
4112
+ *
4113
+ * const {google} = require('googleapis');
4114
+ * const dataform = google.dataform('v1beta1');
4115
+ *
4116
+ * async function main() {
4117
+ * const auth = new google.auth.GoogleAuth({
4118
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4119
+ * scopes: [
4120
+ * 'https://www.googleapis.com/auth/bigquery',
4121
+ * 'https://www.googleapis.com/auth/cloud-platform',
4122
+ * ],
4123
+ * });
4124
+ *
4125
+ * // Acquire an auth client, and bind it to all future calls
4126
+ * const authClient = await auth.getClient();
4127
+ * google.options({auth: authClient});
4128
+ *
4129
+ * // Do the magic
4130
+ * const res =
4131
+ * await dataform.projects.locations.repositories.releaseConfigs.patch({
4132
+ * // Identifier. The release config's name.
4133
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/releaseConfigs/my-releaseConfig',
4134
+ * // Optional. Specifies the fields to be updated in the release config. If left unset, all fields will be updated.
4135
+ * updateMask: 'placeholder-value',
4136
+ *
4137
+ * // Request body metadata
4138
+ * requestBody: {
4139
+ * // request body parameters
4140
+ * // {
4141
+ * // "codeCompilationConfig": {},
4142
+ * // "cronSchedule": "my_cronSchedule",
4143
+ * // "disabled": false,
4144
+ * // "gitCommitish": "my_gitCommitish",
4145
+ * // "internalMetadata": "my_internalMetadata",
4146
+ * // "name": "my_name",
4147
+ * // "recentScheduledReleaseRecords": [],
4148
+ * // "releaseCompilationResult": "my_releaseCompilationResult",
4149
+ * // "timeZone": "my_timeZone"
4150
+ * // }
4151
+ * },
4152
+ * });
4153
+ * console.log(res.data);
4154
+ *
4155
+ * // Example response
4156
+ * // {
4157
+ * // "codeCompilationConfig": {},
4158
+ * // "cronSchedule": "my_cronSchedule",
4159
+ * // "disabled": false,
4160
+ * // "gitCommitish": "my_gitCommitish",
4161
+ * // "internalMetadata": "my_internalMetadata",
4162
+ * // "name": "my_name",
4163
+ * // "recentScheduledReleaseRecords": [],
4164
+ * // "releaseCompilationResult": "my_releaseCompilationResult",
4165
+ * // "timeZone": "my_timeZone"
4166
+ * // }
4167
+ * }
4168
+ *
4169
+ * main().catch(e => {
4170
+ * console.error(e);
4171
+ * throw e;
4172
+ * });
4173
+ *
4174
+ * ```
2516
4175
  *
2517
4176
  * @param params - Parameters for request
2518
4177
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2585,6 +4244,85 @@ export declare namespace dataform_v1beta1 {
2585
4244
  constructor(context: APIRequestContext);
2586
4245
  /**
2587
4246
  * Creates a new WorkflowConfig in a given Repository.
4247
+ * @example
4248
+ * ```js
4249
+ * // Before running the sample:
4250
+ * // - Enable the API at:
4251
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
4252
+ * // - Login into gcloud by running:
4253
+ * // ```sh
4254
+ * // $ gcloud auth application-default login
4255
+ * // ```
4256
+ * // - Install the npm module by running:
4257
+ * // ```sh
4258
+ * // $ npm install googleapis
4259
+ * // ```
4260
+ *
4261
+ * const {google} = require('googleapis');
4262
+ * const dataform = google.dataform('v1beta1');
4263
+ *
4264
+ * async function main() {
4265
+ * const auth = new google.auth.GoogleAuth({
4266
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4267
+ * scopes: [
4268
+ * 'https://www.googleapis.com/auth/bigquery',
4269
+ * 'https://www.googleapis.com/auth/cloud-platform',
4270
+ * ],
4271
+ * });
4272
+ *
4273
+ * // Acquire an auth client, and bind it to all future calls
4274
+ * const authClient = await auth.getClient();
4275
+ * google.options({auth: authClient});
4276
+ *
4277
+ * // Do the magic
4278
+ * const res =
4279
+ * await dataform.projects.locations.repositories.workflowConfigs.create({
4280
+ * // Required. The repository in which to create the workflow config. Must be in the format `projects/x/locations/x/repositories/x`.
4281
+ * parent:
4282
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie',
4283
+ * // Required. The ID to use for the workflow config, which will become the final component of the workflow config's resource name.
4284
+ * workflowConfigId: 'placeholder-value',
4285
+ *
4286
+ * // Request body metadata
4287
+ * requestBody: {
4288
+ * // request body parameters
4289
+ * // {
4290
+ * // "createTime": "my_createTime",
4291
+ * // "cronSchedule": "my_cronSchedule",
4292
+ * // "disabled": false,
4293
+ * // "internalMetadata": "my_internalMetadata",
4294
+ * // "invocationConfig": {},
4295
+ * // "name": "my_name",
4296
+ * // "recentScheduledExecutionRecords": [],
4297
+ * // "releaseConfig": "my_releaseConfig",
4298
+ * // "timeZone": "my_timeZone",
4299
+ * // "updateTime": "my_updateTime"
4300
+ * // }
4301
+ * },
4302
+ * });
4303
+ * console.log(res.data);
4304
+ *
4305
+ * // Example response
4306
+ * // {
4307
+ * // "createTime": "my_createTime",
4308
+ * // "cronSchedule": "my_cronSchedule",
4309
+ * // "disabled": false,
4310
+ * // "internalMetadata": "my_internalMetadata",
4311
+ * // "invocationConfig": {},
4312
+ * // "name": "my_name",
4313
+ * // "recentScheduledExecutionRecords": [],
4314
+ * // "releaseConfig": "my_releaseConfig",
4315
+ * // "timeZone": "my_timeZone",
4316
+ * // "updateTime": "my_updateTime"
4317
+ * // }
4318
+ * }
4319
+ *
4320
+ * main().catch(e => {
4321
+ * console.error(e);
4322
+ * throw e;
4323
+ * });
4324
+ *
4325
+ * ```
2588
4326
  *
2589
4327
  * @param params - Parameters for request
2590
4328
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2599,6 +4337,54 @@ export declare namespace dataform_v1beta1 {
2599
4337
  create(callback: BodyResponseCallback<Schema$WorkflowConfig>): void;
2600
4338
  /**
2601
4339
  * Deletes a single WorkflowConfig.
4340
+ * @example
4341
+ * ```js
4342
+ * // Before running the sample:
4343
+ * // - Enable the API at:
4344
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
4345
+ * // - Login into gcloud by running:
4346
+ * // ```sh
4347
+ * // $ gcloud auth application-default login
4348
+ * // ```
4349
+ * // - Install the npm module by running:
4350
+ * // ```sh
4351
+ * // $ npm install googleapis
4352
+ * // ```
4353
+ *
4354
+ * const {google} = require('googleapis');
4355
+ * const dataform = google.dataform('v1beta1');
4356
+ *
4357
+ * async function main() {
4358
+ * const auth = new google.auth.GoogleAuth({
4359
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4360
+ * scopes: [
4361
+ * 'https://www.googleapis.com/auth/bigquery',
4362
+ * 'https://www.googleapis.com/auth/cloud-platform',
4363
+ * ],
4364
+ * });
4365
+ *
4366
+ * // Acquire an auth client, and bind it to all future calls
4367
+ * const authClient = await auth.getClient();
4368
+ * google.options({auth: authClient});
4369
+ *
4370
+ * // Do the magic
4371
+ * const res =
4372
+ * await dataform.projects.locations.repositories.workflowConfigs.delete({
4373
+ * // Required. The workflow config's name.
4374
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workflowConfigs/my-workflowConfig',
4375
+ * });
4376
+ * console.log(res.data);
4377
+ *
4378
+ * // Example response
4379
+ * // {}
4380
+ * }
4381
+ *
4382
+ * main().catch(e => {
4383
+ * console.error(e);
4384
+ * throw e;
4385
+ * });
4386
+ *
4387
+ * ```
2602
4388
  *
2603
4389
  * @param params - Parameters for request
2604
4390
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2613,6 +4399,65 @@ export declare namespace dataform_v1beta1 {
2613
4399
  delete(callback: BodyResponseCallback<Schema$Empty>): void;
2614
4400
  /**
2615
4401
  * Fetches a single WorkflowConfig.
4402
+ * @example
4403
+ * ```js
4404
+ * // Before running the sample:
4405
+ * // - Enable the API at:
4406
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
4407
+ * // - Login into gcloud by running:
4408
+ * // ```sh
4409
+ * // $ gcloud auth application-default login
4410
+ * // ```
4411
+ * // - Install the npm module by running:
4412
+ * // ```sh
4413
+ * // $ npm install googleapis
4414
+ * // ```
4415
+ *
4416
+ * const {google} = require('googleapis');
4417
+ * const dataform = google.dataform('v1beta1');
4418
+ *
4419
+ * async function main() {
4420
+ * const auth = new google.auth.GoogleAuth({
4421
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4422
+ * scopes: [
4423
+ * 'https://www.googleapis.com/auth/bigquery',
4424
+ * 'https://www.googleapis.com/auth/cloud-platform',
4425
+ * ],
4426
+ * });
4427
+ *
4428
+ * // Acquire an auth client, and bind it to all future calls
4429
+ * const authClient = await auth.getClient();
4430
+ * google.options({auth: authClient});
4431
+ *
4432
+ * // Do the magic
4433
+ * const res =
4434
+ * await dataform.projects.locations.repositories.workflowConfigs.get({
4435
+ * // Required. The workflow config's name.
4436
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workflowConfigs/my-workflowConfig',
4437
+ * });
4438
+ * console.log(res.data);
4439
+ *
4440
+ * // Example response
4441
+ * // {
4442
+ * // "createTime": "my_createTime",
4443
+ * // "cronSchedule": "my_cronSchedule",
4444
+ * // "disabled": false,
4445
+ * // "internalMetadata": "my_internalMetadata",
4446
+ * // "invocationConfig": {},
4447
+ * // "name": "my_name",
4448
+ * // "recentScheduledExecutionRecords": [],
4449
+ * // "releaseConfig": "my_releaseConfig",
4450
+ * // "timeZone": "my_timeZone",
4451
+ * // "updateTime": "my_updateTime"
4452
+ * // }
4453
+ * }
4454
+ *
4455
+ * main().catch(e => {
4456
+ * console.error(e);
4457
+ * throw e;
4458
+ * });
4459
+ *
4460
+ * ```
2616
4461
  *
2617
4462
  * @param params - Parameters for request
2618
4463
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2627,6 +4472,63 @@ export declare namespace dataform_v1beta1 {
2627
4472
  get(callback: BodyResponseCallback<Schema$WorkflowConfig>): void;
2628
4473
  /**
2629
4474
  * Lists WorkflowConfigs in a given Repository.
4475
+ * @example
4476
+ * ```js
4477
+ * // Before running the sample:
4478
+ * // - Enable the API at:
4479
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
4480
+ * // - Login into gcloud by running:
4481
+ * // ```sh
4482
+ * // $ gcloud auth application-default login
4483
+ * // ```
4484
+ * // - Install the npm module by running:
4485
+ * // ```sh
4486
+ * // $ npm install googleapis
4487
+ * // ```
4488
+ *
4489
+ * const {google} = require('googleapis');
4490
+ * const dataform = google.dataform('v1beta1');
4491
+ *
4492
+ * async function main() {
4493
+ * const auth = new google.auth.GoogleAuth({
4494
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4495
+ * scopes: [
4496
+ * 'https://www.googleapis.com/auth/bigquery',
4497
+ * 'https://www.googleapis.com/auth/cloud-platform',
4498
+ * ],
4499
+ * });
4500
+ *
4501
+ * // Acquire an auth client, and bind it to all future calls
4502
+ * const authClient = await auth.getClient();
4503
+ * google.options({auth: authClient});
4504
+ *
4505
+ * // Do the magic
4506
+ * const res =
4507
+ * await dataform.projects.locations.repositories.workflowConfigs.list({
4508
+ * // 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.
4509
+ * pageSize: 'placeholder-value',
4510
+ * // 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.
4511
+ * pageToken: 'placeholder-value',
4512
+ * // Required. The repository in which to list workflow configs. Must be in the format `projects/x/locations/x/repositories/x`.
4513
+ * parent:
4514
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie',
4515
+ * });
4516
+ * console.log(res.data);
4517
+ *
4518
+ * // Example response
4519
+ * // {
4520
+ * // "nextPageToken": "my_nextPageToken",
4521
+ * // "unreachable": [],
4522
+ * // "workflowConfigs": []
4523
+ * // }
4524
+ * }
4525
+ *
4526
+ * main().catch(e => {
4527
+ * console.error(e);
4528
+ * throw e;
4529
+ * });
4530
+ *
4531
+ * ```
2630
4532
  *
2631
4533
  * @param params - Parameters for request
2632
4534
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2641,6 +4543,84 @@ export declare namespace dataform_v1beta1 {
2641
4543
  list(callback: BodyResponseCallback<Schema$ListWorkflowConfigsResponse>): void;
2642
4544
  /**
2643
4545
  * 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.*
4546
+ * @example
4547
+ * ```js
4548
+ * // Before running the sample:
4549
+ * // - Enable the API at:
4550
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
4551
+ * // - Login into gcloud by running:
4552
+ * // ```sh
4553
+ * // $ gcloud auth application-default login
4554
+ * // ```
4555
+ * // - Install the npm module by running:
4556
+ * // ```sh
4557
+ * // $ npm install googleapis
4558
+ * // ```
4559
+ *
4560
+ * const {google} = require('googleapis');
4561
+ * const dataform = google.dataform('v1beta1');
4562
+ *
4563
+ * async function main() {
4564
+ * const auth = new google.auth.GoogleAuth({
4565
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4566
+ * scopes: [
4567
+ * 'https://www.googleapis.com/auth/bigquery',
4568
+ * 'https://www.googleapis.com/auth/cloud-platform',
4569
+ * ],
4570
+ * });
4571
+ *
4572
+ * // Acquire an auth client, and bind it to all future calls
4573
+ * const authClient = await auth.getClient();
4574
+ * google.options({auth: authClient});
4575
+ *
4576
+ * // Do the magic
4577
+ * const res =
4578
+ * await dataform.projects.locations.repositories.workflowConfigs.patch({
4579
+ * // Identifier. The workflow config's name.
4580
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workflowConfigs/my-workflowConfig',
4581
+ * // Optional. Specifies the fields to be updated in the workflow config. If left unset, all fields will be updated.
4582
+ * updateMask: 'placeholder-value',
4583
+ *
4584
+ * // Request body metadata
4585
+ * requestBody: {
4586
+ * // request body parameters
4587
+ * // {
4588
+ * // "createTime": "my_createTime",
4589
+ * // "cronSchedule": "my_cronSchedule",
4590
+ * // "disabled": false,
4591
+ * // "internalMetadata": "my_internalMetadata",
4592
+ * // "invocationConfig": {},
4593
+ * // "name": "my_name",
4594
+ * // "recentScheduledExecutionRecords": [],
4595
+ * // "releaseConfig": "my_releaseConfig",
4596
+ * // "timeZone": "my_timeZone",
4597
+ * // "updateTime": "my_updateTime"
4598
+ * // }
4599
+ * },
4600
+ * });
4601
+ * console.log(res.data);
4602
+ *
4603
+ * // Example response
4604
+ * // {
4605
+ * // "createTime": "my_createTime",
4606
+ * // "cronSchedule": "my_cronSchedule",
4607
+ * // "disabled": false,
4608
+ * // "internalMetadata": "my_internalMetadata",
4609
+ * // "invocationConfig": {},
4610
+ * // "name": "my_name",
4611
+ * // "recentScheduledExecutionRecords": [],
4612
+ * // "releaseConfig": "my_releaseConfig",
4613
+ * // "timeZone": "my_timeZone",
4614
+ * // "updateTime": "my_updateTime"
4615
+ * // }
4616
+ * }
4617
+ *
4618
+ * main().catch(e => {
4619
+ * console.error(e);
4620
+ * throw e;
4621
+ * });
4622
+ *
4623
+ * ```
2644
4624
  *
2645
4625
  * @param params - Parameters for request
2646
4626
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2713,6 +4693,60 @@ export declare namespace dataform_v1beta1 {
2713
4693
  constructor(context: APIRequestContext);
2714
4694
  /**
2715
4695
  * Requests cancellation of a running WorkflowInvocation.
4696
+ * @example
4697
+ * ```js
4698
+ * // Before running the sample:
4699
+ * // - Enable the API at:
4700
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
4701
+ * // - Login into gcloud by running:
4702
+ * // ```sh
4703
+ * // $ gcloud auth application-default login
4704
+ * // ```
4705
+ * // - Install the npm module by running:
4706
+ * // ```sh
4707
+ * // $ npm install googleapis
4708
+ * // ```
4709
+ *
4710
+ * const {google} = require('googleapis');
4711
+ * const dataform = google.dataform('v1beta1');
4712
+ *
4713
+ * async function main() {
4714
+ * const auth = new google.auth.GoogleAuth({
4715
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4716
+ * scopes: [
4717
+ * 'https://www.googleapis.com/auth/bigquery',
4718
+ * 'https://www.googleapis.com/auth/cloud-platform',
4719
+ * ],
4720
+ * });
4721
+ *
4722
+ * // Acquire an auth client, and bind it to all future calls
4723
+ * const authClient = await auth.getClient();
4724
+ * google.options({auth: authClient});
4725
+ *
4726
+ * // Do the magic
4727
+ * const res =
4728
+ * await dataform.projects.locations.repositories.workflowInvocations.cancel({
4729
+ * // Required. The workflow invocation resource's name.
4730
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workflowInvocations/my-workflowInvocation',
4731
+ *
4732
+ * // Request body metadata
4733
+ * requestBody: {
4734
+ * // request body parameters
4735
+ * // {}
4736
+ * },
4737
+ * });
4738
+ * console.log(res.data);
4739
+ *
4740
+ * // Example response
4741
+ * // {}
4742
+ * }
4743
+ *
4744
+ * main().catch(e => {
4745
+ * console.error(e);
4746
+ * throw e;
4747
+ * });
4748
+ *
4749
+ * ```
2716
4750
  *
2717
4751
  * @param params - Parameters for request
2718
4752
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2727,6 +4761,81 @@ export declare namespace dataform_v1beta1 {
2727
4761
  cancel(callback: BodyResponseCallback<Schema$CancelWorkflowInvocationResponse>): void;
2728
4762
  /**
2729
4763
  * Creates a new WorkflowInvocation in a given Repository.
4764
+ * @example
4765
+ * ```js
4766
+ * // Before running the sample:
4767
+ * // - Enable the API at:
4768
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
4769
+ * // - Login into gcloud by running:
4770
+ * // ```sh
4771
+ * // $ gcloud auth application-default login
4772
+ * // ```
4773
+ * // - Install the npm module by running:
4774
+ * // ```sh
4775
+ * // $ npm install googleapis
4776
+ * // ```
4777
+ *
4778
+ * const {google} = require('googleapis');
4779
+ * const dataform = google.dataform('v1beta1');
4780
+ *
4781
+ * async function main() {
4782
+ * const auth = new google.auth.GoogleAuth({
4783
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4784
+ * scopes: [
4785
+ * 'https://www.googleapis.com/auth/bigquery',
4786
+ * 'https://www.googleapis.com/auth/cloud-platform',
4787
+ * ],
4788
+ * });
4789
+ *
4790
+ * // Acquire an auth client, and bind it to all future calls
4791
+ * const authClient = await auth.getClient();
4792
+ * google.options({auth: authClient});
4793
+ *
4794
+ * // Do the magic
4795
+ * const res =
4796
+ * await dataform.projects.locations.repositories.workflowInvocations.create({
4797
+ * // Required. The repository in which to create the workflow invocation. Must be in the format `projects/x/locations/x/repositories/x`.
4798
+ * parent:
4799
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie',
4800
+ *
4801
+ * // Request body metadata
4802
+ * requestBody: {
4803
+ * // request body parameters
4804
+ * // {
4805
+ * // "compilationResult": "my_compilationResult",
4806
+ * // "dataEncryptionState": {},
4807
+ * // "internalMetadata": "my_internalMetadata",
4808
+ * // "invocationConfig": {},
4809
+ * // "invocationTiming": {},
4810
+ * // "name": "my_name",
4811
+ * // "resolvedCompilationResult": "my_resolvedCompilationResult",
4812
+ * // "state": "my_state",
4813
+ * // "workflowConfig": "my_workflowConfig"
4814
+ * // }
4815
+ * },
4816
+ * });
4817
+ * console.log(res.data);
4818
+ *
4819
+ * // Example response
4820
+ * // {
4821
+ * // "compilationResult": "my_compilationResult",
4822
+ * // "dataEncryptionState": {},
4823
+ * // "internalMetadata": "my_internalMetadata",
4824
+ * // "invocationConfig": {},
4825
+ * // "invocationTiming": {},
4826
+ * // "name": "my_name",
4827
+ * // "resolvedCompilationResult": "my_resolvedCompilationResult",
4828
+ * // "state": "my_state",
4829
+ * // "workflowConfig": "my_workflowConfig"
4830
+ * // }
4831
+ * }
4832
+ *
4833
+ * main().catch(e => {
4834
+ * console.error(e);
4835
+ * throw e;
4836
+ * });
4837
+ *
4838
+ * ```
2730
4839
  *
2731
4840
  * @param params - Parameters for request
2732
4841
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2741,6 +4850,54 @@ export declare namespace dataform_v1beta1 {
2741
4850
  create(callback: BodyResponseCallback<Schema$WorkflowInvocation>): void;
2742
4851
  /**
2743
4852
  * Deletes a single WorkflowInvocation.
4853
+ * @example
4854
+ * ```js
4855
+ * // Before running the sample:
4856
+ * // - Enable the API at:
4857
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
4858
+ * // - Login into gcloud by running:
4859
+ * // ```sh
4860
+ * // $ gcloud auth application-default login
4861
+ * // ```
4862
+ * // - Install the npm module by running:
4863
+ * // ```sh
4864
+ * // $ npm install googleapis
4865
+ * // ```
4866
+ *
4867
+ * const {google} = require('googleapis');
4868
+ * const dataform = google.dataform('v1beta1');
4869
+ *
4870
+ * async function main() {
4871
+ * const auth = new google.auth.GoogleAuth({
4872
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4873
+ * scopes: [
4874
+ * 'https://www.googleapis.com/auth/bigquery',
4875
+ * 'https://www.googleapis.com/auth/cloud-platform',
4876
+ * ],
4877
+ * });
4878
+ *
4879
+ * // Acquire an auth client, and bind it to all future calls
4880
+ * const authClient = await auth.getClient();
4881
+ * google.options({auth: authClient});
4882
+ *
4883
+ * // Do the magic
4884
+ * const res =
4885
+ * await dataform.projects.locations.repositories.workflowInvocations.delete({
4886
+ * // Required. The workflow invocation resource's name.
4887
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workflowInvocations/my-workflowInvocation',
4888
+ * });
4889
+ * console.log(res.data);
4890
+ *
4891
+ * // Example response
4892
+ * // {}
4893
+ * }
4894
+ *
4895
+ * main().catch(e => {
4896
+ * console.error(e);
4897
+ * throw e;
4898
+ * });
4899
+ *
4900
+ * ```
2744
4901
  *
2745
4902
  * @param params - Parameters for request
2746
4903
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2755,6 +4912,64 @@ export declare namespace dataform_v1beta1 {
2755
4912
  delete(callback: BodyResponseCallback<Schema$Empty>): void;
2756
4913
  /**
2757
4914
  * Fetches a single WorkflowInvocation.
4915
+ * @example
4916
+ * ```js
4917
+ * // Before running the sample:
4918
+ * // - Enable the API at:
4919
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
4920
+ * // - Login into gcloud by running:
4921
+ * // ```sh
4922
+ * // $ gcloud auth application-default login
4923
+ * // ```
4924
+ * // - Install the npm module by running:
4925
+ * // ```sh
4926
+ * // $ npm install googleapis
4927
+ * // ```
4928
+ *
4929
+ * const {google} = require('googleapis');
4930
+ * const dataform = google.dataform('v1beta1');
4931
+ *
4932
+ * async function main() {
4933
+ * const auth = new google.auth.GoogleAuth({
4934
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4935
+ * scopes: [
4936
+ * 'https://www.googleapis.com/auth/bigquery',
4937
+ * 'https://www.googleapis.com/auth/cloud-platform',
4938
+ * ],
4939
+ * });
4940
+ *
4941
+ * // Acquire an auth client, and bind it to all future calls
4942
+ * const authClient = await auth.getClient();
4943
+ * google.options({auth: authClient});
4944
+ *
4945
+ * // Do the magic
4946
+ * const res =
4947
+ * await dataform.projects.locations.repositories.workflowInvocations.get({
4948
+ * // Required. The workflow invocation resource's name.
4949
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workflowInvocations/my-workflowInvocation',
4950
+ * });
4951
+ * console.log(res.data);
4952
+ *
4953
+ * // Example response
4954
+ * // {
4955
+ * // "compilationResult": "my_compilationResult",
4956
+ * // "dataEncryptionState": {},
4957
+ * // "internalMetadata": "my_internalMetadata",
4958
+ * // "invocationConfig": {},
4959
+ * // "invocationTiming": {},
4960
+ * // "name": "my_name",
4961
+ * // "resolvedCompilationResult": "my_resolvedCompilationResult",
4962
+ * // "state": "my_state",
4963
+ * // "workflowConfig": "my_workflowConfig"
4964
+ * // }
4965
+ * }
4966
+ *
4967
+ * main().catch(e => {
4968
+ * console.error(e);
4969
+ * throw e;
4970
+ * });
4971
+ *
4972
+ * ```
2758
4973
  *
2759
4974
  * @param params - Parameters for request
2760
4975
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2769,6 +4984,67 @@ export declare namespace dataform_v1beta1 {
2769
4984
  get(callback: BodyResponseCallback<Schema$WorkflowInvocation>): void;
2770
4985
  /**
2771
4986
  * Lists WorkflowInvocations in a given Repository.
4987
+ * @example
4988
+ * ```js
4989
+ * // Before running the sample:
4990
+ * // - Enable the API at:
4991
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
4992
+ * // - Login into gcloud by running:
4993
+ * // ```sh
4994
+ * // $ gcloud auth application-default login
4995
+ * // ```
4996
+ * // - Install the npm module by running:
4997
+ * // ```sh
4998
+ * // $ npm install googleapis
4999
+ * // ```
5000
+ *
5001
+ * const {google} = require('googleapis');
5002
+ * const dataform = google.dataform('v1beta1');
5003
+ *
5004
+ * async function main() {
5005
+ * const auth = new google.auth.GoogleAuth({
5006
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5007
+ * scopes: [
5008
+ * 'https://www.googleapis.com/auth/bigquery',
5009
+ * 'https://www.googleapis.com/auth/cloud-platform',
5010
+ * ],
5011
+ * });
5012
+ *
5013
+ * // Acquire an auth client, and bind it to all future calls
5014
+ * const authClient = await auth.getClient();
5015
+ * google.options({auth: authClient});
5016
+ *
5017
+ * // Do the magic
5018
+ * const res =
5019
+ * await dataform.projects.locations.repositories.workflowInvocations.list({
5020
+ * // Optional. Filter for the returned list.
5021
+ * filter: 'placeholder-value',
5022
+ * // 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.
5023
+ * orderBy: 'placeholder-value',
5024
+ * // 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.
5025
+ * pageSize: 'placeholder-value',
5026
+ * // 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.
5027
+ * pageToken: 'placeholder-value',
5028
+ * // Required. The parent resource of the WorkflowInvocation type. Must be in the format `projects/x/locations/x/repositories/x`.
5029
+ * parent:
5030
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie',
5031
+ * });
5032
+ * console.log(res.data);
5033
+ *
5034
+ * // Example response
5035
+ * // {
5036
+ * // "nextPageToken": "my_nextPageToken",
5037
+ * // "unreachable": [],
5038
+ * // "workflowInvocations": []
5039
+ * // }
5040
+ * }
5041
+ *
5042
+ * main().catch(e => {
5043
+ * console.error(e);
5044
+ * throw e;
5045
+ * });
5046
+ *
5047
+ * ```
2772
5048
  *
2773
5049
  * @param params - Parameters for request
2774
5050
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2783,6 +5059,61 @@ export declare namespace dataform_v1beta1 {
2783
5059
  list(callback: BodyResponseCallback<Schema$ListWorkflowInvocationsResponse>): void;
2784
5060
  /**
2785
5061
  * Returns WorkflowInvocationActions in a given WorkflowInvocation.
5062
+ * @example
5063
+ * ```js
5064
+ * // Before running the sample:
5065
+ * // - Enable the API at:
5066
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
5067
+ * // - Login into gcloud by running:
5068
+ * // ```sh
5069
+ * // $ gcloud auth application-default login
5070
+ * // ```
5071
+ * // - Install the npm module by running:
5072
+ * // ```sh
5073
+ * // $ npm install googleapis
5074
+ * // ```
5075
+ *
5076
+ * const {google} = require('googleapis');
5077
+ * const dataform = google.dataform('v1beta1');
5078
+ *
5079
+ * async function main() {
5080
+ * const auth = new google.auth.GoogleAuth({
5081
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5082
+ * scopes: [
5083
+ * 'https://www.googleapis.com/auth/bigquery',
5084
+ * 'https://www.googleapis.com/auth/cloud-platform',
5085
+ * ],
5086
+ * });
5087
+ *
5088
+ * // Acquire an auth client, and bind it to all future calls
5089
+ * const authClient = await auth.getClient();
5090
+ * google.options({auth: authClient});
5091
+ *
5092
+ * // Do the magic
5093
+ * const res =
5094
+ * await dataform.projects.locations.repositories.workflowInvocations.query({
5095
+ * // Required. The workflow invocation's name.
5096
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workflowInvocations/my-workflowInvocation',
5097
+ * // 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.
5098
+ * pageSize: 'placeholder-value',
5099
+ * // 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.
5100
+ * pageToken: 'placeholder-value',
5101
+ * });
5102
+ * console.log(res.data);
5103
+ *
5104
+ * // Example response
5105
+ * // {
5106
+ * // "nextPageToken": "my_nextPageToken",
5107
+ * // "workflowInvocationActions": []
5108
+ * // }
5109
+ * }
5110
+ *
5111
+ * main().catch(e => {
5112
+ * console.error(e);
5113
+ * throw e;
5114
+ * });
5115
+ *
5116
+ * ```
2786
5117
  *
2787
5118
  * @param params - Parameters for request
2788
5119
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2869,6 +5200,63 @@ export declare namespace dataform_v1beta1 {
2869
5200
  constructor(context: APIRequestContext);
2870
5201
  /**
2871
5202
  * Applies a Git commit for uncommitted files in a Workspace.
5203
+ * @example
5204
+ * ```js
5205
+ * // Before running the sample:
5206
+ * // - Enable the API at:
5207
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
5208
+ * // - Login into gcloud by running:
5209
+ * // ```sh
5210
+ * // $ gcloud auth application-default login
5211
+ * // ```
5212
+ * // - Install the npm module by running:
5213
+ * // ```sh
5214
+ * // $ npm install googleapis
5215
+ * // ```
5216
+ *
5217
+ * const {google} = require('googleapis');
5218
+ * const dataform = google.dataform('v1beta1');
5219
+ *
5220
+ * async function main() {
5221
+ * const auth = new google.auth.GoogleAuth({
5222
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5223
+ * scopes: [
5224
+ * 'https://www.googleapis.com/auth/bigquery',
5225
+ * 'https://www.googleapis.com/auth/cloud-platform',
5226
+ * ],
5227
+ * });
5228
+ *
5229
+ * // Acquire an auth client, and bind it to all future calls
5230
+ * const authClient = await auth.getClient();
5231
+ * google.options({auth: authClient});
5232
+ *
5233
+ * // Do the magic
5234
+ * const res = await dataform.projects.locations.repositories.workspaces.commit({
5235
+ * // Required. The workspace's name.
5236
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
5237
+ *
5238
+ * // Request body metadata
5239
+ * requestBody: {
5240
+ * // request body parameters
5241
+ * // {
5242
+ * // "author": {},
5243
+ * // "commitMessage": "my_commitMessage",
5244
+ * // "paths": []
5245
+ * // }
5246
+ * },
5247
+ * });
5248
+ * console.log(res.data);
5249
+ *
5250
+ * // Example response
5251
+ * // {}
5252
+ * }
5253
+ *
5254
+ * main().catch(e => {
5255
+ * console.error(e);
5256
+ * throw e;
5257
+ * });
5258
+ *
5259
+ * ```
2872
5260
  *
2873
5261
  * @param params - Parameters for request
2874
5262
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2883,6 +5271,72 @@ export declare namespace dataform_v1beta1 {
2883
5271
  commit(callback: BodyResponseCallback<Schema$CommitWorkspaceChangesResponse>): void;
2884
5272
  /**
2885
5273
  * Creates a new Workspace in a given Repository.
5274
+ * @example
5275
+ * ```js
5276
+ * // Before running the sample:
5277
+ * // - Enable the API at:
5278
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
5279
+ * // - Login into gcloud by running:
5280
+ * // ```sh
5281
+ * // $ gcloud auth application-default login
5282
+ * // ```
5283
+ * // - Install the npm module by running:
5284
+ * // ```sh
5285
+ * // $ npm install googleapis
5286
+ * // ```
5287
+ *
5288
+ * const {google} = require('googleapis');
5289
+ * const dataform = google.dataform('v1beta1');
5290
+ *
5291
+ * async function main() {
5292
+ * const auth = new google.auth.GoogleAuth({
5293
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5294
+ * scopes: [
5295
+ * 'https://www.googleapis.com/auth/bigquery',
5296
+ * 'https://www.googleapis.com/auth/cloud-platform',
5297
+ * ],
5298
+ * });
5299
+ *
5300
+ * // Acquire an auth client, and bind it to all future calls
5301
+ * const authClient = await auth.getClient();
5302
+ * google.options({auth: authClient});
5303
+ *
5304
+ * // Do the magic
5305
+ * const res = await dataform.projects.locations.repositories.workspaces.create({
5306
+ * // Required. The repository in which to create the workspace. Must be in the format `projects/x/locations/x/repositories/x`.
5307
+ * parent:
5308
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie',
5309
+ * // Required. The ID to use for the workspace, which will become the final component of the workspace's resource name.
5310
+ * workspaceId: 'placeholder-value',
5311
+ *
5312
+ * // Request body metadata
5313
+ * requestBody: {
5314
+ * // request body parameters
5315
+ * // {
5316
+ * // "createTime": "my_createTime",
5317
+ * // "dataEncryptionState": {},
5318
+ * // "internalMetadata": "my_internalMetadata",
5319
+ * // "name": "my_name"
5320
+ * // }
5321
+ * },
5322
+ * });
5323
+ * console.log(res.data);
5324
+ *
5325
+ * // Example response
5326
+ * // {
5327
+ * // "createTime": "my_createTime",
5328
+ * // "dataEncryptionState": {},
5329
+ * // "internalMetadata": "my_internalMetadata",
5330
+ * // "name": "my_name"
5331
+ * // }
5332
+ * }
5333
+ *
5334
+ * main().catch(e => {
5335
+ * console.error(e);
5336
+ * throw e;
5337
+ * });
5338
+ *
5339
+ * ```
2886
5340
  *
2887
5341
  * @param params - Parameters for request
2888
5342
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2897,6 +5351,53 @@ export declare namespace dataform_v1beta1 {
2897
5351
  create(callback: BodyResponseCallback<Schema$Workspace>): void;
2898
5352
  /**
2899
5353
  * Deletes a single Workspace.
5354
+ * @example
5355
+ * ```js
5356
+ * // Before running the sample:
5357
+ * // - Enable the API at:
5358
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
5359
+ * // - Login into gcloud by running:
5360
+ * // ```sh
5361
+ * // $ gcloud auth application-default login
5362
+ * // ```
5363
+ * // - Install the npm module by running:
5364
+ * // ```sh
5365
+ * // $ npm install googleapis
5366
+ * // ```
5367
+ *
5368
+ * const {google} = require('googleapis');
5369
+ * const dataform = google.dataform('v1beta1');
5370
+ *
5371
+ * async function main() {
5372
+ * const auth = new google.auth.GoogleAuth({
5373
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5374
+ * scopes: [
5375
+ * 'https://www.googleapis.com/auth/bigquery',
5376
+ * 'https://www.googleapis.com/auth/cloud-platform',
5377
+ * ],
5378
+ * });
5379
+ *
5380
+ * // Acquire an auth client, and bind it to all future calls
5381
+ * const authClient = await auth.getClient();
5382
+ * google.options({auth: authClient});
5383
+ *
5384
+ * // Do the magic
5385
+ * const res = await dataform.projects.locations.repositories.workspaces.delete({
5386
+ * // Required. The workspace resource's name.
5387
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
5388
+ * });
5389
+ * console.log(res.data);
5390
+ *
5391
+ * // Example response
5392
+ * // {}
5393
+ * }
5394
+ *
5395
+ * main().catch(e => {
5396
+ * console.error(e);
5397
+ * throw e;
5398
+ * });
5399
+ *
5400
+ * ```
2900
5401
  *
2901
5402
  * @param params - Parameters for request
2902
5403
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2911,6 +5412,59 @@ export declare namespace dataform_v1beta1 {
2911
5412
  delete(callback: BodyResponseCallback<Schema$Empty>): void;
2912
5413
  /**
2913
5414
  * Fetches Git diff for an uncommitted file in a Workspace.
5415
+ * @example
5416
+ * ```js
5417
+ * // Before running the sample:
5418
+ * // - Enable the API at:
5419
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
5420
+ * // - Login into gcloud by running:
5421
+ * // ```sh
5422
+ * // $ gcloud auth application-default login
5423
+ * // ```
5424
+ * // - Install the npm module by running:
5425
+ * // ```sh
5426
+ * // $ npm install googleapis
5427
+ * // ```
5428
+ *
5429
+ * const {google} = require('googleapis');
5430
+ * const dataform = google.dataform('v1beta1');
5431
+ *
5432
+ * async function main() {
5433
+ * const auth = new google.auth.GoogleAuth({
5434
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5435
+ * scopes: [
5436
+ * 'https://www.googleapis.com/auth/bigquery',
5437
+ * 'https://www.googleapis.com/auth/cloud-platform',
5438
+ * ],
5439
+ * });
5440
+ *
5441
+ * // Acquire an auth client, and bind it to all future calls
5442
+ * const authClient = await auth.getClient();
5443
+ * google.options({auth: authClient});
5444
+ *
5445
+ * // Do the magic
5446
+ * const res =
5447
+ * await dataform.projects.locations.repositories.workspaces.fetchFileDiff({
5448
+ * // Required. The file's full path including filename, relative to the workspace root.
5449
+ * path: 'placeholder-value',
5450
+ * // Required. The workspace's name.
5451
+ * workspace:
5452
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
5453
+ * });
5454
+ * console.log(res.data);
5455
+ *
5456
+ * // Example response
5457
+ * // {
5458
+ * // "formattedDiff": "my_formattedDiff"
5459
+ * // }
5460
+ * }
5461
+ *
5462
+ * main().catch(e => {
5463
+ * console.error(e);
5464
+ * throw e;
5465
+ * });
5466
+ *
5467
+ * ```
2914
5468
  *
2915
5469
  * @param params - Parameters for request
2916
5470
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2925,6 +5479,58 @@ export declare namespace dataform_v1beta1 {
2925
5479
  fetchFileDiff(callback: BodyResponseCallback<Schema$FetchFileDiffResponse>): void;
2926
5480
  /**
2927
5481
  * Fetches Git statuses for the files in a Workspace.
5482
+ * @example
5483
+ * ```js
5484
+ * // Before running the sample:
5485
+ * // - Enable the API at:
5486
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
5487
+ * // - Login into gcloud by running:
5488
+ * // ```sh
5489
+ * // $ gcloud auth application-default login
5490
+ * // ```
5491
+ * // - Install the npm module by running:
5492
+ * // ```sh
5493
+ * // $ npm install googleapis
5494
+ * // ```
5495
+ *
5496
+ * const {google} = require('googleapis');
5497
+ * const dataform = google.dataform('v1beta1');
5498
+ *
5499
+ * async function main() {
5500
+ * const auth = new google.auth.GoogleAuth({
5501
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5502
+ * scopes: [
5503
+ * 'https://www.googleapis.com/auth/bigquery',
5504
+ * 'https://www.googleapis.com/auth/cloud-platform',
5505
+ * ],
5506
+ * });
5507
+ *
5508
+ * // Acquire an auth client, and bind it to all future calls
5509
+ * const authClient = await auth.getClient();
5510
+ * google.options({auth: authClient});
5511
+ *
5512
+ * // Do the magic
5513
+ * const res =
5514
+ * await dataform.projects.locations.repositories.workspaces.fetchFileGitStatuses(
5515
+ * {
5516
+ * // Required. The workspace's name.
5517
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
5518
+ * },
5519
+ * );
5520
+ * console.log(res.data);
5521
+ *
5522
+ * // Example response
5523
+ * // {
5524
+ * // "uncommittedFileChanges": []
5525
+ * // }
5526
+ * }
5527
+ *
5528
+ * main().catch(e => {
5529
+ * console.error(e);
5530
+ * throw e;
5531
+ * });
5532
+ *
5533
+ * ```
2928
5534
  *
2929
5535
  * @param params - Parameters for request
2930
5536
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2939,6 +5545,61 @@ export declare namespace dataform_v1beta1 {
2939
5545
  fetchFileGitStatuses(callback: BodyResponseCallback<Schema$FetchFileGitStatusesResponse>): void;
2940
5546
  /**
2941
5547
  * Fetches Git ahead/behind against a remote branch.
5548
+ * @example
5549
+ * ```js
5550
+ * // Before running the sample:
5551
+ * // - Enable the API at:
5552
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
5553
+ * // - Login into gcloud by running:
5554
+ * // ```sh
5555
+ * // $ gcloud auth application-default login
5556
+ * // ```
5557
+ * // - Install the npm module by running:
5558
+ * // ```sh
5559
+ * // $ npm install googleapis
5560
+ * // ```
5561
+ *
5562
+ * const {google} = require('googleapis');
5563
+ * const dataform = google.dataform('v1beta1');
5564
+ *
5565
+ * async function main() {
5566
+ * const auth = new google.auth.GoogleAuth({
5567
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5568
+ * scopes: [
5569
+ * 'https://www.googleapis.com/auth/bigquery',
5570
+ * 'https://www.googleapis.com/auth/cloud-platform',
5571
+ * ],
5572
+ * });
5573
+ *
5574
+ * // Acquire an auth client, and bind it to all future calls
5575
+ * const authClient = await auth.getClient();
5576
+ * google.options({auth: authClient});
5577
+ *
5578
+ * // Do the magic
5579
+ * const res =
5580
+ * await dataform.projects.locations.repositories.workspaces.fetchGitAheadBehind(
5581
+ * {
5582
+ * // Required. The workspace's name.
5583
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
5584
+ * // 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.
5585
+ * remoteBranch: 'placeholder-value',
5586
+ * },
5587
+ * );
5588
+ * console.log(res.data);
5589
+ *
5590
+ * // Example response
5591
+ * // {
5592
+ * // "commitsAhead": 0,
5593
+ * // "commitsBehind": 0
5594
+ * // }
5595
+ * }
5596
+ *
5597
+ * main().catch(e => {
5598
+ * console.error(e);
5599
+ * throw e;
5600
+ * });
5601
+ *
5602
+ * ```
2942
5603
  *
2943
5604
  * @param params - Parameters for request
2944
5605
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2953,6 +5614,58 @@ export declare namespace dataform_v1beta1 {
2953
5614
  fetchGitAheadBehind(callback: BodyResponseCallback<Schema$FetchGitAheadBehindResponse>): void;
2954
5615
  /**
2955
5616
  * Fetches a single Workspace.
5617
+ * @example
5618
+ * ```js
5619
+ * // Before running the sample:
5620
+ * // - Enable the API at:
5621
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
5622
+ * // - Login into gcloud by running:
5623
+ * // ```sh
5624
+ * // $ gcloud auth application-default login
5625
+ * // ```
5626
+ * // - Install the npm module by running:
5627
+ * // ```sh
5628
+ * // $ npm install googleapis
5629
+ * // ```
5630
+ *
5631
+ * const {google} = require('googleapis');
5632
+ * const dataform = google.dataform('v1beta1');
5633
+ *
5634
+ * async function main() {
5635
+ * const auth = new google.auth.GoogleAuth({
5636
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5637
+ * scopes: [
5638
+ * 'https://www.googleapis.com/auth/bigquery',
5639
+ * 'https://www.googleapis.com/auth/cloud-platform',
5640
+ * ],
5641
+ * });
5642
+ *
5643
+ * // Acquire an auth client, and bind it to all future calls
5644
+ * const authClient = await auth.getClient();
5645
+ * google.options({auth: authClient});
5646
+ *
5647
+ * // Do the magic
5648
+ * const res = await dataform.projects.locations.repositories.workspaces.get({
5649
+ * // Required. The workspace's name.
5650
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
5651
+ * });
5652
+ * console.log(res.data);
5653
+ *
5654
+ * // Example response
5655
+ * // {
5656
+ * // "createTime": "my_createTime",
5657
+ * // "dataEncryptionState": {},
5658
+ * // "internalMetadata": "my_internalMetadata",
5659
+ * // "name": "my_name"
5660
+ * // }
5661
+ * }
5662
+ *
5663
+ * main().catch(e => {
5664
+ * console.error(e);
5665
+ * throw e;
5666
+ * });
5667
+ *
5668
+ * ```
2956
5669
  *
2957
5670
  * @param params - Parameters for request
2958
5671
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2967,6 +5680,61 @@ export declare namespace dataform_v1beta1 {
2967
5680
  get(callback: BodyResponseCallback<Schema$Workspace>): void;
2968
5681
  /**
2969
5682
  * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
5683
+ * @example
5684
+ * ```js
5685
+ * // Before running the sample:
5686
+ * // - Enable the API at:
5687
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
5688
+ * // - Login into gcloud by running:
5689
+ * // ```sh
5690
+ * // $ gcloud auth application-default login
5691
+ * // ```
5692
+ * // - Install the npm module by running:
5693
+ * // ```sh
5694
+ * // $ npm install googleapis
5695
+ * // ```
5696
+ *
5697
+ * const {google} = require('googleapis');
5698
+ * const dataform = google.dataform('v1beta1');
5699
+ *
5700
+ * async function main() {
5701
+ * const auth = new google.auth.GoogleAuth({
5702
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5703
+ * scopes: [
5704
+ * 'https://www.googleapis.com/auth/bigquery',
5705
+ * 'https://www.googleapis.com/auth/cloud-platform',
5706
+ * ],
5707
+ * });
5708
+ *
5709
+ * // Acquire an auth client, and bind it to all future calls
5710
+ * const authClient = await auth.getClient();
5711
+ * google.options({auth: authClient});
5712
+ *
5713
+ * // Do the magic
5714
+ * const res =
5715
+ * await dataform.projects.locations.repositories.workspaces.getIamPolicy({
5716
+ * // 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).
5717
+ * 'options.requestedPolicyVersion': 'placeholder-value',
5718
+ * // 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.
5719
+ * resource:
5720
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
5721
+ * });
5722
+ * console.log(res.data);
5723
+ *
5724
+ * // Example response
5725
+ * // {
5726
+ * // "bindings": [],
5727
+ * // "etag": "my_etag",
5728
+ * // "version": 0
5729
+ * // }
5730
+ * }
5731
+ *
5732
+ * main().catch(e => {
5733
+ * console.error(e);
5734
+ * throw e;
5735
+ * });
5736
+ *
5737
+ * ```
2970
5738
  *
2971
5739
  * @param params - Parameters for request
2972
5740
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2981,6 +5749,63 @@ export declare namespace dataform_v1beta1 {
2981
5749
  getIamPolicy(callback: BodyResponseCallback<Schema$Policy>): void;
2982
5750
  /**
2983
5751
  * Installs dependency NPM packages (inside a Workspace).
5752
+ * @example
5753
+ * ```js
5754
+ * // Before running the sample:
5755
+ * // - Enable the API at:
5756
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
5757
+ * // - Login into gcloud by running:
5758
+ * // ```sh
5759
+ * // $ gcloud auth application-default login
5760
+ * // ```
5761
+ * // - Install the npm module by running:
5762
+ * // ```sh
5763
+ * // $ npm install googleapis
5764
+ * // ```
5765
+ *
5766
+ * const {google} = require('googleapis');
5767
+ * const dataform = google.dataform('v1beta1');
5768
+ *
5769
+ * async function main() {
5770
+ * const auth = new google.auth.GoogleAuth({
5771
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5772
+ * scopes: [
5773
+ * 'https://www.googleapis.com/auth/bigquery',
5774
+ * 'https://www.googleapis.com/auth/cloud-platform',
5775
+ * ],
5776
+ * });
5777
+ *
5778
+ * // Acquire an auth client, and bind it to all future calls
5779
+ * const authClient = await auth.getClient();
5780
+ * google.options({auth: authClient});
5781
+ *
5782
+ * // Do the magic
5783
+ * const res =
5784
+ * await dataform.projects.locations.repositories.workspaces.installNpmPackages(
5785
+ * {
5786
+ * // Required. The workspace's name.
5787
+ * workspace:
5788
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
5789
+ *
5790
+ * // Request body metadata
5791
+ * requestBody: {
5792
+ * // request body parameters
5793
+ * // {}
5794
+ * },
5795
+ * },
5796
+ * );
5797
+ * console.log(res.data);
5798
+ *
5799
+ * // Example response
5800
+ * // {}
5801
+ * }
5802
+ *
5803
+ * main().catch(e => {
5804
+ * console.error(e);
5805
+ * throw e;
5806
+ * });
5807
+ *
5808
+ * ```
2984
5809
  *
2985
5810
  * @param params - Parameters for request
2986
5811
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2995,6 +5820,66 @@ export declare namespace dataform_v1beta1 {
2995
5820
  installNpmPackages(callback: BodyResponseCallback<Schema$InstallNpmPackagesResponse>): void;
2996
5821
  /**
2997
5822
  * Lists Workspaces in a given Repository.
5823
+ * @example
5824
+ * ```js
5825
+ * // Before running the sample:
5826
+ * // - Enable the API at:
5827
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
5828
+ * // - Login into gcloud by running:
5829
+ * // ```sh
5830
+ * // $ gcloud auth application-default login
5831
+ * // ```
5832
+ * // - Install the npm module by running:
5833
+ * // ```sh
5834
+ * // $ npm install googleapis
5835
+ * // ```
5836
+ *
5837
+ * const {google} = require('googleapis');
5838
+ * const dataform = google.dataform('v1beta1');
5839
+ *
5840
+ * async function main() {
5841
+ * const auth = new google.auth.GoogleAuth({
5842
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5843
+ * scopes: [
5844
+ * 'https://www.googleapis.com/auth/bigquery',
5845
+ * 'https://www.googleapis.com/auth/cloud-platform',
5846
+ * ],
5847
+ * });
5848
+ *
5849
+ * // Acquire an auth client, and bind it to all future calls
5850
+ * const authClient = await auth.getClient();
5851
+ * google.options({auth: authClient});
5852
+ *
5853
+ * // Do the magic
5854
+ * const res = await dataform.projects.locations.repositories.workspaces.list({
5855
+ * // Optional. Filter for the returned list.
5856
+ * filter: 'placeholder-value',
5857
+ * // 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.
5858
+ * orderBy: 'placeholder-value',
5859
+ * // Optional. Maximum number of workspaces to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
5860
+ * pageSize: 'placeholder-value',
5861
+ * // 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.
5862
+ * pageToken: 'placeholder-value',
5863
+ * // Required. The repository in which to list workspaces. Must be in the format `projects/x/locations/x/repositories/x`.
5864
+ * parent:
5865
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie',
5866
+ * });
5867
+ * console.log(res.data);
5868
+ *
5869
+ * // Example response
5870
+ * // {
5871
+ * // "nextPageToken": "my_nextPageToken",
5872
+ * // "unreachable": [],
5873
+ * // "workspaces": []
5874
+ * // }
5875
+ * }
5876
+ *
5877
+ * main().catch(e => {
5878
+ * console.error(e);
5879
+ * throw e;
5880
+ * });
5881
+ *
5882
+ * ```
2998
5883
  *
2999
5884
  * @param params - Parameters for request
3000
5885
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3009,6 +5894,63 @@ export declare namespace dataform_v1beta1 {
3009
5894
  list(callback: BodyResponseCallback<Schema$ListWorkspacesResponse>): void;
3010
5895
  /**
3011
5896
  * Creates a directory inside a Workspace.
5897
+ * @example
5898
+ * ```js
5899
+ * // Before running the sample:
5900
+ * // - Enable the API at:
5901
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
5902
+ * // - Login into gcloud by running:
5903
+ * // ```sh
5904
+ * // $ gcloud auth application-default login
5905
+ * // ```
5906
+ * // - Install the npm module by running:
5907
+ * // ```sh
5908
+ * // $ npm install googleapis
5909
+ * // ```
5910
+ *
5911
+ * const {google} = require('googleapis');
5912
+ * const dataform = google.dataform('v1beta1');
5913
+ *
5914
+ * async function main() {
5915
+ * const auth = new google.auth.GoogleAuth({
5916
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5917
+ * scopes: [
5918
+ * 'https://www.googleapis.com/auth/bigquery',
5919
+ * 'https://www.googleapis.com/auth/cloud-platform',
5920
+ * ],
5921
+ * });
5922
+ *
5923
+ * // Acquire an auth client, and bind it to all future calls
5924
+ * const authClient = await auth.getClient();
5925
+ * google.options({auth: authClient});
5926
+ *
5927
+ * // Do the magic
5928
+ * const res =
5929
+ * await dataform.projects.locations.repositories.workspaces.makeDirectory({
5930
+ * // Required. The workspace's name.
5931
+ * workspace:
5932
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
5933
+ *
5934
+ * // Request body metadata
5935
+ * requestBody: {
5936
+ * // request body parameters
5937
+ * // {
5938
+ * // "path": "my_path"
5939
+ * // }
5940
+ * },
5941
+ * });
5942
+ * console.log(res.data);
5943
+ *
5944
+ * // Example response
5945
+ * // {}
5946
+ * }
5947
+ *
5948
+ * main().catch(e => {
5949
+ * console.error(e);
5950
+ * throw e;
5951
+ * });
5952
+ *
5953
+ * ```
3012
5954
  *
3013
5955
  * @param params - Parameters for request
3014
5956
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3023,6 +5965,64 @@ export declare namespace dataform_v1beta1 {
3023
5965
  makeDirectory(callback: BodyResponseCallback<Schema$MakeDirectoryResponse>): void;
3024
5966
  /**
3025
5967
  * Moves a directory (inside a Workspace), and all of its contents, to a new location.
5968
+ * @example
5969
+ * ```js
5970
+ * // Before running the sample:
5971
+ * // - Enable the API at:
5972
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
5973
+ * // - Login into gcloud by running:
5974
+ * // ```sh
5975
+ * // $ gcloud auth application-default login
5976
+ * // ```
5977
+ * // - Install the npm module by running:
5978
+ * // ```sh
5979
+ * // $ npm install googleapis
5980
+ * // ```
5981
+ *
5982
+ * const {google} = require('googleapis');
5983
+ * const dataform = google.dataform('v1beta1');
5984
+ *
5985
+ * async function main() {
5986
+ * const auth = new google.auth.GoogleAuth({
5987
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5988
+ * scopes: [
5989
+ * 'https://www.googleapis.com/auth/bigquery',
5990
+ * 'https://www.googleapis.com/auth/cloud-platform',
5991
+ * ],
5992
+ * });
5993
+ *
5994
+ * // Acquire an auth client, and bind it to all future calls
5995
+ * const authClient = await auth.getClient();
5996
+ * google.options({auth: authClient});
5997
+ *
5998
+ * // Do the magic
5999
+ * const res =
6000
+ * await dataform.projects.locations.repositories.workspaces.moveDirectory({
6001
+ * // Required. The workspace's name.
6002
+ * workspace:
6003
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
6004
+ *
6005
+ * // Request body metadata
6006
+ * requestBody: {
6007
+ * // request body parameters
6008
+ * // {
6009
+ * // "newPath": "my_newPath",
6010
+ * // "path": "my_path"
6011
+ * // }
6012
+ * },
6013
+ * });
6014
+ * console.log(res.data);
6015
+ *
6016
+ * // Example response
6017
+ * // {}
6018
+ * }
6019
+ *
6020
+ * main().catch(e => {
6021
+ * console.error(e);
6022
+ * throw e;
6023
+ * });
6024
+ *
6025
+ * ```
3026
6026
  *
3027
6027
  * @param params - Parameters for request
3028
6028
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3037,6 +6037,64 @@ export declare namespace dataform_v1beta1 {
3037
6037
  moveDirectory(callback: BodyResponseCallback<Schema$MoveDirectoryResponse>): void;
3038
6038
  /**
3039
6039
  * Moves a file (inside a Workspace) to a new location.
6040
+ * @example
6041
+ * ```js
6042
+ * // Before running the sample:
6043
+ * // - Enable the API at:
6044
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
6045
+ * // - Login into gcloud by running:
6046
+ * // ```sh
6047
+ * // $ gcloud auth application-default login
6048
+ * // ```
6049
+ * // - Install the npm module by running:
6050
+ * // ```sh
6051
+ * // $ npm install googleapis
6052
+ * // ```
6053
+ *
6054
+ * const {google} = require('googleapis');
6055
+ * const dataform = google.dataform('v1beta1');
6056
+ *
6057
+ * async function main() {
6058
+ * const auth = new google.auth.GoogleAuth({
6059
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6060
+ * scopes: [
6061
+ * 'https://www.googleapis.com/auth/bigquery',
6062
+ * 'https://www.googleapis.com/auth/cloud-platform',
6063
+ * ],
6064
+ * });
6065
+ *
6066
+ * // Acquire an auth client, and bind it to all future calls
6067
+ * const authClient = await auth.getClient();
6068
+ * google.options({auth: authClient});
6069
+ *
6070
+ * // Do the magic
6071
+ * const res =
6072
+ * await dataform.projects.locations.repositories.workspaces.moveFile({
6073
+ * // Required. The workspace's name.
6074
+ * workspace:
6075
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
6076
+ *
6077
+ * // Request body metadata
6078
+ * requestBody: {
6079
+ * // request body parameters
6080
+ * // {
6081
+ * // "newPath": "my_newPath",
6082
+ * // "path": "my_path"
6083
+ * // }
6084
+ * },
6085
+ * });
6086
+ * console.log(res.data);
6087
+ *
6088
+ * // Example response
6089
+ * // {}
6090
+ * }
6091
+ *
6092
+ * main().catch(e => {
6093
+ * console.error(e);
6094
+ * throw e;
6095
+ * });
6096
+ *
6097
+ * ```
3040
6098
  *
3041
6099
  * @param params - Parameters for request
3042
6100
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3051,6 +6109,62 @@ export declare namespace dataform_v1beta1 {
3051
6109
  moveFile(callback: BodyResponseCallback<Schema$MoveFileResponse>): void;
3052
6110
  /**
3053
6111
  * Pulls Git commits from the Repository's remote into a Workspace.
6112
+ * @example
6113
+ * ```js
6114
+ * // Before running the sample:
6115
+ * // - Enable the API at:
6116
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
6117
+ * // - Login into gcloud by running:
6118
+ * // ```sh
6119
+ * // $ gcloud auth application-default login
6120
+ * // ```
6121
+ * // - Install the npm module by running:
6122
+ * // ```sh
6123
+ * // $ npm install googleapis
6124
+ * // ```
6125
+ *
6126
+ * const {google} = require('googleapis');
6127
+ * const dataform = google.dataform('v1beta1');
6128
+ *
6129
+ * async function main() {
6130
+ * const auth = new google.auth.GoogleAuth({
6131
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6132
+ * scopes: [
6133
+ * 'https://www.googleapis.com/auth/bigquery',
6134
+ * 'https://www.googleapis.com/auth/cloud-platform',
6135
+ * ],
6136
+ * });
6137
+ *
6138
+ * // Acquire an auth client, and bind it to all future calls
6139
+ * const authClient = await auth.getClient();
6140
+ * google.options({auth: authClient});
6141
+ *
6142
+ * // Do the magic
6143
+ * const res = await dataform.projects.locations.repositories.workspaces.pull({
6144
+ * // Required. The workspace's name.
6145
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
6146
+ *
6147
+ * // Request body metadata
6148
+ * requestBody: {
6149
+ * // request body parameters
6150
+ * // {
6151
+ * // "author": {},
6152
+ * // "remoteBranch": "my_remoteBranch"
6153
+ * // }
6154
+ * },
6155
+ * });
6156
+ * console.log(res.data);
6157
+ *
6158
+ * // Example response
6159
+ * // {}
6160
+ * }
6161
+ *
6162
+ * main().catch(e => {
6163
+ * console.error(e);
6164
+ * throw e;
6165
+ * });
6166
+ *
6167
+ * ```
3054
6168
  *
3055
6169
  * @param params - Parameters for request
3056
6170
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3065,6 +6179,61 @@ export declare namespace dataform_v1beta1 {
3065
6179
  pull(callback: BodyResponseCallback<Schema$PullGitCommitsResponse>): void;
3066
6180
  /**
3067
6181
  * Pushes Git commits from a Workspace to the Repository's remote.
6182
+ * @example
6183
+ * ```js
6184
+ * // Before running the sample:
6185
+ * // - Enable the API at:
6186
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
6187
+ * // - Login into gcloud by running:
6188
+ * // ```sh
6189
+ * // $ gcloud auth application-default login
6190
+ * // ```
6191
+ * // - Install the npm module by running:
6192
+ * // ```sh
6193
+ * // $ npm install googleapis
6194
+ * // ```
6195
+ *
6196
+ * const {google} = require('googleapis');
6197
+ * const dataform = google.dataform('v1beta1');
6198
+ *
6199
+ * async function main() {
6200
+ * const auth = new google.auth.GoogleAuth({
6201
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6202
+ * scopes: [
6203
+ * 'https://www.googleapis.com/auth/bigquery',
6204
+ * 'https://www.googleapis.com/auth/cloud-platform',
6205
+ * ],
6206
+ * });
6207
+ *
6208
+ * // Acquire an auth client, and bind it to all future calls
6209
+ * const authClient = await auth.getClient();
6210
+ * google.options({auth: authClient});
6211
+ *
6212
+ * // Do the magic
6213
+ * const res = await dataform.projects.locations.repositories.workspaces.push({
6214
+ * // Required. The workspace's name.
6215
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
6216
+ *
6217
+ * // Request body metadata
6218
+ * requestBody: {
6219
+ * // request body parameters
6220
+ * // {
6221
+ * // "remoteBranch": "my_remoteBranch"
6222
+ * // }
6223
+ * },
6224
+ * });
6225
+ * console.log(res.data);
6226
+ *
6227
+ * // Example response
6228
+ * // {}
6229
+ * }
6230
+ *
6231
+ * main().catch(e => {
6232
+ * console.error(e);
6233
+ * throw e;
6234
+ * });
6235
+ *
6236
+ * ```
3068
6237
  *
3069
6238
  * @param params - Parameters for request
3070
6239
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3079,6 +6248,66 @@ export declare namespace dataform_v1beta1 {
3079
6248
  push(callback: BodyResponseCallback<Schema$PushGitCommitsResponse>): void;
3080
6249
  /**
3081
6250
  * Returns the contents of a given Workspace directory.
6251
+ * @example
6252
+ * ```js
6253
+ * // Before running the sample:
6254
+ * // - Enable the API at:
6255
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
6256
+ * // - Login into gcloud by running:
6257
+ * // ```sh
6258
+ * // $ gcloud auth application-default login
6259
+ * // ```
6260
+ * // - Install the npm module by running:
6261
+ * // ```sh
6262
+ * // $ npm install googleapis
6263
+ * // ```
6264
+ *
6265
+ * const {google} = require('googleapis');
6266
+ * const dataform = google.dataform('v1beta1');
6267
+ *
6268
+ * async function main() {
6269
+ * const auth = new google.auth.GoogleAuth({
6270
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6271
+ * scopes: [
6272
+ * 'https://www.googleapis.com/auth/bigquery',
6273
+ * 'https://www.googleapis.com/auth/cloud-platform',
6274
+ * ],
6275
+ * });
6276
+ *
6277
+ * // Acquire an auth client, and bind it to all future calls
6278
+ * const authClient = await auth.getClient();
6279
+ * google.options({auth: authClient});
6280
+ *
6281
+ * // Do the magic
6282
+ * const res =
6283
+ * await dataform.projects.locations.repositories.workspaces.queryDirectoryContents(
6284
+ * {
6285
+ * // Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
6286
+ * pageSize: 'placeholder-value',
6287
+ * // 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.
6288
+ * pageToken: 'placeholder-value',
6289
+ * // Optional. The directory's full path including directory name, relative to the workspace root. If left unset, the workspace root is used.
6290
+ * path: 'placeholder-value',
6291
+ * // Required. The workspace's name.
6292
+ * workspace:
6293
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
6294
+ * },
6295
+ * );
6296
+ * console.log(res.data);
6297
+ *
6298
+ * // Example response
6299
+ * // {
6300
+ * // "directoryEntries": [],
6301
+ * // "nextPageToken": "my_nextPageToken"
6302
+ * // }
6303
+ * }
6304
+ *
6305
+ * main().catch(e => {
6306
+ * console.error(e);
6307
+ * throw e;
6308
+ * });
6309
+ *
6310
+ * ```
3082
6311
  *
3083
6312
  * @param params - Parameters for request
3084
6313
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3093,6 +6322,61 @@ export declare namespace dataform_v1beta1 {
3093
6322
  queryDirectoryContents(callback: BodyResponseCallback<Schema$QueryDirectoryContentsResponse>): void;
3094
6323
  /**
3095
6324
  * Returns the contents of a file (inside a Workspace).
6325
+ * @example
6326
+ * ```js
6327
+ * // Before running the sample:
6328
+ * // - Enable the API at:
6329
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
6330
+ * // - Login into gcloud by running:
6331
+ * // ```sh
6332
+ * // $ gcloud auth application-default login
6333
+ * // ```
6334
+ * // - Install the npm module by running:
6335
+ * // ```sh
6336
+ * // $ npm install googleapis
6337
+ * // ```
6338
+ *
6339
+ * const {google} = require('googleapis');
6340
+ * const dataform = google.dataform('v1beta1');
6341
+ *
6342
+ * async function main() {
6343
+ * const auth = new google.auth.GoogleAuth({
6344
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6345
+ * scopes: [
6346
+ * 'https://www.googleapis.com/auth/bigquery',
6347
+ * 'https://www.googleapis.com/auth/cloud-platform',
6348
+ * ],
6349
+ * });
6350
+ *
6351
+ * // Acquire an auth client, and bind it to all future calls
6352
+ * const authClient = await auth.getClient();
6353
+ * google.options({auth: authClient});
6354
+ *
6355
+ * // Do the magic
6356
+ * const res =
6357
+ * await dataform.projects.locations.repositories.workspaces.readFile({
6358
+ * // Required. The file's full path including filename, relative to the workspace root.
6359
+ * path: 'placeholder-value',
6360
+ * // Optional. The Git revision of the file to return. If left empty, the current contents of `path` will be returned.
6361
+ * revision: 'placeholder-value',
6362
+ * // Required. The workspace's name.
6363
+ * workspace:
6364
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
6365
+ * });
6366
+ * console.log(res.data);
6367
+ *
6368
+ * // Example response
6369
+ * // {
6370
+ * // "fileContents": "my_fileContents"
6371
+ * // }
6372
+ * }
6373
+ *
6374
+ * main().catch(e => {
6375
+ * console.error(e);
6376
+ * throw e;
6377
+ * });
6378
+ *
6379
+ * ```
3096
6380
  *
3097
6381
  * @param params - Parameters for request
3098
6382
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3107,6 +6391,63 @@ export declare namespace dataform_v1beta1 {
3107
6391
  readFile(callback: BodyResponseCallback<Schema$ReadFileResponse>): void;
3108
6392
  /**
3109
6393
  * Deletes a directory (inside a Workspace) and all of its contents.
6394
+ * @example
6395
+ * ```js
6396
+ * // Before running the sample:
6397
+ * // - Enable the API at:
6398
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
6399
+ * // - Login into gcloud by running:
6400
+ * // ```sh
6401
+ * // $ gcloud auth application-default login
6402
+ * // ```
6403
+ * // - Install the npm module by running:
6404
+ * // ```sh
6405
+ * // $ npm install googleapis
6406
+ * // ```
6407
+ *
6408
+ * const {google} = require('googleapis');
6409
+ * const dataform = google.dataform('v1beta1');
6410
+ *
6411
+ * async function main() {
6412
+ * const auth = new google.auth.GoogleAuth({
6413
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6414
+ * scopes: [
6415
+ * 'https://www.googleapis.com/auth/bigquery',
6416
+ * 'https://www.googleapis.com/auth/cloud-platform',
6417
+ * ],
6418
+ * });
6419
+ *
6420
+ * // Acquire an auth client, and bind it to all future calls
6421
+ * const authClient = await auth.getClient();
6422
+ * google.options({auth: authClient});
6423
+ *
6424
+ * // Do the magic
6425
+ * const res =
6426
+ * await dataform.projects.locations.repositories.workspaces.removeDirectory({
6427
+ * // Required. The workspace's name.
6428
+ * workspace:
6429
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
6430
+ *
6431
+ * // Request body metadata
6432
+ * requestBody: {
6433
+ * // request body parameters
6434
+ * // {
6435
+ * // "path": "my_path"
6436
+ * // }
6437
+ * },
6438
+ * });
6439
+ * console.log(res.data);
6440
+ *
6441
+ * // Example response
6442
+ * // {}
6443
+ * }
6444
+ *
6445
+ * main().catch(e => {
6446
+ * console.error(e);
6447
+ * throw e;
6448
+ * });
6449
+ *
6450
+ * ```
3110
6451
  *
3111
6452
  * @param params - Parameters for request
3112
6453
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3121,6 +6462,63 @@ export declare namespace dataform_v1beta1 {
3121
6462
  removeDirectory(callback: BodyResponseCallback<Schema$RemoveDirectoryResponse>): void;
3122
6463
  /**
3123
6464
  * Deletes a file (inside a Workspace).
6465
+ * @example
6466
+ * ```js
6467
+ * // Before running the sample:
6468
+ * // - Enable the API at:
6469
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
6470
+ * // - Login into gcloud by running:
6471
+ * // ```sh
6472
+ * // $ gcloud auth application-default login
6473
+ * // ```
6474
+ * // - Install the npm module by running:
6475
+ * // ```sh
6476
+ * // $ npm install googleapis
6477
+ * // ```
6478
+ *
6479
+ * const {google} = require('googleapis');
6480
+ * const dataform = google.dataform('v1beta1');
6481
+ *
6482
+ * async function main() {
6483
+ * const auth = new google.auth.GoogleAuth({
6484
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6485
+ * scopes: [
6486
+ * 'https://www.googleapis.com/auth/bigquery',
6487
+ * 'https://www.googleapis.com/auth/cloud-platform',
6488
+ * ],
6489
+ * });
6490
+ *
6491
+ * // Acquire an auth client, and bind it to all future calls
6492
+ * const authClient = await auth.getClient();
6493
+ * google.options({auth: authClient});
6494
+ *
6495
+ * // Do the magic
6496
+ * const res =
6497
+ * await dataform.projects.locations.repositories.workspaces.removeFile({
6498
+ * // Required. The workspace's name.
6499
+ * workspace:
6500
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
6501
+ *
6502
+ * // Request body metadata
6503
+ * requestBody: {
6504
+ * // request body parameters
6505
+ * // {
6506
+ * // "path": "my_path"
6507
+ * // }
6508
+ * },
6509
+ * });
6510
+ * console.log(res.data);
6511
+ *
6512
+ * // Example response
6513
+ * // {}
6514
+ * }
6515
+ *
6516
+ * main().catch(e => {
6517
+ * console.error(e);
6518
+ * throw e;
6519
+ * });
6520
+ *
6521
+ * ```
3124
6522
  *
3125
6523
  * @param params - Parameters for request
3126
6524
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3135,6 +6533,62 @@ export declare namespace dataform_v1beta1 {
3135
6533
  removeFile(callback: BodyResponseCallback<Schema$RemoveFileResponse>): void;
3136
6534
  /**
3137
6535
  * Performs a Git reset for uncommitted files in a Workspace.
6536
+ * @example
6537
+ * ```js
6538
+ * // Before running the sample:
6539
+ * // - Enable the API at:
6540
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
6541
+ * // - Login into gcloud by running:
6542
+ * // ```sh
6543
+ * // $ gcloud auth application-default login
6544
+ * // ```
6545
+ * // - Install the npm module by running:
6546
+ * // ```sh
6547
+ * // $ npm install googleapis
6548
+ * // ```
6549
+ *
6550
+ * const {google} = require('googleapis');
6551
+ * const dataform = google.dataform('v1beta1');
6552
+ *
6553
+ * async function main() {
6554
+ * const auth = new google.auth.GoogleAuth({
6555
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6556
+ * scopes: [
6557
+ * 'https://www.googleapis.com/auth/bigquery',
6558
+ * 'https://www.googleapis.com/auth/cloud-platform',
6559
+ * ],
6560
+ * });
6561
+ *
6562
+ * // Acquire an auth client, and bind it to all future calls
6563
+ * const authClient = await auth.getClient();
6564
+ * google.options({auth: authClient});
6565
+ *
6566
+ * // Do the magic
6567
+ * const res = await dataform.projects.locations.repositories.workspaces.reset({
6568
+ * // Required. The workspace's name.
6569
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
6570
+ *
6571
+ * // Request body metadata
6572
+ * requestBody: {
6573
+ * // request body parameters
6574
+ * // {
6575
+ * // "clean": false,
6576
+ * // "paths": []
6577
+ * // }
6578
+ * },
6579
+ * });
6580
+ * console.log(res.data);
6581
+ *
6582
+ * // Example response
6583
+ * // {}
6584
+ * }
6585
+ *
6586
+ * main().catch(e => {
6587
+ * console.error(e);
6588
+ * throw e;
6589
+ * });
6590
+ *
6591
+ * ```
3138
6592
  *
3139
6593
  * @param params - Parameters for request
3140
6594
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3149,6 +6603,64 @@ export declare namespace dataform_v1beta1 {
3149
6603
  reset(callback: BodyResponseCallback<Schema$ResetWorkspaceChangesResponse>): void;
3150
6604
  /**
3151
6605
  * Finds the contents of a given Workspace directory by filter.
6606
+ * @example
6607
+ * ```js
6608
+ * // Before running the sample:
6609
+ * // - Enable the API at:
6610
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
6611
+ * // - Login into gcloud by running:
6612
+ * // ```sh
6613
+ * // $ gcloud auth application-default login
6614
+ * // ```
6615
+ * // - Install the npm module by running:
6616
+ * // ```sh
6617
+ * // $ npm install googleapis
6618
+ * // ```
6619
+ *
6620
+ * const {google} = require('googleapis');
6621
+ * const dataform = google.dataform('v1beta1');
6622
+ *
6623
+ * async function main() {
6624
+ * const auth = new google.auth.GoogleAuth({
6625
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6626
+ * scopes: [
6627
+ * 'https://www.googleapis.com/auth/bigquery',
6628
+ * 'https://www.googleapis.com/auth/cloud-platform',
6629
+ * ],
6630
+ * });
6631
+ *
6632
+ * // Acquire an auth client, and bind it to all future calls
6633
+ * const authClient = await auth.getClient();
6634
+ * google.options({auth: authClient});
6635
+ *
6636
+ * // Do the magic
6637
+ * const res =
6638
+ * await dataform.projects.locations.repositories.workspaces.searchFiles({
6639
+ * // 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.
6640
+ * filter: 'placeholder-value',
6641
+ * // 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.
6642
+ * pageSize: 'placeholder-value',
6643
+ * // 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.
6644
+ * pageToken: 'placeholder-value',
6645
+ * // Required. The workspace's name.
6646
+ * workspace:
6647
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
6648
+ * });
6649
+ * console.log(res.data);
6650
+ *
6651
+ * // Example response
6652
+ * // {
6653
+ * // "nextPageToken": "my_nextPageToken",
6654
+ * // "searchResults": []
6655
+ * // }
6656
+ * }
6657
+ *
6658
+ * main().catch(e => {
6659
+ * console.error(e);
6660
+ * throw e;
6661
+ * });
6662
+ *
6663
+ * ```
3152
6664
  *
3153
6665
  * @param params - Parameters for request
3154
6666
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3163,6 +6675,67 @@ export declare namespace dataform_v1beta1 {
3163
6675
  searchFiles(callback: BodyResponseCallback<Schema$SearchFilesResponse>): void;
3164
6676
  /**
3165
6677
  * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
6678
+ * @example
6679
+ * ```js
6680
+ * // Before running the sample:
6681
+ * // - Enable the API at:
6682
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
6683
+ * // - Login into gcloud by running:
6684
+ * // ```sh
6685
+ * // $ gcloud auth application-default login
6686
+ * // ```
6687
+ * // - Install the npm module by running:
6688
+ * // ```sh
6689
+ * // $ npm install googleapis
6690
+ * // ```
6691
+ *
6692
+ * const {google} = require('googleapis');
6693
+ * const dataform = google.dataform('v1beta1');
6694
+ *
6695
+ * async function main() {
6696
+ * const auth = new google.auth.GoogleAuth({
6697
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6698
+ * scopes: [
6699
+ * 'https://www.googleapis.com/auth/bigquery',
6700
+ * 'https://www.googleapis.com/auth/cloud-platform',
6701
+ * ],
6702
+ * });
6703
+ *
6704
+ * // Acquire an auth client, and bind it to all future calls
6705
+ * const authClient = await auth.getClient();
6706
+ * google.options({auth: authClient});
6707
+ *
6708
+ * // Do the magic
6709
+ * const res =
6710
+ * await dataform.projects.locations.repositories.workspaces.setIamPolicy({
6711
+ * // 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.
6712
+ * resource:
6713
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
6714
+ *
6715
+ * // Request body metadata
6716
+ * requestBody: {
6717
+ * // request body parameters
6718
+ * // {
6719
+ * // "policy": {}
6720
+ * // }
6721
+ * },
6722
+ * });
6723
+ * console.log(res.data);
6724
+ *
6725
+ * // Example response
6726
+ * // {
6727
+ * // "bindings": [],
6728
+ * // "etag": "my_etag",
6729
+ * // "version": 0
6730
+ * // }
6731
+ * }
6732
+ *
6733
+ * main().catch(e => {
6734
+ * console.error(e);
6735
+ * throw e;
6736
+ * });
6737
+ *
6738
+ * ```
3166
6739
  *
3167
6740
  * @param params - Parameters for request
3168
6741
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3177,6 +6750,67 @@ export declare namespace dataform_v1beta1 {
3177
6750
  setIamPolicy(callback: BodyResponseCallback<Schema$Policy>): void;
3178
6751
  /**
3179
6752
  * 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.
6753
+ * @example
6754
+ * ```js
6755
+ * // Before running the sample:
6756
+ * // - Enable the API at:
6757
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
6758
+ * // - Login into gcloud by running:
6759
+ * // ```sh
6760
+ * // $ gcloud auth application-default login
6761
+ * // ```
6762
+ * // - Install the npm module by running:
6763
+ * // ```sh
6764
+ * // $ npm install googleapis
6765
+ * // ```
6766
+ *
6767
+ * const {google} = require('googleapis');
6768
+ * const dataform = google.dataform('v1beta1');
6769
+ *
6770
+ * async function main() {
6771
+ * const auth = new google.auth.GoogleAuth({
6772
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6773
+ * scopes: [
6774
+ * 'https://www.googleapis.com/auth/bigquery',
6775
+ * 'https://www.googleapis.com/auth/cloud-platform',
6776
+ * ],
6777
+ * });
6778
+ *
6779
+ * // Acquire an auth client, and bind it to all future calls
6780
+ * const authClient = await auth.getClient();
6781
+ * google.options({auth: authClient});
6782
+ *
6783
+ * // Do the magic
6784
+ * const res =
6785
+ * await dataform.projects.locations.repositories.workspaces.testIamPermissions(
6786
+ * {
6787
+ * // 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.
6788
+ * resource:
6789
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
6790
+ *
6791
+ * // Request body metadata
6792
+ * requestBody: {
6793
+ * // request body parameters
6794
+ * // {
6795
+ * // "permissions": []
6796
+ * // }
6797
+ * },
6798
+ * },
6799
+ * );
6800
+ * console.log(res.data);
6801
+ *
6802
+ * // Example response
6803
+ * // {
6804
+ * // "permissions": []
6805
+ * // }
6806
+ * }
6807
+ *
6808
+ * main().catch(e => {
6809
+ * console.error(e);
6810
+ * throw e;
6811
+ * });
6812
+ *
6813
+ * ```
3180
6814
  *
3181
6815
  * @param params - Parameters for request
3182
6816
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3191,6 +6825,64 @@ export declare namespace dataform_v1beta1 {
3191
6825
  testIamPermissions(callback: BodyResponseCallback<Schema$TestIamPermissionsResponse>): void;
3192
6826
  /**
3193
6827
  * Writes to a file (inside a Workspace).
6828
+ * @example
6829
+ * ```js
6830
+ * // Before running the sample:
6831
+ * // - Enable the API at:
6832
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
6833
+ * // - Login into gcloud by running:
6834
+ * // ```sh
6835
+ * // $ gcloud auth application-default login
6836
+ * // ```
6837
+ * // - Install the npm module by running:
6838
+ * // ```sh
6839
+ * // $ npm install googleapis
6840
+ * // ```
6841
+ *
6842
+ * const {google} = require('googleapis');
6843
+ * const dataform = google.dataform('v1beta1');
6844
+ *
6845
+ * async function main() {
6846
+ * const auth = new google.auth.GoogleAuth({
6847
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6848
+ * scopes: [
6849
+ * 'https://www.googleapis.com/auth/bigquery',
6850
+ * 'https://www.googleapis.com/auth/cloud-platform',
6851
+ * ],
6852
+ * });
6853
+ *
6854
+ * // Acquire an auth client, and bind it to all future calls
6855
+ * const authClient = await auth.getClient();
6856
+ * google.options({auth: authClient});
6857
+ *
6858
+ * // Do the magic
6859
+ * const res =
6860
+ * await dataform.projects.locations.repositories.workspaces.writeFile({
6861
+ * // Required. The workspace's name.
6862
+ * workspace:
6863
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
6864
+ *
6865
+ * // Request body metadata
6866
+ * requestBody: {
6867
+ * // request body parameters
6868
+ * // {
6869
+ * // "contents": "my_contents",
6870
+ * // "path": "my_path"
6871
+ * // }
6872
+ * },
6873
+ * });
6874
+ * console.log(res.data);
6875
+ *
6876
+ * // Example response
6877
+ * // {}
6878
+ * }
6879
+ *
6880
+ * main().catch(e => {
6881
+ * console.error(e);
6882
+ * throw e;
6883
+ * });
6884
+ *
6885
+ * ```
3194
6886
  *
3195
6887
  * @param params - Parameters for request
3196
6888
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.