@googleapis/dataform 17.1.0 → 20.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/v1beta1.ts CHANGED
@@ -247,6 +247,19 @@ export namespace dataform_v1beta1 {
247
247
  */
248
248
  role?: string | null;
249
249
  }
250
+ /**
251
+ * Contains metadata about a branch.
252
+ */
253
+ export interface Schema$BranchMetadata {
254
+ /**
255
+ * The branch name.
256
+ */
257
+ branchName?: string | null;
258
+ /**
259
+ * The last commit on the branch.
260
+ */
261
+ lastCommit?: Schema$CommitLogEntry;
262
+ }
250
263
  /**
251
264
  * The request message for Operations.CancelOperation.
252
265
  */
@@ -259,6 +272,23 @@ export namespace dataform_v1beta1 {
259
272
  * `CancelWorkflowInvocation` response message.
260
273
  */
261
274
  export interface Schema$CancelWorkflowInvocationResponse {}
275
+ /**
276
+ * `CheckoutWorkspaceBranch` request message.
277
+ */
278
+ export interface Schema$CheckoutWorkspaceBranchRequest {
279
+ /**
280
+ * Required. The name of the branch in the Git repository to which the workspace should be checked out.
281
+ */
282
+ branch?: string | null;
283
+ /**
284
+ * Optional. If set to true and the branch does not exist, it will be created. Otherwise, an error will be thrown.
285
+ */
286
+ createIfNotExists?: boolean | null;
287
+ /**
288
+ * Optional. The name of the branch in the Git repository from which the new branch should be created. If left unset, the workspace's current branch name will be used. Accepts only branch names from FetchWorkspaceBranches response, and can only be set if `create_if_not_exists` is true. Oherwise, an error will be thrown.
289
+ */
290
+ sourceBranch?: string | null;
291
+ }
262
292
  /**
263
293
  * Configures various aspects of Dataform code compilation.
264
294
  */
@@ -632,6 +662,23 @@ export namespace dataform_v1beta1 {
632
662
  */
633
663
  relationDescriptor?: Schema$RelationDescriptor;
634
664
  }
665
+ /**
666
+ * `DeleteBranch` request message.
667
+ */
668
+ export interface Schema$DeleteBranchRequest {
669
+ /**
670
+ * Required. The name of the branch in the Git repository to delete.
671
+ */
672
+ branch?: string | null;
673
+ /**
674
+ * Optional. If set to true, any non-pushed commits on the branch will be deleted. Upstream branch name will be the same as the branch to delete.
675
+ */
676
+ force?: boolean | null;
677
+ }
678
+ /**
679
+ * `DeleteBranch` response message.
680
+ */
681
+ export interface Schema$DeleteBranchResponse {}
635
682
  /**
636
683
  * Represents the delete file operation.
637
684
  */
@@ -727,6 +774,15 @@ export namespace dataform_v1beta1 {
727
774
  */
728
775
  title?: string | null;
729
776
  }
777
+ /**
778
+ * Response message for `FetchCurrentWorkspaceBranch` method.
779
+ */
780
+ export interface Schema$FetchCurrentWorkspaceBranchResponse {
781
+ /**
782
+ * The name of the current branch for the workspace.
783
+ */
784
+ branchName?: string | null;
785
+ }
730
786
  /**
731
787
  * `FetchFileDiff` response message.
732
788
  */
@@ -780,6 +836,19 @@ export namespace dataform_v1beta1 {
780
836
  */
781
837
  nextPageToken?: string | null;
782
838
  }
839
+ /**
840
+ * Response message for `FetchWorkspaceBranches` method.
841
+ */
842
+ export interface Schema$FetchWorkspaceBranchesResponse {
843
+ /**
844
+ * The branches in the workspace.
845
+ */
846
+ branches?: Schema$BranchMetadata[];
847
+ /**
848
+ * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
849
+ */
850
+ nextPageToken?: string | null;
851
+ }
783
852
  /**
784
853
  * Represents a single file operation to the repository.
785
854
  */
@@ -1999,6 +2068,23 @@ export namespace dataform_v1beta1 {
1999
2068
  */
2000
2069
  message?: string | null;
2001
2070
  }
2071
+ /**
2072
+ * `SyncWorkspaceRefs` request message.
2073
+ */
2074
+ export interface Schema$SyncWorkspaceRefsRequest {
2075
+ /**
2076
+ * Optional. Can be used to deepen the commit history of shallow clones. Git documentation: https://git-scm.com/docs/git-fetch#Documentation/git-fetch.txt---deependepth
2077
+ */
2078
+ deepen?: number | null;
2079
+ /**
2080
+ * Optional. The name of the branch in the Git remote to which the refs should be fetched for. If left unset, all remote branches will be fetched.
2081
+ */
2082
+ remoteBranchName?: string | null;
2083
+ }
2084
+ /**
2085
+ * `SyncWorkspaceRefs` response message.
2086
+ */
2087
+ export interface Schema$SyncWorkspaceRefsResponse {}
2002
2088
  /**
2003
2089
  * Represents a table update trigger configuration.
2004
2090
  */
@@ -2313,10 +2399,18 @@ export namespace dataform_v1beta1 {
2313
2399
  * Output only. A data encryption state of a Git repository if this Workspace is protected by a KMS key.
2314
2400
  */
2315
2401
  dataEncryptionState?: Schema$DataEncryptionState;
2402
+ /**
2403
+ * Optional. Input only. Immutable. The maximum depth of the Git repository to checkout for this workspace. If defined and greater than 0, the Git repository will be created as a shallow clone with the given depth, otherwise a full clone will be performed. This field is available only for GitHub, GitLab and 1p repositories with enabled branch management.
2404
+ */
2405
+ depth?: number | null;
2316
2406
  /**
2317
2407
  * Optional. If set to true, workspaces will not be moved if its linked Repository is moved. Instead, it will be deleted.
2318
2408
  */
2319
2409
  disableMoves?: boolean | null;
2410
+ /**
2411
+ * Immutable. Controls the enablement of branch checkout for the workspace. When set to True, the workspace will be allowed to checkout branches.
2412
+ */
2413
+ enableBranchManagement?: boolean | null;
2320
2414
  /**
2321
2415
  * Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
2322
2416
  */
@@ -2325,10 +2419,18 @@ export namespace dataform_v1beta1 {
2325
2419
  * Identifier. The workspace's name.
2326
2420
  */
2327
2421
  name?: string | null;
2422
+ /**
2423
+ * Optional. Input only. Immutable. The name of the default upstream branch for all pull/push operations in the remote repository for this workspace. If empty, the HEAD branch from repository will be used.
2424
+ */
2425
+ originalBranch?: string | null;
2328
2426
  /**
2329
2427
  * Output only. Metadata indicating whether this resource is user-scoped. For `Workspace` resources, the `user_scoped` field is always `true`.
2330
2428
  */
2331
2429
  privateResourceMetadata?: Schema$PrivateResourceMetadata;
2430
+ /**
2431
+ * Output only. If set to true, the workspace was created as a shallow clone. Will be set to true if the depth field is set to a value greater than 0, otherwise it will be set to false.
2432
+ */
2433
+ shallow?: boolean | null;
2332
2434
  }
2333
2435
  /**
2334
2436
  * Configures workspace compilation overrides for a repository. Primarily used by the UI (`console.cloud.google.com`). `schema_suffix` and `table_prefix` can have a special expression - `${workspaceName\}`, which refers to the workspace name from which the compilation results will be created. API callers are expected to resolve the expression in these overrides and provide them explicitly in `code_compilation_config` (https://cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories.compilationResults#codecompilationconfig) when creating workspace-scoped compilation results.
@@ -11531,6 +11633,155 @@ export namespace dataform_v1beta1 {
11531
11633
  this.context = context;
11532
11634
  }
11533
11635
 
11636
+ /**
11637
+ * Checkout a branch in a Workspace.
11638
+ * @example
11639
+ * ```js
11640
+ * // Before running the sample:
11641
+ * // - Enable the API at:
11642
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
11643
+ * // - Login into gcloud by running:
11644
+ * // ```sh
11645
+ * // $ gcloud auth application-default login
11646
+ * // ```
11647
+ * // - Install the npm module by running:
11648
+ * // ```sh
11649
+ * // $ npm install googleapis
11650
+ * // ```
11651
+ *
11652
+ * const {google} = require('googleapis');
11653
+ * const dataform = google.dataform('v1beta1');
11654
+ *
11655
+ * async function main() {
11656
+ * const auth = new google.auth.GoogleAuth({
11657
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
11658
+ * scopes: [
11659
+ * 'https://www.googleapis.com/auth/bigquery',
11660
+ * 'https://www.googleapis.com/auth/cloud-platform',
11661
+ * ],
11662
+ * });
11663
+ *
11664
+ * // Acquire an auth client, and bind it to all future calls
11665
+ * const authClient = await auth.getClient();
11666
+ * google.options({auth: authClient});
11667
+ *
11668
+ * // Do the magic
11669
+ * const res =
11670
+ * await dataform.projects.locations.repositories.workspaces.checkout({
11671
+ * // Required. The workspace resource name. Format: projects/{project\}/locations/{location\}/repositories/{repository\}/workspaces/{workspace\}
11672
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
11673
+ *
11674
+ * // Request body metadata
11675
+ * requestBody: {
11676
+ * // request body parameters
11677
+ * // {
11678
+ * // "branch": "my_branch",
11679
+ * // "createIfNotExists": false,
11680
+ * // "sourceBranch": "my_sourceBranch"
11681
+ * // }
11682
+ * },
11683
+ * });
11684
+ * console.log(res.data);
11685
+ *
11686
+ * // Example response
11687
+ * // {}
11688
+ * }
11689
+ *
11690
+ * main().catch(e => {
11691
+ * console.error(e);
11692
+ * throw e;
11693
+ * });
11694
+ *
11695
+ * ```
11696
+ *
11697
+ * @param params - Parameters for request
11698
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
11699
+ * @param callback - Optional callback that handles the response.
11700
+ * @returns A promise if used with async/await, or void if used with a callback.
11701
+ */
11702
+ checkout(
11703
+ params: Params$Resource$Projects$Locations$Repositories$Workspaces$Checkout,
11704
+ options: StreamMethodOptions
11705
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
11706
+ checkout(
11707
+ params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Checkout,
11708
+ options?: MethodOptions
11709
+ ): Promise<GaxiosResponseWithHTTP2<Schema$Empty>>;
11710
+ checkout(
11711
+ params: Params$Resource$Projects$Locations$Repositories$Workspaces$Checkout,
11712
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
11713
+ callback: BodyResponseCallback<Readable>
11714
+ ): void;
11715
+ checkout(
11716
+ params: Params$Resource$Projects$Locations$Repositories$Workspaces$Checkout,
11717
+ options: MethodOptions | BodyResponseCallback<Schema$Empty>,
11718
+ callback: BodyResponseCallback<Schema$Empty>
11719
+ ): void;
11720
+ checkout(
11721
+ params: Params$Resource$Projects$Locations$Repositories$Workspaces$Checkout,
11722
+ callback: BodyResponseCallback<Schema$Empty>
11723
+ ): void;
11724
+ checkout(callback: BodyResponseCallback<Schema$Empty>): void;
11725
+ checkout(
11726
+ paramsOrCallback?:
11727
+ | Params$Resource$Projects$Locations$Repositories$Workspaces$Checkout
11728
+ | BodyResponseCallback<Schema$Empty>
11729
+ | BodyResponseCallback<Readable>,
11730
+ optionsOrCallback?:
11731
+ | MethodOptions
11732
+ | StreamMethodOptions
11733
+ | BodyResponseCallback<Schema$Empty>
11734
+ | BodyResponseCallback<Readable>,
11735
+ callback?:
11736
+ BodyResponseCallback<Schema$Empty> | BodyResponseCallback<Readable>
11737
+ ):
11738
+ | void
11739
+ | Promise<GaxiosResponseWithHTTP2<Schema$Empty>>
11740
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
11741
+ let params = (paramsOrCallback ||
11742
+ {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Checkout;
11743
+ let options = (optionsOrCallback || {}) as MethodOptions;
11744
+
11745
+ if (typeof paramsOrCallback === 'function') {
11746
+ callback = paramsOrCallback;
11747
+ params =
11748
+ {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Checkout;
11749
+ options = {};
11750
+ }
11751
+
11752
+ if (typeof optionsOrCallback === 'function') {
11753
+ callback = optionsOrCallback;
11754
+ options = {};
11755
+ }
11756
+
11757
+ const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/';
11758
+ const parameters = {
11759
+ options: Object.assign(
11760
+ {
11761
+ url: (rootUrl + '/v1beta1/{+name}:checkout').replace(
11762
+ /([^:]\/)\/+/g,
11763
+ '$1'
11764
+ ),
11765
+ method: 'POST',
11766
+ apiVersion: '',
11767
+ },
11768
+ options
11769
+ ),
11770
+ params,
11771
+ requiredParams: ['name'],
11772
+ pathParams: ['name'],
11773
+ context: this.context,
11774
+ };
11775
+ if (callback) {
11776
+ createAPIRequest<Schema$Empty>(
11777
+ parameters,
11778
+ callback as BodyResponseCallback<unknown>
11779
+ );
11780
+ } else {
11781
+ return createAPIRequest<Schema$Empty>(parameters);
11782
+ }
11783
+ }
11784
+
11534
11785
  /**
11535
11786
  * Applies a Git commit for uncommitted files in a Workspace.
11536
11787
  * @example
@@ -11732,10 +11983,14 @@ export namespace dataform_v1beta1 {
11732
11983
  * // {
11733
11984
  * // "createTime": "my_createTime",
11734
11985
  * // "dataEncryptionState": {},
11986
+ * // "depth": 0,
11735
11987
  * // "disableMoves": false,
11988
+ * // "enableBranchManagement": false,
11736
11989
  * // "internalMetadata": "my_internalMetadata",
11737
11990
  * // "name": "my_name",
11738
- * // "privateResourceMetadata": {}
11991
+ * // "originalBranch": "my_originalBranch",
11992
+ * // "privateResourceMetadata": {},
11993
+ * // "shallow": false
11739
11994
  * // }
11740
11995
  * },
11741
11996
  * });
@@ -11745,10 +12000,14 @@ export namespace dataform_v1beta1 {
11745
12000
  * // {
11746
12001
  * // "createTime": "my_createTime",
11747
12002
  * // "dataEncryptionState": {},
12003
+ * // "depth": 0,
11748
12004
  * // "disableMoves": false,
12005
+ * // "enableBranchManagement": false,
11749
12006
  * // "internalMetadata": "my_internalMetadata",
11750
12007
  * // "name": "my_name",
11751
- * // "privateResourceMetadata": {}
12008
+ * // "originalBranch": "my_originalBranch",
12009
+ * // "privateResourceMetadata": {},
12010
+ * // "shallow": false
11752
12011
  * // }
11753
12012
  * }
11754
12013
  *
@@ -11983,7 +12242,7 @@ export namespace dataform_v1beta1 {
11983
12242
  }
11984
12243
 
11985
12244
  /**
11986
- * Fetches Git diff for an uncommitted file in a Workspace.
12245
+ * Deletes a branch in a Workspace.
11987
12246
  * @example
11988
12247
  * ```js
11989
12248
  * // Before running the sample:
@@ -12016,19 +12275,23 @@ export namespace dataform_v1beta1 {
12016
12275
  *
12017
12276
  * // Do the magic
12018
12277
  * const res =
12019
- * await dataform.projects.locations.repositories.workspaces.fetchFileDiff({
12020
- * // Required. The file's full path including filename, relative to the workspace root.
12021
- * path: 'placeholder-value',
12022
- * // Required. The workspace's name.
12023
- * workspace:
12024
- * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
12278
+ * await dataform.projects.locations.repositories.workspaces.deleteBranch({
12279
+ * // Required. The workspace resource name. Format: projects/{project\}/locations/{location\}/repositories/{repository\}/workspaces/{workspace\}
12280
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
12281
+ *
12282
+ * // Request body metadata
12283
+ * requestBody: {
12284
+ * // request body parameters
12285
+ * // {
12286
+ * // "branch": "my_branch",
12287
+ * // "force": false
12288
+ * // }
12289
+ * },
12025
12290
  * });
12026
12291
  * console.log(res.data);
12027
12292
  *
12028
12293
  * // Example response
12029
- * // {
12030
- * // "formattedDiff": "my_formattedDiff"
12031
- * // }
12294
+ * // {}
12032
12295
  * }
12033
12296
  *
12034
12297
  * main().catch(e => {
@@ -12043,57 +12306,57 @@ export namespace dataform_v1beta1 {
12043
12306
  * @param callback - Optional callback that handles the response.
12044
12307
  * @returns A promise if used with async/await, or void if used with a callback.
12045
12308
  */
12046
- fetchFileDiff(
12047
- params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff,
12309
+ deleteBranch(
12310
+ params: Params$Resource$Projects$Locations$Repositories$Workspaces$Deletebranch,
12048
12311
  options: StreamMethodOptions
12049
12312
  ): Promise<GaxiosResponseWithHTTP2<Readable>>;
12050
- fetchFileDiff(
12051
- params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff,
12313
+ deleteBranch(
12314
+ params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Deletebranch,
12052
12315
  options?: MethodOptions
12053
- ): Promise<GaxiosResponseWithHTTP2<Schema$FetchFileDiffResponse>>;
12054
- fetchFileDiff(
12055
- params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff,
12316
+ ): Promise<GaxiosResponseWithHTTP2<Schema$DeleteBranchResponse>>;
12317
+ deleteBranch(
12318
+ params: Params$Resource$Projects$Locations$Repositories$Workspaces$Deletebranch,
12056
12319
  options: StreamMethodOptions | BodyResponseCallback<Readable>,
12057
12320
  callback: BodyResponseCallback<Readable>
12058
12321
  ): void;
12059
- fetchFileDiff(
12060
- params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff,
12322
+ deleteBranch(
12323
+ params: Params$Resource$Projects$Locations$Repositories$Workspaces$Deletebranch,
12061
12324
  options:
12062
- MethodOptions | BodyResponseCallback<Schema$FetchFileDiffResponse>,
12063
- callback: BodyResponseCallback<Schema$FetchFileDiffResponse>
12325
+ MethodOptions | BodyResponseCallback<Schema$DeleteBranchResponse>,
12326
+ callback: BodyResponseCallback<Schema$DeleteBranchResponse>
12064
12327
  ): void;
12065
- fetchFileDiff(
12066
- params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff,
12067
- callback: BodyResponseCallback<Schema$FetchFileDiffResponse>
12328
+ deleteBranch(
12329
+ params: Params$Resource$Projects$Locations$Repositories$Workspaces$Deletebranch,
12330
+ callback: BodyResponseCallback<Schema$DeleteBranchResponse>
12068
12331
  ): void;
12069
- fetchFileDiff(
12070
- callback: BodyResponseCallback<Schema$FetchFileDiffResponse>
12332
+ deleteBranch(
12333
+ callback: BodyResponseCallback<Schema$DeleteBranchResponse>
12071
12334
  ): void;
12072
- fetchFileDiff(
12335
+ deleteBranch(
12073
12336
  paramsOrCallback?:
12074
- | Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff
12075
- | BodyResponseCallback<Schema$FetchFileDiffResponse>
12337
+ | Params$Resource$Projects$Locations$Repositories$Workspaces$Deletebranch
12338
+ | BodyResponseCallback<Schema$DeleteBranchResponse>
12076
12339
  | BodyResponseCallback<Readable>,
12077
12340
  optionsOrCallback?:
12078
12341
  | MethodOptions
12079
12342
  | StreamMethodOptions
12080
- | BodyResponseCallback<Schema$FetchFileDiffResponse>
12343
+ | BodyResponseCallback<Schema$DeleteBranchResponse>
12081
12344
  | BodyResponseCallback<Readable>,
12082
12345
  callback?:
12083
- | BodyResponseCallback<Schema$FetchFileDiffResponse>
12346
+ | BodyResponseCallback<Schema$DeleteBranchResponse>
12084
12347
  | BodyResponseCallback<Readable>
12085
12348
  ):
12086
12349
  | void
12087
- | Promise<GaxiosResponseWithHTTP2<Schema$FetchFileDiffResponse>>
12350
+ | Promise<GaxiosResponseWithHTTP2<Schema$DeleteBranchResponse>>
12088
12351
  | Promise<GaxiosResponseWithHTTP2<Readable>> {
12089
12352
  let params = (paramsOrCallback ||
12090
- {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff;
12353
+ {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Deletebranch;
12091
12354
  let options = (optionsOrCallback || {}) as MethodOptions;
12092
12355
 
12093
12356
  if (typeof paramsOrCallback === 'function') {
12094
12357
  callback = paramsOrCallback;
12095
12358
  params =
12096
- {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff;
12359
+ {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Deletebranch;
12097
12360
  options = {};
12098
12361
  }
12099
12362
 
@@ -12106,32 +12369,32 @@ export namespace dataform_v1beta1 {
12106
12369
  const parameters = {
12107
12370
  options: Object.assign(
12108
12371
  {
12109
- url: (rootUrl + '/v1beta1/{+workspace}:fetchFileDiff').replace(
12372
+ url: (rootUrl + '/v1beta1/{+name}:deleteBranch').replace(
12110
12373
  /([^:]\/)\/+/g,
12111
12374
  '$1'
12112
12375
  ),
12113
- method: 'GET',
12376
+ method: 'POST',
12114
12377
  apiVersion: '',
12115
12378
  },
12116
12379
  options
12117
12380
  ),
12118
12381
  params,
12119
- requiredParams: ['workspace'],
12120
- pathParams: ['workspace'],
12382
+ requiredParams: ['name'],
12383
+ pathParams: ['name'],
12121
12384
  context: this.context,
12122
12385
  };
12123
12386
  if (callback) {
12124
- createAPIRequest<Schema$FetchFileDiffResponse>(
12387
+ createAPIRequest<Schema$DeleteBranchResponse>(
12125
12388
  parameters,
12126
12389
  callback as BodyResponseCallback<unknown>
12127
12390
  );
12128
12391
  } else {
12129
- return createAPIRequest<Schema$FetchFileDiffResponse>(parameters);
12392
+ return createAPIRequest<Schema$DeleteBranchResponse>(parameters);
12130
12393
  }
12131
12394
  }
12132
12395
 
12133
12396
  /**
12134
- * Fetches Git statuses for the files in a Workspace.
12397
+ * Fetches branches in a Workspace.
12135
12398
  * @example
12136
12399
  * ```js
12137
12400
  * // Before running the sample:
@@ -12164,17 +12427,22 @@ export namespace dataform_v1beta1 {
12164
12427
  *
12165
12428
  * // Do the magic
12166
12429
  * const res =
12167
- * await dataform.projects.locations.repositories.workspaces.fetchFileGitStatuses(
12168
- * {
12169
- * // Required. The workspace's name.
12170
- * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
12171
- * },
12172
- * );
12430
+ * await dataform.projects.locations.repositories.workspaces.fetchBranches({
12431
+ * // Optional. Filter for the returned list.
12432
+ * filter: 'placeholder-value',
12433
+ * // Required. The workspace resource name. Format: projects/{project\}/locations/{location\}/repositories/{repository\}/workspaces/{workspace\}
12434
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
12435
+ * // Optional. Maximum number of branches to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000.
12436
+ * pageSize: 'placeholder-value',
12437
+ * // Optional. Page token received from a previous `FetchWorkspaceBranches` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchWorkspaceBranches`, with the exception of `page_size`, must match the call that provided the page token.
12438
+ * pageToken: 'placeholder-value',
12439
+ * });
12173
12440
  * console.log(res.data);
12174
12441
  *
12175
12442
  * // Example response
12176
12443
  * // {
12177
- * // "uncommittedFileChanges": []
12444
+ * // "branches": [],
12445
+ * // "nextPageToken": "my_nextPageToken"
12178
12446
  * // }
12179
12447
  * }
12180
12448
  *
@@ -12190,16 +12458,468 @@ export namespace dataform_v1beta1 {
12190
12458
  * @param callback - Optional callback that handles the response.
12191
12459
  * @returns A promise if used with async/await, or void if used with a callback.
12192
12460
  */
12193
- fetchFileGitStatuses(
12194
- params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilegitstatuses,
12461
+ fetchBranches(
12462
+ params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchbranches,
12195
12463
  options: StreamMethodOptions
12196
12464
  ): Promise<GaxiosResponseWithHTTP2<Readable>>;
12197
- fetchFileGitStatuses(
12198
- params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilegitstatuses,
12465
+ fetchBranches(
12466
+ params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchbranches,
12199
12467
  options?: MethodOptions
12200
- ): Promise<GaxiosResponseWithHTTP2<Schema$FetchFileGitStatusesResponse>>;
12201
- fetchFileGitStatuses(
12202
- params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilegitstatuses,
12468
+ ): Promise<GaxiosResponseWithHTTP2<Schema$FetchWorkspaceBranchesResponse>>;
12469
+ fetchBranches(
12470
+ params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchbranches,
12471
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
12472
+ callback: BodyResponseCallback<Readable>
12473
+ ): void;
12474
+ fetchBranches(
12475
+ params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchbranches,
12476
+ options:
12477
+ | MethodOptions
12478
+ | BodyResponseCallback<Schema$FetchWorkspaceBranchesResponse>,
12479
+ callback: BodyResponseCallback<Schema$FetchWorkspaceBranchesResponse>
12480
+ ): void;
12481
+ fetchBranches(
12482
+ params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchbranches,
12483
+ callback: BodyResponseCallback<Schema$FetchWorkspaceBranchesResponse>
12484
+ ): void;
12485
+ fetchBranches(
12486
+ callback: BodyResponseCallback<Schema$FetchWorkspaceBranchesResponse>
12487
+ ): void;
12488
+ fetchBranches(
12489
+ paramsOrCallback?:
12490
+ | Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchbranches
12491
+ | BodyResponseCallback<Schema$FetchWorkspaceBranchesResponse>
12492
+ | BodyResponseCallback<Readable>,
12493
+ optionsOrCallback?:
12494
+ | MethodOptions
12495
+ | StreamMethodOptions
12496
+ | BodyResponseCallback<Schema$FetchWorkspaceBranchesResponse>
12497
+ | BodyResponseCallback<Readable>,
12498
+ callback?:
12499
+ | BodyResponseCallback<Schema$FetchWorkspaceBranchesResponse>
12500
+ | BodyResponseCallback<Readable>
12501
+ ):
12502
+ | void
12503
+ | Promise<GaxiosResponseWithHTTP2<Schema$FetchWorkspaceBranchesResponse>>
12504
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
12505
+ let params = (paramsOrCallback ||
12506
+ {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchbranches;
12507
+ let options = (optionsOrCallback || {}) as MethodOptions;
12508
+
12509
+ if (typeof paramsOrCallback === 'function') {
12510
+ callback = paramsOrCallback;
12511
+ params =
12512
+ {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchbranches;
12513
+ options = {};
12514
+ }
12515
+
12516
+ if (typeof optionsOrCallback === 'function') {
12517
+ callback = optionsOrCallback;
12518
+ options = {};
12519
+ }
12520
+
12521
+ const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/';
12522
+ const parameters = {
12523
+ options: Object.assign(
12524
+ {
12525
+ url: (rootUrl + '/v1beta1/{+name}:fetchBranches').replace(
12526
+ /([^:]\/)\/+/g,
12527
+ '$1'
12528
+ ),
12529
+ method: 'GET',
12530
+ apiVersion: '',
12531
+ },
12532
+ options
12533
+ ),
12534
+ params,
12535
+ requiredParams: ['name'],
12536
+ pathParams: ['name'],
12537
+ context: this.context,
12538
+ };
12539
+ if (callback) {
12540
+ createAPIRequest<Schema$FetchWorkspaceBranchesResponse>(
12541
+ parameters,
12542
+ callback as BodyResponseCallback<unknown>
12543
+ );
12544
+ } else {
12545
+ return createAPIRequest<Schema$FetchWorkspaceBranchesResponse>(
12546
+ parameters
12547
+ );
12548
+ }
12549
+ }
12550
+
12551
+ /**
12552
+ * Fetches the current branch of a Workspace.
12553
+ * @example
12554
+ * ```js
12555
+ * // Before running the sample:
12556
+ * // - Enable the API at:
12557
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
12558
+ * // - Login into gcloud by running:
12559
+ * // ```sh
12560
+ * // $ gcloud auth application-default login
12561
+ * // ```
12562
+ * // - Install the npm module by running:
12563
+ * // ```sh
12564
+ * // $ npm install googleapis
12565
+ * // ```
12566
+ *
12567
+ * const {google} = require('googleapis');
12568
+ * const dataform = google.dataform('v1beta1');
12569
+ *
12570
+ * async function main() {
12571
+ * const auth = new google.auth.GoogleAuth({
12572
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
12573
+ * scopes: [
12574
+ * 'https://www.googleapis.com/auth/bigquery',
12575
+ * 'https://www.googleapis.com/auth/cloud-platform',
12576
+ * ],
12577
+ * });
12578
+ *
12579
+ * // Acquire an auth client, and bind it to all future calls
12580
+ * const authClient = await auth.getClient();
12581
+ * google.options({auth: authClient});
12582
+ *
12583
+ * // Do the magic
12584
+ * const res =
12585
+ * await dataform.projects.locations.repositories.workspaces.fetchCurrentBranch(
12586
+ * {
12587
+ * // Required. The workspace resource name. Format: projects/{project\}/locations/{location\}/repositories/{repository\}/workspaces/{workspace\}
12588
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
12589
+ * },
12590
+ * );
12591
+ * console.log(res.data);
12592
+ *
12593
+ * // Example response
12594
+ * // {
12595
+ * // "branchName": "my_branchName"
12596
+ * // }
12597
+ * }
12598
+ *
12599
+ * main().catch(e => {
12600
+ * console.error(e);
12601
+ * throw e;
12602
+ * });
12603
+ *
12604
+ * ```
12605
+ *
12606
+ * @param params - Parameters for request
12607
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
12608
+ * @param callback - Optional callback that handles the response.
12609
+ * @returns A promise if used with async/await, or void if used with a callback.
12610
+ */
12611
+ fetchCurrentBranch(
12612
+ params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchcurrentbranch,
12613
+ options: StreamMethodOptions
12614
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
12615
+ fetchCurrentBranch(
12616
+ params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchcurrentbranch,
12617
+ options?: MethodOptions
12618
+ ): Promise<
12619
+ GaxiosResponseWithHTTP2<Schema$FetchCurrentWorkspaceBranchResponse>
12620
+ >;
12621
+ fetchCurrentBranch(
12622
+ params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchcurrentbranch,
12623
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
12624
+ callback: BodyResponseCallback<Readable>
12625
+ ): void;
12626
+ fetchCurrentBranch(
12627
+ params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchcurrentbranch,
12628
+ options:
12629
+ | MethodOptions
12630
+ | BodyResponseCallback<Schema$FetchCurrentWorkspaceBranchResponse>,
12631
+ callback: BodyResponseCallback<Schema$FetchCurrentWorkspaceBranchResponse>
12632
+ ): void;
12633
+ fetchCurrentBranch(
12634
+ params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchcurrentbranch,
12635
+ callback: BodyResponseCallback<Schema$FetchCurrentWorkspaceBranchResponse>
12636
+ ): void;
12637
+ fetchCurrentBranch(
12638
+ callback: BodyResponseCallback<Schema$FetchCurrentWorkspaceBranchResponse>
12639
+ ): void;
12640
+ fetchCurrentBranch(
12641
+ paramsOrCallback?:
12642
+ | Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchcurrentbranch
12643
+ | BodyResponseCallback<Schema$FetchCurrentWorkspaceBranchResponse>
12644
+ | BodyResponseCallback<Readable>,
12645
+ optionsOrCallback?:
12646
+ | MethodOptions
12647
+ | StreamMethodOptions
12648
+ | BodyResponseCallback<Schema$FetchCurrentWorkspaceBranchResponse>
12649
+ | BodyResponseCallback<Readable>,
12650
+ callback?:
12651
+ | BodyResponseCallback<Schema$FetchCurrentWorkspaceBranchResponse>
12652
+ | BodyResponseCallback<Readable>
12653
+ ):
12654
+ | void
12655
+ | Promise<
12656
+ GaxiosResponseWithHTTP2<Schema$FetchCurrentWorkspaceBranchResponse>
12657
+ >
12658
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
12659
+ let params = (paramsOrCallback ||
12660
+ {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchcurrentbranch;
12661
+ let options = (optionsOrCallback || {}) as MethodOptions;
12662
+
12663
+ if (typeof paramsOrCallback === 'function') {
12664
+ callback = paramsOrCallback;
12665
+ params =
12666
+ {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchcurrentbranch;
12667
+ options = {};
12668
+ }
12669
+
12670
+ if (typeof optionsOrCallback === 'function') {
12671
+ callback = optionsOrCallback;
12672
+ options = {};
12673
+ }
12674
+
12675
+ const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/';
12676
+ const parameters = {
12677
+ options: Object.assign(
12678
+ {
12679
+ url: (rootUrl + '/v1beta1/{+name}:fetchCurrentBranch').replace(
12680
+ /([^:]\/)\/+/g,
12681
+ '$1'
12682
+ ),
12683
+ method: 'GET',
12684
+ apiVersion: '',
12685
+ },
12686
+ options
12687
+ ),
12688
+ params,
12689
+ requiredParams: ['name'],
12690
+ pathParams: ['name'],
12691
+ context: this.context,
12692
+ };
12693
+ if (callback) {
12694
+ createAPIRequest<Schema$FetchCurrentWorkspaceBranchResponse>(
12695
+ parameters,
12696
+ callback as BodyResponseCallback<unknown>
12697
+ );
12698
+ } else {
12699
+ return createAPIRequest<Schema$FetchCurrentWorkspaceBranchResponse>(
12700
+ parameters
12701
+ );
12702
+ }
12703
+ }
12704
+
12705
+ /**
12706
+ * Fetches Git diff for an uncommitted file in a Workspace.
12707
+ * @example
12708
+ * ```js
12709
+ * // Before running the sample:
12710
+ * // - Enable the API at:
12711
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
12712
+ * // - Login into gcloud by running:
12713
+ * // ```sh
12714
+ * // $ gcloud auth application-default login
12715
+ * // ```
12716
+ * // - Install the npm module by running:
12717
+ * // ```sh
12718
+ * // $ npm install googleapis
12719
+ * // ```
12720
+ *
12721
+ * const {google} = require('googleapis');
12722
+ * const dataform = google.dataform('v1beta1');
12723
+ *
12724
+ * async function main() {
12725
+ * const auth = new google.auth.GoogleAuth({
12726
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
12727
+ * scopes: [
12728
+ * 'https://www.googleapis.com/auth/bigquery',
12729
+ * 'https://www.googleapis.com/auth/cloud-platform',
12730
+ * ],
12731
+ * });
12732
+ *
12733
+ * // Acquire an auth client, and bind it to all future calls
12734
+ * const authClient = await auth.getClient();
12735
+ * google.options({auth: authClient});
12736
+ *
12737
+ * // Do the magic
12738
+ * const res =
12739
+ * await dataform.projects.locations.repositories.workspaces.fetchFileDiff({
12740
+ * // Required. The file's full path including filename, relative to the workspace root.
12741
+ * path: 'placeholder-value',
12742
+ * // Required. The workspace's name.
12743
+ * workspace:
12744
+ * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
12745
+ * });
12746
+ * console.log(res.data);
12747
+ *
12748
+ * // Example response
12749
+ * // {
12750
+ * // "formattedDiff": "my_formattedDiff"
12751
+ * // }
12752
+ * }
12753
+ *
12754
+ * main().catch(e => {
12755
+ * console.error(e);
12756
+ * throw e;
12757
+ * });
12758
+ *
12759
+ * ```
12760
+ *
12761
+ * @param params - Parameters for request
12762
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
12763
+ * @param callback - Optional callback that handles the response.
12764
+ * @returns A promise if used with async/await, or void if used with a callback.
12765
+ */
12766
+ fetchFileDiff(
12767
+ params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff,
12768
+ options: StreamMethodOptions
12769
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
12770
+ fetchFileDiff(
12771
+ params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff,
12772
+ options?: MethodOptions
12773
+ ): Promise<GaxiosResponseWithHTTP2<Schema$FetchFileDiffResponse>>;
12774
+ fetchFileDiff(
12775
+ params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff,
12776
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
12777
+ callback: BodyResponseCallback<Readable>
12778
+ ): void;
12779
+ fetchFileDiff(
12780
+ params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff,
12781
+ options:
12782
+ MethodOptions | BodyResponseCallback<Schema$FetchFileDiffResponse>,
12783
+ callback: BodyResponseCallback<Schema$FetchFileDiffResponse>
12784
+ ): void;
12785
+ fetchFileDiff(
12786
+ params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff,
12787
+ callback: BodyResponseCallback<Schema$FetchFileDiffResponse>
12788
+ ): void;
12789
+ fetchFileDiff(
12790
+ callback: BodyResponseCallback<Schema$FetchFileDiffResponse>
12791
+ ): void;
12792
+ fetchFileDiff(
12793
+ paramsOrCallback?:
12794
+ | Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff
12795
+ | BodyResponseCallback<Schema$FetchFileDiffResponse>
12796
+ | BodyResponseCallback<Readable>,
12797
+ optionsOrCallback?:
12798
+ | MethodOptions
12799
+ | StreamMethodOptions
12800
+ | BodyResponseCallback<Schema$FetchFileDiffResponse>
12801
+ | BodyResponseCallback<Readable>,
12802
+ callback?:
12803
+ | BodyResponseCallback<Schema$FetchFileDiffResponse>
12804
+ | BodyResponseCallback<Readable>
12805
+ ):
12806
+ | void
12807
+ | Promise<GaxiosResponseWithHTTP2<Schema$FetchFileDiffResponse>>
12808
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
12809
+ let params = (paramsOrCallback ||
12810
+ {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff;
12811
+ let options = (optionsOrCallback || {}) as MethodOptions;
12812
+
12813
+ if (typeof paramsOrCallback === 'function') {
12814
+ callback = paramsOrCallback;
12815
+ params =
12816
+ {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff;
12817
+ options = {};
12818
+ }
12819
+
12820
+ if (typeof optionsOrCallback === 'function') {
12821
+ callback = optionsOrCallback;
12822
+ options = {};
12823
+ }
12824
+
12825
+ const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/';
12826
+ const parameters = {
12827
+ options: Object.assign(
12828
+ {
12829
+ url: (rootUrl + '/v1beta1/{+workspace}:fetchFileDiff').replace(
12830
+ /([^:]\/)\/+/g,
12831
+ '$1'
12832
+ ),
12833
+ method: 'GET',
12834
+ apiVersion: '',
12835
+ },
12836
+ options
12837
+ ),
12838
+ params,
12839
+ requiredParams: ['workspace'],
12840
+ pathParams: ['workspace'],
12841
+ context: this.context,
12842
+ };
12843
+ if (callback) {
12844
+ createAPIRequest<Schema$FetchFileDiffResponse>(
12845
+ parameters,
12846
+ callback as BodyResponseCallback<unknown>
12847
+ );
12848
+ } else {
12849
+ return createAPIRequest<Schema$FetchFileDiffResponse>(parameters);
12850
+ }
12851
+ }
12852
+
12853
+ /**
12854
+ * Fetches Git statuses for the files in a Workspace.
12855
+ * @example
12856
+ * ```js
12857
+ * // Before running the sample:
12858
+ * // - Enable the API at:
12859
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
12860
+ * // - Login into gcloud by running:
12861
+ * // ```sh
12862
+ * // $ gcloud auth application-default login
12863
+ * // ```
12864
+ * // - Install the npm module by running:
12865
+ * // ```sh
12866
+ * // $ npm install googleapis
12867
+ * // ```
12868
+ *
12869
+ * const {google} = require('googleapis');
12870
+ * const dataform = google.dataform('v1beta1');
12871
+ *
12872
+ * async function main() {
12873
+ * const auth = new google.auth.GoogleAuth({
12874
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
12875
+ * scopes: [
12876
+ * 'https://www.googleapis.com/auth/bigquery',
12877
+ * 'https://www.googleapis.com/auth/cloud-platform',
12878
+ * ],
12879
+ * });
12880
+ *
12881
+ * // Acquire an auth client, and bind it to all future calls
12882
+ * const authClient = await auth.getClient();
12883
+ * google.options({auth: authClient});
12884
+ *
12885
+ * // Do the magic
12886
+ * const res =
12887
+ * await dataform.projects.locations.repositories.workspaces.fetchFileGitStatuses(
12888
+ * {
12889
+ * // Required. The workspace's name.
12890
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
12891
+ * },
12892
+ * );
12893
+ * console.log(res.data);
12894
+ *
12895
+ * // Example response
12896
+ * // {
12897
+ * // "uncommittedFileChanges": []
12898
+ * // }
12899
+ * }
12900
+ *
12901
+ * main().catch(e => {
12902
+ * console.error(e);
12903
+ * throw e;
12904
+ * });
12905
+ *
12906
+ * ```
12907
+ *
12908
+ * @param params - Parameters for request
12909
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
12910
+ * @param callback - Optional callback that handles the response.
12911
+ * @returns A promise if used with async/await, or void if used with a callback.
12912
+ */
12913
+ fetchFileGitStatuses(
12914
+ params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilegitstatuses,
12915
+ options: StreamMethodOptions
12916
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
12917
+ fetchFileGitStatuses(
12918
+ params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilegitstatuses,
12919
+ options?: MethodOptions
12920
+ ): Promise<GaxiosResponseWithHTTP2<Schema$FetchFileGitStatusesResponse>>;
12921
+ fetchFileGitStatuses(
12922
+ params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilegitstatuses,
12203
12923
  options: StreamMethodOptions | BodyResponseCallback<Readable>,
12204
12924
  callback: BodyResponseCallback<Readable>
12205
12925
  ): void;
@@ -12474,10 +13194,14 @@ export namespace dataform_v1beta1 {
12474
13194
  * // {
12475
13195
  * // "createTime": "my_createTime",
12476
13196
  * // "dataEncryptionState": {},
13197
+ * // "depth": 0,
12477
13198
  * // "disableMoves": false,
13199
+ * // "enableBranchManagement": false,
12478
13200
  * // "internalMetadata": "my_internalMetadata",
12479
13201
  * // "name": "my_name",
12480
- * // "privateResourceMetadata": {}
13202
+ * // "originalBranch": "my_originalBranch",
13203
+ * // "privateResourceMetadata": {},
13204
+ * // "shallow": false
12481
13205
  * // }
12482
13206
  * }
12483
13207
  *
@@ -14843,6 +15567,160 @@ export namespace dataform_v1beta1 {
14843
15567
  }
14844
15568
  }
14845
15569
 
15570
+ /**
15571
+ * Syncs the refs of a Workspace.
15572
+ * @example
15573
+ * ```js
15574
+ * // Before running the sample:
15575
+ * // - Enable the API at:
15576
+ * // https://console.developers.google.com/apis/api/dataform.googleapis.com
15577
+ * // - Login into gcloud by running:
15578
+ * // ```sh
15579
+ * // $ gcloud auth application-default login
15580
+ * // ```
15581
+ * // - Install the npm module by running:
15582
+ * // ```sh
15583
+ * // $ npm install googleapis
15584
+ * // ```
15585
+ *
15586
+ * const {google} = require('googleapis');
15587
+ * const dataform = google.dataform('v1beta1');
15588
+ *
15589
+ * async function main() {
15590
+ * const auth = new google.auth.GoogleAuth({
15591
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
15592
+ * scopes: [
15593
+ * 'https://www.googleapis.com/auth/bigquery',
15594
+ * 'https://www.googleapis.com/auth/cloud-platform',
15595
+ * ],
15596
+ * });
15597
+ *
15598
+ * // Acquire an auth client, and bind it to all future calls
15599
+ * const authClient = await auth.getClient();
15600
+ * google.options({auth: authClient});
15601
+ *
15602
+ * // Do the magic
15603
+ * const res =
15604
+ * await dataform.projects.locations.repositories.workspaces.syncWorkspaceRefs(
15605
+ * {
15606
+ * // Required. The workspace resource name. Format: projects/{project\}/locations/{location\}/repositories/{repository\}/workspaces/{workspace\}
15607
+ * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
15608
+ *
15609
+ * // Request body metadata
15610
+ * requestBody: {
15611
+ * // request body parameters
15612
+ * // {
15613
+ * // "deepen": 0,
15614
+ * // "remoteBranchName": "my_remoteBranchName"
15615
+ * // }
15616
+ * },
15617
+ * },
15618
+ * );
15619
+ * console.log(res.data);
15620
+ *
15621
+ * // Example response
15622
+ * // {}
15623
+ * }
15624
+ *
15625
+ * main().catch(e => {
15626
+ * console.error(e);
15627
+ * throw e;
15628
+ * });
15629
+ *
15630
+ * ```
15631
+ *
15632
+ * @param params - Parameters for request
15633
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
15634
+ * @param callback - Optional callback that handles the response.
15635
+ * @returns A promise if used with async/await, or void if used with a callback.
15636
+ */
15637
+ syncWorkspaceRefs(
15638
+ params: Params$Resource$Projects$Locations$Repositories$Workspaces$Syncworkspacerefs,
15639
+ options: StreamMethodOptions
15640
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
15641
+ syncWorkspaceRefs(
15642
+ params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Syncworkspacerefs,
15643
+ options?: MethodOptions
15644
+ ): Promise<GaxiosResponseWithHTTP2<Schema$SyncWorkspaceRefsResponse>>;
15645
+ syncWorkspaceRefs(
15646
+ params: Params$Resource$Projects$Locations$Repositories$Workspaces$Syncworkspacerefs,
15647
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
15648
+ callback: BodyResponseCallback<Readable>
15649
+ ): void;
15650
+ syncWorkspaceRefs(
15651
+ params: Params$Resource$Projects$Locations$Repositories$Workspaces$Syncworkspacerefs,
15652
+ options:
15653
+ MethodOptions | BodyResponseCallback<Schema$SyncWorkspaceRefsResponse>,
15654
+ callback: BodyResponseCallback<Schema$SyncWorkspaceRefsResponse>
15655
+ ): void;
15656
+ syncWorkspaceRefs(
15657
+ params: Params$Resource$Projects$Locations$Repositories$Workspaces$Syncworkspacerefs,
15658
+ callback: BodyResponseCallback<Schema$SyncWorkspaceRefsResponse>
15659
+ ): void;
15660
+ syncWorkspaceRefs(
15661
+ callback: BodyResponseCallback<Schema$SyncWorkspaceRefsResponse>
15662
+ ): void;
15663
+ syncWorkspaceRefs(
15664
+ paramsOrCallback?:
15665
+ | Params$Resource$Projects$Locations$Repositories$Workspaces$Syncworkspacerefs
15666
+ | BodyResponseCallback<Schema$SyncWorkspaceRefsResponse>
15667
+ | BodyResponseCallback<Readable>,
15668
+ optionsOrCallback?:
15669
+ | MethodOptions
15670
+ | StreamMethodOptions
15671
+ | BodyResponseCallback<Schema$SyncWorkspaceRefsResponse>
15672
+ | BodyResponseCallback<Readable>,
15673
+ callback?:
15674
+ | BodyResponseCallback<Schema$SyncWorkspaceRefsResponse>
15675
+ | BodyResponseCallback<Readable>
15676
+ ):
15677
+ | void
15678
+ | Promise<GaxiosResponseWithHTTP2<Schema$SyncWorkspaceRefsResponse>>
15679
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
15680
+ let params = (paramsOrCallback ||
15681
+ {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Syncworkspacerefs;
15682
+ let options = (optionsOrCallback || {}) as MethodOptions;
15683
+
15684
+ if (typeof paramsOrCallback === 'function') {
15685
+ callback = paramsOrCallback;
15686
+ params =
15687
+ {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Syncworkspacerefs;
15688
+ options = {};
15689
+ }
15690
+
15691
+ if (typeof optionsOrCallback === 'function') {
15692
+ callback = optionsOrCallback;
15693
+ options = {};
15694
+ }
15695
+
15696
+ const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/';
15697
+ const parameters = {
15698
+ options: Object.assign(
15699
+ {
15700
+ url: (rootUrl + '/v1beta1/{+name}:syncWorkspaceRefs').replace(
15701
+ /([^:]\/)\/+/g,
15702
+ '$1'
15703
+ ),
15704
+ method: 'POST',
15705
+ apiVersion: '',
15706
+ },
15707
+ options
15708
+ ),
15709
+ params,
15710
+ requiredParams: ['name'],
15711
+ pathParams: ['name'],
15712
+ context: this.context,
15713
+ };
15714
+ if (callback) {
15715
+ createAPIRequest<Schema$SyncWorkspaceRefsResponse>(
15716
+ parameters,
15717
+ callback as BodyResponseCallback<unknown>
15718
+ );
15719
+ } else {
15720
+ return createAPIRequest<Schema$SyncWorkspaceRefsResponse>(parameters);
15721
+ }
15722
+ }
15723
+
14846
15724
  /**
14847
15725
  * 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.
14848
15726
  * @example
@@ -15150,6 +16028,17 @@ export namespace dataform_v1beta1 {
15150
16028
  }
15151
16029
  }
15152
16030
 
16031
+ export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Checkout extends StandardParameters {
16032
+ /**
16033
+ * Required. The workspace resource name. Format: projects/{project\}/locations/{location\}/repositories/{repository\}/workspaces/{workspace\}
16034
+ */
16035
+ name?: string;
16036
+
16037
+ /**
16038
+ * Request body metadata
16039
+ */
16040
+ requestBody?: Schema$CheckoutWorkspaceBranchRequest;
16041
+ }
15153
16042
  export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Commit extends StandardParameters {
15154
16043
  /**
15155
16044
  * Required. The workspace's name.
@@ -15182,6 +16071,41 @@ export namespace dataform_v1beta1 {
15182
16071
  */
15183
16072
  name?: string;
15184
16073
  }
16074
+ export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Deletebranch extends StandardParameters {
16075
+ /**
16076
+ * Required. The workspace resource name. Format: projects/{project\}/locations/{location\}/repositories/{repository\}/workspaces/{workspace\}
16077
+ */
16078
+ name?: string;
16079
+
16080
+ /**
16081
+ * Request body metadata
16082
+ */
16083
+ requestBody?: Schema$DeleteBranchRequest;
16084
+ }
16085
+ export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchbranches extends StandardParameters {
16086
+ /**
16087
+ * Optional. Filter for the returned list.
16088
+ */
16089
+ filter?: string;
16090
+ /**
16091
+ * Required. The workspace resource name. Format: projects/{project\}/locations/{location\}/repositories/{repository\}/workspaces/{workspace\}
16092
+ */
16093
+ name?: string;
16094
+ /**
16095
+ * Optional. Maximum number of branches to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000.
16096
+ */
16097
+ pageSize?: number;
16098
+ /**
16099
+ * Optional. Page token received from a previous `FetchWorkspaceBranches` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchWorkspaceBranches`, with the exception of `page_size`, must match the call that provided the page token.
16100
+ */
16101
+ pageToken?: string;
16102
+ }
16103
+ export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchcurrentbranch extends StandardParameters {
16104
+ /**
16105
+ * Required. The workspace resource name. Format: projects/{project\}/locations/{location\}/repositories/{repository\}/workspaces/{workspace\}
16106
+ */
16107
+ name?: string;
16108
+ }
15185
16109
  export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff extends StandardParameters {
15186
16110
  /**
15187
16111
  * Required. The file's full path including filename, relative to the workspace root.
@@ -15410,6 +16334,17 @@ export namespace dataform_v1beta1 {
15410
16334
  */
15411
16335
  requestBody?: Schema$SetIamPolicyRequest;
15412
16336
  }
16337
+ export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Syncworkspacerefs extends StandardParameters {
16338
+ /**
16339
+ * Required. The workspace resource name. Format: projects/{project\}/locations/{location\}/repositories/{repository\}/workspaces/{workspace\}
16340
+ */
16341
+ name?: string;
16342
+
16343
+ /**
16344
+ * Request body metadata
16345
+ */
16346
+ requestBody?: Schema$SyncWorkspaceRefsRequest;
16347
+ }
15413
16348
  export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Testiampermissions extends StandardParameters {
15414
16349
  /**
15415
16350
  * 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.